diff --git a/.release-please-manifest.json b/.release-please-manifest.json index 8aee1244f1..4ceabe7e42 100644 --- a/.release-please-manifest.json +++ b/.release-please-manifest.json @@ -1 +1,178 @@ -{".":"140.0.1","src/apis/abusiveexperiencereport":"1.0.7","src/apis/acceleratedmobilepageurl":"1.0.7","src/apis/accesscontextmanager":"7.1.0","src/apis/adexchangebuyer":"1.0.5","src/apis/adexchangebuyer2":"4.2.2","src/apis/adexperiencereport":"1.0.7","src/apis/admin":"20.0.0","src/apis/admob":"2.5.5","src/apis/adsense":"10.0.0","src/apis/adsensehost":"5.0.7","src/apis/alertcenter":"9.5.0","src/apis/analytics":"7.0.7","src/apis/analyticsreporting":"1.0.7","src/apis/androiddeviceprovisioning":"6.3.2","src/apis/androidenterprise":"5.5.2","src/apis/androidmanagement":"17.3.0","src/apis/androidpublisher":"18.0.0","src/apis/appsactivity":"1.0.5","src/apis/bigtableadmin":"20.1.0","src/apis/blogger":"1.1.7","src/apis/books":"4.0.0","src/apis/calendar":"9.7.6","src/apis/chat":"27.0.0","src/apis/chromemanagement":"15.0.0","src/apis/chromepolicy":"9.1.2","src/apis/chromeuxreport":"1.5.2","src/apis/civicinfo":"11.0.4","src/apis/classroom":"4.0.9","src/apis/cloudidentity":"13.0.0","src/apis/cloudkms":"13.0.0","src/apis/cloudsearch":"14.4.0","src/apis/cloudshell":"2.0.6","src/apis/cloudtasks":"15.0.0","src/apis/composer":"9.0.0","src/apis/content":"27.0.0","src/apis/customsearch":"3.0.0","src/apis/dataflow":"11.0.0","src/apis/datafusion":"6.4.3","src/apis/datamigration":"6.1.0","src/apis/deploymentmanager":"14.0.0","src/apis/dfareporting":"5.2.0","src/apis/digitalassetlinks":"1.0.7","src/apis/discovery":"1.7.0","src/apis/displayvideo":"20.0.0","src/apis/docs":"3.0.2","src/apis/domainsrdap":"1.0.7","src/apis/doubleclickbidmanager":"10.0.0","src/apis/doubleclicksearch":"4.0.3","src/apis/drive":"8.11.0","src/apis/driveactivity":"2.0.9","src/apis/eventarc":"6.2.1","src/apis/factchecktools":"1.2.0","src/apis/fcm":"5.0.10","src/apis/file":"7.1.0","src/apis/firebase":"6.4.2","src/apis/firebasedatabase":"2.0.8","src/apis/firebasedynamiclinks":"1.0.9","src/apis/firebasehosting":"9.0.0","src/apis/firebaseml":"5.0.0","src/apis/firebaserules":"1.2.2","src/apis/firebasestorage":"6.1.2","src/apis/fitness":"2.0.7","src/apis/games":"5.9.0","src/apis/gamesConfiguration":"2.0.7","src/apis/gamesManagement":"2.0.7","src/apis/genomics":"3.0.7","src/apis/gmail":"12.0.0","src/apis/gmailpostmastertools":"1.1.2","src/apis/groupsmigration":"1.0.7","src/apis/groupssettings":"3.0.7","src/apis/healthcare":"18.0.0","src/apis/homegraph":"4.0.9","src/apis/iam":"20.0.0","src/apis/iap":"8.0.1","src/apis/identitytoolkit":"11.0.0","src/apis/indexing":"2.0.2","src/apis/kgsearch":"1.0.7","src/apis/libraryagent":"1.0.7","src/apis/licensing":"1.0.7","src/apis/lifesciences":"2.0.6","src/apis/localservices":"4.0.0","src/apis/manufacturers":"5.3.2","src/apis/ml":"3.0.11","src/apis/mybusinessaccountmanagement":"3.0.10","src/apis/networkmanagement":"9.1.0","src/apis/oauth2":"1.0.7","src/apis/ondemandscanning":"12.2.0","src/apis/pagespeedonline":"1.4.0","src/apis/people":"3.0.9","src/apis/playablelocations":"1.0.5","src/apis/playcustomapp":"1.0.5","src/apis/plus":"1.0.3","src/apis/policysimulator":"8.0.0","src/apis/poly":"1.0.5","src/apis/prod_tt_sasportal":"17.0.3","src/apis/pubsublite":"2.1.7","src/apis/realtimebidding":"4.1.7","src/apis/recommendationengine":"3.4.2","src/apis/remotebuildexecution":"3.0.3","src/apis/reseller":"4.0.5","src/apis/run":"17.1.0","src/apis/safebrowsing":"10.0.0","src/apis/sasportal":"18.0.3","src/apis/script":"5.0.0","src/apis/searchconsole":"1.0.5","src/apis/serviceconsumermanagement":"17.0.0","src/apis/servicenetworking":"16.0.0","src/apis/serviceusage":"13.0.0","src/apis/sheets":"9.0.0","src/apis/siteVerification":"2.0.5","src/apis/slides":"1.2.0","src/apis/smartdevicemanagement":"3.0.2","src/apis/sourcerepo":"4.0.3","src/apis/sql":"1.0.3","src/apis/sqladmin":"19.0.0","src/apis/storage":"15.0.0","src/apis/storagetransfer":"7.1.1","src/apis/streetviewpublish":"4.0.5","src/apis/sts":"7.0.0","src/apis/tagmanager":"5.0.2","src/apis/testing":"10.0.0","src/apis/toolresults":"3.3.2","src/apis/tpu":"5.0.0","src/apis/trafficdirector":"4.0.0","src/apis/vault":"3.4.2","src/apis/vectortile":"1.0.3","src/apis/verifiedaccess":"3.4.0","src/apis/webfonts":"1.4.0","src/apis/webmasters":"1.0.3","src/apis/workflowexecutions":"7.5.0","src/apis/youtube":"19.0.0","src/apis/youtubeAnalytics":"2.0.5","src/apis/youtubereporting":"1.0.5","src/apis/forms":"2.0.7","src/apis/authorizedbuyersmarketplace":"5.0.0","src/apis/businessprofileperformance":"1.1.8","src/apis/cloudsupport":"11.0.0","src/apis/connectors":"15.0.0","src/apis/datapipelines":"1.0.7","src/apis/drivelabels":"7.0.2","src/apis/fcmdata":"1.3.0","src/apis/firebaseappcheck":"5.11.0","src/apis/ideahub":"1.0.7","src/apis/mybusinessbusinesscalls":"4.0.5","src/apis/mybusinessbusinessinformation":"4.0.9","src/apis/mybusinesslodging":"3.0.2","src/apis/mybusinessnotifications":"1.0.7","src/apis/mybusinessplaceactions":"1.0.7","src/apis/mybusinessqanda":"1.0.7","src/apis/mybusinessverifications":"2.0.2","src/apis/networkservices":"16.0.0","src/apis/paymentsresellersubscription":"10.0.0","src/apis/playdeveloperreporting":"5.4.0","src/apis/playintegrity":"11.0.0","src/apis/policyanalyzer":"1.2.0","src/apis/runtimeconfig":"4.0.0","src/apis/travelimpactmodel":"2.0.2","src/apis/versionhistory":"1.3.0","src/apis/workloadmanager":"13.0.0","src/apis/workstations":"6.15.0","src/apis/ids":"1.3.0","src/apis/places":"9.3.0","src/apis/vpcaccess":"1.5.2","src/apis/privateca":"4.0.0","src/apis/datalabeling":"2.0.2","src/apis/cloudasset":"7.0.0","src/apis/tasks":"4.3.0","src/apis/datalineage":"1.0.3","src/apis/transcoder":"4.0.0","src/apis/clouderrorreporting":"3.0.0","src/apis/kmsinventory":"1.1.4","src/apis/websecurityscanner":"1.0.5","src/apis/apigateway":"1.0.6","src/apis/analyticshub":"6.0.0","src/apis/notebooks":"8.0.0","src/apis/bigqueryconnection":"1.2.0","src/apis/recommender":"4.2.1","src/apis/analyticsadmin":"8.0.0","src/apis/servicedirectory":"3.0.5","src/apis/monitoring":"6.5.0","src/apis/gkebackup":"8.0.0","src/apis/workflows":"1.5.0","src/apis/jobs":"1.1.2","src/apis/containeranalysis":"8.3.0","src/apis/orgpolicy":"4.0.0","src/apis/documentai":"8.2.0","src/apis/datastream":"6.2.0","src/apis/assuredworkloads":"6.0.2","src/apis/logging":"5.0.0","src/apis/domains":"1.5.0","src/apis/gkehub":"12.0.0","src/apis/vision":"1.5.2","src/apis/policytroubleshooter":"1.0.8","src/apis/gameservices":"1.3.0","src/apis/acmedns":"1.0.5","src/apis/discoveryengine":"11.0.0","src/apis/secretmanager":"1.3.0","src/apis/bigquery":"10.0.1","src/apis/cloudfunctions":"4.1.0","src/apis/vmmigration":"9.0.0","src/apis/certificatemanager":"4.0.0","src/apis/baremetalsolution":"1.0.3","src/apis/accessapproval":"1.6.0","src/apis/container":"8.0.0","src/apis/publicca":"1.0.5","src/apis/batch":"9.1.0","src/apis/datacatalog":"6.0.0","src/apis/managedidentities":"3.0.3","src/apis/bigquerydatatransfer":"1.4.1","src/apis/apikeys":"1.0.5","src/apis/dns":"3.0.0","src/apis/memcache":"3.0.0","src/apis/cloudscheduler":"1.1.7","src/apis/dialogflow":"8.2.0","src/apis/contentwarehouse":"9.1.0","src/apis/speech":"1.5.0","src/apis/contactcenterinsights":"9.0.0","src/apis/oslogin":"3.0.2","src/apis/texttospeech":"1.4.0","src/apis/readerrevenuesubscriptionlinking":"1.0.5","src/apis/compute":"15.0.0","src/apis/cloudtrace":"1.1.2","src/apis/dataplex":"8.0.0","src/apis/advisorynotifications":"3.2.0","src/apis/language":"4.0.0","src/apis/retail":"8.1.1","src/apis/cloudresourcemanager":"1.3.0","src/apis/osconfig":"4.1.1","src/apis/essentialcontacts":"1.0.5","src/apis/appengine":"8.0.0","src/apis/checks":"4.0.2","src/apis/cloudchannel":"1.4.3","src/apis/translate":"3.0.3","src/apis/bigqueryreservation":"3.0.0","src/apis/apigeeregistry":"2.0.2","src/apis/redis":"10.1.0","src/apis/clouddebugger":"1.0.3","src/apis/servicecontrol":"4.1.0","src/apis/videointelligence":"1.2.4","src/apis/cloudbuild":"9.1.0","src/apis/dlp":"10.1.0","src/apis/networksecurity":"8.1.0","src/apis/binaryauthorization":"6.0.1","src/apis/securitycenter":"8.2.0","src/apis/cloudprofiler":"4.0.0","src/apis/dataproc":"8.0.0","src/apis/pubsub":"4.0.0","src/apis/dataform":"5.0.0","src/apis/servicemanagement":"2.0.1","src/apis/searchads360":"6.0.0","src/apis/firebaseappdistribution":"1.0.7","src/apis/billingbudgets":"1.3.2","src/apis/cloudiot":"1.0.2","src/apis/area120tables":"1.0.4","src/apis/beyondcorp":"12.2.0","src/apis/networkconnectivity":"8.1.0","src/apis/analyticsdata":"1.5.0","src/apis/spanner":"7.2.0","src/apis/artifactregistry":"11.0.0","src/apis/firestore":"9.1.0","src/apis/recaptchaenterprise":"6.1.0","src/apis/clouddeploy":"5.1.0","src/apis/datastore":"4.0.0","src/apis/integrations":"1.0.2","src/apis/iamcredentials":"4.0.0","src/apis/resourcesettings":"1.0.4","src/apis/aiplatform":"13.0.0","src/apis/webrisk":"1.0.3","src/apis/gkeonprem":"7.0.2","src/apis/blockchainnodeengine":"6.1.0","src/apis/migrationcenter":"5.0.0","src/apis/contactcenteraiplatform":"5.0.0","src/apis/cloudbilling":"4.0.2","src/apis/metastore":"6.2.0","src/apis/rapidmigrationassessment":"0.1.1","src/apis/playgrouping":"0.1.1","src/apis/alloydb":"8.0.0","src/apis/backupdr":"4.0.0","src/apis/vmwareengine":"1.0.2","src/apis/biglake":"0.1.1","src/apis/looker":"2.0.1","src/apis/bigquerydatapolicy":"0.1.2","src/apis/walletobjects":"4.1.0","src/apis/apphub":"2.1.0","src/apis/dataportability":"3.0.0","src/apis/workspaceevents":"1.0.1","src/apis/marketingplatformadmin":"0.2.2","src/apis/solar":"0.1.0","src/apis/config":"0.2.0","src/apis/cloudcontrolspartner":"0.1.0","src/apis/addressvalidation":"0.1.0","src/apis/developerconnect":"0.1.0"} \ No newline at end of file +{ + "src/apis/abusiveexperiencereport": "1.0.7", + "src/apis/acceleratedmobilepageurl": "1.0.7", + "src/apis/acmedns": "1.0.5", + "src/apis/addressvalidation": "0.1.0", + "src/apis/adexchangebuyer": "1.0.5", + "src/apis/adexchangebuyer2": "4.2.2", + "src/apis/adexperiencereport": "1.0.7", + "src/apis/admin": "20.0.0", + "src/apis/admob": "2.5.5", + "src/apis/adsense": "10.0.0", + "src/apis/adsensehost": "5.0.7", + "src/apis/adsenseplatform": "0.1.0", + "src/apis/airquality": "0.1.0", + "src/apis/alertcenter": "9.5.0", + "src/apis/analytics": "7.0.7", + "src/apis/analyticsreporting": "1.0.7", + "src/apis/androiddeviceprovisioning": "6.3.2", + "src/apis/androidenterprise": "5.5.2", + "src/apis/androidmanagement": "17.3.0", + "src/apis/androidpublisher": "18.0.0", + "src/apis/apim": "0.1.0", + "src/apis/apphub": "2.1.0", + "src/apis/appsactivity": "1.0.5", + "src/apis/authorizedbuyersmarketplace": "5.0.0", + "src/apis/backupdr": "4.0.0", + "src/apis/biglake": "0.1.1", + "src/apis/bigtableadmin": "20.1.0", + "src/apis/blockchainnodeengine": "6.1.0", + "src/apis/blogger": "1.1.7", + "src/apis/books": "4.0.0", + "src/apis/businessprofileperformance": "1.1.8", + "src/apis/calendar": "9.7.6", + "src/apis/chat": "27.0.0", + "src/apis/checks": "4.0.2", + "src/apis/chromemanagement": "15.0.0", + "src/apis/chromepolicy": "9.1.2", + "src/apis/chromeuxreport": "1.5.2", + "src/apis/civicinfo": "11.0.4", + "src/apis/classroom": "4.0.9", + "src/apis/cloudcontrolspartner": "0.1.0", + "src/apis/cloudidentity": "13.0.0", + "src/apis/cloudkms": "13.0.0", + "src/apis/cloudsearch": "14.4.0", + "src/apis/cloudshell": "2.0.6", + "src/apis/cloudtasks": "15.0.0", + "src/apis/config": "0.2.0", + "src/apis/connectors": "15.0.0", + "src/apis/contactcenteraiplatform": "5.0.0", + "src/apis/content": "27.0.0", + "src/apis/css": "0.1.0", + "src/apis/customsearch": "3.0.0", + "src/apis/datapipelines": "1.0.7", + "src/apis/dataportability": "3.0.0", + "src/apis/deploymentmanager": "14.0.0", + "src/apis/developerconnect": "0.1.0", + "src/apis/dfareporting": "5.2.0", + "src/apis/digitalassetlinks": "1.0.7", + "src/apis/discovery": "1.7.0", + "src/apis/displayvideo": "20.0.0", + "src/apis/docs": "3.0.2", + "src/apis/domainsrdap": "1.0.7", + "src/apis/doubleclickbidmanager": "10.0.0", + "src/apis/doubleclicksearch": "4.0.3", + "src/apis/drive": "8.11.0", + "src/apis/driveactivity": "2.0.9", + "src/apis/drivelabels": "7.0.2", + "src/apis/factchecktools": "1.2.0", + "src/apis/fcm": "5.0.10", + "src/apis/fcmdata": "1.3.0", + "src/apis/firebase": "6.4.2", + "src/apis/firebaseappcheck": "5.11.0", + "src/apis/firebaseappdistribution": "1.0.7", + "src/apis/firebasedatabase": "2.0.8", + "src/apis/firebasedynamiclinks": "1.0.9", + "src/apis/firebasehosting": "9.0.0", + "src/apis/firebaseml": "5.0.0", + "src/apis/firebaserules": "1.2.2", + "src/apis/firebasestorage": "6.1.2", + "src/apis/fitness": "2.0.7", + "src/apis/forms": "2.0.7", + "src/apis/games": "5.9.0", + "src/apis/gamesConfiguration": "2.0.7", + "src/apis/gamesManagement": "2.0.7", + "src/apis/genomics": "3.0.7", + "src/apis/gkeonprem": "7.0.2", + "src/apis/gmail": "12.0.0", + "src/apis/gmailpostmastertools": "1.1.2", + "src/apis/groupsmigration": "1.0.7", + "src/apis/groupssettings": "3.0.7", + "src/apis/healthcare": "18.0.0", + "src/apis/homegraph": "4.0.9", + "src/apis/iam": "20.0.0", + "src/apis/ideahub": "1.0.7", + "src/apis/identitytoolkit": "11.0.0", + "src/apis/indexing": "2.0.2", + "src/apis/integrations": "1.0.2", + "src/apis/kgsearch": "1.0.7", + "src/apis/kmsinventory": "1.1.4", + "src/apis/libraryagent": "1.0.7", + "src/apis/licensing": "1.0.7", + "src/apis/localservices": "4.0.0", + "src/apis/looker": "2.0.1", + "src/apis/manufacturers": "5.3.2", + "src/apis/marketingplatformadmin": "0.2.2", + "src/apis/meet": "0.1.0", + "src/apis/merchantapi": "0.1.0", + "src/apis/ml": "3.0.11", + "src/apis/mybusinessaccountmanagement": "3.0.10", + "src/apis/mybusinessbusinesscalls": "4.0.5", + "src/apis/mybusinessbusinessinformation": "4.0.9", + "src/apis/mybusinesslodging": "3.0.2", + "src/apis/mybusinessnotifications": "1.0.7", + "src/apis/mybusinessplaceactions": "1.0.7", + "src/apis/mybusinessqanda": "1.0.7", + "src/apis/mybusinessverifications": "2.0.2", + "src/apis/networkservices": "16.0.0", + "src/apis/oauth2": "1.0.7", + "src/apis/ondemandscanning": "12.2.0", + "src/apis/pagespeedonline": "1.4.0", + "src/apis/paymentsresellersubscription": "10.0.0", + "src/apis/people": "3.0.9", + "src/apis/playablelocations": "1.0.5", + "src/apis/playcustomapp": "1.0.5", + "src/apis/playdeveloperreporting": "5.4.0", + "src/apis/playgrouping": "0.1.1", + "src/apis/playintegrity": "11.0.0", + "src/apis/plus": "1.0.3", + "src/apis/policyanalyzer": "1.2.0", + "src/apis/policysimulator": "8.0.0", + "src/apis/pollen": "0.1.0", + "src/apis/poly": "1.0.5", + "src/apis/prod_tt_sasportal": "17.0.3", + "src/apis/pubsublite": "2.1.7", + "src/apis/readerrevenuesubscriptionlinking": "1.0.5", + "src/apis/realtimebidding": "4.1.7", + "src/apis/recommendationengine": "3.4.2", + "src/apis/remotebuildexecution": "3.0.3", + "src/apis/reseller": "4.0.5", + "src/apis/runtimeconfig": "4.0.0", + "src/apis/safebrowsing": "10.0.0", + "src/apis/sasportal": "18.0.3", + "src/apis/script": "5.0.0", + "src/apis/searchads360": "6.0.0", + "src/apis/searchconsole": "1.0.5", + "src/apis/serviceconsumermanagement": "17.0.0", + "src/apis/servicenetworking": "16.0.0", + "src/apis/sheets": "9.0.0", + "src/apis/siteVerification": "2.0.5", + "src/apis/slides": "1.2.0", + "src/apis/smartdevicemanagement": "3.0.2", + "src/apis/solar": "0.1.0", + "src/apis/sourcerepo": "4.0.3", + "src/apis/sql": "1.0.3", + "src/apis/sqladmin": "19.0.0", + "src/apis/storage": "15.0.0", + "src/apis/streetviewpublish": "4.0.5", + "src/apis/sts": "7.0.0", + "src/apis/tagmanager": "5.0.2", + "src/apis/testing": "10.0.0", + "src/apis/toolresults": "3.3.2", + "src/apis/trafficdirector": "4.0.0", + "src/apis/travelimpactmodel": "2.0.2", + "src/apis/vault": "3.4.2", + "src/apis/vectortile": "1.0.3", + "src/apis/verifiedaccess": "3.4.0", + "src/apis/versionhistory": "1.3.0", + "src/apis/walletobjects": "4.1.0", + "src/apis/webfonts": "1.4.0", + "src/apis/webmasters": "1.0.3", + "src/apis/workflowexecutions": "7.5.0", + "src/apis/workloadmanager": "13.0.0", + "src/apis/workspaceevents": "1.0.1", + "src/apis/youtube": "19.0.0", + "src/apis/youtubeAnalytics": "2.0.5", + "src/apis/youtubereporting": "1.0.5", + ".": "140.0.1" +} \ No newline at end of file diff --git a/discovery/accesscontextmanager-v1.json b/discovery/accesscontextmanager-v1.json index c475b3e72b..4043b79bdb 100644 --- a/discovery/accesscontextmanager-v1.json +++ b/discovery/accesscontextmanager-v1.json @@ -1290,7 +1290,7 @@ } } }, - "revision": "20240623", + "revision": "20240708", "rootUrl": "https://accesscontextmanager.googleapis.com/", "schemas": { "AccessContextManagerOperationMetadata": { @@ -1332,6 +1332,7 @@ "properties": { "etag": { "description": "Output only. An opaque identifier for the current version of the `AccessPolicy`. This will always be a strongly validated etag, meaning that two Access Policies will be identical if and only if their etags are identical. Clients should not expect this to be in any specific format.", + "readOnly": true, "type": "string" }, "name": { @@ -1741,7 +1742,7 @@ "type": "string" }, "sources": { - "description": "Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`.", + "description": "Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out.", "items": { "$ref": "EgressSource" }, @@ -1770,7 +1771,7 @@ "id": "EgressSource", "properties": { "accessLevel": { - "description": "An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed.", + "description": "An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out.", "type": "string" } }, @@ -2548,7 +2549,7 @@ "properties": { "vpcSubnetwork": { "$ref": "VpcSubNetwork", - "description": "Sub-segment ranges of a VPC network." + "description": "Sub-segment ranges of a VPC network. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out." } }, "type": "object" diff --git a/discovery/addressvalidation-v1.json b/discovery/addressvalidation-v1.json index 62bbdf7378..26c380a2d5 100644 --- a/discovery/addressvalidation-v1.json +++ b/discovery/addressvalidation-v1.json @@ -151,7 +151,7 @@ } } }, - "revision": "20240430", + "revision": "20240715", "rootUrl": "https://addressvalidation.googleapis.com/", "schemas": { "GoogleGeoTypeViewport": { @@ -489,7 +489,7 @@ "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 by 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.", + "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" }, "dpvFootnote": { diff --git a/discovery/admin-directory_v1.json b/discovery/admin-directory_v1.json index 6d1b7ee3f3..63989910ca 100644 --- a/discovery/admin-directory_v1.json +++ b/discovery/admin-directory_v1.json @@ -3931,7 +3931,7 @@ ] }, "insert": { - "description": "Creates a user. Mutate calls immediately following user creation might sometimes fail as the user isn't fully created due to propagation delay in our backends. Check the error details for the \"User creation is not complete\" message to see if this is the case. Retrying the calls after some time can help in this case.", + "description": "Creates a user. Mutate calls immediately following user creation might sometimes fail as the user isn't fully created due to propagation delay in our backends. Check the error details for the \"User creation is not complete\" message to see if this is the case. Retrying the calls after some time can help in this case. If `resolveConflictAccount` is set to `true`, a `202` response code means that a conflicting unmanaged account exists and was invited to join the organization. A `409` response code means that a conflicting account exists so the user wasn't created based on the [handling unmanaged user accounts](https://support.google.com/a/answer/11112794) option selected.", "flatPath": "admin/directory/v1/users", "httpMethod": "POST", "id": "directory.users.insert", @@ -4671,7 +4671,7 @@ } } }, - "revision": "20240618", + "revision": "20240709", "rootUrl": "https://admin.googleapis.com/", "schemas": { "Alias": { diff --git a/discovery/adsenseplatform-v1alpha.json b/discovery/adsenseplatform-v1alpha.json new file mode 100644 index 0000000000..471a110d7b --- /dev/null +++ b/discovery/adsenseplatform-v1alpha.json @@ -0,0 +1,721 @@ +{ + "auth": { + "oauth2": { + "scopes": { + "https://www.googleapis.com/auth/adsense": { + "description": "View and manage your AdSense data" + }, + "https://www.googleapis.com/auth/adsense.readonly": { + "description": "View your AdSense data" + } + } + } + }, + "basePath": "", + "baseUrl": "https://adsenseplatform.googleapis.com/", + "batchPath": "batch", + "canonicalName": "AdSense Platform", + "description": "", + "discoveryVersion": "v1", + "documentationLink": "https://developers.google.com/adsense/platforms/", + "fullyEncodeReservedExpansion": true, + "icons": { + "x16": "http://www.google.com/images/icons/product/search-16.gif", + "x32": "http://www.google.com/images/icons/product/search-32.gif" + }, + "id": "adsenseplatform:v1alpha", + "kind": "discovery#restDescription", + "mtlsRootUrl": "https://adsenseplatform.mtls.googleapis.com/", + "name": "adsenseplatform", + "ownerDomain": "google.com", + "ownerName": "Google", + "parameters": { + "$.xgafv": { + "description": "V1 error format.", + "enum": [ + "1", + "2" + ], + "enumDescriptions": [ + "v1 error format", + "v2 error format" + ], + "location": "query", + "type": "string" + }, + "access_token": { + "description": "OAuth access token.", + "location": "query", + "type": "string" + }, + "alt": { + "default": "json", + "description": "Data format for response.", + "enum": [ + "json", + "media", + "proto" + ], + "enumDescriptions": [ + "Responses with Content-Type of application/json", + "Media download with context-dependent Content-Type", + "Responses with Content-Type of application/x-protobuf" + ], + "location": "query", + "type": "string" + }, + "callback": { + "description": "JSONP", + "location": "query", + "type": "string" + }, + "fields": { + "description": "Selector specifying which fields to include in a partial response.", + "location": "query", + "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.", + "location": "query", + "type": "string" + }, + "oauth_token": { + "description": "OAuth 2.0 token for the current user.", + "location": "query", + "type": "string" + }, + "prettyPrint": { + "default": "true", + "description": "Returns response with indentations and line breaks.", + "location": "query", + "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.", + "location": "query", + "type": "string" + }, + "uploadType": { + "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", + "location": "query", + "type": "string" + }, + "upload_protocol": { + "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", + "location": "query", + "type": "string" + } + }, + "protocol": "rest", + "resources": { + "platforms": { + "resources": { + "accounts": { + "methods": { + "close": { + "description": "Closes a sub-account.", + "flatPath": "v1alpha/platforms/{platformsId}/accounts/{accountsId}:close", + "httpMethod": "POST", + "id": "adsenseplatform.platforms.accounts.close", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Account to close. Format: platforms/{platform}/accounts/{account_id}", + "location": "path", + "pattern": "^platforms/[^/]+/accounts/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+name}:close", + "request": { + "$ref": "CloseAccountRequest" + }, + "response": { + "$ref": "CloseAccountResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/adsense" + ] + }, + "create": { + "description": "Creates a sub-account.", + "flatPath": "v1alpha/platforms/{platformsId}/accounts", + "httpMethod": "POST", + "id": "adsenseplatform.platforms.accounts.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. Platform to create an account for. Format: platforms/{platform}", + "location": "path", + "pattern": "^platforms/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+parent}/accounts", + "request": { + "$ref": "Account" + }, + "response": { + "$ref": "Account" + }, + "scopes": [ + "https://www.googleapis.com/auth/adsense" + ] + }, + "get": { + "description": "Gets information about the selected sub-account.", + "flatPath": "v1alpha/platforms/{platformsId}/accounts/{accountsId}", + "httpMethod": "GET", + "id": "adsenseplatform.platforms.accounts.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Account to get information about. Format: platforms/{platform}/accounts/{account_id}", + "location": "path", + "pattern": "^platforms/[^/]+/accounts/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "response": { + "$ref": "Account" + }, + "scopes": [ + "https://www.googleapis.com/auth/adsense", + "https://www.googleapis.com/auth/adsense.readonly" + ] + }, + "list": { + "description": "Lists a partial view of sub-accounts for a specific parent account.", + "flatPath": "v1alpha/platforms/{platformsId}/accounts", + "httpMethod": "GET", + "id": "adsenseplatform.platforms.accounts.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "Optional. The maximum number of accounts to include in the response, used for paging. If unspecified, at most 10000 accounts will be returned. The maximum value is 10000; values above 10000 will be coerced to 10000.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. A page token, received from a previous `ListAccounts` call. Provide this to retrieve the subsequent page.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. Platform who parents the accounts. Format: platforms/{platform}", + "location": "path", + "pattern": "^platforms/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+parent}/accounts", + "response": { + "$ref": "ListAccountsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/adsense", + "https://www.googleapis.com/auth/adsense.readonly" + ] + }, + "lookup": { + "description": "Looks up information about a sub-account for a specified creation_request_id. If no account exists for the given creation_request_id, returns 404.", + "flatPath": "v1alpha/platforms/{platformsId}/accounts:lookup", + "httpMethod": "GET", + "id": "adsenseplatform.platforms.accounts.lookup", + "parameterOrder": [ + "parent" + ], + "parameters": { + "creationRequestId": { + "description": "Optional. The creation_request_id provided when calling createAccount.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. Platform who parents the account. Format: platforms/{platform}", + "location": "path", + "pattern": "^platforms/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+parent}/accounts:lookup", + "response": { + "$ref": "LookupAccountResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/adsense", + "https://www.googleapis.com/auth/adsense.readonly" + ] + } + }, + "resources": { + "events": { + "methods": { + "create": { + "description": "Creates an account event.", + "flatPath": "v1alpha/platforms/{platformsId}/accounts/{accountsId}/events", + "httpMethod": "POST", + "id": "adsenseplatform.platforms.accounts.events.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. Account to log events about. Format: platforms/{platform}/accounts/{account}", + "location": "path", + "pattern": "^platforms/[^/]+/accounts/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+parent}/events", + "request": { + "$ref": "Event" + }, + "response": { + "$ref": "Event" + }, + "scopes": [ + "https://www.googleapis.com/auth/adsense" + ] + } + } + }, + "sites": { + "methods": { + "create": { + "description": "Creates a site for a specified account.", + "flatPath": "v1alpha/platforms/{platformsId}/accounts/{accountsId}/sites", + "httpMethod": "POST", + "id": "adsenseplatform.platforms.accounts.sites.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. Account to create site. Format: platforms/{platform}/accounts/{account_id}", + "location": "path", + "pattern": "^platforms/[^/]+/accounts/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+parent}/sites", + "request": { + "$ref": "Site" + }, + "response": { + "$ref": "Site" + }, + "scopes": [ + "https://www.googleapis.com/auth/adsense" + ] + }, + "delete": { + "description": "Deletes a site from a specified account.", + "flatPath": "v1alpha/platforms/{platformsId}/accounts/{accountsId}/sites/{sitesId}", + "httpMethod": "DELETE", + "id": "adsenseplatform.platforms.accounts.sites.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the site to delete. Format: platforms/{platform}/accounts/{account}/sites/{site}", + "location": "path", + "pattern": "^platforms/[^/]+/accounts/[^/]+/sites/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "response": { + "$ref": "Empty" + }, + "scopes": [ + "https://www.googleapis.com/auth/adsense" + ] + }, + "get": { + "description": "Gets a site from a specified sub-account.", + "flatPath": "v1alpha/platforms/{platformsId}/accounts/{accountsId}/sites/{sitesId}", + "httpMethod": "GET", + "id": "adsenseplatform.platforms.accounts.sites.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the site to retrieve. Format: platforms/{platform}/accounts/{account}/sites/{site}", + "location": "path", + "pattern": "^platforms/[^/]+/accounts/[^/]+/sites/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "response": { + "$ref": "Site" + }, + "scopes": [ + "https://www.googleapis.com/auth/adsense", + "https://www.googleapis.com/auth/adsense.readonly" + ] + }, + "list": { + "description": "Lists sites for a specific account.", + "flatPath": "v1alpha/platforms/{platformsId}/accounts/{accountsId}/sites", + "httpMethod": "GET", + "id": "adsenseplatform.platforms.accounts.sites.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "The maximum number of sites to include in the response, used for paging. If unspecified, at most 10000 sites will be returned. The maximum value is 10000; values above 10000 will be coerced to 10000.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A page token, received from a previous `ListSites` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListSites` must match the call that provided the page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The account which owns the sites. Format: platforms/{platform}/accounts/{account}", + "location": "path", + "pattern": "^platforms/[^/]+/accounts/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+parent}/sites", + "response": { + "$ref": "ListSitesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/adsense", + "https://www.googleapis.com/auth/adsense.readonly" + ] + }, + "requestReview": { + "description": "Requests the review of a site. The site should be in REQUIRES_REVIEW or NEEDS_ATTENTION state. Note: Make sure you place an [ad tag](https://developers.google.com/adsense/platforms/direct/ad-tags) on your site before requesting a review.", + "flatPath": "v1alpha/platforms/{platformsId}/accounts/{accountsId}/sites/{sitesId}:requestReview", + "httpMethod": "POST", + "id": "adsenseplatform.platforms.accounts.sites.requestReview", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the site to submit for review. Format: platforms/{platform}/accounts/{account}/sites/{site}", + "location": "path", + "pattern": "^platforms/[^/]+/accounts/[^/]+/sites/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+name}:requestReview", + "response": { + "$ref": "RequestSiteReviewResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/adsense" + ] + } + } + } + } + } + } + } + }, + "revision": "20240717", + "rootUrl": "https://adsenseplatform.googleapis.com/", + "schemas": { + "Account": { + "description": "Representation of an Account.", + "id": "Account", + "properties": { + "createTime": { + "description": "Output only. Creation time of the account.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "creationRequestId": { + "description": "Required. An opaque token that uniquely identifies the account among all the platform's accounts. This string may contain at most 64 non-whitespace ASCII characters, but otherwise has no predefined structure. However, it is expected to be a platform-specific identifier for the user creating the account, so that only a single account can be created for any given user. This field must not contain any information that is recognizable as personally identifiable information. e.g. it should not be an email address or login name. Once an account has been created, a second attempt to create an account using the same creation_request_id will result in an ALREADY_EXISTS error.", + "type": "string" + }, + "displayName": { + "description": "Display name of this account.", + "type": "string" + }, + "name": { + "description": "Output only. Resource name of the account. Format: platforms/pub-[0-9]+/accounts/pub-[0-9]+", + "readOnly": true, + "type": "string" + }, + "regionCode": { + "description": "Required. Input only. CLDR region code of the country/region of the address. Set this to country code of the child account if known, otherwise to your own country code.", + "type": "string" + }, + "state": { + "description": "Output only. Approval state of the account.", + "enum": [ + "STATE_UNSPECIFIED", + "UNCHECKED", + "APPROVED", + "DISAPPROVED" + ], + "enumDescriptions": [ + "Unspecified.", + "Unchecked.", + "The account is ready to serve ads.", + "The account has been blocked from serving ads." + ], + "readOnly": true, + "type": "string" + }, + "timeZone": { + "$ref": "TimeZone", + "description": "Required. The IANA TZ timezone code of this account. For more information, see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones. This field is used for reporting. It is recommended to set it to the same value for all child accounts." + } + }, + "type": "object" + }, + "Address": { + "description": "Address data.", + "id": "Address", + "properties": { + "address1": { + "description": "First line of address. Max length 64 bytes or 30 characters.", + "type": "string" + }, + "address2": { + "description": "Second line of address. Max length 64 bytes or 30 characters.", + "type": "string" + }, + "city": { + "description": "City. Max length 60 bytes or 30 characters.", + "type": "string" + }, + "company": { + "description": "Name of the company. Max length 255 bytes or 34 characters.", + "type": "string" + }, + "contact": { + "description": "Contact name of the company. Max length 128 bytes or 34 characters.", + "type": "string" + }, + "fax": { + "description": "Fax number with international code (i.e. +441234567890).", + "type": "string" + }, + "phone": { + "description": "Phone number with international code (i.e. +441234567890).", + "type": "string" + }, + "regionCode": { + "description": "Country/Region code. The region is specified as a CLDR region code (e.g. \"US\", \"FR\").", + "type": "string" + }, + "state": { + "description": "State. Max length 60 bytes or 30 characters.", + "type": "string" + }, + "zip": { + "description": "Zip/post code. Max length 10 bytes or 10 characters.", + "type": "string" + } + }, + "type": "object" + }, + "CloseAccountRequest": { + "description": "Request definition for the account close rpc.", + "id": "CloseAccountRequest", + "properties": {}, + "type": "object" + }, + "CloseAccountResponse": { + "description": "Response definition for the account close rpc.", + "id": "CloseAccountResponse", + "properties": {}, + "type": "object" + }, + "Empty": { + "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }", + "id": "Empty", + "properties": {}, + "type": "object" + }, + "Event": { + "description": "A platform sub-account event to record spam signals.", + "id": "Event", + "properties": { + "eventInfo": { + "$ref": "EventInfo", + "description": "Required. Information associated with the event." + }, + "eventTime": { + "description": "Required. Event timestamp.", + "format": "google-datetime", + "type": "string" + }, + "eventType": { + "description": "Required. Event type.", + "enum": [ + "EVENT_TYPE_UNSPECIFIED", + "LOG_IN_VIA_PLATFORM", + "SIGN_UP_VIA_PLATFORM" + ], + "enumDescriptions": [ + "Do not use. You must set an event type explicitly.", + "Log in via platform.", + "Sign up via platform." + ], + "type": "string" + } + }, + "type": "object" + }, + "EventInfo": { + "description": "Private information for partner recorded events (PII).", + "id": "EventInfo", + "properties": { + "billingAddress": { + "$ref": "Address", + "description": "The billing address of the publisher associated with this event, if available." + }, + "email": { + "description": "Required. The email address that is associated with the publisher when performing the event.", + "type": "string" + } + }, + "type": "object" + }, + "ListAccountsResponse": { + "description": "Response definition for the list accounts rpc.", + "id": "ListAccountsResponse", + "properties": { + "accounts": { + "description": "The Accounts returned in the list response. Represented by a partial view of the Account resource, populating `name` and `creation_request_id`.", + "items": { + "$ref": "Account" + }, + "type": "array" + }, + "nextPageToken": { + "description": "Continuation token used to page through accounts. To retrieve the next page of the results, set the next request's \"page_token\" value to this.", + "type": "string" + } + }, + "type": "object" + }, + "ListSitesResponse": { + "description": "Response definition for the site list rpc.", + "id": "ListSitesResponse", + "properties": { + "nextPageToken": { + "description": "Continuation token used to page through sites. To retrieve the next page of the results, set the next request's \"page_token\" value to this.", + "type": "string" + }, + "sites": { + "description": "The sites returned in this list response.", + "items": { + "$ref": "Site" + }, + "type": "array" + } + }, + "type": "object" + }, + "LookupAccountResponse": { + "description": "Response definition for the lookup account rpc.", + "id": "LookupAccountResponse", + "properties": { + "name": { + "description": "The name of the Account Format: platforms/{platform}/accounts/{account_id}", + "type": "string" + } + }, + "type": "object" + }, + "RequestSiteReviewResponse": { + "description": "Response definition for the site request review rpc.", + "id": "RequestSiteReviewResponse", + "properties": {}, + "type": "object" + }, + "Site": { + "description": "Representation of a Site.", + "id": "Site", + "properties": { + "domain": { + "description": "Domain/sub-domain of the site. Must be a valid domain complying with [RFC 1035](https://www.ietf.org/rfc/rfc1035.txt) and formatted as punycode [RFC 3492](https://www.ietf.org/rfc/rfc3492.txt) in case the domain contains unicode characters.", + "type": "string" + }, + "name": { + "description": "Output only. Resource name of a site. Format: platforms/{platform}/accounts/{account}/sites/{site}", + "readOnly": true, + "type": "string" + }, + "state": { + "description": "Output only. State of a site.", + "enum": [ + "STATE_UNSPECIFIED", + "REQUIRES_REVIEW", + "GETTING_READY", + "READY", + "NEEDS_ATTENTION" + ], + "enumDescriptions": [ + "State unspecified.", + "Either: - The site hasn't been checked yet. - The site is inactive and needs another review before it can show ads again. Learn how to [request a review for an inactive site](https://support.google.com/adsense/answer/9393996).", + "Google is running some checks on the site. This usually takes a few days, but in some cases it can take two to four weeks.", + "The site is ready to show ads. Learn how to [set up ads on the site](https://support.google.com/adsense/answer/7037624).", + "Publisher needs to fix some issues before the site is ready to show ads. Learn what to do [if a new site isn't ready](https://support.google.com/adsense/answer/9061852)." + ], + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "TimeZone": { + "description": "Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones).", + "id": "TimeZone", + "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" + } + }, + "type": "object" + } + }, + "servicePath": "", + "title": "AdSense Platform API", + "version": "v1alpha", + "version_module": true +} \ No newline at end of file diff --git a/discovery/aiplatform-v1.json b/discovery/aiplatform-v1.json index 9af8ff67b9..fd07383fec 100644 --- a/discovery/aiplatform-v1.json +++ b/discovery/aiplatform-v1.json @@ -20,19 +20,19 @@ "documentationLink": "https://cloud.google.com/vertex-ai/", "endpoints": [ { - "location": "africa-south1", "endpointUrl": "https://africa-south1-aiplatform.googleapis.com/", - "description": "Locational Endpoint" + "description": "Locational Endpoint", + "location": "africa-south1" }, { - "location": "asia-east1", "endpointUrl": "https://asia-east1-aiplatform.googleapis.com/", - "description": "Locational Endpoint" + "description": "Locational Endpoint", + "location": "asia-east1" }, { + "description": "Locational Endpoint", "endpointUrl": "https://asia-east2-aiplatform.googleapis.com/", - "location": "asia-east2", - "description": "Locational Endpoint" + "location": "asia-east2" }, { "endpointUrl": "https://asia-northeast1-aiplatform.googleapis.com/", @@ -41,32 +41,32 @@ }, { "location": "asia-northeast2", - "endpointUrl": "https://asia-northeast2-aiplatform.googleapis.com/", - "description": "Locational Endpoint" + "description": "Locational Endpoint", + "endpointUrl": "https://asia-northeast2-aiplatform.googleapis.com/" }, { "location": "asia-northeast3", - "description": "Locational Endpoint", - "endpointUrl": "https://asia-northeast3-aiplatform.googleapis.com/" + "endpointUrl": "https://asia-northeast3-aiplatform.googleapis.com/", + "description": "Locational Endpoint" }, { "description": "Locational Endpoint", - "location": "asia-south1", - "endpointUrl": "https://asia-south1-aiplatform.googleapis.com/" + "endpointUrl": "https://asia-south1-aiplatform.googleapis.com/", + "location": "asia-south1" }, { + "endpointUrl": "https://asia-southeast1-aiplatform.googleapis.com/", "description": "Locational Endpoint", - "location": "asia-southeast1", - "endpointUrl": "https://asia-southeast1-aiplatform.googleapis.com/" + "location": "asia-southeast1" }, { + "endpointUrl": "https://asia-southeast2-aiplatform.googleapis.com/", "location": "asia-southeast2", - "description": "Locational Endpoint", - "endpointUrl": "https://asia-southeast2-aiplatform.googleapis.com/" + "description": "Locational Endpoint" }, { - "location": "australia-southeast1", "description": "Locational Endpoint", + "location": "australia-southeast1", "endpointUrl": "https://australia-southeast1-aiplatform.googleapis.com/" }, { @@ -75,34 +75,34 @@ "endpointUrl": "https://australia-southeast2-aiplatform.googleapis.com/" }, { - "endpointUrl": "https://europe-central2-aiplatform.googleapis.com/", + "location": "europe-central2", "description": "Locational Endpoint", - "location": "europe-central2" + "endpointUrl": "https://europe-central2-aiplatform.googleapis.com/" }, { - "location": "europe-north1", "endpointUrl": "https://europe-north1-aiplatform.googleapis.com/", + "location": "europe-north1", "description": "Locational Endpoint" }, { - "endpointUrl": "https://europe-southwest1-aiplatform.googleapis.com/", + "description": "Locational Endpoint", "location": "europe-southwest1", - "description": "Locational Endpoint" + "endpointUrl": "https://europe-southwest1-aiplatform.googleapis.com/" }, { + "location": "europe-west1", "description": "Locational Endpoint", - "endpointUrl": "https://europe-west1-aiplatform.googleapis.com/", - "location": "europe-west1" + "endpointUrl": "https://europe-west1-aiplatform.googleapis.com/" }, { - "description": "Locational Endpoint", "endpointUrl": "https://europe-west2-aiplatform.googleapis.com/", - "location": "europe-west2" + "location": "europe-west2", + "description": "Locational Endpoint" }, { - "location": "europe-west3", + "description": "Locational Endpoint", "endpointUrl": "https://europe-west3-aiplatform.googleapis.com/", - "description": "Locational Endpoint" + "location": "europe-west3" }, { "description": "Locational Endpoint", @@ -115,33 +115,33 @@ "endpointUrl": "https://europe-west6-aiplatform.googleapis.com/" }, { - "endpointUrl": "https://europe-west8-aiplatform.googleapis.com/", "description": "Locational Endpoint", - "location": "europe-west8" + "location": "europe-west8", + "endpointUrl": "https://europe-west8-aiplatform.googleapis.com/" }, { "location": "europe-west9", - "endpointUrl": "https://europe-west9-aiplatform.googleapis.com/", - "description": "Locational Endpoint" + "description": "Locational Endpoint", + "endpointUrl": "https://europe-west9-aiplatform.googleapis.com/" }, { - "location": "europe-west12", "endpointUrl": "https://europe-west12-aiplatform.googleapis.com/", - "description": "Locational Endpoint" + "description": "Locational Endpoint", + "location": "europe-west12" }, { - "location": "me-central1", + "description": "Locational Endpoint", "endpointUrl": "https://me-central1-aiplatform.googleapis.com/", - "description": "Locational Endpoint" + "location": "me-central1" }, { - "location": "me-central2", + "description": "Locational Endpoint", "endpointUrl": "https://me-central2-aiplatform.googleapis.com/", - "description": "Locational Endpoint" + "location": "me-central2" }, { - "location": "me-west1", "endpointUrl": "https://me-west1-aiplatform.googleapis.com/", + "location": "me-west1", "description": "Locational Endpoint" }, { @@ -150,34 +150,34 @@ "endpointUrl": "https://northamerica-northeast1-aiplatform.googleapis.com/" }, { - "endpointUrl": "https://northamerica-northeast2-aiplatform.googleapis.com/", "location": "northamerica-northeast2", + "endpointUrl": "https://northamerica-northeast2-aiplatform.googleapis.com/", "description": "Locational Endpoint" }, { - "location": "southamerica-east1", + "description": "Locational Endpoint", "endpointUrl": "https://southamerica-east1-aiplatform.googleapis.com/", - "description": "Locational Endpoint" + "location": "southamerica-east1" }, { - "location": "southamerica-west1", "description": "Locational Endpoint", + "location": "southamerica-west1", "endpointUrl": "https://southamerica-west1-aiplatform.googleapis.com/" }, { - "description": "Locational Endpoint", "endpointUrl": "https://us-central1-aiplatform.googleapis.com/", - "location": "us-central1" + "location": "us-central1", + "description": "Locational Endpoint" }, { - "location": "us-central2", + "description": "Locational Endpoint", "endpointUrl": "https://us-central2-aiplatform.googleapis.com/", - "description": "Locational Endpoint" + "location": "us-central2" }, { "location": "us-east1", - "endpointUrl": "https://us-east1-aiplatform.googleapis.com/", - "description": "Locational Endpoint" + "description": "Locational Endpoint", + "endpointUrl": "https://us-east1-aiplatform.googleapis.com/" }, { "location": "us-east4", @@ -185,34 +185,34 @@ "description": "Locational Endpoint" }, { - "location": "us-south1", "endpointUrl": "https://us-south1-aiplatform.googleapis.com/", - "description": "Locational Endpoint" + "description": "Locational Endpoint", + "location": "us-south1" }, { - "description": "Locational Endpoint", "location": "us-west1", - "endpointUrl": "https://us-west1-aiplatform.googleapis.com/" + "endpointUrl": "https://us-west1-aiplatform.googleapis.com/", + "description": "Locational Endpoint" }, { "endpointUrl": "https://us-west2-aiplatform.googleapis.com/", - "location": "us-west2", - "description": "Locational Endpoint" + "description": "Locational Endpoint", + "location": "us-west2" }, { "location": "us-west3", - "endpointUrl": "https://us-west3-aiplatform.googleapis.com/", - "description": "Locational Endpoint" + "description": "Locational Endpoint", + "endpointUrl": "https://us-west3-aiplatform.googleapis.com/" }, { "description": "Locational Endpoint", - "location": "us-west4", - "endpointUrl": "https://us-west4-aiplatform.googleapis.com/" + "endpointUrl": "https://us-west4-aiplatform.googleapis.com/", + "location": "us-west4" }, { + "endpointUrl": "https://us-east5-aiplatform.googleapis.com/", "location": "us-east5", - "description": "Locational Endpoint", - "endpointUrl": "https://us-east5-aiplatform.googleapis.com/" + "description": "Locational Endpoint" } ], "fullyEncodeReservedExpansion": true, @@ -2822,6 +2822,40 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "patch": { + "description": "Update a DeploymentResourcePool.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools/{deploymentResourcePoolsId}", + "httpMethod": "PATCH", + "id": "aiplatform.projects.locations.deploymentResourcePools.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Immutable. The resource name of the DeploymentResourcePool. Format: `projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/deploymentResourcePools/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Required. The list of fields to update.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}", + "request": { + "$ref": "GoogleCloudAiplatformV1DeploymentResourcePool" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "queryDeployedModels": { "description": "List DeployedModels that have been deployed on this DeploymentResourcePool.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools/{deploymentResourcePoolsId}:queryDeployedModels", @@ -3893,7 +3927,7 @@ "type": "string" }, "updateMask": { - "description": "Field mask is used to specify the fields to be overwritten in the FeatureGroup resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `labels`", + "description": "Field mask is used to specify the fields to be overwritten in the FeatureGroup resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `labels` * `description` * `big_query` * `big_query.entity_id_columns`", "format": "google-fieldmask", "location": "query", "type": "string" @@ -4072,7 +4106,7 @@ "type": "string" }, "updateMask": { - "description": "Field mask is used to specify the fields to be overwritten in the Features resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `description` * `labels` * `disable_monitoring` (Not supported for FeatureRegistry Feature)", + "description": "Field mask is used to specify the fields to be overwritten in the Features resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `description` * `labels` * `disable_monitoring` (Not supported for FeatureRegistryService Feature) * `point_of_contact` (Not supported for FeaturestoreService FeatureStore)", "format": "google-fieldmask", "location": "query", "type": "string" @@ -4500,7 +4534,7 @@ "type": "string" }, "updateMask": { - "description": "Field mask is used to specify the fields to be overwritten in the FeatureOnlineStore resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `big_query_source` * `bigtable` * `labels` * `sync_config`", + "description": "Field mask is used to specify the fields to be overwritten in the FeatureOnlineStore resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `labels` * `description` * `bigtable` * `bigtable.auto_scaling` * `bigtable.enable_multi_region_replica`", "format": "google-fieldmask", "location": "query", "type": "string" @@ -4700,7 +4734,7 @@ "type": "string" }, "updateMask": { - "description": "Field mask is used to specify the fields to be overwritten in the FeatureView resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `labels` * `serviceAgentType`", + "description": "Field mask is used to specify the fields to be overwritten in the FeatureView resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `labels` * `service_agent_type` * `big_query_source` * `big_query_source.uri` * `big_query_source.entity_id_columns` * `feature_registry_source` * `feature_registry_source.feature_groups` * `sync_config` * `sync_config.cron`", "format": "google-fieldmask", "location": "query", "type": "string" @@ -6067,7 +6101,7 @@ "type": "string" }, "updateMask": { - "description": "Field mask is used to specify the fields to be overwritten in the Features resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `description` * `labels` * `disable_monitoring` (Not supported for FeatureRegistry Feature)", + "description": "Field mask is used to specify the fields to be overwritten in the Features resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `description` * `labels` * `disable_monitoring` (Not supported for FeatureRegistryService Feature) * `point_of_contact` (Not supported for FeaturestoreService FeatureStore)", "format": "google-fieldmask", "location": "query", "type": "string" @@ -11145,6 +11179,167 @@ } }, "notebookExecutionJobs": { + "methods": { + "create": { + "description": "Creates a NotebookExecutionJob.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/notebookExecutionJobs", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.notebookExecutionJobs.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "notebookExecutionJobId": { + "description": "Optional. User specified ID for the NotebookExecutionJob.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the Location to create the NotebookExecutionJob. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/notebookExecutionJobs", + "request": { + "$ref": "GoogleCloudAiplatformV1NotebookExecutionJob" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a NotebookExecutionJob.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/notebookExecutionJobs/{notebookExecutionJobsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.notebookExecutionJobs.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the NotebookExecutionJob resource to be deleted.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/notebookExecutionJobs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets a NotebookExecutionJob.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/notebookExecutionJobs/{notebookExecutionJobsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.notebookExecutionJobs.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the NotebookExecutionJob resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/notebookExecutionJobs/[^/]+$", + "required": true, + "type": "string" + }, + "view": { + "description": "Optional. The NotebookExecutionJob view. Defaults to BASIC.", + "enum": [ + "NOTEBOOK_EXECUTION_JOB_VIEW_UNSPECIFIED", + "NOTEBOOK_EXECUTION_JOB_VIEW_BASIC", + "NOTEBOOK_EXECUTION_JOB_VIEW_FULL" + ], + "enumDescriptions": [ + "When unspecified, the API defaults to the BASIC view.", + "Includes all fields except for direct notebook inputs.", + "Includes all fields." + ], + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleCloudAiplatformV1NotebookExecutionJob" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists NotebookExecutionJobs in a Location.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/notebookExecutionJobs", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.notebookExecutionJobs.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `notebookExecutionJob` supports = and !=. `notebookExecutionJob` represents the NotebookExecutionJob ID. * `displayName` supports = and != and regex. * `schedule` supports = and != and regex. Some examples: * `notebookExecutionJob=\"123\"` * `notebookExecutionJob=\"my-execution-job\"` * `displayName=\"myDisplayName\"` and `displayName=~\"myDisplayNameRegex\"`", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Optional. A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * `display_name` * `create_time` * `update_time` Example: `display_name, create_time desc`.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. The standard list page token. Typically obtained via ListNotebookExecutionJobs.next_page_token of the previous NotebookService.ListNotebookExecutionJobs call.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the Location from which to list the NotebookExecutionJobs. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + }, + "view": { + "description": "Optional. The NotebookExecutionJob view. Defaults to BASIC.", + "enum": [ + "NOTEBOOK_EXECUTION_JOB_VIEW_UNSPECIFIED", + "NOTEBOOK_EXECUTION_JOB_VIEW_BASIC", + "NOTEBOOK_EXECUTION_JOB_VIEW_FULL" + ], + "enumDescriptions": [ + "When unspecified, the API defaults to the BASIC view.", + "Includes all fields except for direct notebook inputs.", + "Includes all fields." + ], + "location": "query", + "type": "string" + } + }, + "path": "v1/{+parent}/notebookExecutionJobs", + "response": { + "$ref": "GoogleCloudAiplatformV1ListNotebookExecutionJobsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, "resources": { "operations": { "methods": { @@ -16776,11 +16971,11 @@ } } }, - "revision": "20240617", + "revision": "20240704", "rootUrl": "https://aiplatform.googleapis.com/", "schemas": { "CloudAiLargeModelsVisionGenerateVideoResponse": { - "description": "Generate video response.", + "description": "Next ID: 8 Generate video response.", "id": "CloudAiLargeModelsVisionGenerateVideoResponse", "properties": { "generatedSamples": { @@ -18246,7 +18441,12 @@ "GoogleCloudAiplatformV1BleuSpec": { "description": "Spec for bleu score metric - calculates the precision of n-grams in the prediction as compared to reference - returns a score ranging between 0 to 1.", "id": "GoogleCloudAiplatformV1BleuSpec", - "properties": {}, + "properties": { + "useEffectiveOrder": { + "description": "Optional. Whether to use_effective_order to compute bleu score.", + "type": "boolean" + } + }, "type": "object" }, "GoogleCloudAiplatformV1Blob": { @@ -18405,6 +18605,12 @@ }, "readOnly": true, "type": "array" + }, + "score": { + "description": "Output only. Confidence score of the candidate.", + "format": "double", + "readOnly": true, + "type": "number" } }, "type": "object" @@ -18615,12 +18821,23 @@ "description": "Request message for ComputeTokens RPC call.", "id": "GoogleCloudAiplatformV1ComputeTokensRequest", "properties": { + "contents": { + "description": "Optional. Input content.", + "items": { + "$ref": "GoogleCloudAiplatformV1Content" + }, + "type": "array" + }, "instances": { - "description": "Required. The instances that are the input to token computing API call. Schema is identical to the prediction schema of the text model, even for the non-text models, like chat models, or Codey models.", + "description": "Optional. The instances that are the input to token computing API call. Schema is identical to the prediction schema of the text model, even for the non-text models, like chat models, or Codey models.", "items": { "type": "any" }, "type": "array" + }, + "model": { + "description": "Optional. The name of the publisher model requested to serve the prediction. Format: projects/{project}/locations/{location}/publishers/*/models/*", + "type": "string" } }, "type": "object" @@ -18821,22 +19038,33 @@ "id": "GoogleCloudAiplatformV1CountTokensRequest", "properties": { "contents": { - "description": "Required. Input content.", + "description": "Optional. Input content.", "items": { "$ref": "GoogleCloudAiplatformV1Content" }, "type": "array" }, "instances": { - "description": "Required. The instances that are the input to token counting call. Schema is identical to the prediction schema of the underlying model.", + "description": "Optional. The instances that are the input to token counting call. Schema is identical to the prediction schema of the underlying model.", "items": { "type": "any" }, "type": "array" }, "model": { - "description": "Required. The name of the publisher model requested to serve the prediction. Format: `projects/{project}/locations/{location}/publishers/*/models/*`", + "description": "Optional. The name of the publisher model requested to serve the prediction. Format: `projects/{project}/locations/{location}/publishers/*/models/*`", "type": "string" + }, + "systemInstruction": { + "$ref": "GoogleCloudAiplatformV1Content", + "description": "Optional. The user provided system instructions for the model. Note: only text should be used in parts and content in each part will be in a separate paragraph." + }, + "tools": { + "description": "Optional. A list of `Tools` the model may use to generate the next 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.", + "items": { + "$ref": "GoogleCloudAiplatformV1Tool" + }, + "type": "array" } }, "type": "object" @@ -19039,6 +19267,21 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1CreateNotebookExecutionJobOperationMetadata": { + "description": "Metadata information for NotebookService.CreateNotebookExecutionJob.", + "id": "GoogleCloudAiplatformV1CreateNotebookExecutionJobOperationMetadata", + "properties": { + "genericMetadata": { + "$ref": "GoogleCloudAiplatformV1GenericOperationMetadata", + "description": "The operation generic information." + }, + "progressMessage": { + "description": "A human-readable message that shows the intermediate progress details of NotebookRuntime.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1CreateNotebookRuntimeTemplateOperationMetadata": { "description": "Metadata information for NotebookService.CreateNotebookRuntimeTemplate.", "id": "GoogleCloudAiplatformV1CreateNotebookRuntimeTemplateOperationMetadata", @@ -22077,10 +22320,19 @@ "description": "The dedicated serving endpoint for this FeatureOnlineStore. Only need to set when you choose Optimized storage type. Public endpoint is provisioned by default.", "id": "GoogleCloudAiplatformV1FeatureOnlineStoreDedicatedServingEndpoint", "properties": { + "privateServiceConnectConfig": { + "$ref": "GoogleCloudAiplatformV1PrivateServiceConnectConfig", + "description": "Optional. Private service connect config. The private service connection is available only for Optimized storage type, not for embedding management now. If PrivateServiceConnectConfig.enable_private_service_connect set to true, customers will use private service connection to send request. Otherwise, the connection will set to public endpoint." + }, "publicEndpointDomainName": { "description": "Output only. This field will be populated with the domain name to use for this FeatureOnlineStore", "readOnly": true, "type": "string" + }, + "serviceAttachment": { + "description": "Output only. The name of the service attachment resource. Populated if private service connect is enabled and after FeatureViewSync is created.", + "readOnly": true, + "type": "string" } }, "type": "object" @@ -23487,10 +23739,69 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1GroundingChunk": { + "description": "Grounding chunk.", + "id": "GoogleCloudAiplatformV1GroundingChunk", + "properties": { + "retrievedContext": { + "$ref": "GoogleCloudAiplatformV1GroundingChunkRetrievedContext", + "description": "Grounding chunk from context retrieved by the retrieval tools." + }, + "web": { + "$ref": "GoogleCloudAiplatformV1GroundingChunkWeb", + "description": "Grounding chunk from the web." + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1GroundingChunkRetrievedContext": { + "description": "Chunk from context retrieved by the retrieval tools.", + "id": "GoogleCloudAiplatformV1GroundingChunkRetrievedContext", + "properties": { + "title": { + "description": "Title of the attribution.", + "type": "string" + }, + "uri": { + "description": "URI reference of the attribution.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1GroundingChunkWeb": { + "description": "Chunk from the web.", + "id": "GoogleCloudAiplatformV1GroundingChunkWeb", + "properties": { + "title": { + "description": "Title of the chunk.", + "type": "string" + }, + "uri": { + "description": "URI reference of the chunk.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1GroundingMetadata": { "description": "Metadata returned to client when grounding is enabled.", "id": "GoogleCloudAiplatformV1GroundingMetadata", "properties": { + "groundingChunks": { + "description": "List of supporting references retrieved from specified grounding source.", + "items": { + "$ref": "GoogleCloudAiplatformV1GroundingChunk" + }, + "type": "array" + }, + "groundingSupports": { + "description": "Optional. List of grounding support.", + "items": { + "$ref": "GoogleCloudAiplatformV1GroundingSupport" + }, + "type": "array" + }, "searchEntryPoint": { "$ref": "GoogleCloudAiplatformV1SearchEntryPoint", "description": "Optional. Google search entry for the following-up web searches." @@ -23505,6 +23816,33 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1GroundingSupport": { + "description": "Grounding support.", + "id": "GoogleCloudAiplatformV1GroundingSupport", + "properties": { + "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.", + "items": { + "format": "float", + "type": "number" + }, + "type": "array" + }, + "groundingChunkIndices": { + "description": "A list of indices (into 'grounding_chunk') specifying the citations associated with the claim. For instance [1,3,4] means that grounding_chunk[1], grounding_chunk[3], grounding_chunk[4] are the retrieved content attributed to the claim.", + "items": { + "format": "int32", + "type": "integer" + }, + "type": "array" + }, + "segment": { + "$ref": "GoogleCloudAiplatformV1Segment", + "description": "Segment of the content this support belongs to." + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1HyperparameterTuningJob": { "description": "Represents a HyperparameterTuningJob. A HyperparameterTuningJob has a Study specification and multiple CustomJobs with identical CustomJob specification.", "id": "GoogleCloudAiplatformV1HyperparameterTuningJob", @@ -24891,6 +25229,24 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1ListNotebookExecutionJobsResponse": { + "description": "Response message for [NotebookService.CreateNotebookExecutionJob]", + "id": "GoogleCloudAiplatformV1ListNotebookExecutionJobsResponse", + "properties": { + "nextPageToken": { + "description": "A token to retrieve next page of results. Pass to ListNotebookExecutionJobs.page_token to obtain that page.", + "type": "string" + }, + "notebookExecutionJobs": { + "description": "List of NotebookExecutionJobs in the requested page.", + "items": { + "$ref": "GoogleCloudAiplatformV1NotebookExecutionJob" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1ListNotebookRuntimeTemplatesResponse": { "description": "Response message for NotebookService.ListNotebookRuntimeTemplates.", "id": "GoogleCloudAiplatformV1ListNotebookRuntimeTemplatesResponse", @@ -25218,6 +25574,22 @@ "TPU_V4_POD", "TPU_V5_LITEPOD" ], + "enumDeprecated": [ + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Unspecified accelerator type, which means no accelerator.", "Nvidia Tesla K80 GPU.", @@ -25769,6 +26141,16 @@ "$ref": "GoogleCloudAiplatformV1PredictSchemata", "description": "The schemata that describe formats of the Model's predictions and explanations as given and returned via PredictionService.Predict and PredictionService.Explain." }, + "satisfiesPzi": { + "description": "Output only. Reserved for future use.", + "readOnly": true, + "type": "boolean" + }, + "satisfiesPzs": { + "description": "Output only. Reserved for future use.", + "readOnly": true, + "type": "boolean" + }, "supportedDeploymentResourcesTypes": { "description": "Output only. When this Model is deployed, its prediction resources are described by the `prediction_resources` field of the Endpoint.deployed_models object. Because not all Models support all resource configuration types, the configuration types this Model supports are listed here. If no configuration types are listed, the Model cannot be deployed to an Endpoint and does not support online predictions (PredictionService.Predict or PredictionService.Explain). Such a Model can serve predictions by using a BatchPredictionJob, if it has at least one entry each in supported_input_storage_formats and supported_output_storage_formats.", "items": { @@ -27507,6 +27889,159 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1NotebookExecutionJob": { + "description": "NotebookExecutionJob represents an instance of a notebook execution.", + "id": "GoogleCloudAiplatformV1NotebookExecutionJob", + "properties": { + "createTime": { + "description": "Output only. Timestamp when this NotebookExecutionJob was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "dataformRepositorySource": { + "$ref": "GoogleCloudAiplatformV1NotebookExecutionJobDataformRepositorySource", + "description": "The Dataform Repository pointing to a single file notebook repository." + }, + "directNotebookSource": { + "$ref": "GoogleCloudAiplatformV1NotebookExecutionJobDirectNotebookSource", + "description": "The contents of an input notebook file." + }, + "displayName": { + "description": "The display name of the NotebookExecutionJob. The name can be up to 128 characters long and can consist of any UTF-8 characters.", + "type": "string" + }, + "executionTimeout": { + "description": "Max running time of the execution job in seconds (default 86400s / 24 hrs).", + "format": "google-duration", + "type": "string" + }, + "executionUser": { + "description": "The user email to run the execution as. Only supported by Colab runtimes.", + "type": "string" + }, + "gcsNotebookSource": { + "$ref": "GoogleCloudAiplatformV1NotebookExecutionJobGcsNotebookSource", + "description": "The Cloud Storage url pointing to the ipynb file. Format: `gs://bucket/notebook_file.ipynb`" + }, + "gcsOutputUri": { + "description": "The Cloud Storage location to upload the result to. Format: `gs://bucket-name`", + "type": "string" + }, + "jobState": { + "description": "Output only. The state of the NotebookExecutionJob.", + "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" + ], + "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." + ], + "readOnly": true, + "type": "string" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "The labels with user-defined metadata to organize NotebookExecutionJobs. 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" + }, + "name": { + "description": "Output only. The resource name of this NotebookExecutionJob. Format: `projects/{project_id}/locations/{location}/notebookExecutionJobs/{job_id}`", + "readOnly": true, + "type": "string" + }, + "notebookRuntimeTemplateResourceName": { + "description": "The NotebookRuntimeTemplate to source compute configuration from.", + "type": "string" + }, + "scheduleResourceName": { + "description": "Output only. The Schedule resource name if this job is triggered by one. Format: `projects/{project_id}/locations/{location}/schedules/{schedule_id}`", + "readOnly": true, + "type": "string" + }, + "serviceAccount": { + "description": "The service account to run the execution as.", + "type": "string" + }, + "status": { + "$ref": "GoogleRpcStatus", + "description": "Output only. Populated when the NotebookExecutionJob is completed. When there is an error during notebook execution, the error details are populated.", + "readOnly": true + }, + "updateTime": { + "description": "Output only. Timestamp when this NotebookExecutionJob was most recently updated.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1NotebookExecutionJobDataformRepositorySource": { + "description": "The Dataform Repository containing the input notebook.", + "id": "GoogleCloudAiplatformV1NotebookExecutionJobDataformRepositorySource", + "properties": { + "commitSha": { + "description": "The commit SHA to read repository with. If unset, the file will be read at HEAD.", + "type": "string" + }, + "dataformRepositoryResourceName": { + "description": "The resource name of the Dataform Repository. Format: `projects/{project_id}/locations/{location}/repositories/{repository_id}`", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1NotebookExecutionJobDirectNotebookSource": { + "description": "The content of the input notebook in ipynb format.", + "id": "GoogleCloudAiplatformV1NotebookExecutionJobDirectNotebookSource", + "properties": { + "content": { + "description": "The base64-encoded contents of the input notebook file.", + "format": "byte", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1NotebookExecutionJobGcsNotebookSource": { + "description": "The Cloud Storage uri for the input notebook.", + "id": "GoogleCloudAiplatformV1NotebookExecutionJobGcsNotebookSource", + "properties": { + "generation": { + "description": "The version of the Cloud Storage object to read. If unset, the current version of the object is read. See https://cloud.google.com/storage/docs/metadata#generation-number.", + "type": "string" + }, + "uri": { + "description": "The Cloud Storage uri pointing to the ipynb file. Format: `gs://bucket/notebook_file.ipynb`", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1NotebookIdleShutdownConfig": { "description": "The idle shutdown configuration of NotebookRuntimeTemplate, which contains the idle_timeout as required field.", "id": "GoogleCloudAiplatformV1NotebookIdleShutdownConfig", @@ -29023,6 +29558,10 @@ "$ref": "GoogleCloudAiplatformV1DedicatedResources", "description": "A description of resources that are dedicated to the DeployedModel, and that need a higher degree of manual configuration." }, + "deployMetadata": { + "$ref": "GoogleCloudAiplatformV1PublisherModelCallToActionDeployDeployMetadata", + "description": "Optional. Metadata information about this deployment config." + }, "deployTaskName": { "description": "Optional. The name of the deploy task (e.g., \"text to image generation\").", "type": "string" @@ -29050,6 +29589,20 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1PublisherModelCallToActionDeployDeployMetadata": { + "description": "Metadata information about the deployment for managing deployment config.", + "id": "GoogleCloudAiplatformV1PublisherModelCallToActionDeployDeployMetadata", + "properties": { + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. Labels for the deployment. For managing deployment config like verifying, source of deployment config, etc.", + "type": "object" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1PublisherModelCallToActionDeployGke": { "description": "Configurations for PublisherModel GKE deployment", "id": "GoogleCloudAiplatformV1PublisherModelCallToActionDeployGke", @@ -29710,6 +30263,17 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1RayLogsSpec": { + "description": "Configuration for the Ray OSS Logs.", + "id": "GoogleCloudAiplatformV1RayLogsSpec", + "properties": { + "disabled": { + "description": "Optional. Flag to disable the export of Ray OSS logs to Cloud Logging.", + "type": "boolean" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1RayMetricSpec": { "description": "Configuration for the Ray metrics.", "id": "GoogleCloudAiplatformV1RayMetricSpec", @@ -29733,6 +30297,10 @@ "description": "Optional. Default image for user to choose a preferred ML framework (for example, TensorFlow or Pytorch) by choosing from [Vertex prebuilt images](https://cloud.google.com/vertex-ai/docs/training/pre-built-containers). Either this or the resource_pool_images is required. Use this field if you need all the resource pools to have the same Ray image. Otherwise, use the {@code resource_pool_images} field.", "type": "string" }, + "rayLogsSpec": { + "$ref": "GoogleCloudAiplatformV1RayLogsSpec", + "description": "Optional. OSS Ray logging configurations." + }, "rayMetricSpec": { "$ref": "GoogleCloudAiplatformV1RayMetricSpec", "description": "Optional. Ray metrics configurations." @@ -30019,7 +30587,7 @@ "properties": { "autoscalingSpec": { "$ref": "GoogleCloudAiplatformV1ResourcePoolAutoscalingSpec", - "description": "Optional. Optional spec to configure GKE autoscaling" + "description": "Optional. Optional spec to configure GKE or Ray-on-Vertex autoscaling" }, "diskSpec": { "$ref": "GoogleCloudAiplatformV1DiskSpec", @@ -30057,7 +30625,7 @@ "type": "string" }, "minReplicaCount": { - "description": "Optional. min replicas in the node pool, must be ≤ replica_count and < max_replica_count or will throw error", + "description": "Optional. min replicas in the node pool, must be ≤ replica_count and < max_replica_count or will throw error. For autoscaling enabled Ray-on-Vertex, we allow min_replica_count of a resource_pool to be 0 to match the OSS Ray behavior(https://docs.ray.io/en/latest/cluster/vms/user-guides/configuring-autoscaling.html#cluster-config-parameters). As for Persistent Resource, the min_replica_count must be > 0, we added a corresponding validation inside CreatePersistentResourceRequestValidator.java.", "format": "int64", "type": "string" } @@ -34809,6 +35377,36 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1Segment": { + "description": "Segment of the content.", + "id": "GoogleCloudAiplatformV1Segment", + "properties": { + "endIndex": { + "description": "Output only. End index in the given Part, measured in bytes. Offset from the start of the Part, exclusive, starting at zero.", + "format": "int32", + "readOnly": true, + "type": "integer" + }, + "partIndex": { + "description": "Output only. The index of a Part object within its parent Content object.", + "format": "int32", + "readOnly": true, + "type": "integer" + }, + "startIndex": { + "description": "Output only. Start index in the given Part, measured in bytes. Offset from the start of the Part, inclusive, starting at zero.", + "format": "int32", + "readOnly": true, + "type": "integer" + }, + "text": { + "description": "Output only. The text corresponding to the segment from the response.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1ServiceAccountSpec": { "description": "Configuration for the use of custom service account to run the workloads.", "id": "GoogleCloudAiplatformV1ServiceAccountSpec", @@ -35896,11 +36494,18 @@ "id": "GoogleCloudAiplatformV1SupervisedTuningDataStats", "properties": { "totalBillableCharacterCount": { + "deprecated": true, "description": "Output only. Number of billable characters in the tuning dataset.", "format": "int64", "readOnly": true, "type": "string" }, + "totalBillableTokenCount": { + "description": "Output only. Number of billable tokens in the tuning dataset.", + "format": "int64", + "readOnly": true, + "type": "string" + }, "totalTuningCharacterCount": { "description": "Output only. Number of tuning characters in the tuning dataset.", "format": "int64", @@ -35949,6 +36554,12 @@ "description": "Dataset distribution for Supervised Tuning.", "id": "GoogleCloudAiplatformV1SupervisedTuningDatasetDistribution", "properties": { + "billableSum": { + "description": "Output only. Sum of a given population of values that are billable.", + "format": "int64", + "readOnly": true, + "type": "string" + }, "buckets": { "description": "Output only. Defines the histogram bucket.", "items": { @@ -36265,6 +36876,16 @@ "readOnly": true, "type": "integer" }, + "satisfiesPzi": { + "description": "Output only. Reserved for future use.", + "readOnly": true, + "type": "boolean" + }, + "satisfiesPzs": { + "description": "Output only. Reserved for future use.", + "readOnly": true, + "type": "boolean" + }, "updateTime": { "description": "Output only. Timestamp when this Tensorboard was last updated.", "format": "google-datetime", @@ -36608,6 +37229,10 @@ "description": "Tokens info with a list of tokens and the corresponding list of token ids.", "id": "GoogleCloudAiplatformV1TokensInfo", "properties": { + "role": { + "description": "Optional. Optional fields for the role from the corresponding Content.", + "type": "string" + }, "tokenIds": { "description": "A list of token ids from the input.", "items": { diff --git a/discovery/aiplatform-v1beta1.json b/discovery/aiplatform-v1beta1.json index e89cb69035..88ba9696af 100644 --- a/discovery/aiplatform-v1beta1.json +++ b/discovery/aiplatform-v1beta1.json @@ -20,34 +20,34 @@ "documentationLink": "https://cloud.google.com/vertex-ai/", "endpoints": [ { + "location": "africa-south1", "endpointUrl": "https://africa-south1-aiplatform.googleapis.com/", - "description": "Locational Endpoint", - "location": "africa-south1" + "description": "Locational Endpoint" }, { - "location": "asia-east1", "endpointUrl": "https://asia-east1-aiplatform.googleapis.com/", - "description": "Locational Endpoint" + "description": "Locational Endpoint", + "location": "asia-east1" }, { - "endpointUrl": "https://asia-east2-aiplatform.googleapis.com/", + "description": "Locational Endpoint", "location": "asia-east2", - "description": "Locational Endpoint" + "endpointUrl": "https://asia-east2-aiplatform.googleapis.com/" }, { - "location": "asia-northeast1", "endpointUrl": "https://asia-northeast1-aiplatform.googleapis.com/", - "description": "Locational Endpoint" + "description": "Locational Endpoint", + "location": "asia-northeast1" }, { - "description": "Locational Endpoint", + "location": "asia-northeast2", "endpointUrl": "https://asia-northeast2-aiplatform.googleapis.com/", - "location": "asia-northeast2" + "description": "Locational Endpoint" }, { - "location": "asia-northeast3", + "endpointUrl": "https://asia-northeast3-aiplatform.googleapis.com/", "description": "Locational Endpoint", - "endpointUrl": "https://asia-northeast3-aiplatform.googleapis.com/" + "location": "asia-northeast3" }, { "description": "Locational Endpoint", @@ -55,14 +55,14 @@ "location": "asia-south1" }, { + "description": "Locational Endpoint", "location": "asia-southeast1", - "endpointUrl": "https://asia-southeast1-aiplatform.googleapis.com/", - "description": "Locational Endpoint" + "endpointUrl": "https://asia-southeast1-aiplatform.googleapis.com/" }, { + "endpointUrl": "https://asia-southeast2-aiplatform.googleapis.com/", "location": "asia-southeast2", - "description": "Locational Endpoint", - "endpointUrl": "https://asia-southeast2-aiplatform.googleapis.com/" + "description": "Locational Endpoint" }, { "endpointUrl": "https://australia-southeast1-aiplatform.googleapis.com/", @@ -70,13 +70,13 @@ "description": "Locational Endpoint" }, { - "description": "Locational Endpoint", "location": "australia-southeast2", + "description": "Locational Endpoint", "endpointUrl": "https://australia-southeast2-aiplatform.googleapis.com/" }, { - "description": "Locational Endpoint", "location": "europe-central2", + "description": "Locational Endpoint", "endpointUrl": "https://europe-central2-aiplatform.googleapis.com/" }, { @@ -85,29 +85,29 @@ "endpointUrl": "https://europe-north1-aiplatform.googleapis.com/" }, { - "endpointUrl": "https://europe-southwest1-aiplatform.googleapis.com/", + "description": "Locational Endpoint", "location": "europe-southwest1", - "description": "Locational Endpoint" + "endpointUrl": "https://europe-southwest1-aiplatform.googleapis.com/" }, { - "description": "Locational Endpoint", "location": "europe-west1", - "endpointUrl": "https://europe-west1-aiplatform.googleapis.com/" + "endpointUrl": "https://europe-west1-aiplatform.googleapis.com/", + "description": "Locational Endpoint" }, { + "location": "europe-west2", "description": "Locational Endpoint", - "endpointUrl": "https://europe-west2-aiplatform.googleapis.com/", - "location": "europe-west2" + "endpointUrl": "https://europe-west2-aiplatform.googleapis.com/" }, { + "description": "Locational Endpoint", "endpointUrl": "https://europe-west3-aiplatform.googleapis.com/", - "location": "europe-west3", - "description": "Locational Endpoint" + "location": "europe-west3" }, { - "location": "europe-west4", "endpointUrl": "https://europe-west4-aiplatform.googleapis.com/", - "description": "Locational Endpoint" + "description": "Locational Endpoint", + "location": "europe-west4" }, { "description": "Locational Endpoint", @@ -115,104 +115,104 @@ "endpointUrl": "https://europe-west6-aiplatform.googleapis.com/" }, { - "endpointUrl": "https://europe-west8-aiplatform.googleapis.com/", + "description": "Locational Endpoint", "location": "europe-west8", - "description": "Locational Endpoint" + "endpointUrl": "https://europe-west8-aiplatform.googleapis.com/" }, { "location": "europe-west9", - "endpointUrl": "https://europe-west9-aiplatform.googleapis.com/", - "description": "Locational Endpoint" + "description": "Locational Endpoint", + "endpointUrl": "https://europe-west9-aiplatform.googleapis.com/" }, { + "description": "Locational Endpoint", "endpointUrl": "https://europe-west12-aiplatform.googleapis.com/", - "location": "europe-west12", - "description": "Locational Endpoint" + "location": "europe-west12" }, { + "location": "me-central1", "description": "Locational Endpoint", - "endpointUrl": "https://me-central1-aiplatform.googleapis.com/", - "location": "me-central1" + "endpointUrl": "https://me-central1-aiplatform.googleapis.com/" }, { + "location": "me-central2", "endpointUrl": "https://me-central2-aiplatform.googleapis.com/", - "description": "Locational Endpoint", - "location": "me-central2" + "description": "Locational Endpoint" }, { - "location": "me-west1", + "endpointUrl": "https://me-west1-aiplatform.googleapis.com/", "description": "Locational Endpoint", - "endpointUrl": "https://me-west1-aiplatform.googleapis.com/" + "location": "me-west1" }, { - "location": "northamerica-northeast1", + "endpointUrl": "https://northamerica-northeast1-aiplatform.googleapis.com/", "description": "Locational Endpoint", - "endpointUrl": "https://northamerica-northeast1-aiplatform.googleapis.com/" + "location": "northamerica-northeast1" }, { - "location": "northamerica-northeast2", "endpointUrl": "https://northamerica-northeast2-aiplatform.googleapis.com/", - "description": "Locational Endpoint" + "description": "Locational Endpoint", + "location": "northamerica-northeast2" }, { "endpointUrl": "https://southamerica-east1-aiplatform.googleapis.com/", - "description": "Locational Endpoint", - "location": "southamerica-east1" + "location": "southamerica-east1", + "description": "Locational Endpoint" }, { "location": "southamerica-west1", - "endpointUrl": "https://southamerica-west1-aiplatform.googleapis.com/", - "description": "Locational Endpoint" + "description": "Locational Endpoint", + "endpointUrl": "https://southamerica-west1-aiplatform.googleapis.com/" }, { - "location": "us-central1", "endpointUrl": "https://us-central1-aiplatform.googleapis.com/", + "location": "us-central1", "description": "Locational Endpoint" }, { - "location": "us-central2", "description": "Locational Endpoint", - "endpointUrl": "https://us-central2-aiplatform.googleapis.com/" + "endpointUrl": "https://us-central2-aiplatform.googleapis.com/", + "location": "us-central2" }, { + "endpointUrl": "https://us-east1-aiplatform.googleapis.com/", "description": "Locational Endpoint", - "location": "us-east1", - "endpointUrl": "https://us-east1-aiplatform.googleapis.com/" + "location": "us-east1" }, { "location": "us-east4", - "description": "Locational Endpoint", - "endpointUrl": "https://us-east4-aiplatform.googleapis.com/" + "endpointUrl": "https://us-east4-aiplatform.googleapis.com/", + "description": "Locational Endpoint" }, { - "location": "us-south1", "endpointUrl": "https://us-south1-aiplatform.googleapis.com/", - "description": "Locational Endpoint" + "description": "Locational Endpoint", + "location": "us-south1" }, { "endpointUrl": "https://us-west1-aiplatform.googleapis.com/", - "location": "us-west1", - "description": "Locational Endpoint" + "description": "Locational Endpoint", + "location": "us-west1" }, { - "endpointUrl": "https://us-west2-aiplatform.googleapis.com/", + "location": "us-west2", "description": "Locational Endpoint", - "location": "us-west2" + "endpointUrl": "https://us-west2-aiplatform.googleapis.com/" }, { "location": "us-west3", - "endpointUrl": "https://us-west3-aiplatform.googleapis.com/", - "description": "Locational Endpoint" + "description": "Locational Endpoint", + "endpointUrl": "https://us-west3-aiplatform.googleapis.com/" }, { - "location": "us-west4", "description": "Locational Endpoint", - "endpointUrl": "https://us-west4-aiplatform.googleapis.com/" + "endpointUrl": "https://us-west4-aiplatform.googleapis.com/", + "location": "us-west4" }, { - "location": "us-east5", + "endpointUrl": "https://us-east5-aiplatform.googleapis.com/", "description": "Locational Endpoint", - "endpointUrl": "https://us-east5-aiplatform.googleapis.com/" + "location": "us-east5" } ], "fullyEncodeReservedExpansion": true, @@ -3411,6 +3411,40 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "patch": { + "description": "Update a DeploymentResourcePool.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools/{deploymentResourcePoolsId}", + "httpMethod": "PATCH", + "id": "aiplatform.projects.locations.deploymentResourcePools.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Immutable. The resource name of the DeploymentResourcePool. Format: `projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/deploymentResourcePools/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Required. The list of fields to update.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1DeploymentResourcePool" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "queryDeployedModels": { "description": "List DeployedModels that have been deployed on this DeploymentResourcePool.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools/{deploymentResourcePoolsId}:queryDeployedModels", @@ -5567,7 +5601,7 @@ "type": "string" }, "updateMask": { - "description": "Field mask is used to specify the fields to be overwritten in the FeatureGroup resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `labels`", + "description": "Field mask is used to specify the fields to be overwritten in the FeatureGroup resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `labels` * `description` * `big_query` * `big_query.entity_id_columns`", "format": "google-fieldmask", "location": "query", "type": "string" @@ -5746,7 +5780,7 @@ "type": "string" }, "updateMask": { - "description": "Field mask is used to specify the fields to be overwritten in the Features resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `description` * `labels` * `disable_monitoring` (Not supported for FeatureRegistry Feature)", + "description": "Field mask is used to specify the fields to be overwritten in the Features resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `description` * `labels` * `disable_monitoring` (Not supported for FeatureRegistryService Feature) * `point_of_contact` (Not supported for FeaturestoreService FeatureStore)", "format": "google-fieldmask", "location": "query", "type": "string" @@ -6205,7 +6239,7 @@ "type": "string" }, "updateMask": { - "description": "Field mask is used to specify the fields to be overwritten in the FeatureOnlineStore resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `big_query_source` * `bigtable` * `labels` * `sync_config`", + "description": "Field mask is used to specify the fields to be overwritten in the FeatureOnlineStore resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `labels` * `description` * `bigtable` * `bigtable.auto_scaling` * `bigtable.enable_multi_region_replica`", "format": "google-fieldmask", "location": "query", "type": "string" @@ -6495,7 +6529,7 @@ "type": "string" }, "updateMask": { - "description": "Field mask is used to specify the fields to be overwritten in the FeatureView resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `labels` * `serviceAgentType`", + "description": "Field mask is used to specify the fields to be overwritten in the FeatureView resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `labels` * `service_agent_type` * `big_query_source` * `big_query_source.uri` * `big_query_source.entity_id_columns` * `feature_registry_source` * `feature_registry_source.feature_groups` * `sync_config` * `sync_config.cron`", "format": "google-fieldmask", "location": "query", "type": "string" @@ -7943,7 +7977,7 @@ "type": "string" }, "updateMask": { - "description": "Field mask is used to specify the fields to be overwritten in the Features resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `description` * `labels` * `disable_monitoring` (Not supported for FeatureRegistry Feature)", + "description": "Field mask is used to specify the fields to be overwritten in the Features resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `description` * `labels` * `disable_monitoring` (Not supported for FeatureRegistryService Feature) * `point_of_contact` (Not supported for FeaturestoreService FeatureStore)", "format": "google-fieldmask", "location": "query", "type": "string" @@ -20413,11 +20447,11 @@ } } }, - "revision": "20240617", + "revision": "20240704", "rootUrl": "https://aiplatform.googleapis.com/", "schemas": { "CloudAiLargeModelsVisionGenerateVideoResponse": { - "description": "Generate video response.", + "description": "Next ID: 8 Generate video response.", "id": "CloudAiLargeModelsVisionGenerateVideoResponse", "properties": { "generatedSamples": { @@ -22063,7 +22097,12 @@ "GoogleCloudAiplatformV1beta1BleuSpec": { "description": "Spec for bleu score metric - calculates the precision of n-grams in the prediction as compared to reference - returns a score ranging between 0 to 1.", "id": "GoogleCloudAiplatformV1beta1BleuSpec", - "properties": {}, + "properties": { + "useEffectiveOrder": { + "description": "Optional. Whether to use_effective_order to compute bleu score.", + "type": "boolean" + } + }, "type": "object" }, "GoogleCloudAiplatformV1beta1Blob": { @@ -22300,6 +22339,12 @@ }, "readOnly": true, "type": "array" + }, + "score": { + "description": "Output only. Confidence score of the candidate.", + "format": "double", + "readOnly": true, + "type": "number" } }, "type": "object" @@ -22510,12 +22555,23 @@ "description": "Request message for ComputeTokens RPC call.", "id": "GoogleCloudAiplatformV1beta1ComputeTokensRequest", "properties": { + "contents": { + "description": "Optional. Input content.", + "items": { + "$ref": "GoogleCloudAiplatformV1beta1Content" + }, + "type": "array" + }, "instances": { - "description": "Required. The instances that are the input to token computing API call. Schema is identical to the prediction schema of the text model, even for the non-text models, like chat models, or Codey models.", + "description": "Optional. The instances that are the input to token computing API call. Schema is identical to the prediction schema of the text model, even for the non-text models, like chat models, or Codey models.", "items": { "type": "any" }, "type": "array" + }, + "model": { + "description": "Optional. The name of the publisher model requested to serve the prediction. Format: projects/{project}/locations/{location}/publishers/*/models/*", + "type": "string" } }, "type": "object" @@ -22716,22 +22772,33 @@ "id": "GoogleCloudAiplatformV1beta1CountTokensRequest", "properties": { "contents": { - "description": "Required. Input content.", + "description": "Optional. Input content.", "items": { "$ref": "GoogleCloudAiplatformV1beta1Content" }, "type": "array" }, "instances": { - "description": "Required. The instances that are the input to token counting call. Schema is identical to the prediction schema of the underlying model.", + "description": "Optional. The instances that are the input to token counting call. Schema is identical to the prediction schema of the underlying model.", "items": { "type": "any" }, "type": "array" }, "model": { - "description": "Required. The name of the publisher model requested to serve the prediction. Format: `projects/{project}/locations/{location}/publishers/*/models/*`", + "description": "Optional. The name of the publisher model requested to serve the prediction. Format: `projects/{project}/locations/{location}/publishers/*/models/*`", "type": "string" + }, + "systemInstruction": { + "$ref": "GoogleCloudAiplatformV1beta1Content", + "description": "Optional. The user provided system instructions for the model. Note: only text should be used in parts and content in each part will be in a separate paragraph." + }, + "tools": { + "description": "Optional. A list of `Tools` the model may use to generate the next 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.", + "items": { + "$ref": "GoogleCloudAiplatformV1beta1Tool" + }, + "type": "array" } }, "type": "object" @@ -27870,10 +27937,69 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1beta1GroundingChunk": { + "description": "Grounding chunk.", + "id": "GoogleCloudAiplatformV1beta1GroundingChunk", + "properties": { + "retrievedContext": { + "$ref": "GoogleCloudAiplatformV1beta1GroundingChunkRetrievedContext", + "description": "Grounding chunk from context retrieved by the retrieval tools." + }, + "web": { + "$ref": "GoogleCloudAiplatformV1beta1GroundingChunkWeb", + "description": "Grounding chunk from the web." + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1GroundingChunkRetrievedContext": { + "description": "Chunk from context retrieved by the retrieval tools.", + "id": "GoogleCloudAiplatformV1beta1GroundingChunkRetrievedContext", + "properties": { + "title": { + "description": "Title of the attribution.", + "type": "string" + }, + "uri": { + "description": "URI reference of the attribution.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1GroundingChunkWeb": { + "description": "Chunk from the web.", + "id": "GoogleCloudAiplatformV1beta1GroundingChunkWeb", + "properties": { + "title": { + "description": "Title of the chunk.", + "type": "string" + }, + "uri": { + "description": "URI reference of the chunk.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1GroundingMetadata": { "description": "Metadata returned to client when grounding is enabled.", "id": "GoogleCloudAiplatformV1beta1GroundingMetadata", "properties": { + "groundingChunks": { + "description": "List of supporting references retrieved from specified grounding source.", + "items": { + "$ref": "GoogleCloudAiplatformV1beta1GroundingChunk" + }, + "type": "array" + }, + "groundingSupports": { + "description": "Optional. List of grounding support.", + "items": { + "$ref": "GoogleCloudAiplatformV1beta1GroundingSupport" + }, + "type": "array" + }, "retrievalQueries": { "description": "Optional. Queries executed by the retrieval tools.", "items": { @@ -27895,6 +28021,33 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1beta1GroundingSupport": { + "description": "Grounding support.", + "id": "GoogleCloudAiplatformV1beta1GroundingSupport", + "properties": { + "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.", + "items": { + "format": "float", + "type": "number" + }, + "type": "array" + }, + "groundingChunkIndices": { + "description": "A list of indices (into 'grounding_chunk') specifying the citations associated with the claim. For instance [1,3,4] means that grounding_chunk[1], grounding_chunk[3], grounding_chunk[4] are the retrieved content attributed to the claim.", + "items": { + "format": "int32", + "type": "integer" + }, + "type": "array" + }, + "segment": { + "$ref": "GoogleCloudAiplatformV1beta1Segment", + "description": "Segment of the content this support belongs to." + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1HyperparameterTuningJob": { "description": "Represents a HyperparameterTuningJob. A HyperparameterTuningJob has a Study specification and multiple CustomJobs with identical CustomJob specification.", "id": "GoogleCloudAiplatformV1beta1HyperparameterTuningJob", @@ -29867,6 +30020,22 @@ "TPU_V4_POD", "TPU_V5_LITEPOD" ], + "enumDeprecated": [ + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Unspecified accelerator type, which means no accelerator.", "Nvidia Tesla K80 GPU.", @@ -30410,6 +30579,16 @@ "$ref": "GoogleCloudAiplatformV1beta1PredictSchemata", "description": "The schemata that describe formats of the Model's predictions and explanations as given and returned via PredictionService.Predict and PredictionService.Explain." }, + "satisfiesPzi": { + "description": "Output only. Reserved for future use.", + "readOnly": true, + "type": "boolean" + }, + "satisfiesPzs": { + "description": "Output only. Reserved for future use.", + "readOnly": true, + "type": "boolean" + }, "supportedDeploymentResourcesTypes": { "description": "Output only. When this Model is deployed, its prediction resources are described by the `prediction_resources` field of the Endpoint.deployed_models object. Because not all Models support all resource configuration types, the configuration types this Model supports are listed here. If no configuration types are listed, the Model cannot be deployed to an Endpoint and does not support online predictions (PredictionService.Predict or PredictionService.Explain). Such a Model can serve predictions by using a BatchPredictionJob, if it has at least one entry each in supported_input_storage_formats and supported_output_storage_formats.", "items": { @@ -34586,6 +34765,10 @@ "$ref": "GoogleCloudAiplatformV1beta1DedicatedResources", "description": "A description of resources that are dedicated to the DeployedModel, and that need a higher degree of manual configuration." }, + "deployMetadata": { + "$ref": "GoogleCloudAiplatformV1beta1PublisherModelCallToActionDeployDeployMetadata", + "description": "Optional. Metadata information about this deployment config." + }, "deployTaskName": { "description": "Optional. The name of the deploy task (e.g., \"text to image generation\").", "type": "string" @@ -34613,6 +34796,20 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1beta1PublisherModelCallToActionDeployDeployMetadata": { + "description": "Metadata information about the deployment for managing deployment config.", + "id": "GoogleCloudAiplatformV1beta1PublisherModelCallToActionDeployDeployMetadata", + "properties": { + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. Labels for the deployment. For managing deployment config like verifying, source of deployment config, etc.", + "type": "object" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1PublisherModelCallToActionDeployGke": { "description": "Configurations for PublisherModel GKE deployment", "id": "GoogleCloudAiplatformV1beta1PublisherModelCallToActionDeployGke", @@ -35534,11 +35731,6 @@ "text": { "description": "Optional. The query in text format to get relevant contexts.", "type": "string" - }, - "vectorDistanceThreshold": { - "description": "Optional. Only return contexts with vector distance smaller than the threshold.", - "format": "double", - "type": "number" } }, "type": "object" @@ -35554,6 +35746,17 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1beta1RayLogsSpec": { + "description": "Configuration for the Ray OSS Logs.", + "id": "GoogleCloudAiplatformV1beta1RayLogsSpec", + "properties": { + "disabled": { + "description": "Optional. Flag to disable the export of Ray OSS logs to Cloud Logging.", + "type": "boolean" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1RayMetricSpec": { "description": "Configuration for the Ray metrics.", "id": "GoogleCloudAiplatformV1beta1RayMetricSpec", @@ -35577,6 +35780,10 @@ "description": "Optional. Default image for user to choose a preferred ML framework (for example, TensorFlow or Pytorch) by choosing from [Vertex prebuilt images](https://cloud.google.com/vertex-ai/docs/training/pre-built-containers). Either this or the resource_pool_images is required. Use this field if you need all the resource pools to have the same Ray image. Otherwise, use the {@code resource_pool_images} field.", "type": "string" }, + "rayLogsSpec": { + "$ref": "GoogleCloudAiplatformV1beta1RayLogsSpec", + "description": "Optional. OSS Ray logging configurations." + }, "rayMetricSpec": { "$ref": "GoogleCloudAiplatformV1beta1RayMetricSpec", "description": "Optional. Ray metrics configurations." @@ -36042,7 +36249,7 @@ "properties": { "autoscalingSpec": { "$ref": "GoogleCloudAiplatformV1beta1ResourcePoolAutoscalingSpec", - "description": "Optional. Optional spec to configure GKE autoscaling" + "description": "Optional. Optional spec to configure GKE or Ray-on-Vertex autoscaling" }, "diskSpec": { "$ref": "GoogleCloudAiplatformV1beta1DiskSpec", @@ -36080,7 +36287,7 @@ "type": "string" }, "minReplicaCount": { - "description": "Optional. min replicas in the node pool, must be ≤ replica_count and < max_replica_count or will throw error", + "description": "Optional. min replicas in the node pool, must be ≤ replica_count and < max_replica_count or will throw error. For autoscaling enabled Ray-on-Vertex, we allow min_replica_count of a resource_pool to be 0 to match the OSS Ray behavior(https://docs.ray.io/en/latest/cluster/vms/user-guides/configuring-autoscaling.html#cluster-config-parameters). As for Persistent Resource, the min_replica_count must be > 0, we added a corresponding validation inside CreatePersistentResourceRequestValidator.java.", "format": "int64", "type": "string" } @@ -36352,7 +36559,7 @@ }, "vertexAiSearchRuntimeConfig": { "$ref": "GoogleCloudAiplatformV1beta1RuntimeConfigVertexAISearchRuntimeConfig", - "description": "Runtime configuration for Vertext AI Search extension." + "description": "Runtime configuration for Vertex AI Search extension." } }, "type": "object" @@ -40973,6 +41180,36 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1beta1Segment": { + "description": "Segment of the content.", + "id": "GoogleCloudAiplatformV1beta1Segment", + "properties": { + "endIndex": { + "description": "Output only. End index in the given Part, measured in bytes. Offset from the start of the Part, exclusive, starting at zero.", + "format": "int32", + "readOnly": true, + "type": "integer" + }, + "partIndex": { + "description": "Output only. The index of a Part object within its parent Content object.", + "format": "int32", + "readOnly": true, + "type": "integer" + }, + "startIndex": { + "description": "Output only. Start index in the given Part, measured in bytes. Offset from the start of the Part, inclusive, starting at zero.", + "format": "int32", + "readOnly": true, + "type": "integer" + }, + "text": { + "description": "Output only. The text corresponding to the segment from the response.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1ServiceAccountSpec": { "description": "Configuration for the use of custom service account to run the workloads.", "id": "GoogleCloudAiplatformV1beta1ServiceAccountSpec", @@ -42169,11 +42406,18 @@ "id": "GoogleCloudAiplatformV1beta1SupervisedTuningDataStats", "properties": { "totalBillableCharacterCount": { + "deprecated": true, "description": "Output only. Number of billable characters in the tuning dataset.", "format": "int64", "readOnly": true, "type": "string" }, + "totalBillableTokenCount": { + "description": "Output only. Number of billable tokens in the tuning dataset.", + "format": "int64", + "readOnly": true, + "type": "string" + }, "totalTuningCharacterCount": { "description": "Output only. Number of tuning characters in the tuning dataset.", "format": "int64", @@ -42222,6 +42466,12 @@ "description": "Dataset distribution for Supervised Tuning.", "id": "GoogleCloudAiplatformV1beta1SupervisedTuningDatasetDistribution", "properties": { + "billableSum": { + "description": "Output only. Sum of a given population of values that are billable.", + "format": "int64", + "readOnly": true, + "type": "string" + }, "buckets": { "description": "Output only. Defines the histogram bucket.", "items": { @@ -42538,6 +42788,16 @@ "readOnly": true, "type": "integer" }, + "satisfiesPzi": { + "description": "Output only. Reserved for future use.", + "readOnly": true, + "type": "boolean" + }, + "satisfiesPzs": { + "description": "Output only. Reserved for future use.", + "readOnly": true, + "type": "boolean" + }, "updateTime": { "description": "Output only. Timestamp when this Tensorboard was last updated.", "format": "google-datetime", @@ -42881,6 +43141,10 @@ "description": "Tokens info with a list of tokens and the corresponding list of token ids.", "id": "GoogleCloudAiplatformV1beta1TokensInfo", "properties": { + "role": { + "description": "Optional. Optional fields for the role from the corresponding Content.", + "type": "string" + }, "tokenIds": { "description": "A list of token ids from the input.", "items": { diff --git a/discovery/alloydb-v1.json b/discovery/alloydb-v1.json index ba1d375993..7ad2fedc69 100644 --- a/discovery/alloydb-v1.json +++ b/discovery/alloydb-v1.json @@ -1489,7 +1489,7 @@ } } }, - "revision": "20240612", + "revision": "20240703", "rootUrl": "https://alloydb.googleapis.com/", "schemas": { "AuthorizedNetwork": { @@ -1968,6 +1968,25 @@ "readOnly": true, "type": "string" }, + "subscriptionType": { + "description": "Optional. Subscription type of the cluster.", + "enum": [ + "SUBSCRIPTION_TYPE_UNSPECIFIED", + "STANDARD", + "TRIAL" + ], + "enumDescriptions": [ + "This is an unknown Subscription type (By default, Subscription Type is STANDARD)", + "Standard subscription.", + "Trial subscription." + ], + "type": "string" + }, + "trialMetadata": { + "$ref": "TrialMetadata", + "description": "Output only. Metadata for free trial clusters", + "readOnly": true + }, "uid": { "description": "Output only. The system-generated UID of the resource. The UID is assigned when the resource is created, and it is retained until it is deleted.", "readOnly": true, @@ -4577,6 +4596,28 @@ }, "type": "object" }, + "TrialMetadata": { + "description": "Contains information and all metadata related to TRIAL clusters.", + "id": "TrialMetadata", + "properties": { + "endTime": { + "description": "End time of the trial cluster.", + "format": "google-datetime", + "type": "string" + }, + "startTime": { + "description": "start time of the trial cluster.", + "format": "google-datetime", + "type": "string" + }, + "upgradeTime": { + "description": "Upgrade time of trial cluster to Standard cluster.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, "User": { "description": "Message describing User object.", "id": "User", diff --git a/discovery/alloydb-v1alpha.json b/discovery/alloydb-v1alpha.json index 37445d0c50..20efe48bd4 100644 --- a/discovery/alloydb-v1alpha.json +++ b/discovery/alloydb-v1alpha.json @@ -1489,7 +1489,7 @@ } } }, - "revision": "20240612", + "revision": "20240703", "rootUrl": "https://alloydb.googleapis.com/", "schemas": { "AuthorizedNetwork": { @@ -1578,19 +1578,22 @@ "DATABASE_VERSION_UNSPECIFIED", "POSTGRES_13", "POSTGRES_14", - "POSTGRES_15" + "POSTGRES_15", + "POSTGRES_16" ], "enumDeprecated": [ false, true, false, + false, false ], "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 15.", + "The database version is Postgres 16." ], "readOnly": true, "type": "string" @@ -1839,19 +1842,22 @@ "DATABASE_VERSION_UNSPECIFIED", "POSTGRES_13", "POSTGRES_14", - "POSTGRES_15" + "POSTGRES_15", + "POSTGRES_16" ], "enumDeprecated": [ false, true, false, + false, false ], "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 15.", + "The database version is Postgres 16." ], "type": "string" }, @@ -2864,7 +2870,7 @@ "id": "ObservabilityInstanceConfig", "properties": { "enabled": { - "description": "Observability feature status for an instance. This is a read-only flag and modifiable only by producer API. This flag is turned \"off\" by default.", + "description": "Observability feature status for an instance. This flag is turned \"off\" by default.", "type": "boolean" }, "maxQueryStringLength": { @@ -2877,7 +2883,7 @@ "type": "boolean" }, "queryPlansPerMinute": { - "description": "Number of query execution plans captured by Insights per minute for all queries combined. The default value is 5. Any integer between 0 to 20 is considered valid.", + "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.", "format": "int32", "type": "integer" }, @@ -4654,19 +4660,22 @@ "DATABASE_VERSION_UNSPECIFIED", "POSTGRES_13", "POSTGRES_14", - "POSTGRES_15" + "POSTGRES_15", + "POSTGRES_16" ], "enumDeprecated": [ false, true, false, + false, false ], "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 15.", + "The database version is Postgres 16." ], "type": "string" }, diff --git a/discovery/alloydb-v1beta.json b/discovery/alloydb-v1beta.json index 03855ea43f..84f5f9355d 100644 --- a/discovery/alloydb-v1beta.json +++ b/discovery/alloydb-v1beta.json @@ -1486,7 +1486,7 @@ } } }, - "revision": "20240612", + "revision": "20240703", "rootUrl": "https://alloydb.googleapis.com/", "schemas": { "AuthorizedNetwork": { @@ -1575,19 +1575,22 @@ "DATABASE_VERSION_UNSPECIFIED", "POSTGRES_13", "POSTGRES_14", - "POSTGRES_15" + "POSTGRES_15", + "POSTGRES_16" ], "enumDeprecated": [ false, true, false, + false, false ], "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 15.", + "The database version is Postgres 16." ], "readOnly": true, "type": "string" @@ -1825,19 +1828,22 @@ "DATABASE_VERSION_UNSPECIFIED", "POSTGRES_13", "POSTGRES_14", - "POSTGRES_15" + "POSTGRES_15", + "POSTGRES_16" ], "enumDeprecated": [ false, true, false, + false, false ], "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 15.", + "The database version is Postgres 16." ], "type": "string" }, @@ -2840,7 +2846,7 @@ "id": "ObservabilityInstanceConfig", "properties": { "enabled": { - "description": "Observability feature status for an instance. This is a read-only flag and modifiable only by producer API. This flag is turned \"off\" by default.", + "description": "Observability feature status for an instance. This flag is turned \"off\" by default.", "type": "boolean" }, "maxQueryStringLength": { @@ -2853,7 +2859,7 @@ "type": "boolean" }, "queryPlansPerMinute": { - "description": "Number of query execution plans captured by Insights per minute for all queries combined. The default value is 5. Any integer between 0 to 20 is considered valid.", + "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.", "format": "int32", "type": "integer" }, @@ -4630,19 +4636,22 @@ "DATABASE_VERSION_UNSPECIFIED", "POSTGRES_13", "POSTGRES_14", - "POSTGRES_15" + "POSTGRES_15", + "POSTGRES_16" ], "enumDeprecated": [ false, true, false, + false, false ], "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 15.", + "The database version is Postgres 16." ], "type": "string" }, diff --git a/discovery/analyticsadmin-v1alpha.json b/discovery/analyticsadmin-v1alpha.json index 0b6c7a5481..cae27b4548 100644 --- a/discovery/analyticsadmin-v1alpha.json +++ b/discovery/analyticsadmin-v1alpha.json @@ -1710,6 +1710,59 @@ }, "bigQueryLinks": { "methods": { + "create": { + "description": "Creates a BigQueryLink.", + "flatPath": "v1alpha/properties/{propertiesId}/bigQueryLinks", + "httpMethod": "POST", + "id": "analyticsadmin.properties.bigQueryLinks.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. Example format: properties/1234", + "location": "path", + "pattern": "^properties/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+parent}/bigQueryLinks", + "request": { + "$ref": "GoogleAnalyticsAdminV1alphaBigQueryLink" + }, + "response": { + "$ref": "GoogleAnalyticsAdminV1alphaBigQueryLink" + }, + "scopes": [ + "https://www.googleapis.com/auth/analytics.edit" + ] + }, + "delete": { + "description": "Deletes a BigQueryLink on a property.", + "flatPath": "v1alpha/properties/{propertiesId}/bigQueryLinks/{bigQueryLinksId}", + "httpMethod": "DELETE", + "id": "analyticsadmin.properties.bigQueryLinks.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The BigQueryLink to delete. Example format: properties/1234/bigQueryLinks/5678", + "location": "path", + "pattern": "^properties/[^/]+/bigQueryLinks/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/analytics.edit" + ] + }, "get": { "description": "Lookup for a single BigQuery Link.", "flatPath": "v1alpha/properties/{propertiesId}/bigQueryLinks/{bigQueryLinksId}", @@ -1772,6 +1825,40 @@ "https://www.googleapis.com/auth/analytics.edit", "https://www.googleapis.com/auth/analytics.readonly" ] + }, + "patch": { + "description": "Updates a BigQueryLink.", + "flatPath": "v1alpha/properties/{propertiesId}/bigQueryLinks/{bigQueryLinksId}", + "httpMethod": "PATCH", + "id": "analyticsadmin.properties.bigQueryLinks.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Output only. Resource name of this BigQuery link. Format: 'properties/{property_id}/bigQueryLinks/{bigquery_link_id}' Format: 'properties/1234/bigQueryLinks/abc567'", + "location": "path", + "pattern": "^properties/[^/]+/bigQueryLinks/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Required. The list of fields to be updated. Field names must be in snake case (e.g., \"field_to_update\"). Omitted fields will not be updated. To replace the entire entity, use one path with the string \"*\" to match all fields.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "request": { + "$ref": "GoogleAnalyticsAdminV1alphaBigQueryLink" + }, + "response": { + "$ref": "GoogleAnalyticsAdminV1alphaBigQueryLink" + }, + "scopes": [ + "https://www.googleapis.com/auth/analytics.edit" + ] } } }, @@ -3016,35 +3103,6 @@ } } }, - "eventEditRules": { - "methods": { - "reorder": { - "description": "Changes the processing order of event edit rules on the specified stream.", - "flatPath": "v1alpha/properties/{propertiesId}/dataStreams/{dataStreamsId}/eventEditRules:reorder", - "httpMethod": "POST", - "id": "analyticsadmin.properties.dataStreams.eventEditRules.reorder", - "parameterOrder": [ - "parent" - ], - "parameters": { - "parent": { - "description": "Required. Example format: properties/123/dataStreams/456", - "location": "path", - "pattern": "^properties/[^/]+/dataStreams/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1alpha/{+parent}/eventEditRules:reorder", - "request": { - "$ref": "GoogleAnalyticsAdminV1alphaReorderEventEditRulesRequest" - }, - "response": { - "$ref": "GoogleProtobufEmpty" - } - } - } - }, "measurementProtocolSecrets": { "methods": { "create": { @@ -4646,7 +4704,7 @@ } } }, - "revision": "20240529", + "revision": "20240715", "rootUrl": "https://analyticsadmin.googleapis.com/", "schemas": { "GoogleAnalyticsAdminV1alphaAccessBetweenFilter": { @@ -5765,6 +5823,10 @@ "description": "If set true, enables daily data export to the linked Google Cloud project.", "type": "boolean" }, + "datasetLocation": { + "description": "Required. Immutable. The geographic location where the created BigQuery dataset should reside. See https://cloud.google.com/bigquery/docs/locations for supported locations.", + "type": "string" + }, "excludedEvents": { "description": "The list of event names that will be excluded from exports.", "items": { @@ -8235,20 +8297,6 @@ }, "type": "object" }, - "GoogleAnalyticsAdminV1alphaReorderEventEditRulesRequest": { - "description": "Request message for ReorderEventEditRules RPC.", - "id": "GoogleAnalyticsAdminV1alphaReorderEventEditRulesRequest", - "properties": { - "eventEditRules": { - "description": "Required. EventEditRule resource names for the specified data stream, in the needed processing order. All EventEditRules for the stream must be present in the list.", - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, "GoogleAnalyticsAdminV1alphaRollupPropertySourceLink": { "description": "A link that references a source property under the parent rollup property.", "id": "GoogleAnalyticsAdminV1alphaRollupPropertySourceLink", @@ -8511,6 +8559,7 @@ "ATTRIBUTION_SETTINGS", "EXPANDED_DATA_SET", "CHANNEL_GROUP", + "BIGQUERY_LINK", "ENHANCED_MEASUREMENT_SETTINGS", "DATA_REDACTION_SETTINGS", "SKADNETWORK_CONVERSION_VALUE_SCHEMA", @@ -8538,6 +8587,7 @@ "AttributionSettings resource", "ExpandedDataSet resource", "ChannelGroup resource", + "BigQuery link resource", "EnhancedMeasurementSettings resource", "DataRedactionSettings resource", "SKAdNetworkConversionValueSchema resource", diff --git a/discovery/analyticsadmin-v1beta.json b/discovery/analyticsadmin-v1beta.json index 62906b8fda..2bd55d613b 100644 --- a/discovery/analyticsadmin-v1beta.json +++ b/discovery/analyticsadmin-v1beta.json @@ -1253,35 +1253,6 @@ } }, "resources": { - "eventEditRules": { - "methods": { - "reorder": { - "description": "Changes the processing order of event edit rules on the specified stream.", - "flatPath": "v1beta/properties/{propertiesId}/dataStreams/{dataStreamsId}/eventEditRules:reorder", - "httpMethod": "POST", - "id": "analyticsadmin.properties.dataStreams.eventEditRules.reorder", - "parameterOrder": [ - "parent" - ], - "parameters": { - "parent": { - "description": "Required. Example format: properties/123/dataStreams/456", - "location": "path", - "pattern": "^properties/[^/]+/dataStreams/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta/{+parent}/eventEditRules:reorder", - "request": { - "$ref": "GoogleAnalyticsAdminV1betaReorderEventEditRulesRequest" - }, - "response": { - "$ref": "GoogleProtobufEmpty" - } - } - } - }, "measurementProtocolSecrets": { "methods": { "create": { @@ -1817,7 +1788,7 @@ } } }, - "revision": "20240529", + "revision": "20240715", "rootUrl": "https://analyticsadmin.googleapis.com/", "schemas": { "GoogleAnalyticsAdminV1betaAccessBetweenFilter": { @@ -3352,20 +3323,6 @@ }, "type": "object" }, - "GoogleAnalyticsAdminV1betaReorderEventEditRulesRequest": { - "description": "Request message for ReorderEventEditRules RPC.", - "id": "GoogleAnalyticsAdminV1betaReorderEventEditRulesRequest", - "properties": { - "eventEditRules": { - "description": "Required. EventEditRule resource names for the specified data stream, in the needed processing order. All EventEditRules for the stream must be present in the list.", - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, "GoogleAnalyticsAdminV1betaRunAccessReportRequest": { "description": "The request for a Data Access Record Report.", "id": "GoogleAnalyticsAdminV1betaRunAccessReportRequest", diff --git a/discovery/androidenterprise-v1.json b/discovery/androidenterprise-v1.json index 2d221af913..40fa1e5b90 100644 --- a/discovery/androidenterprise-v1.json +++ b/discovery/androidenterprise-v1.json @@ -483,6 +483,11 @@ "id": "androidenterprise.enterprises.generateSignupUrl", "parameterOrder": [], "parameters": { + "adminEmail": { + "description": "Optional. Email address used to prefill the admin field of the enterprise signup form. This value is a hint only and can be altered by the user.", + "location": "query", + "type": "string" + }, "callbackUrl": { "description": "The callback URL to which the Admin will be redirected after successfully creating an enterprise. Before redirecting there the system will add a single query parameter to this URL named \"enterpriseToken\" which will contain an opaque token to be used for the CompleteSignup request. Beware that this means that the URL will be parsed, the parameter added and then a new URL formatted, i.e. there may be some minor formatting changes and, more importantly, the URL must be well-formed so that it can be parsed.", "location": "query", @@ -2649,7 +2654,7 @@ } } }, - "revision": "20240625", + "revision": "20240716", "rootUrl": "https://androidenterprise.googleapis.com/", "schemas": { "Administrator": { diff --git a/discovery/androidpublisher-v3.json b/discovery/androidpublisher-v3.json index 15fceb2684..11754c2bdf 100644 --- a/discovery/androidpublisher-v3.json +++ b/discovery/androidpublisher-v3.json @@ -277,36 +277,6 @@ "https://www.googleapis.com/auth/androidpublisher" ] }, - "appRecoveries": { - "description": "List all app recovery action resources associated with a particular package name and app version.", - "flatPath": "androidpublisher/v3/applications/{packageName}/appRecoveries", - "httpMethod": "POST", - "id": "androidpublisher.apprecovery.appRecoveries", - "parameterOrder": [ - "packageName" - ], - "parameters": { - "packageName": { - "description": "Required. Package name of the app for which list of recovery actions is requested.", - "location": "path", - "required": true, - "type": "string" - }, - "versionCode": { - "description": "Required. Version code targeted by the list of recovery actions.", - "format": "int64", - "location": "query", - "type": "string" - } - }, - "path": "androidpublisher/v3/applications/{packageName}/appRecoveries", - "response": { - "$ref": "ListAppRecoveriesResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/androidpublisher" - ] - }, "cancel": { "description": "Cancel an already executing app recovery action. Note that this action changes status of the recovery action to CANCELED.", "flatPath": "androidpublisher/v3/applications/{packageName}/appRecoveries/{appRecoveryId}:cancel", @@ -403,6 +373,36 @@ "scopes": [ "https://www.googleapis.com/auth/androidpublisher" ] + }, + "list": { + "description": "List all app recovery action resources associated with a particular package name and app version.", + "flatPath": "androidpublisher/v3/applications/{packageName}/appRecoveries", + "httpMethod": "GET", + "id": "androidpublisher.apprecovery.list", + "parameterOrder": [ + "packageName" + ], + "parameters": { + "packageName": { + "description": "Required. Package name of the app for which list of recovery actions is requested.", + "location": "path", + "required": true, + "type": "string" + }, + "versionCode": { + "description": "Required. Version code targeted by the list of recovery actions.", + "format": "int64", + "location": "query", + "type": "string" + } + }, + "path": "androidpublisher/v3/applications/{packageName}/appRecoveries", + "response": { + "$ref": "ListAppRecoveriesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/androidpublisher" + ] } } }, @@ -4731,7 +4731,7 @@ } } }, - "revision": "20240626", + "revision": "20240717", "rootUrl": "https://androidpublisher.googleapis.com/", "schemas": { "Abi": { @@ -6299,7 +6299,7 @@ "readOnly": true }, "transactionProgramCode": { - "description": "Optional. The transaction program code, used to help determine service fee for apps partcipating in special partner programs. This field can not be used for external offers transactions. Developers participating in the Play Media Experience Program (https://play.google.com/console/about/programs/mediaprogram/) must provide the program code when reporting alternative billing external transactions. If you are an eligible developer, please contact your BDM for more information on how to set this field.", + "description": "Optional. The transaction program code, used to help determine service fee for eligible apps participating in partner programs. Developers participating in the Play Media Experience Program (https://play.google.com/console/about/programs/mediaprogram/) must provide the program code when reporting alternative billing transactions. If you are an eligible developer, please contact your BDM for more information on how to set this field. Note: this field can not be used for external offers transactions.", "format": "int32", "type": "integer" }, diff --git a/discovery/artifactregistry-v1.json b/discovery/artifactregistry-v1.json index f1be1366d3..33bbff96ec 100644 --- a/discovery/artifactregistry-v1.json +++ b/discovery/artifactregistry-v1.json @@ -2013,7 +2013,7 @@ } } }, - "revision": "20240608", + "revision": "20240708", "rootUrl": "https://artifactregistry.googleapis.com/", "schemas": { "AptArtifact": { @@ -3355,6 +3355,12 @@ }, "type": "object" }, + "PromoteArtifactMetadata": { + "description": "The metadata for promote artifact long running operation.", + "id": "PromoteArtifactMetadata", + "properties": {}, + "type": "object" + }, "PythonPackage": { "description": "PythonPackage represents a python artifact.", "id": "PythonPackage", @@ -3735,7 +3741,7 @@ "type": "string" }, "packageId": { - "description": "The ID of the package of the generic artifact. If the package does not exist, a new package will be created. The `package_id` must start with a letter, end with a letter or number, only contain letters, numbers, hyphens and periods i.e. [a-z0-9-.], and cannot exceed 256 characters.", + "description": "The ID of the package of the generic artifact. If the package does not exist, a new package will be created. The `package_id` should start and end with a letter or number, only contain letters, numbers, hyphens, underscores, and periods, and not exceed 256 characters.", "type": "string" }, "versionId": { diff --git a/discovery/assuredworkloads-v1.json b/discovery/assuredworkloads-v1.json index 522a6dd8c4..aae52b4fc6 100644 --- a/discovery/assuredworkloads-v1.json +++ b/discovery/assuredworkloads-v1.json @@ -591,7 +591,7 @@ } } }, - "revision": "20240621", + "revision": "20240712", "rootUrl": "https://assuredworkloads.googleapis.com/", "schemas": { "GoogleCloudAssuredworkloadsV1AcknowledgeViolationRequest": { @@ -683,25 +683,19 @@ "FEDRAMP_HIGH", "FEDRAMP_MODERATE", "US_REGIONAL_ACCESS", - "REGIONAL_CONTROLS_PREMIUM_US", "HIPAA", "HITRUST", "EU_REGIONS_AND_SUPPORT", - "REGIONAL_CONTROLS_PREMIUM_EU", "CA_REGIONS_AND_SUPPORT", - "REGIONAL_CONTROLS_PREMIUM_CA", "ITAR", "AU_REGIONS_AND_US_SUPPORT", - "REGIONAL_CONTROLS_PREMIUM_AU", "ASSURED_WORKLOADS_FOR_PARTNERS", "ISR_REGIONS", - "REGIONAL_CONTROLS_PREMIUM_ISR", "ISR_REGIONS_AND_SUPPORT", "CA_PROTECTED_B", "IL5", "IL2", "JP_REGIONS_AND_SUPPORT", - "REGIONAL_CONTROLS_PREMIUM_JP", "KSA_REGIONS_AND_SUPPORT_WITH_SOVEREIGNTY_CONTROLS", "REGIONAL_CONTROLS" ], @@ -712,26 +706,20 @@ "FedRAMP High data protection controls", "FedRAMP Moderate data protection controls", "Assured Workloads For US Regions 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 EU Regions and Support controls", - "Assured Workloads For Canada 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 Australia Regions and Support controls", "Assured Workloads for Partners;", "Assured Workloads for Israel Regions", - "Assured Workloads for Israel", "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 for Japan Regions", - "KSA R5 Controls.", + "Assured Workloads Sovereign Controls KSA", "Assured Workloads for Regional Controls" ], "type": "string" @@ -1178,25 +1166,19 @@ "FEDRAMP_HIGH", "FEDRAMP_MODERATE", "US_REGIONAL_ACCESS", - "REGIONAL_CONTROLS_PREMIUM_US", "HIPAA", "HITRUST", "EU_REGIONS_AND_SUPPORT", - "REGIONAL_CONTROLS_PREMIUM_EU", "CA_REGIONS_AND_SUPPORT", - "REGIONAL_CONTROLS_PREMIUM_CA", "ITAR", "AU_REGIONS_AND_US_SUPPORT", - "REGIONAL_CONTROLS_PREMIUM_AU", "ASSURED_WORKLOADS_FOR_PARTNERS", "ISR_REGIONS", - "REGIONAL_CONTROLS_PREMIUM_ISR", "ISR_REGIONS_AND_SUPPORT", "CA_PROTECTED_B", "IL5", "IL2", "JP_REGIONS_AND_SUPPORT", - "REGIONAL_CONTROLS_PREMIUM_JP", "KSA_REGIONS_AND_SUPPORT_WITH_SOVEREIGNTY_CONTROLS", "REGIONAL_CONTROLS" ], @@ -1207,26 +1189,20 @@ "FedRAMP High data protection controls", "FedRAMP Moderate data protection controls", "Assured Workloads For US Regions 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 EU Regions and Support controls", - "Assured Workloads For Canada 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 Australia Regions and Support controls", "Assured Workloads for Partners;", "Assured Workloads for Israel Regions", - "Assured Workloads for Israel", "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 for Japan Regions", - "KSA R5 Controls.", + "Assured Workloads Sovereign Controls KSA", "Assured Workloads for Regional Controls" ], "type": "string" diff --git a/discovery/assuredworkloads-v1beta1.json b/discovery/assuredworkloads-v1beta1.json index 975fbf4ff2..ab19cc79ce 100644 --- a/discovery/assuredworkloads-v1beta1.json +++ b/discovery/assuredworkloads-v1beta1.json @@ -588,7 +588,7 @@ } } }, - "revision": "20240627", + "revision": "20240712", "rootUrl": "https://assuredworkloads.googleapis.com/", "schemas": { "GoogleCloudAssuredworkloadsV1beta1AcknowledgeViolationRequest": { @@ -680,25 +680,19 @@ "FEDRAMP_HIGH", "FEDRAMP_MODERATE", "US_REGIONAL_ACCESS", - "REGIONAL_CONTROLS_PREMIUM_US", "HIPAA", "HITRUST", "EU_REGIONS_AND_SUPPORT", - "REGIONAL_CONTROLS_PREMIUM_EU", "CA_REGIONS_AND_SUPPORT", - "REGIONAL_CONTROLS_PREMIUM_CA", "ITAR", "AU_REGIONS_AND_US_SUPPORT", - "REGIONAL_CONTROLS_PREMIUM_AU", "ASSURED_WORKLOADS_FOR_PARTNERS", "ISR_REGIONS", - "REGIONAL_CONTROLS_PREMIUM_ISR", "ISR_REGIONS_AND_SUPPORT", "CA_PROTECTED_B", "IL5", "IL2", "JP_REGIONS_AND_SUPPORT", - "REGIONAL_CONTROLS_PREMIUM_JP", "KSA_REGIONS_AND_SUPPORT_WITH_SOVEREIGNTY_CONTROLS", "REGIONAL_CONTROLS" ], @@ -709,26 +703,20 @@ "FedRAMP High data protection controls", "FedRAMP Moderate data protection controls", "Assured Workloads For US Regions 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 EU Regions and Support controls", - "Assured Workloads For Canada 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 Australia Regions and Support controls", "Assured Workloads for Partners;", "Assured Workloads for Israel Regions", - "Assured Workloads for Israel", "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 for Japan Regions", - "KSA R5 Controls.", + "Assured Workloads Sovereign Controls KSA", "Assured Workloads for Regional Controls" ], "type": "string" @@ -1173,25 +1161,19 @@ "FEDRAMP_HIGH", "FEDRAMP_MODERATE", "US_REGIONAL_ACCESS", - "REGIONAL_CONTROLS_PREMIUM_US", "HIPAA", "HITRUST", "EU_REGIONS_AND_SUPPORT", - "REGIONAL_CONTROLS_PREMIUM_EU", "CA_REGIONS_AND_SUPPORT", - "REGIONAL_CONTROLS_PREMIUM_CA", "ITAR", "AU_REGIONS_AND_US_SUPPORT", - "REGIONAL_CONTROLS_PREMIUM_AU", "ASSURED_WORKLOADS_FOR_PARTNERS", "ISR_REGIONS", - "REGIONAL_CONTROLS_PREMIUM_ISR", "ISR_REGIONS_AND_SUPPORT", "CA_PROTECTED_B", "IL5", "IL2", "JP_REGIONS_AND_SUPPORT", - "REGIONAL_CONTROLS_PREMIUM_JP", "KSA_REGIONS_AND_SUPPORT_WITH_SOVEREIGNTY_CONTROLS", "REGIONAL_CONTROLS" ], @@ -1202,26 +1184,20 @@ "FedRAMP High data protection controls", "FedRAMP Moderate data protection controls", "Assured Workloads For US Regions 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 EU Regions and Support controls", - "Assured Workloads For Canada 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 Australia Regions and Support controls", "Assured Workloads for Partners;", "Assured Workloads for Israel Regions", - "Assured Workloads for Israel", "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 for Japan Regions", - "KSA R5 Controls.", + "Assured Workloads Sovereign Controls KSA", "Assured Workloads for Regional Controls" ], "type": "string" diff --git a/discovery/backupdr-v1.json b/discovery/backupdr-v1.json index b92d24ea73..0e646e99f8 100644 --- a/discovery/backupdr-v1.json +++ b/discovery/backupdr-v1.json @@ -177,6 +177,727 @@ } }, "resources": { + "backupVaults": { + "methods": { + "create": { + "description": "", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/backupVaults", + "httpMethod": "POST", + "id": "backupdr.projects.locations.backupVaults.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "backupVaultId": { + "description": "Required. ID of the requesting object If auto-generating ID server-side, remove this field and backup_vault_id from the method_signature of Create RPC", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. Value for parent.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + }, + "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).", + "location": "query", + "type": "string" + }, + "validateOnly": { + "description": "Optional. Only validate the request, but do not perform mutations. The default is 'false'.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1/{+parent}/backupVaults", + "request": { + "$ref": "BackupVault" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a BackupVault.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/backupVaults/{backupVaultsId}", + "httpMethod": "DELETE", + "id": "backupdr.projects.locations.backupVaults.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "allowMissing": { + "description": "Optional. If true and the BackupVault is not found, the request will succeed but no action will be taken.", + "location": "query", + "type": "boolean" + }, + "etag": { + "description": "The current etag of the backup vault. If an etag is provided and does not match the current etag of the connection, deletion will be blocked.", + "location": "query", + "type": "string" + }, + "force": { + "description": "Optional. If set to true, any data source from this backup vault will also be deleted.", + "location": "query", + "type": "boolean" + }, + "name": { + "description": "Required. Name of the resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/backupVaults/[^/]+$", + "required": true, + "type": "string" + }, + "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).", + "location": "query", + "type": "string" + }, + "validateOnly": { + "description": "Optional. Only validate the request, but do not perform mutations. The default is 'false'.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "fetchUsable": { + "description": "FetchUsableBackupVaults lists usable BackupVaults in a given project and location. Usable BackupVault are the ones that user has backupdr.backupVaults.get permission.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/backupVaults:fetchUsable", + "httpMethod": "GET", + "id": "backupdr.projects.locations.backupVaults.fetchUsable", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. Filtering results.", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Optional. Hint for how to order the results.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. A token identifying a page of results the server should return.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The project and location for which to retrieve backupvault stores information, in the format 'projects/{project_id}/locations/{location}'. In Cloud Backup and DR, locations map to Google Cloud regions, for example **us-central1**. To retrieve backupvault stores for all locations, use \"-\" for the '{location}' value.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/backupVaults:fetchUsable", + "response": { + "$ref": "FetchUsableBackupVaultsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets details of a BackupVault.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/backupVaults/{backupVaultsId}", + "httpMethod": "GET", + "id": "backupdr.projects.locations.backupVaults.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Name of the backupvault store resource name, in the format 'projects/{project_id}/locations/{location}/backupVaults/{resource_name}'", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/backupVaults/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "BackupVault" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists BackupVaults in a given project and location.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/backupVaults", + "httpMethod": "GET", + "id": "backupdr.projects.locations.backupVaults.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. Filtering results.", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Optional. Hint for how to order the results.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. A token identifying a page of results the server should return.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The project and location for which to retrieve backupvault stores information, in the format 'projects/{project_id}/locations/{location}'. In Cloud Backup and DR, locations map to Google Cloud regions, for example **us-central1**. To retrieve backupvault stores for all locations, use \"-\" for the '{location}' value.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/backupVaults", + "response": { + "$ref": "ListBackupVaultsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates the settings of a BackupVault.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/backupVaults/{backupVaultsId}", + "httpMethod": "PATCH", + "id": "backupdr.projects.locations.backupVaults.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Output only. The resource name.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/backupVaults/[^/]+$", + "required": true, + "type": "string" + }, + "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).", + "location": "query", + "type": "string" + }, + "updateMask": { + "description": "Required. Field mask is used to specify the fields to be overwritten in the BackupVault resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then the request will fail.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + }, + "validateOnly": { + "description": "Optional. Only validate the request, but do not perform mutations. The default is 'false'.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1/{+name}", + "request": { + "$ref": "BackupVault" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "testIamPermissions": { + "description": "Returns the caller's permissions on a BackupVault resource. A caller is not required to have Google IAM permission to make this request.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/backupVaults/{backupVaultsId}:testIamPermissions", + "httpMethod": "POST", + "id": "backupdr.projects.locations.backupVaults.testIamPermissions", + "parameterOrder": [ + "resource" + ], + "parameters": { + "resource": { + "description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/backupVaults/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+resource}:testIamPermissions", + "request": { + "$ref": "TestIamPermissionsRequest" + }, + "response": { + "$ref": "TestIamPermissionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "dataSources": { + "methods": { + "abandonBackup": { + "description": "Internal only. Abandons a backup.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/backupVaults/{backupVaultsId}/dataSources/{dataSourcesId}:abandonBackup", + "httpMethod": "POST", + "id": "backupdr.projects.locations.backupVaults.dataSources.abandonBackup", + "parameterOrder": [ + "dataSource" + ], + "parameters": { + "dataSource": { + "description": "Required. The resource name of the instance, in the format 'projects/*/locations/*/backupVaults/*/dataSources/'.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/backupVaults/[^/]+/dataSources/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+dataSource}:abandonBackup", + "request": { + "$ref": "AbandonBackupRequest" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "fetchAccessToken": { + "description": "Internal only. Fetch access token for a given data source.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/backupVaults/{backupVaultsId}/dataSources/{dataSourcesId}:fetchAccessToken", + "httpMethod": "POST", + "id": "backupdr.projects.locations.backupVaults.dataSources.fetchAccessToken", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name for the location for which static IPs should be returned. Must be in the format 'projects/*/locations/*/backupVaults/*/dataSources'.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/backupVaults/[^/]+/dataSources/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:fetchAccessToken", + "request": { + "$ref": "FetchAccessTokenRequest" + }, + "response": { + "$ref": "FetchAccessTokenResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "finalizeBackup": { + "description": "Internal only. Finalize a backup that was started by a call to InitiateBackup.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/backupVaults/{backupVaultsId}/dataSources/{dataSourcesId}:finalizeBackup", + "httpMethod": "POST", + "id": "backupdr.projects.locations.backupVaults.dataSources.finalizeBackup", + "parameterOrder": [ + "dataSource" + ], + "parameters": { + "dataSource": { + "description": "Required. The resource name of the instance, in the format 'projects/*/locations/*/backupVaults/*/dataSources/'.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/backupVaults/[^/]+/dataSources/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+dataSource}:finalizeBackup", + "request": { + "$ref": "FinalizeBackupRequest" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets details of a DataSource.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/backupVaults/{backupVaultsId}/dataSources/{dataSourcesId}", + "httpMethod": "GET", + "id": "backupdr.projects.locations.backupVaults.dataSources.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Name of the data source resource name, in the format 'projects/{project_id}/locations/{location}/backupVaults/{resource_name}/dataSource/{resource_name}'", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/backupVaults/[^/]+/dataSources/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "DataSource" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "initiateBackup": { + "description": "Internal only. Initiates a backup.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/backupVaults/{backupVaultsId}/dataSources/{dataSourcesId}:initiateBackup", + "httpMethod": "POST", + "id": "backupdr.projects.locations.backupVaults.dataSources.initiateBackup", + "parameterOrder": [ + "dataSource" + ], + "parameters": { + "dataSource": { + "description": "Required. The resource name of the instance, in the format 'projects/*/locations/*/backupVaults/*/dataSources/'.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/backupVaults/[^/]+/dataSources/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+dataSource}:initiateBackup", + "request": { + "$ref": "InitiateBackupRequest" + }, + "response": { + "$ref": "InitiateBackupResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists DataSources in a given project and location.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/backupVaults/{backupVaultsId}/dataSources", + "httpMethod": "GET", + "id": "backupdr.projects.locations.backupVaults.dataSources.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. Filtering results.", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Optional. Hint for how to order the results.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. A token identifying a page of results the server should return.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The project and location for which to retrieve data sources information, in the format 'projects/{project_id}/locations/{location}'. In Cloud Backup and DR, locations map to Google Cloud regions, for example **us-central1**. To retrieve data sources for all locations, use \"-\" for the '{location}' value.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/backupVaults/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/dataSources", + "response": { + "$ref": "ListDataSourcesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates the settings of a DataSource.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/backupVaults/{backupVaultsId}/dataSources/{dataSourcesId}", + "httpMethod": "PATCH", + "id": "backupdr.projects.locations.backupVaults.dataSources.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "allowMissing": { + "description": "Optional. Enable upsert.", + "location": "query", + "type": "boolean" + }, + "name": { + "description": "Output only. The resource name.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/backupVaults/[^/]+/dataSources/[^/]+$", + "required": true, + "type": "string" + }, + "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).", + "location": "query", + "type": "string" + }, + "updateMask": { + "description": "Required. Field mask is used to specify the fields to be overwritten in the DataSource resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then the request will fail.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}", + "request": { + "$ref": "DataSource" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "remove": { + "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.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/backupVaults/{backupVaultsId}/dataSources/{dataSourcesId}:remove", + "httpMethod": "POST", + "id": "backupdr.projects.locations.backupVaults.dataSources.remove", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Name of the resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/backupVaults/[^/]+/dataSources/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:remove", + "request": { + "$ref": "RemoveDataSourceRequest" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "setInternalStatus": { + "description": "Sets the internal status of a DataSource.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/backupVaults/{backupVaultsId}/dataSources/{dataSourcesId}:setInternalStatus", + "httpMethod": "POST", + "id": "backupdr.projects.locations.backupVaults.dataSources.setInternalStatus", + "parameterOrder": [ + "dataSource" + ], + "parameters": { + "dataSource": { + "description": "Required. The resource name of the instance, in the format 'projects/*/locations/*/backupVaults/*/dataSources/'.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/backupVaults/[^/]+/dataSources/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+dataSource}:setInternalStatus", + "request": { + "$ref": "SetInternalStatusRequest" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "backups": { + "methods": { + "delete": { + "description": "Deletes a Backup.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/backupVaults/{backupVaultsId}/dataSources/{dataSourcesId}/backups/{backupsId}", + "httpMethod": "DELETE", + "id": "backupdr.projects.locations.backupVaults.dataSources.backups.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Name of the resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/backupVaults/[^/]+/dataSources/[^/]+/backups/[^/]+$", + "required": true, + "type": "string" + }, + "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).", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets details of a Backup.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/backupVaults/{backupVaultsId}/dataSources/{dataSourcesId}/backups/{backupsId}", + "httpMethod": "GET", + "id": "backupdr.projects.locations.backupVaults.dataSources.backups.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Name of the data source resource name, in the format 'projects/{project_id}/locations/{location}/backupVaults/{backupVault}/dataSources/{datasource}/backups/{backup}'", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/backupVaults/[^/]+/dataSources/[^/]+/backups/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "Backup" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists Backups in a given project and location.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/backupVaults/{backupVaultsId}/dataSources/{dataSourcesId}/backups", + "httpMethod": "GET", + "id": "backupdr.projects.locations.backupVaults.dataSources.backups.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. Filtering results.", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Optional. Hint for how to order the results.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. A token identifying a page of results the server should return.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The project and location for which to retrieve backup information, in the format 'projects/{project_id}/locations/{location}'. In Cloud Backup and DR, locations map to Google Cloud regions, for example **us-central1**. To retrieve data sources for all locations, use \"-\" for the '{location}' value.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/backupVaults/[^/]+/dataSources/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/backups", + "response": { + "$ref": "ListBackupsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates the settings of a Backup.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/backupVaults/{backupVaultsId}/dataSources/{dataSourcesId}/backups/{backupsId}", + "httpMethod": "PATCH", + "id": "backupdr.projects.locations.backupVaults.dataSources.backups.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Output only. Name of the resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/backupVaults/[^/]+/dataSources/[^/]+/backups/[^/]+$", + "required": true, + "type": "string" + }, + "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).", + "location": "query", + "type": "string" + }, + "updateMask": { + "description": "Required. Field mask is used to specify the fields to be overwritten in the Backup resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then the request will fail.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}", + "request": { + "$ref": "Backup" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + } + } + }, "managementServers": { "methods": { "create": { @@ -194,7 +915,7 @@ "type": "string" }, "parent": { - "description": "Required. The management server project and location in the format `projects/{project_id}/locations/{location}`. In Cloud Backup and DR locations map to GCP regions, for example **us-central1**.", + "description": "Required. The management server project and location in the format 'projects/{project_id}/locations/{location}'. In Cloud Backup and DR locations map to Google Cloud regions, for example **us-central1**.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -257,7 +978,7 @@ ], "parameters": { "name": { - "description": "Required. Name of the management server resource name, in the format `projects/{project_id}/locations/{location}/managementServers/{resource_name}`", + "description": "Required. Name of the management server resource name, in the format 'projects/{project_id}/locations/{location}/managementServers/{resource_name}'", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/managementServers/[^/]+$", "required": true, @@ -334,7 +1055,7 @@ "type": "string" }, "parent": { - "description": "Required. The project and location for which to retrieve management servers information, in the format `projects/{project_id}/locations/{location}`. In Cloud BackupDR, locations map to GCP regions, for example **us-central1**. To retrieve management servers for all locations, use \"-\" for the `{location}` value.", + "description": "Required. The project and location for which to retrieve management servers information, in the format 'projects/{project_id}/locations/{location}'. In Cloud BackupDR, locations map to Google Cloud regions, for example **us-central1**. To retrieve management servers for all locations, use \"-\" for the '{location}' value.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -535,110 +1256,1343 @@ } } }, - "revision": "20240522", + "revision": "20240703", "rootUrl": "https://backupdr.googleapis.com/", "schemas": { - "AuditConfig": { - "description": "Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { \"audit_configs\": [ { \"service\": \"allServices\", \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\", \"exempted_members\": [ \"user:jose@example.com\" ] }, { \"log_type\": \"DATA_WRITE\" }, { \"log_type\": \"ADMIN_READ\" } ] }, { \"service\": \"sampleservice.googleapis.com\", \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\" }, { \"log_type\": \"DATA_WRITE\", \"exempted_members\": [ \"user:aliya@example.com\" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging.", - "id": "AuditConfig", + "AbandonBackupRequest": { + "description": "request message for AbandonBackup.", + "id": "AbandonBackupRequest", "properties": { - "auditLogConfigs": { - "description": "The configuration for logging of each type of permission.", + "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" + } + }, + "type": "object" + }, + "AcceleratorConfig": { + "description": "A specification of the type and number of accelerator cards attached to the instance.", + "id": "AcceleratorConfig", + "properties": { + "acceleratorCount": { + "description": "Optional. The number of the guest accelerator cards exposed to this instance.", + "format": "int32", + "type": "integer" + }, + "acceleratorType": { + "description": "Optional. Full or partial URL of the accelerator type resource to attach to this instance.", + "type": "string" + } + }, + "type": "object" + }, + "AccessConfig": { + "description": "An access configuration attached to an instance's network interface. Only one access config per instance is supported.", + "id": "AccessConfig", + "properties": { + "externalIpv6": { + "description": "Optional. The external IPv6 address of this access configuration.", + "type": "string" + }, + "externalIpv6PrefixLength": { + "description": "Optional. The prefix length of the external IPv6 range.", + "format": "int32", + "type": "integer" + }, + "name": { + "description": "Optional. The name of this access configuration.", + "type": "string" + }, + "natIP": { + "description": "Optional. The external IP address of this access configuration.", + "type": "string" + }, + "networkTier": { + "description": "Optional. This signifies the networking tier used for configuring this access", + "enum": [ + "NETWORK_TIER_UNSPECIFIED", + "PREMIUM", + "STANDARD" + ], + "enumDescriptions": [ + "Default value. This value is unused.", + "High quality, Google-grade network tier, support for all networking products.", + "Public internet quality, only limited support for other networking products." + ], + "type": "string" + }, + "publicPtrDomainName": { + "description": "Optional. The DNS domain name for the public PTR record.", + "type": "string" + }, + "setPublicPtr": { + "description": "Optional. Specifies whether a public DNS 'PTR' record should be created to map the external IP address of the instance to a DNS domain name.", + "type": "boolean" + }, + "type": { + "description": "Optional. In accessConfigs (IPv4), the default and only option is ONE_TO_ONE_NAT. In ipv6AccessConfigs, the default and only option is DIRECT_IPV6.", + "enum": [ + "ACCESS_TYPE_UNSPECIFIED", + "ONE_TO_ONE_NAT", + "DIRECT_IPV6" + ], + "enumDescriptions": [ + "Default value. This value is unused.", + "ONE_TO_ONE_NAT", + "Direct IPv6 access." + ], + "type": "string" + } + }, + "type": "object" + }, + "AliasIpRange": { + "description": "An alias IP range attached to an instance's network interface.", + "id": "AliasIpRange", + "properties": { + "ipCidrRange": { + "description": "Optional. The IP alias ranges to allocate for this interface.", + "type": "string" + }, + "subnetworkRangeName": { + "description": "Optional. The name of a subnetwork secondary IP range from which to allocate an IP alias range. If not specified, the primary range of the subnetwork is used.", + "type": "string" + } + }, + "type": "object" + }, + "AttachedDisk": { + "description": "An instance-attached disk resource.", + "id": "AttachedDisk", + "properties": { + "autoDelete": { + "description": "Optional. Specifies whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance).", + "type": "boolean" + }, + "boot": { + "description": "Optional. Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem.", + "type": "boolean" + }, + "deviceName": { + "description": "Optional. This is used as an identifier for the disks. This is the unique name has to provided to modify disk parameters like disk_name and replica_zones (in case of RePDs)", + "type": "string" + }, + "diskEncryptionKey": { + "$ref": "CustomerEncryptionKey", + "description": "Optional. Encrypts or decrypts a disk using a customer-supplied encryption key." + }, + "diskInterface": { + "description": "Optional. Specifies the disk interface to use for attaching this disk.", + "enum": [ + "DISK_INTERFACE_UNSPECIFIED", + "SCSI", + "NVME", + "NVDIMM", + "ISCSI" + ], + "enumDescriptions": [ + "Default value, which is unused.", + "SCSI Disk Interface.", + "NVME Disk Interface.", + "NVDIMM Disk Interface.", + "ISCSI Disk Interface." + ], + "type": "string" + }, + "diskSizeGb": { + "description": "Optional. The size of the disk in GB.", + "format": "int64", + "type": "string" + }, + "diskType": { + "description": "Optional. Specifies the type of the disk.", + "enum": [ + "DISK_TYPE_UNSPECIFIED", + "SCRATCH", + "PERSISTENT" + ], + "enumDescriptions": [ + "Default value, which is unused.", + "A scratch disk type.", + "A persistent disk type." + ], + "type": "string" + }, + "guestOsFeature": { + "description": "Optional. A list of features to enable on the guest operating system. Applicable only for bootable images.", + "items": { + "$ref": "GuestOsFeature" + }, + "type": "array" + }, + "index": { + "description": "Optional. A zero-based index to this disk, where 0 is reserved for the boot disk.", + "format": "int64", + "type": "string" + }, + "initializeParams": { + "$ref": "InitializeParams", + "description": "Optional. Specifies the parameters to initialize this disk." + }, + "kind": { + "description": "Optional. Type of the resource.", + "type": "string" + }, + "license": { + "description": "Optional. Any valid publicly visible licenses.", + "items": { + "type": "string" + }, + "type": "array" + }, + "mode": { + "description": "Optional. The mode in which to attach this disk.", + "enum": [ + "DISK_MODE_UNSPECIFIED", + "READ_WRITE", + "READ_ONLY", + "LOCKED" + ], + "enumDescriptions": [ + "Default value, which is unused.", + "Attaches this disk in read-write mode. Only one virtual machine at a time can be attached to a disk in read-write mode.", + "Attaches this disk in read-only mode. Multiple virtual machines can use a disk in read-only mode at a time.", + "The disk is locked for administrative reasons. Nobody else can use the disk. This mode is used (for example) when taking a snapshot of a disk to prevent mounting the disk while it is being snapshotted." + ], + "type": "string" + }, + "savedState": { + "description": "Optional. Output only. The state of the disk.", + "enum": [ + "DISK_SAVED_STATE_UNSPECIFIED", + "PRESERVED" + ], + "enumDescriptions": [ + "Default Disk state has not been preserved.", + "Disk state has been preserved." + ], + "readOnly": true, + "type": "string" + }, + "source": { + "description": "Optional. Specifies a valid partial or full URL to an existing Persistent Disk resource.", + "type": "string" + } + }, + "type": "object" + }, + "AuditConfig": { + "description": "Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { \"audit_configs\": [ { \"service\": \"allServices\", \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\", \"exempted_members\": [ \"user:jose@example.com\" ] }, { \"log_type\": \"DATA_WRITE\" }, { \"log_type\": \"ADMIN_READ\" } ] }, { \"service\": \"sampleservice.googleapis.com\", \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\" }, { \"log_type\": \"DATA_WRITE\", \"exempted_members\": [ \"user:aliya@example.com\" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging.", + "id": "AuditConfig", + "properties": { + "auditLogConfigs": { + "description": "The configuration for logging of each type of permission.", + "items": { + "$ref": "AuditLogConfig" + }, + "type": "array" + }, + "service": { + "description": "Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.", + "type": "string" + } + }, + "type": "object" + }, + "AuditLogConfig": { + "description": "Provides the configuration for logging a type of permissions. Example: { \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\", \"exempted_members\": [ \"user:jose@example.com\" ] }, { \"log_type\": \"DATA_WRITE\" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.", + "id": "AuditLogConfig", + "properties": { + "exemptedMembers": { + "description": "Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.", + "items": { + "type": "string" + }, + "type": "array" + }, + "logType": { + "description": "The log type that this config enables.", + "enum": [ + "LOG_TYPE_UNSPECIFIED", + "ADMIN_READ", + "DATA_WRITE", + "DATA_READ" + ], + "enumDescriptions": [ + "Default case. Should never be this.", + "Admin reads. Example: CloudIAM getIamPolicy", + "Data writes. Example: CloudSQL Users create", + "Data reads. Example: CloudSQL Users list" + ], + "type": "string" + } + }, + "type": "object" + }, + "Backup": { + "description": "Message describing a Backup object.", + "id": "Backup", + "properties": { + "backupApplianceBackupProperties": { + "$ref": "BackupApplianceBackupProperties", + "readOnly": true + }, + "backupApplianceLocks": { + "description": "Optional. The list of BackupLocks taken by the accessor Backup Appliance.", + "items": { + "$ref": "BackupLock" + }, + "type": "array" + }, + "backupType": { + "enum": [ + "BACKUP_TYPE_UNSPECIFIED", + "SCHEDULED", + "ON_DEMAND" + ], + "enumDescriptions": [ + "", + "", + "" + ], + "readOnly": true, + "type": "string" + }, + "computeInstanceBackupProperties": { + "$ref": "ComputeInstanceBackupProperties", + "readOnly": true + }, + "consistencyTime": { + "description": "Output only. The point in time when this backup was captured from the source.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "createTime": { + "description": "Output only. The time when the instance was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "description": { + "description": "Output only. The description of the Backup instance (2048 characters or less).", + "readOnly": true, + "type": "string" + }, + "enforcedRetentionEndTime": { + "description": "Optional. The backup can not be deleted before this time.", + "format": "google-datetime", + "type": "string" + }, + "etag": { + "description": "Optional. Server specified ETag to prevent updates from overwriting each other.", + "type": "string" + }, + "expireTime": { + "description": "Optional. When this backup is automatically expired.", + "format": "google-datetime", + "type": "string" + }, + "gcpBackupPlanInfo": { + "$ref": "GCPBackupPlanInfo", + "description": "Output only. Configuration for a Google Cloud resource.", + "readOnly": true + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. Resource labels to represent user provided metadata. No labels currently defined.", + "type": "object" + }, + "name": { + "description": "Output only. Name of the resource.", + "readOnly": true, + "type": "string" + }, + "resourceSizeBytes": { + "description": "Output only. source resource size in bytes at the time of the backup.", + "format": "int64", + "readOnly": true, + "type": "string" + }, + "serviceLocks": { + "description": "Output only. The list of BackupLocks taken by the service to prevent the deletion of the backup.", + "items": { + "$ref": "BackupLock" + }, + "readOnly": true, + "type": "array" + }, + "state": { + "description": "Output only. The Backup resource instance state.", + "enum": [ + "STATE_UNSPECIFIED", + "CREATING", + "ACTIVE", + "DELETING", + "ERROR" + ], + "enumDescriptions": [ + "State not set.", + "The backup is being created.", + "The backup has been created and is fully usable.", + "The backup is being deleted.", + "The backup is experiencing an issue and might be unusable." + ], + "readOnly": true, + "type": "string" + }, + "updateTime": { + "description": "Output only. The time when the instance was updated.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "BackupApplianceBackupConfig": { + "description": "BackupApplianceBackupConfig captures the backup configuration for applications that are protected by Backup Appliances.", + "id": "BackupApplianceBackupConfig", + "properties": { + "applicationName": { + "description": "The name of the application.", + "type": "string" + }, + "backupApplianceId": { + "description": "The ID of the backup appliance.", + "format": "int64", + "type": "string" + }, + "backupApplianceName": { + "description": "The name of the backup appliance.", + "type": "string" + }, + "hostName": { + "description": "The name of the host where the application is running.", + "type": "string" + }, + "slaId": { + "description": "The ID of the SLA of this application.", + "format": "int64", + "type": "string" + }, + "slpName": { + "description": "The name of the SLP associated with the application.", + "type": "string" + }, + "sltName": { + "description": "The name of the SLT associated with the application.", + "type": "string" + } + }, + "type": "object" + }, + "BackupApplianceBackupProperties": { + "description": "BackupApplianceBackupProperties represents BackupDR backup appliance's properties.", + "id": "BackupApplianceBackupProperties", + "properties": { + "finalizeTime": { + "description": "Output only. The time when this backup object was finalized (if none, backup is not finalized).", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "generationId": { + "description": "Output only. The numeric generation ID of the backup (monotonically increasing).", + "format": "int32", + "readOnly": true, + "type": "integer" + }, + "recoveryRangeEndTime": { + "description": "Optional. The latest timestamp of data available in this Backup.", + "format": "google-datetime", + "type": "string" + }, + "recoveryRangeStartTime": { + "description": "Optional. The earliest timestamp of data available in this Backup.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "BackupApplianceLockInfo": { + "description": "BackupApplianceLockInfo contains metadata about the backupappliance that created the lock.", + "id": "BackupApplianceLockInfo", + "properties": { + "backupApplianceId": { + "description": "Required. The ID of the backup/recovery appliance that created this lock.", + "format": "int64", + "type": "string" + }, + "backupApplianceName": { + "description": "Required. The name of the backup/recovery appliance that created this lock.", + "type": "string" + }, + "backupImage": { + "description": "The image name that depends on this Backup.", + "type": "string" + }, + "jobName": { + "description": "The job name on the backup/recovery appliance that created this lock.", + "type": "string" + }, + "lockReason": { + "description": "Required. The reason for the lock: e.g. MOUNT/RESTORE/BACKUP/etc. The value of this string is only meaningful to the client and it is not interpreted by the BackupVault service.", + "type": "string" + }, + "slaId": { + "description": "The SLA on the backup/recovery appliance that owns the lock.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "BackupConfigInfo": { + "description": "BackupConfigInfo has information about how the resource is configured for Backup and about the most recent backup to this vault.", + "id": "BackupConfigInfo", + "properties": { + "backupApplianceBackupConfig": { + "$ref": "BackupApplianceBackupConfig", + "description": "Configuration for an application backed up by a Backup Appliance." + }, + "gcpBackupConfig": { + "$ref": "GcpBackupConfig", + "description": "Configuration for a Google Cloud resource." + }, + "lastBackupError": { + "$ref": "Status", + "description": "Output only. If the last backup failed, this field has the error message.", + "readOnly": true + }, + "lastBackupState": { + "description": "Output only. The status of the last backup to this BackupVault", + "enum": [ + "LAST_BACKUP_STATE_UNSPECIFIED", + "FIRST_BACKUP_PENDING", + "SUCCEEDED", + "FAILED", + "PERMISSION_DENIED" + ], + "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" + ], + "readOnly": true, + "type": "string" + }, + "lastSuccessfulBackupConsistencyTime": { + "description": "Output only. If the last backup were successful, this field has the consistency date.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "BackupLock": { + "description": "BackupLock represents a single lock on a Backup resource. An unexpired lock on a Backup prevents the Backup from being deleted.", + "id": "BackupLock", + "properties": { + "backupApplianceLockInfo": { + "$ref": "BackupApplianceLockInfo", + "description": "If the client is a backup and recovery appliance, this contains metadata about why the lock exists." + }, + "lockUntilTime": { + "description": "Required. The time after which this lock is not considered valid and will no longer protect the Backup from deletion.", + "format": "google-datetime", + "type": "string" + }, + "serviceLockInfo": { + "$ref": "ServiceLockInfo", + "description": "Output only. Contains metadata about the lock exist for Google Cloud native backups.", + "readOnly": true + } + }, + "type": "object" + }, + "BackupVault": { + "description": "Message describing a BackupVault object.", + "id": "BackupVault", + "properties": { + "annotations": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. User annotations. See https://google.aip.dev/128#annotations Stores small amounts of arbitrary data.", + "type": "object" + }, + "backupCount": { + "description": "Output only. The number of backups in this backup vault.", + "format": "int64", + "readOnly": true, + "type": "string" + }, + "backupMinimumEnforcedRetentionDuration": { + "description": "Required. The default and minimum enforced retention for each backup within the backup vault. The enforced retention for each backup can be extended.", + "format": "google-duration", + "type": "string" + }, + "createTime": { + "description": "Output only. The time when the instance was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "deletable": { + "description": "Output only. Set to true when there are no backups nested under this resource.", + "readOnly": true, + "type": "boolean" + }, + "description": { + "description": "Optional. The description of the BackupVault instance (2048 characters or less).", + "type": "string" + }, + "effectiveTime": { + "description": "Optional. Time after which the BackupVault resource is locked.", + "format": "google-datetime", + "type": "string" + }, + "enforcedRetentionDuration": { + "description": "Required. The default retention period for each backup in the backup vault (Deprecated).", + "format": "google-duration", + "type": "string" + }, + "etag": { + "description": "Optional. Server specified ETag for the backup vault resource to prevent simultaneous updates from overwiting each other.", + "type": "string" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. Resource labels to represent user provided metadata. No labels currently defined:", + "type": "object" + }, + "name": { + "description": "Output only. The resource name.", + "readOnly": true, + "type": "string" + }, + "serviceAccount": { + "description": "Output only. Service account used by the BackupVault Service for this BackupVault. The user should grant this account permissions in their workload project to enable the service to run backups and restores there.", + "readOnly": true, + "type": "string" + }, + "state": { + "description": "Output only. The BackupVault resource instance state.", + "enum": [ + "STATE_UNSPECIFIED", + "CREATING", + "ACTIVE", + "DELETING", + "ERROR" + ], + "enumDescriptions": [ + "State not set.", + "The backup vault is being created.", + "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." + ], + "readOnly": true, + "type": "string" + }, + "totalStoredBytes": { + "description": "Output only. Total size of the storage used by all backup resources.", + "format": "int64", + "readOnly": true, + "type": "string" + }, + "uid": { + "description": "Output only. Output only Immutable after resource creation until resource deletion.", + "readOnly": true, + "type": "string" + }, + "updateTime": { + "description": "Output only. The time when the instance was updated.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "Binding": { + "description": "Associates `members`, or principals, with a `role`.", + "id": "Binding", + "properties": { + "condition": { + "$ref": "Expr", + "description": "The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies)." + }, + "members": { + "description": "Specifies the principals requesting access for a 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" + } + }, + "type": "object" + }, + "CancelOperationRequest": { + "description": "The request message for Operations.CancelOperation.", + "id": "CancelOperationRequest", + "properties": {}, + "type": "object" + }, + "ComputeInstanceBackupProperties": { + "description": "ComputeInstanceBackupProperties represents Compute Engine instance backup properties.", + "id": "ComputeInstanceBackupProperties", + "properties": { + "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 https://cloud.google.com/vpc/docs/using-routes#canipforward documentation for more information.", + "type": "boolean" + }, + "description": { + "description": "An optional text description for the instances that are created from these properties.", + "type": "string" + }, + "disk": { + "description": "An array of disks that are associated with the instances that are created from these properties.", + "items": { + "$ref": "AttachedDisk" + }, + "type": "array" + }, + "guestAccelerator": { + "description": "A list of guest accelerator cards' type and count to use for instances created from these properties.", + "items": { + "$ref": "AcceleratorConfig" + }, + "type": "array" + }, + "keyRevocationActionType": { + "description": "KeyRevocationActionType of the instance. Supported options are \"STOP\" and \"NONE\". The default value is \"NONE\" if it is not specified.", + "enum": [ + "KEY_REVOCATION_ACTION_TYPE_UNSPECIFIED", + "NONE", + "STOP" + ], + "enumDescriptions": [ + "Default value. This value is unused.", + "Indicates user chose no operation.", + "Indicates user chose to opt for VM shutdown on key revocation." + ], + "type": "string" + }, + "machineType": { + "description": "The machine type to use for instances that are created from these properties.", + "type": "string" + }, + "metadata": { + "$ref": "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 https://cloud.google.com/compute/docs/metadata/overview for more information." + }, + "minCpuPlatform": { + "description": "Minimum cpu/platform to be used by instances. The instance may be scheduled on the specified or newer cpu/platform. Applicable values are the friendly names of CPU platforms, such as `minCpuPlatform: Intel Haswell` or `minCpuPlatform: Intel Sandy Bridge`. For more information, read https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform.", + "type": "string" + }, + "networkInterface": { + "description": "An array of network access configurations for this interface.", + "items": { + "$ref": "NetworkInterface" + }, + "type": "array" + }, + "scheduling": { + "$ref": "Scheduling", + "description": "Specifies the scheduling options for the instances that are created from these properties." + }, + "serviceAccount": { + "description": "A list of service accounts with specified scopes. Access tokens for these service accounts are available to the instances that are created from these properties. Use metadata queries to obtain the access tokens for these instances.", + "items": { + "$ref": "ServiceAccount" + }, + "type": "array" + }, + "sourceInstanceName": { + "description": "Name of the source instance at the time of backup. The name is 1-63 characters long, and complies with RFC1035.", + "type": "string" + }, + "tags": { + "$ref": "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 (https://www.ietf.org/rfc/rfc1035.txt)." + } + }, + "type": "object" + }, + "ComputeInstanceDataSourceProperties": { + "description": "ComputeInstanceDataSourceProperties represents the properties of a ComputeEngine resource that are stored in the DataSource.", + "id": "ComputeInstanceDataSourceProperties", + "properties": { + "description": { + "description": "The description of the Compute Engine instance.", + "type": "string" + }, + "machineType": { + "description": "The machine type of the instance.", + "type": "string" + }, + "name": { + "description": "Name of the compute instance backed up by the datasource.", + "type": "string" + }, + "totalDiskCount": { + "description": "The total number of disks attached to the Instance.", + "format": "int64", + "type": "string" + }, + "totalDiskSizeGb": { + "description": "The sum of all the disk sizes.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "CustomerEncryptionKey": { + "description": "A customer-supplied encryption key.", + "id": "CustomerEncryptionKey", + "properties": { + "kmsKeyName": { + "description": "Optional. The name of the encryption key that is stored in Google Cloud KMS.", + "type": "string" + }, + "kmsKeyServiceAccount": { + "description": "Optional. The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used.", + "type": "string" + }, + "rawKey": { + "description": "Optional. Specifies a 256-bit customer-supplied encryption key.", + "type": "string" + }, + "rsaEncryptedKey": { + "description": "Optional. RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.", + "type": "string" + } + }, + "type": "object" + }, + "DataSource": { + "description": "Message describing a DataSource object. Datasource object used to represent Datasource details for both admin and basic view.", + "id": "DataSource", + "properties": { + "backupConfigInfo": { + "$ref": "BackupConfigInfo", + "description": "Output only. Details of how the resource is configured for backup.", + "readOnly": true + }, + "backupCount": { + "description": "Number of backups in the data source.", + "format": "int64", + "type": "string" + }, + "configState": { + "description": "The backup configuration state.", + "enum": [ + "BACKUP_CONFIG_STATE_UNSPECIFIED", + "ACTIVE", + "PASSIVE" + ], + "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)" + ], + "type": "string" + }, + "createTime": { + "description": "Output only. The time when the instance was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "dataSourceBackupApplianceApplication": { + "$ref": "DataSourceBackupApplianceApplication", + "description": "The backed up resource is a backup appliance application." + }, + "dataSourceGcpResource": { + "$ref": "DataSourceGcpResource", + "description": "The backed up resource is a Google Cloud resource. The word 'DataSource' was included in the names to indicate that this is the representation of the Google Cloud resource used within the DataSource object." + }, + "etag": { + "description": "Server specified ETag for the ManagementServer resource to prevent simultaneous updates from overwiting each other.", + "type": "string" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. Resource labels to represent user provided metadata. No labels currently defined:", + "type": "object" + }, + "name": { + "description": "Output only. The resource name.", + "readOnly": true, + "type": "string" + }, + "state": { + "description": "Output only. The DataSource resource instance state.", + "enum": [ + "STATE_UNSPECIFIED", + "CREATING", + "ACTIVE", + "DELETING", + "ERROR" + ], + "enumDescriptions": [ + "State not set.", + "The data source is being created.", + "The data source has been created and is fully usable.", + "The data source is being deleted.", + "The data source is experiencing an issue and might be unusable." + ], + "readOnly": true, + "type": "string" + }, + "totalStoredBytes": { + "description": "The number of bytes (metadata and data) stored in this datasource.", + "format": "int64", + "type": "string" + }, + "updateTime": { + "description": "Output only. The time when the instance was updated.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "DataSourceBackupApplianceApplication": { + "description": "BackupApplianceApplication describes a Source Resource when it is an application backed up by a BackupAppliance.", + "id": "DataSourceBackupApplianceApplication", + "properties": { + "applianceId": { + "description": "Appliance Id of the Backup Appliance.", + "format": "int64", + "type": "string" + }, + "applicationId": { + "description": "The appid field of the application within the Backup Appliance.", + "format": "int64", + "type": "string" + }, + "applicationName": { + "description": "The name of the Application as known to the Backup Appliance.", + "type": "string" + }, + "backupAppliance": { + "description": "Appliance name.", + "type": "string" + }, + "hostId": { + "description": "Hostid of the application host.", + "format": "int64", + "type": "string" + }, + "hostname": { + "description": "Hostname of the host where the application is running.", + "type": "string" + }, + "type": { + "description": "The type of the application. e.g. VMBackup", + "type": "string" + } + }, + "type": "object" + }, + "DataSourceGcpResource": { + "description": "DataSourceGcpResource is used for protected resources that are Google Cloud Resources. This name is easeier to understand than GcpResourceDataSource or GcpDataSourceResource", + "id": "DataSourceGcpResource", + "properties": { + "computeInstanceDatasourceProperties": { + "$ref": "ComputeInstanceDataSourceProperties", + "description": "ComputeInstanceDataSourceProperties has a subset of Compute Instance properties that are useful at the Datasource level." + }, + "gcpResourcename": { + "description": "Output only. Full resource pathname URL of the source Google Cloud resource.", + "readOnly": true, + "type": "string" + }, + "location": { + "description": "Location of the resource: //\"global\"/\"unspecified\".", + "type": "string" + }, + "type": { + "description": "The type of the Google Cloud resource. Use the Unified Resource Type, eg. compute.googleapis.com/Instance.", + "type": "string" + } + }, + "type": "object" + }, + "Empty": { + "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }", + "id": "Empty", + "properties": {}, + "type": "object" + }, + "Entry": { + "description": "A key/value pair to be used for storing metadata.", + "id": "Entry", + "properties": { + "key": { + "description": "Optional. Key for the metadata entry.", + "type": "string" + }, + "value": { + "description": "Optional. Value for the metadata entry. These are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on values is that their size must be less than or equal to 262144 bytes (256 KiB).", + "type": "string" + } + }, + "type": "object" + }, + "Expr": { + "description": "Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: \"Summary size limit\" description: \"Determines if a summary is less than 100 chars\" expression: \"document.summary.size() < 100\" Example (Equality): title: \"Requestor is owner\" description: \"Determines if requestor is the document owner\" expression: \"document.owner == request.auth.claims.email\" Example (Logic): title: \"Public documents\" description: \"Determine whether the document should be publicly visible\" expression: \"document.type != 'private' && document.type != 'internal'\" Example (Data Manipulation): title: \"Notification string\" description: \"Create a notification string with a timestamp.\" expression: \"'New message received at ' + string(document.create_time)\" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.", + "id": "Expr", + "properties": { + "description": { + "description": "Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.", + "type": "string" + }, + "expression": { + "description": "Textual representation of an expression in Common Expression Language syntax.", + "type": "string" + }, + "location": { + "description": "Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.", + "type": "string" + }, + "title": { + "description": "Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.", + "type": "string" + } + }, + "type": "object" + }, + "FetchAccessTokenRequest": { + "description": "Request message for FetchAccessToken.", + "id": "FetchAccessTokenRequest", + "properties": { + "generationId": { + "description": "Required. The generation of the backup to update.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "FetchAccessTokenResponse": { + "description": "Response message for FetchAccessToken.", + "id": "FetchAccessTokenResponse", + "properties": { + "expireTime": { + "description": "The token is valid until this time.", + "format": "google-datetime", + "type": "string" + }, + "readLocation": { + "description": "The location in bucket that can be used for reading.", + "type": "string" + }, + "token": { + "description": "The downscoped token that was created.", + "type": "string" + }, + "writeLocation": { + "description": "The location in bucket that can be used for writing.", + "type": "string" + } + }, + "type": "object" + }, + "FetchUsableBackupVaultsResponse": { + "description": "Response message for fetching usable BackupVaults.", + "id": "FetchUsableBackupVaultsResponse", + "properties": { + "backupVaults": { + "description": "The list of BackupVault instances in the project for the specified location. If the '{location}' value in the request is \"-\", the response contains a list of instances from all locations. In case any location is unreachable, the response will only return backup vaults in reachable locations and the 'unreachable' field will be populated with a list of unreachable locations.", + "items": { + "$ref": "BackupVault" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token identifying a page of results the server should return.", + "type": "string" + }, + "unreachable": { + "description": "Locations that could not be reached.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "FinalizeBackupRequest": { + "description": "Message for finalizing a Backup.", + "id": "FinalizeBackupRequest", + "properties": { + "backupId": { + "description": "Required. Resource ID of the Backup resource to be finalized. This must be the same backup_id that was used in the InitiateBackupRequest.", + "type": "string" + }, + "consistencyTime": { + "description": "The point in time when this backup was captured from the source. This will be assigned to the consistency_time field of the newly created Backup.", + "format": "google-datetime", + "type": "string" + }, + "description": { + "description": "This will be assigned to the description field of the newly created Backup.", + "type": "string" + }, + "recoveryRangeEndTime": { + "description": "The latest timestamp of data available in this Backup. This will be set on the newly created Backup.", + "format": "google-datetime", + "type": "string" + }, + "recoveryRangeStartTime": { + "description": "The earliest timestamp of data available in this Backup. This will set on the newly created Backup.", + "format": "google-datetime", + "type": "string" + }, + "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" + }, + "retentionDuration": { + "description": "The ExpireTime on the backup will be set to FinalizeTime plus this duration. If the resulting ExpireTime is less than EnforcedRetentionEndTime, then ExpireTime is set to EnforcedRetentionEndTime.", + "format": "google-duration", + "type": "string" + } + }, + "type": "object" + }, + "GCPBackupPlanInfo": { + "description": "GCPBackupPlanInfo captures the plan configuration details of Google Cloud resources at the time of backup.", + "id": "GCPBackupPlanInfo", + "properties": { + "backupPlan": { + "description": "Resource name of backup plan by which workload is protected at the time of the backup. Format: projects/{project}/locations/{location}/backupPlans/{backupPlanId}", + "type": "string" + }, + "backupPlanRuleId": { + "description": "The rule id of the backup plan which triggered this backup in case of scheduled backup or used for", + "type": "string" + } + }, + "type": "object" + }, + "GcpBackupConfig": { + "description": "GcpBackupConfig captures the Backup configuration details for Google Cloud resources. All Google Cloud resources regardless of type are protected with backup plan associations.", + "id": "GcpBackupConfig", + "properties": { + "backupPlan": { + "description": "The name of the backup plan.", + "type": "string" + }, + "backupPlanAssociation": { + "description": "The name of the backup plan association.", + "type": "string" + }, + "backupPlanDescription": { + "description": "The description of the backup plan.", + "type": "string" + }, + "backupPlanRules": { + "description": "The names of the backup plan rules which point to this backupvault", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "GuestOsFeature": { + "description": "Feature type of the Guest OS.", + "id": "GuestOsFeature", + "properties": { + "type": { + "description": "The ID of a supported feature.", + "enum": [ + "FEATURE_TYPE_UNSPECIFIED", + "VIRTIO_SCSI_MULTIQUEUE", + "WINDOWS", + "MULTI_IP_SUBNET", + "UEFI_COMPATIBLE", + "SECURE_BOOT", + "GVNIC", + "SEV_CAPABLE", + "BARE_METAL_LINUX_COMPATIBLE", + "SUSPEND_RESUME_COMPATIBLE", + "SEV_LIVE_MIGRATABLE", + "SEV_SNP_CAPABLE", + "TDX_CAPABLE", + "IDPF", + "SEV_LIVE_MIGRATABLE_V2" + ], + "enumDescriptions": [ + "Default value, which is unused.", + "VIRTIO_SCSI_MULTIQUEUE feature type.", + "WINDOWS feature type.", + "MULTI_IP_SUBNET feature type.", + "UEFI_COMPATIBLE feature type.", + "SECURE_BOOT feature type.", + "GVNIC feature type.", + "SEV_CAPABLE feature type.", + "BARE_METAL_LINUX_COMPATIBLE feature type.", + "SUSPEND_RESUME_COMPATIBLE feature type.", + "SEV_LIVE_MIGRATABLE feature type.", + "SEV_SNP_CAPABLE feature type.", + "TDX_CAPABLE feature type.", + "IDPF feature type.", + "SEV_LIVE_MIGRATABLE_V2 feature type." + ], + "type": "string" + } + }, + "type": "object" + }, + "InitializeParams": { + "description": "Specifies the parameters to initialize this disk.", + "id": "InitializeParams", + "properties": { + "diskName": { + "description": "Optional. Specifies the disk name. If not specified, the default is to use the name of the instance.", + "type": "string" + }, + "replicaZones": { + "description": "Optional. URL of the zone where the disk should be created. Required for each regional disk associated with the instance.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "InitiateBackupRequest": { + "description": "request message for InitiateBackup.", + "id": "InitiateBackupRequest", + "properties": { + "backupId": { + "description": "Required. Resource ID of the Backup resource.", + "type": "string" + }, + "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" + } + }, + "type": "object" + }, + "InitiateBackupResponse": { + "description": "Response message for InitiateBackup.", + "id": "InitiateBackupResponse", + "properties": { + "backup": { + "description": "The name of the backup that was created.", + "type": "string" + }, + "baseBackupGenerationId": { + "description": "The generation id of the base backup. It is needed for the incremental backups.", + "format": "int32", + "type": "integer" + }, + "newBackupGenerationId": { + "description": "The generation id of the new backup.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "ListBackupVaultsResponse": { + "description": "Response message for listing BackupVaults.", + "id": "ListBackupVaultsResponse", + "properties": { + "backupVaults": { + "description": "The list of BackupVault instances in the project for the specified location. If the '{location}' value in the request is \"-\", the response contains a list of instances from all locations. In case any location is unreachable, the response will only return backup vaults in reachable locations and the 'unreachable' field will be populated with a list of unreachable locations.", + "items": { + "$ref": "BackupVault" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token identifying a page of results the server should return.", + "type": "string" + }, + "unreachable": { + "description": "Locations that could not be reached.", "items": { - "$ref": "AuditLogConfig" + "type": "string" }, "type": "array" - }, - "service": { - "description": "Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.", - "type": "string" } }, "type": "object" }, - "AuditLogConfig": { - "description": "Provides the configuration for logging a type of permissions. Example: { \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\", \"exempted_members\": [ \"user:jose@example.com\" ] }, { \"log_type\": \"DATA_WRITE\" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.", - "id": "AuditLogConfig", + "ListBackupsResponse": { + "description": "Response message for listing Backups.", + "id": "ListBackupsResponse", "properties": { - "exemptedMembers": { - "description": "Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.", + "backups": { + "description": "The list of Backup instances in the project for the specified location. If the '{location}' value in the request is \"-\", the response contains a list of instances from all locations. In case any location is unreachable, the response will only return data sources in reachable locations and the 'unreachable' field will be populated with a list of unreachable locations.", "items": { - "type": "string" + "$ref": "Backup" }, "type": "array" }, - "logType": { - "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" - ], + "nextPageToken": { + "description": "A token identifying a page of results the server should return.", "type": "string" - } - }, - "type": "object" - }, - "Binding": { - "description": "Associates `members`, or principals, with a `role`.", - "id": "Binding", - "properties": { - "condition": { - "$ref": "Expr", - "description": "The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies)." }, - "members": { - "description": "Specifies the principals requesting access for a 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": { + "description": "Locations that could not be reached.", "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" } }, "type": "object" }, - "CancelOperationRequest": { - "description": "The request message for Operations.CancelOperation.", - "id": "CancelOperationRequest", - "properties": {}, - "type": "object" - }, - "Empty": { - "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }", - "id": "Empty", - "properties": {}, - "type": "object" - }, - "Expr": { - "description": "Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: \"Summary size limit\" description: \"Determines if a summary is less than 100 chars\" expression: \"document.summary.size() < 100\" Example (Equality): title: \"Requestor is owner\" description: \"Determines if requestor is the document owner\" expression: \"document.owner == request.auth.claims.email\" Example (Logic): title: \"Public documents\" description: \"Determine whether the document should be publicly visible\" expression: \"document.type != 'private' && document.type != 'internal'\" Example (Data Manipulation): title: \"Notification string\" description: \"Create a notification string with a timestamp.\" expression: \"'New message received at ' + string(document.create_time)\" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.", - "id": "Expr", + "ListDataSourcesResponse": { + "description": "Response message for listing DataSources.", + "id": "ListDataSourcesResponse", "properties": { - "description": { - "description": "Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.", - "type": "string" - }, - "expression": { - "description": "Textual representation of an expression in Common Expression Language syntax.", - "type": "string" + "dataSources": { + "description": "The list of DataSource instances in the project for the specified location. If the '{location}' value in the request is \"-\", the response contains a list of instances from all locations. In case any location is unreachable, the response will only return data sources in reachable locations and the 'unreachable' field will be populated with a list of unreachable locations.", + "items": { + "$ref": "DataSource" + }, + "type": "array" }, - "location": { - "description": "Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.", + "nextPageToken": { + "description": "A token identifying a page of results the server should return.", "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" + "unreachable": { + "description": "Locations that could not be reached.", + "items": { + "type": "string" + }, + "type": "array" } }, "type": "object" @@ -666,7 +2620,7 @@ "id": "ListManagementServersResponse", "properties": { "managementServers": { - "description": "The list of ManagementServer instances in the project for the specified location. If the `{location}` value in the request is \"-\", the response contains a list of instances from all locations. In case any location is unreachable, the response will only return management servers in reachable locations and the 'unreachable' field will be populated with a list of unreachable locations.", + "description": "The list of ManagementServer instances in the project for the specified location. If the '{location}' value in the request is \"-\", the response contains a list of instances from all locations. In case any location is unreachable, the response will only return management servers in reachable locations and the 'unreachable' field will be populated with a list of unreachable locations.", "items": { "$ref": "ManagementServer" }, @@ -789,7 +2743,7 @@ "type": "array" }, "oauth2ClientId": { - "description": "Output only. The OAuth 2.0 client id is required to make API calls to the BackupDR instance API of this ManagementServer. This is the value that should be provided in the ‘aud’ field of the OIDC ID Token (see openid specification https://openid.net/specs/openid-connect-core-1_0.html#IDToken).", + "description": "Output only. The OAuth 2.0 client id is required to make API calls to the BackupDR instance API of this ManagementServer. This is the value that should be provided in the 'aud' field of the OIDC ID Token (see openid specification https://openid.net/specs/openid-connect-core-1_0.html#IDToken).", "readOnly": true, "type": "string" }, @@ -876,6 +2830,20 @@ }, "type": "object" }, + "Metadata": { + "description": "A metadata key/value entry.", + "id": "Metadata", + "properties": { + "items": { + "description": "Optional. Array of key/value pairs. The total size of all keys and values must be less than 512 KB.", + "items": { + "$ref": "Entry" + }, + "type": "array" + } + }, + "type": "object" + }, "NetworkConfig": { "description": "Network configuration for ManagementServer instance.", "id": "NetworkConfig", @@ -899,6 +2867,143 @@ }, "type": "object" }, + "NetworkInterface": { + "description": "A network interface resource attached to an instance. s", + "id": "NetworkInterface", + "properties": { + "accessConfigs": { + "description": "Optional. An array of configurations for this interface. Currently, only one access config,ONE_TO_ONE_NAT is supported. If there are no accessConfigs specified, then this instance will have no external internet access.", + "items": { + "$ref": "AccessConfig" + }, + "type": "array" + }, + "aliasIpRanges": { + "description": "Optional. An array of alias IP ranges for this network interface. You can only specify this field for network interfaces in VPC networks.", + "items": { + "$ref": "AliasIpRange" + }, + "type": "array" + }, + "internalIpv6PrefixLength": { + "description": "Optional. The prefix length of the primary internal IPv6 range.", + "format": "int32", + "type": "integer" + }, + "ipv6AccessConfigs": { + "description": "Optional. An array of IPv6 access configurations for this interface. Currently, only one IPv6 access config, DIRECT_IPV6, is supported. If there is no ipv6AccessConfig specified, then this instance will have no external IPv6 Internet access.", + "items": { + "$ref": "AccessConfig" + }, + "type": "array" + }, + "ipv6AccessType": { + "description": "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.", + "enum": [ + "UNSPECIFIED_IPV6_ACCESS_TYPE", + "INTERNAL", + "EXTERNAL" + ], + "enumDescriptions": [ + "IPv6 access type not set. Means this network interface hasn't been turned on IPv6 yet.", + "This network interface can have internal IPv6.", + "This network interface can have external IPv6." + ], + "type": "string" + }, + "ipv6Address": { + "description": "Optional. 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" + }, + "name": { + "description": "Output only. [Output Only] The name of the network interface, which is generated by the server.", + "readOnly": true, + "type": "string" + }, + "network": { + "description": "Optional. URL of the VPC network resource for this instance.", + "type": "string" + }, + "networkAttachment": { + "description": "Optional. 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" + }, + "networkIP": { + "description": "Optional. An IPv4 internal IP address to assign to the instance for this network interface. If not specified by the user, an unused internal IP is assigned by the system.", + "type": "string" + }, + "nicType": { + "description": "Optional. The type of vNIC to be used on this interface. This may be gVNIC or VirtioNet.", + "enum": [ + "NIC_TYPE_UNSPECIFIED", + "VIRTIO_NET", + "GVNIC" + ], + "enumDescriptions": [ + "Default should be NIC_TYPE_UNSPECIFIED.", + "VIRTIO", + "GVNIC" + ], + "type": "string" + }, + "queueCount": { + "description": "Optional. The networking queue count that's specified by users for the network interface. Both Rx and Tx queues will be set to this number. It'll be empty if not specified by the users.", + "format": "int32", + "type": "integer" + }, + "stackType": { + "description": "The stack type for this network interface.", + "enum": [ + "STACK_TYPE_UNSPECIFIED", + "IPV4_ONLY", + "IPV4_IPV6" + ], + "enumDescriptions": [ + "Default should be STACK_TYPE_UNSPECIFIED.", + "The network interface will be assigned IPv4 address.", + "The network interface can have both IPv4 and IPv6 addresses." + ], + "type": "string" + }, + "subnetwork": { + "description": "Optional. The URL of the Subnetwork resource for this instance.", + "type": "string" + } + }, + "type": "object" + }, + "NodeAffinity": { + "description": "Node Affinity: the configuration of desired nodes onto which this Instance could be scheduled.", + "id": "NodeAffinity", + "properties": { + "key": { + "description": "Optional. Corresponds to the label key of Node resource.", + "type": "string" + }, + "operator": { + "description": "Optional. Defines the operation of node selection.", + "enum": [ + "OPERATOR_UNSPECIFIED", + "IN", + "NOT_IN" + ], + "enumDescriptions": [ + "Default value. This value is unused.", + "Requires Compute Engine to seek for matched nodes.", + "Requires Compute Engine to avoid certain nodes." + ], + "type": "string" + }, + "values": { + "description": "Optional. Corresponds to the label values of Node resource.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "Operation": { "description": "This resource represents a long-running operation that is the result of a network API call.", "id": "Operation", @@ -964,7 +3069,7 @@ "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`.", + "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" }, @@ -1017,6 +3122,137 @@ }, "type": "object" }, + "RemoveDataSourceRequest": { + "description": "Message for deleting a DataSource.", + "id": "RemoveDataSourceRequest", + "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" + } + }, + "type": "object" + }, + "Scheduling": { + "description": "Sets the scheduling options for an Instance.", + "id": "Scheduling", + "properties": { + "automaticRestart": { + "description": "Optional. Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user).", + "type": "boolean" + }, + "instanceTerminationAction": { + "description": "Optional. Specifies the termination action for the instance.", + "enum": [ + "INSTANCE_TERMINATION_ACTION_UNSPECIFIED", + "DELETE", + "STOP" + ], + "enumDescriptions": [ + "Default value. This value is unused.", + "Delete the VM.", + "Stop the VM without storing in-memory content. default action." + ], + "type": "string" + }, + "localSsdRecoveryTimeout": { + "$ref": "SchedulingDuration", + "description": "Optional. 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." + }, + "minNodeCpus": { + "description": "Optional. The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node.", + "format": "int32", + "type": "integer" + }, + "nodeAffinities": { + "description": "Optional. A set of node affinity and anti-affinity configurations. Overrides reservationAffinity.", + "items": { + "$ref": "NodeAffinity" + }, + "type": "array" + }, + "onHostMaintenance": { + "description": "Optional. Defines the maintenance behavior for this instance.", + "enum": [ + "ON_HOST_MAINTENANCE_UNSPECIFIED", + "TERMINATE", + "MIGRATE" + ], + "enumDescriptions": [ + "Default value. This value is unused.", + "Tells Compute Engine to terminate and (optionally) restart the instance away from the maintenance activity.", + "Default, Allows Compute Engine to automatically migrate instances out of the way of maintenance events." + ], + "type": "string" + }, + "preemptible": { + "description": "Optional. Defines whether the instance is preemptible.", + "type": "boolean" + }, + "provisioningModel": { + "description": "Optional. Specifies the provisioning model of the instance.", + "enum": [ + "PROVISIONING_MODEL_UNSPECIFIED", + "STANDARD", + "SPOT" + ], + "enumDescriptions": [ + "Default value. This value is not used.", + "Standard provisioning with user controlled runtime, no discounts.", + "Heavily discounted, no guaranteed runtime." + ], + "type": "string" + } + }, + "type": "object" + }, + "SchedulingDuration": { + "description": "A SchedulingDuration 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.", + "id": "SchedulingDuration", + "properties": { + "nanos": { + "description": "Optional. Span of time that's a fraction of a second at nanosecond resolution.", + "format": "int32", + "type": "integer" + }, + "seconds": { + "description": "Optional. Span of time at a resolution of a second.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "ServiceAccount": { + "description": "A service account.", + "id": "ServiceAccount", + "properties": { + "email": { + "description": "Optional. Email address of the service account.", + "type": "string" + }, + "scopes": { + "description": "Optional. The list of scopes to be made available for this service account.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "ServiceLockInfo": { + "description": "ServiceLockInfo represents the details of a lock taken by the service on a Backup resource.", + "id": "ServiceLockInfo", + "properties": { + "operation": { + "description": "Output only. The name of the operation that created this lock. The lock will automatically be released when the operation completes.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, "SetIamPolicyRequest": { "description": "Request message for `SetIamPolicy` method.", "id": "SetIamPolicyRequest", @@ -1033,6 +3269,36 @@ }, "type": "object" }, + "SetInternalStatusRequest": { + "description": "Request message for SetStatusInternal method.", + "id": "SetInternalStatusRequest", + "properties": { + "backupConfigState": { + "description": "Required. The new BackupConfigState to set for the DataSource.", + "enum": [ + "BACKUP_CONFIG_STATE_UNSPECIFIED", + "ACTIVE", + "PASSIVE" + ], + "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)" + ], + "type": "string" + }, + "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. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "type": "string" + }, + "value": { + "description": "Required. The value required for this method to work. This field must be the 32-byte SHA256 hash of the DataSourceID. The DataSourceID used here is only the final piece of the fully qualified resource path for this DataSource (i.e. the part after '.../dataSources/'). This field exists to make this method difficult to call since it is intended for use only by Backup Appliances.", + "format": "byte", + "type": "string" + } + }, + "type": "object" + }, "Status": { "description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).", "id": "Status", @@ -1060,6 +3326,20 @@ }, "type": "object" }, + "Tags": { + "description": "A set of instance tags.", + "id": "Tags", + "properties": { + "items": { + "description": "Optional. An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "TestIamPermissionsRequest": { "description": "Request message for `TestIamPermissions` method.", "id": "TestIamPermissionsRequest", diff --git a/discovery/batch-v1.json b/discovery/batch-v1.json index 53584d56d8..bfb227984d 100644 --- a/discovery/batch-v1.json +++ b/discovery/batch-v1.json @@ -561,7 +561,7 @@ } } }, - "revision": "20240612", + "revision": "20240703", "rootUrl": "https://batch.googleapis.com/", "schemas": { "Accelerator": { @@ -2010,7 +2010,7 @@ "type": "object" }, "StatusEvent": { - "description": "Status event", + "description": "Status event.", "id": "StatusEvent", "properties": { "description": { @@ -2024,10 +2024,10 @@ }, "taskExecution": { "$ref": "TaskExecution", - "description": "Task Execution" + "description": "Task Execution. This field is only defined for task-level status events where the task fails." }, "taskState": { - "description": "Task State", + "description": "Task State. This field is only defined for task-level status events.", "enum": [ "STATE_UNSPECIFIED", "PENDING", @@ -2223,11 +2223,11 @@ "type": "object" }, "TaskStatus": { - "description": "Status of a task", + "description": "Status of a task.", "id": "TaskStatus", "properties": { "state": { - "description": "Task state", + "description": "Task state.", "enum": [ "STATE_UNSPECIFIED", "PENDING", diff --git a/discovery/beyondcorp-v1alpha.json b/discovery/beyondcorp-v1alpha.json index 93237a02f0..307b81994c 100644 --- a/discovery/beyondcorp-v1alpha.json +++ b/discovery/beyondcorp-v1alpha.json @@ -1028,7 +1028,7 @@ ], "parameters": { "filter": { - "description": "Optional. Filter expression to restrict the insights returned. Supported filter fields: * `type` * `category` * `subCategory` Examples: * \"category = application AND type = count\" * \"category = application AND subCategory = iap\" * \"type = status\" Allowed values: * type: [count, latency, status, list] * category: [application, device, request, security] * subCategory: [iap, webprotect] NOTE: Only equality based comparison is allowed. Only `AND` conjunction is allowed. NOTE: The 'AND' in the filter field needs to be in capital letters only. NOTE: Just filtering on `subCategory` is not allowed. It should be passed in with the parent `category` too. (These expressions are based on the filter language described at https://google.aip.dev/160).", + "description": "Optional. Filter expression to restrict the insights returned. Supported filter fields: * `type` * `category` * `subCategory` Examples: * \"category = application AND type = count\" * \"category = application AND subCategory = iap\" * \"type = status\" Allowed values: * type: [count, latency, status, list] * category: [application, device, request, security] * subCategory: [iap, caa, webprotect] NOTE: Only equality based comparison is allowed. Only `AND` conjunction is allowed. NOTE: The 'AND' in the filter field needs to be in capital letters only. NOTE: Just filtering on `subCategory` is not allowed. It should be passed in with the parent `category` too. (These expressions are based on the filter language described at https://google.aip.dev/160).", "location": "query", "type": "string" }, @@ -3534,7 +3534,7 @@ ], "parameters": { "filter": { - "description": "Optional. Filter expression to restrict the insights returned. Supported filter fields: * `type` * `category` * `subCategory` Examples: * \"category = application AND type = count\" * \"category = application AND subCategory = iap\" * \"type = status\" Allowed values: * type: [count, latency, status, list] * category: [application, device, request, security] * subCategory: [iap, webprotect] NOTE: Only equality based comparison is allowed. Only `AND` conjunction is allowed. NOTE: The 'AND' in the filter field needs to be in capital letters only. NOTE: Just filtering on `subCategory` is not allowed. It should be passed in with the parent `category` too. (These expressions are based on the filter language described at https://google.aip.dev/160).", + "description": "Optional. Filter expression to restrict the insights returned. Supported filter fields: * `type` * `category` * `subCategory` Examples: * \"category = application AND type = count\" * \"category = application AND subCategory = iap\" * \"type = status\" Allowed values: * type: [count, latency, status, list] * category: [application, device, request, security] * subCategory: [iap, caa, webprotect] NOTE: Only equality based comparison is allowed. Only `AND` conjunction is allowed. NOTE: The 'AND' in the filter field needs to be in capital letters only. NOTE: Just filtering on `subCategory` is not allowed. It should be passed in with the parent `category` too. (These expressions are based on the filter language described at https://google.aip.dev/160).", "location": "query", "type": "string" }, @@ -4080,7 +4080,7 @@ } } }, - "revision": "20240619", + "revision": "20240626", "rootUrl": "https://beyondcorp.googleapis.com/", "schemas": { "AllocatedConnection": { diff --git a/discovery/bigquery-v2.json b/discovery/bigquery-v2.json index 0e212edaf9..23becbe43e 100644 --- a/discovery/bigquery-v2.json +++ b/discovery/bigquery-v2.json @@ -289,7 +289,7 @@ "type": "boolean" }, "filter": { - "description": "An expression for filtering the results of the request by label. The syntax is \\\"labels.[:]\\\". Multiple filters can be ANDed together by connecting with a space. Example: \\\"labels.department:receiving labels.active\\\". See [Filtering datasets using labels](/bigquery/docs/filtering-labels#filtering_datasets_using_labels) for details.", + "description": "An expression for filtering the results of the request by label. The syntax is `labels.[:]`. Multiple filters can be ANDed together by connecting with a space. Example: `labels.department:receiving labels.active`. See [Filtering datasets using labels](https://cloud.google.com/bigquery/docs/filtering-labels#filtering_datasets_using_labels) for details.", "location": "query", "type": "string" }, @@ -455,7 +455,7 @@ "type": "string" }, "location": { - "description": "The geographic location of the job. You must specify the location to run the job for the following scenarios: - If the location to run a job is not in the `us` or the `eu` multi-regional location - If the job's location is in a single region (for example, `us-central1`) For more information, see https://cloud.google.com/bigquery/docs/locations#specifying_your_location.", + "description": "The geographic location of the job. You must specify the location to run the job for the following scenarios: * If the location to run a job is not in the `us` or the `eu` multi-regional location * If the job's location is in a single region (for example, `us-central1`) For more information, see https://cloud.google.com/bigquery/docs/locations#specifying_your_location.", "location": "query", "type": "string" }, @@ -530,7 +530,7 @@ "type": "string" }, "location": { - "description": "The geographic location of the job. You must specify the location to run the job for the following scenarios: - If the location to run a job is not in the `us` or the `eu` multi-regional location - If the job's location is in a single region (for example, `us-central1`) For more information, see https://cloud.google.com/bigquery/docs/locations#specifying_your_location.", + "description": "The geographic location of the job. You must specify the location to run the job for the following scenarios: * If the location to run a job is not in the `us` or the `eu` multi-regional location * If the job's location is in a single region (for example, `us-central1`) For more information, see https://cloud.google.com/bigquery/docs/locations#specifying_your_location.", "location": "query", "type": "string" }, @@ -575,7 +575,7 @@ "type": "string" }, "location": { - "description": "The geographic location of the job. You must specify the location to run the job for the following scenarios: - If the location to run a job is not in the `us` or the `eu` multi-regional location - If the job's location is in a single region (for example, `us-central1`) For more information, see https://cloud.google.com/bigquery/docs/locations#specifying_your_location.", + "description": "The geographic location of the job. You must specify the location to run the job for the following scenarios: * If the location to run a job is not in the `us` or the `eu` multi-regional location * If the job's location is in a single region (for example, `us-central1`) For more information, see https://cloud.google.com/bigquery/docs/locations#specifying_your_location.", "location": "query", "type": "string" }, @@ -1935,7 +1935,7 @@ } } }, - "revision": "20240616", + "revision": "20240629", "rootUrl": "https://bigquery.googleapis.com/", "schemas": { "AggregateClassificationMetrics": { @@ -2518,7 +2518,7 @@ "id": "BigLakeConfiguration", "properties": { "connectionId": { - "description": "Required. 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 \"..\" or \"projects//locations//connections/\".", + "description": "Required. 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": { @@ -2534,7 +2534,7 @@ "type": "string" }, "storageUri": { - "description": "Required. 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/\"", + "description": "Required. 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": { @@ -2585,7 +2585,7 @@ "type": "boolean" }, "qualifierEncoded": { - "description": "[Required] Qualifier of the column. Columns in the parent column family that has this exact qualifier are exposed as . field. If the qualifier is valid UTF-8 string, it can be specified in the qualifier_string field. Otherwise, a base-64 encoded value must be set to qualifier_encoded. The column field name is the same as the column qualifier. However, if the qualifier is not a valid BigQuery field identifier i.e. does not match a-zA-Z*, a valid identifier must be provided as field_name.", + "description": "[Required] Qualifier of the column. Columns in the parent column family that has this exact qualifier are exposed as `.` field. If the qualifier is valid UTF-8 string, it can be specified in the qualifier_string field. Otherwise, a base-64 encoded value must be set to qualifier_encoded. The column field name is the same as the column qualifier. However, if the qualifier is not a valid BigQuery field identifier i.e. does not match a-zA-Z*, a valid identifier must be provided as field_name.", "format": "byte", "type": "string" }, @@ -2605,7 +2605,7 @@ "id": "BigtableColumnFamily", "properties": { "columns": { - "description": "Optional. Lists of columns that should be exposed as individual fields as opposed to a list of (column name, value) pairs. All columns whose qualifier matches a qualifier in this list can be accessed as .. Other columns can be accessed as a list through .Column field.", + "description": "Optional. Lists of columns that should be exposed as individual fields as opposed to a list of (column name, value) pairs. All columns whose qualifier matches a qualifier in this list can be accessed as `.`. Other columns can be accessed as a list through the `.Column` field.", "items": { "$ref": "BigtableColumn" }, @@ -3096,6 +3096,7 @@ "type": "object" }, "Dataset": { + "description": "Represents a BigQuery dataset.", "id": "Dataset", "properties": { "access": { @@ -3120,7 +3121,7 @@ "type": "string" }, "role": { - "description": "An IAM role ID that should be granted to the user, group, or domain specified in this access entry. The following legacy mappings will be applied: OWNER <=> roles/bigquery.dataOwner WRITER <=> roles/bigquery.dataEditor READER <=> roles/bigquery.dataViewer This field will accept any of the above formats, but will return only the legacy format. For example, if you set this field to \"roles/bigquery.dataOwner\", it will be returned back as \"OWNER\".", + "description": "An IAM role ID that should be granted to the user, group, or domain specified in this access entry. The following legacy mappings will be applied: * `OWNER`: `roles/bigquery.dataOwner` * `WRITER`: `roles/bigquery.dataEditor` * `READER`: `roles/bigquery.dataViewer` This field will accept any of the above formats, but will return only the legacy format. For example, if you set this field to \"roles/bigquery.dataOwner\", it will be returned back as \"OWNER\".", "type": "string" }, "routine": { @@ -3128,7 +3129,7 @@ "description": "[Pick one] A routine from a different dataset to grant access to. Queries executed against that routine will have read access to views/tables/routines in this dataset. Only UDF is supported for now. The role field is not required when this field is set. If that routine is updated by any user, access to the routine needs to be granted again via an update operation." }, "specialGroup": { - "description": "[Pick one] A special group to grant access to. Possible values include: projectOwners: Owners of the enclosing project. projectReaders: Readers of the enclosing project. projectWriters: Writers of the enclosing project. allAuthenticatedUsers: All authenticated BigQuery users. Maps to similarly-named IAM members.", + "description": "[Pick one] A special group to grant access to. Possible values include: * projectOwners: Owners of the enclosing project. * projectReaders: Readers of the enclosing project. * projectWriters: Writers of the enclosing project. * allAuthenticatedUsers: All authenticated BigQuery users. Maps to similarly-named IAM members.", "type": "string" }, "userByEmail": { @@ -3226,7 +3227,7 @@ "additionalProperties": { "type": "string" }, - "description": "The labels associated with this dataset. You can use these to organize and group your datasets. You can set this property when inserting or updating a dataset. See Creating and Updating Dataset Labels for more information.", + "description": "The labels associated with this dataset. You can use these to organize and group your datasets. You can set this property when inserting or updating a dataset. See [Creating and Updating Dataset Labels](https://cloud.google.com/bigquery/docs/creating-managing-labels#creating_and_updating_dataset_labels) for more information.", "type": "object" }, "lastModifiedTime": { @@ -3416,6 +3417,7 @@ "type": "object" }, "DatasetReference": { + "description": "Identifier for a dataset.", "id": "DatasetReference", "properties": { "datasetId": { @@ -3589,6 +3591,7 @@ "type": "object" }, "EncryptionConfiguration": { + "description": "Configuration for Cloud KMS encryption settings.", "id": "EncryptionConfiguration", "properties": { "kmsKeyName": { @@ -3981,7 +3984,7 @@ "type": "string" }, "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_id can have the form \"..\" or \"projects//locations//connections/\".", + "description": "Optional. The connection specifying the credentials to be used to read external storage, such as Azure Blob, Cloud Storage, or S3. The connection_id can have the form `{project_id}.{location_id};{connection_id}` or `projects/{project_id}/locations/{location_id}/connections/{connection_id}`.", "type": "string" }, "csvOptions": { @@ -6412,7 +6415,7 @@ "Random forest classifier model.", "An imported TensorFlow Lite model.", "An imported ONNX model.", - "Model to capture the manual preprocessing logic in the transform clause." + "Model to capture the columns and logic in the TRANSFORM clause along with statistics useful for ML analytic functions." ], "readOnly": true, "type": "string" @@ -6583,7 +6586,7 @@ "Random forest classifier model.", "An imported TensorFlow Lite model.", "An imported ONNX model.", - "Model to capture the manual preprocessing logic in the transform clause." + "Model to capture the columns and logic in the TRANSFORM clause along with statistics useful for ML analytic functions." ], "readOnly": true, "type": "string" @@ -8986,6 +8989,11 @@ "description": "Free form human-readable reason metadata caching was unused for the job.", "type": "string" }, + "staleness": { + "description": "Duration since last refresh as of this job for managed tables (indicates metadata cache staleness as seen by this job).", + "format": "google-duration", + "type": "string" + }, "tableReference": { "$ref": "TableReference", "description": "Metadata caching eligible table referenced in the query." diff --git a/discovery/bigtableadmin-v2.json b/discovery/bigtableadmin-v2.json index cbc11e9fe5..1cc46844a5 100644 --- a/discovery/bigtableadmin-v2.json +++ b/discovery/bigtableadmin-v2.json @@ -949,7 +949,7 @@ ], "parameters": { "parent": { - "description": "Required. The name of the destination cluster that will contain the backup copy. The cluster must already exists. Values are of the form: `projects/{project}/instances/{instance}/clusters/{cluster}`.", + "description": "Required. The name of the destination cluster that will contain the backup copy. The cluster must already exist. Values are of the form: `projects/{project}/instances/{instance}/clusters/{cluster}`.", "location": "path", "pattern": "^projects/[^/]+/instances/[^/]+/clusters/[^/]+$", "required": true, @@ -2194,7 +2194,7 @@ } } }, - "revision": "20240616", + "revision": "20240703", "rootUrl": "https://bigtableadmin.googleapis.com/", "schemas": { "AppProfile": { @@ -3144,10 +3144,22 @@ "description": "A value that combines incremental updates into a summarized value. Data is never directly written or read using type `Aggregate`. Writes will provide either the `input_type` or `state_type`, and reads will always return the `state_type` .", "id": "GoogleBigtableAdminV2TypeAggregate", "properties": { + "hllppUniqueCount": { + "$ref": "GoogleBigtableAdminV2TypeAggregateHyperLogLogPlusPlusUniqueCount", + "description": "HyperLogLogPlusPlusUniqueCount aggregator." + }, "inputType": { "$ref": "Type", "description": "Type of the inputs that are accumulated by this `Aggregate`, which must specify a full encoding. Use `AddInput` mutations to accumulate new inputs." }, + "max": { + "$ref": "GoogleBigtableAdminV2TypeAggregateMax", + "description": "Max aggregator." + }, + "min": { + "$ref": "GoogleBigtableAdminV2TypeAggregateMin", + "description": "Min aggregator." + }, "stateType": { "$ref": "Type", "description": "Output only. Type that holds the internal accumulator state for the `Aggregate`. This is a function of the `input_type` and `aggregator` chosen, and will always specify a full encoding.", @@ -3160,12 +3172,47 @@ }, "type": "object" }, + "GoogleBigtableAdminV2TypeAggregateHyperLogLogPlusPlusUniqueCount": { + "description": "Computes an approximate unique count over the input values. When using raw data as input, be careful to use a consistent encoding. Otherwise the same value encoded differently could count more than once, or two distinct values could count as identical. Input: Any, or omit for Raw State: TBD Special state conversions: `Int64` (the unique count estimate)", + "id": "GoogleBigtableAdminV2TypeAggregateHyperLogLogPlusPlusUniqueCount", + "properties": {}, + "type": "object" + }, + "GoogleBigtableAdminV2TypeAggregateMax": { + "description": "Computes the max of the input values. Allowed input: `Int64` State: same as input", + "id": "GoogleBigtableAdminV2TypeAggregateMax", + "properties": {}, + "type": "object" + }, + "GoogleBigtableAdminV2TypeAggregateMin": { + "description": "Computes the min of the input values. Allowed input: `Int64` State: same as input", + "id": "GoogleBigtableAdminV2TypeAggregateMin", + "properties": {}, + "type": "object" + }, "GoogleBigtableAdminV2TypeAggregateSum": { "description": "Computes the sum of the input values. Allowed input: `Int64` State: same as input", "id": "GoogleBigtableAdminV2TypeAggregateSum", "properties": {}, "type": "object" }, + "GoogleBigtableAdminV2TypeArray": { + "description": "An ordered list of elements of a given type. Values of type `Array` are stored in `Value.array_value`.", + "id": "GoogleBigtableAdminV2TypeArray", + "properties": { + "elementType": { + "$ref": "Type", + "description": "The type of the elements in the array. This must not be `Array`." + } + }, + "type": "object" + }, + "GoogleBigtableAdminV2TypeBool": { + "description": "bool Values of type `Bool` are stored in `Value.bool_value`.", + "id": "GoogleBigtableAdminV2TypeBool", + "properties": {}, + "type": "object" + }, "GoogleBigtableAdminV2TypeBytes": { "description": "Bytes Values of type `Bytes` are stored in `Value.bytes_value`.", "id": "GoogleBigtableAdminV2TypeBytes", @@ -3189,11 +3236,29 @@ "type": "object" }, "GoogleBigtableAdminV2TypeBytesEncodingRaw": { - "description": "Leaves the value \"as-is\" * Natural sort? Yes * Self-delimiting? No * Compatibility? N/A", + "description": "Leaves the value \"as-is\" * Order-preserving? Yes * Self-delimiting? No * Compatibility? N/A", "id": "GoogleBigtableAdminV2TypeBytesEncodingRaw", "properties": {}, "type": "object" }, + "GoogleBigtableAdminV2TypeDate": { + "description": "Date Values of type `Date` are stored in `Value.date_value`.", + "id": "GoogleBigtableAdminV2TypeDate", + "properties": {}, + "type": "object" + }, + "GoogleBigtableAdminV2TypeFloat32": { + "description": "Float32 Values of type `Float32` are stored in `Value.float_value`.", + "id": "GoogleBigtableAdminV2TypeFloat32", + "properties": {}, + "type": "object" + }, + "GoogleBigtableAdminV2TypeFloat64": { + "description": "Float64 Values of type `Float64` are stored in `Value.float_value`.", + "id": "GoogleBigtableAdminV2TypeFloat64", + "properties": {}, + "type": "object" + }, "GoogleBigtableAdminV2TypeInt64": { "description": "Int64 Values of type `Int64` are stored in `Value.int_value`.", "id": "GoogleBigtableAdminV2TypeInt64", @@ -3217,16 +3282,94 @@ "type": "object" }, "GoogleBigtableAdminV2TypeInt64EncodingBigEndianBytes": { - "description": "Encodes the value as an 8-byte big endian twos complement `Bytes` value. * Natural sort? No (positive values only) * Self-delimiting? Yes * Compatibility? - BigQuery Federation `BINARY` encoding - HBase `Bytes.toBytes` - Java `ByteBuffer.putLong()` with `ByteOrder.BIG_ENDIAN`", + "description": "Encodes the value as an 8-byte big endian twos complement `Bytes` value. * Order-preserving? No (positive values only) * Self-delimiting? Yes * Compatibility? - BigQuery Federation `BINARY` encoding - HBase `Bytes.toBytes` - Java `ByteBuffer.putLong()` with `ByteOrder.BIG_ENDIAN`", "id": "GoogleBigtableAdminV2TypeInt64EncodingBigEndianBytes", "properties": { "bytesType": { "$ref": "GoogleBigtableAdminV2TypeBytes", - "description": "The underlying `Bytes` type, which may be able to encode further." + "description": "Deprecated: ignored if set." + } + }, + "type": "object" + }, + "GoogleBigtableAdminV2TypeMap": { + "description": "A mapping of keys to values of a given type. Values of type `Map` are stored in a `Value.array_value` where each entry is another `Value.array_value` with two elements (the key and the value, in that order). Normally encoded Map values won't have repeated keys, however, clients are expected to handle the case in which they do. If the same key appears multiple times, the _last_ value takes precedence.", + "id": "GoogleBigtableAdminV2TypeMap", + "properties": { + "keyType": { + "$ref": "Type", + "description": "The type of a map key. Only `Bytes`, `String`, and `Int64` are allowed as key types." + }, + "valueType": { + "$ref": "Type", + "description": "The type of the values in a map." + } + }, + "type": "object" + }, + "GoogleBigtableAdminV2TypeString": { + "description": "String Values of type `String` are stored in `Value.string_value`.", + "id": "GoogleBigtableAdminV2TypeString", + "properties": { + "encoding": { + "$ref": "GoogleBigtableAdminV2TypeStringEncoding", + "description": "The encoding to use when converting to/from lower level types." + } + }, + "type": "object" + }, + "GoogleBigtableAdminV2TypeStringEncoding": { + "description": "Rules used to convert to/from lower level types.", + "id": "GoogleBigtableAdminV2TypeStringEncoding", + "properties": { + "utf8Bytes": { + "$ref": "GoogleBigtableAdminV2TypeStringEncodingUtf8Bytes", + "description": "Use `Utf8Bytes` encoding." + } + }, + "type": "object" + }, + "GoogleBigtableAdminV2TypeStringEncodingUtf8Bytes": { + "description": "UTF-8 encoding * Order-preserving? Yes (code point order) * Self-delimiting? No * Compatibility? - BigQuery Federation `TEXT` encoding - HBase `Bytes.toBytes` - Java `String#getBytes(StandardCharsets.UTF_8)`", + "id": "GoogleBigtableAdminV2TypeStringEncodingUtf8Bytes", + "properties": {}, + "type": "object" + }, + "GoogleBigtableAdminV2TypeStruct": { + "description": "A structured data value, consisting of fields which map to dynamically typed values. Values of type `Struct` are stored in `Value.array_value` where entries are in the same order and number as `field_types`.", + "id": "GoogleBigtableAdminV2TypeStruct", + "properties": { + "fields": { + "description": "The names and types of the fields in this struct.", + "items": { + "$ref": "GoogleBigtableAdminV2TypeStructField" + }, + "type": "array" } }, "type": "object" }, + "GoogleBigtableAdminV2TypeStructField": { + "description": "A struct field and its type.", + "id": "GoogleBigtableAdminV2TypeStructField", + "properties": { + "fieldName": { + "description": "The field name (optional). Fields without a `field_name` are considered anonymous and cannot be referenced by name.", + "type": "string" + }, + "type": { + "$ref": "Type", + "description": "The type of values in this field." + } + }, + "type": "object" + }, + "GoogleBigtableAdminV2TypeTimestamp": { + "description": "Timestamp Values of type `Timestamp` are stored in `Value.timestamp_value`.", + "id": "GoogleBigtableAdminV2TypeTimestamp", + "properties": {}, + "type": "object" + }, "HotTablet": { "description": "A tablet is a defined by a start and end key and is explained in https://cloud.google.com/bigtable/docs/overview#architecture and https://cloud.google.com/bigtable/docs/performance#optimization. A Hot tablet is a tablet that exhibits high average cpu usage during the time interval from start time to end time.", "id": "HotTablet", @@ -4103,20 +4246,56 @@ "type": "object" }, "Type": { - "description": "`Type` represents the type of data that is written to, read from, or stored in Bigtable. It is heavily based on the GoogleSQL standard to help maintain familiarity and consistency across products and features. For compatibility with Bigtable's existing untyped APIs, each `Type` includes an `Encoding` which describes how to convert to/from the underlying data. This might involve composing a series of steps into an \"encoding chain,\" for example to convert from INT64 -> STRING -> raw bytes. In most cases, a \"link\" in the encoding chain will be based an on existing GoogleSQL conversion function like `CAST`. Each link in the encoding chain also defines the following properties: * Natural sort: Does the encoded value sort consistently with the original typed value? Note that Bigtable will always sort data based on the raw encoded value, *not* the decoded type. - Example: BYTES values sort in the same order as their raw encodings. - Counterexample: Encoding INT64 to a fixed-width STRING does *not* preserve sort order when dealing with negative numbers. INT64(1) > INT64(-1), but STRING(\"-00001\") > STRING(\"00001). - The overall encoding chain has this property if *every* link does. * Self-delimiting: If we concatenate two encoded values, can we always tell where the first one ends and the second one begins? - Example: If we encode INT64s to fixed-width STRINGs, the first value will always contain exactly N digits, possibly preceded by a sign. - Counterexample: If we concatenate two UTF-8 encoded STRINGs, we have no way to tell where the first one ends. - The overall encoding chain has this property if *any* link does. * Compatibility: Which other systems have matching encoding schemes? For example, does this encoding have a GoogleSQL equivalent? HBase? Java?", + "description": "`Type` represents the type of data that is written to, read from, or stored in Bigtable. It is heavily based on the GoogleSQL standard to help maintain familiarity and consistency across products and features. For compatibility with Bigtable's existing untyped APIs, each `Type` includes an `Encoding` which describes how to convert to/from the underlying data. Each encoding also defines the following properties: * Order-preserving: Does the encoded value sort consistently with the original typed value? Note that Bigtable will always sort data based on the raw encoded value, *not* the decoded type. - Example: BYTES values sort in the same order as their raw encodings. - Counterexample: Encoding INT64 as a fixed-width decimal string does *not* preserve sort order when dealing with negative numbers. INT64(1) > INT64(-1), but STRING(\"-00001\") > STRING(\"00001). * Self-delimiting: If we concatenate two encoded values, can we always tell where the first one ends and the second one begins? - Example: If we encode INT64s to fixed-width STRINGs, the first value will always contain exactly N digits, possibly preceded by a sign. - Counterexample: If we concatenate two UTF-8 encoded STRINGs, we have no way to tell where the first one ends. * Compatibility: Which other systems have matching encoding schemes? For example, does this encoding have a GoogleSQL equivalent? HBase? Java?", "id": "Type", "properties": { "aggregateType": { "$ref": "GoogleBigtableAdminV2TypeAggregate", "description": "Aggregate" }, + "arrayType": { + "$ref": "GoogleBigtableAdminV2TypeArray", + "description": "Array" + }, + "boolType": { + "$ref": "GoogleBigtableAdminV2TypeBool", + "description": "Bool" + }, "bytesType": { "$ref": "GoogleBigtableAdminV2TypeBytes", "description": "Bytes" }, + "dateType": { + "$ref": "GoogleBigtableAdminV2TypeDate", + "description": "Date" + }, + "float32Type": { + "$ref": "GoogleBigtableAdminV2TypeFloat32", + "description": "Float32" + }, + "float64Type": { + "$ref": "GoogleBigtableAdminV2TypeFloat64", + "description": "Float64" + }, "int64Type": { "$ref": "GoogleBigtableAdminV2TypeInt64", "description": "Int64" + }, + "mapType": { + "$ref": "GoogleBigtableAdminV2TypeMap", + "description": "Map" + }, + "stringType": { + "$ref": "GoogleBigtableAdminV2TypeString", + "description": "String" + }, + "structType": { + "$ref": "GoogleBigtableAdminV2TypeStruct", + "description": "Struct" + }, + "timestampType": { + "$ref": "GoogleBigtableAdminV2TypeTimestamp", + "description": "Timestamp" } }, "type": "object" diff --git a/discovery/calendar-v3.json b/discovery/calendar-v3.json index c51dc20f38..e18def39e1 100644 --- a/discovery/calendar-v3.json +++ b/discovery/calendar-v3.json @@ -1763,7 +1763,7 @@ } } }, - "revision": "20240523", + "revision": "20240712", "rootUrl": "https://www.googleapis.com/", "schemas": { "Acl": { @@ -2591,7 +2591,7 @@ "type": "string" }, "reminders": { - "description": "Information about the event's reminders for the authenticated user.", + "description": "Information about the event's reminders for the authenticated user. Note that changing reminders does not also change the updated property of the enclosing event.", "properties": { "overrides": { "description": "If the event doesn't use the default reminders, this lists the reminders specific to the event, or, if not set, indicates that no reminders are set for this event. The maximum number of override reminders is 5.", @@ -2651,7 +2651,7 @@ "type": "string" }, "updated": { - "description": "Last modification time of the event (as a RFC3339 timestamp). Read-only.", + "description": "Last modification time of the main event data (as a RFC3339 timestamp). Updating event reminders will not cause this to change. Read-only.", "format": "date-time", "type": "string" }, diff --git a/discovery/chat-v1.json b/discovery/chat-v1.json index 19952f69e6..4d96ce96a1 100644 --- a/discovery/chat-v1.json +++ b/discovery/chat-v1.json @@ -433,7 +433,7 @@ "type": "string" }, "updateMask": { - "description": "Required. The updated field paths, comma separated if there are multiple. Currently supported field paths: - `display_name` (Only supports changing the display name of a space with the `SPACE` type, or when also including the `space_type` mask to change a `GROUP_CHAT` space type to `SPACE`. Trying to update the display name of a `GROUP_CHAT` or a `DIRECT_MESSAGE` space results in an invalid argument error. If you receive the error message `ALREADY_EXISTS` when updating the `displayName`, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name.) - `space_type` (Only supports changing a `GROUP_CHAT` space type to `SPACE`. Include `display_name` together with `space_type` in the update mask and ensure that the specified space has a non-empty display name and the `SPACE` space type. Including the `space_type` mask and the `SPACE` type in the specified space when updating the display name is optional if the existing space already has the `SPACE` type. Trying to update the space type in other ways results in an invalid argument error). `space_type` is not supported with admin access. - `space_details` - `space_history_state` (Supports [turning history on or off for the space](https://support.google.com/chat/answer/7664687) if [the organization allows users to change their history setting](https://support.google.com/a/answer/7664184). Warning: mutually exclusive with all other field paths.) `space_history_state` is not supported with admin access. - `access_settings.audience` (Supports changing the [access setting](https://support.google.com/chat/answer/11971020) of who can discover the space, join the space, and preview the messages in space. If no audience is specified in the access setting, the space's access setting is updated to private. Warning: mutually exclusive with all other field paths.) `access_settings.audience` is not supported with admin access. - Developer Preview: Supports changing the [permission settings](https://support.google.com/chat/answer/13340792) of a space, supported field paths include: `permission_settings.manage_members_and_groups`, `permission_settings.modify_space_details`, `permission_settings.toggle_history`, `permission_settings.use_at_mention_all`, `permission_settings.manage_apps`, `permission_settings.manage_webhooks`, `permission_settings.reply_messages` (Warning: mutually exclusive with all other non-permission settings field paths). `permission_settings` is not supported with admin access.", + "description": "Required. The updated field paths, comma separated if there are multiple. You can update the following fields for a space: - `space_details` - `display_name`: Only supports updating the display name for spaces where `spaceType` field is `SPACE`. If you receive the error message `ALREADY_EXISTS`, try a different value. An existing space within the Google Workspace organization might already use this display name. - `space_type`: Only supports changing a `GROUP_CHAT` space type to `SPACE`. Include `display_name` together with `space_type` in the update mask and ensure that the specified space has a non-empty display name and the `SPACE` space type. Including the `space_type` mask and the `SPACE` type in the specified space when updating the display name is optional if the existing space already has the `SPACE` type. Trying to update the space type in other ways results in an invalid argument error. `space_type` is not supported with admin access. - `space_history_state`: Updates [space history settings](https://support.google.com/chat/answer/7664687) by turning history on or off for the space. Only supported if history settings are enabled for the Google Workspace organization. To update the space history state, you must omit all other field masks in your request. `space_history_state` is not supported with admin access. - `access_settings.audience`: Updates the [access setting](https://support.google.com/chat/answer/11971020) of who can discover the space, join the space, and preview the messages in named space where `spaceType` field is `SPACE`. If the existing space has a target audience, you can remove the audience and restrict space access by omitting a value for this field mask. To update access settings for a space, the authenticating user must be a space manager and omit all other field masks in your request. You can't update this field if the space is in [import mode](https://developers.google.com/workspace/chat/import-data-overview). To learn more, see [Make a space discoverable to specific users](https://developers.google.com/workspace/chat/space-target-audience). `access_settings.audience` is not supported with admin access. - Developer Preview: Supports changing the [permission settings](https://support.google.com/chat/answer/13340792) of a space, supported field paths include: `permission_settings.manage_members_and_groups`, `permission_settings.modify_space_details`, `permission_settings.toggle_history`, `permission_settings.use_at_mention_all`, `permission_settings.manage_apps`, `permission_settings.manage_webhooks`, `permission_settings.reply_messages` (Warning: mutually exclusive with all other non-permission settings field paths). `permission_settings` is not supported with admin access.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -1241,7 +1241,7 @@ } } }, - "revision": "20240625", + "revision": "20240709", "rootUrl": "https://chat.googleapis.com/", "schemas": { "AccessSettings": { @@ -1257,14 +1257,14 @@ ], "enumDescriptions": [ "Access state is unknown or not supported in this API.", - "Space is discoverable by added or invited members or groups.", - "Space is discoverable by the selected [target audience](https://support.google.com/a/answer/9934697), as well as added or invited members or groups." + "Only users or Google Groups that have been individually added or invited by other users or Google Workspace administrators can discover and access the space.", + "A space manager has granted a target audience access to the space. Users or Google Groups that have been individually added or invited to the space can also discover and access the space. To learn more, see [Make a space discoverable to specific users](https://developers.google.com/workspace/chat/space-target-audience)." ], "readOnly": true, "type": "string" }, "audience": { - "description": "Optional. The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover the space, join the space, and preview the messages in the space. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`.", + "description": "Optional. The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover the space, join the space, and preview the messages in the space. If unset, only users or Google Groups who have been individually invited or added to the space can access it. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`.", "type": "string" } }, @@ -1850,7 +1850,7 @@ "type": "object" }, "DeprecatedEvent": { - "description": "A Google Chat app interaction event. To learn about interaction events, see [Receive and respond to interactions with your Google Chat app](https://developers.google.com/workspace/chat/api/guides/message-formats). To learn about event types and for example event payloads, see [Types of Google Chat app interaction events](https://developers.google.com/workspace/chat/events). In addition to receiving events from user interactions, Chat apps can receive events about changes to spaces, such as when a new member is added to a space. To learn about space events, see [Work with events from Google Chat](https://developers.google.com/workspace/chat/events-overview).", + "description": "A Google Chat app interaction event that represents and contains data about a user's interaction with a Chat app. To configure your Chat app to receive interaction events, see [Receive and respond to user interactions](https://developers.google.com/workspace/chat/receive-respond-interactions). In addition to receiving events from user interactions, Chat apps can receive events about changes to spaces, such as when a new member is added to a space. To learn about space events, see [Work with events from Google Chat](https://developers.google.com/workspace/chat/events-overview).", "id": "DeprecatedEvent", "properties": { "action": { @@ -1859,7 +1859,7 @@ }, "common": { "$ref": "CommonEventObject", - "description": "Represents informatmessage_visibilityion about the user's client, such as locale, host app, and platform. For Chat apps, `CommonEventObject` includes information submitted by users interacting with [dialogs](https://developers.google.com/workspace/chat/dialogs), like data entered on a card." + "description": "Represents information about the user's client, such as locale, host app, and platform. For Chat apps, `CommonEventObject` includes information submitted by users interacting with [dialogs](https://developers.google.com/workspace/chat/dialogs), like data entered on a card." }, "configCompleteRedirectUrl": { "description": "The URL the Chat app should redirect the user to after they have completed an authorization or configuration flow outside of Google Chat. For more information, see [Connect a Chat app with other services & tools](https://developers.google.com/workspace/chat/connect-web-services-tools).", @@ -1896,7 +1896,7 @@ }, "space": { "$ref": "Space", - "description": "The space in which the interaction event occurred." + "description": "The space in which the user interacted with the Chat app." }, "threadKey": { "description": "The Chat app-defined key for the thread related to the interaction event. See [`spaces.messages.thread.threadKey`](/chat/api/reference/rest/v1/spaces.messages#Thread.FIELDS.thread_key) for more information.", @@ -1907,7 +1907,7 @@ "type": "string" }, "type": { - "description": "The type of interaction event. For details, see [Types of Google Chat app interaction events](https://developers.google.com/workspace/chat/events).", + "description": "The [type](/workspace/chat/api/reference/rest/v1/EventType) of user interaction with the Chat app, such as `MESSAGE` or `ADDED_TO_SPACE`.", "enum": [ "UNSPECIFIED", "MESSAGE", @@ -1918,17 +1918,17 @@ ], "enumDescriptions": [ "Default value for the enum. DO NOT USE.", - "A user sends the Chat app a message, or invokes the Chat app in a space.", - "A user adds the Chat app to a space, or a Google Workspace administrator installs the Chat app in direct message spaces for users in their organization.", - "A user removes the Chat app from a space.", - "A user clicks an interactive element of a card or dialog from a Chat app, such as a button. If a user interacts with a dialog, the `CARD_CLICKED` interaction event's `isDialogEvent` field is set to `true` and includes a [`DialogEventType`](https://developers.google.com/workspace/chat/api/reference/rest/v1/DialogEventType).", + "A user sends the Chat app a message, or invokes the Chat app in a space, such as any of the following examples: * Any message in a direct message (DM) space with the Chat app. * A message in a multi-person space where a person @mentions the Chat app, or uses one of its slash commands. * If you've configured link previews for your Chat app, a user posts a message that contains a link that matches the configured URL pattern.", + "A user adds the Chat app to a space, or a Google Workspace administrator installs the Chat app in direct message spaces for users in their organization. Chat apps typically respond to this interaction event by posting a welcome message in the space. When administrators install Chat apps, the `space.adminInstalled` field is set to `true` and users can't uninstall them. To learn about Chat apps installed by administrators, see Google Workspace Admin Help's documentation, [Install Marketplace apps in your domain](https://support.google.com/a/answer/172482).", + "A user removes the Chat app from a space, or a Google Workspace administrator uninstalls the Chat app for a user in their organization. Chat apps can't respond with messages to this event, because they have already been removed. When administrators uninstall Chat apps, the `space.adminInstalled` field is set to `false`. If a user installed the Chat app before the administrator, the Chat app remains installed for the user and the Chat app doesn't receive a `REMOVED_FROM_SPACE` interaction event.", + "A user clicks an interactive element of a card or dialog from a Chat app, such as a button. To receive an interaction event, the button must trigger another interaction with the Chat app. For example, a Chat app doesn't receive a `CARD_CLICKED` interaction event if a user clicks a button that opens a link to a website, but receives interaction events in the following examples: * The user clicks a `Send feedback` button on a card, which opens a dialog for the user to input information. * The user clicks a `Submit` button after inputting information into a card or dialog. If a user clicks a button to open, submit, or cancel a dialog, the `CARD_CLICKED` interaction event's `isDialogEvent` field is set to `true` and includes a [`DialogEventType`](https://developers.google.com/workspace/chat/api/reference/rest/v1/DialogEventType).", "A user updates a widget in a card message or dialog." ], "type": "string" }, "user": { "$ref": "User", - "description": "The user that triggered the interaction event." + "description": "The user that interacted with the Chat app." } }, "type": "object" @@ -4098,7 +4098,7 @@ "type": "string" }, "externalUserAllowed": { - "description": "Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. * The space is used to [import data to Google Chat] (https://developers.google.com/chat/api/guides/import-data-overview) because import mode spaces must only permit members from the same Google Workspace organization. However, as part of the [Google Workspace Developer Preview Program](https://developers.google.com/workspace/preview), import mode spaces can permit any Google Chat user so this field can then be set for import mode spaces. For existing spaces, this field is output only.", + "description": "Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. For existing spaces, this field is output only.", "type": "boolean" }, "importMode": { diff --git a/discovery/chromemanagement-v1.json b/discovery/chromemanagement-v1.json index 91180ad8d2..eb0d740a94 100644 --- a/discovery/chromemanagement-v1.json +++ b/discovery/chromemanagement-v1.json @@ -591,12 +591,12 @@ "type": "string" }, "filter": { - "description": "Query string to filter results, AND-separated fields in EBNF syntax. Note: OR operations are not supported in this filter. Supported filter fields: * app_name * app_type * install_type * number_of_permissions * total_install_count * latest_profile_active_date * permission_name * app_id", + "description": "Query string to filter results, AND-separated fields in EBNF syntax. Note: OR operations are not supported in this filter. Supported filter fields: * app_name * app_type * install_type * number_of_permissions * total_install_count * latest_profile_active_date * permission_name * app_id * manifest_versions", "location": "query", "type": "string" }, "orderBy": { - "description": "Field used to order results. Supported order by fields: * app_name * app_type * install_type * number_of_permissions * total_install_count * app_id", + "description": "Field used to order results. Supported order by fields: * app_name * app_type * install_type * number_of_permissions * total_install_count * app_id * manifest_versions", "location": "query", "type": "string" }, @@ -976,7 +976,7 @@ "type": "string" }, "readMask": { - "description": "Required. Read mask to specify which fields to return. Although currently required, this field will become optional, while the filter parameter with an event type will be come required. Supported read_mask paths are: - device - user - audio_severe_underrun_event - usb_peripherals_event - https_latency_change_event - network_state_change_event - wifi_signal_strength_event - vpn_connection_state_change_event - app_install_event - app_uninstall_event - app_launch_event ", + "description": "Required. Read mask to specify which fields to return. Although currently required, this field will become optional, while the filter parameter with an event type will be come required. Supported read_mask paths are: - device - user - audio_severe_underrun_event - usb_peripherals_event - https_latency_change_event - network_state_change_event - wifi_signal_strength_event - vpn_connection_state_change_event - app_install_event - app_uninstall_event - app_launch_event - os_crash_event ", "format": "google-fieldmask", "location": "query", "type": "string" @@ -1172,7 +1172,7 @@ } } }, - "revision": "20240627", + "revision": "20240715", "rootUrl": "https://chromemanagement.googleapis.com/", "schemas": { "GoogleChromeManagementV1AndroidAppInfo": { @@ -4112,7 +4112,8 @@ "VPN_CONNECTION_STATE_CHANGE", "APP_INSTALLED", "APP_UNINSTALLED", - "APP_LAUNCHED" + "APP_LAUNCHED", + "OS_CRASH" ], "enumDescriptions": [ "Event type unknown.", @@ -4126,7 +4127,8 @@ "Triggered on changes to VPN connections.", "Triggered when an app is installed.", "Triggered when an app is uninstalled.", - "Triggered when an app is launched." + "Triggered when an app is launched.", + "Triggered when a crash occurs." ], "type": "string" }, @@ -4192,7 +4194,8 @@ "VPN_CONNECTION_STATE_CHANGE", "APP_INSTALLED", "APP_UNINSTALLED", - "APP_LAUNCHED" + "APP_LAUNCHED", + "OS_CRASH" ], "enumDescriptions": [ "Event type unknown.", @@ -4206,7 +4209,8 @@ "Triggered on changes to VPN connections.", "Triggered when an app is installed.", "Triggered when an app is uninstalled.", - "Triggered when an app is launched." + "Triggered when an app is launched.", + "Triggered when a crash occurs." ], "type": "string" }, diff --git a/discovery/classroom-v1.json b/discovery/classroom-v1.json index 01a8f53f00..11cdbe40fb 100644 --- a/discovery/classroom-v1.json +++ b/discovery/classroom-v1.json @@ -564,7 +564,7 @@ "type": "string" }, "attachmentId": { - "description": "Optional. The identifier of the attachment. This field is required for student users and optional for teacher users. If not provided in the student case, an error is returned.", + "description": "Optional. The identifier of the attachment. This field is required for all requests except when the user is in the [Attachment Discovery iframe](https://developers.google.com/classroom/add-ons/get-started/iframes/attachment-discovery-iframe).", "location": "query", "type": "string" }, @@ -1061,7 +1061,7 @@ "type": "string" }, "attachmentId": { - "description": "Optional. The identifier of the attachment. This field is required for student users and optional for teacher users. If not provided in the student case, an error is returned.", + "description": "Optional. The identifier of the attachment. This field is required for all requests except when the user is in the [Attachment Discovery iframe](https://developers.google.com/classroom/add-ons/get-started/iframes/attachment-discovery-iframe).", "location": "query", "type": "string" }, @@ -1185,7 +1185,7 @@ ] }, "patch": { - "description": "Updates one or more fields of a course work. See google.classroom.v1.CourseWork for details of which fields may be updated and who may change them. This request must be made by the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding course work item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting developer project did not create the corresponding course work, if the user is not permitted to make the requested modification to the student submission, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `FAILED_PRECONDITION` if the requested course work has already been deleted. * `NOT_FOUND` if the requested course, course work, or student submission does not exist.", + "description": "Updates one or more fields of a course work. See google.classroom.v1.CourseWork for details of which fields may be updated and who may change them. This request must be made by the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding course work item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting developer project did not create the corresponding course work, if the user is not permitted to make the requested modification to the student submission, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `FAILED_PRECONDITION` if the requested course work has already been deleted. * `NOT_FOUND` if the requested course or course work does not exist.", "flatPath": "v1/courses/{courseId}/courseWork/{id}", "httpMethod": "PATCH", "id": "classroom.courses.courseWork.patch", @@ -1207,7 +1207,7 @@ "type": "string" }, "updateMask": { - "description": "Mask that identifies which fields on the course work to update. This field is required to do an update. The update fails if invalid fields are specified. If a field supports empty values, it can be cleared by specifying it in the update mask and not in the `CourseWork` object. If a field that does not support empty values is included in the update mask and not set in the `CourseWork` object, an `INVALID_ARGUMENT` error is returned. The following fields may be specified by teachers: * `title` * `description` * `state` * `due_date` * `due_time` * `max_points` * `scheduled_time` * `submission_modification_mode` * `topic_id`", + "description": "Mask that identifies which fields on the course work to update. This field is required to do an update. The update fails if invalid fields are specified. If a field supports empty values, it can be cleared by specifying it in the update mask and not in the `CourseWork` object. If a field that does not support empty values is included in the update mask and not set in the `CourseWork` object, an `INVALID_ARGUMENT` error is returned. The following fields may be specified by teachers: * `title` * `description` * `state` * `due_date` * `due_time` * `max_points` * `scheduled_time` * `submission_modification_mode` * `topic_id` * `grading_period_id` Available in [V1_20240401_PREVIEW](https://developers.google.com/classroom/reference/preview) and later.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -2021,7 +2021,7 @@ "type": "string" }, "attachmentId": { - "description": "Optional. The identifier of the attachment. This field is required for student users and optional for teacher users. If not provided in the student case, an error is returned.", + "description": "Optional. The identifier of the attachment. This field is required for all requests except when the user is in the [Attachment Discovery iframe](https://developers.google.com/classroom/add-ons/get-started/iframes/attachment-discovery-iframe).", "location": "query", "type": "string" }, @@ -2402,7 +2402,7 @@ "type": "string" }, "attachmentId": { - "description": "Optional. The identifier of the attachment. This field is required for student users and optional for teacher users. If not provided in the student case, an error is returned.", + "description": "Optional. The identifier of the attachment. This field is required for all requests except when the user is in the [Attachment Discovery iframe](https://developers.google.com/classroom/add-ons/get-started/iframes/attachment-discovery-iframe).", "location": "query", "type": "string" }, @@ -3695,7 +3695,7 @@ } } }, - "revision": "20240617", + "revision": "20240713", "rootUrl": "https://classroom.googleapis.com/", "schemas": { "AddOnAttachment": { diff --git a/discovery/cloudasset-v1.json b/discovery/cloudasset-v1.json index 1ffd559ccb..dd942adce6 100644 --- a/discovery/cloudasset-v1.json +++ b/discovery/cloudasset-v1.json @@ -1095,7 +1095,7 @@ } } }, - "revision": "20240621", + "revision": "20240705", "rootUrl": "https://cloudasset.googleapis.com/", "schemas": { "AccessSelector": { @@ -2600,6 +2600,7 @@ "properties": { "etag": { "description": "Output only. An opaque identifier for the current version of the `AccessPolicy`. This will always be a strongly validated etag, meaning that two Access Policies will be identical if and only if their etags are identical. Clients should not expect this to be in any specific format.", + "readOnly": true, "type": "string" }, "name": { @@ -2835,7 +2836,7 @@ "type": "string" }, "sources": { - "description": "Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`.", + "description": "Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out.", "items": { "$ref": "GoogleIdentityAccesscontextmanagerV1EgressSource" }, @@ -2864,7 +2865,7 @@ "id": "GoogleIdentityAccesscontextmanagerV1EgressSource", "properties": { "accessLevel": { - "description": "An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed.", + "description": "An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out.", "type": "string" } }, @@ -3151,7 +3152,7 @@ "properties": { "vpcSubnetwork": { "$ref": "GoogleIdentityAccesscontextmanagerV1VpcSubNetwork", - "description": "Sub-segment ranges of a VPC network." + "description": "Sub-segment ranges of a VPC network. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out." } }, "type": "object" diff --git a/discovery/cloudasset-v1beta1.json b/discovery/cloudasset-v1beta1.json index 609d4985c2..193ecdb907 100644 --- a/discovery/cloudasset-v1beta1.json +++ b/discovery/cloudasset-v1beta1.json @@ -411,7 +411,7 @@ } } }, - "revision": "20240621", + "revision": "20240705", "rootUrl": "https://cloudasset.googleapis.com/", "schemas": { "AnalyzeIamPolicyLongrunningMetadata": { @@ -925,6 +925,7 @@ "properties": { "etag": { "description": "Output only. An opaque identifier for the current version of the `AccessPolicy`. This will always be a strongly validated etag, meaning that two Access Policies will be identical if and only if their etags are identical. Clients should not expect this to be in any specific format.", + "readOnly": true, "type": "string" }, "name": { @@ -1160,7 +1161,7 @@ "type": "string" }, "sources": { - "description": "Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`.", + "description": "Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out.", "items": { "$ref": "GoogleIdentityAccesscontextmanagerV1EgressSource" }, @@ -1189,7 +1190,7 @@ "id": "GoogleIdentityAccesscontextmanagerV1EgressSource", "properties": { "accessLevel": { - "description": "An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed.", + "description": "An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out.", "type": "string" } }, @@ -1476,7 +1477,7 @@ "properties": { "vpcSubnetwork": { "$ref": "GoogleIdentityAccesscontextmanagerV1VpcSubNetwork", - "description": "Sub-segment ranges of a VPC network." + "description": "Sub-segment ranges of a VPC network. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out." } }, "type": "object" diff --git a/discovery/cloudasset-v1p1beta1.json b/discovery/cloudasset-v1p1beta1.json index 07f522691b..8c165bdb56 100644 --- a/discovery/cloudasset-v1p1beta1.json +++ b/discovery/cloudasset-v1p1beta1.json @@ -207,7 +207,7 @@ } } }, - "revision": "20240621", + "revision": "20240705", "rootUrl": "https://cloudasset.googleapis.com/", "schemas": { "AnalyzeIamPolicyLongrunningMetadata": { @@ -627,6 +627,7 @@ "properties": { "etag": { "description": "Output only. An opaque identifier for the current version of the `AccessPolicy`. This will always be a strongly validated etag, meaning that two Access Policies will be identical if and only if their etags are identical. Clients should not expect this to be in any specific format.", + "readOnly": true, "type": "string" }, "name": { @@ -862,7 +863,7 @@ "type": "string" }, "sources": { - "description": "Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`.", + "description": "Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out.", "items": { "$ref": "GoogleIdentityAccesscontextmanagerV1EgressSource" }, @@ -891,7 +892,7 @@ "id": "GoogleIdentityAccesscontextmanagerV1EgressSource", "properties": { "accessLevel": { - "description": "An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed.", + "description": "An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out.", "type": "string" } }, @@ -1178,7 +1179,7 @@ "properties": { "vpcSubnetwork": { "$ref": "GoogleIdentityAccesscontextmanagerV1VpcSubNetwork", - "description": "Sub-segment ranges of a VPC network." + "description": "Sub-segment ranges of a VPC network. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out." } }, "type": "object" diff --git a/discovery/cloudasset-v1p5beta1.json b/discovery/cloudasset-v1p5beta1.json index 5e4e5375bc..9200e12ff1 100644 --- a/discovery/cloudasset-v1p5beta1.json +++ b/discovery/cloudasset-v1p5beta1.json @@ -177,7 +177,7 @@ } } }, - "revision": "20240621", + "revision": "20240705", "rootUrl": "https://cloudasset.googleapis.com/", "schemas": { "AnalyzeIamPolicyLongrunningMetadata": { @@ -632,6 +632,7 @@ "properties": { "etag": { "description": "Output only. An opaque identifier for the current version of the `AccessPolicy`. This will always be a strongly validated etag, meaning that two Access Policies will be identical if and only if their etags are identical. Clients should not expect this to be in any specific format.", + "readOnly": true, "type": "string" }, "name": { @@ -867,7 +868,7 @@ "type": "string" }, "sources": { - "description": "Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`.", + "description": "Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out.", "items": { "$ref": "GoogleIdentityAccesscontextmanagerV1EgressSource" }, @@ -896,7 +897,7 @@ "id": "GoogleIdentityAccesscontextmanagerV1EgressSource", "properties": { "accessLevel": { - "description": "An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed.", + "description": "An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out.", "type": "string" } }, @@ -1183,7 +1184,7 @@ "properties": { "vpcSubnetwork": { "$ref": "GoogleIdentityAccesscontextmanagerV1VpcSubNetwork", - "description": "Sub-segment ranges of a VPC network." + "description": "Sub-segment ranges of a VPC network. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out." } }, "type": "object" diff --git a/discovery/cloudasset-v1p7beta1.json b/discovery/cloudasset-v1p7beta1.json index 991c938874..38d0d19eaf 100644 --- a/discovery/cloudasset-v1p7beta1.json +++ b/discovery/cloudasset-v1p7beta1.json @@ -167,7 +167,7 @@ } } }, - "revision": "20240621", + "revision": "20240705", "rootUrl": "https://cloudasset.googleapis.com/", "schemas": { "AnalyzeIamPolicyLongrunningMetadata": { @@ -701,6 +701,7 @@ "properties": { "etag": { "description": "Output only. An opaque identifier for the current version of the `AccessPolicy`. This will always be a strongly validated etag, meaning that two Access Policies will be identical if and only if their etags are identical. Clients should not expect this to be in any specific format.", + "readOnly": true, "type": "string" }, "name": { @@ -936,7 +937,7 @@ "type": "string" }, "sources": { - "description": "Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`.", + "description": "Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out.", "items": { "$ref": "GoogleIdentityAccesscontextmanagerV1EgressSource" }, @@ -965,7 +966,7 @@ "id": "GoogleIdentityAccesscontextmanagerV1EgressSource", "properties": { "accessLevel": { - "description": "An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed.", + "description": "An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out.", "type": "string" } }, @@ -1252,7 +1253,7 @@ "properties": { "vpcSubnetwork": { "$ref": "GoogleIdentityAccesscontextmanagerV1VpcSubNetwork", - "description": "Sub-segment ranges of a VPC network." + "description": "Sub-segment ranges of a VPC network. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out." } }, "type": "object" diff --git a/discovery/cloudbuild-v1.json b/discovery/cloudbuild-v1.json index 6f536ac4fa..6b7c178a45 100644 --- a/discovery/cloudbuild-v1.json +++ b/discovery/cloudbuild-v1.json @@ -2346,7 +2346,7 @@ } } }, - "revision": "20240627", + "revision": "20240704", "rootUrl": "https://cloudbuild.googleapis.com/", "schemas": { "ApprovalConfig": { @@ -4295,7 +4295,7 @@ "id": "HttpConfig", "properties": { "proxySecretVersionName": { - "description": "SecretVersion resource of the HTTP proxy URL. The Service Account should have accessor permissions on this secret. The proxy URL should be in format protocol://@]proxyhost[:port].", + "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" } }, diff --git a/discovery/cloudbuild-v2.json b/discovery/cloudbuild-v2.json index 445b48c007..a60d2e5cd9 100644 --- a/discovery/cloudbuild-v2.json +++ b/discovery/cloudbuild-v2.json @@ -844,7 +844,7 @@ } } }, - "revision": "20240618", + "revision": "20240704", "rootUrl": "https://cloudbuild.googleapis.com/", "schemas": { "AuditConfig": { @@ -1806,12 +1806,14 @@ "enum": [ "TYPE_UNSPECIFIED", "STRING", - "ARRAY" + "ARRAY", + "OBJECT" ], "enumDescriptions": [ "Default enum type; should not be used.", "Default", - "Arrary type." + "Array type.", + "Object type." ], "type": "string" } @@ -1829,6 +1831,13 @@ }, "type": "array" }, + "objectVal": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. Value of the parameter if type is object.", + "type": "object" + }, "stringVal": { "description": "Value of the parameter if type is string.", "type": "string" @@ -1838,12 +1847,14 @@ "enum": [ "TYPE_UNSPECIFIED", "STRING", - "ARRAY" + "ARRAY", + "OBJECT" ], "enumDescriptions": [ "Default enum type; should not be used.", "Default", - "Array type" + "Array type", + "Object type" ], "type": "string" } diff --git a/discovery/clouderrorreporting-v1beta1.json b/discovery/clouderrorreporting-v1beta1.json index 105d7f28ce..5fc2cc2e74 100644 --- a/discovery/clouderrorreporting-v1beta1.json +++ b/discovery/clouderrorreporting-v1beta1.json @@ -117,7 +117,7 @@ ], "parameters": { "projectName": { - "description": "Required. The resource name of the Google Cloud Platform project. Written as `projects/{projectID}`, where `{projectID}` is the [Google Cloud Platform project ID](https://support.google.com/cloud/answer/6158840). Example: `projects/my-project-123`.", + "description": "Required. The resource name of the Google Cloud Platform project. Written as `projects/{projectID}` or `projects/{projectID}/locations/{location}`, where `{projectID}` is the [Google Cloud Platform project ID](https://support.google.com/cloud/answer/6158840) and `{location}` is a Cloud region. Examples: `projects/my-project-123`, `projects/my-project-123/locations/global`. For a list of supported locations, see [Supported Regions](https://cloud.google.com/logging/docs/region-support). `global` is the default when unspecified.", "location": "path", "pattern": "^projects/[^/]+$", "required": true, @@ -162,7 +162,7 @@ "type": "string" }, "projectName": { - "description": "Required. The resource name of the Google Cloud Platform project. Written as `projects/{projectID}`, where `{projectID}` is the [Google Cloud Platform project ID](https://support.google.com/cloud/answer/6158840). Example: `projects/my-project-123`.", + "description": "Required. The resource name of the Google Cloud Platform project. Written as `projects/{projectID}` or `projects/{projectID}/locations/{location}`, where `{projectID}` is the [Google Cloud Platform project ID](https://support.google.com/cloud/answer/6158840) and `{location}` is a Cloud region. Examples: `projects/my-project-123`, `projects/my-project-123/locations/global`. For a list of supported locations, see [Supported Regions](https://cloud.google.com/logging/docs/region-support). `global` is the default when unspecified.", "location": "path", "pattern": "^projects/[^/]+$", "required": true, @@ -214,7 +214,7 @@ ] }, "report": { - "description": "Report an individual error event and record the event to a log. This endpoint accepts **either** an OAuth token, **or** an [API key](https://support.google.com/cloud/answer/6158862) for authentication. To use an API key, append it to the URL as the value of a `key` parameter. For example: `POST https://clouderrorreporting.googleapis.com/v1beta1/{projectName}/events:report?key=123ABC456` **Note:** [Error Reporting] (https://cloud.google.com/error-reporting) is a global service built on Cloud Logging and can analyze log entries when all of the following are true: * The log entries are stored in a log bucket in the `global` location. * Customer-managed encryption keys (CMEK) are disabled on the log bucket. * The log bucket satisfies one of the following: * The log bucket is stored in the same project where the logs originated. * The logs were routed to a project, and then that project stored those logs in a log bucket that it owns.", + "description": "Report an individual error event and record the event to a log. This endpoint accepts **either** an OAuth token, **or** an [API key](https://support.google.com/cloud/answer/6158862) for authentication. To use an API key, append it to the URL as the value of a `key` parameter. For example: `POST https://clouderrorreporting.googleapis.com/v1beta1/{projectName}/events:report?key=123ABC456` **Note:** [Error Reporting] (https://cloud.google.com/error-reporting) is a service built on Cloud Logging and can analyze log entries when all of the following are true: * Customer-managed encryption keys (CMEK) are disabled on the log bucket. * The log bucket satisfies one of the following: * The log bucket is stored in the same project where the logs originated. * The logs were routed to a project, and then that project stored those logs in a log bucket that it owns.", "flatPath": "v1beta1/projects/{projectsId}/events:report", "httpMethod": "POST", "id": "clouderrorreporting.projects.events.report", @@ -312,7 +312,7 @@ "type": "string" }, "projectName": { - "description": "Required. The resource name of the Google Cloud Platform project. Written as `projects/{projectID}` or `projects/{projectNumber}`, where `{projectID}` and `{projectNumber}` can be found in the [Google Cloud console](https://support.google.com/cloud/answer/6158840). Examples: `projects/my-project-123`, `projects/5551234`.", + "description": "Required. The resource name of the Google Cloud Platform project. Written as `projects/{projectID}` or `projects/{projectNumber}`, where `{projectID}` and `{projectNumber}` can be found in the [Google Cloud console](https://support.google.com/cloud/answer/6158840). It may also include a location, such as `projects/{projectID}/locations/{location}` where `{location}` is a cloud region. Examples: `projects/my-project-123`, `projects/5551234`, `projects/my-project-123/locations/us-central1`, `projects/5551234/locations/us-central1`. For a list of supported locations, see [Supported Regions](https://cloud.google.com/logging/docs/region-support). `global` is the default when unspecified. Use `-` as a wildcard to request group stats from all regions.", "location": "path", "pattern": "^projects/[^/]+$", "required": true, @@ -383,7 +383,7 @@ ], "parameters": { "groupName": { - "description": "Required. The group resource name. Written as `projects/{projectID}/groups/{group_id}`. Call groupStats.list to return a list of groups belonging to this project. Example: `projects/my-project-123/groups/my-group` In the group resource name, the `group_id` is a unique identifier for a particular error group. The identifier is derived from key parts of the error-log content and is treated as Service Data. For information about how Service Data is handled, see [Google Cloud Privacy Notice](https://cloud.google.com/terms/cloud-privacy-notice).", + "description": "Required. The group resource name. Written as either `projects/{projectID}/groups/{group_id}` or `projects/{projectID}/locations/{location}/groups/{group_id}`. Call groupStats.list to return a list of groups belonging to this project. Examples: `projects/my-project-123/groups/my-group`, `projects/my-project-123/locations/global/groups/my-group` In the group resource name, the `group_id` is a unique identifier for a particular error group. The identifier is derived from key parts of the error-log content and is treated as Service Data. For information about how Service Data is handled, see [Google Cloud Privacy Notice](https://cloud.google.com/terms/cloud-privacy-notice). For a list of supported locations, see [Supported Regions](https://cloud.google.com/logging/docs/region-support). `global` is the default when unspecified.", "location": "path", "pattern": "^projects/[^/]+/groups/[^/]+$", "required": true, @@ -408,7 +408,7 @@ ], "parameters": { "name": { - "description": "The group resource name. Written as `projects/{projectID}/groups/{group_id}`. Example: `projects/my-project-123/groups/my-group` In the group resource name, the `group_id` is a unique identifier for a particular error group. The identifier is derived from key parts of the error-log content and is treated as Service Data. For information about how Service Data is handled, see [Google Cloud Privacy Notice](https://cloud.google.com/terms/cloud-privacy-notice).", + "description": "The group resource name. Written as `projects/{projectID}/groups/{group_id}` or `projects/{projectID}/locations/{location}/groups/{group_id}` Examples: `projects/my-project-123/groups/my-group`, `projects/my-project-123/locations/us-central1/groups/my-group` In the group resource name, the `group_id` is a unique identifier for a particular error group. The identifier is derived from key parts of the error-log content and is treated as Service Data. For information about how Service Data is handled, see [Google Cloud Privacy Notice](https://cloud.google.com/terms/cloud-privacy-notice). For a list of supported locations, see [Supported Regions](https://cloud.google.com/logging/docs/region-support). `global` is the default when unspecified.", "location": "path", "pattern": "^projects/[^/]+/groups/[^/]+$", "required": true, @@ -427,11 +427,308 @@ ] } } + }, + "locations": { + "methods": { + "deleteEvents": { + "description": "Deletes all error events of a given project.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/events", + "httpMethod": "DELETE", + "id": "clouderrorreporting.projects.locations.deleteEvents", + "parameterOrder": [ + "projectName" + ], + "parameters": { + "projectName": { + "description": "Required. The resource name of the Google Cloud Platform project. Written as `projects/{projectID}` or `projects/{projectID}/locations/{location}`, where `{projectID}` is the [Google Cloud Platform project ID](https://support.google.com/cloud/answer/6158840) and `{location}` is a Cloud region. Examples: `projects/my-project-123`, `projects/my-project-123/locations/global`. For a list of supported locations, see [Supported Regions](https://cloud.google.com/logging/docs/region-support). `global` is the default when unspecified.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+projectName}/events", + "response": { + "$ref": "DeleteEventsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "events": { + "methods": { + "list": { + "description": "Lists the specified events.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/events", + "httpMethod": "GET", + "id": "clouderrorreporting.projects.locations.events.list", + "parameterOrder": [ + "projectName" + ], + "parameters": { + "groupId": { + "description": "Required. The group for which events shall be returned. The `group_id` is a unique identifier for a particular error group. The identifier is derived from key parts of the error-log content and is treated as Service Data. For information about how Service Data is handled, see [Google Cloud Privacy Notice](https://cloud.google.com/terms/cloud-privacy-notice).", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. The maximum number of results to return per response.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. A `next_page_token` provided by a previous response.", + "location": "query", + "type": "string" + }, + "projectName": { + "description": "Required. The resource name of the Google Cloud Platform project. Written as `projects/{projectID}` or `projects/{projectID}/locations/{location}`, where `{projectID}` is the [Google Cloud Platform project ID](https://support.google.com/cloud/answer/6158840) and `{location}` is a Cloud region. Examples: `projects/my-project-123`, `projects/my-project-123/locations/global`. For a list of supported locations, see [Supported Regions](https://cloud.google.com/logging/docs/region-support). `global` is the default when unspecified.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + }, + "serviceFilter.resourceType": { + "description": "Optional. The exact value to match against [`ServiceContext.resource_type`](/error-reporting/reference/rest/v1beta1/ServiceContext#FIELDS.resource_type).", + "location": "query", + "type": "string" + }, + "serviceFilter.service": { + "description": "Optional. The exact value to match against [`ServiceContext.service`](/error-reporting/reference/rest/v1beta1/ServiceContext#FIELDS.service).", + "location": "query", + "type": "string" + }, + "serviceFilter.version": { + "description": "Optional. The exact value to match against [`ServiceContext.version`](/error-reporting/reference/rest/v1beta1/ServiceContext#FIELDS.version).", + "location": "query", + "type": "string" + }, + "timeRange.period": { + "description": "Restricts the query to the specified time range.", + "enum": [ + "PERIOD_UNSPECIFIED", + "PERIOD_1_HOUR", + "PERIOD_6_HOURS", + "PERIOD_1_DAY", + "PERIOD_1_WEEK", + "PERIOD_30_DAYS" + ], + "enumDescriptions": [ + "Do not use.", + "Retrieve data for the last hour. Recommended minimum timed count duration: 1 min.", + "Retrieve data for the last 6 hours. Recommended minimum timed count duration: 10 min.", + "Retrieve data for the last day. Recommended minimum timed count duration: 1 hour.", + "Retrieve data for the last week. Recommended minimum timed count duration: 6 hours.", + "Retrieve data for the last 30 days. Recommended minimum timed count duration: 1 day." + ], + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+projectName}/events", + "response": { + "$ref": "ListEventsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "groupStats": { + "methods": { + "list": { + "description": "Lists the specified groups.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/groupStats", + "httpMethod": "GET", + "id": "clouderrorreporting.projects.locations.groupStats.list", + "parameterOrder": [ + "projectName" + ], + "parameters": { + "alignment": { + "description": "Optional. The alignment of the timed counts to be returned. Default is `ALIGNMENT_EQUAL_AT_END`.", + "enum": [ + "ERROR_COUNT_ALIGNMENT_UNSPECIFIED", + "ALIGNMENT_EQUAL_ROUNDED", + "ALIGNMENT_EQUAL_AT_END" + ], + "enumDescriptions": [ + "No alignment specified.", + "The time periods shall be consecutive, have width equal to the requested duration, and be aligned at the alignment_time provided in the request. The alignment_time does not have to be inside the query period but even if it is outside, only time periods are returned which overlap with the query period. A rounded alignment will typically result in a different size of the first or the last time period.", + "The time periods shall be consecutive, have width equal to the requested duration, and be aligned at the end of the requested time period. This can result in a different size of the first time period." + ], + "location": "query", + "type": "string" + }, + "alignmentTime": { + "description": "Optional. Time where the timed counts shall be aligned if rounded alignment is chosen. Default is 00:00 UTC.", + "format": "google-datetime", + "location": "query", + "type": "string" + }, + "groupId": { + "description": "Optional. List all ErrorGroupStats with these IDs. The `group_id` is a unique identifier for a particular error group. The identifier is derived from key parts of the error-log content and is treated as Service Data. For information about how Service Data is handled, see [Google Cloud Privacy Notice] (https://cloud.google.com/terms/cloud-privacy-notice).", + "location": "query", + "repeated": true, + "type": "string" + }, + "order": { + "description": "Optional. The sort order in which the results are returned. Default is `COUNT_DESC`.", + "enum": [ + "GROUP_ORDER_UNSPECIFIED", + "COUNT_DESC", + "LAST_SEEN_DESC", + "CREATED_DESC", + "AFFECTED_USERS_DESC" + ], + "enumDescriptions": [ + "No group order specified.", + "Total count of errors in the given time window in descending order.", + "Timestamp when the group was last seen in the given time window in descending order.", + "Timestamp when the group was created in descending order.", + "Number of affected users in the given time window in descending order." + ], + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. The maximum number of results to return per response. Default is 20.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. A next_page_token provided by a previous response. To view additional results, pass this token along with the identical query parameters as the first request.", + "location": "query", + "type": "string" + }, + "projectName": { + "description": "Required. The resource name of the Google Cloud Platform project. Written as `projects/{projectID}` or `projects/{projectNumber}`, where `{projectID}` and `{projectNumber}` can be found in the [Google Cloud console](https://support.google.com/cloud/answer/6158840). It may also include a location, such as `projects/{projectID}/locations/{location}` where `{location}` is a cloud region. Examples: `projects/my-project-123`, `projects/5551234`, `projects/my-project-123/locations/us-central1`, `projects/5551234/locations/us-central1`. For a list of supported locations, see [Supported Regions](https://cloud.google.com/logging/docs/region-support). `global` is the default when unspecified. Use `-` as a wildcard to request group stats from all regions.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + }, + "serviceFilter.resourceType": { + "description": "Optional. The exact value to match against [`ServiceContext.resource_type`](/error-reporting/reference/rest/v1beta1/ServiceContext#FIELDS.resource_type).", + "location": "query", + "type": "string" + }, + "serviceFilter.service": { + "description": "Optional. The exact value to match against [`ServiceContext.service`](/error-reporting/reference/rest/v1beta1/ServiceContext#FIELDS.service).", + "location": "query", + "type": "string" + }, + "serviceFilter.version": { + "description": "Optional. The exact value to match against [`ServiceContext.version`](/error-reporting/reference/rest/v1beta1/ServiceContext#FIELDS.version).", + "location": "query", + "type": "string" + }, + "timeRange.period": { + "description": "Restricts the query to the specified time range.", + "enum": [ + "PERIOD_UNSPECIFIED", + "PERIOD_1_HOUR", + "PERIOD_6_HOURS", + "PERIOD_1_DAY", + "PERIOD_1_WEEK", + "PERIOD_30_DAYS" + ], + "enumDescriptions": [ + "Do not use.", + "Retrieve data for the last hour. Recommended minimum timed count duration: 1 min.", + "Retrieve data for the last 6 hours. Recommended minimum timed count duration: 10 min.", + "Retrieve data for the last day. Recommended minimum timed count duration: 1 hour.", + "Retrieve data for the last week. Recommended minimum timed count duration: 6 hours.", + "Retrieve data for the last 30 days. Recommended minimum timed count duration: 1 day." + ], + "location": "query", + "type": "string" + }, + "timedCountDuration": { + "description": "Optional. The preferred duration for a single returned TimedCount. If not set, no timed counts are returned.", + "format": "google-duration", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+projectName}/groupStats", + "response": { + "$ref": "ListGroupStatsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "groups": { + "methods": { + "get": { + "description": "Get the specified group.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/groups/{groupsId}", + "httpMethod": "GET", + "id": "clouderrorreporting.projects.locations.groups.get", + "parameterOrder": [ + "groupName" + ], + "parameters": { + "groupName": { + "description": "Required. The group resource name. Written as either `projects/{projectID}/groups/{group_id}` or `projects/{projectID}/locations/{location}/groups/{group_id}`. Call groupStats.list to return a list of groups belonging to this project. Examples: `projects/my-project-123/groups/my-group`, `projects/my-project-123/locations/global/groups/my-group` In the group resource name, the `group_id` is a unique identifier for a particular error group. The identifier is derived from key parts of the error-log content and is treated as Service Data. For information about how Service Data is handled, see [Google Cloud Privacy Notice](https://cloud.google.com/terms/cloud-privacy-notice). For a list of supported locations, see [Supported Regions](https://cloud.google.com/logging/docs/region-support). `global` is the default when unspecified.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/groups/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+groupName}", + "response": { + "$ref": "ErrorGroup" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "update": { + "description": "Replace the data for the specified group. Fails if the group does not exist.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/groups/{groupsId}", + "httpMethod": "PUT", + "id": "clouderrorreporting.projects.locations.groups.update", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The group resource name. Written as `projects/{projectID}/groups/{group_id}` or `projects/{projectID}/locations/{location}/groups/{group_id}` Examples: `projects/my-project-123/groups/my-group`, `projects/my-project-123/locations/us-central1/groups/my-group` In the group resource name, the `group_id` is a unique identifier for a particular error group. The identifier is derived from key parts of the error-log content and is treated as Service Data. For information about how Service Data is handled, see [Google Cloud Privacy Notice](https://cloud.google.com/terms/cloud-privacy-notice). For a list of supported locations, see [Supported Regions](https://cloud.google.com/logging/docs/region-support). `global` is the default when unspecified.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/groups/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "request": { + "$ref": "ErrorGroup" + }, + "response": { + "$ref": "ErrorGroup" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } } } } }, - "revision": "20240426", + "revision": "20240702", "rootUrl": "https://clouderrorreporting.googleapis.com/", "schemas": { "DeleteEventsResponse": { @@ -499,7 +796,7 @@ "type": "string" }, "name": { - "description": "The group resource name. Written as `projects/{projectID}/groups/{group_id}`. Example: `projects/my-project-123/groups/my-group` In the group resource name, the `group_id` is a unique identifier for a particular error group. The identifier is derived from key parts of the error-log content and is treated as Service Data. For information about how Service Data is handled, see [Google Cloud Privacy Notice](https://cloud.google.com/terms/cloud-privacy-notice).", + "description": "The group resource name. Written as `projects/{projectID}/groups/{group_id}` or `projects/{projectID}/locations/{location}/groups/{group_id}` Examples: `projects/my-project-123/groups/my-group`, `projects/my-project-123/locations/us-central1/groups/my-group` In the group resource name, the `group_id` is a unique identifier for a particular error group. The identifier is derived from key parts of the error-log content and is treated as Service Data. For information about how Service Data is handled, see [Google Cloud Privacy Notice](https://cloud.google.com/terms/cloud-privacy-notice). For a list of supported locations, see [Supported Regions](https://cloud.google.com/logging/docs/region-support). `global` is the default when unspecified.", "type": "string" }, "resolutionStatus": { diff --git a/discovery/cloudsearch-v1.json b/discovery/cloudsearch-v1.json index 42733e7173..db937fb017 100644 --- a/discovery/cloudsearch-v1.json +++ b/discovery/cloudsearch-v1.json @@ -2115,7 +2115,7 @@ } } }, - "revision": "20240529", + "revision": "20240710", "rootUrl": "https://cloudsearch.googleapis.com/", "schemas": { "Action": { @@ -2187,6 +2187,24 @@ }, "type": "object" }, + "BandWidthRangeKbps": { + "id": "BandWidthRangeKbps", + "properties": { + "percentile10": { + "format": "int32", + "type": "integer" + }, + "percentile50": { + "format": "int32", + "type": "integer" + }, + "percentile90": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, "BooleanOperatorOptions": { "description": "Used to provide a search operator for boolean properties. This is optional. Search operators let users restrict the query to specific fields relevant to the type of item being searched.", "id": "BooleanOperatorOptions", @@ -2219,971 +2237,1764 @@ }, "type": "object" }, - "CompositeFilter": { - "id": "CompositeFilter", + "ClientOptInContext": { + "description": "Represents the user's current opt-in status on the current device related to features such as Google Now, App and Web History, Device State and Content. Each opt-in status includes an eligibility status, which depends on the type of account (Dasher, etc.), country, language, and device specifics. Next id: 38 Note: if the proto is changed, please also update the code that converts it to corresponding logs proto (they are in the same name but incompatible so manual conversion is needed). LINT.IfChange", + "id": "ClientOptInContext", "properties": { - "logicOperator": { - "description": "The logic operator of the sub filter.", + "ambientEnrollmentStatus": { + "description": "Enrollment status for Ambient Mode feature go/assistant-ambient-mode", "enum": [ - "AND", - "OR", - "NOT" + "OPA_OPT_IN_STATUS_UNKNOWN", + "OPA_OPT_IN_STATUS_DISABLED", + "OPA_OPT_IN_STATUS_ENABLED" ], "enumDescriptions": [ - "Logical operators, which can only be applied to sub filters.", - "", - "NOT can only be applied on a single sub filter." + "The user has never been prompted with this opt-in.", + "The user has rejected the opt-in.", + "The user has accepted the opt-in." ], "type": "string" }, - "subFilters": { - "description": "Sub filters.", + "ambientPhotoEnrollmentStatus": { + "description": "Enrollment status for PhotoFrame feature in Ambient Mode. This is different from PhotoFrame enrollment in other features such as Dreamliner. go/assistant-ambient-mode", + "enum": [ + "OPA_OPT_IN_STATUS_UNKNOWN", + "OPA_OPT_IN_STATUS_DISABLED", + "OPA_OPT_IN_STATUS_ENABLED" + ], + "enumDescriptions": [ + "The user has never been prompted with this opt-in.", + "The user has rejected the opt-in.", + "The user has accepted the opt-in." + ], + "type": "string" + }, + "assistantOnLockscreenStatus": { + "description": "Whether the user has opted into enabling Assistant on Lockscreen. go/iris-newperm-prd", + "enum": [ + "OPA_OPT_IN_STATUS_UNKNOWN", + "OPA_OPT_IN_STATUS_DISABLED", + "OPA_OPT_IN_STATUS_ENABLED" + ], + "enumDescriptions": [ + "The user has never been prompted with this opt-in.", + "The user has rejected the opt-in.", + "The user has accepted the opt-in." + ], + "type": "string" + }, + "audioHistoryStatus": { + "$ref": "OptInStatus", + "description": "Audio History. Used to improve speech recognition and hotword triggering. https://sites.google.com/a/google.com/android-speech/projects/audio-history" + }, + "bluetoothAudioRecordingStatus": { + "description": "Whether the user has opted into bluetooth audio recording setting.", + "enum": [ + "OPA_OPT_IN_STATUS_UNKNOWN", + "OPA_OPT_IN_STATUS_DISABLED", + "OPA_OPT_IN_STATUS_ENABLED" + ], + "enumDescriptions": [ + "The user has never been prompted with this opt-in.", + "The user has rejected the opt-in.", + "The user has accepted the opt-in." + ], + "type": "string" + }, + "chromeSyncStatus": { + "$ref": "OptInStatus", + "description": "Set to true iff the user is signed into Chrome with the same account as GSA and has Chrome sync enabled (as reported by Chrome to GSA). This can be used to serve personalized suggestions based on the user's browsing history." + }, + "deviceAppsStatus": { + "$ref": "OptInStatus", + "description": "Allows Google to upload device app information." + }, + "deviceContactsStatus": { + "$ref": "OptInStatus", + "description": "Allows Google to upload contact information from device." + }, + "deviceStateAndContentStatus": { + "$ref": "OptInStatus", + "description": "User allows Google to upload state (aka settings) and content (documents and media) from their device. See https://goto.google.com/device-consents" + }, + "disabledIcingSourceApps": { + "description": "List of Android package names the user disabled from appearing in the autocomplete suggestions on their device. ", "items": { - "$ref": "Filter" + "type": "string" + }, + "type": "array" + }, + "disabledIcingSources": { + "description": "List of Android packages and corpora that the user disabled. This replaces disabled_icing_source_apps and allows disabling a single corpus for a particular package.", + "items": { + "$ref": "DisabledIcingPackageCorpus" }, "type": "array" + }, + "headphonePersonalResultsStatus": { + "description": "Whether the user has opted into headphone personal results setting. go/enable-pr-with-headset", + "enum": [ + "OPA_OPT_IN_STATUS_UNKNOWN", + "OPA_OPT_IN_STATUS_DISABLED", + "OPA_OPT_IN_STATUS_ENABLED" + ], + "enumDescriptions": [ + "The user has never been prompted with this opt-in.", + "The user has rejected the opt-in.", + "The user has accepted the opt-in." + ], + "type": "string" + }, + "hotwordEnrollmentStatus": { + "$ref": "OptInStatus", + "description": "Enrollment status for Hotword any-screen/always-on. This information is sent to the server-side to know that the user can run Hotword. For example, in go/gsa-voice-feature-tips using this information, the user will be shown Voice Tips that will take the user directly to the enrollment and guide them to move to the next level of Voice Features experience." + }, + "locationHistoryStatus": { + "$ref": "OptInStatus", + "description": "User allows Google to upload location history from their device. See https://goto.google.com/gcore-ulr" + }, + "lockscreenPersonalResponseStatus": { + "description": "Whether the user has opted into showing personal response on Lockscreen.", + "enum": [ + "OPA_OPT_IN_STATUS_UNKNOWN", + "OPA_OPT_IN_STATUS_DISABLED", + "OPA_OPT_IN_STATUS_ENABLED" + ], + "enumDescriptions": [ + "The user has never been prompted with this opt-in.", + "The user has rejected the opt-in.", + "The user has accepted the opt-in." + ], + "type": "string" + }, + "lockscreenSearchBluetoothStatus": { + "description": "Whether the user has opted into lockscreen queries via bluetooth headsets setting.", + "enum": [ + "OPA_OPT_IN_STATUS_UNKNOWN", + "OPA_OPT_IN_STATUS_DISABLED", + "OPA_OPT_IN_STATUS_ENABLED" + ], + "enumDescriptions": [ + "The user has never been prompted with this opt-in.", + "The user has rejected the opt-in.", + "The user has accepted the opt-in." + ], + "type": "string" + }, + "lockscreenSearchWiredHeadsetStatus": { + "description": "Whether the user has opted into lockscreen queries via wired headsets setting.", + "enum": [ + "OPA_OPT_IN_STATUS_UNKNOWN", + "OPA_OPT_IN_STATUS_DISABLED", + "OPA_OPT_IN_STATUS_ENABLED" + ], + "enumDescriptions": [ + "The user has never been prompted with this opt-in.", + "The user has rejected the opt-in.", + "The user has accepted the opt-in." + ], + "type": "string" + }, + "nowNotificationStatus": { + "$ref": "OptInStatus", + "description": "Google Now push notifications." + }, + "nowStatus": { + "$ref": "OptInStatus", + "description": "Google Now activation." + }, + "nowTosVersion": { + "description": "Google Now marks each release with a TOS version, so it can ask users to opt in again if the terms change from release to release.", + "format": "int32", + "type": "integer" + }, + "opaEligibility": { + "description": "User's eligibility to use the Assistant.", + "enum": [ + "NOT_ELIGIBLE", + "ELIGIBLE_PREBUILT", + "ELIGIBLE_FOR_UPGRADE", + "ELIGIBLE_UPGRADING", + "ELIGIBLE_UPGRADED", + "ELIGIBLE_UPGRADED_BYPASS" + ], + "enumDescriptions": [ + "User is not eligible for OPA", + "User is eligible for OPA because their device came with OPA.", + "User is eligible to upgrade to OPA after their formerly-ineligible device received an update to AGSA >= 6.13 and received the proper config flags.", + "User is eligible to upgrade, AND has started the upgrade, but NOT finished it. By definition, a user who is ELIGIBLE_UPGRADING was ELIGIBLE_FOR_UPGRADE at some point prior.", + "User is eligible for OPA after completing the upgrade flow. By definition, a user who is ELIGIBLE_UPGRADED was ELIGIBLE_UPGRADING at some point prior.", + "User is eligible for OPA and bypassed some screens in onboarding to complete the upgrade flow. By definition, a user who is ELIGIBLE_UPGRADED_BYPASS is an OPA upgraded user and was ELIGIBLE_UPGRADING at some point prior." + ], + "type": "string" + }, + "opaEmailOptInStatus": { + "description": "Has the user opted-in to receiving emails for OPA? This is set when the user opts-in during the OPA upgrade flow. It has an UNKNOWN value otherwise. Note that this bit isn't updated if the user changes their email opt-in status through settings or unsubscribing in the email.", + "enum": [ + "OPA_OPT_IN_STATUS_UNKNOWN", + "OPA_OPT_IN_STATUS_DISABLED", + "OPA_OPT_IN_STATUS_ENABLED" + ], + "enumDescriptions": [ + "The user has never been prompted with this opt-in.", + "The user has rejected the opt-in.", + "The user has accepted the opt-in." + ], + "type": "string" + }, + "opaExperienceType": { + "description": "The Opa experience type. As of Feb 2019, it is only used to check whether the user is in the Try Before You Buy experience.", + "enum": [ + "OPA_EXPERIENCE_TYPE_UNKNOWN", + "OPA_EXPERIENCE_INELIGIBLE", + "OPA_EXPERIENCE_NOT_STARTED", + "OPA_EXPERIENCE_TRY_BEFORE_YOU_BUY", + "OPA_EXPERIENCE_COMPLETED_ONBOARDING" + ], + "enumDescriptions": [ + "Default value. AGSA 9.27-: all users AGSA 9.27+ 9.66-: all users but TBYB users AGSA 9.66+: not used", + "OPA-ineligible users (AGSA 9.66+ only)", + "The initial state of OPA-eligible users (AGSA 9.66+ only)", + "TBYB users (AGSA 9.27+ only)", + "OOBE-completed users (AGSA 9.66+ only)" + ], + "type": "string" + }, + "opaPartialExperienceReason": { + "description": "The reason why user enters the OPA \"signed-out mode\" partial experience (go/opa-signed-out-everywhere). Note that the value only means how the user entered the partial experience. For example, if a user enters TBYB and becomes a full-experience user, this value will remain as TBYB. To check the current experience type, you should read opa_experience_type instead.", + "enum": [ + "OPA_PARTIAL_EXPERIENCE_REASON_UNKNOWN", + "OPA_TRY_BEFORE_YOU_BUY", + "OPA_UDC_OPT_OUT_FLOW" + ], + "enumDescriptions": [ + "Default value", + "User enters OPA \"siged-out mode\" partial experience due to the try-before-you-buy (TBYB) experiment go/opa-tbyb-experiment-plan", + "User enters OPA \"siged-out mode\" partial experience due to the \"UDC opt-out flow\" experiment (go/opa-udc-opt-out-ux-flow)" + ], + "type": "string" + }, + "opaUdcConsentStatus": { + "description": "Has the user opted in to OPA's UDC requirements? \"OPA UDC consent\" is a one-time opt-in to the set of required UDC opt-in bits. If the user has already granted all required UDC opt-ins, then we automatically mark them as consented. We require that users grant OPA UDC consent before using OPA for the first time. Note: The user does not revoke OPA UDC consent if they turn off one of the UDC opt-in bits from Settings; for such users, the server either offers a degraded experience, or prompts the user to re-grant missing opt-ins.)", + "enum": [ + "OPA_OPT_IN_STATUS_UNKNOWN", + "OPA_OPT_IN_STATUS_DISABLED", + "OPA_OPT_IN_STATUS_ENABLED" + ], + "enumDescriptions": [ + "The user has never been prompted with this opt-in.", + "The user has rejected the opt-in.", + "The user has accepted the opt-in." + ], + "type": "string" + }, + "opaUserEnabledStatus": { + "description": "A user-configurable global on/off switch for the Assistant; the user can completely disable the assistant (go/opa-enabled-ss). Defaults to enabled. This setting is completely independent from the user's opa_eligibility; they can be eligible, but OPA disabled. There users are by definition not making Assistant queries, so this value is a signal of the population size.", + "enum": [ + "OPA_OPT_IN_STATUS_UNKNOWN", + "OPA_OPT_IN_STATUS_DISABLED", + "OPA_OPT_IN_STATUS_ENABLED" + ], + "enumDescriptions": [ + "The user has never been prompted with this opt-in.", + "The user has rejected the opt-in.", + "The user has accepted the opt-in." + ], + "type": "string" + }, + "proactivePersonalResponseStatus": { + "description": "Whether the user has opted into showing proactive personal suggestions on lock screen before asking. This is the proactive sub-bit for lockscreen_personal_response_status.", + "enum": [ + "OPA_OPT_IN_STATUS_UNKNOWN", + "OPA_OPT_IN_STATUS_DISABLED", + "OPA_OPT_IN_STATUS_ENABLED" + ], + "enumDescriptions": [ + "The user has never been prompted with this opt-in.", + "The user has rejected the opt-in.", + "The user has accepted the opt-in." + ], + "type": "string" + }, + "screenContextOptInStatus": { + "description": "Has the user granted permission for Google to read the contents of their screen. Note that in OPA, training hotword automatically opts the user into screen context.", + "enum": [ + "OPA_OPT_IN_STATUS_UNKNOWN", + "OPA_OPT_IN_STATUS_DISABLED", + "OPA_OPT_IN_STATUS_ENABLED" + ], + "enumDescriptions": [ + "The user has never been prompted with this opt-in.", + "The user has rejected the opt-in.", + "The user has accepted the opt-in." + ], + "type": "string" + }, + "skipVoiceRecognitionStatus": { + "description": "Whether the user has opted into skipping voice recognition. go/iris-newperm-prd", + "enum": [ + "OPA_OPT_IN_STATUS_UNKNOWN", + "OPA_OPT_IN_STATUS_DISABLED", + "OPA_OPT_IN_STATUS_ENABLED" + ], + "enumDescriptions": [ + "The user has never been prompted with this opt-in.", + "The user has rejected the opt-in.", + "The user has accepted the opt-in." + ], + "type": "string" + }, + "speakerModelStatus": { + "description": "Whether the user has enrolled the Speaker ID model.", + "enum": [ + "OPA_OPT_IN_STATUS_UNKNOWN", + "OPA_OPT_IN_STATUS_DISABLED", + "OPA_OPT_IN_STATUS_ENABLED" + ], + "enumDescriptions": [ + "The user has never been prompted with this opt-in.", + "The user has rejected the opt-in.", + "The user has accepted the opt-in." + ], + "type": "string" + }, + "thirdPartyDisclosureStatus": { + "description": "Whether the user has acknowledged the third party disclosure.", + "enum": [ + "OPA_OPT_IN_STATUS_UNKNOWN", + "OPA_OPT_IN_STATUS_DISABLED", + "OPA_OPT_IN_STATUS_ENABLED" + ], + "enumDescriptions": [ + "The user has never been prompted with this opt-in.", + "The user has rejected the opt-in.", + "The user has accepted the opt-in." + ], + "type": "string" + }, + "warmActionsAlarmsTimersEnrollmentStatus": { + "description": "Whether the user has opted into alarms/timers context for Quick phrases.", + "enum": [ + "OPA_OPT_IN_STATUS_UNKNOWN", + "OPA_OPT_IN_STATUS_DISABLED", + "OPA_OPT_IN_STATUS_ENABLED" + ], + "enumDescriptions": [ + "The user has never been prompted with this opt-in.", + "The user has rejected the opt-in.", + "The user has accepted the opt-in." + ], + "type": "string" + }, + "warmActionsCallsEnrollmentStatus": { + "description": "Whether the user has opted into calls context for Quick phrases.", + "enum": [ + "OPA_OPT_IN_STATUS_UNKNOWN", + "OPA_OPT_IN_STATUS_DISABLED", + "OPA_OPT_IN_STATUS_ENABLED" + ], + "enumDescriptions": [ + "The user has never been prompted with this opt-in.", + "The user has rejected the opt-in.", + "The user has accepted the opt-in." + ], + "type": "string" + }, + "warmActionsEnrollmentStatus": { + "description": "Whether the user has opted into at least one Mobile Warm Words/Quick Phrases context. go/mww-prd", + "enum": [ + "OPA_OPT_IN_STATUS_UNKNOWN", + "OPA_OPT_IN_STATUS_DISABLED", + "OPA_OPT_IN_STATUS_ENABLED" + ], + "enumDescriptions": [ + "The user has never been prompted with this opt-in.", + "The user has rejected the opt-in.", + "The user has accepted the opt-in." + ], + "type": "string" + }, + "webAndAppHistoryStatus": { + "$ref": "OptInStatus", + "description": "User allows Google to upload usage history from their device. This field can be set to true iff web_history_status is set to true. Historically, this used to be called \"Supplemental Search History\". See https://goto.google.com/device-consents" + }, + "webHistoryStatus": { + "$ref": "OptInStatus", + "description": "User allows Google to log interactions with Search from their device. Historically, this used to be called \"Search History\". See https://goto.google.com/device-consents" } }, "type": "object" }, - "Content": { - "id": "Content", + "CloudsearchEmailAddress": { + "description": "A person's email address.", + "id": "CloudsearchEmailAddress", "properties": { - "actions": { - "description": "[Optional] Actions for this card.", + "emailAddress": { + "description": "The email address.", + "type": "string" + }, + "primary": { + "description": "Indicates if this is the user's primary email. Only one entry can be marked as primary.", + "type": "boolean" + } + }, + "type": "object" + }, + "CloudsearchFilter": { + "description": "Generic way of expessing filters. It support two ways. 1. Setting name and the value. The name has to be an operator_name defined in schema. 2. Setting the operator and filters. The sub filters will be evaluated using the operator.", + "id": "CloudsearchFilter", + "properties": { + "filters": { + "description": "Sub filters. If present, the operator must be set.", "items": { - "$ref": "Action" + "$ref": "CloudsearchFilter" }, "type": "array" }, - "description": { - "$ref": "SafeHtmlProto", - "description": "[Optional] Description of the card." + "name": { + "description": "The operator_name that we apply to the query, e.g. price_greater_than. It can be either case, 1. operator_name in schema. We will filter the results with the property that matches the value. 2. greater_than_operator_name or less_than_operator_name in schema. We will filter the results that property is greater than or less than the given value.", + "type": "string" }, - "subtitle": { - "$ref": "BackgroundColoredText", - "description": "[Optional] Subtitle of the card." + "operator": { + "description": "The operator of the filter.", + "enum": [ + "AND", + "OR", + "NOT" + ], + "enumDescriptions": [ + "Logical operators, can only be applied to a sub filters.", + "", + "NOT can only be appiled on a single sub filters." + ], + "type": "string" }, - "title": { - "$ref": "BackgroundColoredText", - "description": "[Optional] Title of the card." + "value": { + "$ref": "CloudsearchValue", + "description": "The value to check. If present, the name must be set." } }, "type": "object" }, - "Context": { - "id": "Context", + "CloudsearchFilterSuggestion": { + "description": "A filter suggestion.", + "id": "CloudsearchFilterSuggestion", "properties": { - "app": { - "description": "[Optional] App where the card should be shown. If missing, the card will be shown in TOPAZ.", + "filter": { + "$ref": "CloudsearchFilter", + "description": "The filter suggestion. It can be 1. A value filter, e.g. type:documents 2. A composite filter before:today and after:yesterday" + }, + "suggestionMatchInfo": { + "$ref": "CloudsearchSnippet", + "description": "This field contains the suggestion match information returned by the backend after escaping the HTML in the suggestion string. The areas that we might like to extract from the suggestion string returned by the backend are marked using the match_ranges field inside Snippet. For example, if the snippet string inside suggestion_match_info is: \"google search\", and the keyword \"goog\" is supposed to be bolded, the match_ranges is the list of range of indexes in the snippet string where it is bolded: [[0, 4)]." + }, + "type": { + "enum": [ + "NONE", + "OPERATOR", + "LABEL" + ], + "enumDescriptions": [ + "", + "", + "" + ], + "type": "string" + } + }, + "type": "object" + }, + "CloudsearchGroup": { + "description": "Object to represent a group.", + "id": "CloudsearchGroup", + "properties": { + "emailAddresses": { + "description": "The group's email addresses", "items": { - "enum": [ - "UNKNOWN_APP", - "TOPAZ", - "MOMA" - ], - "enumDescriptions": [ - "", - "", - "" - ], - "type": "string" + "$ref": "CloudsearchEmailAddress" }, "type": "array" }, - "dayOfWeek": { - "description": "[Optional] Day of week when the card should be shown, where 0 is Monday.", + "groupNames": { + "description": "Group's names", "items": { - "format": "int32", - "type": "integer" + "$ref": "CloudsearchName" }, "type": "array" }, - "endDateSec": { - "description": "[Optional] Date (in seconds since epoch) when the card should stop being shown. If missing, end_date_sec will be set to Jan 1st, 2100.", - "format": "int64", + "name": { + "description": "The resource name of the group to provide information about. See People.get from Google People API.", "type": "string" }, - "endDayOffsetSec": { - "description": "[Optional] End time in seconds, within a day, when the card should stop being shown if it's within [start_date_sec, end_date_sec]. If missing, this is set to 86400 (24 hours x 3600 sec/hour), i.e., midnight next day.", - "format": "int64", + "obfuscatedId": { + "description": "Obfuscated GAIA ID of a google group. Used by first party Cloud Search clients.", + "type": "string" + } + }, + "type": "object" + }, + "CloudsearchImage": { + "description": "Image returned with suggestion; eg: person's photo or document thumbnail.", + "id": "CloudsearchImage", + "properties": { + "source": { + "description": "Specifies the source from where the photo is fetched.", + "enum": [ + "CONTACT_DATA_SOURCE_UNSPECIFIED", + "CONTACT_DATA_SOURCE_PROFILE", + "CONTACT_DATA_SOURCE_DOMAIN_PROFILE", + "CONTACT_DATA_SOURCE_CONTACT", + "CONTACT_DATA_SOURCE_DOMAIN_CONTACT", + "CONTACT_DATA_SOURCE_AFFINITY" + ], + "enumDescriptions": [ + "Data source for the contact is not specified.", + "This is where a Google user keeps and edits information about themself. They can decide who (what other Google users) can view which parts of it. Since it is information a user is managing about themselves, it is considered to be the most up-to-date.", + "Google-For-Work Profile. The domain profile data source describes Google profile data that is populated/edited by the admin of a Google Workspace organization.", + "Where a Google user keeps contact information about others, like phone numbers, emails and more. The user owns and edits this information. It could be out of date or incorrect. Users are generally only allowed to read their own contacts. Contacts are typically synced to mobile devices and used in apps like Gmail and Hangouts.", + "Domain shared contact. An entity that is owned by a domain and represents a person, but is not a user in the domain. For more details see https://support.google.com/a/answer/9281635.", + "Device contacts that are used in interaction ranking, but have not been uploaded to Google. These are synthesized people from interaction data." + ], "type": "string" }, - "locale": { - "description": "[Optional] The locales for which the card should be triggered (e.g., en_US and en_CA). If missing, the card is going to show to clients regardless of their locale.", - "items": { - "type": "string" - }, - "type": "array" - }, - "location": { - "description": "[Optional] Text-free locations where the card should be shown. This is expected to match the user's location in focus. If no location is specified, the card will be shown for any location.", - "items": { - "type": "string" - }, - "type": "array" - }, - "query": { - "description": "[Required only for Answer and RHS cards - will be ignored for Homepage] cards. It's the exact case-insensitive queries that will trigger the Answer or RHS card.", - "items": { - "type": "string" - }, - "type": "array" + "url": { + "description": "The URL of the photo.", + "type": "string" + } + }, + "type": "object" + }, + "CloudsearchMatchRange": { + "description": "Matched range of a snippet [start, end). The \"start\" and \"end\" positions are 0 indexed. For example, if the snippet string is \"google search\" and the string to be matched is \"goog\", the MatchRange is [0, 4).", + "id": "CloudsearchMatchRange", + "properties": { + "end": { + "description": "1 + index of the ending position of the match in the snippet.", + "format": "int32", + "type": "integer" }, - "startDateSec": { - "description": "[Optional] Date (in seconds since epoch) when the card should start being shown. If missing, start_date_sec will be Jan 1st, 1970 UTC.", - "format": "int64", + "start": { + "description": "Index of the starting position of the match in the snippet.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "CloudsearchName": { + "description": "A person or group's name.", + "id": "CloudsearchName", + "properties": { + "displayName": { + "description": "The read-only display name formatted according to the locale specified by the viewer's account or the Accept-Language HTTP header.", "type": "string" }, - "startDayOffsetSec": { - "description": "[Optional] Start time in seconds, within a day, when the card should be shown if it's within [start_date_sec, end_date_sec]. If 0, the card will be shown from 12:00am on.", - "format": "int64", + "source": { + "description": "Specifies the source from where the name is fetched.", + "enum": [ + "CONTACT_DATA_SOURCE_UNSPECIFIED", + "CONTACT_DATA_SOURCE_PROFILE", + "CONTACT_DATA_SOURCE_DOMAIN_PROFILE", + "CONTACT_DATA_SOURCE_CONTACT", + "CONTACT_DATA_SOURCE_DOMAIN_CONTACT", + "CONTACT_DATA_SOURCE_AFFINITY" + ], + "enumDescriptions": [ + "Data source for the contact is not specified.", + "This is where a Google user keeps and edits information about themself. They can decide who (what other Google users) can view which parts of it. Since it is information a user is managing about themselves, it is considered to be the most up-to-date.", + "Google-For-Work Profile. The domain profile data source describes Google profile data that is populated/edited by the admin of a Google Workspace organization.", + "Where a Google user keeps contact information about others, like phone numbers, emails and more. The user owns and edits this information. It could be out of date or incorrect. Users are generally only allowed to read their own contacts. Contacts are typically synced to mobile devices and used in apps like Gmail and Hangouts.", + "Domain shared contact. An entity that is owned by a domain and represents a person, but is not a user in the domain. For more details see https://support.google.com/a/answer/9281635.", + "Device contacts that are used in interaction ranking, but have not been uploaded to Google. These are synthesized people from interaction data." + ], "type": "string" + } + }, + "type": "object" + }, + "CloudsearchPeopleSuggestion": { + "description": "A person suggestion.", + "id": "CloudsearchPeopleSuggestion", + "properties": { + "emailNameMatchInfo": { + "$ref": "CloudsearchSnippet", + "description": "This field contains the suggestion information returned by the backend after escaping the HTML in the suggestion string. The areas that we might like to extract from the suggestion string returned by the backend are marked using the match_ranges field inside Snippet. For example, if the snippet string inside email_name_match_info is: \"John Doe - johndoe@google.com\", and the keyword \"doe\" should be matched, the match_ranges is: [[5, 8), [15, 18)]." }, - "surface": { - "description": "[Optional] Surface where the card should be shown in. If missing, the card will be shown in any surface.", - "items": { - "enum": [ - "UNKNOWN_SURFACE", - "DESKTOP", - "ANDROID", - "IOS", - "MOBILE", - "ANY" - ], - "enumDescriptions": [ - "", - "", - "", - "", - "Any mobile device.", - "" - ], - "type": "string" - }, - "type": "array" + "googleGroup": { + "$ref": "CloudsearchGroup" }, - "type": { - "description": "[Required] Type of the card (homepage, Answer or RHS).", - "items": { - "enum": [ - "UNKNOWN_CARD_TYPE", - "HOMEPAGE_CARD", - "ANSWER_CARD", - "RHS_CARD" - ], - "enumDescriptions": [ - "", - "", - "", - "" - ], - "type": "string" - }, - "type": "array" + "person": { + "$ref": "CloudsearchPerson" } }, "type": "object" }, - "ContextAttribute": { - "description": "A named attribute associated with an item which can be used for influencing the ranking of the item based on the context in the request.", - "id": "ContextAttribute", + "CloudsearchPerson": { + "description": "Object to represent a person.", + "id": "CloudsearchPerson", "properties": { + "emailAddresses": { + "description": "The person's email addresses", + "items": { + "$ref": "CloudsearchEmailAddress" + }, + "type": "array" + }, "name": { - "description": "The name of the attribute. It should not be empty. The maximum length is 32 characters. The name must start with a letter and can only contain letters (A-Z, a-z) or numbers (0-9). The name will be normalized (lower-cased) before being matched.", + "description": "The resource name of the person to provide information about. See People.get from Google People API.", "type": "string" }, - "values": { - "description": "Text values of the attribute. The maximum number of elements is 10. The maximum length of an element in the array is 32 characters. The value will be normalized (lower-cased) before being matched.", + "obfuscatedId": { + "description": "Obfuscated GAIA ID of a person. Used by first party Cloud Search client, to build a hangout link.", + "type": "string" + }, + "personNames": { + "description": "The person's names", "items": { - "type": "string" + "$ref": "CloudsearchName" }, "type": "array" - } - }, - "type": "object" - }, - "CustomerIndexStats": { - "description": "Aggregation of items by status code as of the specified date.", - "id": "CustomerIndexStats", - "properties": { - "date": { - "$ref": "Date", - "description": "The date for which statistics were calculated." }, - "itemCountByStatus": { - "description": "Number of items aggregrated by status code.", + "photos": { + "description": "A person's read-only photo. A picture shown next to the person's name to help others recognize the person in search results.", "items": { - "$ref": "ItemCountByStatus" + "$ref": "CloudsearchImage" }, "type": "array" } }, "type": "object" }, - "CustomerQueryStats": { - "id": "CustomerQueryStats", + "CloudsearchQuerySuggestion": { + "id": "CloudsearchQuerySuggestion", "properties": { - "date": { - "$ref": "Date", - "description": "The date for which query stats were calculated. Stats calculated on the next day close to midnight are returned." - }, - "queryCountByStatus": { - "items": { - "$ref": "QueryCountByStatus" - }, - "type": "array" + "suggestionMatchInfo": { + "$ref": "CloudsearchSnippet", + "description": "This field contains the suggestion match information returned by the backend after escaping the HTML in the suggestion string. The areas that we might like to extract from the suggestion string returned by the backend are marked using the match_ranges field inside Snippet. For example, if the snippet string inside suggestion_match_info is: \"google search\", and the keyword \"goog\" is supposed to be bolded, the match_ranges is the list of range of indexes in the snippet string where it is bolded: [[0, 4)]." } }, "type": "object" }, - "CustomerSearchApplicationStats": { - "description": "Search application stats for a customer for the given date.", - "id": "CustomerSearchApplicationStats", + "CloudsearchSnippet": { + "description": "Snippet of the suggestion, which summarizes the content of the resulting page.", + "id": "CloudsearchSnippet", "properties": { - "count": { - "description": "The count of search applications for the date.", - "format": "int64", - "type": "string" + "matchRanges": { + "description": "The matched ranges in the snippet.", + "items": { + "$ref": "CloudsearchMatchRange" + }, + "type": "array" }, - "date": { - "$ref": "Date", - "description": "The date for which search application stats were calculated." + "snippet": { + "description": "The snippet of the document.", + "type": "string" } }, "type": "object" }, - "CustomerSessionStats": { - "id": "CustomerSessionStats", + "CloudsearchSource": { + "description": "Define a source to query suggest/search APIs. Source is set in the STMixer request params.", + "id": "CloudsearchSource", "properties": { - "date": { - "$ref": "Date", - "description": "The date for which session stats were calculated. Stats are calculated on the following day, close to midnight PST, and then returned." + "anyThirdPartySource": { + "description": "If set to true, all 3p sources will be considered", + "type": "boolean" }, - "searchSessionsCount": { - "description": "The count of search sessions on the day", - "format": "int64", + "name": { + "description": "Source name of contents that indexed by Index API", + "type": "string" + }, + "predefinedSource": { + "description": "Predefined source for Google Apps.", + "enum": [ + "GENERIC", + "GROUPS", + "QUERY_HISTORY", + "PEOPLE", + "GOOGLE_DRIVE", + "GOOGLE_GMAIL", + "GOOGLE_SITES", + "GOOGLE_GROUPS", + "GOOGLE_CALENDAR", + "GOOGLE_CHAT", + "GOOGLE_KEEP", + "ENGDOC", + "GOOGLE_ATARI", + "GOOGLE_JOTSPOT", + "GOOWIKI", + "MOMA_GLOSSARY", + "MOMA_UAR", + "ENGDOC_RESTRICTED", + "GKMS", + "X20", + "YAQS", + "ENTERPRISE_ASSIST", + "FILTER" + ], + "enumDescriptions": [ + "Default source.", + "", + "People API source. Used for suggest API only. Ignored in search API.", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "" + ], "type": "string" } }, "type": "object" }, - "CustomerSettings": { - "description": "Represents settings at a customer level.", - "id": "CustomerSettings", + "CloudsearchSuggestResponseDebugInfo": { + "id": "CloudsearchSuggestResponseDebugInfo", "properties": { - "auditLoggingSettings": { - "$ref": "AuditLoggingSettings", - "description": "Audit Logging settings for the customer. If update_mask is empty then this field will be updated based on UpdateCustomerSettings request." + "completeServerInfo": { + "$ref": "CloudsearchSuggestResponseDebugInfoCompleteServerInfo" }, - "vpcSettings": { - "$ref": "VPCSettings", - "description": "VPC SC settings for the customer. If update_mask is empty then this field will be updated based on UpdateCustomerSettings request." + "starlightInfo": { + "$ref": "CloudsearchSuggestResponseDebugInfoStarlightInfo" } }, "type": "object" }, - "CustomerUserStats": { - "id": "CustomerUserStats", + "CloudsearchSuggestResponseDebugInfoCompleteServerInfo": { + "id": "CloudsearchSuggestResponseDebugInfoCompleteServerInfo", "properties": { - "date": { - "$ref": "Date", - "description": "The date for which session stats were calculated. Stats calculated on the next day close to midnight are returned." - }, - "oneDayActiveUsersCount": { - "description": "The count of unique active users in the past one day", - "format": "int64", + "completeserverHostname": { "type": "string" }, - "sevenDaysActiveUsersCount": { - "description": "The count of unique active users in the past seven days", - "format": "int64", - "type": "string" + "psuggestDoNotCache": { + "type": "boolean" }, - "thirtyDaysActiveUsersCount": { - "description": "The count of unique active users in the past thirty days", - "format": "int64", + "request": { + "$ref": "SuggestSuggestRequest" + }, + "results": { + "items": { + "$ref": "CloudsearchSuggestResponseDebugInfoCompleteServerInfoSuggestResult" + }, + "type": "array" + }, + "starlightHostname": { "type": "string" } }, "type": "object" }, - "DataSource": { - "description": "Datasource is a logical namespace for items to be indexed. All items must belong to a datasource. This is the prerequisite before items can be indexed into Cloud Search. ", - "id": "DataSource", + "CloudsearchSuggestResponseDebugInfoCompleteServerInfoSuggestResult": { + "id": "CloudsearchSuggestResponseDebugInfoCompleteServerInfoSuggestResult", "properties": { - "disableModifications": { - "description": "If true, sets the datasource to read-only mode. In read-only mode, the Indexing API rejects any requests to index or delete items in this source. Enabling read-only mode does not stop the processing of previously accepted data.", - "type": "boolean" + "suggestedQuery": { + "type": "string" }, - "disableServing": { - "description": "Disable serving any search or assist results.", - "type": "boolean" + "suggestionType": { + "enum": [ + "UNKNOWN", + "GMAIL_SUBJECT", + "CONTACT", + "PERSON", + "GMAIL_LABEL", + "DRIVE_TITLE", + "GMAIL_OPERATOR", + "QUERY_PREFIX", + "GMAIL_QUERY", + "WEB_QUERY", + "YOUTUBE_QUERY", + "MAPS_QUERY", + "MAPS_FEATURE", + "MAPS_PLACE_LIST", + "PHOTO_PERSON", + "PHOTO_PLACE", + "PHOTO_THING", + "PHOTO_ALBUM", + "PHOTO_DATE", + "PHOTO_APP_PAGE", + "PHOTO_OTHER", + "PHOTO_MEDIA_TYPE", + "GENERIC_QUERY", + "PHOTO_CAMERA", + "CHROME_HISTORY", + "DEVICE_CONTACT", + "CONTACT_GROUP", + "IMAGE_QUERY", + "LAST_URL", + "SERP_CLICK", + "PLAY_STORE_QUERY", + "PODCASTS_QUERY", + "CHAT_QUERY", + "DRIVE_QUERY", + "CALENDAR_QUERY", + "TOPAZ_QUERY", + "SHOPPING_QUERY", + "WEB_MAPS_FEATURE", + "LENS_QUERY", + "IGA_HISTORY", + "EXPERIMENTAL_QUERY" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "", + "", + "", + "The original query prefix.", + "", + "Personalized web query.", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "Contact label.", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "" + ], + "type": "string" + } + }, + "type": "object" + }, + "CloudsearchSuggestResponseDebugInfoStarlightInfo": { + "id": "CloudsearchSuggestResponseDebugInfoStarlightInfo", + "properties": { + "compareRankingsScore": { + "description": "Position-weighted measurement of the difference between the two result sets. See go/search-experiments-glossary - CR Score.", + "format": "double", + "type": "number" }, - "displayName": { - "description": "Required. Display name of the datasource The maximum length is 300 characters.", + "starlightHostname": { "type": "string" }, - "indexingServiceAccounts": { - "description": "List of service accounts that have indexing access.", + "suggestResults": { + "description": "List of suggestion results returned from Starlight for dark launch.", "items": { - "type": "string" + "$ref": "CloudsearchSuggestResult" }, "type": "array" + } + }, + "type": "object" + }, + "CloudsearchSuggestResult": { + "description": "One suggestion result. next_id: 16", + "id": "CloudsearchSuggestResult", + "properties": { + "encryptedResultDebugId": { + "type": "string" }, - "itemsVisibility": { - "description": "This field restricts visibility to items at the datasource level. Items within the datasource are restricted to the union of users and groups included in this field. Note that, this does not ensure access to a specific item, as users need to have ACL permissions on the contained items. This ensures a high level access on the entire datasource, and that the individual items are not shared outside this visibility.", + "extension": { + "$ref": "MessageSet" + }, + "filterSuggestion": { + "$ref": "CloudsearchFilterSuggestion" + }, + "matchedTextInQueryInfo": { + "description": "Indicates the matches between the suggestion and the user's query. For example, if the user types \"isac xx\" and the returned suggestion is \"Isaac Elias\" then the match is on the token \"isaac\" after spell correction. Note that \"isac\" in user's query matched with \"isaac\" in the suggestion because of spell correction. Also note that spell correction may or may not happen. In this example, matched_text_in_query_info.size() is 1, matched_text_in_query_info(0).snippet() is \"isaac\", matched_text_in_query_info(0).match_ranges().start() is 0 and matched_text_in_query_info(0).match_ranges().end() is 5.", "items": { - "$ref": "GSuitePrincipal" + "$ref": "CloudsearchSnippet" }, "type": "array" }, "name": { - "description": "The name of the datasource resource. Format: datasources/{source_id}. The name is ignored when creating a datasource.", + "description": "The name of the suggestion. This is unique identifier of the suggestion.", "type": "string" }, - "operationIds": { - "description": "IDs of the Long Running Operations (LROs) currently running for this schema.", - "items": { - "type": "string" - }, - "type": "array" + "peopleSuggestion": { + "$ref": "CloudsearchPeopleSuggestion" }, - "returnThumbnailUrls": { - "description": "Can a user request to get thumbnail URI for Items indexed in this data source.", - "type": "boolean" + "querySuggestion": { + "$ref": "CloudsearchQuerySuggestion" }, - "shortName": { - "description": "A short name or alias for the source. This value will be used to match the 'source' operator. For example, if the short name is ** then queries like *source:* will only return results for this source. The value must be unique across all datasources. The value must only contain alphanumeric characters (a-zA-Z0-9). The value cannot start with 'google' and cannot be one of the following: mail, gmail, docs, drive, groups, sites, calendar, hangouts, gplus, keep, people, teams. Its maximum length is 32 characters.", + "score": { + "description": "Final score returned by superroot for this suggestion.", + "format": "double", + "type": "number" + }, + "source": { + "$ref": "CloudsearchSource" + }, + "subScores": { + "$ref": "CloudsearchSuggestionScores" + }, + "subType": { + "enum": [ + "NONE", + "CONTENT_TEXT_SUGGESTION", + "OPERATOR_NAME_SUGGESTION", + "OPERATOR_VALUE_SUGGESTION", + "NL_ENTITY_SUGGESTION", + "PEOPLE_SUGGESTION" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "", + "" + ], + "type": "string" + }, + "suggestedQuery": { + "description": "The suggested query that will be used for search, when the user clicks on the suggestion", + "type": "string" + }, + "suggestionOrigin": { + "enum": [ + "DEFAULT", + "HISTORY", + "SEARCH_OPERATOR" + ], + "enumDescriptions": [ + "Suggestion with default type.", + "Personal query history.", + "Suggestion is from search operator index." + ], + "type": "string" + }, + "type": { + "enum": [ + "UNKNOWN", + "QUERY_HISTORY", + "SOURCE_CONTENT", + "PEOPLE", + "FILTER", + "GROUP", + "USER_QUERY" + ], + "enumDescriptions": [ + "Type is not known.", + "Suggestion from user search history.", + "Suggestion from content/source.", + "Suggestion is a person.", + "Suggestion is a filter.", + "Suggestion is a group.", + "User's own query returned as a suggestion" + ], "type": "string" } }, "type": "object" }, - "DataSourceIndexStats": { - "description": "Aggregation of items by status code as of the specified date.", - "id": "DataSourceIndexStats", + "CloudsearchSuggestionScores": { + "description": "Signals that contribute to the final score.", + "id": "CloudsearchSuggestionScores", "properties": { - "date": { - "$ref": "Date", - "description": "The date for which index stats were calculated. If the date of request is not the current date then stats calculated on the next day are returned. Stats are calculated close to mid night in this case. If date of request is current date, then real time stats are returned." + "completeServerInternalScores": { + "$ref": "CloudsearchSuggestionScoresCompleteServerInternalScores" }, - "itemCountByStatus": { - "description": "Number of items aggregrated by status code.", - "items": { - "$ref": "ItemCountByStatus" - }, - "type": "array" + "completeserverInternalScores": { + "$ref": "CloudsearchSuggestionScoresInternalScores" + }, + "personalizedBoost": { + "description": "How frequent is the suggestion within this user.", + "format": "float", + "type": "number" + }, + "popularity": { + "description": "How popular is the suggestion among all users.", + "format": "float", + "type": "number" + }, + "sectionBoost": { + "description": "Amount by which a section is boosted based on heuristics.", + "format": "float", + "type": "number" + }, + "sourceScaleFactor": { + "description": "Scale factor of the datasource its coming from.", + "format": "float", + "type": "number" + }, + "starlightInternalScores": { + "$ref": "CloudsearchSuggestionScoresInternalScores" } }, "type": "object" }, - "DataSourceRestriction": { - "description": "Restriction on Datasource.", - "id": "DataSourceRestriction", + "CloudsearchSuggestionScoresCompleteServerInternalScores": { + "id": "CloudsearchSuggestionScoresCompleteServerInternalScores", "properties": { - "filterOptions": { - "description": "Filter options restricting the results. If multiple filters are present, they are grouped by object type before joining. Filters with the same object type are joined conjunctively, then the resulting expressions are joined disjunctively. The maximum number of elements is 20. NOTE: Suggest API supports only few filters at the moment: \"objecttype\", \"type\" and \"mimetype\". For now, schema specific filters cannot be used to filter suggestions.", - "items": { - "$ref": "FilterOptions" - }, - "type": "array" + "contactsGroup": { + "description": "Contacts group score (i.e. if the string is a name of a group).", + "format": "float", + "type": "number" }, - "source": { - "$ref": "Source", - "description": "The source of restriction." + "emailAutocompleteScore": { + "description": "Score for email autocomplete. Corresponds to DAS affinity PERSONAL_SUGGEST_EMAIL_AUTOCOMPLETE_SCORE.", + "format": "float", + "type": "number" + }, + "focusOutboundEmailCount": { + "description": "Outbound email count as read from FBS.", + "format": "float", + "type": "number" + }, + "gmailHistory": { + "description": "Frequency based score of a query from the user's gmail search history", + "format": "float", + "type": "number" + }, + "gmailHistoryMediumTermQueryTime": { + "format": "float", + "type": "number" + }, + "gmailHistoryShortTermQueryTime": { + "description": "Both the gmail query_time scores below are based on the time of the last query event. Basically the score is (query_time - (model_time - PERIOD)) / PERIOD Where PERIOD is 1 & 14 days for short and medium term.", + "format": "float", + "type": "number" + }, + "gmailLabel": { + "description": "Gmail label score, as received from Gmail through PbUI.", + "format": "float", + "type": "number" + }, + "gmailOperator": { + "description": "Score for gmail operators.", + "format": "float", + "type": "number" + }, + "gmailText": { + "description": "Score for text entities extracted from gmail subjects.", + "format": "float", + "type": "number" + }, + "matchScore": { + "description": "The score of the match. The score is in the range [0, num_matching_tokens]. This means that a query with many tokens can have matches with higher score.", + "format": "double", + "type": "number" + }, + "score": { + "description": "Final score from CompleteServer. This either corresponds to Starlight score or Muppet score (for Generic Suggest suggestions) based on the CompleteServer backend. This is a combination of query dependent and independent components. The scores related to suggestion types like email_autocomplete_score & gmail_text are query independent whereas the match_score is query dependent.", + "format": "double", + "type": "number" } }, "type": "object" }, - "Date": { - "description": "Represents a whole calendar date, for example a date of birth. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the [Proleptic Gregorian Calendar](https://en.wikipedia.org/wiki/Proleptic_Gregorian_calendar). The date must be a valid calendar date between the year 1 and 9999.", - "id": "Date", + "CloudsearchSuggestionScoresInternalScores": { + "description": "Internal scores from CompleteServer/Starlight. NOTE: This proto message is also being used for storing scores from calling Starlight directly instead from CompleteServer.", + "id": "CloudsearchSuggestionScoresInternalScores", "properties": { - "day": { - "description": "Day of month. Must be from 1 to 31 and valid for the year and month.", - "format": "int32", - "type": "integer" + "contactsGroup": { + "description": "Contacts group score (i.e. if the string is a name of a group).", + "format": "float", + "type": "number" }, - "month": { - "description": "Month of date. Must be from 1 to 12.", - "format": "int32", - "type": "integer" + "emailAutocompleteScore": { + "description": "Score for email autocomplete. Corresponds to DAS affinity PERSONAL_SUGGEST_EMAIL_AUTOCOMPLETE_SCORE.", + "format": "float", + "type": "number" }, - "year": { - "description": "Year of date. Must be from 1 to 9999.", - "format": "int32", - "type": "integer" + "focusOutboundEmailCount": { + "description": "Outbound email count as read from FBS.", + "format": "float", + "type": "number" + }, + "gmailHistory": { + "description": "Frequency based score of a query from the user's gmail search history", + "format": "float", + "type": "number" + }, + "gmailHistoryMediumTermQueryTime": { + "format": "float", + "type": "number" + }, + "gmailHistoryShortTermQueryTime": { + "description": "Both the gmail query_time scores below are based on the time of the last query event. Basically the score is (query_time - (model_time - PERIOD)) / PERIOD Where PERIOD is 1 & 14 days for short and medium term.", + "format": "float", + "type": "number" + }, + "gmailLabel": { + "description": "Gmail label score, as received from Gmail through PbUI.", + "format": "float", + "type": "number" + }, + "gmailOperator": { + "description": "Score for gmail operators.", + "format": "float", + "type": "number" + }, + "gmailText": { + "description": "Score for text entities extracted from gmail subjects.", + "format": "float", + "type": "number" + }, + "matchScore": { + "description": "The score of the match. The score is in the range [0, num_matching_tokens]. This means that a query with many tokens can have matches with higher score.", + "format": "double", + "type": "number" + }, + "score": { + "description": "Final score from CompleteServe / Starlight. This either corresponds to Starlight score or Muppet score (for Generic Suggest suggestions) based on the CompleteServer backend. This is a combination of query dependent and independent components. The scores related to suggestion types like email_autocomplete_score & gmail_text are query independent whereas the match_score is query dependent.", + "format": "double", + "type": "number" } }, "type": "object" }, - "DateOperatorOptions": { - "description": "Optional. Provides a search operator for date properties. Search operators let users restrict the query to specific fields relevant to the type of item being searched.", - "id": "DateOperatorOptions", + "CloudsearchValue": { + "description": "Definition of a single value with generic type. LINT.IfChange", + "id": "CloudsearchValue", "properties": { - "greaterThanOperatorName": { - "description": "Indicates the operator name required in the query in order to isolate the date property using the greater-than operator. For example, if greaterThanOperatorName is *closedafter* and the property's name is *closeDate*, then queries like *closedafter:* show results only where the value of the property named *closeDate* is later than **. The operator name can only contain lowercase letters (a-z). The maximum length is 32 characters.", - "type": "string" + "booleanValue": { + "type": "boolean" }, - "lessThanOperatorName": { - "description": "Indicates the operator name required in the query in order to isolate the date property using the less-than operator. For example, if lessThanOperatorName is *closedbefore* and the property's name is *closeDate*, then queries like *closedbefore:* show results only where the value of the property named *closeDate* is earlier than **. The operator name can only contain lowercase letters (a-z). The maximum length is 32 characters.", - "type": "string" + "dateValue": { + "$ref": "Date" }, - "operatorName": { - "description": "Indicates the actual string required in the query in order to isolate the date property. For example, suppose an issue tracking schema object has a property named *closeDate* that specifies an operator with an operatorName of *closedon*. For searches on that data, queries like *closedon:* show results only where the value of the *closeDate* property matches **. By contrast, a search that uses the same ** without an operator returns all items where ** matches the value of any String properties or text within the content field for the indexed datasource. The operator name can only contain lowercase letters (a-z). The maximum length is 32 characters.", - "type": "string" - } - }, - "type": "object" - }, - "DatePropertyOptions": { - "description": "The options for date properties.", - "id": "DatePropertyOptions", - "properties": { - "operatorOptions": { - "$ref": "DateOperatorOptions", - "description": "If set, describes how the date should be used as a search operator." + "doubleValue": { + "format": "double", + "type": "number" + }, + "integerValue": { + "format": "int64", + "type": "string" + }, + "stringValue": { + "type": "string" + }, + "timestampValue": { + "format": "google-datetime", + "type": "string" } }, "type": "object" }, - "DateValues": { - "description": "List of date values.", - "id": "DateValues", + "CompositeFilter": { + "id": "CompositeFilter", "properties": { - "values": { + "logicOperator": { + "description": "The logic operator of the sub filter.", + "enum": [ + "AND", + "OR", + "NOT" + ], + "enumDescriptions": [ + "Logical operators, which can only be applied to sub filters.", + "", + "NOT can only be applied on a single sub filter." + ], + "type": "string" + }, + "subFilters": { + "description": "Sub filters.", "items": { - "$ref": "Date" + "$ref": "Filter" }, "type": "array" } }, "type": "object" }, - "DebugOptions": { - "description": "Shared request debug options for all cloudsearch RPC methods.", - "id": "DebugOptions", + "Content": { + "id": "Content", "properties": { - "enableDebugging": { - "description": "If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field.", - "type": "boolean" + "actions": { + "description": "[Optional] Actions for this card.", + "items": { + "$ref": "Action" + }, + "type": "array" + }, + "description": { + "$ref": "SafeHtmlProto", + "description": "[Optional] Description of the card." + }, + "subtitle": { + "$ref": "BackgroundColoredText", + "description": "[Optional] Subtitle of the card." + }, + "title": { + "$ref": "BackgroundColoredText", + "description": "[Optional] Title of the card." } }, "type": "object" }, - "DebugResponse": { - "description": "Debug Search Response.", - "id": "DebugResponse", + "Context": { + "id": "Context", "properties": { - "gsrRequest": { - "description": "Serialized string of GenericSearchRequest.", - "format": "byte", - "type": "string" + "app": { + "description": "[Optional] App where the card should be shown. If missing, the card will be shown in TOPAZ.", + "items": { + "enum": [ + "UNKNOWN_APP", + "TOPAZ", + "MOMA" + ], + "enumDescriptions": [ + "", + "", + "" + ], + "type": "string" + }, + "type": "array" }, - "gsrResponse": { - "description": "Serialized string of GenericSearchResponse.", - "format": "byte", + "dayOfWeek": { + "description": "[Optional] Day of week when the card should be shown, where 0 is Monday.", + "items": { + "format": "int32", + "type": "integer" + }, + "type": "array" + }, + "endDateSec": { + "description": "[Optional] Date (in seconds since epoch) when the card should stop being shown. If missing, end_date_sec will be set to Jan 1st, 2100.", + "format": "int64", "type": "string" }, - "searchResponse": { - "$ref": "SearchResponse", - "description": "Search response." - } - }, - "type": "object" - }, - "DeleteQueueItemsRequest": { - "id": "DeleteQueueItemsRequest", - "properties": { - "connectorName": { - "description": "The name of connector making this call. Format: datasources/{source_id}/connectors/{ID}", + "endDayOffsetSec": { + "description": "[Optional] End time in seconds, within a day, when the card should stop being shown if it's within [start_date_sec, end_date_sec]. If missing, this is set to 86400 (24 hours x 3600 sec/hour), i.e., midnight next day.", + "format": "int64", "type": "string" }, - "debugOptions": { - "$ref": "DebugOptions", - "description": "Common debug options." + "locale": { + "description": "[Optional] The locales for which the card should be triggered (e.g., en_US and en_CA). If missing, the card is going to show to clients regardless of their locale.", + "items": { + "type": "string" + }, + "type": "array" }, - "queue": { - "description": "The name of a queue to delete items from.", + "location": { + "description": "[Optional] Text-free locations where the card should be shown. This is expected to match the user's location in focus. If no location is specified, the card will be shown for any location.", + "items": { + "type": "string" + }, + "type": "array" + }, + "query": { + "description": "[Required only for Answer and RHS cards - will be ignored for Homepage] cards. It's the exact case-insensitive queries that will trigger the Answer or RHS card.", + "items": { + "type": "string" + }, + "type": "array" + }, + "startDateSec": { + "description": "[Optional] Date (in seconds since epoch) when the card should start being shown. If missing, start_date_sec will be Jan 1st, 1970 UTC.", + "format": "int64", + "type": "string" + }, + "startDayOffsetSec": { + "description": "[Optional] Start time in seconds, within a day, when the card should be shown if it's within [start_date_sec, end_date_sec]. If 0, the card will be shown from 12:00am on.", + "format": "int64", "type": "string" + }, + "surface": { + "description": "[Optional] Surface where the card should be shown in. If missing, the card will be shown in any surface.", + "items": { + "enum": [ + "UNKNOWN_SURFACE", + "DESKTOP", + "ANDROID", + "IOS", + "MOBILE", + "ANY" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "Any mobile device.", + "" + ], + "type": "string" + }, + "type": "array" + }, + "type": { + "description": "[Required] Type of the card (homepage, Answer or RHS).", + "items": { + "enum": [ + "UNKNOWN_CARD_TYPE", + "HOMEPAGE_CARD", + "ANSWER_CARD", + "RHS_CARD" + ], + "enumDescriptions": [ + "", + "", + "", + "" + ], + "type": "string" + }, + "type": "array" } }, "type": "object" }, - "DisplayedProperty": { - "description": "A reference to a top-level property within the object that should be displayed in search results. The values of the chosen properties is displayed in the search results along with the display label for that property if one is specified. If a display label is not specified, only the values is shown.", - "id": "DisplayedProperty", + "ContextAttribute": { + "description": "A named attribute associated with an item which can be used for influencing the ranking of the item based on the context in the request.", + "id": "ContextAttribute", "properties": { - "propertyName": { - "description": "The name of the top-level property as defined in a property definition for the object. If the name is not a defined property in the schema, an error is given when attempting to update the schema.", + "name": { + "description": "The name of the attribute. It should not be empty. The maximum length is 32 characters. The name must start with a letter and can only contain letters (A-Z, a-z) or numbers (0-9). The name will be normalized (lower-cased) before being matched.", "type": "string" + }, + "values": { + "description": "Text values of the attribute. The maximum number of elements is 10. The maximum length of an element in the array is 32 characters. The value will be normalized (lower-cased) before being matched.", + "items": { + "type": "string" + }, + "type": "array" } }, "type": "object" }, - "DoubleOperatorOptions": { - "description": "Used to provide a search operator for double properties. This is optional. Search operators let users restrict the query to specific fields relevant to the type of item being searched.", - "id": "DoubleOperatorOptions", + "CustomerIndexStats": { + "description": "Aggregation of items by status code as of the specified date.", + "id": "CustomerIndexStats", "properties": { - "operatorName": { - "description": "Indicates the operator name required in the query in order to use the double property in sorting or as a facet. The operator name can only contain lowercase letters (a-z). The maximum length is 32 characters.", - "type": "string" + "date": { + "$ref": "Date", + "description": "The date for which statistics were calculated." + }, + "itemCountByStatus": { + "description": "Number of items aggregrated by status code.", + "items": { + "$ref": "ItemCountByStatus" + }, + "type": "array" } }, "type": "object" }, - "DoublePropertyOptions": { - "description": "The options for double properties.", - "id": "DoublePropertyOptions", + "CustomerQueryStats": { + "id": "CustomerQueryStats", "properties": { - "operatorOptions": { - "$ref": "DoubleOperatorOptions", - "description": "If set, describes how the double should be used as a search operator." + "date": { + "$ref": "Date", + "description": "The date for which query stats were calculated. Stats calculated on the next day close to midnight are returned." + }, + "queryCountByStatus": { + "items": { + "$ref": "QueryCountByStatus" + }, + "type": "array" } }, "type": "object" }, - "DoubleValues": { - "description": "List of double values.", - "id": "DoubleValues", - "properties": { - "values": { - "items": { - "format": "double", - "type": "number" - }, - "type": "array" - } - }, - "type": "object" - }, - "DriveFollowUpRestrict": { - "description": "Drive follow-up search restricts (e.g. \"followup:suggestions\").", - "id": "DriveFollowUpRestrict", + "CustomerSearchApplicationStats": { + "description": "Search application stats for a customer for the given date.", + "id": "CustomerSearchApplicationStats", "properties": { - "type": { - "enum": [ - "UNSPECIFIED", - "FOLLOWUP_SUGGESTIONS", - "FOLLOWUP_ACTION_ITEMS" - ], - "enumDescriptions": [ - "", - "", - "" - ], + "count": { + "description": "The count of search applications for the date.", + "format": "int64", "type": "string" + }, + "date": { + "$ref": "Date", + "description": "The date for which search application stats were calculated." } }, "type": "object" }, - "DriveLocationRestrict": { - "description": "Drive location search restricts (e.g. \"is:starred\").", - "id": "DriveLocationRestrict", + "CustomerSessionStats": { + "id": "CustomerSessionStats", "properties": { - "type": { - "enum": [ - "UNSPECIFIED", - "TRASHED", - "STARRED" - ], - "enumDescriptions": [ - "", - "", - "" - ], + "date": { + "$ref": "Date", + "description": "The date for which session stats were calculated. Stats are calculated on the following day, close to midnight PST, and then returned." + }, + "searchSessionsCount": { + "description": "The count of search sessions on the day", + "format": "int64", "type": "string" } }, "type": "object" }, - "DriveMimeTypeRestrict": { - "description": "Drive mime-type search restricts (e.g. \"type:pdf\").", - "id": "DriveMimeTypeRestrict", + "CustomerSettings": { + "description": "Represents settings at a customer level.", + "id": "CustomerSettings", "properties": { - "type": { - "enum": [ - "UNSPECIFIED", - "PDF", - "DOCUMENT", - "PRESENTATION", - "SPREADSHEET", - "FORM", - "DRAWING", - "SCRIPT", - "MAP", - "IMAGE", - "AUDIO", - "VIDEO", - "FOLDER", - "ARCHIVE", - "SITE" - ], - "enumDescriptions": [ - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "" - ], - "type": "string" + "auditLoggingSettings": { + "$ref": "AuditLoggingSettings", + "description": "Audit Logging settings for the customer. If update_mask is empty then this field will be updated based on UpdateCustomerSettings request." + }, + "vpcSettings": { + "$ref": "VPCSettings", + "description": "VPC SC settings for the customer. If update_mask is empty then this field will be updated based on UpdateCustomerSettings request." } }, "type": "object" }, - "DriveTimeSpanRestrict": { - "description": "The time span search restrict (e.g. \"after:2017-09-11 before:2017-09-12\").", - "id": "DriveTimeSpanRestrict", + "CustomerUserStats": { + "id": "CustomerUserStats", "properties": { - "type": { - "enum": [ - "UNSPECIFIED", - "TODAY", - "YESTERDAY", - "LAST_7_DAYS", - "LAST_30_DAYS", - "LAST_90_DAYS" - ], - "enumDescriptions": [ - "", - "", - "", - "", - "Not Enabled", - "Not Enabled" - ], + "date": { + "$ref": "Date", + "description": "The date for which session stats were calculated. Stats calculated on the next day close to midnight are returned." + }, + "oneDayActiveUsersCount": { + "description": "The count of unique active users in the past one day", + "format": "int64", + "type": "string" + }, + "sevenDaysActiveUsersCount": { + "description": "The count of unique active users in the past seven days", + "format": "int64", + "type": "string" + }, + "thirtyDaysActiveUsersCount": { + "description": "The count of unique active users in the past thirty days", + "format": "int64", "type": "string" } }, "type": "object" }, - "EmailAddress": { - "description": "A person's email address.", - "id": "EmailAddress", + "DataSource": { + "description": "Datasource is a logical namespace for items to be indexed. All items must belong to a datasource. This is the prerequisite before items can be indexed into Cloud Search. ", + "id": "DataSource", "properties": { - "customType": { - "description": "If the value of type is custom, this property contains the custom type string.", - "type": "string" + "disableModifications": { + "description": "If true, sets the datasource to read-only mode. In read-only mode, the Indexing API rejects any requests to index or delete items in this source. Enabling read-only mode does not stop the processing of previously accepted data.", + "type": "boolean" }, - "emailAddress": { - "description": "The email address.", + "disableServing": { + "description": "Disable serving any search or assist results.", + "type": "boolean" + }, + "displayName": { + "description": "Required. Display name of the datasource The maximum length is 300 characters.", "type": "string" }, - "emailUrl": { - "description": "The URL to send email.", + "indexingServiceAccounts": { + "description": "List of service accounts that have indexing access.", + "items": { + "type": "string" + }, + "type": "array" + }, + "itemsVisibility": { + "description": "This field restricts visibility to items at the datasource level. Items within the datasource are restricted to the union of users and groups included in this field. Note that, this does not ensure access to a specific item, as users need to have ACL permissions on the contained items. This ensures a high level access on the entire datasource, and that the individual items are not shared outside this visibility.", + "items": { + "$ref": "GSuitePrincipal" + }, + "type": "array" + }, + "name": { + "description": "The name of the datasource resource. Format: datasources/{source_id}. The name is ignored when creating a datasource.", "type": "string" }, - "primary": { - "description": "Indicates if this is the user's primary email. Only one entry can be marked as primary.", + "operationIds": { + "description": "IDs of the Long Running Operations (LROs) currently running for this schema.", + "items": { + "type": "string" + }, + "type": "array" + }, + "returnThumbnailUrls": { + "description": "Can a user request to get thumbnail URI for Items indexed in this data source.", "type": "boolean" }, - "type": { - "description": "The type of the email account. Acceptable values are: \"custom\", \"home\", \"other\", \"work\".", + "shortName": { + "description": "A short name or alias for the source. This value will be used to match the 'source' operator. For example, if the short name is ** then queries like *source:* will only return results for this source. The value must be unique across all datasources. The value must only contain alphanumeric characters (a-zA-Z0-9). The value cannot start with 'google' and cannot be one of the following: mail, gmail, docs, drive, groups, sites, calendar, hangouts, gplus, keep, people, teams. Its maximum length is 32 characters.", "type": "string" } }, "type": "object" }, - "EnterpriseTopazFrontendTeamsLink": { - "id": "EnterpriseTopazFrontendTeamsLink", + "DataSourceIndexStats": { + "description": "Aggregation of items by status code as of the specified date.", + "id": "DataSourceIndexStats", "properties": { - "type": { - "description": "The identifying link type", - "type": "string" + "date": { + "$ref": "Date", + "description": "The date for which index stats were calculated. If the date of request is not the current date then stats calculated on the next day are returned. Stats are calculated close to mid night in this case. If date of request is current date, then real time stats are returned." }, - "url": { - "$ref": "SafeUrlProto" + "itemCountByStatus": { + "description": "Number of items aggregrated by status code.", + "items": { + "$ref": "ItemCountByStatus" + }, + "type": "array" } }, "type": "object" }, - "EnterpriseTopazFrontendTeamsPersonCorePhoneNumber": { - "id": "EnterpriseTopazFrontendTeamsPersonCorePhoneNumber", + "DataSourceRestriction": { + "description": "Restriction on Datasource.", + "id": "DataSourceRestriction", "properties": { - "phoneNumber": { - "description": "Phone number in no particular format (as comes from the Focus profile).", - "type": "string" - }, - "phoneUrl": { - "$ref": "SafeUrlProto", - "description": "Phone number URL" + "filterOptions": { + "description": "Filter options restricting the results. If multiple filters are present, they are grouped by object type before joining. Filters with the same object type are joined conjunctively, then the resulting expressions are joined disjunctively. The maximum number of elements is 20. NOTE: Suggest API supports only few filters at the moment: \"objecttype\", \"type\" and \"mimetype\". For now, schema specific filters cannot be used to filter suggestions.", + "items": { + "$ref": "FilterOptions" + }, + "type": "array" }, - "type": { - "enum": [ - "UNKNOWN", - "MOBILE", - "OFFICE", - "OTHER" - ], - "enumDescriptions": [ - "", - "", - "", - "" - ], - "type": "string" + "source": { + "$ref": "Source", + "description": "The source of restriction." } }, "type": "object" }, - "EnterpriseTopazSidekickAgendaEntry": { - "description": "An AgendaEntry, e.g., a Calendar Event.", - "id": "EnterpriseTopazSidekickAgendaEntry", + "Date": { + "description": "Represents a whole calendar date, for example a date of birth. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the [Proleptic Gregorian Calendar](https://en.wikipedia.org/wiki/Proleptic_Gregorian_calendar). The date must be a valid calendar date between the year 1 and 9999.", + "id": "Date", "properties": { - "agendaItemUrl": { - "description": "URL of the agenda item.", - "type": "string" - }, - "chronology": { - "description": "The chronology from the present.", - "enum": [ - "STALE", - "ALL_DAY", - "PAST", - "RECENTLY_PAST", - "PRESENT", - "NEAR_FUTURE", - "FUTURE" - ], - "enumDescriptions": [ - "Stale.", - "All day.", - "Past.", - "Recently past.", - "Present.", - "Near future.", - "Future." - ], - "type": "string" - }, - "creator": { - "$ref": "EnterpriseTopazSidekickPerson", - "description": "Person who created the event." - }, - "currentUserAttendingStatus": { - "description": "Attendance status for the current user making the request. This is a convenience data member in order to avoid figuring out the same by iterating the invitee list above on the caller side.", - "enum": [ - "AWAITING", - "YES", - "NO", - "MAYBE" - ], - "enumDescriptions": [ - "Awaiting for the user to set the status.", - "Attending.", - "Not attending.", - "Tentatively attending." - ], - "type": "string" - }, - "description": { - "description": "Description of the agenda item (i.e., typically, summary in calendar event).", - "type": "string" - }, - "document": { - "description": "Items related to the current AgendaEntry. E.g., related drive/mail/groups documents.", - "items": { - "$ref": "EnterpriseTopazSidekickCommonDocument" - }, - "type": "array" - }, - "endDate": { - "description": "End date \"Friday, August 26\" in the user's timezone.", - "type": "string" - }, - "endTime": { - "description": "End time (HH:mm) in the user's timezone.", - "type": "string" - }, - "endTimeMs": { - "description": "End time in milliseconds", - "format": "int64", - "type": "string" - }, - "eventId": { - "description": "Event id provided by Calendar API.", - "type": "string" - }, - "guestsCanInviteOthers": { - "description": "Whether the guests can invite other guests.", - "type": "boolean" - }, - "guestsCanModify": { - "description": "Whether the guests can modify the event.", - "type": "boolean" - }, - "guestsCanSeeGuests": { - "description": "Whether the guests of the event can be seen. If false, the user is going to be reported as the only attendee to the meeting, even though there may be more attendees.", - "type": "boolean" - }, - "hangoutId": { - "description": "Hangout meeting identifier.", - "type": "string" - }, - "hangoutUrl": { - "description": "Absolute URL for the Hangout meeting.", - "type": "string" - }, - "invitee": { - "description": "People attending the meeting.", - "items": { - "$ref": "EnterpriseTopazSidekickPerson" - }, - "type": "array" - }, - "isAllDay": { - "description": "Whether the entry lasts all day.", - "type": "boolean" - }, - "lastModificationTimeMs": { - "description": "Last time the event was modified.", - "format": "int64", - "type": "string" - }, - "location": { - "description": "Agenda item location.", - "type": "string" - }, - "notifyToUser": { - "description": "Whether this should be notified to the user.", - "type": "boolean" - }, - "otherAttendeesExcluded": { - "description": "Whether guest list is not returned because number of attendees is too large.", - "type": "boolean" - }, - "requesterIsOwner": { - "description": "Whether the requester is the owner of the agenda entry.", - "type": "boolean" - }, - "showFullEventDetailsToUse": { - "description": "Whether the details of this entry should be displayed to the user.", - "type": "boolean" - }, - "startDate": { - "description": "Start date \"Friday, August 26\" in the user's timezone.", - "type": "string" + "day": { + "description": "Day of month. Must be from 1 to 31 and valid for the year and month.", + "format": "int32", + "type": "integer" }, - "startTime": { - "description": "Start time (HH:mm) in the user's timezone.", - "type": "string" + "month": { + "description": "Month of date. Must be from 1 to 12.", + "format": "int32", + "type": "integer" }, - "startTimeMs": { - "description": "Start time in milliseconds.", - "format": "int64", + "year": { + "description": "Year of date. Must be from 1 to 9999.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "DateOperatorOptions": { + "description": "Optional. Provides a search operator for date properties. Search operators let users restrict the query to specific fields relevant to the type of item being searched.", + "id": "DateOperatorOptions", + "properties": { + "greaterThanOperatorName": { + "description": "Indicates the operator name required in the query in order to isolate the date property using the greater-than operator. For example, if greaterThanOperatorName is *closedafter* and the property's name is *closeDate*, then queries like *closedafter:* show results only where the value of the property named *closeDate* is later than **. The operator name can only contain lowercase letters (a-z). The maximum length is 32 characters.", "type": "string" }, - "timeZone": { - "description": "User's calendar timezone;", + "lessThanOperatorName": { + "description": "Indicates the operator name required in the query in order to isolate the date property using the less-than operator. For example, if lessThanOperatorName is *closedbefore* and the property's name is *closeDate*, then queries like *closedbefore:* show results only where the value of the property named *closeDate* is earlier than **. The operator name can only contain lowercase letters (a-z). The maximum length is 32 characters.", "type": "string" }, - "title": { - "description": "Title of the agenda item.", + "operatorName": { + "description": "Indicates the actual string required in the query in order to isolate the date property. For example, suppose an issue tracking schema object has a property named *closeDate* that specifies an operator with an operatorName of *closedon*. For searches on that data, queries like *closedon:* show results only where the value of the *closeDate* property matches **. By contrast, a search that uses the same ** without an operator returns all items where ** matches the value of any String properties or text within the content field for the indexed datasource. The operator name can only contain lowercase letters (a-z). The maximum length is 32 characters.", "type": "string" } }, "type": "object" }, - "EnterpriseTopazSidekickAgendaGroupCardProto": { - "id": "EnterpriseTopazSidekickAgendaGroupCardProto", + "DatePropertyOptions": { + "description": "The options for date properties.", + "id": "DatePropertyOptions", "properties": { - "agendaItem": { + "operatorOptions": { + "$ref": "DateOperatorOptions", + "description": "If set, describes how the date should be used as a search operator." + } + }, + "type": "object" + }, + "DateValues": { + "description": "List of date values.", + "id": "DateValues", + "properties": { + "values": { "items": { - "$ref": "EnterpriseTopazSidekickAgendaItem" + "$ref": "Date" }, "type": "array" - }, - "context": { - "$ref": "EnterpriseTopazSidekickAgendaGroupCardProtoContext" - }, - "currentAgendaItem": { - "$ref": "EnterpriseTopazSidekickAgendaItem" } }, "type": "object" }, - "EnterpriseTopazSidekickAgendaGroupCardProtoContext": { - "description": "The context that resulted in the generation of the card.", - "id": "EnterpriseTopazSidekickAgendaGroupCardProtoContext", + "DebugOptions": { + "description": "Shared request debug options for all cloudsearch RPC methods.", + "id": "DebugOptions", "properties": { - "context": { - "description": "User friendly free text that describes the context of the card (e.g. \"Next meeting with Bob\"). This is largely only applicable when the card is generated from a query.", - "type": "string" - }, - "date": { - "description": "Localized free text that describes the dates represented by the card. Currently, the card will only represent a single day.", - "type": "string" - }, - "eventsRestrict": { - "description": "Represents restrictions applied to the events requested in the user's query.", - "enum": [ - "NONE", - "NEXT_MEETING" - ], - "enumDescriptions": [ - "No specific event was requested.", - "The next meeting was requested." - ], - "type": "string" + "enableDebugging": { + "description": "If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field.", + "type": "boolean" } }, "type": "object" }, - "EnterpriseTopazSidekickAgendaItem": { - "id": "EnterpriseTopazSidekickAgendaItem", + "DebugResponse": { + "description": "Debug Search Response.", + "id": "DebugResponse", "properties": { - "conflictedGroup": { - "$ref": "EnterpriseTopazSidekickConflictingEventsCardProto" + "gsrRequest": { + "description": "Serialized string of GenericSearchRequest.", + "format": "byte", + "type": "string" }, - "gapBefore": { - "$ref": "EnterpriseTopazSidekickGap" + "gsrResponse": { + "description": "Serialized string of GenericSearchResponse.", + "format": "byte", + "type": "string" }, - "meeting": { - "$ref": "EnterpriseTopazSidekickAgendaEntry" + "searchResponse": { + "$ref": "SearchResponse", + "description": "Search response." } }, "type": "object" }, - "EnterpriseTopazSidekickAnswerAnswerList": { - "description": "A list of answers represented as free text.", - "id": "EnterpriseTopazSidekickAnswerAnswerList", + "DefaultBlockingDataProto": { + "description": "Next ID: 3", + "id": "DefaultBlockingDataProto", "properties": { - "labeledAnswer": { - "description": "Answers that have a corresponding label.", + "types": { "items": { - "$ref": "EnterpriseTopazSidekickAnswerAnswerListLabeledAnswer" + "enum": [ + "BLOCKING_TYPE_UNSPECIFIED", + "BLOCKING_TYPE_DEFAULT_BLOCKED", + "BLOCKING_TYPE_DEFAULT_BLOCKED_NON_TYPE_COUNTRY" + ], + "enumDescriptions": [ + "The default value. Not actually used by IPGeo/Oolong.", + "Under go/embargo.", + "A feature that is not a TYPE_COUNTRY and is under go/embargo. Discouraged." + ], + "type": "string" }, "type": "array" }, + "version": { + "description": "Version ID of the current list of blocked countries and sanctions areas, based on which the types field was computed.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "DeleteQueueItemsRequest": { + "id": "DeleteQueueItemsRequest", + "properties": { + "connectorName": { + "description": "The name of connector making this call. Format: datasources/{source_id}/connectors/{ID}", + "type": "string" + }, + "debugOptions": { + "$ref": "DebugOptions", + "description": "Common debug options." + }, + "queue": { + "description": "The name of a queue to delete items from.", + "type": "string" + } + }, + "type": "object" + }, + "DisabledIcingPackageCorpus": { + "id": "DisabledIcingPackageCorpus", + "properties": { + "corpusName": { + "description": "The name of an individual corpus within the given app. When unset, this means that all corpora for the given package are disabled.", + "type": "string" + }, + "packageName": { + "description": "The package name of an app that the user disabled. This is required.", + "type": "string" + } + }, + "type": "object" + }, + "DisplayedProperty": { + "description": "A reference to a top-level property within the object that should be displayed in search results. The values of the chosen properties is displayed in the search results along with the display label for that property if one is specified. If a display label is not specified, only the values is shown.", + "id": "DisplayedProperty", + "properties": { + "propertyName": { + "description": "The name of the top-level property as defined in a property definition for the object. If the name is not a defined property in the schema, an error is given when attempting to update the schema.", + "type": "string" + } + }, + "type": "object" + }, + "DoubleOperatorOptions": { + "description": "Used to provide a search operator for double properties. This is optional. Search operators let users restrict the query to specific fields relevant to the type of item being searched.", + "id": "DoubleOperatorOptions", + "properties": { + "operatorName": { + "description": "Indicates the operator name required in the query in order to use the double property in sorting or as a facet. The operator name can only contain lowercase letters (a-z). The maximum length is 32 characters.", + "type": "string" + } + }, + "type": "object" + }, + "DoublePropertyOptions": { + "description": "The options for double properties.", + "id": "DoublePropertyOptions", + "properties": { + "operatorOptions": { + "$ref": "DoubleOperatorOptions", + "description": "If set, describes how the double should be used as a search operator." + } + }, + "type": "object" + }, + "DoubleValues": { + "description": "List of double values.", + "id": "DoubleValues", + "properties": { + "values": { + "items": { + "format": "double", + "type": "number" + }, + "type": "array" + } + }, + "type": "object" + }, + "DriveFollowUpRestrict": { + "description": "Drive follow-up search restricts (e.g. \"followup:suggestions\").", + "id": "DriveFollowUpRestrict", + "properties": { "type": { - "description": "Answer type.", "enum": [ - "UNKNOWN", - "PERSON_ADDRESS", - "PERSON_BIRTHDAY", - "PERSON_DEPARTMENT", - "PERSON_DESK_LOCATION", - "PERSON_EMAIL", - "PERSON_JOB_TITLE", - "PERSON_PHONE" + "UNSPECIFIED", + "FOLLOWUP_SUGGESTIONS", + "FOLLOWUP_ACTION_ITEMS" ], "enumDescriptions": [ - "", - "", - "", - "", - "", "", "", "" @@ -3193,301 +4004,178 @@ }, "type": "object" }, - "EnterpriseTopazSidekickAnswerAnswerListLabeledAnswer": { - "description": "An answer with a corresponding label.", - "id": "EnterpriseTopazSidekickAnswerAnswerListLabeledAnswer", + "DriveLocationRestrict": { + "description": "Drive location search restricts (e.g. \"is:starred\").", + "id": "DriveLocationRestrict", "properties": { - "answer": { - "description": "The free text answer.", - "type": "string" - }, - "label": { - "description": "A localized label for the answer (e.g. \"Cell phone\" vs \"Desk phone\").", + "type": { + "enum": [ + "UNSPECIFIED", + "TRASHED", + "STARRED" + ], + "enumDescriptions": [ + "", + "", + "" + ], "type": "string" } }, "type": "object" }, - "EnterpriseTopazSidekickAnswerSuggestedQueryAnswerCard": { - "description": "Contains a list of suggested queries. Allows the user to determine what natural language queries they can ask Cloud Search (e.g. \"what can I search for?\").", - "id": "EnterpriseTopazSidekickAnswerSuggestedQueryAnswerCard", + "DriveMimeTypeRestrict": { + "description": "Drive mime-type search restricts (e.g. \"type:pdf\").", + "id": "DriveMimeTypeRestrict", "properties": { - "suggestedQueryCategory": { - "description": "A list of queries to suggest.", - "items": { - "$ref": "EnterpriseTopazSidekickAnswerSuggestedQueryCategory" - }, - "type": "array" + "type": { + "enum": [ + "UNSPECIFIED", + "PDF", + "DOCUMENT", + "PRESENTATION", + "SPREADSHEET", + "FORM", + "DRAWING", + "SCRIPT", + "MAP", + "IMAGE", + "AUDIO", + "VIDEO", + "FOLDER", + "ARCHIVE", + "SITE" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "" + ], + "type": "string" } }, "type": "object" }, - "EnterpriseTopazSidekickAnswerSuggestedQueryCategory": { - "description": "Contains a list of suggested queries for a single category.", - "id": "EnterpriseTopazSidekickAnswerSuggestedQueryCategory", + "DriveTimeSpanRestrict": { + "description": "The time span search restrict (e.g. \"after:2017-09-11 before:2017-09-12\").", + "id": "DriveTimeSpanRestrict", "properties": { - "category": { - "description": "The query list category.", + "type": { "enum": [ - "UNKNOWN", - "CALENDAR", - "DOCUMENT", - "PEOPLE" + "UNSPECIFIED", + "TODAY", + "YESTERDAY", + "LAST_7_DAYS", + "LAST_30_DAYS", + "LAST_90_DAYS" ], "enumDescriptions": [ - "Unknown.", - "Calendar based queries (e.g. \"my agenda for tomorrow\").", - "Document based queries (e.g. \"files shared with me\").", - "People based queries (e.g. \"what is x's email address?\")." + "", + "", + "", + "", + "Not Enabled", + "Not Enabled" ], "type": "string" + } + }, + "type": "object" + }, + "EmailAddress": { + "description": "A person's email address.", + "id": "EmailAddress", + "properties": { + "customType": { + "description": "If the value of type is custom, this property contains the custom type string.", + "type": "string" }, - "isEnabled": { - "description": "Whether this category is enabled.", + "emailAddress": { + "description": "The email address.", + "type": "string" + }, + "emailUrl": { + "description": "The URL to send email.", + "type": "string" + }, + "primary": { + "description": "Indicates if this is the user's primary email. Only one entry can be marked as primary.", "type": "boolean" }, - "query": { - "description": "List of suggested queries to show the user.", - "items": { - "type": "string" - }, - "type": "array" + "type": { + "description": "The type of the email account. Acceptable values are: \"custom\", \"home\", \"other\", \"work\".", + "type": "string" } }, "type": "object" }, - "EnterpriseTopazSidekickAssistCardProto": { - "description": "Wrapper proto for the Assist cards.", - "id": "EnterpriseTopazSidekickAssistCardProto", + "EnterpriseTopazFrontendTeamsLink": { + "id": "EnterpriseTopazFrontendTeamsLink", "properties": { - "agendaGroupCardProto": { - "$ref": "EnterpriseTopazSidekickAgendaGroupCardProto", - "description": "Agenda group card." - }, - "cardMetadata": { - "$ref": "EnterpriseTopazSidekickCardMetadata", - "description": "Card metadata such as chronology and render mode of the card." + "type": { + "description": "The identifying link type", + "type": "string" }, - "cardType": { - "description": "Card type.", - "enum": [ - "UNKNOWN_TYPE", - "AGENDA", - "CHANGELISTS", - "CONFLICTING_MEETINGS", - "CREATE_NOTES_FOR_MEETING", - "CREATE_NOTES_FOR_MEETING_REQUEST", - "CUSTOMER_NEWS", - "FIND_MEETING_TIME", - "NEXT_MEETING", - "PERSONALIZED_DOCS", - "TRENDING_DOCS", - "UPCOMING_TRIP", - "SUMMARY", - "MEETINGS", - "HOMEPAGE", - "SHARE_MEETING_DOCS", - "DISCOVER_PEOPLE", - "HOMEPAGE_V3", - "AGENDA_GROUP", - "WORK_IN_PROGRESS", - "GET_AND_KEEP_AHEAD", - "GENERIC_ANSWER_CARD", - "THIRD_PARTY_ANSWER_CARD", - "DOMAIN_TRENDING_DOCS", - "TEAM_TRENDING_DOCS", - "DOCUMENT_LIST_ANSWER_CARD", - "SUGGESTED_QUERY_ANSWER_CARD", - "PERSON_ANSWER_CARD", - "RELATED_PEOPLE_ANSWER_CARD", - "PERSON_KNOWLEDGE_CARD", - "PEOPLE_SEARCH_PROMOTION_CARD" - ], - "enumDeprecated": [ - false, - true, - true, - true, - true, - true, - true, - false, - true, - true, - true, - true, - true, - true, - true, - true, - true, - true, - false, - false, - false, - false, - false, - true, - true, - false, - false, - false, - false, - false, - false - ], - "enumDescriptions": [ - "The default type, an unknown card type.", - "The user's agenda for the day.", - "Changelists.", - "Any group of meetings for the day that are overlapping.", - "Create notes for a meeting specified in the request.", - "Create notes for meeting query.", - "News about your SFDC customers.", - "Find a time for two people to meet.", - "The user's next non-declined meeting.", - "Important documents for you since you have viewed them in the last month and there's some action going on.", - "Documents that are trending in your company. A TRENDING_DOCS card can be of two types: TRENDING_IN_COLLABORATORS (i.e., Stay in the Loop) and TRENDING_IN_DOMAIN (i.e., Popular Content). Use DOMAIN_TRENDING_DOCS/TEAM_TRENDING_DOCS instead.", - "An upcoming trip with all trip information along with calendar events in the destination timezone.", - "The Morning/Evening Summary Card for the next working day.", - "A meeting. When requesting meetings, the service will return a MEETING card for each meeting the user has in his agenda.", - "All cards related to the homepage (agenda, conflicting-meetings, summary, etc...). This type should no longer be used. Use HOMEPAGE_V3 instead.", - "A card to with specifics to share meeting documents with all attendees.", - "Represents a set of users that the requesting user has low affinity with.", - "All cards related to the homepage-v3 (agenda-group, WIP, etc...)", - "A group of agenda-events (meeting, conflicts)", - "The documents that you were recently working on.", - "(v3) The \"get and keep ahead\" card for today and tomorrow", - "Generic answer card.", - "Third party answer card.", - "Documents that are trending in your company/domain (i.e., Popular Content).", - "Documents that are trending in your team (i.e., Stay in the Loop).", - "Documents that match the user's query (e.g. sheets shared with me).", - "A help card that provides examples of queries the user can ask.", - "Answer card for a single person (e.g. what is x's phone number).", - "Answer card for a list of people related to the person that is the subject of the query (e.g. who reports to x).", - "Knowledge card for a single person and their related people.", - "People Search promotion card." - ], - "type": "string" - }, - "conflictingMeetingsCard": { - "$ref": "EnterpriseTopazSidekickConflictingEventsCardProto", - "deprecated": true, - "description": "Conflicting events card." - }, - "documentListCard": { - "$ref": "EnterpriseTopazSidekickDocumentPerCategoryList", - "description": "Answer card for documents that are applicable to the current query." - }, - "documentsWithMentions": { - "$ref": "EnterpriseTopazSidekickDocumentPerCategoryList", - "deprecated": true, - "description": "Documents with mentions." - }, - "findMeetingTimeCard": { - "$ref": "EnterpriseTopazSidekickFindMeetingTimeCardProto", - "description": "Find meeting time card." - }, - "genericAnswerCard": { - "$ref": "EnterpriseTopazSidekickGenericAnswerCard", - "description": "Generic answer card." - }, - "getAndKeepAheadCard": { - "$ref": "EnterpriseTopazSidekickGetAndKeepAheadCardProto", - "description": "Get and keep ahead card." - }, - "meeting": { - "$ref": "EnterpriseTopazSidekickAgendaEntry", - "deprecated": true, - "description": "Meeting card." - }, - "meetingNotesCard": { - "$ref": "EnterpriseTopazSidekickMeetingNotesCardProto", - "description": "Meeting notes card." - }, - "meetingNotesCardRequest": { - "$ref": "EnterpriseTopazSidekickMeetingNotesCardRequest", - "description": "Request for meeting notes card." - }, - "peopleDisambiguationCard": { - "$ref": "EnterpriseTopazSidekickPeopleDisambiguationCard", - "description": "The people disambiguation card." - }, - "peoplePromotionCard": { - "$ref": "PeoplePromotionCard", - "description": "People Search promotion card." - }, - "personAnswerCard": { - "$ref": "EnterpriseTopazSidekickPeopleAnswerPersonAnswerCard", - "description": "Answer card that represents a single person." - }, - "personProfileCard": { - "$ref": "EnterpriseTopazSidekickPersonProfileCard", - "description": "Full profile card." - }, - "personalizedDocsCard": { - "$ref": "EnterpriseTopazSidekickPersonalizedDocsCardProto", - "deprecated": true, - "description": "Card with recommended documents for the user." - }, - "relatedPeopleAnswerCard": { - "$ref": "EnterpriseTopazSidekickPeopleAnswerRelatedPeopleAnswerCard", - "description": "Answer card that represents a list of people related to a person." - }, - "shareMeetingDocsCard": { - "$ref": "EnterpriseTopazSidekickShareMeetingDocsCardProto", - "deprecated": true, - "description": "Sahre meeting docs card." - }, - "sharedDocuments": { - "$ref": "EnterpriseTopazSidekickDocumentPerCategoryList", - "deprecated": true, - "description": "Shared documents." - }, - "suggestedQueryAnswerCard": { - "$ref": "EnterpriseTopazSidekickAnswerSuggestedQueryAnswerCard", - "description": "Answer card for what natural language queries the user can ask." - }, - "thirdPartyAnswerCard": { - "$ref": "ThirdPartyGenericCard", - "description": "Third party answer cards." - }, - "workInProgressCardProto": { - "$ref": "EnterpriseTopazSidekickRecentDocumentsCardProto", - "description": "Work In Progress card." + "url": { + "$ref": "SafeUrlProto" } }, "type": "object" }, - "EnterpriseTopazSidekickCardMetadata": { - "description": "Card metadata.", - "id": "EnterpriseTopazSidekickCardMetadata", + "EnterpriseTopazFrontendTeamsPersonCorePhoneNumber": { + "id": "EnterpriseTopazFrontendTeamsPersonCorePhoneNumber", "properties": { - "cardCategory": { - "description": "Declares a preference for how this card should be packed in MSCR. All cards in a response must correspond to a single category. As a result, cards may be dropped from the response if this field is set. Any card that does not match the category of the card with the highest priority in the response will be dropped.", + "phoneNumber": { + "description": "Phone number in no particular format (as comes from the Focus profile).", + "type": "string" + }, + "phoneUrl": { + "$ref": "SafeUrlProto", + "description": "Phone number URL" + }, + "type": { "enum": [ - "DEFAULT", - "ANSWER", - "KNOWLEDGE", - "HOMEPAGE" + "UNKNOWN", + "MOBILE", + "OFFICE", + "OTHER" ], "enumDescriptions": [ - "Let MSCR decide how this card should be packed. Most cards should choose this type. This type should largely be considered equivalent to ANSWER. However, this is not guaranteed to be the case as the request to MSCR may override the static configuration.", - "This card should be rendered as an answer card.", - "This card should be rendered as a knowledge card (a non-organic result).", - "This card should be rendered in the Homepage." + "", + "", + "", + "" ], "type": "string" - }, - "cardId": { - "description": "An ID to identify the card and match actions to it. Be thoughtful of new card IDs since actions will be associated to that ID. E.g., if two card IDs collide, the system will think that the actions have been applied to the same card. Similarly, if EAS can return multiple cards of the same type (e.g., Meetings), ensure that the card_id identifies a given instance of the card so that, e.g., dismissals only affect the dismissed card as opposed to affecting all meeting cards.", + } + }, + "type": "object" + }, + "EnterpriseTopazSidekickAgendaEntry": { + "description": "An AgendaEntry, e.g., a Calendar Event.", + "id": "EnterpriseTopazSidekickAgendaEntry", + "properties": { + "agendaItemUrl": { + "description": "URL of the agenda item.", "type": "string" }, "chronology": { - "description": "Chronology.", + "description": "The chronology from the present.", "enum": [ - "UNKNOWN", + "STALE", + "ALL_DAY", "PAST", "RECENTLY_PAST", "PRESENT", @@ -3495,7 +4183,8 @@ "FUTURE" ], "enumDescriptions": [ - "Unknown chronology (default).", + "Stale.", + "All day.", "Past.", "Recently past.", "Present.", @@ -3504,2817 +4193,16507 @@ ], "type": "string" }, - "debugInfo": { - "description": "Debug info (only reported if request's debug_level > 0).", - "type": "string" - }, - "nlpMetadata": { - "$ref": "EnterpriseTopazSidekickNlpMetadata", - "description": "Information about the NLP done to get the card." - }, - "rankingParams": { - "$ref": "EnterpriseTopazSidekickRankingParams", - "description": "Ranking params." + "creator": { + "$ref": "EnterpriseTopazSidekickPerson", + "description": "Person who created the event." }, - "renderMode": { - "description": "Render mode.", - "enum": [ - "UNKNOWN_RENDER", - "COLLAPSED", - "EXPANDED" - ], - "enumDescriptions": [ - "Unknown mode (default).", - "Collapsed.", - "Expanded." - ], - "type": "string" - } - }, - "type": "object" - }, - "EnterpriseTopazSidekickCommonDebugInfo": { - "description": "Container of debugging information in all object levels. Extend as needed.", - "id": "EnterpriseTopazSidekickCommonDebugInfo", - "properties": { - "message": { - "description": "Debug message.", - "type": "string" - } - }, - "type": "object" - }, - "EnterpriseTopazSidekickCommonDocument": { - "description": "Representation of a document. NEXT_TAG: 15", - "id": "EnterpriseTopazSidekickCommonDocument", - "properties": { - "accessType": { - "description": "Access type, i.e., whether the user has access to the document or not.", + "currentUserAttendingStatus": { + "description": "Attendance status for the current user making the request. This is a convenience data member in order to avoid figuring out the same by iterating the invitee list above on the caller side.", "enum": [ - "UNKNOWN_ACCESS", - "ALLOWED", - "NOT_ALLOWED" + "AWAITING", + "YES", + "NO", + "MAYBE" ], "enumDescriptions": [ - "Unknown access type.", - "Access allowed.", - "Access not allowed." + "Awaiting for the user to set the status.", + "Attending.", + "Not attending.", + "Tentatively attending." ], "type": "string" }, - "debugInfo": { - "$ref": "EnterpriseTopazSidekickCommonDebugInfo", - "description": "Information for debugging." - }, - "documentId": { - "description": "Document id.", + "description": { + "description": "Description of the agenda item (i.e., typically, summary in calendar event).", "type": "string" }, - "driveDocumentMetadata": { - "$ref": "EnterpriseTopazSidekickCommonDocumentDriveDocumentMetadata", - "description": "Drive document metadata." + "document": { + "description": "Items related to the current AgendaEntry. E.g., related drive/mail/groups documents.", + "items": { + "$ref": "EnterpriseTopazSidekickCommonDocument" + }, + "type": "array" }, - "genericUrl": { - "description": "Generic Drive-based url in the format of drive.google.com/open to be used for deeplink", + "endDate": { + "description": "End date \"Friday, August 26\" in the user's timezone.", "type": "string" }, - "justification": { - "$ref": "EnterpriseTopazSidekickCommonDocumentJustification", - "description": "Justification on why the document is selected." - }, - "mimeType": { - "description": "MIME type", + "endTime": { + "description": "End time (HH:mm) in the user's timezone.", "type": "string" }, - "provenance": { - "deprecated": true, - "description": "Document provenance.", - "enum": [ - "UNKNOWN_PROVENANCE", - "CALENDAR_DESCRIPTION", - "CALENDAR_ATTACHMENT", - "MINED", - "CALENDAR_ASSIST_ATTACHMENT" - ], - "enumDescriptions": [ - "Unknown provenance.", - "Calendar event description.", - "Calendar event attachment.", - "Mined (extracted by some offline/online analysis).", - "Attachment created by enterprise assist." - ], + "endTimeMs": { + "description": "End time in milliseconds", + "format": "int64", "type": "string" }, - "reason": { - "deprecated": true, - "description": "Justification of why this document is being returned.", - "enum": [ - "UNKNOWN", - "TRENDING_IN_COLLABORATORS", - "TRENDING_IN_DOMAIN", - "FREQUENTLY_VIEWED", - "FREQUENTLY_EDITED", - "NEW_UPDATES", - "NEW_COMMENTS", - "EVENT_DESCRIPTION", - "EVENT_ATTACHMENT", - "EVENT_METADATA_ATTACHMENT", - "MINED_DOCUMENT", - "NEW_MENTIONS", - "NEW_SHARES" - ], - "enumDescriptions": [ - "Unknown justification.", - "Popular documents within collaborators.", - "Popular documents within the domain.", - "Documents being reviewed frequently by the current user .", - "Documents being edited frequently by the current user .", - "Documents updated since user's last visit.", - "Documents that receive comments since user's last visit.", - "Documents in the calendar event description.", - "Documents in the calendar event attachments section.", - "Documents attached in calendar event metadata instead of the attachment section. Event metadata is not visible to the final user. Enterprise assist uses this metadata to store auto-generated documents such as meeting notes.", - "Documents mined, and so, probably related to the request context. For example, this category includes documents related to a meeting.", - "Documents that contains mentions of the user.", - "Documents that are shared with the user." - ], + "eventId": { + "description": "Event id provided by Calendar API.", "type": "string" }, - "snippet": { - "description": "A sampling of the text from the document.", - "type": "string" + "guestsCanInviteOthers": { + "description": "Whether the guests can invite other guests.", + "type": "boolean" }, - "thumbnailUrl": { - "description": "Thumbnail URL.", - "type": "string" + "guestsCanModify": { + "description": "Whether the guests can modify the event.", + "type": "boolean" }, - "title": { - "description": "Title of the document.", - "type": "string" + "guestsCanSeeGuests": { + "description": "Whether the guests of the event can be seen. If false, the user is going to be reported as the only attendee to the meeting, even though there may be more attendees.", + "type": "boolean" }, - "type": { - "description": "Type of the document.", - "enum": [ - "UNKNOWN", - "DOCUMENT", - "PRESENTATION", - "SPREADSHEET", - "PDF", - "IMAGE", - "BINARY_BLOB", - "FUSION_TABLE", - "FOLDER", - "DRAWING", - "VIDEO", - "FORM", - "LINK_URL", - "LINK_GO", - "LINK_GOO_GL", - "LINK_BIT_LY", - "LINK_GMAIL", - "LINK_MAILTO", - "VIDEO_YOUTUBE", - "VIDEO_LIVE", - "GROUPS", - "NEWS", - "SITES", - "HANGOUT", - "AUDIO", - "MS_WORD", - "MS_POWERPOINT", - "MS_EXCEL", - "MS_OUTLOOK" - ], - "enumDescriptions": [ - "If the type is unknown or not represented in this enum.", - "Drive document types Writely, Word, etc.", - "Presently, PowerPoint, etc.", - "Trix, Excel, etc.", - "File types for Gdrive objects are below. PDF.", - "Image.", - "Fall-back for unknown Gdrive types.", - "Fusion table.", - "Folder.", - "Drawing.", - "Video.", - "Form.", - "Link formats uncategorized URL links", - "meaningful links that should be renderred specifically", - "Link to goo.gl.", - "Link to bit_ly.", - "Link to Gmail.", - "Mailto link.", - "Videos Youtube videos.", - "Live streams (e.g., liveplayer.googleplex.com)", - "Other types. Google Groups.", - "Google News.", - "Google Sites.", - "Google Hangout.", - "Audio files.", - "Microsoft-specific file types.", - "", - "", - "" - ], + "hangoutId": { + "description": "Hangout meeting identifier.", "type": "string" }, - "url": { - "description": "Absolute URL of the document.", - "type": "string" - } - }, - "type": "object" - }, - "EnterpriseTopazSidekickCommonDocumentDriveDocumentMetadata": { - "description": "Meta data for drive documents.", - "id": "EnterpriseTopazSidekickCommonDocumentDriveDocumentMetadata", - "properties": { - "documentId": { - "deprecated": true, - "description": "The drive document cosmo id. Client could use the id to build a URL to open a document. Please use Document.document_id.", + "hangoutUrl": { + "description": "Absolute URL for the Hangout meeting.", "type": "string" }, - "isPrivate": { - "description": "Additional field to identify whether a document is private since scope set to LIMITED can mean both that the doc is private or that it's shared with others. is_private indicates whether the doc is not shared with anyone except for the owner.", + "invitee": { + "description": "People attending the meeting.", + "items": { + "$ref": "EnterpriseTopazSidekickPerson" + }, + "type": "array" + }, + "isAllDay": { + "description": "Whether the entry lasts all day.", "type": "boolean" }, - "lastCommentTimeMs": { - "description": "Timestamp of the most recent comment added to the document in milliseconds since epoch.", - "format": "uint64", + "lastModificationTimeMs": { + "description": "Last time the event was modified.", + "format": "int64", "type": "string" }, - "lastEditTimeMs": { - "description": "Timestamp of the most recent edit from the current user in milliseconds since epoch.", - "format": "uint64", + "location": { + "description": "Agenda item location.", "type": "string" }, - "lastModificationTimeMillis": { - "description": "Last modification time of the document (independent of the user that modified it).", - "format": "int64", - "type": "string" - }, - "lastUpdatedTimeMs": { - "description": "Timestamp of the last updated time of the document in milliseconds since epoch.", - "format": "uint64", - "type": "string" - }, - "lastViewTimeMs": { - "description": "Timestamp of the most recent view from the current user in milliseconds since epoch.", - "format": "uint64", - "type": "string" - }, - "owner": { - "$ref": "EnterpriseTopazSidekickCommonPerson", - "description": "The owner of the document." - }, - "scope": { - "description": "ACL scope of the document which identifies the sharing status of the doc (e.g., limited, shared with link, team drive, ...).", - "enum": [ - "UNKNOWN_DOCUMENT_SCOPE", - "LIMITED", - "DASHER_DOMAIN_WITH_LINK", - "DASHER_DOMAIN", - "PUBLIC_WITH_LINK", - "PUBLIC", - "TEAM_DRIVE" - ], - "enumDescriptions": [ - "", - "", - "", - "", - "", - "", - "" - ], - "type": "string" - } - }, - "type": "object" - }, - "EnterpriseTopazSidekickCommonDocumentJustification": { - "description": "Justification of why we are reporting the document.", - "id": "EnterpriseTopazSidekickCommonDocumentJustification", - "properties": { - "justification": { - "description": "A locale aware message that explains why this document was selected.", - "type": "string" - }, - "reason": { - "description": "Reason on why the document is selected. Populate for trending documents.", - "enum": [ - "UNKNOWN", - "TRENDING_IN_COLLABORATORS", - "TRENDING_IN_DOMAIN", - "FREQUENTLY_VIEWED", - "FREQUENTLY_EDITED", - "NEW_UPDATES", - "NEW_COMMENTS", - "EVENT_DESCRIPTION", - "EVENT_ATTACHMENT", - "EVENT_METADATA_ATTACHMENT", - "MINED_DOCUMENT", - "NEW_MENTIONS", - "NEW_SHARES" - ], - "enumDescriptions": [ - "Unknown justification.", - "Popular documents within collaborators.", - "Popular documents within the domain.", - "Documents being reviewed frequently by the current user .", - "Documents being edited frequently by the current user .", - "Documents updated since user's last visit.", - "Documents that receive comments since user's last visit.", - "Documents in the calendar event description.", - "Documents in the calendar event attachments section.", - "Documents attached in calendar event metadata instead of the attachment section. Event metadata is not visible to the final user. Enterprise assist uses this metadata to store auto-generated documents such as meeting notes.", - "Documents mined, and so, probably related to the request context. For example, this category includes documents related to a meeting.", - "Documents that contains mentions of the user.", - "Documents that are shared with the user." - ], - "type": "string" - } - }, - "type": "object" - }, - "EnterpriseTopazSidekickCommonPerson": { - "description": "Common representation of a person.", - "id": "EnterpriseTopazSidekickCommonPerson", - "properties": { - "birthday": { - "$ref": "EnterpriseTopazSidekickCommonPersonBirthday", - "description": "The birthday." - }, - "cellPhone": { - "description": "Cell phone number.", - "type": "string" - }, - "department": { - "description": "The department the person works in (e.g. Engineering).", - "type": "string" - }, - "deskLocation": { - "description": "Desk location (e.g. US-MTV-PR55-5-5B1I).", - "type": "string" + "notifyToUser": { + "description": "Whether this should be notified to the user.", + "type": "boolean" }, - "deskPhone": { - "description": "Work desk phone number.", - "type": "string" + "otherAttendeesExcluded": { + "description": "Whether guest list is not returned because number of attendees is too large.", + "type": "boolean" }, - "displayName": { - "description": "The full name.", - "type": "string" + "requesterIsOwner": { + "description": "Whether the requester is the owner of the agenda entry.", + "type": "boolean" }, - "email": { - "description": "Email.", - "type": "string" + "showFullEventDetailsToUse": { + "description": "Whether the details of this entry should be displayed to the user.", + "type": "boolean" }, - "familyName": { - "description": "The last name.", + "startDate": { + "description": "Start date \"Friday, August 26\" in the user's timezone.", "type": "string" }, - "fullAddress": { - "description": "The fully formatted address (e.g. 1255 Pear Avenue, Mountain View 94043, United States).", + "startTime": { + "description": "Start time (HH:mm) in the user's timezone.", "type": "string" }, - "gaiaId": { - "deprecated": true, - "description": "This field is deprecated. The obfuscated_id should be used instead.", + "startTimeMs": { + "description": "Start time in milliseconds.", "format": "int64", "type": "string" }, - "givenName": { - "description": "The first name.", - "type": "string" - }, - "jobTitle": { - "description": "The person's job title (e.g. Software Engineer).", - "type": "string" - }, - "manager": { - "$ref": "EnterpriseTopazSidekickCommonPerson", - "description": "The manager." - }, - "obfuscatedId": { - "description": "The obfuscated GAIA ID.", - "type": "string" - }, - "photoUrl": { - "description": "The URL for the Focus profile picture.", + "timeZone": { + "description": "User's calendar timezone;", "type": "string" }, - "streetAddress": { - "description": "The street address (e.g. 1255 Pear Avenue).", - "type": "string" - } - }, - "type": "object" - }, - "EnterpriseTopazSidekickCommonPersonBirthday": { - "id": "EnterpriseTopazSidekickCommonPersonBirthday", - "properties": { - "value": { - "description": "Unstructured birthday.", + "title": { + "description": "Title of the agenda item.", "type": "string" } }, "type": "object" }, - "EnterpriseTopazSidekickConflictingEventsCardProto": { - "description": "Conflicting meetings card proto.", - "id": "EnterpriseTopazSidekickConflictingEventsCardProto", + "EnterpriseTopazSidekickAgendaGroupCardProto": { + "id": "EnterpriseTopazSidekickAgendaGroupCardProto", "properties": { - "conflictingEvent": { - "description": "All the events that conflict with main_event.", + "agendaItem": { "items": { - "$ref": "EnterpriseTopazSidekickAgendaEntry" + "$ref": "EnterpriseTopazSidekickAgendaItem" }, "type": "array" }, - "mainEvent": { - "$ref": "EnterpriseTopazSidekickAgendaEntry", - "description": "The event identified as being the most important." + "context": { + "$ref": "EnterpriseTopazSidekickAgendaGroupCardProtoContext" + }, + "currentAgendaItem": { + "$ref": "EnterpriseTopazSidekickAgendaItem" } }, "type": "object" }, - "EnterpriseTopazSidekickDocumentGroup": { - "description": "Represents a mapping between a document type and its corresponding documents. Use for Work in Progress card in v1 homepage.", - "id": "EnterpriseTopazSidekickDocumentGroup", + "EnterpriseTopazSidekickAgendaGroupCardProtoContext": { + "description": "The context that resulted in the generation of the card.", + "id": "EnterpriseTopazSidekickAgendaGroupCardProtoContext", "properties": { - "groupType": { - "deprecated": true, - "description": "Document group type", + "context": { + "description": "User friendly free text that describes the context of the card (e.g. \"Next meeting with Bob\"). This is largely only applicable when the card is generated from a query.", + "type": "string" + }, + "date": { + "description": "Localized free text that describes the dates represented by the card. Currently, the card will only represent a single day.", + "type": "string" + }, + "eventsRestrict": { + "description": "Represents restrictions applied to the events requested in the user's query.", "enum": [ - "UNKNOWN_TYPE", - "ALL" + "NONE", + "NEXT_MEETING" ], "enumDescriptions": [ - "Unknown type.", - "A mix of all the document types." + "No specific event was requested.", + "The next meeting was requested." ], "type": "string" + } + }, + "type": "object" + }, + "EnterpriseTopazSidekickAgendaItem": { + "id": "EnterpriseTopazSidekickAgendaItem", + "properties": { + "conflictedGroup": { + "$ref": "EnterpriseTopazSidekickConflictingEventsCardProto" }, - "personalizedDocument": { - "description": "The list of corresponding documents.", - "items": { - "$ref": "EnterpriseTopazSidekickCommonDocument" - }, - "type": "array" + "gapBefore": { + "$ref": "EnterpriseTopazSidekickGap" + }, + "meeting": { + "$ref": "EnterpriseTopazSidekickAgendaEntry" } }, "type": "object" }, - "EnterpriseTopazSidekickDocumentPerCategoryList": { - "id": "EnterpriseTopazSidekickDocumentPerCategoryList", + "EnterpriseTopazSidekickAnswerAnswerList": { + "description": "A list of answers represented as free text.", + "id": "EnterpriseTopazSidekickAnswerAnswerList", "properties": { - "documents": { + "labeledAnswer": { + "description": "Answers that have a corresponding label.", "items": { - "$ref": "EnterpriseTopazSidekickDocumentPerCategoryListDocumentPerCategoryListEntry" + "$ref": "EnterpriseTopazSidekickAnswerAnswerListLabeledAnswer" }, "type": "array" }, - "helpMessage": { - "description": "Localized message explaining how the documents were derived (e.g. from the last 30 days activity). This field is optional.", - "type": "string" - }, - "listType": { - "enum": [ - "UNKNOWN_LIST_TYPE", - "MENTIONS", - "SHARES", - "NEEDS_ATTENTION", - "VIEWS", - "EDITS" - ], - "enumDescriptions": [ - "", - "All documents in the list correspond to one of the mention categories.", - "All documents in the list correspond to one of the share categories.", - "A mixture of document categories that correspond to documents that need the users attention (e.g. documents that have been explicitly shared with the user but have not been viewed and documents where the user was mentioned but has not replied).", - "All documents in the list correspond to one of the view categories.", - "All documents in the list correspond to one of the edit categories." - ], - "type": "string" - }, - "listTypeDescription": { - "description": "Description of the types of documents present in the list.", - "type": "string" - }, - "responseMessage": { - "description": "Response message in case no documents are present in the card.", - "type": "string" - } - }, - "type": "object" - }, - "EnterpriseTopazSidekickDocumentPerCategoryListDocumentPerCategoryListEntry": { - "id": "EnterpriseTopazSidekickDocumentPerCategoryListDocumentPerCategoryListEntry", - "properties": { - "category": { + "type": { + "description": "Answer type.", "enum": [ - "UNKNOWN_DOCUMENT", - "ACTIONABLE", - "VIEWED", - "REPLIED", - "MENTION_VIEWED", - "MENTION_REPLIED", - "MENTION_NOT_VIEWED", - "SHARED_AND_VIEWED", - "SHARED_NOT_VIEWED", - "EDITED" - ], - "enumDeprecated": [ - false, - true, - false, - true, - false, - false, - false, - false, - false, - false + "UNKNOWN", + "PERSON_ADDRESS", + "PERSON_BIRTHDAY", + "PERSON_DEPARTMENT", + "PERSON_DESK_LOCATION", + "PERSON_EMAIL", + "PERSON_JOB_TITLE", + "PERSON_PHONE" ], "enumDescriptions": [ "", "", "", "", - "Mention categories. The mention has been viewed by the user, but the user has not replied.", - "The user has replied to the mention.", - "The mention has not been viewed by the user.", - "Share categories. Consists of documents that have been explicitly shared with the user. Document has been viewed.", - "Document has not been viewed.", - "Document has been edited." + "", + "", + "", + "" ], "type": "string" - }, - "document": { - "$ref": "EnterpriseTopazSidekickCommonDocument" - }, - "rationale": { - "description": "Reason this document was selected.", - "type": "string" - } - }, - "type": "object" - }, - "EnterpriseTopazSidekickFindMeetingTimeCardProto": { - "description": "Response to find meeting time among a set of people.", - "id": "EnterpriseTopazSidekickFindMeetingTimeCardProto", - "properties": { - "commonAvailableTimeSlots": { - "description": "Slots when all attendees have availability.", - "items": { - "$ref": "EnterpriseTopazSidekickTimeSlot" - }, - "type": "array" - }, - "invitees": { - "description": "Invitees to the event.", - "items": { - "$ref": "EnterpriseTopazSidekickPerson" - }, - "type": "array" - }, - "requester": { - "$ref": "EnterpriseTopazSidekickPerson", - "description": "Requester." - }, - "scheduledMeeting": { - "$ref": "EnterpriseTopazSidekickScheduledMeeting", - "description": "Details about the scheduled meeting, if one exists." - }, - "skippedInvitees": { - "description": "Invitees that have been skipped in the computation, most likely because they are groups.", - "items": { - "$ref": "EnterpriseTopazSidekickPerson" - }, - "type": "array" - }, - "timeBoundaries": { - "$ref": "EnterpriseTopazSidekickTimeSlot", - "description": "Min and max timestamp used to find a common available timeslot." - }, - "timezoneId": { - "description": "Timezone ID.", - "type": "string" - } - }, - "type": "object" - }, - "EnterpriseTopazSidekickGap": { - "id": "EnterpriseTopazSidekickGap", - "properties": { - "displayRemainingTime": { - "description": "Localized time string in the format: 1 hour 15 minutes", - "type": "string" - }, - "endTime": { - "description": "Localized time string in the format:(Locale CZ) 8:30 odp.", - "type": "string" - }, - "endTimeMs": { - "format": "uint64", - "type": "string" - }, - "remainingTime": { - "format": "google-duration", - "type": "string" - }, - "startTime": { - "description": "Localized time string in the format:(Locale CZ) 8:30 odp.", - "type": "string" - }, - "startTimeMs": { - "format": "uint64", - "type": "string" } }, "type": "object" }, - "EnterpriseTopazSidekickGenericAnswerCard": { - "id": "EnterpriseTopazSidekickGenericAnswerCard", + "EnterpriseTopazSidekickAnswerAnswerListLabeledAnswer": { + "description": "An answer with a corresponding label.", + "id": "EnterpriseTopazSidekickAnswerAnswerListLabeledAnswer", "properties": { "answer": { - "description": "The answer.", + "description": "The free text answer.", "type": "string" }, - "title": { - "description": "Title or header of the card.", + "label": { + "description": "A localized label for the answer (e.g. \"Cell phone\" vs \"Desk phone\").", "type": "string" } }, "type": "object" }, - "EnterpriseTopazSidekickGetAndKeepAheadCardProto": { - "description": "Get and keep ahead card", - "id": "EnterpriseTopazSidekickGetAndKeepAheadCardProto", - "properties": { - "declinedEvents": { - "$ref": "EnterpriseTopazSidekickGetAndKeepAheadCardProtoDeclinedEvents" - }, - "mentionedDocuments": { - "$ref": "EnterpriseTopazSidekickDocumentPerCategoryList" - }, - "sharedDocuments": { - "$ref": "EnterpriseTopazSidekickDocumentPerCategoryList" - } - }, - "type": "object" - }, - "EnterpriseTopazSidekickGetAndKeepAheadCardProtoDeclinedEvents": { - "description": "A list of events where all guests declined.", - "id": "EnterpriseTopazSidekickGetAndKeepAheadCardProtoDeclinedEvents", + "EnterpriseTopazSidekickAnswerSuggestedQueryAnswerCard": { + "description": "Contains a list of suggested queries. Allows the user to determine what natural language queries they can ask Cloud Search (e.g. \"what can I search for?\").", + "id": "EnterpriseTopazSidekickAnswerSuggestedQueryAnswerCard", "properties": { - "events": { + "suggestedQueryCategory": { + "description": "A list of queries to suggest.", "items": { - "$ref": "EnterpriseTopazSidekickAgendaEntry" + "$ref": "EnterpriseTopazSidekickAnswerSuggestedQueryCategory" }, "type": "array" } }, "type": "object" }, - "EnterpriseTopazSidekickMeetingNotesCardError": { - "description": "Errors in the creation of meeting notes.", - "id": "EnterpriseTopazSidekickMeetingNotesCardError", + "EnterpriseTopazSidekickAnswerSuggestedQueryCategory": { + "description": "Contains a list of suggested queries for a single category.", + "id": "EnterpriseTopazSidekickAnswerSuggestedQueryCategory", "properties": { - "description": { - "description": "The description of the reason why create-meeting-notes failed.", - "type": "string" - }, - "event": { - "$ref": "EnterpriseTopazSidekickAgendaEntry", - "description": "The event to request meeting notes creation" - }, - "reason": { - "description": "The reason why create-meeting-notes failed.", + "category": { + "description": "The query list category.", "enum": [ - "NONE", - "NOT_OWNER", - "UNKNOWN" + "UNKNOWN", + "CALENDAR", + "DOCUMENT", + "PEOPLE" ], "enumDescriptions": [ - "No reason (default value).", - "The user is not an owner.", - "Unknown reason." + "Unknown.", + "Calendar based queries (e.g. \"my agenda for tomorrow\").", + "Document based queries (e.g. \"files shared with me\").", + "People based queries (e.g. \"what is x's email address?\")." ], "type": "string" + }, + "isEnabled": { + "description": "Whether this category is enabled.", + "type": "boolean" + }, + "query": { + "description": "List of suggested queries to show the user.", + "items": { + "type": "string" + }, + "type": "array" } }, "type": "object" }, - "EnterpriseTopazSidekickMeetingNotesCardProto": { - "description": "Information about the meeting notes created.", - "id": "EnterpriseTopazSidekickMeetingNotesCardProto", + "EnterpriseTopazSidekickAssistCardProto": { + "description": "Wrapper proto for the Assist cards.", + "id": "EnterpriseTopazSidekickAssistCardProto", "properties": { - "event": { - "$ref": "EnterpriseTopazSidekickAgendaEntry", - "description": "The event to request meeting notes creation." + "agendaGroupCardProto": { + "$ref": "EnterpriseTopazSidekickAgendaGroupCardProto", + "description": "Agenda group card." }, - "fileId": { - "description": "Google Drive ID (a.k.a. resource ID) of the file.", - "type": "string" + "cardMetadata": { + "$ref": "EnterpriseTopazSidekickCardMetadata", + "description": "Card metadata such as chronology and render mode of the card." }, - "title": { - "description": "Title we want to show for meeting notes in the answer card", + "cardType": { + "description": "Card type.", + "enum": [ + "UNKNOWN_TYPE", + "AGENDA", + "CHANGELISTS", + "CONFLICTING_MEETINGS", + "CREATE_NOTES_FOR_MEETING", + "CREATE_NOTES_FOR_MEETING_REQUEST", + "CUSTOMER_NEWS", + "FIND_MEETING_TIME", + "NEXT_MEETING", + "PERSONALIZED_DOCS", + "TRENDING_DOCS", + "UPCOMING_TRIP", + "SUMMARY", + "MEETINGS", + "HOMEPAGE", + "SHARE_MEETING_DOCS", + "DISCOVER_PEOPLE", + "HOMEPAGE_V3", + "AGENDA_GROUP", + "WORK_IN_PROGRESS", + "GET_AND_KEEP_AHEAD", + "GENERIC_ANSWER_CARD", + "THIRD_PARTY_ANSWER_CARD", + "DOMAIN_TRENDING_DOCS", + "TEAM_TRENDING_DOCS", + "DOCUMENT_LIST_ANSWER_CARD", + "SUGGESTED_QUERY_ANSWER_CARD", + "PERSON_ANSWER_CARD", + "RELATED_PEOPLE_ANSWER_CARD", + "PERSON_KNOWLEDGE_CARD", + "PEOPLE_SEARCH_PROMOTION_CARD" + ], + "enumDeprecated": [ + false, + true, + true, + true, + true, + true, + true, + false, + true, + true, + true, + true, + true, + true, + true, + true, + true, + true, + false, + false, + false, + false, + false, + true, + true, + false, + false, + false, + false, + false, + false + ], + "enumDescriptions": [ + "The default type, an unknown card type.", + "The user's agenda for the day.", + "Changelists.", + "Any group of meetings for the day that are overlapping.", + "Create notes for a meeting specified in the request.", + "Create notes for meeting query.", + "News about your SFDC customers.", + "Find a time for two people to meet.", + "The user's next non-declined meeting.", + "Important documents for you since you have viewed them in the last month and there's some action going on.", + "Documents that are trending in your company. A TRENDING_DOCS card can be of two types: TRENDING_IN_COLLABORATORS (i.e., Stay in the Loop) and TRENDING_IN_DOMAIN (i.e., Popular Content). Use DOMAIN_TRENDING_DOCS/TEAM_TRENDING_DOCS instead.", + "An upcoming trip with all trip information along with calendar events in the destination timezone.", + "The Morning/Evening Summary Card for the next working day.", + "A meeting. When requesting meetings, the service will return a MEETING card for each meeting the user has in his agenda.", + "All cards related to the homepage (agenda, conflicting-meetings, summary, etc...). This type should no longer be used. Use HOMEPAGE_V3 instead.", + "A card to with specifics to share meeting documents with all attendees.", + "Represents a set of users that the requesting user has low affinity with.", + "All cards related to the homepage-v3 (agenda-group, WIP, etc...)", + "A group of agenda-events (meeting, conflicts)", + "The documents that you were recently working on.", + "(v3) The \"get and keep ahead\" card for today and tomorrow", + "Generic answer card.", + "Third party answer card.", + "Documents that are trending in your company/domain (i.e., Popular Content).", + "Documents that are trending in your team (i.e., Stay in the Loop).", + "Documents that match the user's query (e.g. sheets shared with me).", + "A help card that provides examples of queries the user can ask.", + "Answer card for a single person (e.g. what is x's phone number).", + "Answer card for a list of people related to the person that is the subject of the query (e.g. who reports to x).", + "Knowledge card for a single person and their related people.", + "People Search promotion card." + ], "type": "string" }, - "url": { - "description": "New URL.", - "type": "string" - } - }, - "type": "object" - }, - "EnterpriseTopazSidekickMeetingNotesCardRequest": { - "description": "Meeting notes card request.", - "id": "EnterpriseTopazSidekickMeetingNotesCardRequest", - "properties": { - "canCreateFor": { - "description": "Who are the meeting notes created for.", - "items": { - "enum": [ - "UNKNOWN", - "MYSELF", - "ALL_ATTENDEES" - ], - "enumDescriptions": [ - "Unknown (default).", - "For the requester.", - "For all the meeting attendees." - ], - "type": "string" - }, - "type": "array" + "conflictingMeetingsCard": { + "$ref": "EnterpriseTopazSidekickConflictingEventsCardProto", + "deprecated": true, + "description": "Conflicting events card." }, - "error": { - "$ref": "EnterpriseTopazSidekickMeetingNotesCardError", - "description": "The error and reason if known error occured." + "documentListCard": { + "$ref": "EnterpriseTopazSidekickDocumentPerCategoryList", + "description": "Answer card for documents that are applicable to the current query." }, - "event": { - "$ref": "EnterpriseTopazSidekickAgendaEntry", - "description": "The event to request meeting notes creation" - } - }, - "type": "object" - }, - "EnterpriseTopazSidekickNlpMetadata": { - "description": "Metadata about the NLP interpretation of the query.", - "id": "EnterpriseTopazSidekickNlpMetadata", - "properties": { - "confidence": { - "description": "Confidence of the interpretation that generated this card.", - "format": "float", - "type": "number" - } - }, - "type": "object" - }, - "EnterpriseTopazSidekickPeopleAnswerDisambiguationInfo": { - "description": "Metadata for disambiguation.", - "id": "EnterpriseTopazSidekickPeopleAnswerDisambiguationInfo", - "properties": { - "disambiguation": { - "description": "A list of people that also matched the query. This list is not complete.", - "items": { - "$ref": "EnterpriseTopazSidekickPeopleAnswerDisambiguationInfoDisambiguationPerson" - }, - "type": "array" + "documentsWithMentions": { + "$ref": "EnterpriseTopazSidekickDocumentPerCategoryList", + "deprecated": true, + "description": "Documents with mentions." }, - "name": { - "description": "The name that was extracted from the query. This may be in the form of the given name, last name, full name, LDAP, or email address. This name can be considered suitable for displaying to the user and can largely be considered to be normalized (e.g. \"Bob's\" -> \"Bob\").", - "type": "string" - } - }, - "type": "object" - }, - "EnterpriseTopazSidekickPeopleAnswerDisambiguationInfoDisambiguationPerson": { - "description": "A person that also matches the query, but was not selected due to a lower affinity with the requesting user.", - "id": "EnterpriseTopazSidekickPeopleAnswerDisambiguationInfoDisambiguationPerson", - "properties": { - "person": { - "$ref": "EnterpriseTopazSidekickCommonPerson", - "description": "The profile of this person." + "findMeetingTimeCard": { + "$ref": "EnterpriseTopazSidekickFindMeetingTimeCardProto", + "description": "Find meeting time card." }, - "query": { - "description": "The query that can be used to produce an answer card with the same attribute, but for this person.", - "type": "string" - } - }, - "type": "object" - }, - "EnterpriseTopazSidekickPeopleAnswerPeopleAnswerCardHeader": { - "description": "Recommended header to display for the card.", - "id": "EnterpriseTopazSidekickPeopleAnswerPeopleAnswerCardHeader", - "properties": { - "title": { - "description": "The suggested title to display. This defaults to the user's query.", - "type": "string" - } - }, - "type": "object" - }, - "EnterpriseTopazSidekickPeopleAnswerPersonAnswerCard": { - "description": "An answer card for a single person.", - "id": "EnterpriseTopazSidekickPeopleAnswerPersonAnswerCard", - "properties": { - "answer": { + "genericAnswerCard": { + "$ref": "EnterpriseTopazSidekickGenericAnswerCard", + "description": "Generic answer card." + }, + "getAndKeepAheadCard": { + "$ref": "EnterpriseTopazSidekickGetAndKeepAheadCardProto", + "description": "Get and keep ahead card." + }, + "meeting": { + "$ref": "EnterpriseTopazSidekickAgendaEntry", "deprecated": true, - "description": "List of answers.", - "items": { - "$ref": "SafeHtmlProto" - }, - "type": "array" + "description": "Meeting card." }, - "answerText": { - "$ref": "EnterpriseTopazSidekickAnswerAnswerList", - "description": "List of answers." + "meetingNotesCard": { + "$ref": "EnterpriseTopazSidekickMeetingNotesCardProto", + "description": "Meeting notes card." }, - "disambiguationInfo": { - "$ref": "EnterpriseTopazSidekickPeopleAnswerDisambiguationInfo", - "description": "Disambiguation information." + "meetingNotesCardRequest": { + "$ref": "EnterpriseTopazSidekickMeetingNotesCardRequest", + "description": "Request for meeting notes card." }, - "header": { - "$ref": "EnterpriseTopazSidekickPeopleAnswerPeopleAnswerCardHeader", - "description": "The header to display for the card." + "peopleDisambiguationCard": { + "$ref": "EnterpriseTopazSidekickPeopleDisambiguationCard", + "description": "The people disambiguation card." }, - "responseStatus": { - "description": "The response status.", - "enum": [ - "UNKNOWN", - "SUCCESS", - "MISSING_PERSON", - "MISSING_DATA" - ], - "enumDescriptions": [ - "Unknown.", - "Success.", - "No such person was found in the user's domain.", - "A person was found to match the query, but an answer could not be obtained." - ], - "type": "string" + "peoplePromotionCard": { + "$ref": "PeoplePromotionCard", + "description": "People Search promotion card." }, - "statusMessage": { - "description": "Localized user friendly message to display to the user in the case of missing data or an error.", - "type": "string" + "personAnswerCard": { + "$ref": "EnterpriseTopazSidekickPeopleAnswerPersonAnswerCard", + "description": "Answer card that represents a single person." }, - "subject": { - "$ref": "EnterpriseTopazSidekickCommonPerson", - "description": "The profile of the person that was the subject of the query." + "personProfileCard": { + "$ref": "EnterpriseTopazSidekickPersonProfileCard", + "description": "Full profile card." + }, + "personalizedDocsCard": { + "$ref": "EnterpriseTopazSidekickPersonalizedDocsCardProto", + "deprecated": true, + "description": "Card with recommended documents for the user." + }, + "relatedPeopleAnswerCard": { + "$ref": "EnterpriseTopazSidekickPeopleAnswerRelatedPeopleAnswerCard", + "description": "Answer card that represents a list of people related to a person." + }, + "shareMeetingDocsCard": { + "$ref": "EnterpriseTopazSidekickShareMeetingDocsCardProto", + "deprecated": true, + "description": "Sahre meeting docs card." + }, + "sharedDocuments": { + "$ref": "EnterpriseTopazSidekickDocumentPerCategoryList", + "deprecated": true, + "description": "Shared documents." + }, + "suggestedQueryAnswerCard": { + "$ref": "EnterpriseTopazSidekickAnswerSuggestedQueryAnswerCard", + "description": "Answer card for what natural language queries the user can ask." + }, + "thirdPartyAnswerCard": { + "$ref": "ThirdPartyGenericCard", + "description": "Third party answer cards." + }, + "workInProgressCardProto": { + "$ref": "EnterpriseTopazSidekickRecentDocumentsCardProto", + "description": "Work In Progress card." } }, "type": "object" }, - "EnterpriseTopazSidekickPeopleAnswerRelatedPeopleAnswerCard": { - "description": "An answer card for a list of people that are related to the subject of the query.", - "id": "EnterpriseTopazSidekickPeopleAnswerRelatedPeopleAnswerCard", + "EnterpriseTopazSidekickCardMetadata": { + "description": "Card metadata.", + "id": "EnterpriseTopazSidekickCardMetadata", "properties": { - "disambiguationInfo": { - "$ref": "EnterpriseTopazSidekickPeopleAnswerDisambiguationInfo", - "description": "Disambiguation information." - }, - "header": { - "$ref": "EnterpriseTopazSidekickPeopleAnswerPeopleAnswerCardHeader", - "description": "The header to display for the card." - }, - "relatedPeople": { - "description": "A list of people that are related to the query subject.", - "items": { - "$ref": "EnterpriseTopazSidekickCommonPerson" - }, - "type": "array" - }, - "relationType": { - "description": "Defines the type of relation the list of people have with the subject of the card.", + "cardCategory": { + "description": "Declares a preference for how this card should be packed in MSCR. All cards in a response must correspond to a single category. As a result, cards may be dropped from the response if this field is set. Any card that does not match the category of the card with the highest priority in the response will be dropped.", "enum": [ - "UNKNOWN", - "DIRECT_REPORTS", - "MANAGER", - "PEERS" + "DEFAULT", + "ANSWER", + "KNOWLEDGE", + "HOMEPAGE" ], "enumDescriptions": [ - "Unknown.", - "Direct reports.", - "The manager.", - "The teammates/peers of the subject." + "Let MSCR decide how this card should be packed. Most cards should choose this type. This type should largely be considered equivalent to ANSWER. However, this is not guaranteed to be the case as the request to MSCR may override the static configuration.", + "This card should be rendered as an answer card.", + "This card should be rendered as a knowledge card (a non-organic result).", + "This card should be rendered in the Homepage." ], "type": "string" }, - "responseStatus": { - "description": "The response status.", + "cardId": { + "description": "An ID to identify the card and match actions to it. Be thoughtful of new card IDs since actions will be associated to that ID. E.g., if two card IDs collide, the system will think that the actions have been applied to the same card. Similarly, if EAS can return multiple cards of the same type (e.g., Meetings), ensure that the card_id identifies a given instance of the card so that, e.g., dismissals only affect the dismissed card as opposed to affecting all meeting cards.", + "type": "string" + }, + "chronology": { + "description": "Chronology.", "enum": [ "UNKNOWN", - "SUCCESS", - "MISSING_PERSON", - "MISSING_DATA" + "PAST", + "RECENTLY_PAST", + "PRESENT", + "NEAR_FUTURE", + "FUTURE" ], "enumDescriptions": [ - "Unknown.", - "Success.", - "No such person was found in the user's domain.", - "A person was found to match the query, but an answer could not be obtained." + "Unknown chronology (default).", + "Past.", + "Recently past.", + "Present.", + "Near future.", + "Future." ], "type": "string" }, - "statusMessage": { - "description": "Localized user friendly message to display to the user in the case of missing data or an error.", + "debugInfo": { + "description": "Debug info (only reported if request's debug_level > 0).", "type": "string" }, - "subject": { - "$ref": "EnterpriseTopazSidekickCommonPerson", - "description": "The profile of the person that was the subject of the query." + "nlpMetadata": { + "$ref": "EnterpriseTopazSidekickNlpMetadata", + "description": "Information about the NLP done to get the card." + }, + "rankingParams": { + "$ref": "EnterpriseTopazSidekickRankingParams", + "description": "Ranking params." + }, + "renderMode": { + "description": "Render mode.", + "enum": [ + "UNKNOWN_RENDER", + "COLLAPSED", + "EXPANDED" + ], + "enumDescriptions": [ + "Unknown mode (default).", + "Collapsed.", + "Expanded." + ], + "type": "string" } }, "type": "object" }, - "EnterpriseTopazSidekickPeopleDisambiguationCard": { - "id": "EnterpriseTopazSidekickPeopleDisambiguationCard", + "EnterpriseTopazSidekickCommonDebugInfo": { + "description": "Container of debugging information in all object levels. Extend as needed.", + "id": "EnterpriseTopazSidekickCommonDebugInfo", "properties": { - "person": { - "description": "Candidate persons for the query.", - "items": { - "$ref": "EnterpriseTopazSidekickCommonPerson" - }, - "type": "array" + "message": { + "description": "Debug message.", + "type": "string" } }, "type": "object" }, - "EnterpriseTopazSidekickPerson": { - "description": "Person.", - "id": "EnterpriseTopazSidekickPerson", + "EnterpriseTopazSidekickCommonDocument": { + "description": "Representation of a document. NEXT_TAG: 15", + "id": "EnterpriseTopazSidekickCommonDocument", "properties": { - "affinityLevel": { - "description": "The level of affinity this person has with the requesting user.", + "accessType": { + "description": "Access type, i.e., whether the user has access to the document or not.", "enum": [ - "UNKNOWN", - "LOW", - "MEDIUM", - "HIGH" + "UNKNOWN_ACCESS", + "ALLOWED", + "NOT_ALLOWED" ], "enumDescriptions": [ - "", - "", - "", - "" + "Unknown access type.", + "Access allowed.", + "Access not allowed." ], "type": "string" }, - "attendingStatus": { - "description": "Attendance status of the person when included in a meeting event.", - "enum": [ - "AWAITING", - "YES", - "NO", - "MAYBE" - ], - "enumDescriptions": [ - "Awaiting for the user to set the status.", - "Attending.", - "Not attending.", - "Tentatively attending." - ], - "type": "string" + "debugInfo": { + "$ref": "EnterpriseTopazSidekickCommonDebugInfo", + "description": "Information for debugging." }, - "email": { - "description": "Email.", + "documentId": { + "description": "Document id.", "type": "string" }, - "gaiaId": { - "deprecated": true, - "description": "Gaia id.", - "format": "int64", + "driveDocumentMetadata": { + "$ref": "EnterpriseTopazSidekickCommonDocumentDriveDocumentMetadata", + "description": "Drive document metadata." + }, + "genericUrl": { + "description": "Generic Drive-based url in the format of drive.google.com/open to be used for deeplink", "type": "string" }, - "isGroup": { - "description": "Whether the invitee is a group.", - "type": "boolean" + "justification": { + "$ref": "EnterpriseTopazSidekickCommonDocumentJustification", + "description": "Justification on why the document is selected." }, - "name": { - "description": "Name.", + "mimeType": { + "description": "MIME type", "type": "string" }, - "obfuscatedGaiaId": { - "description": "Obfuscated Gaia id.", + "provenance": { + "deprecated": true, + "description": "Document provenance.", + "enum": [ + "UNKNOWN_PROVENANCE", + "CALENDAR_DESCRIPTION", + "CALENDAR_ATTACHMENT", + "MINED", + "CALENDAR_ASSIST_ATTACHMENT" + ], + "enumDescriptions": [ + "Unknown provenance.", + "Calendar event description.", + "Calendar event attachment.", + "Mined (extracted by some offline/online analysis).", + "Attachment created by enterprise assist." + ], "type": "string" }, - "photoUrl": { - "description": "Absolute URL to the profile photo of the person.", - "type": "string" - } - }, - "type": "object" - }, - "EnterpriseTopazSidekickPersonProfileCard": { - "id": "EnterpriseTopazSidekickPersonProfileCard", - "properties": { - "relatedPeople": { - "items": { - "$ref": "EnterpriseTopazSidekickPersonProfileCardRelatedPeople" - }, - "type": "array" + "reason": { + "deprecated": true, + "description": "Justification of why this document is being returned.", + "enum": [ + "UNKNOWN", + "TRENDING_IN_COLLABORATORS", + "TRENDING_IN_DOMAIN", + "FREQUENTLY_VIEWED", + "FREQUENTLY_EDITED", + "NEW_UPDATES", + "NEW_COMMENTS", + "EVENT_DESCRIPTION", + "EVENT_ATTACHMENT", + "EVENT_METADATA_ATTACHMENT", + "MINED_DOCUMENT", + "NEW_MENTIONS", + "NEW_SHARES" + ], + "enumDescriptions": [ + "Unknown justification.", + "Popular documents within collaborators.", + "Popular documents within the domain.", + "Documents being reviewed frequently by the current user .", + "Documents being edited frequently by the current user .", + "Documents updated since user's last visit.", + "Documents that receive comments since user's last visit.", + "Documents in the calendar event description.", + "Documents in the calendar event attachments section.", + "Documents attached in calendar event metadata instead of the attachment section. Event metadata is not visible to the final user. Enterprise assist uses this metadata to store auto-generated documents such as meeting notes.", + "Documents mined, and so, probably related to the request context. For example, this category includes documents related to a meeting.", + "Documents that contains mentions of the user.", + "Documents that are shared with the user." + ], + "type": "string" }, - "subject": { - "$ref": "EnterpriseTopazSidekickCommonPerson", - "description": "The subject of the card." - } - }, - "type": "object" - }, - "EnterpriseTopazSidekickPersonProfileCardRelatedPeople": { - "id": "EnterpriseTopazSidekickPersonProfileCardRelatedPeople", - "properties": { - "relatedPerson": { - "description": "Related people.", - "items": { - "$ref": "EnterpriseTopazSidekickCommonPerson" - }, - "type": "array" + "snippet": { + "description": "A sampling of the text from the document.", + "type": "string" }, - "relation": { - "description": "Relation type.", + "thumbnailUrl": { + "description": "Thumbnail URL.", + "type": "string" + }, + "title": { + "description": "Title of the document.", + "type": "string" + }, + "type": { + "description": "Type of the document.", "enum": [ "UNKNOWN", - "MANAGER", - "DIRECT_REPORT" + "DOCUMENT", + "PRESENTATION", + "SPREADSHEET", + "PDF", + "IMAGE", + "BINARY_BLOB", + "FUSION_TABLE", + "FOLDER", + "DRAWING", + "VIDEO", + "FORM", + "LINK_URL", + "LINK_GO", + "LINK_GOO_GL", + "LINK_BIT_LY", + "LINK_GMAIL", + "LINK_MAILTO", + "VIDEO_YOUTUBE", + "VIDEO_LIVE", + "GROUPS", + "NEWS", + "SITES", + "HANGOUT", + "AUDIO", + "MS_WORD", + "MS_POWERPOINT", + "MS_EXCEL", + "MS_OUTLOOK" ], "enumDescriptions": [ + "If the type is unknown or not represented in this enum.", + "Drive document types Writely, Word, etc.", + "Presently, PowerPoint, etc.", + "Trix, Excel, etc.", + "File types for Gdrive objects are below. PDF.", + "Image.", + "Fall-back for unknown Gdrive types.", + "Fusion table.", + "Folder.", + "Drawing.", + "Video.", + "Form.", + "Link formats uncategorized URL links", + "meaningful links that should be renderred specifically", + "Link to goo.gl.", + "Link to bit_ly.", + "Link to Gmail.", + "Mailto link.", + "Videos Youtube videos.", + "Live streams (e.g., liveplayer.googleplex.com)", + "Other types. Google Groups.", + "Google News.", + "Google Sites.", + "Google Hangout.", + "Audio files.", + "Microsoft-specific file types.", "", "", "" ], "type": "string" + }, + "url": { + "description": "Absolute URL of the document.", + "type": "string" } }, "type": "object" }, - "EnterpriseTopazSidekickPersonalizedDocsCardProto": { - "description": "Personalized docs card proto.", - "id": "EnterpriseTopazSidekickPersonalizedDocsCardProto", - "properties": { - "documentGroup": { - "description": "Document group.", - "items": { - "$ref": "EnterpriseTopazSidekickDocumentGroup" - }, - "type": "array" - } - }, - "type": "object" - }, - "EnterpriseTopazSidekickRankingParams": { - "description": "Ranking params.", - "id": "EnterpriseTopazSidekickRankingParams", + "EnterpriseTopazSidekickCommonDocumentDriveDocumentMetadata": { + "description": "Meta data for drive documents.", + "id": "EnterpriseTopazSidekickCommonDocumentDriveDocumentMetadata", "properties": { - "endTimeMs": { - "description": "The end-time that this object will expect to occur. If the type is marked as FIXED, then this end-time will persist after bidding. If the type is marked as FLEXIBLE, this field is NOT expected to be filled and will be filled in after it has won a bid. Expected to be set when type is set to FIXED.", + "documentId": { + "deprecated": true, + "description": "The drive document cosmo id. Client could use the id to build a URL to open a document. Please use Document.document_id.", + "type": "string" + }, + "isPrivate": { + "description": "Additional field to identify whether a document is private since scope set to LIMITED can mean both that the doc is private or that it's shared with others. is_private indicates whether the doc is not shared with anyone except for the owner.", + "type": "boolean" + }, + "lastCommentTimeMs": { + "description": "Timestamp of the most recent comment added to the document in milliseconds since epoch.", "format": "uint64", "type": "string" }, - "priority": { - "description": "The priority to determine between objects that have the same start_time_ms The lower-value of priority == ranked higher. Max-priority = 0. Expected to be set for all types.", - "enum": [ - "UNKNOWN", - "CRITICAL", - "IMPORTANT", - "HIGH", - "NORMAL", - "BEST_EFFORT" - ], - "enumDescriptions": [ - "Unknown (default).", - "Critical.", - "Important.", - "High.", - "Normal.", - "Best effort." - ], + "lastEditTimeMs": { + "description": "Timestamp of the most recent edit from the current user in milliseconds since epoch.", + "format": "uint64", "type": "string" }, - "score": { - "description": "The score of the card to be used to break priority-ties", - "format": "float", - "type": "number" + "lastModificationTimeMillis": { + "description": "Last modification time of the document (independent of the user that modified it).", + "format": "int64", + "type": "string" }, - "spanMs": { - "description": "The span that this card will take in the stream Expected to be set when type is set to FLEXIBLE.", + "lastUpdatedTimeMs": { + "description": "Timestamp of the last updated time of the document in milliseconds since epoch.", "format": "uint64", "type": "string" }, - "startTimeMs": { - "description": "The start-time that this object will bid-for If the type is marked as FIXED, then this start-time will persist after bidding. If the type is marked as FLEXIBLE, then it will occur at the given time or sometime after the requested time. Expected to be set for all types.", + "lastViewTimeMs": { + "description": "Timestamp of the most recent view from the current user in milliseconds since epoch.", "format": "uint64", "type": "string" }, - "type": { - "description": "The packing type of this object.", + "owner": { + "$ref": "EnterpriseTopazSidekickCommonPerson", + "description": "The owner of the document." + }, + "scope": { + "description": "ACL scope of the document which identifies the sharing status of the doc (e.g., limited, shared with link, team drive, ...).", "enum": [ - "FIXED", - "FLEXIBLE" + "UNKNOWN_DOCUMENT_SCOPE", + "LIMITED", + "DASHER_DOMAIN_WITH_LINK", + "DASHER_DOMAIN", + "PUBLIC_WITH_LINK", + "PUBLIC", + "TEAM_DRIVE" ], "enumDescriptions": [ - "Fixed, i.e., the card is time sensitive.", - "Flexible, i.e., the card is not time sensitive." + "", + "", + "", + "", + "", + "", + "" ], "type": "string" } }, "type": "object" }, - "EnterpriseTopazSidekickRecentDocumentsCardProto": { - "id": "EnterpriseTopazSidekickRecentDocumentsCardProto", - "properties": { - "document": { - "items": { - "$ref": "EnterpriseTopazSidekickCommonDocument" - }, - "type": "array" - } - }, - "type": "object" - }, - "EnterpriseTopazSidekickScheduledMeeting": { - "description": "Details about scheduled meetings.", - "id": "EnterpriseTopazSidekickScheduledMeeting", + "EnterpriseTopazSidekickCommonDocumentJustification": { + "description": "Justification of why we are reporting the document.", + "id": "EnterpriseTopazSidekickCommonDocumentJustification", "properties": { - "meetingLocation": { - "description": "The meeting location.", + "justification": { + "description": "A locale aware message that explains why this document was selected.", "type": "string" }, - "meetingTime": { - "$ref": "EnterpriseTopazSidekickTimeSlot", - "description": "The meeting time slot." - }, - "meetingTitle": { - "description": "The meeting title.", - "type": "string" - } - }, - "type": "object" - }, - "EnterpriseTopazSidekickShareMeetingDocsCardProto": { - "description": "Share meeting docs card proto.", - "id": "EnterpriseTopazSidekickShareMeetingDocsCardProto", - "properties": { - "document": { - "description": "Documents to share for the given meeting.", - "items": { - "$ref": "EnterpriseTopazSidekickCommonDocument" - }, - "type": "array" - }, - "event": { - "$ref": "EnterpriseTopazSidekickAgendaEntry", - "description": "Event." + "reason": { + "description": "Reason on why the document is selected. Populate for trending documents.", + "enum": [ + "UNKNOWN", + "TRENDING_IN_COLLABORATORS", + "TRENDING_IN_DOMAIN", + "FREQUENTLY_VIEWED", + "FREQUENTLY_EDITED", + "NEW_UPDATES", + "NEW_COMMENTS", + "EVENT_DESCRIPTION", + "EVENT_ATTACHMENT", + "EVENT_METADATA_ATTACHMENT", + "MINED_DOCUMENT", + "NEW_MENTIONS", + "NEW_SHARES" + ], + "enumDescriptions": [ + "Unknown justification.", + "Popular documents within collaborators.", + "Popular documents within the domain.", + "Documents being reviewed frequently by the current user .", + "Documents being edited frequently by the current user .", + "Documents updated since user's last visit.", + "Documents that receive comments since user's last visit.", + "Documents in the calendar event description.", + "Documents in the calendar event attachments section.", + "Documents attached in calendar event metadata instead of the attachment section. Event metadata is not visible to the final user. Enterprise assist uses this metadata to store auto-generated documents such as meeting notes.", + "Documents mined, and so, probably related to the request context. For example, this category includes documents related to a meeting.", + "Documents that contains mentions of the user.", + "Documents that are shared with the user." + ], + "type": "string" } }, "type": "object" }, - "EnterpriseTopazSidekickTimeSlot": { - "description": "Slot of time.", - "id": "EnterpriseTopazSidekickTimeSlot", + "EnterpriseTopazSidekickCommonPerson": { + "description": "Common representation of a person.", + "id": "EnterpriseTopazSidekickCommonPerson", "properties": { - "endTimeDay": { - "description": "Day end time at the user's timezone.", + "birthday": { + "$ref": "EnterpriseTopazSidekickCommonPersonBirthday", + "description": "The birthday." + }, + "cellPhone": { + "description": "Cell phone number.", "type": "string" }, - "endTimeHourAndMinute": { - "description": "Hour and minute of the end time at the user's timezone.", + "department": { + "description": "The department the person works in (e.g. Engineering).", "type": "string" }, - "endTimeInMillis": { - "description": "End time in milliseconds.", - "format": "int64", + "deskLocation": { + "description": "Desk location (e.g. US-MTV-PR55-5-5B1I).", "type": "string" }, - "startTimeDay": { - "description": "Day start time at user's timezone.", + "deskPhone": { + "description": "Work desk phone number.", "type": "string" }, - "startTimeHourAndMinute": { - "description": "Hour and minute of the start time at the user's timezone.", + "displayName": { + "description": "The full name.", "type": "string" }, - "startTimeInMillis": { - "description": "Start time in milliseconds.", + "email": { + "description": "Email.", + "type": "string" + }, + "familyName": { + "description": "The last name.", + "type": "string" + }, + "fullAddress": { + "description": "The fully formatted address (e.g. 1255 Pear Avenue, Mountain View 94043, United States).", + "type": "string" + }, + "gaiaId": { + "deprecated": true, + "description": "This field is deprecated. The obfuscated_id should be used instead.", "format": "int64", "type": "string" + }, + "givenName": { + "description": "The first name.", + "type": "string" + }, + "jobTitle": { + "description": "The person's job title (e.g. Software Engineer).", + "type": "string" + }, + "manager": { + "$ref": "EnterpriseTopazSidekickCommonPerson", + "description": "The manager." + }, + "obfuscatedId": { + "description": "The obfuscated GAIA ID.", + "type": "string" + }, + "photoUrl": { + "description": "The URL for the Focus profile picture.", + "type": "string" + }, + "streetAddress": { + "description": "The street address (e.g. 1255 Pear Avenue).", + "type": "string" } }, "type": "object" }, - "EnumOperatorOptions": { - "description": "Used to provide a search operator for enum properties. This is optional. Search operators let users restrict the query to specific fields relevant to the type of item being searched. For example, if you provide no operator for a *priority* enum property with possible values *p0* and *p1*, a query that contains the term *p0* returns items that have *p0* as the value of the *priority* property, as well as any items that contain the string *p0* in other fields. If you provide an operator name for the enum, such as *priority*, then search users can use that operator to refine results to only items that have *p0* as this property's value, with the query *priority:p0*.", - "id": "EnumOperatorOptions", + "EnterpriseTopazSidekickCommonPersonBirthday": { + "id": "EnterpriseTopazSidekickCommonPersonBirthday", "properties": { - "operatorName": { - "description": "Indicates the operator name required in the query in order to isolate the enum property. For example, if operatorName is *priority* and the property's name is *priorityVal*, then queries like *priority:* show results only where the value of the property named *priorityVal* matches **. By contrast, a search that uses the same ** without an operator returns all items where ** matches the value of any String properties or text within the content field for the item. The operator name can only contain lowercase letters (a-z). The maximum length is 32 characters.", + "value": { + "description": "Unstructured birthday.", "type": "string" } }, "type": "object" }, - "EnumPropertyOptions": { - "description": "The options for enum properties, which allow you to define a restricted set of strings to match user queries, set rankings for those string values, and define an operator name to be paired with those strings so that users can narrow results to only items with a specific value. For example, for items in a request tracking system with priority information, you could define *p0* as an allowable enum value and tie this enum to the operator name *priority* so that search users could add *priority:p0* to their query to restrict the set of results to only those items indexed with the value *p0*.", - "id": "EnumPropertyOptions", + "EnterpriseTopazSidekickConflictingEventsCardProto": { + "description": "Conflicting meetings card proto.", + "id": "EnterpriseTopazSidekickConflictingEventsCardProto", "properties": { - "operatorOptions": { - "$ref": "EnumOperatorOptions", - "description": "If set, describes how the enum should be used as a search operator." + "conflictingEvent": { + "description": "All the events that conflict with main_event.", + "items": { + "$ref": "EnterpriseTopazSidekickAgendaEntry" + }, + "type": "array" }, - "orderedRanking": { - "description": "Used to specify the ordered ranking for the enumeration that determines how the integer values provided in the possible EnumValuePairs are used to rank results. If specified, integer values must be provided for all possible EnumValuePair values given for this property. Can only be used if isRepeatable is false.", + "mainEvent": { + "$ref": "EnterpriseTopazSidekickAgendaEntry", + "description": "The event identified as being the most important." + } + }, + "type": "object" + }, + "EnterpriseTopazSidekickDocumentGroup": { + "description": "Represents a mapping between a document type and its corresponding documents. Use for Work in Progress card in v1 homepage.", + "id": "EnterpriseTopazSidekickDocumentGroup", + "properties": { + "groupType": { + "deprecated": true, + "description": "Document group type", "enum": [ - "NO_ORDER", - "ASCENDING", - "DESCENDING" + "UNKNOWN_TYPE", + "ALL" ], "enumDescriptions": [ - "There is no ranking order for the property. Results aren't adjusted by this property's value.", - "This property is ranked in ascending order. Lower values indicate lower ranking.", - "This property is ranked in descending order. Lower values indicate higher ranking." + "Unknown type.", + "A mix of all the document types." + ], + "type": "string" + }, + "personalizedDocument": { + "description": "The list of corresponding documents.", + "items": { + "$ref": "EnterpriseTopazSidekickCommonDocument" + }, + "type": "array" + } + }, + "type": "object" + }, + "EnterpriseTopazSidekickDocumentPerCategoryList": { + "id": "EnterpriseTopazSidekickDocumentPerCategoryList", + "properties": { + "documents": { + "items": { + "$ref": "EnterpriseTopazSidekickDocumentPerCategoryListDocumentPerCategoryListEntry" + }, + "type": "array" + }, + "helpMessage": { + "description": "Localized message explaining how the documents were derived (e.g. from the last 30 days activity). This field is optional.", + "type": "string" + }, + "listType": { + "enum": [ + "UNKNOWN_LIST_TYPE", + "MENTIONS", + "SHARES", + "NEEDS_ATTENTION", + "VIEWS", + "EDITS" + ], + "enumDescriptions": [ + "", + "All documents in the list correspond to one of the mention categories.", + "All documents in the list correspond to one of the share categories.", + "A mixture of document categories that correspond to documents that need the users attention (e.g. documents that have been explicitly shared with the user but have not been viewed and documents where the user was mentioned but has not replied).", + "All documents in the list correspond to one of the view categories.", + "All documents in the list correspond to one of the edit categories." + ], + "type": "string" + }, + "listTypeDescription": { + "description": "Description of the types of documents present in the list.", + "type": "string" + }, + "responseMessage": { + "description": "Response message in case no documents are present in the card.", + "type": "string" + } + }, + "type": "object" + }, + "EnterpriseTopazSidekickDocumentPerCategoryListDocumentPerCategoryListEntry": { + "id": "EnterpriseTopazSidekickDocumentPerCategoryListDocumentPerCategoryListEntry", + "properties": { + "category": { + "enum": [ + "UNKNOWN_DOCUMENT", + "ACTIONABLE", + "VIEWED", + "REPLIED", + "MENTION_VIEWED", + "MENTION_REPLIED", + "MENTION_NOT_VIEWED", + "SHARED_AND_VIEWED", + "SHARED_NOT_VIEWED", + "EDITED" + ], + "enumDeprecated": [ + false, + true, + false, + true, + false, + false, + false, + false, + false, + false + ], + "enumDescriptions": [ + "", + "", + "", + "", + "Mention categories. The mention has been viewed by the user, but the user has not replied.", + "The user has replied to the mention.", + "The mention has not been viewed by the user.", + "Share categories. Consists of documents that have been explicitly shared with the user. Document has been viewed.", + "Document has not been viewed.", + "Document has been edited." + ], + "type": "string" + }, + "document": { + "$ref": "EnterpriseTopazSidekickCommonDocument" + }, + "rationale": { + "description": "Reason this document was selected.", + "type": "string" + } + }, + "type": "object" + }, + "EnterpriseTopazSidekickFindMeetingTimeCardProto": { + "description": "Response to find meeting time among a set of people.", + "id": "EnterpriseTopazSidekickFindMeetingTimeCardProto", + "properties": { + "commonAvailableTimeSlots": { + "description": "Slots when all attendees have availability.", + "items": { + "$ref": "EnterpriseTopazSidekickTimeSlot" + }, + "type": "array" + }, + "invitees": { + "description": "Invitees to the event.", + "items": { + "$ref": "EnterpriseTopazSidekickPerson" + }, + "type": "array" + }, + "requester": { + "$ref": "EnterpriseTopazSidekickPerson", + "description": "Requester." + }, + "scheduledMeeting": { + "$ref": "EnterpriseTopazSidekickScheduledMeeting", + "description": "Details about the scheduled meeting, if one exists." + }, + "skippedInvitees": { + "description": "Invitees that have been skipped in the computation, most likely because they are groups.", + "items": { + "$ref": "EnterpriseTopazSidekickPerson" + }, + "type": "array" + }, + "timeBoundaries": { + "$ref": "EnterpriseTopazSidekickTimeSlot", + "description": "Min and max timestamp used to find a common available timeslot." + }, + "timezoneId": { + "description": "Timezone ID.", + "type": "string" + } + }, + "type": "object" + }, + "EnterpriseTopazSidekickGap": { + "id": "EnterpriseTopazSidekickGap", + "properties": { + "displayRemainingTime": { + "description": "Localized time string in the format: 1 hour 15 minutes", + "type": "string" + }, + "endTime": { + "description": "Localized time string in the format:(Locale CZ) 8:30 odp.", + "type": "string" + }, + "endTimeMs": { + "format": "uint64", + "type": "string" + }, + "remainingTime": { + "format": "google-duration", + "type": "string" + }, + "startTime": { + "description": "Localized time string in the format:(Locale CZ) 8:30 odp.", + "type": "string" + }, + "startTimeMs": { + "format": "uint64", + "type": "string" + } + }, + "type": "object" + }, + "EnterpriseTopazSidekickGenericAnswerCard": { + "id": "EnterpriseTopazSidekickGenericAnswerCard", + "properties": { + "answer": { + "description": "The answer.", + "type": "string" + }, + "title": { + "description": "Title or header of the card.", + "type": "string" + } + }, + "type": "object" + }, + "EnterpriseTopazSidekickGetAndKeepAheadCardProto": { + "description": "Get and keep ahead card", + "id": "EnterpriseTopazSidekickGetAndKeepAheadCardProto", + "properties": { + "declinedEvents": { + "$ref": "EnterpriseTopazSidekickGetAndKeepAheadCardProtoDeclinedEvents" + }, + "mentionedDocuments": { + "$ref": "EnterpriseTopazSidekickDocumentPerCategoryList" + }, + "sharedDocuments": { + "$ref": "EnterpriseTopazSidekickDocumentPerCategoryList" + } + }, + "type": "object" + }, + "EnterpriseTopazSidekickGetAndKeepAheadCardProtoDeclinedEvents": { + "description": "A list of events where all guests declined.", + "id": "EnterpriseTopazSidekickGetAndKeepAheadCardProtoDeclinedEvents", + "properties": { + "events": { + "items": { + "$ref": "EnterpriseTopazSidekickAgendaEntry" + }, + "type": "array" + } + }, + "type": "object" + }, + "EnterpriseTopazSidekickMeetingNotesCardError": { + "description": "Errors in the creation of meeting notes.", + "id": "EnterpriseTopazSidekickMeetingNotesCardError", + "properties": { + "description": { + "description": "The description of the reason why create-meeting-notes failed.", + "type": "string" + }, + "event": { + "$ref": "EnterpriseTopazSidekickAgendaEntry", + "description": "The event to request meeting notes creation" + }, + "reason": { + "description": "The reason why create-meeting-notes failed.", + "enum": [ + "NONE", + "NOT_OWNER", + "UNKNOWN" + ], + "enumDescriptions": [ + "No reason (default value).", + "The user is not an owner.", + "Unknown reason." + ], + "type": "string" + } + }, + "type": "object" + }, + "EnterpriseTopazSidekickMeetingNotesCardProto": { + "description": "Information about the meeting notes created.", + "id": "EnterpriseTopazSidekickMeetingNotesCardProto", + "properties": { + "event": { + "$ref": "EnterpriseTopazSidekickAgendaEntry", + "description": "The event to request meeting notes creation." + }, + "fileId": { + "description": "Google Drive ID (a.k.a. resource ID) of the file.", + "type": "string" + }, + "title": { + "description": "Title we want to show for meeting notes in the answer card", + "type": "string" + }, + "url": { + "description": "New URL.", + "type": "string" + } + }, + "type": "object" + }, + "EnterpriseTopazSidekickMeetingNotesCardRequest": { + "description": "Meeting notes card request.", + "id": "EnterpriseTopazSidekickMeetingNotesCardRequest", + "properties": { + "canCreateFor": { + "description": "Who are the meeting notes created for.", + "items": { + "enum": [ + "UNKNOWN", + "MYSELF", + "ALL_ATTENDEES" + ], + "enumDescriptions": [ + "Unknown (default).", + "For the requester.", + "For all the meeting attendees." + ], + "type": "string" + }, + "type": "array" + }, + "error": { + "$ref": "EnterpriseTopazSidekickMeetingNotesCardError", + "description": "The error and reason if known error occured." + }, + "event": { + "$ref": "EnterpriseTopazSidekickAgendaEntry", + "description": "The event to request meeting notes creation" + } + }, + "type": "object" + }, + "EnterpriseTopazSidekickNlpMetadata": { + "description": "Metadata about the NLP interpretation of the query.", + "id": "EnterpriseTopazSidekickNlpMetadata", + "properties": { + "confidence": { + "description": "Confidence of the interpretation that generated this card.", + "format": "float", + "type": "number" + } + }, + "type": "object" + }, + "EnterpriseTopazSidekickPeopleAnswerDisambiguationInfo": { + "description": "Metadata for disambiguation.", + "id": "EnterpriseTopazSidekickPeopleAnswerDisambiguationInfo", + "properties": { + "disambiguation": { + "description": "A list of people that also matched the query. This list is not complete.", + "items": { + "$ref": "EnterpriseTopazSidekickPeopleAnswerDisambiguationInfoDisambiguationPerson" + }, + "type": "array" + }, + "name": { + "description": "The name that was extracted from the query. This may be in the form of the given name, last name, full name, LDAP, or email address. This name can be considered suitable for displaying to the user and can largely be considered to be normalized (e.g. \"Bob's\" -> \"Bob\").", + "type": "string" + } + }, + "type": "object" + }, + "EnterpriseTopazSidekickPeopleAnswerDisambiguationInfoDisambiguationPerson": { + "description": "A person that also matches the query, but was not selected due to a lower affinity with the requesting user.", + "id": "EnterpriseTopazSidekickPeopleAnswerDisambiguationInfoDisambiguationPerson", + "properties": { + "person": { + "$ref": "EnterpriseTopazSidekickCommonPerson", + "description": "The profile of this person." + }, + "query": { + "description": "The query that can be used to produce an answer card with the same attribute, but for this person.", + "type": "string" + } + }, + "type": "object" + }, + "EnterpriseTopazSidekickPeopleAnswerPeopleAnswerCardHeader": { + "description": "Recommended header to display for the card.", + "id": "EnterpriseTopazSidekickPeopleAnswerPeopleAnswerCardHeader", + "properties": { + "title": { + "description": "The suggested title to display. This defaults to the user's query.", + "type": "string" + } + }, + "type": "object" + }, + "EnterpriseTopazSidekickPeopleAnswerPersonAnswerCard": { + "description": "An answer card for a single person.", + "id": "EnterpriseTopazSidekickPeopleAnswerPersonAnswerCard", + "properties": { + "answer": { + "deprecated": true, + "description": "List of answers.", + "items": { + "$ref": "SafeHtmlProto" + }, + "type": "array" + }, + "answerText": { + "$ref": "EnterpriseTopazSidekickAnswerAnswerList", + "description": "List of answers." + }, + "disambiguationInfo": { + "$ref": "EnterpriseTopazSidekickPeopleAnswerDisambiguationInfo", + "description": "Disambiguation information." + }, + "header": { + "$ref": "EnterpriseTopazSidekickPeopleAnswerPeopleAnswerCardHeader", + "description": "The header to display for the card." + }, + "responseStatus": { + "description": "The response status.", + "enum": [ + "UNKNOWN", + "SUCCESS", + "MISSING_PERSON", + "MISSING_DATA" + ], + "enumDescriptions": [ + "Unknown.", + "Success.", + "No such person was found in the user's domain.", + "A person was found to match the query, but an answer could not be obtained." + ], + "type": "string" + }, + "statusMessage": { + "description": "Localized user friendly message to display to the user in the case of missing data or an error.", + "type": "string" + }, + "subject": { + "$ref": "EnterpriseTopazSidekickCommonPerson", + "description": "The profile of the person that was the subject of the query." + } + }, + "type": "object" + }, + "EnterpriseTopazSidekickPeopleAnswerRelatedPeopleAnswerCard": { + "description": "An answer card for a list of people that are related to the subject of the query.", + "id": "EnterpriseTopazSidekickPeopleAnswerRelatedPeopleAnswerCard", + "properties": { + "disambiguationInfo": { + "$ref": "EnterpriseTopazSidekickPeopleAnswerDisambiguationInfo", + "description": "Disambiguation information." + }, + "header": { + "$ref": "EnterpriseTopazSidekickPeopleAnswerPeopleAnswerCardHeader", + "description": "The header to display for the card." + }, + "relatedPeople": { + "description": "A list of people that are related to the query subject.", + "items": { + "$ref": "EnterpriseTopazSidekickCommonPerson" + }, + "type": "array" + }, + "relationType": { + "description": "Defines the type of relation the list of people have with the subject of the card.", + "enum": [ + "UNKNOWN", + "DIRECT_REPORTS", + "MANAGER", + "PEERS" + ], + "enumDescriptions": [ + "Unknown.", + "Direct reports.", + "The manager.", + "The teammates/peers of the subject." + ], + "type": "string" + }, + "responseStatus": { + "description": "The response status.", + "enum": [ + "UNKNOWN", + "SUCCESS", + "MISSING_PERSON", + "MISSING_DATA" + ], + "enumDescriptions": [ + "Unknown.", + "Success.", + "No such person was found in the user's domain.", + "A person was found to match the query, but an answer could not be obtained." + ], + "type": "string" + }, + "statusMessage": { + "description": "Localized user friendly message to display to the user in the case of missing data or an error.", + "type": "string" + }, + "subject": { + "$ref": "EnterpriseTopazSidekickCommonPerson", + "description": "The profile of the person that was the subject of the query." + } + }, + "type": "object" + }, + "EnterpriseTopazSidekickPeopleDisambiguationCard": { + "id": "EnterpriseTopazSidekickPeopleDisambiguationCard", + "properties": { + "person": { + "description": "Candidate persons for the query.", + "items": { + "$ref": "EnterpriseTopazSidekickCommonPerson" + }, + "type": "array" + } + }, + "type": "object" + }, + "EnterpriseTopazSidekickPerson": { + "description": "Person.", + "id": "EnterpriseTopazSidekickPerson", + "properties": { + "affinityLevel": { + "description": "The level of affinity this person has with the requesting user.", + "enum": [ + "UNKNOWN", + "LOW", + "MEDIUM", + "HIGH" + ], + "enumDescriptions": [ + "", + "", + "", + "" + ], + "type": "string" + }, + "attendingStatus": { + "description": "Attendance status of the person when included in a meeting event.", + "enum": [ + "AWAITING", + "YES", + "NO", + "MAYBE" + ], + "enumDescriptions": [ + "Awaiting for the user to set the status.", + "Attending.", + "Not attending.", + "Tentatively attending." + ], + "type": "string" + }, + "email": { + "description": "Email.", + "type": "string" + }, + "gaiaId": { + "deprecated": true, + "description": "Gaia id.", + "format": "int64", + "type": "string" + }, + "isGroup": { + "description": "Whether the invitee is a group.", + "type": "boolean" + }, + "name": { + "description": "Name.", + "type": "string" + }, + "obfuscatedGaiaId": { + "description": "Obfuscated Gaia id.", + "type": "string" + }, + "photoUrl": { + "description": "Absolute URL to the profile photo of the person.", + "type": "string" + } + }, + "type": "object" + }, + "EnterpriseTopazSidekickPersonProfileCard": { + "id": "EnterpriseTopazSidekickPersonProfileCard", + "properties": { + "relatedPeople": { + "items": { + "$ref": "EnterpriseTopazSidekickPersonProfileCardRelatedPeople" + }, + "type": "array" + }, + "subject": { + "$ref": "EnterpriseTopazSidekickCommonPerson", + "description": "The subject of the card." + } + }, + "type": "object" + }, + "EnterpriseTopazSidekickPersonProfileCardRelatedPeople": { + "id": "EnterpriseTopazSidekickPersonProfileCardRelatedPeople", + "properties": { + "relatedPerson": { + "description": "Related people.", + "items": { + "$ref": "EnterpriseTopazSidekickCommonPerson" + }, + "type": "array" + }, + "relation": { + "description": "Relation type.", + "enum": [ + "UNKNOWN", + "MANAGER", + "DIRECT_REPORT" + ], + "enumDescriptions": [ + "", + "", + "" + ], + "type": "string" + } + }, + "type": "object" + }, + "EnterpriseTopazSidekickPersonalizedDocsCardProto": { + "description": "Personalized docs card proto.", + "id": "EnterpriseTopazSidekickPersonalizedDocsCardProto", + "properties": { + "documentGroup": { + "description": "Document group.", + "items": { + "$ref": "EnterpriseTopazSidekickDocumentGroup" + }, + "type": "array" + } + }, + "type": "object" + }, + "EnterpriseTopazSidekickRankingParams": { + "description": "Ranking params.", + "id": "EnterpriseTopazSidekickRankingParams", + "properties": { + "endTimeMs": { + "description": "The end-time that this object will expect to occur. If the type is marked as FIXED, then this end-time will persist after bidding. If the type is marked as FLEXIBLE, this field is NOT expected to be filled and will be filled in after it has won a bid. Expected to be set when type is set to FIXED.", + "format": "uint64", + "type": "string" + }, + "priority": { + "description": "The priority to determine between objects that have the same start_time_ms The lower-value of priority == ranked higher. Max-priority = 0. Expected to be set for all types.", + "enum": [ + "UNKNOWN", + "CRITICAL", + "IMPORTANT", + "HIGH", + "NORMAL", + "BEST_EFFORT" + ], + "enumDescriptions": [ + "Unknown (default).", + "Critical.", + "Important.", + "High.", + "Normal.", + "Best effort." + ], + "type": "string" + }, + "score": { + "description": "The score of the card to be used to break priority-ties", + "format": "float", + "type": "number" + }, + "spanMs": { + "description": "The span that this card will take in the stream Expected to be set when type is set to FLEXIBLE.", + "format": "uint64", + "type": "string" + }, + "startTimeMs": { + "description": "The start-time that this object will bid-for If the type is marked as FIXED, then this start-time will persist after bidding. If the type is marked as FLEXIBLE, then it will occur at the given time or sometime after the requested time. Expected to be set for all types.", + "format": "uint64", + "type": "string" + }, + "type": { + "description": "The packing type of this object.", + "enum": [ + "FIXED", + "FLEXIBLE" + ], + "enumDescriptions": [ + "Fixed, i.e., the card is time sensitive.", + "Flexible, i.e., the card is not time sensitive." + ], + "type": "string" + } + }, + "type": "object" + }, + "EnterpriseTopazSidekickRecentDocumentsCardProto": { + "id": "EnterpriseTopazSidekickRecentDocumentsCardProto", + "properties": { + "document": { + "items": { + "$ref": "EnterpriseTopazSidekickCommonDocument" + }, + "type": "array" + } + }, + "type": "object" + }, + "EnterpriseTopazSidekickScheduledMeeting": { + "description": "Details about scheduled meetings.", + "id": "EnterpriseTopazSidekickScheduledMeeting", + "properties": { + "meetingLocation": { + "description": "The meeting location.", + "type": "string" + }, + "meetingTime": { + "$ref": "EnterpriseTopazSidekickTimeSlot", + "description": "The meeting time slot." + }, + "meetingTitle": { + "description": "The meeting title.", + "type": "string" + } + }, + "type": "object" + }, + "EnterpriseTopazSidekickShareMeetingDocsCardProto": { + "description": "Share meeting docs card proto.", + "id": "EnterpriseTopazSidekickShareMeetingDocsCardProto", + "properties": { + "document": { + "description": "Documents to share for the given meeting.", + "items": { + "$ref": "EnterpriseTopazSidekickCommonDocument" + }, + "type": "array" + }, + "event": { + "$ref": "EnterpriseTopazSidekickAgendaEntry", + "description": "Event." + } + }, + "type": "object" + }, + "EnterpriseTopazSidekickTimeSlot": { + "description": "Slot of time.", + "id": "EnterpriseTopazSidekickTimeSlot", + "properties": { + "endTimeDay": { + "description": "Day end time at the user's timezone.", + "type": "string" + }, + "endTimeHourAndMinute": { + "description": "Hour and minute of the end time at the user's timezone.", + "type": "string" + }, + "endTimeInMillis": { + "description": "End time in milliseconds.", + "format": "int64", + "type": "string" + }, + "startTimeDay": { + "description": "Day start time at user's timezone.", + "type": "string" + }, + "startTimeHourAndMinute": { + "description": "Hour and minute of the start time at the user's timezone.", + "type": "string" + }, + "startTimeInMillis": { + "description": "Start time in milliseconds.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "EnumOperatorOptions": { + "description": "Used to provide a search operator for enum properties. This is optional. Search operators let users restrict the query to specific fields relevant to the type of item being searched. For example, if you provide no operator for a *priority* enum property with possible values *p0* and *p1*, a query that contains the term *p0* returns items that have *p0* as the value of the *priority* property, as well as any items that contain the string *p0* in other fields. If you provide an operator name for the enum, such as *priority*, then search users can use that operator to refine results to only items that have *p0* as this property's value, with the query *priority:p0*.", + "id": "EnumOperatorOptions", + "properties": { + "operatorName": { + "description": "Indicates the operator name required in the query in order to isolate the enum property. For example, if operatorName is *priority* and the property's name is *priorityVal*, then queries like *priority:* show results only where the value of the property named *priorityVal* matches **. By contrast, a search that uses the same ** without an operator returns all items where ** matches the value of any String properties or text within the content field for the item. The operator name can only contain lowercase letters (a-z). The maximum length is 32 characters.", + "type": "string" + } + }, + "type": "object" + }, + "EnumPropertyOptions": { + "description": "The options for enum properties, which allow you to define a restricted set of strings to match user queries, set rankings for those string values, and define an operator name to be paired with those strings so that users can narrow results to only items with a specific value. For example, for items in a request tracking system with priority information, you could define *p0* as an allowable enum value and tie this enum to the operator name *priority* so that search users could add *priority:p0* to their query to restrict the set of results to only those items indexed with the value *p0*.", + "id": "EnumPropertyOptions", + "properties": { + "operatorOptions": { + "$ref": "EnumOperatorOptions", + "description": "If set, describes how the enum should be used as a search operator." + }, + "orderedRanking": { + "description": "Used to specify the ordered ranking for the enumeration that determines how the integer values provided in the possible EnumValuePairs are used to rank results. If specified, integer values must be provided for all possible EnumValuePair values given for this property. Can only be used if isRepeatable is false.", + "enum": [ + "NO_ORDER", + "ASCENDING", + "DESCENDING" + ], + "enumDescriptions": [ + "There is no ranking order for the property. Results aren't adjusted by this property's value.", + "This property is ranked in ascending order. Lower values indicate lower ranking.", + "This property is ranked in descending order. Lower values indicate higher ranking." + ], + "type": "string" + }, + "possibleValues": { + "description": "The list of possible values for the enumeration property. All EnumValuePairs must provide a string value. If you specify an integer value for one EnumValuePair, then all possible EnumValuePairs must provide an integer value. Both the string value and integer value must be unique over all possible values. Once set, possible values cannot be removed or modified. If you supply an ordered ranking and think you might insert additional enum values in the future, leave gaps in the initial integer values to allow adding a value in between previously registered values. The maximum number of elements is 100.", + "items": { + "$ref": "EnumValuePair" + }, + "type": "array" + } + }, + "type": "object" + }, + "EnumValuePair": { + "description": "The enumeration value pair defines two things: a required string value and an optional integer value. The string value defines the necessary query term required to retrieve that item, such as *p0* for a priority item. The integer value determines the ranking of that string value relative to other enumerated values for the same property. For example, you might associate *p0* with *0* and define another enum pair such as *p1* and *1*. You must use the integer value in combination with ordered ranking to set the ranking of a given value relative to other enumerated values for the same property name. Here, a ranking order of DESCENDING for *priority* properties results in a ranking boost for items indexed with a value of *p0* compared to items indexed with a value of *p1*. Without a specified ranking order, the integer value has no effect on item ranking.", + "id": "EnumValuePair", + "properties": { + "integerValue": { + "description": "The integer value of the EnumValuePair which must be non-negative. Optional.", + "format": "int32", + "type": "integer" + }, + "stringValue": { + "description": "The string value of the EnumValuePair. The maximum length is 32 characters.", + "type": "string" + } + }, + "type": "object" + }, + "EnumValues": { + "description": "List of enum values.", + "id": "EnumValues", + "properties": { + "values": { + "description": "The maximum allowable length for string values is 32 characters.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "ErrorInfo": { + "description": "Error information about the response.", + "id": "ErrorInfo", + "properties": { + "errorMessages": { + "items": { + "$ref": "ErrorMessage" + }, + "type": "array" + } + }, + "type": "object" + }, + "ErrorMessage": { + "description": "Error message per source response.", + "id": "ErrorMessage", + "properties": { + "errorMessage": { + "type": "string" + }, + "source": { + "$ref": "Source" + } + }, + "type": "object" + }, + "FacetBucket": { + "description": "A bucket in a facet is the basic unit of operation. A bucket can comprise either a single value OR a contiguous range of values, depending on the type of the field bucketed. FacetBucket is currently used only for returning the response object.", + "id": "FacetBucket", + "properties": { + "count": { + "description": "Number of results that match the bucket value. Counts are only returned for searches when count accuracy is ensured. Cloud Search does not guarantee facet counts for any query and facet counts might be present only intermittently, even for identical queries. Do not build dependencies on facet count existence; instead use facet ount percentages which are always returned.", + "format": "int32", + "type": "integer" + }, + "filter": { + "$ref": "Filter", + "description": "Filter to be passed in the search request if the corresponding bucket is selected." + }, + "percentage": { + "description": "Percent of results that match the bucket value. The returned value is between (0-100], and is rounded down to an integer if fractional. If the value is not explicitly returned, it represents a percentage value that rounds to 0. Percentages are returned for all searches, but are an estimate. Because percentages are always returned, you should render percentages instead of counts.", + "format": "int32", + "type": "integer" + }, + "value": { + "$ref": "Value" + } + }, + "type": "object" + }, + "FacetOptions": { + "description": "Specifies operators to return facet results for. There will be one FacetResult for every source_name/object_type/operator_name combination.", + "id": "FacetOptions", + "properties": { + "integerFacetingOptions": { + "$ref": "IntegerFacetingOptions", + "description": "If set, describes integer faceting options for the given integer property. The corresponding integer property in the schema should be marked isFacetable. The number of buckets returned would be minimum of this and num_facet_buckets." + }, + "numFacetBuckets": { + "description": "Maximum number of facet buckets that should be returned for this facet. Defaults to 10. Maximum value is 100.", + "format": "int32", + "type": "integer" + }, + "objectType": { + "description": "If object_type is set, only those objects of that type will be used to compute facets. If empty, then all objects will be used to compute facets.", + "type": "string" + }, + "operatorName": { + "description": "The name of the operator chosen for faceting. @see cloudsearch.SchemaPropertyOptions", + "type": "string" + }, + "sourceName": { + "description": "Source name to facet on. Format: datasources/{source_id} If empty, all data sources will be used.", + "type": "string" + } + }, + "type": "object" + }, + "FacetResult": { + "description": "Source specific facet response", + "id": "FacetResult", + "properties": { + "buckets": { + "description": "FacetBuckets for values in response containing at least a single result with the corresponding filter.", + "items": { + "$ref": "FacetBucket" + }, + "type": "array" + }, + "objectType": { + "description": "Object type for which facet results are returned. Can be empty.", + "type": "string" + }, + "operatorName": { + "description": "The name of the operator chosen for faceting. @see cloudsearch.SchemaPropertyOptions", + "type": "string" + }, + "sourceName": { + "description": "Source name for which facet results are returned. Will not be empty.", + "type": "string" + } + }, + "type": "object" + }, + "FieldViolation": { + "id": "FieldViolation", + "properties": { + "description": { + "description": "The description of the error.", + "type": "string" + }, + "field": { + "description": "Path of field with violation.", + "type": "string" + } + }, + "type": "object" + }, + "Filter": { + "description": "A generic way of expressing filters in a query, which supports two approaches: **1. Setting a ValueFilter.** The name must match an operator_name defined in the schema for your data source. **2. Setting a CompositeFilter.** The filters are evaluated using the logical operator. The top-level operators can only be either an AND or a NOT. AND can appear only at the top-most level. OR can appear only under a top-level AND.", + "id": "Filter", + "properties": { + "compositeFilter": { + "$ref": "CompositeFilter" + }, + "valueFilter": { + "$ref": "ValueFilter" + } + }, + "type": "object" + }, + "FilterOptions": { + "description": "Filter options to be applied on query.", + "id": "FilterOptions", + "properties": { + "filter": { + "$ref": "Filter", + "description": "Generic filter to restrict the search, such as `lang:en`, `site:xyz`." + }, + "objectType": { + "description": "If object_type is set, only objects of that type are returned. This should correspond to the name of the object that was registered within the definition of schema. The maximum length is 256 characters.", + "type": "string" + } + }, + "type": "object" + }, + "FreshnessOptions": { + "description": "Indicates which freshness property to use when adjusting search ranking for an item. Fresher, more recent dates indicate higher quality. Use the freshness option property that best works with your data. For fileshare documents, last modified time is most relevant. For calendar event data, the time when the event occurs is a more relevant freshness indicator. In this way, calendar events that occur closer to the time of the search query are considered higher quality and ranked accordingly.", + "id": "FreshnessOptions", + "properties": { + "freshnessDuration": { + "description": "The duration after which an object should be considered stale. The default value is 180 days (in seconds).", + "format": "google-duration", + "type": "string" + }, + "freshnessProperty": { + "description": "This property indicates the freshness level of the object in the index. If set, this property must be a top-level property within the property definitions and it must be a timestamp type or date type. Otherwise, the Indexing API uses updateTime as the freshness indicator. The maximum length is 256 characters. When a property is used to calculate freshness, the value defaults to 2 years from the current time.", + "type": "string" + } + }, + "type": "object" + }, + "GSuitePrincipal": { + "id": "GSuitePrincipal", + "properties": { + "gsuiteDomain": { + "description": "This principal represents all users of the Google Workspace domain of the customer.", + "type": "boolean" + }, + "gsuiteGroupEmail": { + "description": "This principal references a Google Workspace group name.", + "type": "string" + }, + "gsuiteUserEmail": { + "description": "This principal references a Google Workspace user account.", + "type": "string" + } + }, + "type": "object" + }, + "GeostoreFeatureIdProto": { + "description": "A globally unique identifier associated with each feature. We use 128-bit identifiers so that we have lots of bits available to distinguish between features. The feature id currently consists of a 64-bit \"cell id\" that **sometimes** corresponds to the approximate centroid of the feature, plus a 64-bit fingerprint of other identifying information. See more on each respective field in its comments. Feature ids are first assigned when the data is created in MapFacts. After initial creation of the feature, they are immutable. This means that the only properties that you should rely on are that they are unique, and that cell_ids often - but not always - preserve spatial locality. The degree of locality varies as the feature undergoes geometry changes, and should not in general be considered a firm guarantee of the location of any particular feature. In fact, some locationless features have randomized cell IDs! Consumers of FeatureProtos from Mapfacts are guaranteed that fprints in the id field of features will be globally unique. Using the fprint allows consumers who don't need the spatial benefit of cell ids to uniquely identify features in a 64-bit address space. This property is not guaranteed for other sources of FeatureProtos.", + "id": "GeostoreFeatureIdProto", + "properties": { + "cellId": { + "description": "The S2CellId corresponding to the approximate location of this feature as of when it was first created. This can be of variable accuracy, ranging from the exact centroid of the feature at creation, a very large S2 Cell, or even being completely randomized for locationless features. Cell ids have the nice property that they follow a space-filling curve over the surface of the earth. (See s2cellid.h for details.) WARNING: Clients should only use cell IDs to perform spatial locality optimizations. There is no strict guarantee that the cell ID of a feature is related to the current geometry of the feature in any way.", + "format": "uint64", + "type": "string" + }, + "fprint": { + "description": "A 64-bit fingerprint used to identify features. Most clients should rely on MapFacts or OneRing to choose fingerprints. If creating new fprints, the strategy should be chosen so that the chance of collision is remote or non-existent, and the distribution should be reasonably uniform. For example, if the source data assigns unique ids to features, then a fingerprint of the provider name, version, and source id is sufficient.", + "format": "uint64", + "type": "string" + }, + "temporaryData": { + "$ref": "MessageSet", + "description": "A place for clients to attach arbitrary data to a feature ID. Never set in MapFacts." + } + }, + "type": "object" + }, + "GeostoreFieldMetadataProto": { + "description": "Internal field metadata. This part is not exposed to downstream consumers of the repository (read-only clients) but is available to upstream providers to the repository (read-write clients).", + "id": "GeostoreFieldMetadataProto", + "properties": { + "internal": { + "$ref": "GeostoreInternalFieldMetadataProto" + } + }, + "type": "object" + }, + "GeostoreInternalFieldMetadataProto": { + "id": "GeostoreInternalFieldMetadataProto", + "properties": { + "isAuto": { + "description": "Whether or not the piece of data has been generated automatically (i.e., by a bot/automated process based on heuristics/algorithms rather than coming as a fact set by some human user or data provider based on their knowledge). Note that this does NOT imply that the value was set as a result of a bot operation on the repository, since it is conceivable to use a bot/automated process simply as a way of convenience to ingest large amount of canonical/ground truth data.", + "type": "boolean" + }, + "sourceSummary": { + "$ref": "GeostoreInternalSourceSummaryProto", + "description": "Information about the source providing the piece of data this metadata is attached to." + } + }, + "type": "object" + }, + "GeostoreInternalSourceSummaryProto": { + "id": "GeostoreInternalSourceSummaryProto", + "properties": { + "dataset": { + "description": "Within the above provider, the dataset from which this piece of data was generated. For fields that are auto-generated the \"dataset\" is likely to be some algorithm's or program's name. Similar to SourceInfoProto.dataset but with the difference that it is required to always be set. Providers that don't have a concept of dataset may use \"default\".", + "type": "string" + }, + "provider": { + "description": "The data provider from which this piece of data was generated. Equivalent to SourceInfoProto.provider in the public schema.", + "enum": [ + "PROVIDER_ANY", + "PROVIDER_UNKNOWN", + "PROVIDER_NAVTEQ", + "PROVIDER_TELE_ATLAS", + "PROVIDER_TELE_ATLAS_MULTINET", + "PROVIDER_TELE_ATLAS_CODEPOINT", + "PROVIDER_TELE_ATLAS_GEOPOST", + "PROVIDER_TELE_ATLAS_DATAGEO", + "PROVIDER_TELE_ATLAS_ADDRESS_POINTS", + "PROVIDER_TELCONTAR", + "PROVIDER_EUROPA", + "PROVIDER_ROYAL_MAIL", + "PROVIDER_GOOGLE", + "PROVIDER_GOOGLE_HAND_EDIT", + "PROVIDER_GOOGLE_BORDERS", + "PROVIDER_GOOGLE_SUBRANGE", + "PROVIDER_GOOGLE_GT_FUSION", + "PROVIDER_GOOGLE_ZAGAT_CMS", + "PROVIDER_GOOGLE_PLACE_NAVBOOST", + "PROVIDER_GOOGLE_FOOTPRINT", + "PROVIDER_GOOGLE_PRODUCT_TERMS", + "PROVIDER_GOOGLE_POINTCARDS", + "PROVIDER_GOOGLE_BUSINESS_CHAINS", + "PROVIDER_GOOGLE_LOCAL_SUMMARIZATION", + "PROVIDER_GOOGLE_PRONUNCIATIONS", + "PROVIDER_GOOGLE_DUMPLING", + "PROVIDER_GOOGLE_DISTILLERY", + "PROVIDER_GOOGLE_LOCAL_ATTRIBUTE_SUMMARIZATION", + "PROVIDER_GOOGLE_RELATION_MINER", + "PROVIDER_GOOGLE_MAPSPAM", + "PROVIDER_GOOGLE_ROSE", + "PROVIDER_GOOGLE_LOCAL_PLACE_RATINGS", + "PROVIDER_GOOGLE_WIPEOUT", + "PROVIDER_GOOGLE_KNOWLEDGE_GRAPH", + "PROVIDER_GOOGLE_BEEGEES", + "PROVIDER_GOOGLE_REVIEW_SUMMARIZATION", + "PROVIDER_GOOGLE_OFFLINE_NON_CORE_ATTRIBUTE_SUMMARIZATION", + "PROVIDER_GOOGLE_GEO_WORLDMAPS", + "PROVIDER_GOOGLE_GEO_MODERATION", + "PROVIDER_GOOGLE_OYSTER_AUTO_EDITS", + "PROVIDER_GOOGLE_LOCAL_ALCHEMY", + "PROVIDER_GOOGLE_KEROUAC", + "PROVIDER_GOOGLE_MOBRANK", + "PROVIDER_GOOGLE_RAPTURE", + "PROVIDER_GOOGLE_CULTURAL_INSTITUTE", + "PROVIDER_GOOGLE_GEOCODES_FROM_LOCAL_FEEDS", + "PROVIDER_GOOGLE_ATTRIBUTES_FROM_CRAWLED_CHAINS", + "PROVIDER_GOOGLE_TACTILE_MAPS", + "PROVIDER_GOOGLE_MAPS_FOR_MOBILE", + "PROVIDER_GOOGLE_GEO_REALTIME", + "PROVIDER_GOOGLE_PROMINENT_PLACES", + "PROVIDER_GOOGLE_PLACE_ACTIONS", + "PROVIDER_GOOGLE_GT_AUTO_EDITS", + "PROVIDER_GOOGLE_WAZE", + "PROVIDER_GOOGLE_ONTHEGO", + "PROVIDER_GOOGLE_GT_IMPORT", + "PROVIDER_GOOGLE_STRUCTURED_DATA", + "PROVIDER_GOOGLE_HELICOPTER", + "PROVIDER_GOOGLE_ROLLBACK", + "PROVIDER_GOOGLE_RIGHTS_REPAIR", + "PROVIDER_GOOGLE_PERFUME", + "PROVIDER_GOOGLE_MAPS_TRANSLATION", + "PROVIDER_GOOGLE_CALL_ME_MAYBE", + "PROVIDER_GOOGLE_LOCAL_UNIVERSAL", + "PROVIDER_GOOGLE_CROUPIER", + "PROVIDER_GOOGLE_SKYSMART", + "PROVIDER_GOOGLE_RIDDLER", + "PROVIDER_GOOGLE_ROADCLOSURES", + "PROVIDER_GOOGLE_SPORE", + "PROVIDER_GOOGLE_LOCALIZATION", + "PROVIDER_GOOGLE_CATTERMS", + "PROVIDER_GOOGLE_GT_FIELD_OPS", + "PROVIDER_GOOGLE_MATCHMAKER", + "PROVIDER_GOOGLE_ARBITRATION", + "PROVIDER_GOOGLE_BIZBUILDER_OPS", + "PROVIDER_GOOGLE_LOCAL_INVENTORY_ADS", + "PROVIDER_GOOGLE_GT_DRAFTY", + "PROVIDER_GOOGLE_HOTELADS_OPS", + "PROVIDER_GOOGLE_MARKERS", + "PROVIDER_GOOGLE_STATE_MACHINE", + "PROVIDER_GOOGLE_ATTRIBUTES_INFERENCE", + "PROVIDER_GOOGLE_BIKESHARE", + "PROVIDER_GOOGLE_GHOSTWRITER", + "PROVIDER_GOOGLE_EDIT_PLATFORM", + "PROVIDER_GOOGLE_BLUE_GINGER", + "PROVIDER_GOOGLE_GEO_TIGER", + "PROVIDER_GOOGLE_HYADES", + "PROVIDER_GOOGLE_WEBQUARRY", + "PROVIDER_GOOGLE_GEO_MADDEN", + "PROVIDER_GOOGLE_ANDROID_PAY", + "PROVIDER_GOOGLE_OPENING_HOURS_TEAM", + "PROVIDER_GOOGLE_LOCAL_DISCOVERY", + "PROVIDER_GOOGLE_LOCAL_HEALTH", + "PROVIDER_GOOGLE_UGC_MAPS", + "PROVIDER_GOOGLE_FIBER", + "PROVIDER_GOOGLE_REVGEO", + "PROVIDER_GOOGLE_HOTELADS_PARTNER_FRONT_END", + "PROVIDER_GOOGLE_GEO_UGC_TASKS", + "PROVIDER_GOOGLE_GEOCODING", + "PROVIDER_GOOGLE_SPYGLASS", + "PROVIDER_GOOGLE_PLUS_CODES_AS_ADDRESSES", + "PROVIDER_GOOGLE_GEO_CHANGES", + "PROVIDER_GOOGLE_HUME", + "PROVIDER_GOOGLE_MEGAMIND", + "PROVIDER_GOOGLE_GT_ROADSYNTH", + "PROVIDER_GOOGLE_FIREBOLT", + "PROVIDER_GOOGLE_LOCAL_PLACE_OFFERINGS", + "PROVIDER_GOOGLE_UGC_SERVICES", + "PROVIDER_GOOGLE_GEOALIGN", + "PROVIDER_GOOGLE_GT_COMPOUNDS", + "PROVIDER_GOOGLE_FOOD_ORDERING", + "PROVIDER_GOOGLE_HOTEL_KNOWLEDGE_OPS", + "PROVIDER_GOOGLE_URAW", + "PROVIDER_GOOGLE_FLYEYE", + "PROVIDER_GOOGLE_YOUKE", + "PROVIDER_GOOGLE_GT_ZEPHYR", + "PROVIDER_GOOGLE_USER_SAFETY", + "PROVIDER_GOOGLE_ADDRESS_MAKER", + "PROVIDER_GOOGLE_UGC_PHOTOS", + "PROVIDER_GOOGLE_GT_WINDCHIME", + "PROVIDER_GOOGLE_SNAG_FIXER", + "PROVIDER_GOOGLE_GEO_DEALS", + "PROVIDER_GOOGLE_LOCAL_PLACE_TOPICS", + "PROVIDER_GOOGLE_PROPERTY_INSIGHTS", + "PROVIDER_GOOGLE_GEO_CONSUMER_MERCHANT_EXPERIMENTS", + "PROVIDER_GOOGLE_GEO_PORTKEY", + "PROVIDER_GOOGLE_ROAD_MAPPER", + "PROVIDER_GOOGLE_LOCATION_PLATFORM", + "PROVIDER_GOOGLE_POSTTRIP", + "PROVIDER_GOOGLE_TRAVEL_DESTINATION", + "PROVIDER_GOOGLE_GEO_DATA_UPLOAD", + "PROVIDER_GOOGLE_BIZBUILDER_CLEANUP", + "PROVIDER_GOOGLE_USER", + "PROVIDER_GOOGLE_STATION", + "PROVIDER_GOOGLE_GEO_FOOD", + "PROVIDER_GOOGLE_GEO_AR", + "PROVIDER_GOOGLE_GEO_TEMPORAL", + "PROVIDER_GOOGLE_SERVICES_MARKETPLACE", + "PROVIDER_GOOGLE_IMT_CLEANUP", + "PROVIDER_GOOGLE_GEO_FOOD_MENU", + "PROVIDER_GOOGLE_CARENAV", + "PROVIDER_GOOGLE_DRIVING_FEEDS", + "PROVIDER_GOOGLE_DRIVING_UGC", + "PROVIDER_GOOGLE_POLAR", + "PROVIDER_GOOGLE_TRIWILD", + "PROVIDER_GOOGLE_CROWD_COMPUTE_OPS", + "PROVIDER_GOOGLE_SA_FROM_WEB", + "PROVIDER_GOOGLE_POI_ALIGNMENT", + "PROVIDER_GOOGLE_SA_FROM_HULK", + "PROVIDER_GOOGLE_SERVICES_INTERACTIONS", + "PROVIDER_GOOGLE_ROADS_UGC_EDITOR", + "PROVIDER_GOOGLE_SA_FROM_NG_INFERENCE", + "PROVIDER_GOOGLE_GEO_DRIVING_VIZ", + "PROVIDER_GOOGLE_GEO_TASKING", + "PROVIDER_GOOGLE_CROWDTASK_DATACOMPUTE", + "PROVIDER_GOOGLE_CROWDTASK_TASKADS", + "PROVIDER_GOOGLE_CROWDTASK_TASKMATE", + "PROVIDER_GOOGLE_CROWDTASK_FURBALL", + "PROVIDER_GOOGLE_CROWDTASK_ADAP", + "PROVIDER_GOOGLE_GPAY", + "PROVIDER_GOOGLE_GEO_UGC_TRUSTED_USERS", + "PROVIDER_GOOGLE_THIRD_PARTY_DATA_PRODUCTION", + "PROVIDER_GOOGLE_GEOTRACKER", + "PROVIDER_GOOGLE_LOCAL_LANDMARK_INFERENCE", + "PROVIDER_GOOGLE_GEO_CLOSED_LOOP", + "PROVIDER_GOOGLE_SA_FROM_MERCHANT_POSTS", + "PROVIDER_GOOGLE_CORE_DATA_RIGHTS", + "PROVIDER_GOOGLE_SA_FROM_USER_REVIEWS", + "PROVIDER_GOOGLE_GEO_CONTENT_FIXER", + "PROVIDER_GOOGLE_POLYGON_REFINEMENT", + "PROVIDER_GOOGLE_HANASU", + "PROVIDER_GOOGLE_FULLRIGHTS_GEO_DATA_UPLOAD", + "PROVIDER_GOOGLE_FULLRIGHTS_3P_OUTREACH_UPLOAD", + "PROVIDER_GOOGLE_ATTRIBUTION_3P_OUTREACH_UPLOAD", + "PROVIDER_GOOGLE_SA_FROM_FOOD_MENUS", + "PROVIDER_GOOGLE_GT_CONSISTENCY_EDITS", + "PROVIDER_GOOGLE_SA_QUALITY", + "PROVIDER_GOOGLE_GDCE_CLEANUP", + "PROVIDER_GOOGLE_UGC_QUALITY_CHAINS", + "PROVIDER_GOOGLE_ATTRIBUTES_DISCOVERY", + "PROVIDER_GOOGLE_GEO_LDE", + "PROVIDER_GOOGLE_GEO_SIGNAL_TRACKING", + "PROVIDER_GOOGLE_UGC_AGGREGATION", + "PROVIDER_GOOGLE_3D_BASEMAP", + "PROVIDER_GOOGLE_MAPFACTS_PRIVACY", + "PROVIDER_GOOGLE_GT_ALF", + "PROVIDER_GOOGLE_GT_OPERATOR_PROVENANCE", + "PROVIDER_GOOGLE_LOCAL_SERVICES_ADS", + "PROVIDER_GOOGLE_GT_LANE_AUTOMATION", + "PROVIDER_GOOGLE_GEO_NG_LOCAL", + "PROVIDER_GOOGLE_MAPFACTS_CLEANUP", + "PROVIDER_GOOGLE_THIRD_PARTY_UGC", + "PROVIDER_GOOGLE_GEO_ISSUE_ADMIN", + "PROVIDER_GOOGLE_VACATION_RENTAL_PARTNERS", + "PROVIDER_GOOGLE_FEED_PROCESSOR_ROAD_INCIDENTS", + "PROVIDER_GOOGLE_DYNAMIC_BASEMAP", + "PROVIDER_GOOGLE_LOCAL_SERVICES_ADS_EMEA", + "PROVIDER_GOOGLE_RWJ_INDIA_FOOD", + "PROVIDER_GOOGLE_LOCALSEARCH", + "PROVIDER_GOOGLE_TRANSIT", + "PROVIDER_GOOGLE_GEOWIKI", + "PROVIDER_GOOGLE_CHINA_LOCAL_TEAM", + "PROVIDER_GOOGLE_SYNTHESIZED", + "PROVIDER_GOOGLE_INTERNAL_TEST", + "PROVIDER_GOOGLE_DISPUTED_AREAS", + "PROVIDER_GOOGLE_3DWAREHOUSE", + "PROVIDER_GOOGLE_GROUNDS_BUILDER", + "PROVIDER_GOOGLE_SESAME", + "PROVIDER_GOOGLE_GT", + "PROVIDER_GOOGLE_GT_BASEMAP_UPLOAD", + "PROVIDER_GOOGLE_ADSDB", + "PROVIDER_GOOGLE_MACHINE_TRANSLITERATION", + "PROVIDER_GOOGLE_TRAVELSEARCH", + "PROVIDER_GOOGLE_PANORAMIO", + "PROVIDER_GOOGLE_YOUTUBE", + "PROVIDER_GOOGLE_OLD", + "PROVIDER_GOOGLE_STREETVIEW", + "PROVIDER_GOOGLE_STREETVIEW_BIZVIEW", + "PROVIDER_GOOGLE_ZIPIT", + "PROVIDER_GOOGLE_OYSTER_CONNECT_ROUTES", + "PROVIDER_GOOGLE_GOLDEN", + "PROVIDER_GOOGLE_INNERSPACE", + "PROVIDER_GOOGLE_MAPSEARCH", + "PROVIDER_GOOGLE_CATEGORIES_TEAM", + "PROVIDER_GOOGLE_CROWDSENSUS", + "PROVIDER_GOOGLE_LOCAL_ALGORITHMIC_IDENTITY", + "PROVIDER_GOOGLE_FREEBASE", + "PROVIDER_GOOGLE_HOTELADS", + "PROVIDER_GOOGLE_AUTHORITY_PAGES", + "PROVIDER_GOOGLE_PLACES_API", + "PROVIDER_GOOGLE_NAMEHEATMAP", + "PROVIDER_GOOGLE_MAPMAKER", + "PROVIDER_GOOGLE_MAPMAKER_MOBILE", + "PROVIDER_GOOGLE_MAPMAKER_PANCAKE", + "PROVIDER_GOOGLE_MAPMAKER_V2", + "PROVIDER_GOOGLE_LOCAL_CLUSTERING_OPERATOR_OVERRIDE", + "PROVIDER_GOOGLE_SERVED_ON_MAPMAKER", + "PROVIDER_GOOGLE_GT_LOCAL", + "PROVIDER_GOOGLE_GT_LOCAL_WITH_RIGHTS", + "PROVIDER_GOOGLE_LOGS_RANKING_SIGNALS", + "PROVIDER_GOOGLE_ENTITY_NAVBOOST", + "PROVIDER_GOOGLE_RELATED_PLACES", + "PROVIDER_GOOGLE_KNOWN_FOR_TERMS", + "PROVIDER_GOOGLE_SYNTHETIC_AREAS", + "PROVIDER_GOOGLE_AUTHORITY_PAGE_PHOTOS", + "PROVIDER_GOOGLE_CROSS_STREETS", + "PROVIDER_GOOGLE_CORRIDORS", + "PROVIDER_GOOGLE_BICYCLE_RENTAL", + "PROVIDER_GOOGLE_CONCRETE_URLS", + "PROVIDER_GOOGLE_LEANBACK", + "PROVIDER_GOOGLE_LOCKED_LISTINGS", + "PROVIDER_GOOGLE_MONITORING", + "PROVIDER_GOOGLE_SPROUT", + "PROVIDER_GOOGLE_LOCAL_SEARCH_QUALITY", + "PROVIDER_GOOGLE_GOBY", + "PROVIDER_GOOGLE_PROBLEM_REPORT", + "PROVIDER_GOOGLE_CANDID", + "PROVIDER_GOOGLE_BIZBUILDER", + "PROVIDER_AUTOMOTIVE_NAVIGATION_DATA", + "PROVIDER_MAPDATA_SCIENCES", + "PROVIDER_MAPONICS", + "PROVIDER_SKI_RESORTS", + "PROVIDER_ZENRIN", + "PROVIDER_SANBORN", + "PROVIDER_URBAN_MAPPING", + "PROVIDER_US_GOVERNMENT", + "PROVIDER_US_CENSUS", + "PROVIDER_US_POSTAL_SERVICE", + "PROVIDER_US_GEOLOGICAL_SURVEY", + "PROVIDER_US_GNIS", + "PROVIDER_US_LANDSAT", + "PROVIDER_US_NATIONAL_GEOSPATIAL_INTELLIGENCE_AGENCY", + "PROVIDER_US_NGA_GNS", + "PROVIDER_US_SSIBL", + "PROVIDER_US_BUREAU_OF_TRANSPORTATION_STATISTICS", + "PROVIDER_US_NATIONAL_OCEANIC_AND_ATMOSPHERIC_ADMINISTRATION", + "PROVIDER_US_POLAR_GEOSPATIAL_CENTER", + "PROVIDER_US_DEPARTMENT_OF_AGRICULTURE", + "PROVIDER_US_NPI_REGISTRY", + "PROVIDER_US_BUREAU_OF_INDIAN_AFFAIRS", + "PROVIDER_DMTI_SPATIAL", + "PROVIDER_INTERNATIONAL_HYDROGRAPHIC_ORGANIZATION", + "PROVIDER_MAPLINK", + "PROVIDER_KINGWAY", + "PROVIDER_GEOCENTRE", + "PROVIDER_CN_NATIONAL_FOUNDAMENTAL_GIS", + "PROVIDER_CN_MAPABC", + "PROVIDER_SMITHSONIAN_INSTITUTE", + "PROVIDER_TRACKS_FOR_AFRICA", + "PROVIDER_PPWK", + "PROVIDER_LEADDOG", + "PROVIDER_CENTRE_DONNEES_ASTRONOMIQUES_STRASBOURG", + "PROVIDER_GISRAEL", + "PROVIDER_BASARSOFT", + "PROVIDER_MAPINFO", + "PROVIDER_MAPIT", + "PROVIDER_GEOBASE", + "PROVIDER_ORION", + "PROVIDER_CENTRAL_EUROPEAN_DATA_AGENCY", + "PROVIDER_ANASAT", + "PROVIDER_MINED_POSTCODES", + "PROVIDER_DMAPAS", + "PROVIDER_COMMON_LOCALE_DATA_REPOSITORY", + "PROVIDER_CH_SBB", + "PROVIDER_SKENERGY", + "PROVIDER_GBRMPA", + "PROVIDER_KOREA_POST", + "PROVIDER_CN_AUTONAVI", + "PROVIDER_MINED_POI", + "PROVIDER_ML_INFOMAP", + "PROVIDER_SNOOPER", + "PROVIDER_GEOSISTEMAS", + "PROVIDER_AFRIGIS", + "PROVIDER_TRANSNAVICOM", + "PROVIDER_EASYCONNECT", + "PROVIDER_LANTMATERIET", + "PROVIDER_LOGICA", + "PROVIDER_MAPKING", + "PROVIDER_DIANPING", + "PROVIDER_GEONAV", + "PROVIDER_HEIBONSHA", + "PROVIDER_DEUTSCHE_TELEKOM", + "PROVIDER_LINGUISTIC_DATA_CONSORTIUM", + "PROVIDER_ACXIOM", + "PROVIDER_DUN_AND_BRADSTREET", + "PROVIDER_FEDERAL_AVIATION_ADMINISTRATION", + "PROVIDER_INFOUSA", + "PROVIDER_INFOUSA_NIXIE", + "PROVIDER_THOMSON_LOCAL", + "PROVIDER_TELEFONICA_PUBLICIDAD_E_INFORMACION", + "PROVIDER_WIKIPEDIA", + "PROVIDER_INFOBEL", + "PROVIDER_MX_GOVERNMENT", + "PROVIDER_MX_NATIONAL_INSTITUTE_STATISTICS_GEOGRAPHY", + "PROVIDER_MX_SERVICIO_POSTAL_MEXICANO", + "PROVIDER_TELEGATE", + "PROVIDER_TELELISTAS", + "PROVIDER_MAPCITY", + "PROVIDER_EXPLAINER_DC", + "PROVIDER_DAIKEI", + "PROVIDER_NL_CHAMBER_OF_COMMERCE", + "PROVIDER_KOREA_INFO_SERVICE", + "PROVIDER_WIKITRAVEL", + "PROVIDER_FLICKR", + "PROVIDER_DIANCO", + "PROVIDER_VOLT_DELTA", + "PROVIDER_SG_GOVERNMENT", + "PROVIDER_SG_LAND_TRANSPORT_AUTHORITY", + "PROVIDER_MAPBAR", + "PROVIDER_LONGTU", + "PROVIDER_SA_GOVERNMENT", + "PROVIDER_SA_SAUDI_POST", + "PROVIDER_PEAKLIST", + "PROVIDER_LOCAL_BUSINESS_CENTER", + "PROVIDER_LOCAL_FEED_XML", + "PROVIDER_WEB", + "PROVIDER_RAILS_TO_TRAILS", + "PROVIDER_INDIACOM", + "PROVIDER_INFOMEDIA", + "PROVIDER_PICASA", + "PROVIDER_AT_GOVERNMENT", + "PROVIDER_AT_BUNDESAMT_FUR_EICH_UND_VERMESSUNGSWESEN", + "PROVIDER_AT_NATIONAL_TOURIST_OFFICE", + "PROVIDER_AT_AUSTRIA_POST", + "PROVIDER_NO_GOVERNMENT", + "PROVIDER_NO_NORSK_EIENDOMSINFORMASJON", + "PROVIDER_NO_POSTEN_NORGE_AS", + "PROVIDER_CH_GOVERNMENT", + "PROVIDER_CH_SWISS_POST", + "PROVIDER_CH_SWISSTOPO", + "PROVIDER_CH_SWISS_NATIONAL_PARK", + "PROVIDER_NAVIT", + "PROVIDER_GEOSEARCH", + "PROVIDER_DE_GOVERNMENT", + "PROVIDER_BUNDESAMT_KARTOGRAPHIE_UND_GEODASIE", + "PROVIDER_BUNDESNETZAGENTUR", + "PROVIDER_SCHOBER_GROUP", + "PROVIDER_MIREO", + "PROVIDER_PUBLIC_MUNICIPALITY", + "PROVIDER_US_PUBLIC_MUNICIPALITY", + "PROVIDER_US_PUBLIC_MUNICIPALITY_WEBSTER_TEXAS", + "PROVIDER_US_PUBLIC_MUNICIPALITY_AMHERST_MASSACHUSETTS", + "PROVIDER_US_PUBLIC_MUNICIPALITY_BLOOMINGTON_INDIANA", + "PROVIDER_US_PUBLIC_MUNICIPALITY_PASADENA_CALIFORNIA", + "PROVIDER_US_PUBLIC_MUNICIPALITY_CHULA_VISTA_CALIFORNIA", + "PROVIDER_US_PUBLIC_MUNICIPALITY_TEMPE_ARIZONA", + "PROVIDER_US_PUBLIC_MUNICIPALITY_COLUMBUS_OHIO", + "PROVIDER_US_PUBLIC_MUNICIPALITY_PORTAGE_MICHIGAN", + "PROVIDER_US_PUBLIC_MUNICIPALITY_GEORGETOWN_KENTUCKY", + "PROVIDER_US_PUBLIC_MUNICIPALITY_GREENVILLE_SOUTH_CAROLINA", + "PROVIDER_US_PUBLIC_MUNICIPALITY_NASHVILLE_TENNESSEE", + "PROVIDER_US_PUBLIC_MUNICIPALITY_WASHINGTON_DISTRICT_OF_COLUMBIA", + "PROVIDER_US_PUBLIC_MUNICIPALITY_BOULDER_COLORADO", + "PROVIDER_NZ_PUBLIC_MUNICIPALITY", + "PROVIDER_NZ_PUBLIC_MUNICIPALITY_ENVIRONMENT_BAY", + "PROVIDER_PL_PUBLIC_MUNICIPALITY", + "PROVIDER_PL_PUBLIC_MUNICIPALITY_BIELSKO_BIALA", + "PROVIDER_DE_PUBLIC_MUNICIPALITY", + "PROVIDER_DE_PUBLIC_MUNICIPALITY_FRANKFURT", + "PROVIDER_DE_PUBLIC_MUNICIPALITY_HAMBURG", + "PROVIDER_DE_PUBLIC_MUNICIPALITY_KARLSRUHE", + "PROVIDER_PT_PUBLIC_MUNICIPALITY", + "PROVIDER_PT_PUBLIC_MUNICIPALITY_SANTA_CRUZ", + "PROVIDER_AT_PUBLIC_MUNICIPALITY", + "PROVIDER_AT_PUBLIC_MUNICIPALITY_KLAGENFURT", + "PROVIDER_AT_PUBLIC_MUNICIPALITY_LINZ", + "PROVIDER_ES_PUBLIC_MUNICIPALITY", + "PROVIDER_ES_PUBLIC_MUNICIPALITY_AZKOITIA", + "PROVIDER_ES_PUBLIC_MUNICIPALITY_BEASAIN", + "PROVIDER_ES_PUBLIC_MUNICIPALITY_GIRONA", + "PROVIDER_ES_PUBLIC_MUNICIPALITY_SAN_SEBASTIAN", + "PROVIDER_ES_PUBLIC_MUNICIPALITY_CATALUNYA", + "PROVIDER_ES_PUBLIC_MUNICIPALITY_HONDARRIBIA", + "PROVIDER_AU_PUBLIC_MUNICIPALITY", + "PROVIDER_AU_PUBLIC_MUNICIPALITY_LAUNCESTON_TASMANIA", + "PROVIDER_IS_PUBLIC_MUNICIPALITY", + "PROVIDER_IS_PUBLIC_MUNICIPALITY_REYKJAVIK", + "PROVIDER_NL_PUBLIC_MUNICIPALITY", + "PROVIDER_NL_PUBLIC_MUNICIPALITY_AMELSTEVEEN", + "PROVIDER_BE_PUBLIC_MUNICIPALITY", + "PROVIDER_BE_PUBLIC_MUNICIPALITY_ANTWERPEN", + "PROVIDER_CA_PUBLIC_MUNICIPALITY", + "PROVIDER_CA_PUBLIC_MUNICIPALITY_FREDERICTON_NEW_BRUNSWICK", + "PROVIDER_CA_PUBLIC_MUNICIPALITY_KAMLOOPS_BRITISH_COLUMBIA", + "PROVIDER_CA_PUBLIC_MUNICIPALITY_NANAIMO_BRITISH_COLUMBIA", + "PROVIDER_CA_PUBLIC_MUNICIPALITY_BANFF_ALBERTA", + "PROVIDER_CA_PUBLIC_MUNICIPALITY_CALGARY_ALBERTA", + "PROVIDER_CA_PUBLIC_MUNICIPALITY_TORONTO_ONTARIO", + "PROVIDER_SE_PUBLIC_MUNICIPALITY", + "PROVIDER_SE_PUBLIC_MUNICIPALITY_UMEA", + "PROVIDER_UA_PUBLIC_MUNICIPALITY", + "PROVIDER_UA_PUBLIC_MUNICIPALITY_KHARKIV", + "PROVIDER_OTHER_PUBLIC_MUNICIPALITY", + "PROVIDER_OTHER_PUBLIC_MUNICIPALITY_AQUA_CALIENTE_CAHUILLA_INDIANS", + "PROVIDER_FR_PUBLIC_MUNICIPALITY", + "PROVIDER_FR_PUBLIC_MUNICIPALITY_PONT_AUDEMER", + "PROVIDER_FR_PUBLIC_MUNICIPALITY_BORDEAUX", + "PROVIDER_SG_PUBLIC_MUNICIPALITY", + "PROVIDER_BR_PUBLIC_MUNICIPALITY", + "PROVIDER_BR_PUBLIC_MUNICIPALITY_RIO_DE_JANEIRO", + "PROVIDER_MAPCUBE", + "PROVIDER_3D_REALITYMAPS", + "PROVIDER_DEUTSCHES_ZENTRUM_FUR_LUFT_UND_RAUMFAHRT", + "PROVIDER_3D_CITIES_SOCIEDADE_ANONIMA", + "PROVIDER_DISNEY", + "PROVIDER_CYBERCITY", + "PROVIDER_PRECISION_LIGHTWORKS_MODELWORKS", + "PROVIDER_VIRTUAL_HUNGARY_LIMITED", + "PROVIDER_VIRTUEL_CITY", + "PROVIDER_SCREAMPOINT_INTERNATIONAL", + "PROVIDER_AGENTSCHAP_VOOR_GEOGRAFISCHE_INFORMATIE_VLAANDEREN", + "PROVIDER_FR_GOVERNMENT", + "PROVIDER_FR_INSTITUT_GEOGRAPHIQUE_NATIONAL", + "PROVIDER_FR_CADASTRE", + "PROVIDER_DIADIEM", + "PROVIDER_THE_WEATHER_CHANNEL", + "PROVIDER_COWI", + "PROVIDER_FALKPLAN_ANDES", + "PROVIDER_NL_GOVERNMENT", + "PROVIDER_NL_KADASTER", + "PROVIDER_NL_BOARD_OF_TOURISM_AND_CONVENTIONS", + "PROVIDER_DIGITAL_MAP_PRODUCTS", + "PROVIDER_SILICE_DIGITAL", + "PROVIDER_TYDAC", + "PROVIDER_ALBRECHT_GOLF", + "PROVIDER_HEALTH_CH", + "PROVIDER_VISITDENMARK", + "PROVIDER_FLYHERE", + "PROVIDER_DIGITAL_DATA_SERVICES", + "PROVIDER_MECOMO", + "PROVIDER_ZA_GOVERNMENT", + "PROVIDER_ZA_RURAL_DEVELOPMENT_LAND_REFORM", + "PROVIDER_SENSIS", + "PROVIDER_JJCONNECT", + "PROVIDER_OPPLYSNINGEN", + "PROVIDER_TELLUS", + "PROVIDER_IQONIA", + "PROVIDER_BE_GOVERNMENT", + "PROVIDER_BE_NATIONAAL_GEOGRAFISCH_INSTITUUT", + "PROVIDER_BE_BRUSSELS_MOBILITY", + "PROVIDER_YELLOWMAP_AG", + "PROVIDER_STIFTUNG_GESUNDHEIT", + "PROVIDER_GIATA", + "PROVIDER_SANPARKS", + "PROVIDER_CENTRE_DINFORMATIQUE_POUR_LA_REGION_BRUXELLOISE", + "PROVIDER_INFOPORTUGAL", + "PROVIDER_NEGOCIOS_DE_TELECOMUNICACOES_E_SISTEMAS_DE_INFORMACAO", + "PROVIDER_COLLINS_BARTHOLOMEW", + "PROVIDER_PROTECT_PLANET_OCEAN", + "PROVIDER_KARTTAKESKUS", + "PROVIDER_FI_GOVERNMENT", + "PROVIDER_FI_NATIONAL_ROAD_ADMINISTRATION", + "PROVIDER_FI_NATIONAL_LAND_SURVEY", + "PROVIDER_FI_STATISTICS_FINLAND", + "PROVIDER_GB_GOVERNMENT", + "PROVIDER_GB_ORDNANCE_SURVEY", + "PROVIDER_NATURAL_ENGLAND", + "PROVIDER_WELSH_GOVERNMENT", + "PROVIDER_GB_OFFICE_FOR_NATIONAL_STATISTICS", + "PROVIDER_EPSILON", + "PROVIDER_PARTNER_FRONT_END", + "PROVIDER_CARTESIA", + "PROVIDER_SE_GOVERNMENT", + "PROVIDER_SE_TRAFIKVERKET", + "PROVIDER_SE_NATURVARDSVERKET", + "PROVIDER_IE_GOVERNMENT", + "PROVIDER_IE_ORDNANCE_SURVEY_IRELAND", + "PROVIDER_LU_GOVERNMENT", + "PROVIDER_LU_P_AND_T_LUXEMBOURG", + "PROVIDER_LU_ADMINISTRATION_DU_CADASTRE_ET_DE_LA_TOPOGRAPHIE", + "PROVIDER_LU_NATIONAL_TOURIST_OFFICE", + "PROVIDER_MAPFLOW", + "PROVIDER_TKARTOR", + "PROVIDER_JUMPSTART", + "PROVIDER_EPTISA", + "PROVIDER_MC_GOVERNMENT", + "PROVIDER_MC_PRINCIPAUTE_DE_MONACO", + "PROVIDER_MONOLIT", + "PROVIDER_ENVIRONMENTAL_SYSTEMS_RESEARCH_INSTITUTE", + "PROVIDER_MODIS", + "PROVIDER_GEOX", + "PROVIDER_GEODIRECTORY", + "PROVIDER_GEOPLAN", + "PROVIDER_INFODIREKT", + "PROVIDER_GEOGLOBAL", + "PROVIDER_DEUTSCHE_POST", + "PROVIDER_TRACASA", + "PROVIDER_CORREOS", + "PROVIDER_ES_GOVERNMENT", + "PROVIDER_ES_CENTRO_NACIONAL_DE_INFORMACION_GEOGRAFICA", + "PROVIDER_EDIMAP", + "PROVIDER_VERIZON", + "PROVIDER_NATIONAL_GEOGRAPHIC_MAPS", + "PROVIDER_PROMAPS", + "PROVIDER_CONSODATA", + "PROVIDER_DE_AGOSTINI", + "PROVIDER_FEDERPARCHI", + "PROVIDER_NAVIGO", + "PROVIDER_ITALIAMAPPE", + "PROVIDER_CZECOT", + "PROVIDER_NATURAL_EARTH", + "PROVIDER_REGIO", + "PROVIDER_SHIPWRECK_CENTRAL", + "PROVIDER_RUTGERS_STATE_UNIVERSITY", + "PROVIDER_TWINICE", + "PROVIDER_NORTHERN_IRELAND_TOURIST_BOARD", + "PROVIDER_INFOGROUP", + "PROVIDER_TNET", + "PROVIDER_CTT_CORREIOS_DE_PORTUGAL", + "PROVIDER_EUROPARC", + "PROVIDER_IUPPITER", + "PROVIDER_MICHAEL_BAUER_INTERNATIONAL", + "PROVIDER_LEPTON", + "PROVIDER_MAPPOINT", + "PROVIDER_GEODATA", + "PROVIDER_RU_GOVERNMENT", + "PROVIDER_RU_FNS_KLADR", + "PROVIDER_BR_GOVERNMENT", + "PROVIDER_BR_INSTITUTO_BRASILEIRO_DO_MEIO_AMBIENTE_E_DOS_RECURSOS_NATURAIS_RENOVAVEIS", + "PROVIDER_BR_MINISTERIO_DO_MEIO_AMBIENTE", + "PROVIDER_BR_AGENCIA_NACIONAL_DE_AGUAS", + "PROVIDER_BR_INSTITUTO_BRASILEIRO_DE_GEOGRAFIA_E_ESTATISTICA", + "PROVIDER_BR_FUNDACAO_NACIONAL_DO_INDIO", + "PROVIDER_BR_DEPARTAMENTO_NACIONAL_DE_INFRAESTRUTURA_DE_TRANSPORTES", + "PROVIDER_AZAVEA", + "PROVIDER_NORTHSTAR", + "PROVIDER_COMMEDI", + "PROVIDER_NEXUS_GEOGRAFICS", + "PROVIDER_INFOERA", + "PROVIDER_AD_GOVERNMENT", + "PROVIDER_AD_AREA_DE_CARTOGRAFIA", + "PROVIDER_MAXXIMA", + "PROVIDER_SI_GOVERNMENT", + "PROVIDER_SI_AGENCY_FOR_ENVIRONMENT", + "PROVIDER_TRANSPORT_HI_TECH_CONSULTANTS", + "PROVIDER_L1_TECHNOLOGIES", + "PROVIDER_TELEMEDIA", + "PROVIDER_CDCOM_PROGOROD", + "PROVIDER_MIT_CITYGUIDE", + "PROVIDER_SUNCART", + "PROVIDER_MICROMAPPER", + "PROVIDER_RICHI", + "PROVIDER_FORUM44", + "PROVIDER_SEAT", + "PROVIDER_VALASSIS", + "PROVIDER_NAVICOM", + "PROVIDER_COLTRACK", + "PROVIDER_PSMA_AUSTRALIA", + "PROVIDER_PT_DUTA_ASTAKONA_GIRINDA", + "PROVIDER_CA_GOVERNMENT", + "PROVIDER_STATISTICS_CANADA", + "PROVIDER_TOCTOC", + "PROVIDER_RMSI", + "PROVIDER_TRUE_TECHNOLOGY", + "PROVIDER_INCREMENT_P_CORPORATION", + "PROVIDER_GOJAVAS", + "PROVIDER_GEOINFORMATION_GROUP", + "PROVIDER_CYBERSOFT", + "PROVIDER_TSENTR_EFFEKTIVNYKH_TEKHNOLOGIY", + "PROVIDER_EE_GOVERNMENT", + "PROVIDER_EE_MAA_AMET", + "PROVIDER_GASBUDDY", + "PROVIDER_DK_GOVERNMENT", + "PROVIDER_DK_GEODATASTYRELSEN", + "PROVIDER_MURCIA_REGION_GOVERNMENT", + "PROVIDER_CORREIOS", + "PROVIDER_WEST_WORLD_MEDIA", + "PROVIDER_INTERNATIONAL_MAPPING_ASSOCIATION", + "PROVIDER_MEDICARE", + "PROVIDER_POLARIS", + "PROVIDER_TW_GOVERNMENT", + "PROVIDER_TW_MINISTRY_OF_THE_INTERIOR_SURVEYING_AND_MAPPING_CENTER", + "PROVIDER_NORDECA", + "PROVIDER_AFRIMAPPING", + "PROVIDER_OVERDRIVE", + "PROVIDER_PROVIDER_NETWORK_DIRECTORIES", + "PROVIDER_BR_MINISTERIO_DA_SAUDE", + "PROVIDER_DIGITAL_EGYPT", + "PROVIDER_INRIX", + "PROVIDER_ARPINDO", + "PROVIDER_IT_GOVERNMENT", + "PROVIDER_ISTITUTO_GEOGRAFICO_MILITARE", + "PROVIDER_EAST_END_GROUP", + "PROVIDER_INGEOLAN", + "PROVIDER_SEMACONNECT", + "PROVIDER_BLINK", + "PROVIDER_EVGO", + "PROVIDER_CHARGEPOINT", + "PROVIDER_TPL_TRAKKER", + "PROVIDER_OI", + "PROVIDER_MAPARADAR", + "PROVIDER_SINGAPORE_POST", + "PROVIDER_CHARGEMASTER", + "PROVIDER_TESLA", + "PROVIDER_VISICOM", + "PROVIDER_GEOLYSIS", + "PROVIDER_ZEPHEIRA", + "PROVIDER_HUBJECT", + "PROVIDER_PODPOINT", + "PROVIDER_CHARGEFOX", + "PROVIDER_KR_GOVERNMENT", + "PROVIDER_KR_MOLIT", + "PROVIDER_KR_MINISTRY_OF_THE_INTERIOR_AND_SAFETY", + "PROVIDER_CRITCHLOW", + "PROVIDER_EIFRIG", + "PROVIDER_GIREVE", + "PROVIDER_CN_NAVINFO", + "PROVIDER_JAPAN_CHARGE_NETWORK", + "PROVIDER_NOBIL", + "PROVIDER_INDIA_BANKS", + "PROVIDER_INDONESIA_ELECTION_KPU", + "PROVIDER_CAREERS360", + "PROVIDER_SOURCE_LONDON", + "PROVIDER_EVBOX", + "PROVIDER_JP_GOVERNMENT", + "PROVIDER_JP_MINISTRY_OF_THE_ENVIRONMENT", + "PROVIDER_YUMYUM", + "PROVIDER_HWW_AUSTRALIA", + "PROVIDER_CINERGY", + "PROVIDER_MTIME", + "PROVIDER_KULTUNAUT", + "PROVIDER_BLITZ", + "PROVIDER_PIA", + "PROVIDER_INTERPARK", + "PROVIDER_CINEMA_ONLINE", + "PROVIDER_BELBIOS", + "PROVIDER_MOVIESEER", + "PROVIDER_SODAMEDYA", + "PROVIDER_ATMOVIES", + "PROVIDER_HOTELBEDS", + "PROVIDER_VERICRED", + "PROVIDER_CIRRANTIC", + "PROVIDER_GOGO_LABS", + "PROVIDER_ELECTRIFY_AMERICA", + "PROVIDER_CMS_MPPUF", + "PROVIDER_DIGIROAD", + "PROVIDER_KONTEX_GEOMATICS", + "PROVIDER_NZ_GOVERNMENT", + "PROVIDER_NZ_LINZ", + "PROVIDER_NZ_DOC", + "PROVIDER_FASTNED", + "PROVIDER_DESTINY_CS", + "PROVIDER_IONITY", + "PROVIDER_EV_CONNECT", + "PROVIDER_PANPAGES", + "PROVIDER_ETECNIC", + "PROVIDER_VOLTA", + "PROVIDER_NISSAN_MEXICO", + "PROVIDER_BMW_GROUP_LATIN_AMERICA", + "PROVIDER_FEDERAL_ELECTRICITY_COMMISSION_MEXICO", + "PROVIDER_VOLVO_CARS_BRASIL", + "PROVIDER_CHARGE_AND_PARKING", + "PROVIDER_DEDUCE_TECHNOLOGIES", + "PROVIDER_SK_TELECOM", + "PROVIDER_ECO_MOVEMENT", + "PROVIDER_GOOGLE_GMS", + "PROVIDER_EASYWAY", + "PROVIDER_PHYSICIAN_COMPARE", + "PROVIDER_HOSPITAL_COMPARE", + "PROVIDER_ENDOLLA_BARCELONA", + "PROVIDER_BE_CHARGE", + "PROVIDER_ONE_NETWORK", + "PROVIDER_CARENAV_DUPLEX", + "PROVIDER_CARENAV_POI", + "PROVIDER_IN_GOVERNMENT", + "PROVIDER_SURVEY_OF_INDIA", + "PROVIDER_E_ON", + "PROVIDER_ELECTRIFY_CANADA", + "PROVIDER_GRIDCARS", + "PROVIDER_DRIVECO", + "PROVIDER_GREEN_ACTION_STUDIOS", + "PROVIDER_GREEN_ACTION_STUDIO", + "PROVIDER_EVINY", + "PROVIDER_MASTERCARD", + "PROVIDER_VATTENFALL", + "PROVIDER_VIETGIS", + "PROVIDER_UNITE", + "PROVIDER_NEOGY", + "PROVIDER_AMPUP", + "PROVIDER_LOOP", + "PROVIDER_ZEST", + "PROVIDER_EZVOLT", + "PROVIDER_JOLT", + "PROVIDER_CHARGESMITH", + "PROVIDER_PLUGO", + "PROVIDER_ELECTRIC_ERA", + "PROVIDER_FLO", + "PROVIDER_DIGITAL_CHARGING_SOLUTIONS", + "PROVIDER_ELECTRIC_PE", + "PROVIDER_PLUGSURFING", + "PROVIDER_ATHER" + ], + "enumDeprecated": [ + false, + false, + true, + false, + true, + true, + true, + true, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + true, + true, + false, + true, + false, + true, + false, + true, + false, + false, + false, + false, + true, + false, + false, + true, + false, + false, + true, + true, + false, + false, + false, + false, + false, + true, + true, + true, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + true, + false, + false, + true, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + 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, + 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, + 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, + true, + true, + false, + false, + false, + false, + false, + true, + false, + true, + false, + false, + true, + true, + false, + true, + false, + true, + true, + false, + true, + false, + false, + false, + false, + true, + true, + true, + true, + true, + true, + false, + false, + false, + true, + false, + true, + false, + true, + true, + true, + false, + true, + true, + true, + false, + false, + true, + true, + true, + false, + false, + false, + false, + 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, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + true, + false, + true, + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + true, + false, + true, + true, + false, + false, + true, + false, + false, + false, + false, + false, + 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, + 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, + 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, + 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, + 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, + 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, + 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, + 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, + 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, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], + "enumDescriptions": [ + "ABSTRACT The root of all provider types. This should never be present on an actual feature, but can be useful when calling InCategory.", + "not actually a legal value, used as sentinel", + "", + "ABSTRACT", + "", + "", + "", + "", + "", + "", + "", + "", + "ABSTRACT", + "", + "All new \"Google\" provider entries must be full ints. The next available ID is: 0x111730C2", + "ABSTRACT", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "This is an internal *only* provider meant for sending wipeout requests to mapfacts.", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "Never rely on source infos with this provider to identify whether or not a feature is a Prominent Place! Instead, use the proper API, localsearch_clustering::QualityTierHelper::IsProminentPlace().", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "UMBRELLA", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "UMBRELLA", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "UMBRELLA", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "Shopping Attributes Discovery", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "UMBRELLA", + "", + "", + "", + "UMBRELLA", + "", + "", + "The next new \"Google\" provider entries should be placed above.", + "UMBRELLA", + "", + "", + "", + "This is a testing provider for teams that wish to integrate with components of the Geo Data Infrastructure that require a valid provider. No production data should ever be sent using this provider.", + "", + "UMBRELLA", + "", + "", + "", + "UMBRELLA", + "0x1117F must not be used, since its range extends the PROVIDER_GOOGLE hierarchy.", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "Deprecated in favor of PROVIDER_GOOGLE_STRUCTURED_DATA (for attributes) and PROVIDER_GOOGLE_GEO_TIGER (for categories).", + "", + "0x1117FF should not be used, since its range further extends the PROVIDER_GOOGLE hierarchy. aka Local AI.", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "No data is obtained from this provider. It is only used to identify features that must be served on MapMaker.", + "", + "", + "", + "", + "", + "", + "0x1117FFF should not be used, since its range further extends the PROVIDER_GOOGLE hierarchy. Synthetically generated areas (sublocalities/neighborhoods/ postal codes/etc) based on dropped terms from approximate geocoding. More info on go/syntheticareas.", + "", + "", + "", + "Similar to Google Transit, a provider that aggregates positions of bicycle rental points that we have agreements with to show on maps", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "This range has been depleted. For new Ids see PROVIDER_GOOGLE_SUBRANGE above.", + "", + "", + "", + "", + "", + "", + "ABSTRACT", + "", + "", + "", + "", + "", + "", + "", + "Small Scale International Boundary Lines", + "", + "NOAA", + "PGC", + "USDA", + "National Provider Identifier Registry", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "old name for PROVIDER_NAVIGO", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "See b/33687395", + "", + "", + "", + "", + "", + "", + "", + "ABSTRACT", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "ABSTRACT", + "", + "", + "", + "ABSTRACT", + "", + "", + "", + "UMBRELLA", + "", + "", + "", + "", + "", + "ABSTRACT", + "", + "", + "", + "ABSTRACT", + "", + "", + "ABSTRACT", + "", + "", + "", + "", + "", + "ABSTRACT", + "", + "", + "", + "", + "ABSTRACT", + "ABSTRACT", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "ABSTRACT", + "", + "ABSTRACT", + "", + "ABSTRACT", + "", + "", + "", + "ABSTRACT", + "", + "ABSTRACT", + "", + "", + "ABSTRACT", + "", + "", + "", + "", + "", + "", + "ABSTRACT", + "", + "ABSTRACT", + "", + "ABSTRACT", + "", + "ABSTRACT", + "", + "ABSTRACT", + "", + "", + "", + "", + "", + "", + "ABSTRACT", + "", + "ABSTRACT", + "", + "ABSTRACT", + "", + "ABSTRACT", + "", + "", + "", + "ABSTRACT", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "ABSTRACT", + "", + "", + "", + "", + "", + "", + "ABSTRACT", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "ABSTRACT", + "", + "", + "", + "", + "", + "", + "ABSTRACT", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "ABSTRACT", + "", + "", + "", + "ABSTRACT", + "", + "", + "", + "", + "", + "", + "", + "ABSTRACT", + "", + "", + "ABSTRACT", + "", + "ABSTRACT", + "", + "", + "", + "", + "", + "", + "", + "ABSTRACT", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "ABSTRACT", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "ABSTRACT", + "", + "ABSTRACT", + "IBAMA", + "MMA", + "ANA", + "IBGE", + "FUNAI", + "DNIT", + "", + "", + "", + "", + "", + "ABSTRACT", + "Department of Cartography", + "", + "ABSTRACT", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "ABSTRACT", + "", + "", + "", + "", + "", + "", + "", + "", + "0x12 and 0x120 are not to be used. OOO CET", + "ABSTRACT", + "Estonian Land Board", + "", + "ABSTRACT", + "Danish Geodata Agency", + "", + "", + "", + "", + "", + "", + "ABSTRACT", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "ABSTRACT", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "ABSTRACT", + "Ministry of land, infrastructure and transport, 국토교통부, Guktogyotongbu", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "ABSTRACT", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "Use PROVIDER_FI_NATIONAL_ROAD_ADMINISTRATION.", + "", + "ABSTRACT", + "Land Information New Zealand", + "NZ Department of Conservation", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "UMBRELLA", + "ABSTRACT", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "Note: Next available value is 0x1277." + ], + "type": "string" + } + }, + "type": "object" + }, + "GeostoreKnowledgeGraphReferenceProto": { + "description": "The reference to an entity in the KnowledgeGraph. For details on the KnowledgeGraph see http://goto/kg.", + "id": "GeostoreKnowledgeGraphReferenceProto", + "properties": { + "id": { + "description": "KG Identifier (MID). For details, see http://go/ke-bg-knowledge-graph#mids.", + "type": "string" + } + }, + "type": "object" + }, + "GeostoreNameProto": { + "description": "A name for a Feature (street name, point of interest, city, building, etc). We currently use NameProto for two essentially disjoint purposes: 1. Common names, which can be language-specific, or have other kinds of variations. 2. Opaque IDs, such as postal codes, which only have the `text` field set, and potentially some flags. This includes internal-only features like template ids. Each NameProto representing a common name corresponds to an assertion that a fluent speaker or writer of a language would recognize NameProto.text to name the given feature in that language. As such, NameProtos are stored in a repeated field, often having: 1. multiple names with the same text and varying languages, and 2. multiple names with the same language and varying texts.", + "id": "GeostoreNameProto", + "properties": { + "flag": { + "description": "clang-format on The set of flags that apply to this name.", + "items": { + "enum": [ + "FLAG_ANY", + "FLAG_IN_LOCAL_LANGUAGE", + "FLAG_PREFERRED", + "FLAG_OFFICIAL", + "FLAG_OBSCURE", + "FLAG_ON_SIGNS", + "FLAG_EXIT_NAME_NUMBER", + "FLAG_EXIT_NAME", + "FLAG_INTERCHANGE_NAME", + "FLAG_EXIT_NUMBER", + "FLAG_INTERCHANGE_NUMBER", + "FLAG_TRANSIT_HEADSIGN", + "FLAG_CONNECTS_DIRECTLY", + "FLAG_CONNECTS_INDIRECTLY", + "FLAG_INTERSECTION_NAME", + "FLAG_VANITY", + "FLAG_ROUTE_NUMBER", + "FLAG_COUNTRY_CODE_2", + "FLAG_ABBREVIATED", + "FLAG_ID", + "FLAG_DESIGNATED_MARKET_AREA_ID", + "FLAG_IATA_ID", + "FLAG_ICAO_ID", + "FLAG_ISO_3166_2", + "FLAG_COUNTRY_SPECIFIC_ID", + "FLAG_LANGUAGE_CODE", + "FLAG_TIMEZONE_ID", + "FLAG_PHONE_NUMBER_PREFIX", + "FLAG_PHONE_NUMBER_AREA_CODE", + "FLAG_TRANSLITERATED", + "FLAG_NOT_ON_SIGNS", + "FLAG_NOT_IN_LOCAL_LANGUAGE", + "FLAG_ROUNDABOUT_ROUTE", + "FLAG_NEVER_DISPLAY", + "FLAG_BICYCLE_ROUTE", + "FLAG_MACHINE_GENERATED", + "FLAG_SUSPICIOUS" + ], + "enumDeprecated": [ + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + true, + true, + false, + false, + false, + false, + false, + true + ], + "enumDescriptions": [ + "ABSTRACT", + "This name is in one of the local languages. A local language is one readable by local people, where all language/script/region subtags in the language field are local. E.g. \"ru\" is local in Russia, but \"ru-Latn\" (transliterated in Latin script) is not local. This is the opposite of FLAG_NOT_IN_LOCAL_LANGUAGE. In general, a given name should have either FLAG_IN_LOCAL_LANGUAGE or FLAG_NOT_IN_LOCAL_LANGUAGE specified. Importers that are unsure should not set either flag. It doesn't make sense to set this flag unless you also specify a language. NOTE: unlike most other flags in this enumeration, this flag has to do with the language field, NOT to the text (and {raw,short}_text fields).", + "This is the most commonly recognized name for this feature (for a given language, when languages apply). This flag is not compatible with the following flags: - FLAG_NEVER_DISPLAY - FLAG_OBSCURE", + "This name is officially recognized by the government. This flag is not compatible with FLAG_SUSPICIOUS.", + "This name is not commonly known. This flag is used on names that are not commonly known, or not \"standard\", but which we wish to have so clients can search on them. An example would be \"Philly\" instead of \"Philadelphia\".", + "ABSTRACT", + "This name is an exit name/number found on signs.", + "This flag is used to differentiate exit names from exit numbers on signs that have both.", + "The highway sign is labeling a highway interchange instead of an exit. In several European countries interchanges are differentiated from highway exits.", + "This flag is used to differentiate exit numbers from exit names on signs that have both. This flag is not compatible with FLAG_ROUTE_NUMBER.", + "The highway sign is labeling a highway interchange the same manner as FLAG_INTERCHANGE_NAME.", + "The headsign of a transit vehicle, often the name of the destination.", + "The road sign target is directly connected (e.g., at end of ramp).", + "The road sign target is not directly connected (e.g., must travel some additional distance).", + "This name is an intersection name found on signs. Usually we can just use the name of a TYPE_INTERSECTION_GROUP feature. However, there are road signs on some intersections in Japan, especially in Hokkaido region where the intersection name is considered \"directional\" (i.e. an intersection could have multiple names depending on directions drivers or pedestrians approach from). Many people think of them as \"intersection names\", but that's not really what they are. We want to model them as road signs, because that's really what they are. This flag is supposed to be used by Pathfinder to generate the appropriate maneuver texts where such a named intersection is involved.", + "This is a vanity name (usually an alternate name for a section of road in honor of some person).", + "This name is a route number from an official numbering system for highways or similar routes (like bicycle routes). Street names (even numbered ones like in Manhattan) are excluded. The name (both text and short_text) should follow a strictly-defined format determined by the official numbering system. Route numbers may be assigned to segments on city streets as well as highways. (US-101 passing through San Francisco is an example that has both.) Historic route names that are no longer part of an official numbering system (like the former US-66) are not route numbers. This flag is not compatible with FLAG_EXIT_NUMBER.", + "This name is a two-letter ISO 3166-1 country code. It has code 0x81 instead of 0x8 for historical reasons (FLAG_COUNTRY_CODE and FLAG_COUNTRY_CODE_3 were removed in the belief that we only want one way to represent a country code in the Geo Schema).", + "An abbreviated version of the name, for example \"CA\" for California. This flag should be used for postal abbreviations that one would expect to see in an address. It should also be used for names where one of the component words is abbreviated (e.g. \"Mass.\" for Massachusetts, \"NWFP\" for the North-West Frontier Province in Pakistan, or \"L\" for the Lobby level in a building). Shortened forms of names (e.g. \"Kingston\" rather than \"Kingston-upon-Hull\") should be marked obscure rather than abbreviated. This flag should be used for names that are feature specific abbreviations. For shortened name versions based on regular, per-term transformations (ex: '1st Street' -> '1st St'), use the short_text field instead.", + "ABSTRACT", + "This name is a Designated Market Area ID number (ex: 501)", + "This name is a three-letter IATA airport code (ex SFO, ZRH).", + "This name is a four-letter ICAO airport code (ex KSFO, LSZH).", + "This name is the ISO 3166-2 country subdivision code.", + "This name is the country specific ID. For example, China government specifies an admin code for each administrative area (province, city and district).", + "This name is an IETF BCP 47 language code, for example \"fr-CA\". Previously used for names of locales. See locale.proto for new way of defining this information.", + "This name is a timezone identifier in the Olson database, for example \"Europe/Zurich\". All timezones have an Olson identifier, understood by POSIX and Google's i18n/identifiers libraries. This flag applies only to features of TYPE_TIMEZONE type.", + "This name is the prefix for a phone number, starting with + and followed by a country code. This flag applies only to features of TYPE_PHONE_NUMBER_PREFIX type and at most one name should have this flag set.", + "This name is the commonly used name for the area code of a phone number, including the national prefix if applicable. This flag applies only to features of TYPE_PHONE_NUMBER_AREA_CODE type and at most one name should have this flag set.", + "The flag used to indicate the name was transliterated from some other character set. For example, this flag would be set on names transliterated from the Cyrillic or Greek alphabets to a Latin alphabet. The correct approach is to use the Google III language code to specify the appropriate language. For example, Greek transliterated into a Latin alphabet should have a language code of \"el-Latn\".", + "There are two kinds of street signs: \"location signs\" and \"guidance signs\". Location signs are the ones you see that tell you where you are. \"Ah, I'm on 85th Street and I'm crossing 6th Avenue.\" Guidance signs are the ones that give you hints about how to get where you want to go. \"Ah, I should go that way to get on I-5 to Seattle.\" This flag is talking about location signs. You'll find this flag on route names when then name is never posted on location signs. This flag is not compatible with flags in the FLAG_ON_SIGNS category.", + "This name is not in one of the local languages. A local language is one readable by local people, where all language/script/region subtags in the language field are local. E.g. \"ru\" is local in Russia, but \"ru-Latn\" (transliterated in Latin script) is not local. This is the opposite of FLAG_IN_LOCAL_LANGUAGE. In general, a given name should have either FLAG_IN_LOCAL_LANGUAGE or FLAG_NOT_IN_LOCAL_LANGUAGE specified. Importers that are unsure should not set either flag. It doesn't make sense to set this flag unless you also specify a language. NOTE: unlike most other flags in this enumeration, this flag has to do with the language field, NOT to the text (and {raw,short}_text fields).", + "This flag is set on routes attached to roundabout segments if and only if this name does not appear on any of the segments incident on the roundabout. This flag can be used by clients to determine which names on roundabouts are more useful than others when displaying to users.", + "Never display this name to a user. This flag is typically used for politically sensitive names such as \"Taiwan, Province of China\". Any feature which has a name with this flag should have another name without it so we have something to display to the user.", + "Routes with these names are common bicycle routes. This includes bicycle trails and routes along shared roadways to popular destinations for cyclists. Unnamed bicycle routes along named shared roadways should not have names of this type. This flag exists so that we can avoid showing bicycle route names in driving directions, while still showing them in bicycling directions.", + "This name is generated automatically by the transliteration pipeline based on an existing name in a different language. Contact Maps Translation team (go/maps-translation) for details.", + "This name may not be a correct name for a feature. It communicates to clients that the name may not be trustworthy. Examples are names of features that are too general (\"swimming pool\", \"hardware store\" etc) or those that incorrectly match names of prominent political features (businesses, transit stations etc named after sublocalities). This flag is not compatible with FLAG_OFFICIAL." + ], + "type": "string" + }, + "type": "array" + }, + "language": { + "description": "The external form of a Google International Identifiers Initiative (III) LanguageCode object. See google3/i18n/identifiers/languagecode.h for details. These strings should be treated as opaque blobs. You can use LanguageCodeConverter::FromOther to convert the string to a LanguageCode reference. You can then call methods on the LanguageCode class to extract language/script/region subtags (if any). See also http://g3doc/i18n/identifiers/g3doc/using-iii. We place extra restrictions on languages in addition to what the III library requires. See go/geo-schema-reference/feature-properties/languages. This field may be missing if the name does not have a concept of language but should be set if the language is unknown.", + "type": "string" + }, + "metadata": { + "$ref": "GeostoreFieldMetadataProto", + "description": "Field-level metadata for this name. NOTE: there are multiple NameProto fields in the Geo Schema. Metadata here is only expected to be present on FeatureProto.name[]." + }, + "rawText": { + "deprecated": true, + "description": "** DEPRECATED ** The name text provided in the original source data (UTF-8 encoding). This is the text provided in the source data unmodified with the exception of being converted to UTF-8 and stripping extra leading, trailing and duplicate whitespaces (if necessary).", + "type": "string" + }, + "shortText": { + "description": "The short name text (UTF-8 encoding). Acronyms/abbreviations should be consistently used, for example \"NE 57th St\" rather than \"Northeast 57th Street\", \"N.E 57th St.\" or some other variant. This field should be populated with the chosen canonical version of the shortened name, based on per-term transformations. For feature specific abbreviations (such as 'CA' for 'California'), one should define a separate name with FLAG_ABBREVIATED set. For other variants of the shortened name that are not the canonical one, devise client based logic (ex: query rewriting rules).", + "type": "string" + }, + "temporaryData": { + "$ref": "MessageSet", + "description": "A place for clients to attach arbitrary data to a name. Never set in MapFacts." + }, + "text": { + "description": "The name text (UTF-8 encoding). Acronyms/abbreviations should be fully expanded, for example \"Northeast 57th Street\" rather than \"NE 57th St\". They can be shortened at display or geocode time. This decision prevents ambiguity over such issues as whether \"St\" represents \"Street\" or \"Saint\". However, it pushes language-specific knowledge into code. We will have libraries and data files to contract acronyms/abbreviations at run-time.", + "type": "string" + } + }, + "type": "object" + }, + "GeostorePointProto": { + "id": "GeostorePointProto", + "properties": { + "latE7": { + "format": "uint32", + "type": "integer" + }, + "lngE7": { + "format": "uint32", + "type": "integer" + }, + "metadata": { + "$ref": "GeostoreFieldMetadataProto", + "description": "NOTE: If removing metadata, remove 'option objc_class_prefix = \"GS\";' together. See cl/189921100. Field-level metadata for this point. NOTE: there are multiple PointProto fields in the Geo Schema. Metadata here is only expected to be present on FeatureProto.point[] and FeatureProto.center." + }, + "temporaryData": { + "$ref": "MessageSet", + "description": "A place for clients to attach arbitrary data to a point. Never set in MapFacts." + } + }, + "type": "object" + }, + "GeostoreRectProto": { + "description": "A latitude-longitude rectangle, represented as two diagonally opposite points \"lo\" and \"hi\". The rectangle is considered to be a closed region, i.e. it includes its boundary. The latitude bounds must be in the range -90 to 90 degrees inclusive, and the longitude bounds must be in the range -180 to 180 degrees inclusive. Various cases include: - If lo == hi, the rectangle consists of a single point. - If lo.longitude > hi.longitude, the longitude range is \"inverted\" (the rectangle crosses the 180 degree longitude line). - If lo.longitude == -180 degrees and hi.longitude = 180 degrees, the rectangle includes all longitudes. - If lo.longitude = 180 degrees and hi.longitude = -180 degrees, the longitude range is empty. - If lo.latitude > hi.latitude, the latitude range is empty.", + "id": "GeostoreRectProto", + "properties": { + "hi": { + "$ref": "GeostorePointProto" + }, + "lo": { + "$ref": "GeostorePointProto" + } + }, + "type": "object" + }, + "GetCustomerIndexStatsResponse": { + "id": "GetCustomerIndexStatsResponse", + "properties": { + "averageIndexedItemCount": { + "description": "Average item count for the given date range for which billing is done.", + "format": "int64", + "type": "string" + }, + "stats": { + "description": "Summary of indexed item counts, one for each day in the requested range.", + "items": { + "$ref": "CustomerIndexStats" + }, + "type": "array" + } + }, + "type": "object" + }, + "GetCustomerQueryStatsResponse": { + "id": "GetCustomerQueryStatsResponse", + "properties": { + "stats": { + "items": { + "$ref": "CustomerQueryStats" + }, + "type": "array" + }, + "totalQueryCount": { + "description": "Total successful query count (status code 200) for the given date range.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "GetCustomerSearchApplicationStatsResponse": { + "description": "Response format for search application stats for a customer.", + "id": "GetCustomerSearchApplicationStatsResponse", + "properties": { + "averageSearchApplicationCount": { + "description": "Average search application count for the given date range.", + "format": "int64", + "type": "string" + }, + "stats": { + "description": "Search application stats by date.", + "items": { + "$ref": "CustomerSearchApplicationStats" + }, + "type": "array" + } + }, + "type": "object" + }, + "GetCustomerSessionStatsResponse": { + "id": "GetCustomerSessionStatsResponse", + "properties": { + "stats": { + "items": { + "$ref": "CustomerSessionStats" + }, + "type": "array" + } + }, + "type": "object" + }, + "GetCustomerUserStatsResponse": { + "id": "GetCustomerUserStatsResponse", + "properties": { + "stats": { + "items": { + "$ref": "CustomerUserStats" + }, + "type": "array" + } + }, + "type": "object" + }, + "GetDataSourceIndexStatsResponse": { + "id": "GetDataSourceIndexStatsResponse", + "properties": { + "averageIndexedItemCount": { + "description": "Average item count for the given date range for which billing is done.", + "format": "int64", + "type": "string" + }, + "stats": { + "description": "Summary of indexed item counts, one for each day in the requested range.", + "items": { + "$ref": "DataSourceIndexStats" + }, + "type": "array" + } + }, + "type": "object" + }, + "GetSearchApplicationQueryStatsResponse": { + "description": "Response format for getting query stats for a search application between given dates.", + "id": "GetSearchApplicationQueryStatsResponse", + "properties": { + "stats": { + "description": "Query stats per date for a search application.", + "items": { + "$ref": "SearchApplicationQueryStats" + }, + "type": "array" + }, + "totalQueryCount": { + "description": "Total successful query count (status code 200) for the given date range.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "GetSearchApplicationSessionStatsResponse": { + "id": "GetSearchApplicationSessionStatsResponse", + "properties": { + "stats": { + "items": { + "$ref": "SearchApplicationSessionStats" + }, + "type": "array" + } + }, + "type": "object" + }, + "GetSearchApplicationUserStatsResponse": { + "id": "GetSearchApplicationUserStatsResponse", + "properties": { + "stats": { + "items": { + "$ref": "SearchApplicationUserStats" + }, + "type": "array" + } + }, + "type": "object" + }, + "HtmlOperatorOptions": { + "description": "Used to provide a search operator for html properties. This is optional. Search operators let users restrict the query to specific fields relevant to the type of item being searched.", + "id": "HtmlOperatorOptions", + "properties": { + "operatorName": { + "description": "Indicates the operator name required in the query in order to isolate the html property. For example, if operatorName is *subject* and the property's name is *subjectLine*, then queries like *subject:* show results only where the value of the property named *subjectLine* matches **. By contrast, a search that uses the same ** without an operator return all items where ** matches the value of any html properties or text within the content field for the item. The operator name can only contain lowercase letters (a-z). The maximum length is 32 characters.", + "type": "string" + } + }, + "type": "object" + }, + "HtmlPropertyOptions": { + "description": "The options for html properties.", + "id": "HtmlPropertyOptions", + "properties": { + "operatorOptions": { + "$ref": "HtmlOperatorOptions", + "description": "If set, describes how the property should be used as a search operator." + }, + "retrievalImportance": { + "$ref": "RetrievalImportance", + "description": "Indicates the search quality importance of the tokens within the field when used for retrieval. Can only be set to DEFAULT or NONE." + } + }, + "type": "object" + }, + "HtmlValues": { + "description": "List of html values.", + "id": "HtmlValues", + "properties": { + "values": { + "description": "The maximum allowable length for html values is 2048 characters.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "IPBlockInfoProto": { + "id": "IPBlockInfoProto", + "properties": { + "asn": { + "description": "ASN of the block. Only present when return_organisational is set in the request options.", + "type": "string" + }, + "carrierName": { + "type": "string" + }, + "cookiePopulation": { + "deprecated": true, + "format": "float", + "type": "number" + }, + "dnsDomain": { + "description": "DNS and organisational info, only present when return_organisational is set in the request options. Currently (November 2010) this data comes from the raw Quova import.", + "type": "string" + }, + "homeIndicator": { + "description": "True, if it is a home IP. Data is from Neustar.", + "type": "boolean" + }, + "ipsEstimate": { + "description": "Day averages for this block of number of .. Currently (May 2011) not filled in. .. active IPs", + "format": "float", + "type": "number" + }, + "isicCode": { + "description": "ISIC code, data from Neustar.", + "type": "string" + }, + "lastChangedS": { + "description": "Seconds since epoch any data constituting this block last changed. Currently (May 2011) not filled in.", + "format": "int32", + "type": "integer" + }, + "naicsCode": { + "description": "NAICS code, data from Neustar.", + "type": "string" + }, + "netstats": { + "$ref": "NetStatsProto", + "description": "Data from the NetDB project, see net/ipmap/..., only present when return_netstats is set in the request options." + }, + "organisationName": { + "type": "string" + }, + "organizationType": { + "description": "Neustar's organization_type data.", + "type": "string" + }, + "proxyClassification": { + "$ref": "ProxyClassificationProto", + "description": "Proxy classification of the block. Only present when return_proxy_classification is set in the request options." + }, + "ranges": { + "description": "For historical reasons, the 'ranges' field is repeated, but actually it occurs at most once. If present, the range is a set of consecutive IP addresses to which the IPGeo result (including the information in the IPBlockInfoProto as well as other info in the IPGeoResponseProto / LocationResult) applies. This means that when the netstats are present, this will be the intersection of the range from the ipgeo index with the range from the netstats index; when the proxy classification is present, this will be intersected with the IP range to which the proxy classification applies. Caveat: intersection with HHI (household income) IP range is currently not implemented.", + "items": { + "$ref": "IPRangeProto" + }, + "type": "array" + }, + "reallocFracEstimate": { + "description": "Estimate of the fraction of IPs that get reallocated per day. Currently (May 2011) not filled in.", + "format": "float", + "type": "number" + }, + "routingtype": { + "description": "Routing type, only present if return_organisational is set in the request options. Currently (June 2012) this data is not filled in.", + "enum": [ + "UNKNOWN", + "INTERNATIONAL_PROXY", + "MOBILE_GATEWAY" + ], + "enumDescriptions": [ + "", + "ANONYMIZER = 2; AOLDIALUP = 3; AOLPOP = 4; AOLPROXY = 5; CACHE_PROXY = 6; FIXED = 7;", + "POP = 10; REGIONAL_PROXY = 11; SATELLITE = 12; SUPERPOP = 13;" + ], + "type": "string" + }, + "trafficEstimate": { + "description": ".. queries", + "format": "float", + "type": "number" + } + }, + "type": "object" + }, + "IPRangeProto": { + "id": "IPRangeProto", + "properties": { + "packedIpBegin": { + "description": "A contiguous range [begin, end] of IPv4 or IPv6 addresses in packed binary form. 4 or 16 bytes, big endian", + "format": "byte", + "type": "string" + }, + "packedIpEnd": { + "description": "inclusive", + "format": "byte", + "type": "string" + } + }, + "type": "object" + }, + "IndexItemOptions": { + "id": "IndexItemOptions", + "properties": { + "allowUnknownGsuitePrincipals": { + "description": "Specifies if the index request should allow Google Workspace principals that do not exist or are deleted.", + "type": "boolean" + } + }, + "type": "object" + }, + "IndexItemRequest": { + "id": "IndexItemRequest", + "properties": { + "connectorName": { + "description": "The name of connector making this call. Format: datasources/{source_id}/connectors/{ID}", + "type": "string" + }, + "debugOptions": { + "$ref": "DebugOptions", + "description": "Common debug options." + }, + "indexItemOptions": { + "$ref": "IndexItemOptions" + }, + "item": { + "$ref": "Item", + "description": "The name of the item. Format: datasources/{source_id}/items/{item_id}" + }, + "mode": { + "description": "Required. The RequestMode for this request.", + "enum": [ + "UNSPECIFIED", + "SYNCHRONOUS", + "ASYNCHRONOUS" + ], + "enumDescriptions": [ + "The priority is not specified in the update request. Leaving priority unspecified results in an update failure.", + "For real-time updates.", + "For changes that are executed after the response is sent back to the caller." + ], + "type": "string" + } + }, + "type": "object" + }, + "InitializeCustomerRequest": { + "description": "Request message for `InitializeCustomer` method.", + "id": "InitializeCustomerRequest", + "properties": {}, + "type": "object" + }, + "IntegerFacetingOptions": { + "description": "Used to specify integer faceting options.", + "id": "IntegerFacetingOptions", + "properties": { + "integerBuckets": { + "description": "Buckets for given integer values should be in strictly ascending order. For example, if values supplied are (1,5,10,100), the following facet buckets will be formed {<1, [1,5), [5-10), [10-100), >=100}.", + "items": { + "format": "int64", + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "IntegerOperatorOptions": { + "description": "Used to provide a search operator for integer properties. This is optional. Search operators let users restrict the query to specific fields relevant to the type of item being searched.", + "id": "IntegerOperatorOptions", + "properties": { + "greaterThanOperatorName": { + "description": "Indicates the operator name required in the query in order to isolate the integer property using the greater-than operator. For example, if greaterThanOperatorName is *priorityabove* and the property's name is *priorityVal*, then queries like *priorityabove:* show results only where the value of the property named *priorityVal* is greater than **. The operator name can only contain lowercase letters (a-z). The maximum length is 32 characters.", + "type": "string" + }, + "lessThanOperatorName": { + "description": "Indicates the operator name required in the query in order to isolate the integer property using the less-than operator. For example, if lessThanOperatorName is *prioritybelow* and the property's name is *priorityVal*, then queries like *prioritybelow:* show results only where the value of the property named *priorityVal* is less than **. The operator name can only contain lowercase letters (a-z). The maximum length is 32 characters.", + "type": "string" + }, + "operatorName": { + "description": "Indicates the operator name required in the query in order to isolate the integer property. For example, if operatorName is *priority* and the property's name is *priorityVal*, then queries like *priority:* show results only where the value of the property named *priorityVal* matches **. By contrast, a search that uses the same ** without an operator returns all items where ** matches the value of any String properties or text within the content field for the item. The operator name can only contain lowercase letters (a-z). The maximum length is 32 characters.", + "type": "string" + } + }, + "type": "object" + }, + "IntegerPropertyOptions": { + "description": "The options for integer properties.", + "id": "IntegerPropertyOptions", + "properties": { + "integerFacetingOptions": { + "$ref": "IntegerFacetingOptions", + "description": "If set, describes integer faceting options for the given integer property. The corresponding integer property should be marked isFacetable." + }, + "maximumValue": { + "description": "The maximum value of the property. The minimum and maximum values for the property are used to rank results according to the ordered ranking. Indexing requests with values greater than the maximum are accepted and ranked with the same weight as items indexed with the maximum value.", + "format": "int64", + "type": "string" + }, + "minimumValue": { + "description": "The minimum value of the property. The minimum and maximum values for the property are used to rank results according to the ordered ranking. Indexing requests with values less than the minimum are accepted and ranked with the same weight as items indexed with the minimum value.", + "format": "int64", + "type": "string" + }, + "operatorOptions": { + "$ref": "IntegerOperatorOptions", + "description": "If set, describes how the integer should be used as a search operator." + }, + "orderedRanking": { + "description": "Used to specify the ordered ranking for the integer. Can only be used if isRepeatable is false.", + "enum": [ + "NO_ORDER", + "ASCENDING", + "DESCENDING" + ], + "enumDescriptions": [ + "There is no ranking order for the property. Results are not adjusted by this property's value.", + "This property is ranked in ascending order. Lower values indicate lower ranking.", + "This property is ranked in descending order. Lower values indicate higher ranking." + ], + "type": "string" + } + }, + "type": "object" + }, + "IntegerValues": { + "description": "List of integer values.", + "id": "IntegerValues", + "properties": { + "values": { + "items": { + "format": "int64", + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "Interaction": { + "description": "Represents an interaction between a user and an item.", + "id": "Interaction", + "properties": { + "interactionTime": { + "description": "The time when the user acted on the item. If multiple actions of the same type exist for a single user, only the most recent action is recorded.", + "format": "google-datetime", + "type": "string" + }, + "principal": { + "$ref": "Principal", + "description": "The user that acted on the item." + }, + "type": { + "enum": [ + "UNSPECIFIED", + "VIEW", + "EDIT" + ], + "enumDescriptions": [ + "Invalid value.", + "This interaction indicates the user viewed the item.", + "This interaction indicates the user edited the item." + ], + "type": "string" + } + }, + "type": "object" + }, + "Item": { + "description": "Represents a single object that is an item in the search index, such as a file, folder, or a database record.", + "id": "Item", + "properties": { + "acl": { + "$ref": "ItemAcl", + "description": "Access control list for this item." + }, + "content": { + "$ref": "ItemContent", + "description": "Item content to be indexed and made text searchable." + }, + "itemType": { + "description": "The type for this item.", + "enum": [ + "UNSPECIFIED", + "CONTENT_ITEM", + "CONTAINER_ITEM", + "VIRTUAL_CONTAINER_ITEM" + ], + "enumDescriptions": [ + "", + "An item that is indexed for the only purpose of serving information. These items cannot be referred in containerName or inheritAclFrom fields.", + "An item that gets indexed and whose purpose is to supply other items with ACLs and/or contain other items.", + "An item that does not get indexed, but otherwise has the same purpose as CONTAINER_ITEM." + ], + "type": "string" + }, + "metadata": { + "$ref": "ItemMetadata", + "description": "The metadata information." + }, + "name": { + "description": "The name of the Item. Format: datasources/{source_id}/items/{item_id} This is a required field. The maximum length is 1536 characters.", + "type": "string" + }, + "payload": { + "description": "Additional state connector can store for this item. The maximum length is 10000 bytes.", + "format": "byte", + "type": "string" + }, + "queue": { + "description": "Queue this item belongs to. The maximum length is 100 characters.", + "type": "string" + }, + "status": { + "$ref": "ItemStatus", + "description": "Status of the item. Output only field." + }, + "structuredData": { + "$ref": "ItemStructuredData", + "description": "The structured data for the item that should conform to a registered object definition in the schema for the data source." + }, + "version": { + "description": "Required. The indexing system stores the version from the datasource as a byte string and compares the Item version in the index to the version of the queued Item using lexical ordering. Cloud Search Indexing won't index or delete any queued item with a version value that is less than or equal to the version of the currently indexed item. The maximum length for this field is 1024 bytes. For information on how item version affects the deletion process, refer to [Handle revisions after manual deletes](https://developers.google.com/cloud-search/docs/guides/operations).", + "format": "byte", + "type": "string" + } + }, + "type": "object" + }, + "ItemAcl": { + "description": "Access control list information for the item. For more information see [Map ACLs](https://developers.google.com/cloud-search/docs/guides/acls).", + "id": "ItemAcl", + "properties": { + "aclInheritanceType": { + "description": "Sets the type of access rules to apply when an item inherits its ACL from a parent. This should always be set in tandem with the inheritAclFrom field. Also, when the inheritAclFrom field is set, this field should be set to a valid AclInheritanceType.", + "enum": [ + "NOT_APPLICABLE", + "CHILD_OVERRIDE", + "PARENT_OVERRIDE", + "BOTH_PERMIT" + ], + "enumDescriptions": [ + "The default value when this item does not inherit an ACL. Use NOT_APPLICABLE when inheritAclFrom is empty. An item without ACL inheritance can still have ACLs supplied by its own readers and deniedReaders fields.", + "During an authorization conflict, the ACL of the child item determines its read access.", + "During an authorization conflict, the ACL of the parent item specified in the inheritAclFrom field determines read access.", + "Access is granted only if this item and the parent item specified in the inheritAclFrom field both permit read access." + ], + "type": "string" + }, + "deniedReaders": { + "description": "List of principals who are explicitly denied access to the item in search results. While principals are denied access by default, use denied readers to handle exceptions and override the list allowed readers. The maximum number of elements is 100.", + "items": { + "$ref": "Principal" + }, + "type": "array" + }, + "inheritAclFrom": { + "description": "The name of the item to inherit the Access Permission List (ACL) from. Note: ACL inheritance *only* provides access permissions to child items and does not define structural relationships, nor does it provide convenient ways to delete large groups of items. Deleting an ACL parent from the index only alters the access permissions of child items that reference the parent in the inheritAclFrom field. The item is still in the index, but may not visible in search results. By contrast, deletion of a container item also deletes all items that reference the container via the containerName field. The maximum length for this field is 1536 characters.", + "type": "string" + }, + "owners": { + "description": "Optional. List of owners for the item. This field has no bearing on document access permissions. It does, however, offer a slight ranking boosts items where the querying user is an owner. The maximum number of elements is 5.", + "items": { + "$ref": "Principal" + }, + "type": "array" + }, + "readers": { + "description": "List of principals who are allowed to see the item in search results. Optional if inheriting permissions from another item or if the item is not intended to be visible, such as virtual containers. The maximum number of elements is 1000.", + "items": { + "$ref": "Principal" + }, + "type": "array" + } + }, + "type": "object" + }, + "ItemContent": { + "description": "Content of an item to be indexed and surfaced by Cloud Search. Only UTF-8 encoded strings are allowed as inlineContent. If the content is uploaded and not binary, it must be UTF-8 encoded.", + "id": "ItemContent", + "properties": { + "contentDataRef": { + "$ref": "UploadItemRef", + "description": "Upload reference ID of a previously uploaded content via write method." + }, + "contentFormat": { + "enum": [ + "UNSPECIFIED", + "HTML", + "TEXT", + "RAW" + ], + "enumDescriptions": [ + "Invalid value.", + "contentFormat is HTML.", + "contentFormat is free text.", + "contentFormat is raw bytes." + ], + "type": "string" + }, + "hash": { + "description": "Hashing info calculated and provided by the API client for content. Can be used with the items.push method to calculate modified state. The maximum length is 2048 characters.", + "type": "string" + }, + "inlineContent": { + "description": "Content that is supplied inlined within the update method. The maximum length is 102400 bytes (100 KiB).", + "format": "byte", + "type": "string" + } + }, + "type": "object" + }, + "ItemCountByStatus": { + "id": "ItemCountByStatus", + "properties": { + "count": { + "description": "Number of items matching the status code.", + "format": "int64", + "type": "string" + }, + "indexedItemsCount": { + "description": "Number of items matching the status code for which billing is done. This excludes virtual container items from the total count. This count would not be applicable for items with ERROR or NEW_ITEM status code.", + "format": "int64", + "type": "string" + }, + "statusCode": { + "description": "Status of the items.", + "enum": [ + "CODE_UNSPECIFIED", + "ERROR", + "MODIFIED", + "NEW_ITEM", + "ACCEPTED" + ], + "enumDescriptions": [ + "Input-only value. Used with Items.list to list all items in the queue, regardless of status.", + "Error encountered by Cloud Search while processing this item. Details of the error are in repositoryError.", + "Item has been modified in the repository, and is out of date with the version previously accepted into Cloud Search.", + "Item is known to exist in the repository, but is not yet accepted by Cloud Search. An item can be in this state when Items.push has been called for an item of this name that did not exist previously.", + "API has accepted the up-to-date data of this item." + ], + "type": "string" + } + }, + "type": "object" + }, + "ItemMetadata": { + "description": "Available metadata fields for the item.", + "id": "ItemMetadata", + "properties": { + "containerName": { + "description": "The name of the container for this item. Deletion of the container item leads to automatic deletion of this item. Note: ACLs are not inherited from a container item. To provide ACL inheritance for an item, use the inheritAclFrom field. The maximum length is 1536 characters.", + "type": "string" + }, + "contentLanguage": { + "description": "The BCP-47 language code for the item, such as \"en-US\" or \"sr-Latn\". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. The maximum length is 32 characters.", + "type": "string" + }, + "contextAttributes": { + "description": "A set of named attributes associated with the item. This can be used for influencing the ranking of the item based on the context in the request. The maximum number of elements is 10.", + "items": { + "$ref": "ContextAttribute" + }, + "type": "array" + }, + "createTime": { + "description": "The time when the item was created in the source repository.", + "format": "google-datetime", + "type": "string" + }, + "hash": { + "description": "Hashing value provided by the API caller. This can be used with the items.push method to calculate modified state. The maximum length is 2048 characters.", + "type": "string" + }, + "interactions": { + "description": "A list of interactions for the item. Interactions are used to improve Search quality, but are not exposed to end users. The maximum number of elements is 1000.", + "items": { + "$ref": "Interaction" + }, + "type": "array" + }, + "keywords": { + "description": "Additional keywords or phrases that should match the item. Used internally for user generated content. The maximum number of elements is 100. The maximum length is 8192 characters.", + "items": { + "type": "string" + }, + "type": "array" + }, + "mimeType": { + "description": "The original mime-type of ItemContent.content in the source repository. The maximum length is 256 characters.", + "type": "string" + }, + "objectType": { + "description": "The type of the item. This should correspond to the name of an object definition in the schema registered for the data source. For example, if the schema for the data source contains an object definition with name 'document', then item indexing requests for objects of that type should set objectType to 'document'. The maximum length is 256 characters.", + "type": "string" + }, + "searchQualityMetadata": { + "$ref": "SearchQualityMetadata", + "description": "Additional search quality metadata of the item" + }, + "sourceRepositoryUrl": { + "description": "Link to the source repository serving the data. Seach results apply this link to the title. Whitespace or special characters may cause Cloud Seach result links to trigger a redirect notice; to avoid this, encode the URL. The maximum length is 2048 characters.", + "type": "string" + }, + "title": { + "description": "The title of the item. If given, this will be the displayed title of the Search result. The maximum length is 2048 characters.", + "type": "string" + }, + "updateTime": { + "description": "The time when the item was last modified in the source repository.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "ItemStatus": { + "description": "This contains item's status and any errors.", + "id": "ItemStatus", + "properties": { + "code": { + "description": "Status code.", + "enum": [ + "CODE_UNSPECIFIED", + "ERROR", + "MODIFIED", + "NEW_ITEM", + "ACCEPTED" + ], + "enumDescriptions": [ + "Input-only value. Used with Items.list to list all items in the queue, regardless of status.", + "Error encountered by Cloud Search while processing this item. Details of the error are in repositoryError.", + "Item has been modified in the repository, and is out of date with the version previously accepted into Cloud Search.", + "Item is known to exist in the repository, but is not yet accepted by Cloud Search. An item can be in this state when Items.push has been called for an item of this name that did not exist previously.", + "API has accepted the up-to-date data of this item." + ], + "type": "string" + }, + "processingErrors": { + "description": "Error details in case the item is in ERROR state.", + "items": { + "$ref": "ProcessingError" + }, + "type": "array" + }, + "repositoryErrors": { + "description": "Repository error reported by connector.", + "items": { + "$ref": "RepositoryError" + }, + "type": "array" + } + }, + "type": "object" + }, + "ItemStructuredData": { + "description": "Available structured data fields for the item.", + "id": "ItemStructuredData", + "properties": { + "hash": { + "description": "Hashing value provided by the API caller. This can be used with the items.push method to calculate modified state. The maximum length is 2048 characters.", + "type": "string" + }, + "object": { + "$ref": "StructuredDataObject", + "description": "The structured data object that should conform to a registered object definition in the schema for the data source." + } + }, + "type": "object" + }, + "ListDataSourceResponse": { + "id": "ListDataSourceResponse", + "properties": { + "nextPageToken": { + "description": "Token to retrieve the next page of results, or empty if there are no more results in the list.", + "type": "string" + }, + "sources": { + "items": { + "$ref": "DataSource" + }, + "type": "array" + } + }, + "type": "object" + }, + "ListItemNamesForUnmappedIdentityResponse": { + "id": "ListItemNamesForUnmappedIdentityResponse", + "properties": { + "itemNames": { + "items": { + "type": "string" + }, + "type": "array" + }, + "nextPageToken": { + "description": "Token to retrieve the next page of results, or empty if there are no more results in the list.", + "type": "string" + } + }, + "type": "object" + }, + "ListItemsResponse": { + "id": "ListItemsResponse", + "properties": { + "items": { + "items": { + "$ref": "Item" + }, + "type": "array" + }, + "nextPageToken": { + "description": "Token to retrieve the next page of results, or empty if there are no more results in the list.", + "type": "string" + } + }, + "type": "object" + }, + "ListOperationsResponse": { + "description": "The response message for Operations.ListOperations.", + "id": "ListOperationsResponse", + "properties": { + "nextPageToken": { + "description": "The standard List next-page token.", + "type": "string" + }, + "operations": { + "description": "A list of operations that matches the specified filter in the request.", + "items": { + "$ref": "Operation" + }, + "type": "array" + } + }, + "type": "object" + }, + "ListQuerySourcesResponse": { + "description": "List sources response.", + "id": "ListQuerySourcesResponse", + "properties": { + "nextPageToken": { + "type": "string" + }, + "sources": { + "items": { + "$ref": "QuerySource" + }, + "type": "array" + } + }, + "type": "object" + }, + "ListSearchApplicationsResponse": { + "id": "ListSearchApplicationsResponse", + "properties": { + "nextPageToken": { + "description": "Token to retrieve the next page of results, or empty if there are no more results in the list.", + "type": "string" + }, + "searchApplications": { + "items": { + "$ref": "SearchApplication" + }, + "type": "array" + } + }, + "type": "object" + }, + "ListUnmappedIdentitiesResponse": { + "id": "ListUnmappedIdentitiesResponse", + "properties": { + "nextPageToken": { + "description": "Token to retrieve the next page of results, or empty if there are no more results in the list.", + "type": "string" + }, + "unmappedIdentities": { + "items": { + "$ref": "UnmappedIdentity" + }, + "type": "array" + } + }, + "type": "object" + }, + "LocationExtractorFeatureletAnnotationSet": { + "description": "A set of featurelet annotations for an alternate policy.", + "id": "LocationExtractorFeatureletAnnotationSet", + "properties": { + "annotations": { + "description": "The featurelet annotations for the alternate policy.", + "items": { + "enum": [ + "TRIMMED_BY_QUALITY_FILTERING" + ], + "enumDescriptions": [ + "Indicate that a featurelet should not be used. This annotation is applied during ApplyQualityFiltering for feature \"trimming\" or added by the PolicyStore as a result of quality score calculation." + ], + "type": "string" + }, + "type": "array" + }, + "name": { + "description": "The name of the alternate policy.", + "type": "string" + } + }, + "type": "object" + }, + "LocationExtractorInterpretation": { + "description": "An interpretation is a place on earth, an annotated query s-tree and a 'legend' grouping tokens into terms, and mapping those to the hierarchy of featurelets inside the location. An interpretation is returned as part of the LocationExtractionResponse and not meant to be used directly. Next tag: 15", + "id": "LocationExtractorInterpretation", + "properties": { + "location": { + "$ref": "LocationExtractorLocation", + "description": "Location on Earth, containing featurelets ordered from most to least specific. These are referred to in the featurelet_index field below. In case of directions queries, this field contains departure location." + }, + "query": { + "description": "serialized s-expr annotated with :loc", + "type": "string" + }, + "term": { + "items": { + "$ref": "LocationExtractorInterpretationTerm" + }, + "type": "array" + } + }, + "type": "object" + }, + "LocationExtractorInterpretationTerm": { + "description": "This group provides details about what we found in the query as a set of non-overlapping 'terms', each referring to a separate political feature. E.g. query of \"Pizza near Mt View CA\" would (in one of the geocodes) contain two terms: \"Mt View\" and \"CA\". All terms are given in left-to-right order. Note that not all featurelets necessarily occur as a term. Some may have been inferred from the political hierarchy. E.g. in the example above there would be a featurelet for the US after the one for \"CA\".", + "id": "LocationExtractorInterpretationTerm", + "properties": { + "featureletIndex": { + "description": "index into location().featurelet() array (above).", + "format": "int32", + "type": "integer" + }, + "tokenEnd": { + "description": "1+last token covered by this term.", + "format": "int32", + "type": "integer" + }, + "tokenStart": { + "description": "These token indexes refer to the non-negated tokens of the query returned by the Interpretation. Note: That means you have to parse the query field with the SqueryParser, use QueryTreeUtils::FindOriginalNonNegatedWordNodes to get the original tokens, and use these 1-based indexes to retrieve the appropriate tokens from the result. You can NOT just split the original raw query on whitespace and use this as an offset. first token covered by this term.", + "format": "int32", + "type": "integer" + }, + "unexpectedLanguageMatch": { + "description": "Whether this term matched in a language that is \"unexpected\". For this purpose, expected languages are: request language, languages spoken in request country, English, unknown languages, and languages of the feature's country.", + "type": "boolean" + } + }, + "type": "object" + }, + "LocationExtractorLocation": { + "description": "A Location message represents a geographical feature with an associated confidence level. Within a LocationExtractionServerResponse message, this message is used to specify possible locations of the user, and possible locations the user may be interested in. Next tag: 41", + "id": "LocationExtractorLocation", + "properties": { + "addressRank": { + "deprecated": true, + "description": "Copy of FeatureProto->RankDetailsProto->address_rank", + "format": "float", + "type": "number" + }, + "areaRank": { + "deprecated": true, + "description": "Copy of FeatureProto->RankDetailsProto->area_rank", + "format": "float", + "type": "number" + }, + "boundingbox": { + "$ref": "LocationExtractorLocationBoundingBox", + "deprecated": true + }, + "center": { + "$ref": "LocationExtractorLocationCenter", + "deprecated": true + }, + "confidence": { + "deprecated": true, + "description": "Represents the Location Extraction Server's confidence that this Location is correct.", + "format": "float", + "type": "number" + }, + "featurelet": { + "items": { + "$ref": "LocationExtractorLocationFeaturelet" + }, + "type": "array" + }, + "ipblockinfo": { + "$ref": "IPBlockInfoProto", + "description": "Information about an ip block, like range, speed etc." + }, + "populationRank": { + "deprecated": true, + "description": "Copy of FeatureProto->RankDetailsProto->population_rank", + "format": "float", + "type": "number" + } + }, + "type": "object" + }, + "LocationExtractorLocationBoundingBox": { + "description": "Defines the bounding box for the area. The values specify a rectangle defined from low to high. Latitude and longitude (in degrees) x 10,000,000. We use sfixed32 (fixed-size int32) because they get transmitted using 4 bytes while int32 gets transmitted using 10 bytes.", + "id": "LocationExtractorLocationBoundingBox", + "properties": { + "highLatitudeE7": { + "format": "int32", + "type": "integer" + }, + "highLongitudeE7": { + "format": "int32", + "type": "integer" + }, + "lowLatitudeE7": { + "format": "int32", + "type": "integer" + }, + "lowLongitudeE7": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "LocationExtractorLocationCenter": { + "description": "Latitude and longitude of the area center (in degrees) x 10,000,000", + "id": "LocationExtractorLocationCenter", + "properties": { + "latitudeE7": { + "format": "int32", + "type": "integer" + }, + "longitudeE7": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "LocationExtractorLocationExtractionResponse": { + "description": "A LocationExtractionResponse message represents a response from the Location Extraction Server. If a location and / or area of interest was found, they will be included in the response. Next tag: 8", + "id": "LocationExtractorLocationExtractionResponse", + "properties": { + "interpretation": { + "description": "The request.max_interpretation() most likely interpretations of the input sexpr or raw_query. The ordering of interpretations is determined by request.scorer().", + "items": { + "$ref": "LocationExtractorInterpretation" + }, + "type": "array" + }, + "tainted": { + "description": "True if the results are unreliable, for example due to a deadline being broken.", + "type": "boolean" + }, + "userLocation": { + "description": "Represents the location of the end user, either from the ip or the user_address field in the request. For historical reasons, this is up to 3 separate locations that form a political hierarchy. See location/extractor/client/public/location.h:MergeLocations for a function to merge them into one. NOTE: the user_location does NOT influence the interpretations below. see the remarks about the ip field above. Conversely, this field is the ONLY field that changes depending on ip or user_address input.", + "items": { + "$ref": "LocationExtractorLocation" + }, + "type": "array" + } + }, + "type": "object" + }, + "LocationExtractorLocationFeaturelet": { + "description": "A location must have one or more Featurelets, each of which correspond to a single GeoStore Feature. The first Featurelet is considered to be the primary component of the location, and any additional Featurelets should be considered supplementary. For example, the Location \"Brooklyn\" might have Featurelets: 1) Brooklyn (borough) 2) New York (city) 3) New York (state) 4) United States (country) LINT.IfChange", + "id": "LocationExtractorLocationFeaturelet", + "properties": { + "additionalData": { + "$ref": "MessageSet", + "description": "A field to attach additional data about the feature. For example, the location extraction server uses this field to include the ads criteria id of the featurelet if available. As specified by MessageSet, all types within the set must be unique. Using the changelist number where the message was created is a good method of ensuring uniqueness." + }, + "alternateAnnotations": { + "description": "Alternate annotations on this featurelet.", + "items": { + "$ref": "LocationExtractorFeatureletAnnotationSet" + }, + "type": "array" + }, + "annotations": { + "description": "Annotations applied to this featurelet. This field is modified by the policy store.", + "items": { + "enum": [ + "TRIMMED_BY_QUALITY_FILTERING" + ], + "enumDescriptions": [ + "Indicate that a featurelet should not be used. This annotation is applied during ApplyQualityFiltering for feature \"trimming\" or added by the PolicyStore as a result of quality score calculation." + ], + "type": "string" + }, + "type": "array" + }, + "areaRank": { + "description": "Copy of FeatureProto->RankDetailsProto->area_rank", + "format": "float", + "type": "number" + }, + "boundingbox": { + "$ref": "LocationExtractorLocationFeatureletBoundingBox" + }, + "center": { + "$ref": "LocationExtractorLocationFeatureletCenter" + }, + "confidence": { + "description": "Represents the Location Extraction Server's confidence that this featurelet is correct. This is currently not populated by LES. Oolong will parse the LES response for IP addreses and combine multiple locations into a single location with multiple featurelets. This confidence will be populated by Oolong by looking into confidences from each of the locations.", + "format": "float", + "type": "number" + }, + "establishmentType": { + "description": "This field contains original feature's establishment type if it had one.", + "enum": [ + "TYPE_ANY", + "TYPE_UNDEFINED", + "TYPE_DEPRECATED_AVIATION", + "TYPE_BUSINESS", + "TYPE_TRAVEL_SERVICE", + "TYPE_LODGING", + "TYPE_HOTEL", + "TYPE_RESORT", + "TYPE_MOTEL", + "TYPE_HOSTEL", + "TYPE_GUESTHOUSE", + "TYPE_VACATION_RENTAL", + "TYPE_GAS_STATION", + "TYPE_REST_AREA", + "TYPE_CASH_MACHINE", + "TYPE_CAR_RENTAL", + "TYPE_CAR_REPAIR", + "TYPE_TAXI_STAND", + "TYPE_TRAVEL_AGENT", + "TYPE_BICYCLE_RENTAL_POINT", + "TYPE_ELECTRIC_VEHICLE_CHARGING_STATION", + "TYPE_SHOPPING", + "TYPE_GROCERY", + "TYPE_ANTIQUES", + "TYPE_APPAREL", + "TYPE_GIFTS", + "TYPE_JEWELRY", + "TYPE_SPORTING_GOODS", + "TYPE_VEHICLE", + "TYPE_SHOPPING_CENTER", + "TYPE_SUPERMARKET", + "TYPE_FAIRGROUNDS", + "TYPE_MARKET", + "TYPE_PRODUCE_MARKET", + "TYPE_FARMERS_MARKET", + "TYPE_LIQUOR_STORE", + "TYPE_SOUVENIR_SHOP", + "TYPE_INDUSTRIAL", + "TYPE_CONSTRUCTION", + "TYPE_BUILDING_MATERIAL", + "TYPE_SECURITY_PRODUCTS", + "TYPE_MECHANICAL", + "TYPE_TEXTILE", + "TYPE_CHEMICAL", + "TYPE_METAL", + "TYPE_TRANSPORTATION", + "TYPE_FREIGHT", + "TYPE_AVIATION", + "TYPE_COURIER", + "TYPE_MOVING", + "TYPE_PACKAGING", + "TYPE_RAIL", + "TYPE_PUBLIC_TRANSIT", + "TYPE_WAREHOUSE", + "TYPE_DEFENSE", + "TYPE_AGRICULTURE", + "TYPE_PLANTATION", + "TYPE_PLANT_NURSERY", + "TYPE_DESIGN", + "TYPE_UTILITIES", + "TYPE_POWER_PLANT", + "TYPE_SEWAGE_TREATMENT_PLANT", + "TYPE_WATER_TREATMENT_PLANT", + "TYPE_SUBSTATION", + "TYPE_MANUFACTURING", + "TYPE_BIOTECH", + "TYPE_MATERIALS", + "TYPE_MINING", + "TYPE_QUARRY", + "TYPE_TANNERY", + "TYPE_OIL_REFINERY", + "TYPE_ADVERTISING_MARKETING", + "TYPE_LEGAL", + "TYPE_FAMILY_LAW", + "TYPE_IP_LAW", + "TYPE_LABOR_LAW", + "TYPE_PERSONAL_INJURY_LAW", + "TYPE_CRIMINAL_LAW", + "TYPE_PERSONAL_FINANCE", + "TYPE_LIFE_INSURANCE", + "TYPE_LENDING", + "TYPE_ACCOUNTING", + "TYPE_INVESTING", + "TYPE_BANKING", + "TYPE_HEALTH", + "TYPE_HEALTH_EQUIPMENT", + "TYPE_NURSING", + "TYPE_HEALTH_INSURANCE", + "TYPE_HEALTH_FACILITY", + "TYPE_DIAGNOSTIC_CENTER", + "TYPE_HEALTH_RESOURCES", + "TYPE_NUTRITION", + "TYPE_VISION", + "TYPE_COUNSELING", + "TYPE_MASSAGE", + "TYPE_BLOOD_BANK", + "TYPE_HEARING", + "TYPE_HOME_GARDEN", + "TYPE_INTERIOR_DECOR", + "TYPE_DOMESTIC_SERVICES", + "TYPE_APPLIANCES", + "TYPE_PEST_CONTROL", + "TYPE_GARDENING", + "TYPE_ELECTRONICS", + "TYPE_COMPUTER", + "TYPE_COMPUTER_HARDWARE", + "TYPE_COMPUTER_SECURITY", + "TYPE_COMPUTER_SOFTWARE", + "TYPE_COMPUTER_SUPPORT", + "TYPE_AUDIO_DEVICES", + "TYPE_VIDEO_DEVICES", + "TYPE_REAL_ESTATE", + "TYPE_OFFICE_SERVICES", + "TYPE_ENTERTAINMENT", + "TYPE_GAMES", + "TYPE_CASINO", + "TYPE_LOTTO", + "TYPE_VIDEO", + "TYPE_CLUBS", + "TYPE_DISCOTHEQUE", + "TYPE_ANIMATION", + "TYPE_MODELING", + "TYPE_HUMOR", + "TYPE_MOVIES", + "TYPE_MOVIE_RENTAL", + "TYPE_MOVIE_THEATER", + "TYPE_MUSIC", + "TYPE_RADIO", + "TYPE_TV", + "TYPE_BAR", + "TYPE_PRINT_MEDIA", + "TYPE_ADULT", + "TYPE_SEXUAL_SERVICES", + "TYPE_ANIMALS", + "TYPE_PETS", + "TYPE_FISHERY", + "TYPE_ARTS", + "TYPE_BOOKS", + "TYPE_PERFORMING_ARTS", + "TYPE_GALLERY", + "TYPE_AUTOMOTIVE", + "TYPE_PARTS", + "TYPE_AUTO_FINANCE", + "TYPE_AUTO_INSURANCE", + "TYPE_RV", + "TYPE_MOTORCYCLES", + "TYPE_CARS", + "TYPE_TRUCKS_SUVS", + "TYPE_LICENSING", + "TYPE_MAINTENANCE", + "TYPE_PERSONAL_CARE", + "TYPE_BODY_ART", + "TYPE_COSMETICS", + "TYPE_FITNESS", + "TYPE_YOGA_CENTER", + "TYPE_GYM", + "TYPE_HAIR_CARE", + "TYPE_SPA", + "TYPE_BEAUTY_SALON", + "TYPE_CORPORATE_EVENTS", + "TYPE_HUMAN_RESOURCES", + "TYPE_FOOD_AND_DRINK", + "TYPE_BEVERAGE", + "TYPE_RECIPES", + "TYPE_COOKWARE", + "TYPE_CULINARY", + "TYPE_RETAIL", + "TYPE_RESTAURANT", + "TYPE_COFFEE", + "TYPE_BAKERY", + "TYPE_FOOD_CENTER", + "TYPE_TEA", + "TYPE_CAFE", + "TYPE_WINERY", + "TYPE_BREWERY", + "TYPE_FAST_FOOD", + "TYPE_FOOD_DELIVERY", + "TYPE_INTERNET", + "TYPE_WEB_DESIGN", + "TYPE_WEB_HOSTING", + "TYPE_WEB_SERVICES", + "TYPE_LIFESTYLE", + "TYPE_PHOTO_VIDEO", + "TYPE_ACTIVITIES", + "TYPE_BOATING", + "TYPE_CYCLING", + "TYPE_EQUESTRIAN", + "TYPE_FISHING", + "TYPE_HIKING", + "TYPE_HUNTING", + "TYPE_SWIMMING", + "TYPE_GOLF", + "TYPE_GOLF_COURSE", + "TYPE_BASEBALL", + "TYPE_BASKETBALL", + "TYPE_HOCKEY", + "TYPE_MOTOR_SPORTS", + "TYPE_WINTER_SPORTS", + "TYPE_FOOTBALL", + "TYPE_SOCCER", + "TYPE_ICE_SKATING", + "TYPE_BOXING", + "TYPE_CRICKET", + "TYPE_ROWING", + "TYPE_RUGBY", + "TYPE_RACQUET_SPORTS", + "TYPE_ROCK_CLIMBING", + "TYPE_REFERENCES", + "TYPE_MAPS", + "TYPE_TIME", + "TYPE_SCIENTIFIC_EQUIPMENT", + "TYPE_TELECOMMUNICATIONS", + "TYPE_EVENT_VENUE", + "TYPE_BANQUET_HALL", + "TYPE_CONFERENCE_HALL", + "TYPE_WEDDING_HALL", + "TYPE_EXHIBITION_HALL", + "TYPE_COMMUNITY_CENTER", + "TYPE_AUDITORIUM", + "TYPE_FUNCTION_HALL", + "TYPE_CONCERT_HALL", + "TYPE_AMPHITHEATER", + "TYPE_LAUNDRY", + "TYPE_LAUNDROMAT", + "TYPE_DRY_CLEANER", + "TYPE_MORTUARY", + "TYPE_REPAIR_AND_MAINTENANCE", + "TYPE_GOVERNMENT", + "TYPE_BORDER_CROSSING", + "TYPE_CITY_HALL", + "TYPE_COURTHOUSE", + "TYPE_EMBASSY", + "TYPE_LIBRARY", + "TYPE_PRISON", + "TYPE_TAX_OFFICE", + "TYPE_PROSECUTORS_OFFICE", + "TYPE_CONGRESS", + "TYPE_TOWN_COUNCIL", + "TYPE_CAPITOL_BUILDING", + "TYPE_VOTING_FACILITY", + "TYPE_CHECKPOINT", + "TYPE_SCHOOL", + "TYPE_UNIVERSITY", + "TYPE_ORPHANAGE", + "TYPE_KINDERGARTEN", + "TYPE_DAYCARE", + "TYPE_ACADEMY", + "TYPE_TRADE_SCHOOL", + "TYPE_SKILL_INSTRUCTION", + "TYPE_EMERGENCY", + "TYPE_HOSPITAL", + "TYPE_PHARMACY", + "TYPE_POLICE", + "TYPE_FIRE", + "TYPE_DOCTOR", + "TYPE_DENTIST", + "TYPE_VETERINARIAN", + "TYPE_FIRST_AID", + "TYPE_CIVIL_DEFENSE", + "TYPE_TOURIST_DESTINATION", + "TYPE_ECO_TOURIST_DESTINATION", + "TYPE_BIRD_WATCHING", + "TYPE_NATURE_RESERVE", + "TYPE_MUSEUM", + "TYPE_VISITOR_CENTER", + "TYPE_OBSERVATION_DECK", + "TYPE_OBSERVATORY", + "TYPE_SCENIC_POINT", + "TYPE_ZOO", + "TYPE_AQUARIUM", + "TYPE_AMUSEMENT_PARK", + "TYPE_MONUMENT", + "TYPE_PALACE", + "TYPE_FORT", + "TYPE_TOWER", + "TYPE_LIGHTHOUSE", + "TYPE_TEMPLE", + "TYPE_CHURCH", + "TYPE_GURUDWARA", + "TYPE_HINDU_TEMPLE", + "TYPE_MOSQUE", + "TYPE_SYNAGOGUE", + "TYPE_BUDDHIST_TEMPLE", + "TYPE_JAIN_TEMPLE", + "TYPE_BAHAI_TEMPLE", + "TYPE_SHINTO_TEMPLE", + "TYPE_MORMON_TEMPLE", + "TYPE_SPORTS_COMPLEX", + "TYPE_STADIUM", + "TYPE_BOWLING", + "TYPE_BADMINTON", + "TYPE_TENNIS", + "TYPE_TABLE_TENNIS", + "TYPE_PARK", + "TYPE_LOCAL_PARK", + "TYPE_NATIONAL_PARK", + "TYPE_US_NATIONAL_PARK", + "TYPE_US_NATIONAL_MONUMENT", + "TYPE_NATIONAL_FOREST", + "TYPE_NATIONAL_GRASSLAND", + "TYPE_NATIONAL_PRESERVE", + "TYPE_NATIONAL_RECREATION_AREA", + "TYPE_NATIONAL_MONUMENT", + "TYPE_NATIONAL_HISTORIC_AREA", + "TYPE_NATIONAL_SCENIC_AREA", + "TYPE_NATIONAL_SCENIC_ROADWAY_AREA", + "TYPE_NATIONAL_SCENIC_RIVER_AREA", + "TYPE_PROVINCIAL_PARK", + "TYPE_PROVINCIAL_FOREST", + "TYPE_CAMPGROUNDS", + "TYPE_WILDERNESS_AREA", + "TYPE_WILDLIFE_AREA", + "TYPE_BOTANICAL_GARDEN", + "TYPE_GARDEN", + "TYPE_ARBORETUM", + "TYPE_MARINE_PROTECTED_AREA", + "TYPE_AIRPORT", + "TYPE_TARMAC", + "TYPE_HELIPORT", + "TYPE_SEAPLANE_BASE", + "TYPE_MILITARY_AIRBASE", + "TYPE_CEMETERY", + "TYPE_MILITARY", + "TYPE_ENCLOSED_TRAFFIC_AREA", + "TYPE_PARKING", + "TYPE_OFF_ROAD_AREA", + "TYPE_POST_OFFICE", + "TYPE_HOUSING_DEVELOPMENT", + "TYPE_BRIDGE", + "TYPE_ARCHAEOLOGICAL", + "TYPE_HISTORICAL", + "TYPE_RUINS", + "TYPE_TUNNEL", + "TYPE_RESIDENTIAL_DWELLING", + "TYPE_DETACHED_DWELLING", + "TYPE_ATTACHED_DWELLING", + "TYPE_APARTMENT", + "TYPE_GATED_COMMUNITY", + "TYPE_RETIREMENT_HOME", + "TYPE_TOLL_BOOTH", + "TYPE_CULTURAL", + "TYPE_CULTURAL_CENTER", + "TYPE_OVERPASS", + "TYPE_REST_ROOM", + "TYPE_PUBLIC_PHONE", + "TYPE_PHONE_BOOTH", + "TYPE_MANNED_PCO", + "TYPE_RESEARCH_INSTITUTE", + "TYPE_NON_GOVERNMENTAL_ORGANIZATION", + "TYPE_OFFICE_PARK", + "TYPE_MEDITATION_CENTER", + "TYPE_RELIGIOUS", + "TYPE_MONASTERY", + "TYPE_ASHRAM", + "TYPE_PAGODA", + "TYPE_MISSION", + "TYPE_PILGRIM_DESTINATION", + "TYPE_SOCIAL_SERVICE", + "TYPE_RANGER_STATION", + "TYPE_TRANSIT_STATION", + "TYPE_BUS_STATION", + "TYPE_TRAMWAY_STATION", + "TYPE_TRAIN_STATION", + "TYPE_SUBWAY_STATION", + "TYPE_FERRY_TERMINAL", + "TYPE_CABLE_CAR_STATION", + "TYPE_GONDOLA_LIFT_STATION", + "TYPE_FUNICULAR_STATION", + "TYPE_HORSE_CARRIAGE_STATION", + "TYPE_MONORAIL_STATION", + "TYPE_SEAPORT", + "TYPE_NATURAL_FEATURE", + "TYPE_ELEVATED", + "TYPE_PEAK" + ], + "enumDescriptions": [ + "ABSTRACT", + "Can be used for features where no establishment information is available. For example, if an importer generates a TYPE_ESTABLISHMENT_BUILDING feature, but source data does not have any information on the actual purpose of the building, the importer should use TYPE_UNDEFINED for establishment type.", + "DEPRECATED", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "Note: 0xF213F is reserved to extend TYPE_INDUSTRIAL", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "0xF6F is reserved and any new types should start with 0xF6F1", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "State parks, county parks, city parks, wilderness areas. This also includes underwater preserves, wild and scenic rivers, etc. Should we have things like baseball diamonds?", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "Wildlife management area. This includes preservation areas for fish, game, and birds.", + "", + "", + "", + "", + "", + "An airport is a location where aircraft such as fixed-wing aircraft, helicopters, and blimps takeoff and land. NOTE: TYPE_TARMAC establishment type has been deprecated in favor of TYPE_TARMAC feature type. Once all data is modeled using the new feature type, the entry below should be removed.", + "DEPRECATED", + "A heliport is a small airport suitable only for use by helicopters.", + "A seaplane base is a special airport suitable for seaplanes.", + "An airbase (sometimes referred to correctly as an airfield, military airport, or Royal Air Force Station or Air Force Station) is a military airfield that provides basing and support of military aircraft.", + "", + "", + "The term \"enclosed traffic area\" is used extensively in Europe. It generally refers to a parking lot or other similar area through which traffic passes but are not generally considered to be a road. Another example is a piazza in an Italian town.", + "Establishment TYPE_PARKING is used for parking lots or garages. The actual feature type can be TYPE_ESTABLISHMENT_GROUNDS or TYPE_ESTABLISHMENT_BUILDING to distinguish between those.", + "", + "", + "In some country (like China), there will have a small area of housing development. Normally covers one or more city blocks.", + "In the Australian data we get bridges as POIs effectively. We'd like to include them so we can mapsearch for \"Sydney Harbour Bridge\" and others. Many other data sets have bridges modeled directly as segments, and so don't require this.", + "", + "In some countries historical objects are well known and important.", + "", + "Feature must be TYPE_ESTABLISHMENT_GROUNDS.", + "These types, when used with appropriate feature type (TYPE_ESTABLISHMENT_BUILDING, TYPE_ESTABLISHMENT_GROUNDS) can refer to a single building or a residential area (respectively).", + "", + "", + "All multi-unit housing such as duplex, condominium, apartment belongs to this.", + "", + "", + "In Korea most toll booths have their own names, and are often used as reference points. If an importer generates TYPE_TOLL_BOOTH establishment features with exact positions and names, then mapsearch will index them. Also this can be used to render them.", + "", + "", + "An overpass, or flyover is a structure that passes over another road or railway.", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "Hierarchy of transit station types. See go/transit-schema for more details.", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "" + ], + "type": "string" + }, + "featureId": { + "$ref": "GeostoreFeatureIdProto", + "description": "The GeoStore Feature ID for this feature. This field will be present when the featurelet was derived from or maps to an oyster feature." + }, + "kgReference": { + "$ref": "GeostoreKnowledgeGraphReferenceProto", + "description": "The reference to an entity in the KnowledgeGraph." + }, + "name": { + "description": "Each Featurelet includes the list of names that are associated with the corresponding GeoStore Feature.", + "items": { + "$ref": "GeostoreNameProto" + }, + "type": "array" + }, + "populationRank": { + "description": "Copy of FeatureProto->RankDetailsProto->population_rank", + "format": "float", + "type": "number" + }, + "type": { + "description": "The GeoStore Feature type.", + "enum": [ + "TYPE_ANY", + "TYPE_TRANSPORTATION", + "TYPE_ROUTE", + "TYPE_DEPRECATED_HIGHWAY_DO_NOT_USE", + "TYPE_HIGHWAY", + "TYPE_HIGHWAY_1", + "TYPE_HIGHWAY_2", + "TYPE_HIGHWAY_3", + "TYPE_HIGHWAY_4", + "TYPE_HIGHWAY_5", + "TYPE_HIGHWAY_6", + "TYPE_HIGHWAY_7", + "TYPE_HIGHWAY_8", + "TYPE_HIGHWAY_9", + "TYPE_BICYCLE_ROUTE", + "TYPE_TRAIL", + "TYPE_SEGMENT", + "TYPE_ROAD", + "TYPE_RAILWAY", + "TYPE_STANDARD_TRACK", + "TYPE_JR_TRACK", + "TYPE_NARROW_TRACK", + "TYPE_MONORAIL_TRACK", + "TYPE_SUBWAY_TRACK", + "TYPE_LIGHT_RAIL_TRACK", + "TYPE_BROAD_TRACK", + "TYPE_HIGH_SPEED_RAIL", + "TYPE_TROLLEY_TRACK", + "TYPE_FERRY", + "TYPE_FERRY_BOAT", + "TYPE_FERRY_TRAIN", + "TYPE_VIRTUAL_SEGMENT", + "TYPE_INTERSECTION", + "TYPE_TRANSIT", + "TYPE_TRANSIT_STATION", + "TYPE_BUS_STATION", + "TYPE_TRAMWAY_STATION", + "TYPE_TRAIN_STATION", + "TYPE_SUBWAY_STATION", + "TYPE_FERRY_TERMINAL", + "TYPE_AIRPORT", + "TYPE_AIRPORT_CIVIL", + "TYPE_AIRPORT_MILITARY", + "TYPE_AIRPORT_MIXED", + "TYPE_HELIPORT", + "TYPE_SEAPLANE_BASE", + "TYPE_AIRSTRIP", + "TYPE_CABLE_CAR_STATION", + "TYPE_GONDOLA_LIFT_STATION", + "TYPE_FUNICULAR_STATION", + "TYPE_SPECIAL_STATION", + "TYPE_HORSE_CARRIAGE_STATION", + "TYPE_MONORAIL_STATION", + "TYPE_SEAPORT", + "TYPE_TRANSIT_STOP", + "TYPE_TRANSIT_TRIP", + "TYPE_TRANSIT_DEPARTURE", + "TYPE_TRANSIT_LEG", + "TYPE_TRANSIT_LINE", + "TYPE_TRANSIT_AGENCY_DEPRECATED_VALUE", + "TYPE_TRANSIT_TRANSFER", + "TYPE_SEGMENT_PATH", + "TYPE_ROAD_SIGN", + "TYPE_INTERSECTION_GROUP", + "TYPE_PATHWAY", + "TYPE_RESTRICTION_GROUP", + "TYPE_TOLL_CLUSTER", + "TYPE_POLITICAL", + "TYPE_COUNTRY", + "TYPE_ADMINISTRATIVE_AREA", + "TYPE_ADMINISTRATIVE_AREA1", + "TYPE_US_STATE", + "TYPE_GB_COUNTRY", + "TYPE_JP_TODOUFUKEN", + "TYPE_ADMINISTRATIVE_AREA2", + "TYPE_GB_FORMER_POSTAL_COUNTY", + "TYPE_GB_TRADITIONAL_COUNTY", + "TYPE_ADMINISTRATIVE_AREA3", + "TYPE_ADMINISTRATIVE_AREA4", + "TYPE_ADMINISTRATIVE_AREA5", + "TYPE_ADMINISTRATIVE_AREA6", + "TYPE_ADMINISTRATIVE_AREA7", + "TYPE_ADMINISTRATIVE_AREA8", + "TYPE_ADMINISTRATIVE_AREA9", + "TYPE_COLLOQUIAL_AREA", + "TYPE_RESERVATION", + "TYPE_LOCALITY", + "TYPE_GB_POST_TOWN", + "TYPE_JP_GUN", + "TYPE_JP_SHIKUCHOUSON", + "TYPE_JP_SUB_SHIKUCHOUSON", + "TYPE_COLLOQUIAL_CITY", + "TYPE_SUBLOCALITY", + "TYPE_US_BOROUGH", + "TYPE_GB_DEPENDENT_LOCALITY", + "TYPE_JP_OOAZA", + "TYPE_JP_KOAZA", + "TYPE_JP_GAIKU", + "TYPE_GB_DOUBLE_DEPENDENT_LOCALITY", + "TYPE_JP_CHIBAN", + "TYPE_JP_EDABAN", + "TYPE_SUBLOCALITY1", + "TYPE_SUBLOCALITY2", + "TYPE_SUBLOCALITY3", + "TYPE_SUBLOCALITY4", + "TYPE_SUBLOCALITY5", + "TYPE_NEIGHBORHOOD", + "TYPE_CONSTITUENCY", + "TYPE_DESIGNATED_MARKET_AREA", + "TYPE_SCHOOL_DISTRICT", + "TYPE_LAND_PARCEL", + "TYPE_DISPUTED_AREA", + "TYPE_POLICE_JURISDICTION", + "TYPE_STATISTICAL_AREA", + "TYPE_CONSTITUENCY_FUTURE", + "TYPE_PARK", + "TYPE_GOLF_COURSE", + "TYPE_LOCAL_PARK", + "TYPE_NATIONAL_PARK", + "TYPE_US_NATIONAL_PARK", + "TYPE_US_NATIONAL_MONUMENT", + "TYPE_NATIONAL_FOREST", + "TYPE_PROVINCIAL_PARK", + "TYPE_PROVINCIAL_FOREST", + "TYPE_CAMPGROUNDS", + "TYPE_HIKING_AREA", + "TYPE_BUSINESS", + "TYPE_GOVERNMENT", + "TYPE_BORDER_CROSSING", + "TYPE_CITY_HALL", + "TYPE_COURTHOUSE", + "TYPE_EMBASSY", + "TYPE_LIBRARY", + "TYPE_SCHOOL", + "TYPE_UNIVERSITY", + "TYPE_EMERGENCY", + "TYPE_HOSPITAL", + "TYPE_PHARMACY", + "TYPE_POLICE", + "TYPE_FIRE", + "TYPE_DOCTOR", + "TYPE_DENTIST", + "TYPE_VETERINARIAN", + "TYPE_TRAVEL_SERVICE", + "TYPE_LODGING", + "TYPE_RESTAURANT", + "TYPE_GAS_STATION", + "TYPE_PARKING", + "TYPE_POST_OFFICE", + "TYPE_REST_AREA", + "TYPE_CASH_MACHINE", + "TYPE_CAR_RENTAL", + "TYPE_CAR_REPAIR", + "TYPE_SHOPPING", + "TYPE_GROCERY", + "TYPE_TOURIST_DESTINATION", + "TYPE_ECO_TOURIST_DESTINATION", + "TYPE_BIRD_WATCHING", + "TYPE_FISHING", + "TYPE_HUNTING", + "TYPE_NATURE_RESERVE", + "TYPE_TEMPLE", + "TYPE_CHURCH", + "TYPE_GURUDWARA", + "TYPE_HINDU_TEMPLE", + "TYPE_MOSQUE", + "TYPE_SYNAGOGUE", + "TYPE_STADIUM", + "TYPE_BAR", + "TYPE_MOVIE_RENTAL", + "TYPE_COFFEE", + "TYPE_GOLF", + "TYPE_BANK", + "TYPE_DOODLE", + "TYPE_GROUNDS", + "TYPE_AIRPORT_GROUNDS", + "TYPE_BUILDING_GROUNDS", + "TYPE_CEMETERY", + "TYPE_HOSPITAL_GROUNDS", + "TYPE_INDUSTRIAL", + "TYPE_MILITARY", + "TYPE_SHOPPING_CENTER", + "TYPE_SPORTS_COMPLEX", + "TYPE_UNIVERSITY_GROUNDS", + "TYPE_DEPRECATED_TARMAC", + "TYPE_ENCLOSED_TRAFFIC_AREA", + "TYPE_PARKING_LOT", + "TYPE_PARKING_GARAGE", + "TYPE_OFF_ROAD_AREA", + "TYPE_BORDER", + "TYPE_BUILDING", + "TYPE_GEOCODED_ADDRESS", + "TYPE_NATURAL_FEATURE", + "TYPE_TERRAIN", + "TYPE_SAND", + "TYPE_BEACH", + "TYPE_DUNE", + "TYPE_ROCKY", + "TYPE_ICE", + "TYPE_GLACIER", + "TYPE_BUILT_UP_AREA", + "TYPE_VEGETATION", + "TYPE_SHRUBBERY", + "TYPE_WOODS", + "TYPE_AGRICULTURAL", + "TYPE_GRASSLAND", + "TYPE_TUNDRA", + "TYPE_DESERT", + "TYPE_SALT_FLAT", + "TYPE_WATER", + "TYPE_OCEAN", + "TYPE_BAY", + "TYPE_BIGHT", + "TYPE_LAGOON", + "TYPE_SEA", + "TYPE_STRAIT", + "TYPE_INLET", + "TYPE_FJORD", + "TYPE_LAKE", + "TYPE_SEASONAL_LAKE", + "TYPE_RESERVOIR", + "TYPE_POND", + "TYPE_RIVER", + "TYPE_RAPIDS", + "TYPE_DISTRIBUTARY", + "TYPE_CONFLUENCE", + "TYPE_WATERFALL", + "TYPE_SPRING", + "TYPE_GEYSER", + "TYPE_HOT_SPRING", + "TYPE_SEASONAL_RIVER", + "TYPE_WADI", + "TYPE_ESTUARY", + "TYPE_WETLAND", + "TYPE_WATER_NAVIGATION", + "TYPE_FORD", + "TYPE_CANAL", + "TYPE_HARBOR", + "TYPE_CHANNEL", + "TYPE_REEF", + "TYPE_REEF_FLAT", + "TYPE_REEF_GROWTH", + "TYPE_REEF_EXTENT", + "TYPE_REEF_ROCK_SUBMERGED", + "TYPE_IRRIGATION", + "TYPE_DAM", + "TYPE_DRINKING_WATER", + "TYPE_CURRENT", + "TYPE_WATERING_HOLE", + "TYPE_TECTONIC", + "TYPE_WATERING_HOLE_DEPRECATED", + "TYPE_VOLCANO", + "TYPE_LAVA_FIELD", + "TYPE_FISSURE", + "TYPE_FAULT", + "TYPE_LAND_MASS", + "TYPE_CONTINENT", + "TYPE_ISLAND", + "TYPE_ATOLL", + "TYPE_OCEAN_ROCK_EXPOSED", + "TYPE_CAY", + "TYPE_PENINSULA", + "TYPE_ISTHMUS", + "TYPE_ELEVATED", + "TYPE_PEAK", + "TYPE_NUNATAK", + "TYPE_SPUR", + "TYPE_PASS", + "TYPE_PLATEAU", + "TYPE_RIDGE", + "TYPE_RAVINE", + "TYPE_CRATER", + "TYPE_KARST", + "TYPE_CLIFF", + "TYPE_VISTA", + "TYPE_DIGITAL_ELEVATION_MODEL", + "TYPE_UPLAND", + "TYPE_TERRACE", + "TYPE_SLOPE", + "TYPE_CONTOUR_LINE", + "TYPE_PAN", + "TYPE_UNSTABLE_HILLSIDE", + "TYPE_MOUNTAIN_RANGE", + "TYPE_UNDERSEA", + "TYPE_SUBMARINE_SEAMOUNT", + "TYPE_SUBMARINE_RIDGE", + "TYPE_SUBMARINE_GAP", + "TYPE_SUBMARINE_PLATEAU", + "TYPE_SUBMARINE_DEEP", + "TYPE_SUBMARINE_VALLEY", + "TYPE_SUBMARINE_BASIN", + "TYPE_SUBMARINE_SLOPE", + "TYPE_SUBMARINE_CLIFF", + "TYPE_SUBMARINE_PLAIN", + "TYPE_SUBMARINE_FRACTURE_ZONE", + "TYPE_CAVE", + "TYPE_ROCK", + "TYPE_ARCHIPELAGO", + "TYPE_POSTAL", + "TYPE_POSTAL_CODE", + "TYPE_POSTAL_CODE_PREFIX", + "TYPE_PREMISE", + "TYPE_SUB_PREMISE", + "TYPE_SUITE", + "TYPE_POST_TOWN", + "TYPE_POSTAL_ROUND", + "TYPE_META_FEATURE", + "TYPE_DATA_SOURCE", + "TYPE_LOCALE", + "TYPE_TIMEZONE", + "TYPE_BUSINESS_CHAIN", + "TYPE_PHONE_NUMBER_PREFIX", + "TYPE_PHONE_NUMBER_AREA_CODE", + "TYPE_BUSINESS_CORRIDOR", + "TYPE_ADDRESS_TEMPLATE", + "TYPE_TRANSIT_AGENCY", + "TYPE_FUTURE_GEOMETRY", + "TYPE_EVENT", + "TYPE_EARTHQUAKE", + "TYPE_HURRICANE", + "TYPE_WEATHER_CONDITION", + "TYPE_TRANSIENT", + "TYPE_ENTRANCE", + "TYPE_CARTOGRAPHIC", + "TYPE_HIGH_TENSION", + "TYPE_SKI_TRAIL", + "TYPE_SKI_LIFT", + "TYPE_SKI_BOUNDARY", + "TYPE_WATERSHED_BOUNDARY", + "TYPE_TARMAC", + "TYPE_WALL", + "TYPE_PICNIC_AREA", + "TYPE_PLAY_GROUND", + "TYPE_TRAIL_HEAD", + "TYPE_GOLF_TEEING_GROUND", + "TYPE_GOLF_PUTTING_GREEN", + "TYPE_GOLF_ROUGH", + "TYPE_GOLF_SAND_BUNKER", + "TYPE_GOLF_FAIRWAY", + "TYPE_GOLF_HOLE", + "TYPE_DEPRECATED_GOLF_SHOP", + "TYPE_CAMPING_SITE", + "TYPE_DESIGNATED_BARBECUE_PIT", + "TYPE_DESIGNATED_COOKING_AREA", + "TYPE_CAMPFIRE_PIT", + "TYPE_WATER_FOUNTAIN", + "TYPE_LITTER_RECEPTACLE", + "TYPE_LOCKER_AREA", + "TYPE_ANIMAL_ENCLOSURE", + "TYPE_CARTOGRAPHIC_LINE", + "TYPE_ESTABLISHMENT", + "TYPE_ESTABLISHMENT_GROUNDS", + "TYPE_ESTABLISHMENT_BUILDING", + "TYPE_ESTABLISHMENT_POI", + "TYPE_ESTABLISHMENT_SERVICE", + "TYPE_CELESTIAL", + "TYPE_ROAD_MONITOR", + "TYPE_PUBLIC_SPACES_AND_MONUMENTS", + "TYPE_STATUE", + "TYPE_TOWN_SQUARE", + "TYPE_LEVEL", + "TYPE_COMPOUND", + "TYPE_COMPOUND_GROUNDS", + "TYPE_COMPOUND_BUILDING", + "TYPE_COMPOUND_SECTION", + "TYPE_TERMINAL_POINT", + "TYPE_REGULATED_AREA", + "TYPE_LOGICAL_BORDER", + "TYPE_GCONCEPT_ONLY", + "TYPE_DO_NOT_USE_RESERVED_TO_CATCH_GENERATED_FILES", + "TYPE_UNKNOWN" + ], + "enumDeprecated": [ + false, + 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, + true, + true, + true, + true, + true, + true, + true, + true, + true, + true, + true, + true, + true, + true, + true, + true, + true, + true, + true, + true, + true, + true, + true, + true, + false, + true, + true, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + true, + true, + true, + false, + true, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + true, + true, + true, + true, + false, + false, + true, + true, + true, + true, + true, + true, + true, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + true, + true, + true, + true, + true, + true, + true, + true, + true, + true, + true, + true, + true, + true, + true, + true, + true, + true, + true, + true, + true, + true, + true, + true, + true, + true, + true, + true, + true, + true, + true, + true, + true, + true, + true, + true, + true, + true, + true, + true, + true, + true, + true, + true, + true, + true, + true, + true, + true, + true, + true, + true, + true, + true, + true, + true, + true, + true, + true, + true, + true, + true, + true, + true, + true, + true, + true, + true, + true, + true, + true, + true, + true, + true, + true, + 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, + false, + false, + false, + false, + false, + 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, + false, + false, + false, + true, + true, + true, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + true, + true, + true, + true, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + true, + true, + false, + false, + false, + false, + false, + false, + false, + true, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + true, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + true, + false + ], + "enumDescriptions": [ + "ABSTRACT", + "ABSTRACT", + "A route is any section of road (or rails, etc.) that has a name. This includes city streets as well as highways. Road segments can belong to multiple routes (e.g. El Camino, CA-82).", + "DEPRECATED", + "ABSTRACT", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "A designated bicycle route, whose segments may consist of any combination of bicycle paths, bicycle lanes, or city streets.", + "A designated trail, which may consist of paved walkways, dirt paths, fire road, streets or highways, etc.", + "ABSTRACT", + "", + "Railroads use several different incompatible track types.", + "", + "", + "", + "", + "", + "", + "", + "", + "Tracks for streetcars, cable-cars, etc. Ferries are services that are part of the road network but are not roads. They typically involve fares and scheduled departure times.", + "ABSTRACT", + "The vast majority of ferries are ferry boats.", + "Also called a \"car transport\", a ferry train is a rail service that carries passengers and their vehicles across undrivable terrain. The Channel Tunnel (\"Chunnel\") is the most famous example, but they are also common in the Alps where they connect neighboring valleys otherwise separated by impassable mountains.", + "Any plausible 1-dimensional path through a 2+ dimensional space, for the purposes of making graph-search-based routing possible. Such segments can be used to model paths through parking lots, squares, floors of buildings and other areas.", + "An intersection consists of a collection of segments that terminate at the same location. This is topological definition: it may not match what a typical user would think of as an \"intersection\". See TYPE_INTERSECTION_GROUP, below, for more information. Each segment terminating at an intersection has an \"endpoint type\" that specifies how that segment is terminated: stop sign, yield sign, three-way light, etc.", + "ABSTRACT", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "A transit line is a collection of transit legs, associated with some invariant properties of the trips that run over the legs. See also transitline.proto", + "TYPE_TRANSIT_AGENCY was moved to 0xC91. This deprecated enum value still exists for debugging purposes only.", + "DEPRECATED", + "ABSTRACT", + "Road sign features have names, point geometry, etc. They also have segment_path data (see below) which lists the segments that refer to the sign. See segment.proto for the reference from the segment to the road sign.", + "Our TYPE_INTERSECTION feature, above, models the point where one or more segments terminate. This is topological definition: it may not match what a typical user would think of as an \"intersection\". Consider the intersections where Hayes, Market, Larkin, and 9th Street meet near (37.77765, -122.41638) in San Francisco. Most people would probably consider this a single feature, even though we model it as four separate TYPE_INTERSECTION features. This TYPE_INTERSECTION_GROUP is used to model the user's concept of a complex intersection.", + "RESERVED", + "A restriction group describes a set of segment restrictions that belong together and have a name or an associated event. See also restriction_group.proto", + "DEPRECATED", + "ABSTRACT", + "", + "ABSTRACT", + "", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "", + "DEPRECATED", + "DEPRECATED", + "", + "", + "", + "", + "", + "", + "", + "e.g. Silicon Valley", + "A reservation is a region collectively held or governed by indigenous people and officially recognized by the country’s government at the federal or state level. A reservation may be fully contained within an administrative feature or partially contained within two or more. These regions are referred to by different categorical names depending on country and even by state, including but not limited to: “Indian Reservations”, “Indian Reserves”, “Land Claim Settlement Lands”, “Indian Lands”, “Treaty Lands”, “Indigenous Territories”, etc. A reservation is not a historic indigenous territory boundary or a region which has applied for land rights but has not yet received official recognition.", + "", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "An entity widely considered to be a city, that may itself be made up of smaller political entities, some of which are cities/towns/villages themselves. For example, the colloquial view of Sydney, Australia actually comprises many smaller cities, but is regarded as a city itself. This type is not suitable for modeling official metro-/micropolitan or other statistical areas.", + "ABSTRACT", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "", + "", + "", + "", + "", + "", + "", + "Designated Market Areas (or DMAs) are used by marketing and ratings companies (such as the Nielsen Media Research company) to describe geographical regions (such as the greater New York metropolitan area) that are covered by a set of television stations. (See http://www.schooldata.com/pdfs/DMA.pdf) In the United States, DMAs should have a DMA numeric ID name, tagged with the FLAG_DESIGNATED_MARKET_AREA_ID flag.", + "", + "", + "Eventually we'll have more data for disputed areas (e.g., who makes claims on the area, who has de facto control, etc.). For the moment, we just define a type so we can simply mark areas as disputed.", + "Boundaries representing the jurisdiction of a particular police station.", + "An area used for aggregating statistical data, eg, a census region. Note that TYPE_STATISTICAL_AREA has a third nibble so we can add an abstract parent above it later if need be at 0x2E1 (and rename TYPE_STATISTICAL_AREA as TYPE_STATISTICAL_AREA1).", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "A line representing the boundary between two features. See border.proto for details.", + "DEPRECATED", + "An association of a point with an address, with no other information.", + "ABSTRACT", + "Expanses of land that share common surface attributes. These areas would look more or less uniform from a high altitude.", + "", + "", + "", + "", + "", + "", + "Terrain that looks populated.", + "Terrain that is covered in vegetation.", + "", + "", + "", + "", + "", + "", + "A flat expanse of salt left by the evaporation of a body of salt water.", + "Features can be TYPE_WATER if we don't have enough information to properly type the body of water. TYPE_WATER is also used as the type for child features that compose a TYPE_RIVER feature.", + "One of the large salt-water bodies that covers most of the globe.", + "An ocean subdivision formed by a coastal indentation. Includes coves and gulfs.", + "An open body of water formed by a slight coastal indentation.", + "", + "An ocean subdivision more or less confined by land and islands.", + "A long narrow ocean subdivision. Includes sounds.", + "", + "", + "An inland body of standing water.", + "A lake that dries up part of the year.", + "An artificial body of water, possibly created by a dam, often used for irrigation or house use.", + "", + "An inland body of moving water, or parts associated with it in which there is little or no current (backwater).", + "", + "A branch which flows away from the main river. Includes deltas.", + "A place where two or more rivers join.", + "", + "A place where ground water flows naturally out of the ground.", + "", + "", + "A river that dries up part of the year.", + "A dry riverbed that occasionally receives flashfloods.", + "A place at the end of a river where fresh and salt water mix. Includes tidal creeks and limans.", + "Land that is usually flooded. Includes bogs, marshes, flats, moors, and swamps.", + "", + "A shallow place where water may be waded through.", + "A narrow passage used by boats. Normally artificial.", + "A deep place near a shore where ships commonly drop anchor.", + "A deep part in a body of water that is suitable for navigation. Includes narrows.", + "Rocks, coral, sandbars, or other features beneath the surface of the water that pose a hazard to passing ships. Includes shoals.", + "A relatively shallow zone of the back reef located closest to the shore, that may be exposed at low tide.", + "A small section of rocks, coral, sandbars, or other features beneath the surface of the water that forms part of a reef.", + "The full extent of the reef complex.", + "A submerged rock in the water.", + "Man-made (and sometimes natural) channels used to move water. This type was used for both dam structures and water that is hold back by dams. We should use TYPE_COMPOUND_BUILDING for dam structures and TYPE_RESERVOIR for water.", + "DEPRECATED", + "", + "Includes overfalls.", + "A natural depression filled with water where animals come to drink.", + "This type is incorrectly under TYPE_TECTONIC instead of TYPE_WATER. This was a mistake and is now fixed. See TYPE_WATERING_HOLE for the replacement.", + "DEPRECATED", + "", + "", + "", + "", + "", + "", + "", + "", + "An exposed rock in the water.", + "A small, low-elevation, sandy island formed on the surface of coral reefs", + "A stretch of land projecting into water. Includes capes and spits.", + "A strip of land connecting two larger land masses, such as continents.", + "Features that are notable for being high (or low), or for having sudden changes in elevation. These features might have an \"elevation\" extension to specify the actual elevation. See ElevationProto for more information.", + "Elevations that have a distinctive peak.", + "A peak or ridge of a mountain that extends through a glacier.", + "A subsidiary peak of a mountain.", + "A route over an otherwise difficult to traverse feature. Includes saddle.", + "Elevations that are flat on top. Includes mesas and buttes.", + "A ridge is a geographical feature consisting of a chain of mountains or hills that form a continuous elevated crest with a single ridgeline for some distance.", + "Steep declines usually carved by erosion. Includes valleys, canyons, ditches, and gorges.", + "Depressions causes by impact, explosion, and sometimes sink-holes.", + "Topography formed on limestone and gypsum by dissolution with sinkholes, caves, etc.", + "A vertical or nearly vertical slope. Includes escarpments.", + "An elevated place that is notable for having a good view. Raster digital elevation data. This is not a type to be used by providers or consumed by clients.", + "RESERVED", + "Land along streams higher than the alluvial plain or stream terrace.", + "", + "Land not so steep as a cliff, but changing elevation. Includes slides.", + "All the points on the polygon are at the same elevation.", + "A near-level shallow, natural depression or basin, usually containing an intermittent lake, pond, or pool.", + "", + "A series of mountains or hills ranged in a line and connected by high ground. Mountain ranges usually consist of many smaller ridges. For example, the Himalayas, the Andes. the Alps, etc.", + "Features that are notable for being high (or low), or for having sudden changes in elevation. These features might have an \"elevation\" extension to specify the actual elevation. See ElevationProto for more information.", + "includes peaks, ranges, and spurs", + "", + "includes saddles", + "", + "", + "includes trenches and troughs", + "", + "", + "", + "", + "", + "Don't use 0xA7. Use 8 bits for additional types under TYPE_NATURAL_FEATURE, so we don't run out of space. The following are miscellaneous natural features that don't fit any of the categories above.", + "", + "A feature representing a group or chain of islands. ", + "ABSTRACT", + "This is the type for postal codes which are complete and independent enough that there should be a feature for them (e.g. US 5-digit ZIP codes). For even more detailed suffixes that further subdivide a postal code (such as the +4 component in US ZIP codes), store the information in a TYPE_POSTAL_CODE_SUFFIX address component. When a range or set of postal codes share the same geographical area, e.g. because a precise subdivision does not exist or this subdivision is unknown, this type is used for each individual postal code.", + "A prefix portion of a postal code which does not meet the requirements for TYPE_POSTAL_CODE, but which is useful to search for, for example UK outcodes.", + "DEPRECATED", + "DEPRECATED This is deprecated and we want to use TYPE_COMPOUND_SECTION instead.", + "DEPRECATED", + "The term \"post town\" is used for a locality-like-entity that is only used for postal addresses.", + "DEPRECATED", + "ABSTRACT", + "Every data source used in constructing a data repository has a corresponding feature that provides more information about that data source. The extra information is stored in the optional data_source field below.", + "A locale feature provides region specific conventions such as preferred language and formatting details for time, date, and currency values. Locales aren't necessary defined by physical geographic features, so they are classified as meta-features.", + "A timezone feature is used to specify the region covering an international timezone. When a point is covered by multiple timezone features, the most specific one can be used to compute the local time at this point. Most specific implies a much smaller region or the one that is closer to the center. A feature's timezone can be specified in the repeated related_timezone field.", + "A business chain feature is used to represent a chain, e.g. Starbucks, McDonald's, etc. Other features representing specific stores/franchises of this chain may refer to one such feature via RELATION_MEMBER_OF_CHAIN. This is not strictly reserved to commercial chains but can also be used to model organizations such as the Red Cross or the United Nations.", + "A phone number prefix feature is used to specify the region where phone numbers (typically fixed-line numbers) must begin with a certain prefix. Any phone number prefix down to any level of granularity could be represented by this type.", + "A phone number area code is a prefix which also coincides with the area code, or national destination code, of a particular region.", + "A Business Corridor is a dense cluster of semantically similar establishments. TYPE_BUSINESS_CORRIDOR features are distinguished from TYPE_COLLOQUIAL_AREA features because the corridors are not under the political hierarchy, are allowed to be nameless, and may not correspond to well-known real world locations. For more details, see go/geo-corridors-schema.", + "An address template feature provides region-specific conventions for structuring addresses. These features aren't necessarily defined by physical geographic features, so they are classified as meta-features.", + "A transit agency operates a number of lines, typically all in the same city, region or country. See also transitagency.proto", + "A feature whose geometry is planned to replace the geometry on another feature.", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "RESERVED", + "A portal of entry or exit to another feature. Examples: - Subway station entrance. - Parking lot entrance.", + "Cartographic features are used to capture real-world objects for which there is no current desire to model any specific attributes. These are only useful to make the map tiles look pretty.", + "DEPRECATED", + "Also see skitrail.proto", + "Also see skilift.proto", + "Also see skiboundary.proto", + "", + "Starting with TYPE_TARMAC, we use longer IDs, so that we can expand the number of feature types under TYPE_CARTOGRAPHIC.", + "Use TYPE_COMPOUND_GROUND and appropriate gcids for the next two.", + "DEPRECATED", + "DEPRECATED", + "", + "Sub-types within a golf course.", + "", + "", + "", + "", + "Use TYPE_ESTABLISHMENT_POI and gcid:golf_shop for golf shops instead.", + "DEPRECATED", + "DEPRECATED", + "", + "", + "", + "", + "", + "", + "Subtype within a zoo - a cage or fenced-off or otherwise delineated area containing animals.", + "A line for a cartographic detail. For example the international date line. Such features should have polyline geometry.", + "ABSTRACT This type is being replaced by TYPE_COMPOUND_GROUNDS. For further details, see go/compounds-v2", + "DEPRECATED This type has been replaced by TYPE_COMPOUND_BUILDING. For further details, see go/oyster-compounds", + "DEPRECATED", + "An establishment that has a physical location. Note that it *may* also have a service area (e.g. a restaurant that offers both dine-in and delivery). This type of business is also known as a \"hybrid\" Service Area Business. Establishment POIs can be referenced by TYPE_COMPOUND features using the RELATION_PRIMARILY_OCCUPIED_BY. This is the reciprocal relation of the RELATION_OCCUPIES.", + "NOTE(tcain): Using value 0xD441, since we could find ourselves with a need to differentiate service areas from online-only at this level in the future, but still benefit from being able to group those under a common parent, disjoint from TYPE_ESTABLISHMENT_POI.", + "The root of types of features that are in the sky, rather than on the earth. There will eventually be a hierarchy of types here.", + "Features responsible for monitoring traffic on roads (usually for speed). Includes cameras at particular points as well as monitors that cover larger spans. Features of this type should have a corresponding gcid that specifies the correct subtype (e.g. gcid:road_camera or gcid:speed_camera_zone). This type was originally named as TYPE_ROAD_CAMERA.", + "ABSTRACT", + "Note that this type does not distinguish the nature of the statue (religious, historical, memorial, tourist, ...).", + "Open space used for events, gathering, or as market-place.", + "A feature used to represent a logical level, e.g. floor.", + "ABSTRACT", + "e.g. campus, compound, parcel.", + "e.g. single family dwelling, office building.", + "e.g. suite, room, hallway, cubicle.", + "A terminal point represents a good location for a user to meet a taxi, ridesharing vehicle, or general driver.", + "An area controlled in some way by an authoritative source, such as a government-designated COVID containment zone or an area under government sanctions. Features of this type should have one or more gcids corresponding to their specific regulation, and client handling of these features may vary based on the type of regulation.", + "A grouping of TYPE_BORDER features (\"border segments\"), which together represent a border between two features of the same type.", + "A generic feature type for any geo-type that cannot be modeled under existing feature types. No new feature type should be created within feature proto after this type.", + "DEPRECATED", + "A feature of completely unknown type. This should only be used when absolutely necessary. One example in which this type is useful is in the Chinese importer, which must heuristically segment addresses into components - it often does not know what types to make those components. Please note that the Oyster address formatter does not currently support address components of TYPE_UNKNOWN well." + ], + "type": "string" + } + }, + "type": "object" + }, + "LocationExtractorLocationFeatureletBoundingBox": { + "description": "Defines the bounding box for the area. The values specify a rectangle defined from low to high. Latitude and longitude (in degrees) x 10,000,000. We use sfixed32 (fixed size int32) because they get transmitted using 4 bytes while int32 gets transmitted using 10 bytes. This is currently not populated by LES. Oolong will parse the LES response for IP addreses and combine multiple locations into a single location with multiple featurelets. This will be populated by Oolong by looking into bounding boxes from each location.", + "id": "LocationExtractorLocationFeatureletBoundingBox", + "properties": { + "highLatitudeE7": { + "format": "int32", + "type": "integer" + }, + "highLongitudeE7": { + "format": "int32", + "type": "integer" + }, + "lowLatitudeE7": { + "format": "int32", + "type": "integer" + }, + "lowLongitudeE7": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "LocationExtractorLocationFeatureletCenter": { + "description": "Latitude and longitude of the feature center (in degrees) x 10,000,000", + "id": "LocationExtractorLocationFeatureletCenter", + "properties": { + "latitudeE7": { + "format": "int32", + "type": "integer" + }, + "longitudeE7": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "LocationUnifiedActivityRecord": { + "description": "Represents a detected activity record. Next id 3.", + "id": "LocationUnifiedActivityRecord", + "properties": { + "confidence": { + "description": "The confidence of the detection. Range is [0, 100].", + "format": "int32", + "type": "integer" + }, + "type": { + "description": "The type of activity.", + "enum": [ + "IN_VEHICLE", + "ON_BICYCLE", + "ON_FOOT", + "STILL", + "UNKNOWN", + "TILTING", + "EXITING_VEHICLE", + "WALKING", + "RUNNING", + "OFF_BODY", + "TRUSTED_GAIT", + "FLOOR_CHANGE", + "ON_STAIRS", + "ON_ESCALATOR", + "IN_ELEVATOR", + "SLEEPING", + "IN_ROAD_VEHICLE", + "IN_RAIL_VEHICLE", + "IN_TWO_WHEELER_VEHICLE", + "IN_FOUR_WHEELER_VEHICLE", + "IN_CAR", + "IN_BUS", + "EXPERIMENTAL_EXTRA_PERSONAL_VEHICLE" + ], + "enumDescriptions": [ + "LINT.IfChange", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "This is to support EXPERIMENTAL_EXTRA_PERSONAL_VEHICLE until Activity Recognition team figures out their API. LINT.ThenChange( //depot/google3/java/com/google/geo/sidekick/proto/detected_activity.proto, //depot/google3/personalization/context/proto/detected_activity/detected_activity.proto )" + ], + "type": "string" + } + }, + "type": "object" + }, + "LocationUnifiedAnnotationSet": { + "description": "A set of annotations (e.g., those applied by some particular policy). Next tag: 6", + "id": "LocationUnifiedAnnotationSet", + "properties": { + "annotations": { + "description": "The annotations that have been applied by some policy.", + "items": { + "$ref": "LocationUnifiedLocationAnnotation" + }, + "type": "array" + }, + "clientId": { + "description": "If set then this set of annotations are originating from this client id for production use.", + "enum": [ + "CLIENT_UNKNOWN", + "CLIENT_CURIO", + "CLIENT_ONE_GOOGLE_SERVICE", + "CLIENT_EVALS", + "CLIENT_EVALS_ONESHOT", + "CLIENT_EVALS_UQS", + "CLIENT_BOOKS", + "CLIENT_BOND", + "CLIENT_CHROME_UMA", + "CLIENT_DOUBLECLICK_SEARCH", + "CLIENT_YOUTUBE_ISP_RATING", + "CLIENT_YOUTUBE_REAL_TIME_QOE", + "CLIENT_YOUTUBE_QOE_LIVYATAN", + "CLIENT_YOUTUBE", + "CLIENT_YOUTUBE_SHORTS_DESKTOP_GAIA", + "CLIENT_YOUTUBE_SHORTS_DESKTOP_ZWIEBACK", + "CLIENT_YOUTUBE_SHORTS_MOBILE_GAIA", + "CLIENT_YOUTUBE_SHORTS_MOBILE_ZWIEBACK", + "CLIENT_YOUTUBE_VIRAL_DESKTOP_GAIA", + "CLIENT_YOUTUBE_VIRAL_DESKTOP_ZWIEBACK", + "CLIENT_YOUTUBE_VIRAL_MOBILE_GAIA", + "CLIENT_YOUTUBE_VIRAL_MOBILE_ZWIEBACK", + "CLIENT_YOUTUBE_VIRAL_LES", + "CLIENT_YOUTUBE_VIRAL_EXP_DESKTOP_GAIA", + "CLIENT_YOUTUBE_VIRAL_EXP_DESKTOP_ZWIEBACK", + "CLIENT_YOUTUBE_VIRAL_EXP_MOBILE_GAIA", + "CLIENT_YOUTUBE_VIRAL_EXP_MOBILE_ZWIEBACK", + "CLIENT_YOUTUBE_VIRAL_DESKTOP_GAIA_AXOLOTL", + "CLIENT_YOUTUBE_VIRAL_DESKTOP_ZWIEBACK_AXOLOTL", + "CLIENT_YOUTUBE_VIRAL_MOBILE_GAIA_AXOLOTL", + "CLIENT_YOUTUBE_VIRAL_MOBILE_ZWIEBACK_AXOLOTL", + "CLIENT_YOUTUBE_VIRAL_DESKTOP_GAIA_BADGER", + "CLIENT_YOUTUBE_VIRAL_DESKTOP_ZWIEBACK_BADGER", + "CLIENT_YOUTUBE_VIRAL_MOBILE_GAIA_BADGER", + "CLIENT_YOUTUBE_VIRAL_MOBILE_ZWIEBACK_BADGER", + "CLIENT_YOUTUBE_VIRAL_DESKTOP_GAIA_CHIPMUNK", + "CLIENT_YOUTUBE_VIRAL_DESKTOP_ZWIEBACK_CHIPMUNK", + "CLIENT_YOUTUBE_VIRAL_MOBILE_GAIA_CHIPMUNK", + "CLIENT_YOUTUBE_VIRAL_MOBILE_ZWIEBACK_CHIPMUNK", + "CLIENT_YOUTUBE_ADMIN_YURT", + "CLIENT_YOUTUBE_BAD_HARVEST", + "CLIENT_SPEECH", + "CLIENT_GMAIL", + "CLIENT_GMAIL_SPAM", + "CLIENT_CHROMECAST_WEB", + "CLIENT_PANCETTA", + "CLIENT_GOOGLE_LOCATION_SERVER", + "CLIENT_GOOGLE_FEEDBACK", + "CLIENT_ANDROID_METRICS_WAREHOUSE", + "CLIENT_USERMGMT", + "CLIENT_APPREMOTING", + "CLIENT_GAIA_PERMISSION_SERVER", + "CLIENT_ACTIONABLE_IPS", + "CLIENT_DISPLAY_ADS", + "CLIENT_DISPLAY_ADS_DEFAULT", + "CLIENT_DISPLAY_ADS_DESKTOP_GAIA", + "CLIENT_DISPLAY_ADS_DESKTOP_ZWIEBACK", + "CLIENT_DISPLAY_ADS_MOBILE_GAIA", + "CLIENT_DISPLAY_ADS_MOBILE_ZWIEBACK", + "CLIENT_DISPLAY_ADS_PREVIEW", + "CLIENT_HOBBES", + "CLIENT_NEWSSTAND", + "CLIENT_NEWSSTAND_EXPERIMENTAL", + "CLIENT_POLYNEWS", + "CLIENT_DOCS", + "CLIENT_ADWORDS_EXPRESS", + "CLIENT_TRACE_DEPOT", + "CLIENT_MAPSPRO", + "CLIENT_GEO_ONDEMAND", + "CLIENT_ACCESS_FILTER", + "CLIENT_DOMAIN_REGISTRAR", + "CLIENT_ASSISTANT", + "CLIENT_ASSISTANT_FRONTEND", + "CLIENT_ACCOUNT_LINKING", + "CLIENT_LEGAL_REMOVALS", + "CLIENT_CLOUD_CONSOLE", + "CLIENT_CLOUD_FREE_TRIAL", + "CLIENT_CLOUD_SOLUTIONS_CATALOG", + "CLIENT_CLOUD_MEDIA_ACCESS", + "CLIENT_DOTORG_G4NP", + "CLIENT_CRASH_INTERNAL", + "CLIENT_GOOGLE_WIFI_MONLOG", + "CLIENT_GOOGLE_VOICE", + "CLIENT_BLOGGER", + "CLIENT_THOR_BACKEND", + "CLIENT_NEWS", + "CLIENT_GOOGLE_PHOTOS", + "CLIENT_GOOGLE_PHOTOS_INFERRED_LOCATION", + "CLIENT_RANKBRAIN_DEBUG", + "CLIENT_HETERODYNE", + "CLIENT_FRAUDREVIEW", + "CLIENT_JAMBOARD", + "CLIENT_MARCONI", + "CLIENT_AART", + "CLIENT_CULTURAL", + "CLIENT_YOUTUBE_ECOMMERCE", + "CLIENT_ARES", + "CLIENT_LIS", + "CLIENT_STORE", + "CLIENT_DASHER_AUDITING", + "CLIENT_SHOPPING_LIST", + "CLIENT_ITEM_SUGGEST", + "CLIENT_SMART_BOOKS", + "CLIENT_GRADS", + "CLIENT_ADS_ROOT", + "CLIENT_SE_ROOT", + "CLIENT_YT_ORBIT", + "CLIENT_NOVA_APERTURE", + "CLIENT_LENA_SIGNUP_DEFAULTS", + "CLIENT_PLAY_APPS_PUBLISHER", + "CLIENT_FINSKY_ENTERPRISE", + "CLIENT_GOOGLE_ADMIN", + "CLIENT_CRYPTAUTH", + "CLIENT_GSA_UNIVERSAL_SERVER", + "CLIENT_TRAVEL_FRONTEND_TRANSIT", + "CLIENT_HOME_CLOUD", + "CLIENT_GSX_MALL", + "CLIENT_GOOGLE_DUO", + "CLIENT_GAIA_FRONTEND", + "CLIENT_ANDROID_MESSAGES", + "CLIENT_GOOGLE_LENS", + "CLIENT_CHROME_WEB_STORE", + "CLIENT_ACTIONS_ON_GOOGLE_CONSOLE", + "CLIENT_ANDROID_TV_CHANNELS", + "CLIENT_ASSISTANT_WEB_SETTINGS", + "CLIENT_PLAY_USER_DATA", + "CLIENT_ADS_INTEGRITY", + "CLIENT_ADS_INTEGRITY_MALVERTISING", + "CLIENT_FIREBASE_CONSOLE", + "CLIENT_AOG_FEED_VALIDATOR", + "CLIENT_PLUMERIA", + "CLIENT_PAISA", + "CLIENT_GOOGLE_PAY", + "CLIENT_GOOGLE_PAY_WEB", + "CLIENT_GOOGLE_WALLET", + "CLIENT_SCROOGLED", + "CLIENT_WAYMO", + "CLIENT_CROW", + "CLIENT_GSUITE_SECURITY_CENTER_SIT", + "CLIENT_EVENT_THREAT_DETECTION", + "CLIENT_PLAY_LOCATION", + "CLIENT_FOOTPLACER", + "CLIENT_DASHER_COMMERCE", + "CLIENT_SOCIAL_PEOPLE_ANALYTICS", + "CLIENT_CONTACTS_UI", + "CLIENT_GAFE4", + "CLIENT_PLACES_API", + "CLIENT_PLACES_SEARCH_API", + "CLIENT_DRIVE_WEB", + "CLIENT_ANDROID_OTA", + "CLIENT_PAISA_NEARBY_STORES", + "CLIENT_ISP_FIBER_FAS", + "CLIENT_SUPPORT_CONTENT", + "CLIENT_GWS_OFFROAD_LOGGING", + "CLIENT_CHANGEHISTORY", + "CLIENT_SESSION_RISK", + "CLIENT_ALPS", + "CLIENT_DISCOVER_NEWS_LOCATION", + "CLIENT_ASSISTANT_SNAPSHOT", + "CLIENT_HONEYCOMB", + "CLIENT_PLAY_MONETARY_ABUSE", + "CLIENT_SMALL_BUSINESS_ADVISORS", + "CLIENT_GPA_FEEDS", + "CLIENT_EDU_ORIGINALITY", + "CLIENT_PAIDTASKS", + "CLIENT_TRANSLATE", + "CLIENT_FUNDING_CHOICES", + "CLIENT_SEARCH_NOTIFICATIONS", + "CLIENT_VISUAL_SEMANTIC_SERVICE", + "CLIENT_CHROME_PREFETCH_PROXY", + "CLIENT_WEAR_FRONTEND", + "CLIENT_PAYMENTS_RISKENGINE", + "CLIENT_PAYMENTS_ORCHESTRATION", + "CLIENT_ANDROID_TV_IRDB", + "CLIENT_TRENDS_FRONTEND", + "CLIENT_COLABORATORY", + "CLIENT_SOCRATIC", + "CLIENT_PS1_LOCATION", + "CLIENT_DDM_REPORTING", + "CLIENT_HOMEROOM_BACKEND", + "CLIENT_CARS_CATEGORICAL", + "CLIENT_GPAY_MERCHANT_VERTICALS", + "CLIENT_RECAPTCHA_ACCOUNT_DEFENDER", + "CLIENT_RECAPTCHA_LITE", + "CLIENT_RECAPTCHA_FRAUD", + "CLIENT_AUTONT_ACCESS_LOCATION", + "CLIENT_TFAA_REPORT", + "CLIENT_IDAAS_IP_LOCATION", + "CLIENT_ONESTACK_METRIC_COLLECTION", + "CLIENT_GPAY_TRANSIT", + "CLIENT_CHRONICLE_SECURITY", + "CLIENT_CHRONICLE_SECURITY_UI", + "CLIENT_GPAY_MERCHANT_SPOT_ONBOARDING_TOOL", + "CLIENT_ADS_SCRAPING", + "CLIENT_CLOUD_SUPPORT_PORTAL", + "CLIENT_LAMDA", + "CLIENT_ACCESS_REDIRECTION_SERVICE", + "CLIENT_PINPOINT", + "CLIENT_SHOPPING_ORDER_HISTORY", + "CLIENT_NEST_CAMERA_CLOUD", + "CLIENT_PANOPTIC_EVAL", + "CLIENT_ABOUT_THIS_PAGE", + "CLIENT_PHOTOS_ANALYTICS_MARKETING", + "CLIENT_GMSCORE_GMSCOMPLIANCE", + "CLIENT_ANALYTICS_COLLECTION", + "CLIENT_PLAY_CONSOLE_ANDROID_VITALS", + "CLIENT_CRASHLYTICS_PLAY_CONSOLE_CRASHES", + "CLIENT_PAYMENTS_MERCHANT_STORIES", + "CLIENT_CLOUDTOP_CONNECTIVITY", + "CLIENT_CLOUD_WEB", + "CLIENT_RECORDING_CONSENT", + "CLIENT_DV3_FRONTEND", + "CLIENT_LENDING_DATA_MANAGER", + "CLIENT_CHROMEOS_DATA_FRESNEL", + "CLIENT_PPN", + "CLIENT_GEO_SEARCH_API", + "CLIENT_GOOGLE_ONE_SECURITY", + "CLIENT_GOOGLE_TV_LAVA", + "CLIENT_DYNAMITE_SERVER", + "CLIENT_BCE_CLIENT_CONNECTOR", + "CLIENT_DSE_REGULATORY_ANALYSIS", + "CLIENT_SEARCH_PINPOINT", + "CLIENT_CORPLOGIN", + "CLIENT_MONOSPACE", + "CLIENT_LIGHTER", + "CLIENT_P11", + "CLIENT_FIND_MY_DEVICE_WEB", + "CLIENT_YOUTUBE_TV", + "CLIENT_FITBIT_WEB", + "CLIENT_CHORD", + "CLIENT_FITBIT_FI", + "CLIENT_GOOGLE_ANALYTICS_SERVING", + "CLIENT_FONTS", + "CLIENT_ASSISTANT_BARD", + "CLIENT_NEST_GREENENERGY", + "CLIENT_DEEPMIND_LABS", + "CLIENT_ONE_PRESENCE", + "CLIENT_TRANSPARENCY_REPORT", + "CLIENT_GOOGLE_ONE_ML", + "CLIENT_GMP_PARTNER_GALLERY", + "CLIENT_MAKERSUITE", + "CLIENT_ADS_ADMANAGER_TOS", + "CLIENT_CHROME_REMOTE_DESKTOP", + "CLIENT_SOJI", + "CLIENT_WORKSPACE_LABS_SIGNUP", + "CLIENT_AIDA", + "CLIENT_TSP", + "CLIENT_AI_SANDBOX", + "CLIENT_LABS_TAILWIND", + "CLIENT_GMAIL_TASK_ASSIST", + "CLIENT_PIXEL_WEATHER", + "CLIENT_GPAY_CATEGORY_BILLERS", + "CLIENT_SUPPORT_CHANNELS_ZENDESK_WHATSAPP", + "CLIENT_PAYMENTS_TRANSACTION_MONITORING", + "CLIENT_DISCOVER_QUERY_RECOMMENDATIONS", + "CLIENT_COMMUNICATION_PREFERENCE_CENTER", + "CLIENT_PLAY_CONSOLE_DEVELOPER_IDENTITY_AND_ACCOUNTS", + "CLIENT_GNP_ONLINE_EVALUATION", + "CLIENT_LOCAL_SUGGESTED_SETS_DEMO_SERVER", + "CLIENT_SEARCH_LABS", + "CLIENT_CROWDSOURCE", + "CLIENT_TARSIER", + "CLIENT_WORKSPACE_SIDEKICK", + "CLIENT_GOOGLE_PHOTOS_REMINISCING", + "CLIENT_GEOX_CONTAMINATION", + "CLIENT_CLOUD_MESSAGE_STORE", + "CLIENT_IP_PROTECTION", + "CLIENT_SEARCH_HAMSA", + "CLIENT_ACCOUNT_LOCATION", + "CLIENT_ANDROID_BACKUP_AND_RESTORE", + "CLIENT_ADS_AWSM", + "CLIENT_STARGATE", + "CLIENT_ACCOUNT_MANAGEMENT", + "CLIENT_USER_ACCOUNT_CREATION", + "CLIENT_NETSENSE", + "CLIENT_FITBIT_LABS", + "CLIENT_LOCAL_SERVICES", + "CLIENT_USER_FEEDBACK_SERVICE", + "CLIENT_BARD_EVAL", + "CLIENT_SCENARIO_BASED_SEEDING_HOME_WORK", + "CLIENT_ACCOUNT_INTEGRITY_FEATURE_API", + "CLIENT_LABS_BETTANY", + "CLIENT_NECO_GENESIS", + "CLIENT_FITBIT_CAPABILITIES", + "CLIENT_ADS_MARKETING_AUTOMATION", + "CLIENT_ANDROID_TELEMETRY_WESTWORLD", + "CLIENT_DSPM_DETECTIVE_CONTROLS", + "CLIENT_CAA_INSIGHTS", + "CLIENT_SHOPPING_CARRIER_INFO", + "CLIENT_GWS_TLD_MOBILE_ZWIEBACK", + "CLIENT_GWS_TLD_DESKTOP_ZWIEBACK", + "CLIENT_GWS_TLD_MOBILE_GAIA", + "CLIENT_GWS_TLD_DESKTOP_GAIA", + "CLIENT_GWS_TLD_NON_PERSONALIZED", + "CLIENT_GWS_HOMEPAGE", + "CLIENT_ADS_DESKTOP_ZWIEBACK", + "CLIENT_ADS_DESKTOP_GAIA", + "CLIENT_ADS_MOBILE_ZWIEBACK", + "CLIENT_ADS_MOBILE_GAIA", + "CLIENT_ADS_NON_PERSONALIZED", + "CLIENT_ADS_TLD_NON_PERSONALIZED", + "CLIENT_ADS_EOM", + "CLIENT_ADS_TLD_EOM", + "CLIENT_ADS_ADMANAGER_SIGNUP", + "CLIENT_GWS_NONTLD_DESKTOP_ZWIEBACK", + "CLIENT_GWS_NONTLD_DESKTOP_GAIA", + "CLIENT_GWS_NONTLD_MOBILE_ZWIEBACK", + "CLIENT_GWS_NONTLD_MOBILE_GAIA", + "CLIENT_ASSISTANT_NONTLD_MOBILE_ZWIEBACK", + "CLIENT_ASSISTANT_NONTLD_DESKTOP_ZWIEBACK", + "CLIENT_ASSISTANT_NONTLD_MOBILE_GAIA", + "CLIENT_ASSISTANT_NONTLD_DESKTOP_GAIA", + "CLIENT_GWS_TLD_DESKTOP_ZWIEBACK_EXP", + "CLIENT_GWS_TLD_DESKTOP_GAIA_EXP", + "CLIENT_GWS_TLD_MOBILE_ZWIEBACK_EXP", + "CLIENT_GWS_TLD_MOBILE_GAIA_EXP", + "CLIENT_ADS_DESKTOP_ZWIEBACK_EXP", + "CLIENT_ADS_DESKTOP_GAIA_EXP", + "CLIENT_ADS_MOBILE_ZWIEBACK_EXP", + "CLIENT_ADS_MOBILE_GAIA_EXP", + "CLIENT_GWS_NONTLD_DESKTOP_ZWIEBACK_EXP", + "CLIENT_GWS_NONTLD_DESKTOP_GAIA_EXP", + "CLIENT_GWS_NONTLD_MOBILE_ZWIEBACK_EXP", + "CLIENT_GWS_NONTLD_MOBILE_GAIA_EXP", + "CLIENT_ASSISTANT_NONTLD_MOBILE_ZWIEBACK_EXP", + "CLIENT_ASSISTANT_NONTLD_DESKTOP_ZWIEBACK_EXP", + "CLIENT_ASSISTANT_NONTLD_MOBILE_GAIA_EXP", + "CLIENT_ASSISTANT_NONTLD_DESKTOP_GAIA_EXP", + "CLIENT_GWS_TLD_MOBILE_ZWIEBACK_ANDROMEDA", + "CLIENT_GWS_TLD_DESKTOP_ZWIEBACK_ANDROMEDA", + "CLIENT_GWS_TLD_MOBILE_GAIA_ANDROMEDA", + "CLIENT_GWS_TLD_DESKTOP_GAIA_ANDROMEDA", + "CLIENT_ADS_DESKTOP_ZWIEBACK_ANDROMEDA", + "CLIENT_ADS_MOBILE_ZWIEBACK_ANDROMEDA", + "CLIENT_ADS_DESKTOP_GAIA_ANDROMEDA", + "CLIENT_ADS_MOBILE_GAIA_ANDROMEDA", + "CLIENT_GWS_NONTLD_DESKTOP_ZWIEBACK_ANDROMEDA", + "CLIENT_GWS_NONTLD_DESKTOP_GAIA_ANDROMEDA", + "CLIENT_GWS_NONTLD_MOBILE_ZWIEBACK_ANDROMEDA", + "CLIENT_GWS_NONTLD_MOBILE_GAIA_ANDROMEDA", + "CLIENT_ASSISTANT_NONTLD_MOBILE_ZWIEBACK_ANDROMEDA", + "CLIENT_ASSISTANT_NONTLD_DESKTOP_ZWIEBACK_ANDROMEDA", + "CLIENT_ASSISTANT_NONTLD_MOBILE_GAIA_ANDROMEDA", + "CLIENT_ASSISTANT_NONTLD_DESKTOP_GAIA_ANDROMEDA", + "CLIENT_GWS_TLD_MOBILE_ZWIEBACK_BOOTES", + "CLIENT_GWS_TLD_DESKTOP_ZWIEBACK_BOOTES", + "CLIENT_GWS_TLD_MOBILE_GAIA_BOOTES", + "CLIENT_GWS_TLD_DESKTOP_GAIA_BOOTES", + "CLIENT_ADS_DESKTOP_ZWIEBACK_BOOTES", + "CLIENT_ADS_MOBILE_ZWIEBACK_BOOTES", + "CLIENT_ADS_DESKTOP_GAIA_BOOTES", + "CLIENT_ADS_MOBILE_GAIA_BOOTES", + "CLIENT_GWS_NONTLD_DESKTOP_ZWIEBACK_BOOTES", + "CLIENT_GWS_NONTLD_DESKTOP_GAIA_BOOTES", + "CLIENT_GWS_NONTLD_MOBILE_ZWIEBACK_BOOTES", + "CLIENT_GWS_NONTLD_MOBILE_GAIA_BOOTES", + "CLIENT_ASSISTANT_NONTLD_MOBILE_ZWIEBACK_BOOTES", + "CLIENT_ASSISTANT_NONTLD_DESKTOP_ZWIEBACK_BOOTES", + "CLIENT_ASSISTANT_NONTLD_MOBILE_GAIA_BOOTES", + "CLIENT_ASSISTANT_NONTLD_DESKTOP_GAIA_BOOTES", + "CLIENT_GWS_TLD_MOBILE_ZWIEBACK_CASSIOPEIA", + "CLIENT_GWS_TLD_DESKTOP_ZWIEBACK_CASSIOPEIA", + "CLIENT_GWS_TLD_MOBILE_GAIA_CASSIOPEIA", + "CLIENT_GWS_TLD_DESKTOP_GAIA_CASSIOPEIA", + "CLIENT_ADS_DESKTOP_ZWIEBACK_CASSIOPEIA", + "CLIENT_ADS_MOBILE_ZWIEBACK_CASSIOPEIA", + "CLIENT_ADS_DESKTOP_GAIA_CASSIOPEIA", + "CLIENT_ADS_MOBILE_GAIA_CASSIOPEIA", + "CLIENT_GWS_NONTLD_DESKTOP_ZWIEBACK_CASSIOPEIA", + "CLIENT_GWS_NONTLD_DESKTOP_GAIA_CASSIOPEIA", + "CLIENT_GWS_NONTLD_MOBILE_ZWIEBACK_CASSIOPEIA", + "CLIENT_GWS_NONTLD_MOBILE_GAIA_CASSIOPEIA", + "CLIENT_ASSISTANT_NONTLD_MOBILE_ZWIEBACK_CASSIOPEIA", + "CLIENT_ASSISTANT_NONTLD_DESKTOP_ZWIEBACK_CASSIOPEIA", + "CLIENT_ASSISTANT_NONTLD_MOBILE_GAIA_CASSIOPEIA", + "CLIENT_ASSISTANT_NONTLD_DESKTOP_GAIA_CASSIOPEIA", + "CLIENT_GWS_TLD_MOBILE_ZWIEBACK_DELPHINUS", + "CLIENT_GWS_TLD_DESKTOP_ZWIEBACK_DELPHINUS", + "CLIENT_GWS_TLD_MOBILE_GAIA_DELPHINUS", + "CLIENT_GWS_TLD_DESKTOP_GAIA_DELPHINUS", + "CLIENT_ADS_DESKTOP_ZWIEBACK_DELPHINUS", + "CLIENT_ADS_MOBILE_ZWIEBACK_DELPHINUS", + "CLIENT_ADS_DESKTOP_GAIA_DELPHINUS", + "CLIENT_ADS_MOBILE_GAIA_DELPHINUS", + "CLIENT_GWS_NONTLD_DESKTOP_ZWIEBACK_DELPHINUS", + "CLIENT_GWS_NONTLD_DESKTOP_GAIA_DELPHINUS", + "CLIENT_GWS_NONTLD_MOBILE_ZWIEBACK_DELPHINUS", + "CLIENT_GWS_NONTLD_MOBILE_GAIA_DELPHINUS", + "CLIENT_ASSISTANT_NONTLD_MOBILE_ZWIEBACK_DELPHINUS", + "CLIENT_ASSISTANT_NONTLD_DESKTOP_ZWIEBACK_DELPHINUS", + "CLIENT_ASSISTANT_NONTLD_MOBILE_GAIA_DELPHINUS", + "CLIENT_ASSISTANT_NONTLD_DESKTOP_GAIA_DELPHINUS", + "CLIENT_GWS_TLD_MOBILE_ZWIEBACK_ERIDANUS", + "CLIENT_GWS_TLD_DESKTOP_ZWIEBACK_ERIDANUS", + "CLIENT_GWS_TLD_MOBILE_GAIA_ERIDANUS", + "CLIENT_GWS_TLD_DESKTOP_GAIA_ERIDANUS", + "CLIENT_ADS_DESKTOP_ZWIEBACK_ERIDANUS", + "CLIENT_ADS_MOBILE_ZWIEBACK_ERIDANUS", + "CLIENT_ADS_DESKTOP_GAIA_ERIDANUS", + "CLIENT_ADS_MOBILE_GAIA_ERIDANUS", + "CLIENT_GWS_NONTLD_DESKTOP_ZWIEBACK_ERIDANUS", + "CLIENT_GWS_NONTLD_DESKTOP_GAIA_ERIDANUS", + "CLIENT_GWS_NONTLD_MOBILE_ZWIEBACK_ERIDANUS", + "CLIENT_GWS_NONTLD_MOBILE_GAIA_ERIDANUS", + "CLIENT_ASSISTANT_NONTLD_MOBILE_ZWIEBACK_ERIDANUS", + "CLIENT_ASSISTANT_NONTLD_DESKTOP_ZWIEBACK_ERIDANUS", + "CLIENT_ASSISTANT_NONTLD_MOBILE_GAIA_ERIDANUS", + "CLIENT_ASSISTANT_NONTLD_DESKTOP_GAIA_ERIDANUS", + "CLIENT_GWS_TLD_MOBILE_ZWIEBACK_FOMAX", + "CLIENT_GWS_TLD_DESKTOP_ZWIEBACK_FOMAX", + "CLIENT_GWS_TLD_MOBILE_GAIA_FOMAX", + "CLIENT_GWS_TLD_DESKTOP_GAIA_FOMAX", + "CLIENT_ADS_DESKTOP_ZWIEBACK_FOMAX", + "CLIENT_ADS_MOBILE_ZWIEBACK_FOMAX", + "CLIENT_ADS_DESKTOP_GAIA_FOMAX", + "CLIENT_ADS_MOBILE_GAIA_FOMAX", + "CLIENT_GWS_NONTLD_DESKTOP_ZWIEBACK_FOMAX", + "CLIENT_GWS_NONTLD_DESKTOP_GAIA_FOMAX", + "CLIENT_GWS_NONTLD_MOBILE_ZWIEBACK_FOMAX", + "CLIENT_GWS_NONTLD_MOBILE_GAIA_FOMAX", + "CLIENT_ASSISTANT_NONTLD_MOBILE_ZWIEBACK_FOMAX", + "CLIENT_ASSISTANT_NONTLD_DESKTOP_ZWIEBACK_FOMAX", + "CLIENT_ASSISTANT_NONTLD_MOBILE_GAIA_FOMAX", + "CLIENT_ASSISTANT_NONTLD_DESKTOP_GAIA_FOMAX", + "CLIENT_GWS_TLD_MOBILE_ZWIEBACK_GEMINI", + "CLIENT_GWS_TLD_DESKTOP_ZWIEBACK_GEMINI", + "CLIENT_GWS_TLD_MOBILE_GAIA_GEMINI", + "CLIENT_GWS_TLD_DESKTOP_GAIA_GEMINI", + "CLIENT_ADS_DESKTOP_ZWIEBACK_GEMINI", + "CLIENT_ADS_MOBILE_ZWIEBACK_GEMINI", + "CLIENT_ADS_DESKTOP_GAIA_GEMINI", + "CLIENT_ADS_MOBILE_GAIA_GEMINI", + "CLIENT_GWS_NONTLD_DESKTOP_ZWIEBACK_GEMINI", + "CLIENT_GWS_NONTLD_DESKTOP_GAIA_GEMINI", + "CLIENT_GWS_NONTLD_MOBILE_ZWIEBACK_GEMINI", + "CLIENT_GWS_NONTLD_MOBILE_GAIA_GEMINI", + "CLIENT_ASSISTANT_NONTLD_DESKTOP_ZWIEBACK_GEMINI", + "CLIENT_ASSISTANT_NONTLD_DESKTOP_GAIA_GEMINI", + "CLIENT_ASSISTANT_NONTLD_MOBILE_ZWIEBACK_GEMINI", + "CLIENT_ASSISTANT_NONTLD_MOBILE_GAIA_GEMINI", + "CLIENT_GWS_TLD_MOBILE_ZWIEBACK_HERCULES", + "CLIENT_GWS_TLD_DESKTOP_ZWIEBACK_HERCULES", + "CLIENT_GWS_TLD_MOBILE_GAIA_HERCULES", + "CLIENT_GWS_TLD_DESKTOP_GAIA_HERCULES", + "CLIENT_ADS_DESKTOP_ZWIEBACK_HERCULES", + "CLIENT_ADS_MOBILE_ZWIEBACK_HERCULES", + "CLIENT_ADS_DESKTOP_GAIA_HERCULES", + "CLIENT_ADS_MOBILE_GAIA_HERCULES", + "CLIENT_GWS_NONTLD_DESKTOP_ZWIEBACK_HERCULES", + "CLIENT_GWS_NONTLD_DESKTOP_GAIA_HERCULES", + "CLIENT_GWS_NONTLD_MOBILE_ZWIEBACK_HERCULES", + "CLIENT_GWS_NONTLD_MOBILE_GAIA_HERCULES", + "CLIENT_ASSISTANT_NONTLD_DESKTOP_ZWIEBACK_HERCULES", + "CLIENT_ASSISTANT_NONTLD_DESKTOP_GAIA_HERCULES", + "CLIENT_ASSISTANT_NONTLD_MOBILE_ZWIEBACK_HERCULES", + "CLIENT_ASSISTANT_NONTLD_MOBILE_GAIA_HERCULES", + "CLIENT_GWS_TLD_MOBILE_ZWIEBACK_INDUS", + "CLIENT_GWS_TLD_DESKTOP_ZWIEBACK_INDUS", + "CLIENT_GWS_TLD_MOBILE_GAIA_INDUS", + "CLIENT_GWS_TLD_DESKTOP_GAIA_INDUS", + "CLIENT_ADS_DESKTOP_ZWIEBACK_INDUS", + "CLIENT_ADS_MOBILE_ZWIEBACK_INDUS", + "CLIENT_ADS_DESKTOP_GAIA_INDUS", + "CLIENT_ADS_MOBILE_GAIA_INDUS", + "CLIENT_GWS_NONTLD_DESKTOP_ZWIEBACK_INDUS", + "CLIENT_GWS_NONTLD_DESKTOP_GAIA_INDUS", + "CLIENT_GWS_NONTLD_MOBILE_ZWIEBACK_INDUS", + "CLIENT_GWS_NONTLD_MOBILE_GAIA_INDUS", + "CLIENT_ASSISTANT_NONTLD_DESKTOP_ZWIEBACK_INDUS", + "CLIENT_ASSISTANT_NONTLD_DESKTOP_GAIA_INDUS", + "CLIENT_ASSISTANT_NONTLD_MOBILE_ZWIEBACK_INDUS", + "CLIENT_ASSISTANT_NONTLD_MOBILE_GAIA_INDUS", + "CLIENT_GWS_TLD_MOBILE_ZWIEBACK_LEO", + "CLIENT_GWS_TLD_DESKTOP_ZWIEBACK_LEO", + "CLIENT_GWS_TLD_MOBILE_GAIA_LEO", + "CLIENT_GWS_TLD_DESKTOP_GAIA_LEO", + "CLIENT_ADS_DESKTOP_ZWIEBACK_LEO", + "CLIENT_ADS_MOBILE_ZWIEBACK_LEO", + "CLIENT_ADS_DESKTOP_GAIA_LEO", + "CLIENT_ADS_MOBILE_GAIA_LEO", + "CLIENT_GWS_NONTLD_DESKTOP_ZWIEBACK_LEO", + "CLIENT_GWS_NONTLD_DESKTOP_GAIA_LEO", + "CLIENT_GWS_NONTLD_MOBILE_ZWIEBACK_LEO", + "CLIENT_GWS_NONTLD_MOBILE_GAIA_LEO", + "CLIENT_ASSISTANT_NONTLD_DESKTOP_ZWIEBACK_LEO", + "CLIENT_ASSISTANT_NONTLD_DESKTOP_GAIA_LEO", + "CLIENT_ASSISTANT_NONTLD_MOBILE_ZWIEBACK_LEO", + "CLIENT_ASSISTANT_NONTLD_MOBILE_GAIA_LEO", + "CLIENT_GWS_TLD_MOBILE_ZWIEBACK_MENSA", + "CLIENT_GWS_TLD_DESKTOP_ZWIEBACK_MENSA", + "CLIENT_GWS_TLD_MOBILE_GAIA_MENSA", + "CLIENT_GWS_TLD_DESKTOP_GAIA_MENSA", + "CLIENT_ADS_DESKTOP_ZWIEBACK_MENSA", + "CLIENT_ADS_MOBILE_ZWIEBACK_MENSA", + "CLIENT_ADS_DESKTOP_GAIA_MENSA", + "CLIENT_ADS_MOBILE_GAIA_MENSA", + "CLIENT_GWS_NONTLD_DESKTOP_ZWIEBACK_MENSA", + "CLIENT_GWS_NONTLD_DESKTOP_GAIA_MENSA", + "CLIENT_GWS_NONTLD_MOBILE_ZWIEBACK_MENSA", + "CLIENT_GWS_NONTLD_MOBILE_GAIA_MENSA", + "CLIENT_ASSISTANT_NONTLD_DESKTOP_ZWIEBACK_MENSA", + "CLIENT_ASSISTANT_NONTLD_DESKTOP_GAIA_MENSA", + "CLIENT_ASSISTANT_NONTLD_MOBILE_ZWIEBACK_MENSA", + "CLIENT_ASSISTANT_NONTLD_MOBILE_GAIA_MENSA", + "CLIENT_GWS_TLD_MOBILE_ZWIEBACK_NORMA", + "CLIENT_GWS_TLD_DESKTOP_ZWIEBACK_NORMA", + "CLIENT_GWS_TLD_MOBILE_GAIA_NORMA", + "CLIENT_GWS_TLD_DESKTOP_GAIA_NORMA", + "CLIENT_ADS_DESKTOP_ZWIEBACK_NORMA", + "CLIENT_ADS_MOBILE_ZWIEBACK_NORMA", + "CLIENT_ADS_DESKTOP_GAIA_NORMA", + "CLIENT_ADS_MOBILE_GAIA_NORMA", + "CLIENT_GWS_NONTLD_DESKTOP_ZWIEBACK_NORMA", + "CLIENT_GWS_NONTLD_DESKTOP_GAIA_NORMA", + "CLIENT_GWS_NONTLD_MOBILE_ZWIEBACK_NORMA", + "CLIENT_GWS_NONTLD_MOBILE_GAIA_NORMA", + "CLIENT_ASSISTANT_NONTLD_MOBILE_ZWIEBACK_NORMA", + "CLIENT_ASSISTANT_NONTLD_DESKTOP_ZWIEBACK_NORMA", + "CLIENT_ASSISTANT_NONTLD_MOBILE_GAIA_NORMA", + "CLIENT_ASSISTANT_NONTLD_DESKTOP_GAIA_NORMA", + "CLIENT_GWS_TLD_MOBILE_ZWIEBACK_ORION", + "CLIENT_GWS_TLD_DESKTOP_ZWIEBACK_ORION", + "CLIENT_GWS_TLD_MOBILE_GAIA_ORION", + "CLIENT_GWS_TLD_DESKTOP_GAIA_ORION", + "CLIENT_ADS_DESKTOP_ZWIEBACK_ORION", + "CLIENT_ADS_MOBILE_ZWIEBACK_ORION", + "CLIENT_ADS_DESKTOP_GAIA_ORION", + "CLIENT_ADS_MOBILE_GAIA_ORION", + "CLIENT_GWS_NONTLD_DESKTOP_ZWIEBACK_ORION", + "CLIENT_GWS_NONTLD_DESKTOP_GAIA_ORION", + "CLIENT_GWS_NONTLD_MOBILE_ZWIEBACK_ORION", + "CLIENT_GWS_NONTLD_MOBILE_GAIA_ORION", + "CLIENT_ASSISTANT_NONTLD_DESKTOP_ZWIEBACK_ORION", + "CLIENT_ASSISTANT_NONTLD_DESKTOP_GAIA_ORION", + "CLIENT_ASSISTANT_NONTLD_MOBILE_ZWIEBACK_ORION", + "CLIENT_ASSISTANT_NONTLD_MOBILE_GAIA_ORION", + "CLIENT_GWS_TLD_MOBILE_ZWIEBACK_PISCES", + "CLIENT_GWS_TLD_DESKTOP_ZWIEBACK_PISCES", + "CLIENT_GWS_TLD_MOBILE_GAIA_PISCES", + "CLIENT_GWS_TLD_DESKTOP_GAIA_PISCES", + "CLIENT_ADS_DESKTOP_ZWIEBACK_PISCES", + "CLIENT_ADS_MOBILE_ZWIEBACK_PISCES", + "CLIENT_ADS_DESKTOP_GAIA_PISCES", + "CLIENT_ADS_MOBILE_GAIA_PISCES", + "CLIENT_GWS_NONTLD_DESKTOP_ZWIEBACK_PISCES", + "CLIENT_GWS_NONTLD_DESKTOP_GAIA_PISCES", + "CLIENT_GWS_NONTLD_MOBILE_ZWIEBACK_PISCES", + "CLIENT_GWS_NONTLD_MOBILE_GAIA_PISCES", + "CLIENT_ASSISTANT_NONTLD_DESKTOP_ZWIEBACK_PISCES", + "CLIENT_ASSISTANT_NONTLD_DESKTOP_GAIA_PISCES", + "CLIENT_ASSISTANT_NONTLD_MOBILE_ZWIEBACK_PISCES", + "CLIENT_ASSISTANT_NONTLD_MOBILE_GAIA_PISCES", + "CLIENT_GWS_TLD_MOBILE_ZWIEBACK_RETICULUM", + "CLIENT_GWS_TLD_DESKTOP_ZWIEBACK_RETICULUM", + "CLIENT_GWS_TLD_MOBILE_GAIA_RETICULUM", + "CLIENT_GWS_TLD_DESKTOP_GAIA_RETICULUM", + "CLIENT_ADS_DESKTOP_ZWIEBACK_RETICULUM", + "CLIENT_ADS_MOBILE_ZWIEBACK_RETICULUM", + "CLIENT_ADS_DESKTOP_GAIA_RETICULUM", + "CLIENT_ADS_MOBILE_GAIA_RETICULUM", + "CLIENT_GWS_NONTLD_DESKTOP_ZWIEBACK_RETICULUM", + "CLIENT_GWS_NONTLD_DESKTOP_GAIA_RETICULUM", + "CLIENT_GWS_NONTLD_MOBILE_ZWIEBACK_RETICULUM", + "CLIENT_GWS_NONTLD_MOBILE_GAIA_RETICULUM", + "CLIENT_ASSISTANT_NONTLD_DESKTOP_ZWIEBACK_RETICULUM", + "CLIENT_ASSISTANT_NONTLD_DESKTOP_GAIA_RETICULUM", + "CLIENT_ASSISTANT_NONTLD_MOBILE_ZWIEBACK_RETICULUM", + "CLIENT_ASSISTANT_NONTLD_MOBILE_GAIA_RETICULUM", + "CLIENT_GWS_TLD_MOBILE_ZWIEBACK_SAGITTARIUS", + "CLIENT_GWS_TLD_DESKTOP_ZWIEBACK_SAGITTARIUS", + "CLIENT_GWS_TLD_MOBILE_GAIA_SAGITTARIUS", + "CLIENT_GWS_TLD_DESKTOP_GAIA_SAGITTARIUS", + "CLIENT_ADS_DESKTOP_ZWIEBACK_SAGITTARIUS", + "CLIENT_ADS_MOBILE_ZWIEBACK_SAGITTARIUS", + "CLIENT_ADS_DESKTOP_GAIA_SAGITTARIUS", + "CLIENT_ADS_MOBILE_GAIA_SAGITTARIUS", + "CLIENT_GWS_NONTLD_DESKTOP_ZWIEBACK_SAGITTARIUS", + "CLIENT_GWS_NONTLD_DESKTOP_GAIA_SAGITTARIUS", + "CLIENT_GWS_NONTLD_MOBILE_ZWIEBACK_SAGITTARIUS", + "CLIENT_GWS_NONTLD_MOBILE_GAIA_SAGITTARIUS", + "CLIENT_ASSISTANT_NONTLD_DESKTOP_ZWIEBACK_SAGITTARIUS", + "CLIENT_ASSISTANT_NONTLD_DESKTOP_GAIA_SAGITTARIUS", + "CLIENT_ASSISTANT_NONTLD_MOBILE_ZWIEBACK_SAGITTARIUS", + "CLIENT_ASSISTANT_NONTLD_MOBILE_GAIA_SAGITTARIUS", + "CLIENT_GWS_TLD_MOBILE_ZWIEBACK_TAURUS", + "CLIENT_GWS_TLD_DESKTOP_ZWIEBACK_TAURUS", + "CLIENT_GWS_TLD_MOBILE_GAIA_TAURUS", + "CLIENT_GWS_TLD_DESKTOP_GAIA_TAURUS", + "CLIENT_ADS_DESKTOP_ZWIEBACK_TAURUS", + "CLIENT_ADS_MOBILE_ZWIEBACK_TAURUS", + "CLIENT_ADS_DESKTOP_GAIA_TAURUS", + "CLIENT_ADS_MOBILE_GAIA_TAURUS", + "CLIENT_GWS_NONTLD_DESKTOP_ZWIEBACK_TAURUS", + "CLIENT_GWS_NONTLD_DESKTOP_GAIA_TAURUS", + "CLIENT_GWS_NONTLD_MOBILE_ZWIEBACK_TAURUS", + "CLIENT_GWS_NONTLD_MOBILE_GAIA_TAURUS", + "CLIENT_ASSISTANT_NONTLD_DESKTOP_ZWIEBACK_TAURUS", + "CLIENT_ASSISTANT_NONTLD_DESKTOP_GAIA_TAURUS", + "CLIENT_ASSISTANT_NONTLD_MOBILE_ZWIEBACK_TAURUS", + "CLIENT_ASSISTANT_NONTLD_MOBILE_GAIA_TAURUS", + "CLIENT_GWS_TLD_MOBILE_ZWIEBACK_URSA_MAJOR", + "CLIENT_GWS_TLD_DESKTOP_ZWIEBACK_URSA_MAJOR", + "CLIENT_GWS_TLD_MOBILE_GAIA_URSA_MAJOR", + "CLIENT_GWS_TLD_DESKTOP_GAIA_URSA_MAJOR", + "CLIENT_ADS_DESKTOP_ZWIEBACK_URSA_MAJOR", + "CLIENT_ADS_MOBILE_ZWIEBACK_URSA_MAJOR", + "CLIENT_ADS_DESKTOP_GAIA_URSA_MAJOR", + "CLIENT_ADS_MOBILE_GAIA_URSA_MAJOR", + "CLIENT_GWS_NONTLD_DESKTOP_ZWIEBACK_URSA_MAJOR", + "CLIENT_GWS_NONTLD_DESKTOP_GAIA_URSA_MAJOR", + "CLIENT_GWS_NONTLD_MOBILE_ZWIEBACK_URSA_MAJOR", + "CLIENT_GWS_NONTLD_MOBILE_GAIA_URSA_MAJOR", + "CLIENT_ASSISTANT_NONTLD_DESKTOP_ZWIEBACK_URSA_MAJOR", + "CLIENT_ASSISTANT_NONTLD_DESKTOP_GAIA_URSA_MAJOR", + "CLIENT_ASSISTANT_NONTLD_MOBILE_ZWIEBACK_URSA_MAJOR", + "CLIENT_ASSISTANT_NONTLD_MOBILE_GAIA_URSA_MAJOR", + "CLIENT_GWS_TLD_MOBILE_ZWIEBACK_VIRGO", + "CLIENT_GWS_TLD_DESKTOP_ZWIEBACK_VIRGO", + "CLIENT_GWS_TLD_MOBILE_GAIA_VIRGO", + "CLIENT_GWS_TLD_DESKTOP_GAIA_VIRGO", + "CLIENT_ADS_DESKTOP_ZWIEBACK_VIRGO", + "CLIENT_ADS_MOBILE_ZWIEBACK_VIRGO", + "CLIENT_ADS_DESKTOP_GAIA_VIRGO", + "CLIENT_ADS_MOBILE_GAIA_VIRGO", + "CLIENT_GWS_NONTLD_DESKTOP_ZWIEBACK_VIRGO", + "CLIENT_GWS_NONTLD_DESKTOP_GAIA_VIRGO", + "CLIENT_GWS_NONTLD_MOBILE_ZWIEBACK_VIRGO", + "CLIENT_GWS_NONTLD_MOBILE_GAIA_VIRGO", + "CLIENT_ASSISTANT_NONTLD_DESKTOP_ZWIEBACK_VIRGO", + "CLIENT_ASSISTANT_NONTLD_DESKTOP_GAIA_VIRGO", + "CLIENT_ASSISTANT_NONTLD_MOBILE_ZWIEBACK_VIRGO", + "CLIENT_ASSISTANT_NONTLD_MOBILE_GAIA_VIRGO", + "CLIENT_LOGGED_CONTEXT", + "CLIENT_IPGEO_REGION", + "CLIENT_IPGEO_EVAL", + "CLIENT_GWS_TACTILE_INITIAL_VIEWPORT", + "CLIENT_GWS_MAPS_DESKTOP", + "CLIENT_GWS_MAPS_MOBILE", + "CLIENT_GWS_GMM_LOCATION_SHIFT", + "CLIENT_GWS_NONTLD_MAPS_DESKTOP_GAIA", + "CLIENT_GWS_NONTLD_MAPS_DESKTOP_ZWIEBACK", + "CLIENT_GWS_TLD_MAPS_DESKTOP_GAIA", + "CLIENT_GWS_TLD_MAPS_DESKTOP_ZWIEBACK", + "CLIENT_GWS_TLD_MAPS_MOBILE_GAIA", + "CLIENT_GWS_TLD_MAPS_MOBILE_ZWIEBACK", + "CLIENT_GWS_NONTLD_MAPS_DESKTOP_EXPERIMENTAL", + "CLIENT_GWS_NONTLD_MAPS_MOBILE_EXPERIMENTAL", + "CLIENT_SESSIONS", + "CLIENT_MANUAL", + "CLIENT_NONTLD_DEFAULT", + "CLIENT_NO_LOCATION", + "CLIENT_ONLY_LEGAL", + "CLIENT_TESTING", + "CLIENT_COARSEN_ALL_TESTING", + "CLIENT_GWS_TLD_DESKTOP_ORACLE", + "CLIENT_GWS_TLD_MOBILE_ORACLE", + "CLIENT_GWS_NONTLD_DESKTOP_ORACLE", + "CLIENT_GWS_NONTLD_MOBILE_ORACLE", + "CLIENT_COMPARE_DL", + "CLIENT_COMPARE_IP", + "CLIENT_COMPARE_IPDL", + "CLIENT_MAGICEYE_DIMENSIONS", + "CLIENT_MAPS_GUIDE_DIRECTIONS", + "CLIENT_SAFE_BROWSING", + "CLIENT_GWS_NONTLD_DESKTOP", + "CLIENT_GWS_NONTLD_MOBILE" + ], + "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, + 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, + 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, + 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, + 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, + 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, + 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, + 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, + 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, + 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, + 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, + 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, + 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, + 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, + 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, + true + ], + "enumDescriptions": [ + "Unset client ID. Never use it in production code.", + "Curio team (go/curio). Contact: curio-team@.", + "OneGoogle Service (OGS): OGS will fetch the LocationContext for the frontends that have not talked to LES yet.", + "Client id used by evaluation tools. Contact: davidreis@", + "Same as CLIENT_EVALS, but less strict, so can be used to avoid a hack when some use cases needed to send the request twice with different client ID. Contact: bohdant@", + "Client id used by go/unified-query-sourcing. Contact: query-sampling-team@", + "Client id used by Play Books. Contact: ocean-team@", + "Client id used by Bond team. Contact: sterman@ and/or id-devices-eng@", + "Client id used by Chrome User Metrics Analysis (UMA, go/chrome-data)", + "Client id used by DoubleClick Search. Contact: wdtseng@, ds3data@, go/ds", + "Client id used by youtube QoE frontend. Contact: pfish@, kathyqian@, qoe-team@", + "Client id used by youtube Real-Time QoE. Contact: jeffcohen@, tnavien@, qoe-team@", + "Client id used by youtube QoE Livyatan. Contact: kathyqian@, gaozhiquan@, qoe-team@", + "Client id used by YouTube serving frontend and shared by all downstreams of the frontend server. Contact: tubbs@, yt-serving-platform@", + "Client ids used by YouTube Shorts. See go/oolong-changes-for-yt-le for details.", + "", + "", + "", + "Client ids used by Youtube Viral.", + "", + "", + "", + "", + "Client ids used by Youtube Viral Experiments. See go/ul-experimental-slots for description.", + "", + "", + "", + "Client ids used by Youtube Viral Experiments. See go/ul-experimental-slots for description.", + "", + "", + "", + "Client ids used by Youtube Viral Experiments. See go/ul-experimental-slots for description.", + "", + "", + "", + "Client ids used by Youtube Viral Experiments. See go/ul-experimental-slots for description.", + "", + "", + "", + "Client id used by YouTube admin review tools. Contact: yurt-eng@", + "Client id used by YouTube Bad Harvest (go/badharvest). Contact: bad-harvest-eng@", + "Client id used by the speech team. Contact: xuedong@", + "Client id used by Gmail team. Contact: shine@, lianglin@", + "Client id used by Gmail/Spam. Contact: gmail-spam-eng@", + "Client id used by chromecast web interface. Contact: pierred@, bquinlan@, eureka-team@", + "Defaults to NONTLD_DEFAULT Contact: jamesjw@, pancetta-eng@", + "Client id used by GLS (Google Location Server) Contact: lmohanan@, tsuwei@, lbs-team@", + "Contact: feedback-eng@", + "Client id used by Android Metrics team. Contact: androidmetrics-eng@", + "Client id used by AdWords Usermgmt (go/usermgmt). Contact: timthom@, ads-usermgmt-eng@", + "Client id used by appremoting VM management stack which is further used by Looking Glass and Developer Shell products. Contact: looking-glass-team@, hekate-eng@.", + "Client id used by the login protections server. (go/hijacking) Contact: hijacking-eng@, danmogo@.", + "Client id used by Actionable IPs. (go/actionable-ips). Contact: amirha@, ncmec-actionableips-eng@.", + "Client id used by Display Ads. Contact: local-display@.", + "CLIENT_DISPLAY_ADS_DEFAULT is the same as CLIENT_DISPLAY_ADS, but excludes postal code trimming. This client is used to make the ProcessLocationContext call.", + "", + "", + "", + "", + "Client id used by Display Ads Preview Service. Contact: fletch-eng@.", + "Client id used by Hobbes(go/hobbes). Contact: hobbes-team@google.com", + "Client id used by Newsstand(go/dots). Contact: gnews-infra@.", + "", + "Client id used by Panoptic (News Ranking + Backend) Contact: polynews-eng@.", + "Client id used by Google Docs. Contact: doplar-eng@, jameshong@", + "Client id used by AdWords Express. Contact: boost-eng@, stephenleung@", + "Client id used by TraceDepot server. Contact: tibrewal@, kjs@", + "Client id used by MapsPro Contact: obrien@, jiazheng@", + "Client id used by Madden (go/madden) Contact: madden-eng@", + "Client id used by AccessFilter Contact: ishwarya@", + "Client id used by Google Domains (go/domain-registrar) Contact: domain-registrar-eng@", + "Client id used by Google Assistant (go/opa) Contact: assistant-infra-core@", + "", + "Client id user by Google Account Linking (go/account-linking) Contact: account-linking-team@", + "Client id used by Legal Removals. Contact: legal-removals-eng@", + "Client id used by Cloud Console (Pantheon) Contact: paninfra-sfo@.", + "Client id used by Cloud New User for Free Trial Contact: coe-nu-eng@", + "Client id used by Solutions Catalog Contact: coe-solutions@", + "Client id used by cloud media access team, go/cloud-media-access Contact: cloud-media-access-team@", + "Client id used by Dotorg G4NP Contact: g4np-eng@", + "Client id used by Crash Internal Contact: crash-team@", + "Client id used by Monlog in access/infrastructure Contact: monlog-eng@", + "Client id used by GoogleVoice Contact: voice-eng@", + "Client id used by Blogger Contact: blogger-tech@, eitzenb@", + "Thor/Google Meet backend. Contact: comms-work-backend-team@.", + "Client id used by News Contact: news-frontend-eng-team@.", + "Client id used by Google Photos", + "Client id used by Google Photos for inferred location tagging.", + "Client id used by RankBrain Debug (go/rankbrain-debug).", + "Client id used by Heterodyne (go/heterodyne) Contact: ph-eng@", + "Client id used by fraudreview (go/fraudreview) Contact: pf-review-tools@", + "Client id used by Jamboard (go/jamboard) for go/jamboard-scheduled-otas Contact: jamboard-eng@", + "Client id used by Marconi (go/marconi) Contact: marconi-eng@", + "Client id used by Aart (go/aart-docs) Contact: aart-team@", + "Client id used by the Google Arts And Culture (go/artsandculture) Contact: ci-eng@", + "Client id used by Youtube Ecommerce (go/ypc) Contact: ytr-eng@", + "Client id used by Ares managed feature providers (go/project-ares) Contact: ares-eng@", + "Client id used by LIS and the UUDE framework (go/uude) Contact: lis-eng@", + "Client id used by Google Store smashberry (go/smashberry) Contact: smashberry-eng@", + "Client id used by Dasher Auditing (go/dasher-auditing) Contact: dasher-auditing-eng@", + "Client id used by the Shopping List Server (go/shopping-list-server) Contact: shoppinglist-eng@", + "Client ID used by the Drive Item Suggest service (go/itemsuggest)", + "Client ID used by Smart Books (go/smart-books) Contact: smart-books-team@", + "Client ID used by GRADS (go/grads)", + "Client ID used by AdsRoot (go/adsroot)", + "Client ID used by Service Engine (go/seroot)", + "Client ID used by Orbit (go/ytorbit)", + "Client ID used by Project Fi (nova). This client was initially created for Nova aperture (go/aperture) but all Nova clients are recommended to use this one.", + "Client ID used by Lena Signup Defaults (go/lena-prd)", + "Client ID used by the Play Console (go/fc) Contact: play-dev-console-platform@", + "Client ID used by Finsky Enterprise (go/pfw)", + "Client ID used by Google Admin (go/google-admin)", + "Client ID used by CryptAuth (go/cryptauth, go/authzen-pdd, go/gnubby-pdd)", + "Client ID used by the GsaUniversalServer (go/gus)", + "Client ID used by the TravelFrontendTransitServer web app.", + "Client ID used by Home Cloud services (go/home-cloud)", + "Client ID used by Google Shopping Express (go/gsx)", + "Client ID used by Google Duo (go/duo)", + "Client ID used by Gaia Frontend (go/gaiafe)", + "Client ID used by Android Messages (go/bugle)", + "Client ID used by Google Lens (go/lens) Contact: lens-frontend-server-eng@", + "Client ID used by Chrome Web Store (go/cws)", + "Client ID used by Actions on Google console (go/aog-console) Contact: actions-on-google-console-eng@", + "Client ID used by Android TV Channels (go/android-tv-channels)", + "Client ID used by Assistant Web Settings (go/assistant-settings-web-ui-design)", + "Client ID used by Play User Data Server (go/play-user-data-server)", + "Client ID used by Ads Integrity (go/ads-integrity) Contact: ads-integrity-risk@", + "Client ID used by Ragnarok (go/ragnarok) Contact: ads-integrity-wat@", + "Client ID used by Firebase Console (go/fireconsole) Contact: fireconsole-contrib@", + "Client ID used by AoG Feed Validator (http://go/aog-feed-validator)", + "Client ID used by Plumeria (go/plumeria-legal-eng-intro) Contact: plumeria-eng@", + "Client ID used by Paisa (http://go/paisa) Contact: paisa-eng@", + "Client ID used by Google Pay (go/googlepay)", + "Client ID used by the Google Pay web serving stack.", + "Client ID used by Google Wallet (go/wallet)", + "Client ID used by Scroogled (go/scroogled). Contact: hijacking-team@.", + "Client ID used by Waymo ride-hailing services. Client referenced in a silo: waymo/taas/frontend3/handlers/test_base.cc Contact: taas-offboard@, chauffeur-hailing@", + "Client ID used by CROW team. Contact: crow-team@", + "Client ID used by the Security Investigation Tool of GSuite Security Center(go/security-investigation-tool). Contact: gsc-sit-eng@", + "Client ID used by the Event Threat Detection team (go/etd). Contact: etd-team@", + "Client ID used by Play Location Server (go/play-location-server). Contact: play-experiment-team@", + "Client ID used by Footplacer (go/footplacer). Contact: footplacer-eng@", + "used by dasher commerce team (go/acom) Contact: dasher-commerce-eng@", + "Client ID used by Social People Analytics (go/spa-docs). Contact: social-people-analytics@", + "Client ID used by Contacts UI surfaces (go/web-contacts). Contact: contactsplus-eng@, custard-eng@", + "Client ID used by Google Analytics (go/gafe4). Contact: gafe4-eng+code@", + "Client ID used by Places API (go/places-api). Contact: geo-enterprise-metrics@", + "", + "Client ID used by Drive Web Frontend. Contact: drive-frontend-eng@", + "Client ID used by Android OTA (go/android-ota). Contact: android-auto-ota-dev@", + "Clients of nearby stores. Contact: payments-microapps-pek-team@", + "Clients used by Fiber Address Service (gfiber-weaver-infra-team@).", + "Client ID used by Support Content (go/supportcontent) Contact: support-content-eng@", + "Logging anonymization for Offroad (GMM offline) search/suggest.", + "Client id used by Google Ads Change History (go/ch). Contact: leonxie@, kluo@, ch-dev@", + "Client ID used by Session Risk (go/session-risk). Contact: session-protection-eng@", + "Client ID used by Alps (go/alps). Contact: address-understanding-team@", + "Client ID used by discover for resolving locations according to the user's news preferences. Contact: newsx@", + "Client Id for Assistant Snapshot.", + "Client ID used by Area 120 Honeycomb (go/honeycomb) Contact: honeycomb-eng@", + "Client ID used by Play Monetary Abuse service to detect location abuse. Contact: play-monetary-abuse@", + "Client ID used by Small Business Advisors (GMB Assisted Activation). Contact: gmb-assisted-activation@", + "Client ID used by GPA Feeds Ingestion. Contact: gpa-feeds-eng@", + "Client ID used by EDU originality reports (go/plagiarism). Contact: plagiarism-eng@", + "Client ID used by Paidtasks to grab user ipgeo information. Contact: 402-eng@", + "Client ID used by Translate for country level IPGeo. Contact: website-translation-team@", + "Client ID used by Funding Choices to determine the legal jurisdiction that a user belongs to, for example, GDPR (EEA) or CCPA (California), etc. More information: go/funding-choices Contact: oncall/xads, funding-choices-eng-core@", + "Client ID used by Search Notifications (go/sno). Contact: now-push-eng-team@", + "Client ID used by Visual Semantic Service (go/vss). Contact: vss-team@", + "Client ID used by the Chrome Prefetch Proxy (go/chrome-p4)", + "Wear OS clients Contact: wear-lon-backend@", + "Client ID used by Payments Risk (go/risk-eng) Contact: payments-risk-team@", + "Client ID used by Payments Orchestration/Orchestration2 server (go/o2) Contact: payments-orchestration-eng@", + "Client ID used by Android TV IRDB (go/sabrina-irdb-service) Contact: project-axel-eng@", + "Client ID used by Trends (go/trends-eng) Contact: trends@", + "Client ID used by Colab (go/colab) Contact: colab-team@", + "Client ID for Socratic (go/bloom) Contact: bloom-edu-eng@", + "Client ID for go/ps1-location Contact: location-infra@", + "Client ID for DDM Reporting Processing go/proc Contact: ddm-reporting-stateless@", + "Client ID for go/hr-be Contact: homeroom-backend@", + "Client ID for cars categorical Contact: cars-eng@", + "Client ID used by Gpay MerchantVerticals VerticalsDiscoveryService go/vertical-discovery Contact: merchant-verticals-discovery-eng@", + "Client ID used by reCAPTCHA's Account Protections team. Shared ID used by both Account Defender and SMS Fraud Detection services. go/recaptcha-account-defender-u-bad Contact: recaptcha-account-protections@", + "Client ID used by reCAPTCHA Lite. go/recaptcha-asn-reputation-design-doc Contact: recaptcha-waf-eng@", + "Client ID used by reCAPTCHA Fraud Prevention. go/recaptcha-fraud-geocoding Contact: recatpcha-fraud@", + "Client ID used by AutoNT DNS mapchecker module. go/autont Contact: autont-team@", + "Client ID used by Transparency for All Ads Report. go/tfaar Contact: tfaa-report-eng@", + "Client ID used by GCIP Location Service. go/cicp-team Contact: cicp-eng@", + "Client ID used by OneStack Metric Collection service.", + "Client ID used by GPay Transit TapAndPay Frontend Service go/transit-recommended-agencies Contact: tp2-transit-eng@", + "Client ID used by Chronicle Security (go/malachite). go/chronicle:theres-waldo Contact: malachite-dip-engg@ Contact: malachite-eng@", + "Client ID used by the UI for Chronicle Security (go/malachite). go/chronicle-i18n-design Contact: chronicle-ui@ Contact: malachite-eng@", + "Client ID used by GPay Merchant Spot Onboarding Tool (b/186640782). Contact: gtech-google-pay-food-fte@ Contact: edisonc@", + "Client ID used by Ads scraping tool owned by Ads ExpandedMatch. go/ads-scraping-tool Contact: ads-expmatch-eng@", + "Client ID for cloud support portal frontend go/xpp-lite Contact: xpp-eng@", + "Client ID used by the LaMDA team. Contact: srrvnn@, lamda-team@ // NOTYPO NOTYPO", + "Client ID used by Access Redirection Service. (go/redirection-service) contact: access-sre-fe@google.com", + "Client ID used by Pinpoint (go/jsuite-pinpoint) Contact: backlight-eng@", + "Client ID used by Google Shopping Order History (go/shopping-order-history)", + "Client ID used by Nest camera cloud team contact: nest-camera-cloud@google.com", + "Client ID used by Panoptic SxS contact: yukang@, deepakverma@, local-fcr@google.com", + "Client ID used for About This Page external API. contact: beaton, diner-team@, go/project-diner", + "Client ID used for the Photos Analytics marketing pipeline. contact: guillo, photos-analytics@", + "Client ID for the gmscompliance server (UDEVS) contact: gmscore-trust-team@google.com", + "Client ID for Analytics Collection contact: tag-serving-eng@, go/tag-serving", + "Client ID for play console android vitals contact: play-dev-quality-all@google.com", + "Client ID for crashlytics play console crashes contact: play-dev-quality-all@google.com", + "Client ID for Payments Merchant Stories contact: merry-eng@, go/merry", + "Client ID for Cloudtop Connectivity contact: cloudtop-eng@, go/cloudtop", + "Client ID for Cloud Web (cloud.google.com) contact: cloudx-platform-eng@", + "Client for go/speakeasy-meet-consent-frontend Contact: ccp-pegasus@", + "Client for Display & Video 360 (DV3, Xbid) frontend. Contact: qypeng@, xbid-fe-eng@", + "Client for lending data manager. Contact: nest-data-infra-eng@", + "Client for ChromeOS Data Fresnel service. Contact: chromeos-data-eng@", + "Client for PPN team to provide VPN service.", + "Client ID used by Geo API Platform (go/geo:api). Contact: geo-apis-platform@", + "Client for Google One security to access Oolong data. Contact: g1-security-eng@", + "Client ID used by the Google TV Web player (go/lava) Contact: lava-eng@", + "Client ID used by the dynamite server. Contact: dynamite-eng@", + "Client ID used by the bce-client-connector. Contact: bce-client-connector-eng@", + "Client ID used by go/rde team pipeline. Contact: rde-team@.", + "Client ID used by Pinpoint UI tools (go/pinpoint). Contact: pinpoint-team@", + "Client ID for Corplogin Contact: sso-team@", + "Client ID for Monospace (go/monospace) Contact: monospace-team@", + "Client ID used by the Lighter (go/lighter). Contact: lighter-backend-eng@", + "Client ID used by P11 (go/p11-eng) Contact: eleven-sw-eng@", + "Client ID used by the new Find My Device website. Contact: fmd-eng@", + "Client ID used by Youtube TV. Contact: ott-platform-serving", + "Client ID used by Fitbit WebAccounts Contact fitbit-uam@", + "Client ID used for Chord (go/chord-g3doc) Contact: chord-eng@", + "Client ID used by Fitbit-Fi Contact fdp-gallery@", + "Client ID used by Google-Analytics-Serving Contact ga-gold-query-engine@", + "Client ID used by Google Fonts Contact fonts-eng@", + "Client ID used by project Bard Contact bard-team@", + "Client ID used by Nest Renew (go/apollo-eng) Contact apollo-energy-eng@", + "Client ID used by DeepMind Labs Contact deepmind-goodall@", + "Client ID used by One Presence Profiles Contact mcf-profiles-eng-team@", + "Client ID used by Transparency Report (go/transparency-eng) Contact: transparency-report-leads@", + "Client for Google One ML team to access Oolong data. Contact: g1-ml-eng@", + "Client for GMP Partner Gallery team to access Oolong data. Contact: gmppartnergallery-team@", + "Client for MakerSuite. Contact: makersuite-team@", + "Client for Ad Manager ToS Contact: drx-fe-infra@", + "Client ID for Chrome Remote Desktop. contact: chromotin-eng-team@, go/chromoting", + "Client for OSLO Soji (go/soji). Contact: soji-team@", + "Client ID for Workspace labs signup page. Contact: workspace-labs-signup-eng@", + "Client AIDA Contact: aida-api-team@", + "Client ID for Trust Signals Platform Contact: trust-signals-eng@", + "Client Id for AI Test Kitchen Contact: ai-sandbox-eng@", + "Client Id for Labs Tailwind Contact: labs-tailwind-eng-team@", + "Client Id for Gmail Task Assist. Contact: task-assist-eng@", + "Client Id for Pixel Weather service. Contact: pixel-apps-weather-boq-team@", + "Client Id for GPay Geo-based category billers. (go/gpay-category-biller-suggestions-design-doc) Contact: nityam-eng@, gpay-server-infra@", + "Client Id for Support Channels WhatsApp Zendesk integration. (go/cecsi-whatsapp-dd) Contact: voice-channels-eng@", + "Client ID used by Payments Anti-Financial Crimes Transaction Monitoring pipeline to fetch country-level IPGeo information.", + "Client ID for the offline batch pipeline creating the Discover query recommendation corpus.", + "Client id used by Preference Center (go/preference-center). Contact: preference-center-eng@", + "Client ID used by Developer Identity and Accounts Contact: play-dev-dia-epu@google.com.", + "Client ID used by GNP Online Evaluation Contact: gnp-ginger-eng@google.com", + "Client ID used by local suggested sets demo server (go/local-sets-demo-server-dd) Contact: local-sets-quality@", + "Client ID used by Search Labs Contact: search-labs-frontend@google.com", + "Client ID for Crowdsource Contact: crowdsource-eng@google.com", + "Client ID for Tarsier Contact: tarsier-team@google.com", + "Client Id for WorkSpace SideKick. Contact: kopi-eng@", + "Client id used by Google Photos for reminising features.", + "Client Id for Geox contamination. Contact: amt-geox-core@", + "Client Id for CloudMessageStore. Contact:tachyon-backend-eng@", + "Client Id for IP Protection Contact: ip-protection-team@", + "Client Id for Search MCF Hamsa. Contact: search-mcf-hamsa@", + "Client Id for Account Location (go/accountlocation). Contact emmett-eng@google.com, compliance-signals-eng@google.com", + "Client Id for Android Backup & Restore (http://go/br-home). Contact android-backup-server-eng@google.com", + "Client Id for Google Ads AWSM. Contact awsm-eng@google.com", + "Client Id for Stargate satellite messaging. Contact dune-server-eng-team@google.com", + "Client Id for Account Management (go/ams). Contact account-management-eng@google.com, compliance-signals-eng@google.com.", + "Client Id for User Account Creation (go/id-eco-infra:account-creation). Contact account-ecosystem-infra-team@google.com, compliance-signals-eng@google.com.", + "Client Id for Netsense (go/netsense). Contact trapdoor-team@google.com,", + "Client ID used by Fitbit Labs (go/fitbit-labs). Contact fitbit-labs-eng@", + "Client ID used by Local Services Ads. Contact sab-eng@", + "Client ID used by the User Feedback Service (go/user-feedback-service). Contact ads-integrity-transparency-team@", + "Client ID used by Bard/Gemini evals to spoof location data. Contact bard-eval-infra@ This should only be used with spoofed location data. For real user data, follow the onboarding steps at go/use-current-location", + "Client ID used by the Scenario-based Seeding Home & Work seeder. Contact loki-prod@google.com", + "Client ID used by the ADI Feature API (go/adi-feature-api)", + "Client Id for Labs Bettany Contact: bettany-eng@", + "Client Id for neco-genesis Contact: neco-eng@", + "Client ID used by Fitbit Capabilities Service (go/fitbit-capabilities). Contact fitbit-app-platform@", + "Client ID for Ads Marketing Automation (go/ce-ama) Contact: ads-marketing-automation-eng@", + "Client ID for Android Telemetry Westworld Contact: android-telemetry-infra-server@", + "Client ID for Data Security Posture Management (DSPM) Detective Controls Contact: dspm-controls-eng@", + "Client ID for CAA Insights Contact: policy-decision-service-eng@", + "Client ID for Shopping Carrier Info Contact: gpay-jp-eng-all@", + "Gws. Contact: oolong-team@.", + "", + "", + "", + "", + "", + "Search Ads clients providing similar user location to Search.", + "", + "", + "", + "", + "", + "", + "", + "Ad manager user sign up location by IP address", + "Use these within GWS iff the project is not using TLD (e.g. www.google.ch).", + "", + "", + "", + "Client Ids for Assistant via Oolong Service.", + "", + "", + "", + "Gws tld experimental clients", + "", + "", + "", + "Ads experimental clients", + "", + "", + "", + "Gws nontld experimental clients", + "", + "", + "", + "Assistant experimental clients", + "", + "", + "", + "Clients for Andromeda experimental slot. See go/ul-experimental-slots for description.", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "Clients for Bootes experimental slot. See go/ul-experimental-slots for description.", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "Clients for Cassiopeia experimental slot. See go/ul-experimental-slots for description.", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "Clients for Delphinus experimental slot. See go/ul-experimental-slots for description.", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "Clients for Eridanus experimental slot. See go/ul-experimental-slots for description.", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "Clients for Fomax experimental slot. See go/ul-experimental-slots for description.", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "Clients for Gemini experimental slot. See go/ul-experimental-slots for description.", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "Clients for Hercules experimental slot. See go/ul-experimental-slots for description.", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "Clients for Indus experimental slot. See go/ul-experimental-slots for description.", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "Clients for Leo experimental slot. See go/ul-experimental-slots for description.", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "Clients for Mensa experimental slot. See go/ul-experimental-slots for description.", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "Clients for Norma experimental slot. See go/ul-experimental-slots for description.", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "Clients for Orion experimental slot. See go/ul-experimental-slots for description.", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "Clients for Pisces experimental slot. See go/ul-experimental-slots for description.", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "Clients for Reticulum experimental slot. See go/ul-experimental-slots for description.", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "Clients for Sagittarius experimental slot. See go/ul-experimental-slots for description.", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "Clients for Taurus experimental slot. See go/ul-experimental-slots for description.", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "Clients for Ursa Major experimental slot. See go/ul-experimental-slots for description.", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "Clients for Virgo experimental slot. See go/ul-experimental-slots for description.", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "Use for LoggedContext re-geocoding. Do not use for LocationContext processing.", + "Client useful for country level IPGeo. It accepts any country regardless of the confidence. Do not use this client for any location other than country. It can be used while migrating from legacy googledata/ipgeo index. Contact: oolong-team@.", + "Client similar to CLIENT_IPGEO_REGION, but adapted to IPGeo Eval purpose. Contact: ipgeo-team@.", + "Tactile initial viewport policy. Contact: oolong-team@ Note that maps clients don't adhere to TLD restrictions.", + "", + "", + "", + "Maps clients that use glassbox.", + "", + "", + "", + "", + "", + "Experimental maps clients.", + "", + "Session IP geocoding. Contact: oolong-team@.", + "Use this client ID if you are not using oolong legal/quality annotations. A sample usecase is reverse geocoding a set of lat/lngs or mids/featureids. NOTE: do not use oolong annotations if this client is set.", + "Default client to use when TLD restrictions are not applied. This policy can change without notice. If you care about particular quality assumptions, then create a custom client id. Contact: oolong-team@", + "Does NOT annotate anything with UNIQUE_SELECTED_FOR_USER_LOCATION", + "Client id that only applies legal annotations.", + "Use for testing only. Never use this in production.", + "", + "Used for oracle eval.", + "", + "", + "", + "Clients used to compare different location source combinations.", + "", + "", + "Client used for country field in Magic Eye dimensions (go/core-dimensions).", + "Used for the go/mapsguide directions prototype.", + "Deprecated clients SafeBrowsing Team. Contact: anov@.", + "Use CLIENT_GWS_NONTLD_DESKTOP_ZWIEBACK or _GAIA Contact oolong-team@", + "Use CLIENT_GWS_NONTLD_MOBILE_ZWIEBACK or _GAIA Contact oolong-team@" + ], + "type": "string" + }, + "name": { + "description": "The name of this set.", + "type": "string" + }, + "policyResult": { + "$ref": "LocationUnifiedPolicyResult", + "description": "The policy result that corresponds to the alternate policy." + }, + "sourceDescription": { + "description": "The source description for this result in the alternate policy.", + "enum": [ + "SOURCE_DESCRIPTION_UNSPECIFIED", + "FROM_YOUR_INTERNET_ADDRESS", + "FROM_YOUR_LOCATION_HISTORY", + "BASED_ON_YOUR_LOCATION_HISTORY", + "FROM_YOUR_DEVICE", + "BASED_ON_YOUR_PAST_ACTIVITY", + "FROM_YOUR_PLACES_HOME", + "FROM_YOUR_PLACES_WORK" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "", + "", + "", + "" + ], + "type": "string" + } + }, + "type": "object" + }, + "LocationUnifiedExtractorFlags": { + "id": "LocationUnifiedExtractorFlags", + "properties": { + "gwsJurisdictionCountryExtractorEnabled": { + "type": "boolean" + }, + "hostDomainExtractorEnabled": { + "type": "boolean" + }, + "ipAlternateExtractorEnabled": { + "type": "boolean" + }, + "ipExtractorEnabled": { + "type": "boolean" + }, + "queryExtractorEnabled": { + "description": "If true, any query found in the request will be included in geocoding and the location context.", + "type": "boolean" + }, + "uuleCookieExtractorEnabled": { + "type": "boolean" + }, + "xgeoHeaderExtractorEnabled": { + "type": "boolean" + } + }, + "type": "object" + }, + "LocationUnifiedFeatureIdProto": { + "description": "A copy of //geostore/base/proto/featureid.proto. Because Oolong descriptors are intended to be publicly available, we don't want to depend on other protos. This proto is tag-compatible with the original. Note that this could be used for non-Oyster identifiers if distinguished by some appropriate producer. Otherwise, it is assumed to be an Oyster ID. The code in logs/storage/validator/logs_validator_traits.cc treats this type as if it were annotated as ST_LOCATION.", + "id": "LocationUnifiedFeatureIdProto", + "properties": { + "cellId": { + "description": "The S2CellId corresponding to the approximate centroid of this feature.", + "format": "uint64", + "type": "string" + }, + "fprint": { + "description": "A 64-bit fingerprint used to distinguish between multiple features at the same location.", + "format": "uint64", + "type": "string" + } + }, + "type": "object" + }, + "LocationUnifiedFeatureReference": { + "description": "A featurelet in the location result's hierarchy. This references the feature pool for base data (like names and geometry), and contains additional fields that are set by the policy.", + "id": "LocationUnifiedFeatureReference", + "properties": { + "alternateAnnotations": { + "description": "Alternate annotations applied to this featurelet.", + "items": { + "$ref": "LocationExtractorFeatureletAnnotationSet" + }, + "type": "array" + }, + "annotations": { + "description": "Annotations applied to this featurelet by the policy store.", + "items": { + "enum": [ + "TRIMMED_BY_QUALITY_FILTERING" + ], + "enumDescriptions": [ + "Indicate that a featurelet should not be used. This annotation is applied during ApplyQualityFiltering for feature \"trimming\" or added by the PolicyStore as a result of quality score calculation." + ], + "type": "string" + }, + "type": "array" + }, + "confidence": { + "description": "The confidence that this featurelet is correct.", + "format": "float", + "type": "number" + }, + "featureId": { + "$ref": "GeostoreFeatureIdProto", + "description": "The feature ID, which is used as key for looking up the featurelet from the LocationContext's feature pool." + } + }, + "type": "object" + }, + "LocationUnifiedFieldOfView": { + "description": "A description of the field of view of a camera. Used in conjunction with location and rotation to indicate how much of a scene is being rendered inside the camera.", + "id": "LocationUnifiedFieldOfView", + "properties": { + "fieldOfViewXDegrees": { + "description": "Horizontal degrees of view, i.e. the angle between the left and right clipping planes.", + "format": "float", + "type": "number" + }, + "fieldOfViewYDegrees": { + "description": "Vertical degrees of view, i.e. the angle between the top and bottom clipping planes.", + "format": "float", + "type": "number" + }, + "screenWidthPixels": { + "description": "Pixel dimensions of a device screen. This is currently only used by Tactile and should not be used elsewhere without good reason, at which point we would probably rename the field. Pixels are assumed to be square.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "LocationUnifiedInterpretationData": { + "id": "LocationUnifiedInterpretationData", + "properties": { + "query": { + "description": "Serialized s-expr annotated with :loc.", + "type": "string" + }, + "term": { + "description": "This group provides details about what we found in the query as a set of non-overlapping 'terms', each referring to a separate political feature. E.g. query of \"Pizza near Mt View CA\" would (in one of the geocodes) contain two terms: \"Mt View\" and \"CA\". All terms are given in left-to-right order. Note that not all featurelets necessarily occur as a term. Some may have been inferred from the political hierarchy. E.g. in the example above there would be a featurelet for the US after the one for \"CA\".", + "items": { + "$ref": "LocationExtractorInterpretationTerm" + }, + "type": "array" + } + }, + "type": "object" + }, + "LocationUnifiedLatLng": { + "description": "A latitude and longitude used to describe a point. Units are degrees x 10^7 and rounded to the nearest integer). When used to describe a point, the latitudes should be in the range +/- 90 degrees and the longitude should be in the range +/- 180 degrees (inclusive). LatLng message was also used to describe a span, but it turns out full longitude span (360 degrees * 10^7) does not fit in signed int32. Thus, using LatLng for a span is deprecated. Please use LatLngRect instead. The code in logs/storage/validator/logs_validator_traits.cc treats this type as if it were annotated as ST_LOCATION.", + "id": "LocationUnifiedLatLng", + "properties": { + "latitudeE7": { + "format": "int32", + "type": "integer" + }, + "longitudeE7": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "LocationUnifiedLatLngRect": { + "description": "A latitude-longitude rectangle, represented as two diagonally opposite points \"lo\" and \"hi\". The rectangle is considered to be a closed region, i.e. it includes its boundary. The latitude bounds must be in the range -90 to 90 degrees inclusive, and the longitude bounds must be in the range -180 to 180 degrees inclusive. Both points must be normalized, with lo.latitude <= hi.latitude. If lo.latitude > hi.latitude, the latitude range is considered empty and there will be a warning the first 100 times Oolong sees such proto. \"lo\" point is the lower-left corner and \"hi\" point is the upper-right corner of the resulting rectangle. Various special cases include: - If lo == hi, the rectangle consists of a single point. - If lo.longitude > hi.longitude, the longitude range is \"inverted\" (the rectangle crosses the 180 degree longitude line). - If lo.longitude == -180 degrees and hi.longitude = 180 degrees, the rectangle includes all longitudes. - If lo.longitude = 180 degrees and hi.longitude = -180 degrees, the longitude range is empty. The code in logs/storage/validator/logs_validator_traits.cc treats this type as if it were annotated as ST_LOCATION.", + "id": "LocationUnifiedLatLngRect", + "properties": { + "hi": { + "$ref": "LocationUnifiedLatLng" + }, + "lo": { + "$ref": "LocationUnifiedLatLng" + } + }, + "type": "object" + }, + "LocationUnifiedLocationAnnotation": { + "description": "Used to distinguish locations within a location context (e.g., indicate those locations selected by a policy).", + "id": "LocationUnifiedLocationAnnotation", + "properties": { + "details": { + "description": "Optional debug information associated with this annotation. For human consumption only.", + "type": "string" + }, + "type": { + "description": "Indicates the purpose of this annotation.", + "enum": [ + "UNKNOWN_ANNOTATION", + "UNIQUE_SELECTED_FOR_CONTEXT", + "UNIQUE_SELECTED_FOR_USER_LOCATION", + "SELECTED_FOR_EXPLICIT_IMMEDIATE_LOCATION", + "UNIQUE_SELECTED_FOR_NON_QUERY_ROLES", + "UNIQUE_TRUSTED_CURRENT_LOCATION", + "UNIQUE_TRUSTED_CURRENT_COUNTRY", + "UNIQUE_JURISDICTION_COUNTRY", + "SELECTED_FOR_JURISDICTION_COUNTRIES", + "DOES_NOT_CONFORM_TO_TLD", + "MARKED_FOR_POLICY_REMOVAL", + "FINE_GRAINED_CURRENT_LOCATION", + "UNIQUE_SELECTED_FOR_CONTEXT_EXPERIMENTAL_QREF", + "SELECTED_FOR_RTBF_COUNTRIES", + "UNIQUE_SELECTED_FOR_RTBF_DOMAIN", + "PRODUCER_ABLATED_FOR_EXPERIMENT", + "SELECTED_FOR_AREA_OF_INTEREST", + "SELECTED_FOR_FREQUENT_LOCATION", + "STRIPPED_FROM_LIVE_RESPONSE", + "UNIQUE_SELECTED_FOR_ROLE", + "LOW_CONFIDENCE", + "DO_NOT_USE_FOR_SEARCHING", + "EXPERIMENTAL", + "UNIQUE_SELECTED_LOCALE", + "UNIQUE_SELECTED_FOR_SEMANTIC_USER_LOCATION", + "ADDITIONAL_USER_LOCATION", + "REMOVED_DEVICE_LOCATION" + ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + true, + true, + true, + true, + true, + true, + true, + true + ], + "enumDescriptions": [ + "THIS VALUE MUST BE THE FIRST IN THIS ENUM. Default value used to identify unset fields including those resulting from enum values unknown to an out-dated binary. This should be used only to check for errors.", + "A descriptor with this annotation has been selected by some policy as the single descriptor to be used for this request. This selects a result that prefers explicit location set by the user over our best guess for the user location. If you think you need to use this annotation, please contact oolong-team@ first. Use SELECTED_FOR_EXPLICIT_IMMEDIATE_LOCATION and UNIQUE_SELECTED_FOR_USER_LOCATION, if you need access to user provided locations and/or implicit user locations respectively. Invariant: At most one descriptor in a context can have an annotation of this type.", + "A descriptor with this annotation has been selected by some policy as the single descriptor to be used for current user location (physical location). Note that this is our best guess about actual user location which may be spoofed by malicious user. If you need stronger guarantees about user country of presence, use UNIQUE_TRUSTED_CURRENT_LOCATION annotation defined below (if in doubt, contact oolong-team for advise). Invariant: At most one descriptor in a context can have this annotation.", + "Descriptors with this annotation have been selected by the policy as the set of locations that can be used as explicit immediate locations. Note that the set will not contain current user location (e.g. location with annotation UNIQUE_SELECTED_FOR_USER_LOCATION). It may contain query location, viewport or a location that has been specified by the user for a given request, such as the &near param. For more details see: https://docs.google.com/a/google.com/document/d/1aTiZG-r-hrLRGiGCJvjIAk45hUPSi07idxySzvzaQvk/edit", + "A descriptor with this annotation has been selected by some policy as the single descriptor to be used for this request, excluding any locations present in the user query. This will be the descriptor that would have the annotation UNIQUE_SELECTED_FOR_CONTEXT if all QUERY role descriptors were removed from the context. Invariant: At most one descriptor in a context can have this annotation.", + "A descriptor with this annotation has been selected by some policy as the single descriptor in the context that can be trusted to represent the user's current location (i.e., it is not user specified and is hard to spoof). TLD does not affect this annotation. This annotation can be used to apply restrictions on services based on a user's \"physical\" location. DO NOT USE THIS ANNOTATION WITHOUT TALKING TO oolong-team (and possibly Legal). It can only be used in very specific circumstances.", + "A descriptor with this annotation has been selected by some policy as the single descriptor in the context that can be trusted to represent the user's current country (i.e., it is not user specified and is hard to spoof). TLD does not affect this annotation. This annotation can be used to apply restrictions on services based on a user's \"physical\" location. This is the country-level-only version of UNIQUE_TRUSTED_CURRENT_LOCATION. DO NOT USE THIS ANNOTATION WITHOUT TALKING TO oolong-team (and possibly Legal). It can only be used in very specific circumstances.", + "A descriptor with this annotation has been selected by some policy as the single descriptor in the context that represents the country of jurisdiction for the user. Some restrictions can be applied based on the location country in this descriptor. This annotation can be used to apply restrictions on services based on a user's \"logical\" location. Results annotated with UNIQUE_JURISDICTION_COUNTRY are not guaranteed to have a TYPE_COUNTRY feature if the result is within a disputed area. See also SELECTED_FOR_JURISDICTION_COUNTRIES below. DO NOT USE THIS ANNOTATION WITHOUT TALKING TO oolong-team (and possibly Legal). It can only be used in very specific circumstances.", + "SELECTED_FOR_JURISDICTION_COUNTRIES is always added to the result annotated with UNIQUE_JURISDICTION_COUNTRY. If the UNIQUE_JURISDICTION_COUNTRY result matches a disputed area in http://google3/googledata/location/unified/location_service/disputed_areas_jurisdiction_countries.txt, then SELECTED_FOR_JURISDICTION_COUNTRIES is additionally added to synthetic results with the country codes specified in that file. For example, if a result in Crimea is annotated with UNIQUE_JURISDICTION_COUNTRY, then SELECTED_FOR_JURISDICTION_COUNTRIES will be present: - on the Crimea location; - on a synthetic result in Russia (with country code RU); and - on a synthetic result in Ukraine (with country code UA). DO NOT USE THIS ANNOTATION WITHOUT TALKING TO oolong-team (and possibly Legal). It can only be used in very specific circumstances.", + "A descriptor with this annotation means that it was an implicit (ie IP, not NEAR) location and the country of the result does not match the country of the TLD. Results with these annotations should not be used without first consulting oolong-team.", + "This annotation means that the descriptor is not allowed by the policy that was applied. It may appear in alternate annotations in a merged LocationContext. Results with this annotation should be removed when the merged LocationContext is split. For example, Ads essential-only mode clients forbid the use of UULE device locations. Results with this annotation should generally not have any of the \"Search selected\" or \"Legal selected\" annotations.", + "A descriptor with this annotation means that it is a very precise user location, such as a GPS location. This annotation is applied to locations with UNIQUE_SELECTED_FOR_USER_LOCATION annotation.", + "This annotation has been introduced for the purpose of transitioning from LES query geocoding to QREF query geocoding. Clients who wish to use QREF query annotations, should consider using this annotation as a replacement for UNIQUE_SELECTED_FOR_CONTEXT. It has identical semantics to UNIQUE_SELECTED_FOR_CONTEXT with a difference that QREF annotations are used. Note that this is a temporary annotation and should eventually be removed once migration to QREF is complete.", + "This annotation selects the countries for RTBF content restriction. The union of restrictions of all countries with this annotation should be applied.", + "This annotation selects the country based on which all european RTBF content restrictions should be applied if the selected country is european.", + "This annotation indicates that the result has a producer that was removed as asked by the Oolong__producers_to_ablate flag and re-added.", + "This annotation indicates that the location has been selected by some policy as an area of interest, i.e. the location is of significance to the user. Areas of interest are usually implicit, i.e. not part of the current query. See go/oolong-aoi. DO NOT USE THIS ANNOTATION WITHOUT TALKING TO oolong-team.", + "This annotation indicates that the location has been selected by some policy as a frequent location. Frequent locations are places where we expect a user to spend extended amounts of time. See go/oolong-serving-flops. DO NOT USE THIS ANNOTATION WITHOUT TALKING TO oolong-team.", + "This annotation should never been seen at serving time, yet it will be present in logs to indicate when a specific location was stripped at serving time. For example, when a location is not accessible by any location view.", + "DEPRECATED annotations", + "", + "", + "", + "Use UNIQUE_SELECTED_FOR_USER_LOCATION instead", + "", + "", + "" + ], + "type": "string" + } + }, + "type": "object" + }, + "LocationUnifiedLocationAttributesProto": { + "description": "Supplemental attributes for a location that may affect search results. Next Id: 24", + "id": "LocationUnifiedLocationAttributesProto", + "properties": { + "activityRecord": { + "description": "The user detected activity.", + "items": { + "$ref": "LocationUnifiedActivityRecord" + }, + "type": "array" + }, + "adsConfidence": { + "description": "Confidence for use in ads. Might be different from the confidence in the descriptor. Currently only used for locations with producer TRAVEL_STATE_INTENT.", + "format": "float", + "type": "number" + }, + "altitudeMetersFromGround": { + "description": "Altitude in meters, from ground level.", + "format": "double", + "type": "number" + }, + "bearingAccuracyDegrees": { + "description": "The accuracy of bearing in degrees, based on GMS Core calculations on two latest location points. The actual bearing should be within bearing_degrees ± bearing_accuracy_degrees.", + "format": "int32", + "type": "integer" + }, + "bearingDegrees": { + "description": "The direction in degrees in which the client device was moving. Must be in the range 0 to 359. 0 represents north and 90 is east.", + "format": "int32", + "type": "integer" + }, + "boardedTransitVehicleToken": { + "description": "An opaque token to represent a transit vehicle that a user is riding. This field is always server generated and encoding scheme is determined by the server. Currently, Tactile's local encoding (web-safe base64 prefixed by \"B\") is used.", + "type": "string" + }, + "carrierIpType": { + "enum": [ + "CARRIER_IP_UNKNOWN", + "CARRIER_IP_NOT_CARRIER", + "CARRIER_IP_MOBILE" + ], + "enumDescriptions": [ + "", + "", + "" + ], + "type": "string" + }, + "deviceLocationRatio": { + "description": "FOR OOLONG INTERNAL USE ONLY! TODO(b/142046202) Migrate this field outside of Location Descriptor. Ratio of device location versus other signals that we have for this user. Note that this is a per-user attribute, not a per-location attribute.", + "format": "float", + "type": "number" + }, + "fieldOfView": { + "$ref": "LocationUnifiedFieldOfView", + "description": "The field of view of a camera." + }, + "headingDegrees": { + "description": "The direction in degrees in which the client device was pointed. Must be in the range 0 to 359. 0 represents north and 90 is east.", + "format": "int32", + "type": "integer" + }, + "inference": { + "enum": [ + "INFERENCE_NONE", + "INFERENCE_HULK_HEURISTIC", + "INFERENCE_HULK_CLASSIFIED", + "INFERENCE_HULK_UNKNOWN", + "INFERENCE_PLM" + ], + "enumDescriptions": [ + "this is not an inferred place", + "", + "HULK Classifier is used instead of heuristic.", + "", + "" + ], + "type": "string" + }, + "ipRangeConfidence": { + "format": "float", + "type": "number" + }, + "manualEntry": { + "enum": [ + "MANUAL_ENTRY_NONE", + "MANUAL_ENTRY_UNKNOWN", + "MANUAL_ENTRY", + "MANUAL_ENTRY_DROPPED_PIN", + "MANUAL_ENTRY_HIGH_LEVEL", + "MANUAL_ENTRY_STALE", + "MANUAL_ENTRY_INSUFFICIENT_LOCATIONS" + ], + "enumDescriptions": [ + "this place was not manually entered", + "", + "Not stale manual entry of an address", + "", + "", + "", + "" + ], + "type": "string" + }, + "personalizedLocationAttributes": { + "$ref": "LocationUnifiedPersonalizedLocationAttributes", + "description": "FOR OOLONG INTERNAL USE ONLY! TODO(b/142046202) Migrate this field outside of Location Descriptor. Additional Oolong-specific attributes of the location." + }, + "plmSourceLocationCount": { + "description": "FOR OOLONG INTERNAL USE ONLY! TODO(b/142046202) Migrate this field outside of Location Descriptor. Total number of locations (across all events) used in PLM inference.", + "format": "int32", + "type": "integer" + }, + "plmType": { + "deprecated": true, + "enum": [ + "PLMTYPE_UNKNOWN", + "PLMTYPE_FIRST", + "PLMTYPE_SECOND", + "PLMTYPE_THIRD", + "PLMTYPE_FOURTH", + "PLMTYPE_FIFTH", + "PLMTYPE_SIXTH", + "PLMTYPE_SEVENTH", + "PLMTYPE_EIGHTH", + "PLMTYPE_NINTH" + ], + "enumDescriptions": [ + "", + "Order by confidence.", + "", + "", + "", + "", + "", + "", + "", + "" + ], + "type": "string" + }, + "rollDegrees": { + "description": "Clockwise rotation around the line of sight (i.e. vector (0, 0, -1) in Eye Coords). Zero means that y points up in Screen Coords; 180 gives an upside down view, where y points down in Screen Coords. Allowed range is [0, 360). For out-of-range values, the behavior is undefined.", + "format": "int32", + "type": "integer" + }, + "speedAccuracyKph": { + "description": "The accuracy of the speed in kilometers per hour, meaning that the actual speed should be within speed_kph ± speed_accuracy_kph.", + "format": "int32", + "type": "integer" + }, + "speedKph": { + "description": "The speed in kilometers per hour at which the client device was moving.", + "format": "int32", + "type": "integer" + }, + "tiltDegrees": { + "description": "Rotation where zero points down, 180 points up and 90 points to horizon. Allowed range is [0, 180]. For out-of-range values, the behavior is undefined.", + "format": "int32", + "type": "integer" + }, + "viewportSearchOptions": { + "enum": [ + "VIEWPORT_SEARCH_OPTIONS_UNSPECIFIED", + "VIEWPORT_SEARCH_OPTIONS_AROUND", + "VIEWPORT_SEARCH_OPTIONS_RESTRICT", + "VIEWPORT_SEARCH_OPTIONS_FILTER_ONLY", + "VIEWPORT_SEARCH_OPTIONS_FORCE_AROUND" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "" + ], + "type": "string" + }, + "weekSecondConfidence": { + "format": "float", + "type": "number" + } + }, + "type": "object" + }, + "LocationUnifiedLocationContext": { + "description": "A container for passing and processing the set of locations associated with a particular request. Next available tag: 11", + "id": "LocationUnifiedLocationContext", + "properties": { + "clientId": { + "description": "The client ID that was used for annotating this location context (if any). This field is set accordingly by the policy annotation.", + "enum": [ + "CLIENT_UNKNOWN", + "CLIENT_CURIO", + "CLIENT_ONE_GOOGLE_SERVICE", + "CLIENT_EVALS", + "CLIENT_EVALS_ONESHOT", + "CLIENT_EVALS_UQS", + "CLIENT_BOOKS", + "CLIENT_BOND", + "CLIENT_CHROME_UMA", + "CLIENT_DOUBLECLICK_SEARCH", + "CLIENT_YOUTUBE_ISP_RATING", + "CLIENT_YOUTUBE_REAL_TIME_QOE", + "CLIENT_YOUTUBE_QOE_LIVYATAN", + "CLIENT_YOUTUBE", + "CLIENT_YOUTUBE_SHORTS_DESKTOP_GAIA", + "CLIENT_YOUTUBE_SHORTS_DESKTOP_ZWIEBACK", + "CLIENT_YOUTUBE_SHORTS_MOBILE_GAIA", + "CLIENT_YOUTUBE_SHORTS_MOBILE_ZWIEBACK", + "CLIENT_YOUTUBE_VIRAL_DESKTOP_GAIA", + "CLIENT_YOUTUBE_VIRAL_DESKTOP_ZWIEBACK", + "CLIENT_YOUTUBE_VIRAL_MOBILE_GAIA", + "CLIENT_YOUTUBE_VIRAL_MOBILE_ZWIEBACK", + "CLIENT_YOUTUBE_VIRAL_LES", + "CLIENT_YOUTUBE_VIRAL_EXP_DESKTOP_GAIA", + "CLIENT_YOUTUBE_VIRAL_EXP_DESKTOP_ZWIEBACK", + "CLIENT_YOUTUBE_VIRAL_EXP_MOBILE_GAIA", + "CLIENT_YOUTUBE_VIRAL_EXP_MOBILE_ZWIEBACK", + "CLIENT_YOUTUBE_VIRAL_DESKTOP_GAIA_AXOLOTL", + "CLIENT_YOUTUBE_VIRAL_DESKTOP_ZWIEBACK_AXOLOTL", + "CLIENT_YOUTUBE_VIRAL_MOBILE_GAIA_AXOLOTL", + "CLIENT_YOUTUBE_VIRAL_MOBILE_ZWIEBACK_AXOLOTL", + "CLIENT_YOUTUBE_VIRAL_DESKTOP_GAIA_BADGER", + "CLIENT_YOUTUBE_VIRAL_DESKTOP_ZWIEBACK_BADGER", + "CLIENT_YOUTUBE_VIRAL_MOBILE_GAIA_BADGER", + "CLIENT_YOUTUBE_VIRAL_MOBILE_ZWIEBACK_BADGER", + "CLIENT_YOUTUBE_VIRAL_DESKTOP_GAIA_CHIPMUNK", + "CLIENT_YOUTUBE_VIRAL_DESKTOP_ZWIEBACK_CHIPMUNK", + "CLIENT_YOUTUBE_VIRAL_MOBILE_GAIA_CHIPMUNK", + "CLIENT_YOUTUBE_VIRAL_MOBILE_ZWIEBACK_CHIPMUNK", + "CLIENT_YOUTUBE_ADMIN_YURT", + "CLIENT_YOUTUBE_BAD_HARVEST", + "CLIENT_SPEECH", + "CLIENT_GMAIL", + "CLIENT_GMAIL_SPAM", + "CLIENT_CHROMECAST_WEB", + "CLIENT_PANCETTA", + "CLIENT_GOOGLE_LOCATION_SERVER", + "CLIENT_GOOGLE_FEEDBACK", + "CLIENT_ANDROID_METRICS_WAREHOUSE", + "CLIENT_USERMGMT", + "CLIENT_APPREMOTING", + "CLIENT_GAIA_PERMISSION_SERVER", + "CLIENT_ACTIONABLE_IPS", + "CLIENT_DISPLAY_ADS", + "CLIENT_DISPLAY_ADS_DEFAULT", + "CLIENT_DISPLAY_ADS_DESKTOP_GAIA", + "CLIENT_DISPLAY_ADS_DESKTOP_ZWIEBACK", + "CLIENT_DISPLAY_ADS_MOBILE_GAIA", + "CLIENT_DISPLAY_ADS_MOBILE_ZWIEBACK", + "CLIENT_DISPLAY_ADS_PREVIEW", + "CLIENT_HOBBES", + "CLIENT_NEWSSTAND", + "CLIENT_NEWSSTAND_EXPERIMENTAL", + "CLIENT_POLYNEWS", + "CLIENT_DOCS", + "CLIENT_ADWORDS_EXPRESS", + "CLIENT_TRACE_DEPOT", + "CLIENT_MAPSPRO", + "CLIENT_GEO_ONDEMAND", + "CLIENT_ACCESS_FILTER", + "CLIENT_DOMAIN_REGISTRAR", + "CLIENT_ASSISTANT", + "CLIENT_ASSISTANT_FRONTEND", + "CLIENT_ACCOUNT_LINKING", + "CLIENT_LEGAL_REMOVALS", + "CLIENT_CLOUD_CONSOLE", + "CLIENT_CLOUD_FREE_TRIAL", + "CLIENT_CLOUD_SOLUTIONS_CATALOG", + "CLIENT_CLOUD_MEDIA_ACCESS", + "CLIENT_DOTORG_G4NP", + "CLIENT_CRASH_INTERNAL", + "CLIENT_GOOGLE_WIFI_MONLOG", + "CLIENT_GOOGLE_VOICE", + "CLIENT_BLOGGER", + "CLIENT_THOR_BACKEND", + "CLIENT_NEWS", + "CLIENT_GOOGLE_PHOTOS", + "CLIENT_GOOGLE_PHOTOS_INFERRED_LOCATION", + "CLIENT_RANKBRAIN_DEBUG", + "CLIENT_HETERODYNE", + "CLIENT_FRAUDREVIEW", + "CLIENT_JAMBOARD", + "CLIENT_MARCONI", + "CLIENT_AART", + "CLIENT_CULTURAL", + "CLIENT_YOUTUBE_ECOMMERCE", + "CLIENT_ARES", + "CLIENT_LIS", + "CLIENT_STORE", + "CLIENT_DASHER_AUDITING", + "CLIENT_SHOPPING_LIST", + "CLIENT_ITEM_SUGGEST", + "CLIENT_SMART_BOOKS", + "CLIENT_GRADS", + "CLIENT_ADS_ROOT", + "CLIENT_SE_ROOT", + "CLIENT_YT_ORBIT", + "CLIENT_NOVA_APERTURE", + "CLIENT_LENA_SIGNUP_DEFAULTS", + "CLIENT_PLAY_APPS_PUBLISHER", + "CLIENT_FINSKY_ENTERPRISE", + "CLIENT_GOOGLE_ADMIN", + "CLIENT_CRYPTAUTH", + "CLIENT_GSA_UNIVERSAL_SERVER", + "CLIENT_TRAVEL_FRONTEND_TRANSIT", + "CLIENT_HOME_CLOUD", + "CLIENT_GSX_MALL", + "CLIENT_GOOGLE_DUO", + "CLIENT_GAIA_FRONTEND", + "CLIENT_ANDROID_MESSAGES", + "CLIENT_GOOGLE_LENS", + "CLIENT_CHROME_WEB_STORE", + "CLIENT_ACTIONS_ON_GOOGLE_CONSOLE", + "CLIENT_ANDROID_TV_CHANNELS", + "CLIENT_ASSISTANT_WEB_SETTINGS", + "CLIENT_PLAY_USER_DATA", + "CLIENT_ADS_INTEGRITY", + "CLIENT_ADS_INTEGRITY_MALVERTISING", + "CLIENT_FIREBASE_CONSOLE", + "CLIENT_AOG_FEED_VALIDATOR", + "CLIENT_PLUMERIA", + "CLIENT_PAISA", + "CLIENT_GOOGLE_PAY", + "CLIENT_GOOGLE_PAY_WEB", + "CLIENT_GOOGLE_WALLET", + "CLIENT_SCROOGLED", + "CLIENT_WAYMO", + "CLIENT_CROW", + "CLIENT_GSUITE_SECURITY_CENTER_SIT", + "CLIENT_EVENT_THREAT_DETECTION", + "CLIENT_PLAY_LOCATION", + "CLIENT_FOOTPLACER", + "CLIENT_DASHER_COMMERCE", + "CLIENT_SOCIAL_PEOPLE_ANALYTICS", + "CLIENT_CONTACTS_UI", + "CLIENT_GAFE4", + "CLIENT_PLACES_API", + "CLIENT_PLACES_SEARCH_API", + "CLIENT_DRIVE_WEB", + "CLIENT_ANDROID_OTA", + "CLIENT_PAISA_NEARBY_STORES", + "CLIENT_ISP_FIBER_FAS", + "CLIENT_SUPPORT_CONTENT", + "CLIENT_GWS_OFFROAD_LOGGING", + "CLIENT_CHANGEHISTORY", + "CLIENT_SESSION_RISK", + "CLIENT_ALPS", + "CLIENT_DISCOVER_NEWS_LOCATION", + "CLIENT_ASSISTANT_SNAPSHOT", + "CLIENT_HONEYCOMB", + "CLIENT_PLAY_MONETARY_ABUSE", + "CLIENT_SMALL_BUSINESS_ADVISORS", + "CLIENT_GPA_FEEDS", + "CLIENT_EDU_ORIGINALITY", + "CLIENT_PAIDTASKS", + "CLIENT_TRANSLATE", + "CLIENT_FUNDING_CHOICES", + "CLIENT_SEARCH_NOTIFICATIONS", + "CLIENT_VISUAL_SEMANTIC_SERVICE", + "CLIENT_CHROME_PREFETCH_PROXY", + "CLIENT_WEAR_FRONTEND", + "CLIENT_PAYMENTS_RISKENGINE", + "CLIENT_PAYMENTS_ORCHESTRATION", + "CLIENT_ANDROID_TV_IRDB", + "CLIENT_TRENDS_FRONTEND", + "CLIENT_COLABORATORY", + "CLIENT_SOCRATIC", + "CLIENT_PS1_LOCATION", + "CLIENT_DDM_REPORTING", + "CLIENT_HOMEROOM_BACKEND", + "CLIENT_CARS_CATEGORICAL", + "CLIENT_GPAY_MERCHANT_VERTICALS", + "CLIENT_RECAPTCHA_ACCOUNT_DEFENDER", + "CLIENT_RECAPTCHA_LITE", + "CLIENT_RECAPTCHA_FRAUD", + "CLIENT_AUTONT_ACCESS_LOCATION", + "CLIENT_TFAA_REPORT", + "CLIENT_IDAAS_IP_LOCATION", + "CLIENT_ONESTACK_METRIC_COLLECTION", + "CLIENT_GPAY_TRANSIT", + "CLIENT_CHRONICLE_SECURITY", + "CLIENT_CHRONICLE_SECURITY_UI", + "CLIENT_GPAY_MERCHANT_SPOT_ONBOARDING_TOOL", + "CLIENT_ADS_SCRAPING", + "CLIENT_CLOUD_SUPPORT_PORTAL", + "CLIENT_LAMDA", + "CLIENT_ACCESS_REDIRECTION_SERVICE", + "CLIENT_PINPOINT", + "CLIENT_SHOPPING_ORDER_HISTORY", + "CLIENT_NEST_CAMERA_CLOUD", + "CLIENT_PANOPTIC_EVAL", + "CLIENT_ABOUT_THIS_PAGE", + "CLIENT_PHOTOS_ANALYTICS_MARKETING", + "CLIENT_GMSCORE_GMSCOMPLIANCE", + "CLIENT_ANALYTICS_COLLECTION", + "CLIENT_PLAY_CONSOLE_ANDROID_VITALS", + "CLIENT_CRASHLYTICS_PLAY_CONSOLE_CRASHES", + "CLIENT_PAYMENTS_MERCHANT_STORIES", + "CLIENT_CLOUDTOP_CONNECTIVITY", + "CLIENT_CLOUD_WEB", + "CLIENT_RECORDING_CONSENT", + "CLIENT_DV3_FRONTEND", + "CLIENT_LENDING_DATA_MANAGER", + "CLIENT_CHROMEOS_DATA_FRESNEL", + "CLIENT_PPN", + "CLIENT_GEO_SEARCH_API", + "CLIENT_GOOGLE_ONE_SECURITY", + "CLIENT_GOOGLE_TV_LAVA", + "CLIENT_DYNAMITE_SERVER", + "CLIENT_BCE_CLIENT_CONNECTOR", + "CLIENT_DSE_REGULATORY_ANALYSIS", + "CLIENT_SEARCH_PINPOINT", + "CLIENT_CORPLOGIN", + "CLIENT_MONOSPACE", + "CLIENT_LIGHTER", + "CLIENT_P11", + "CLIENT_FIND_MY_DEVICE_WEB", + "CLIENT_YOUTUBE_TV", + "CLIENT_FITBIT_WEB", + "CLIENT_CHORD", + "CLIENT_FITBIT_FI", + "CLIENT_GOOGLE_ANALYTICS_SERVING", + "CLIENT_FONTS", + "CLIENT_ASSISTANT_BARD", + "CLIENT_NEST_GREENENERGY", + "CLIENT_DEEPMIND_LABS", + "CLIENT_ONE_PRESENCE", + "CLIENT_TRANSPARENCY_REPORT", + "CLIENT_GOOGLE_ONE_ML", + "CLIENT_GMP_PARTNER_GALLERY", + "CLIENT_MAKERSUITE", + "CLIENT_ADS_ADMANAGER_TOS", + "CLIENT_CHROME_REMOTE_DESKTOP", + "CLIENT_SOJI", + "CLIENT_WORKSPACE_LABS_SIGNUP", + "CLIENT_AIDA", + "CLIENT_TSP", + "CLIENT_AI_SANDBOX", + "CLIENT_LABS_TAILWIND", + "CLIENT_GMAIL_TASK_ASSIST", + "CLIENT_PIXEL_WEATHER", + "CLIENT_GPAY_CATEGORY_BILLERS", + "CLIENT_SUPPORT_CHANNELS_ZENDESK_WHATSAPP", + "CLIENT_PAYMENTS_TRANSACTION_MONITORING", + "CLIENT_DISCOVER_QUERY_RECOMMENDATIONS", + "CLIENT_COMMUNICATION_PREFERENCE_CENTER", + "CLIENT_PLAY_CONSOLE_DEVELOPER_IDENTITY_AND_ACCOUNTS", + "CLIENT_GNP_ONLINE_EVALUATION", + "CLIENT_LOCAL_SUGGESTED_SETS_DEMO_SERVER", + "CLIENT_SEARCH_LABS", + "CLIENT_CROWDSOURCE", + "CLIENT_TARSIER", + "CLIENT_WORKSPACE_SIDEKICK", + "CLIENT_GOOGLE_PHOTOS_REMINISCING", + "CLIENT_GEOX_CONTAMINATION", + "CLIENT_CLOUD_MESSAGE_STORE", + "CLIENT_IP_PROTECTION", + "CLIENT_SEARCH_HAMSA", + "CLIENT_ACCOUNT_LOCATION", + "CLIENT_ANDROID_BACKUP_AND_RESTORE", + "CLIENT_ADS_AWSM", + "CLIENT_STARGATE", + "CLIENT_ACCOUNT_MANAGEMENT", + "CLIENT_USER_ACCOUNT_CREATION", + "CLIENT_NETSENSE", + "CLIENT_FITBIT_LABS", + "CLIENT_LOCAL_SERVICES", + "CLIENT_USER_FEEDBACK_SERVICE", + "CLIENT_BARD_EVAL", + "CLIENT_SCENARIO_BASED_SEEDING_HOME_WORK", + "CLIENT_ACCOUNT_INTEGRITY_FEATURE_API", + "CLIENT_LABS_BETTANY", + "CLIENT_NECO_GENESIS", + "CLIENT_FITBIT_CAPABILITIES", + "CLIENT_ADS_MARKETING_AUTOMATION", + "CLIENT_ANDROID_TELEMETRY_WESTWORLD", + "CLIENT_DSPM_DETECTIVE_CONTROLS", + "CLIENT_CAA_INSIGHTS", + "CLIENT_SHOPPING_CARRIER_INFO", + "CLIENT_GWS_TLD_MOBILE_ZWIEBACK", + "CLIENT_GWS_TLD_DESKTOP_ZWIEBACK", + "CLIENT_GWS_TLD_MOBILE_GAIA", + "CLIENT_GWS_TLD_DESKTOP_GAIA", + "CLIENT_GWS_TLD_NON_PERSONALIZED", + "CLIENT_GWS_HOMEPAGE", + "CLIENT_ADS_DESKTOP_ZWIEBACK", + "CLIENT_ADS_DESKTOP_GAIA", + "CLIENT_ADS_MOBILE_ZWIEBACK", + "CLIENT_ADS_MOBILE_GAIA", + "CLIENT_ADS_NON_PERSONALIZED", + "CLIENT_ADS_TLD_NON_PERSONALIZED", + "CLIENT_ADS_EOM", + "CLIENT_ADS_TLD_EOM", + "CLIENT_ADS_ADMANAGER_SIGNUP", + "CLIENT_GWS_NONTLD_DESKTOP_ZWIEBACK", + "CLIENT_GWS_NONTLD_DESKTOP_GAIA", + "CLIENT_GWS_NONTLD_MOBILE_ZWIEBACK", + "CLIENT_GWS_NONTLD_MOBILE_GAIA", + "CLIENT_ASSISTANT_NONTLD_MOBILE_ZWIEBACK", + "CLIENT_ASSISTANT_NONTLD_DESKTOP_ZWIEBACK", + "CLIENT_ASSISTANT_NONTLD_MOBILE_GAIA", + "CLIENT_ASSISTANT_NONTLD_DESKTOP_GAIA", + "CLIENT_GWS_TLD_DESKTOP_ZWIEBACK_EXP", + "CLIENT_GWS_TLD_DESKTOP_GAIA_EXP", + "CLIENT_GWS_TLD_MOBILE_ZWIEBACK_EXP", + "CLIENT_GWS_TLD_MOBILE_GAIA_EXP", + "CLIENT_ADS_DESKTOP_ZWIEBACK_EXP", + "CLIENT_ADS_DESKTOP_GAIA_EXP", + "CLIENT_ADS_MOBILE_ZWIEBACK_EXP", + "CLIENT_ADS_MOBILE_GAIA_EXP", + "CLIENT_GWS_NONTLD_DESKTOP_ZWIEBACK_EXP", + "CLIENT_GWS_NONTLD_DESKTOP_GAIA_EXP", + "CLIENT_GWS_NONTLD_MOBILE_ZWIEBACK_EXP", + "CLIENT_GWS_NONTLD_MOBILE_GAIA_EXP", + "CLIENT_ASSISTANT_NONTLD_MOBILE_ZWIEBACK_EXP", + "CLIENT_ASSISTANT_NONTLD_DESKTOP_ZWIEBACK_EXP", + "CLIENT_ASSISTANT_NONTLD_MOBILE_GAIA_EXP", + "CLIENT_ASSISTANT_NONTLD_DESKTOP_GAIA_EXP", + "CLIENT_GWS_TLD_MOBILE_ZWIEBACK_ANDROMEDA", + "CLIENT_GWS_TLD_DESKTOP_ZWIEBACK_ANDROMEDA", + "CLIENT_GWS_TLD_MOBILE_GAIA_ANDROMEDA", + "CLIENT_GWS_TLD_DESKTOP_GAIA_ANDROMEDA", + "CLIENT_ADS_DESKTOP_ZWIEBACK_ANDROMEDA", + "CLIENT_ADS_MOBILE_ZWIEBACK_ANDROMEDA", + "CLIENT_ADS_DESKTOP_GAIA_ANDROMEDA", + "CLIENT_ADS_MOBILE_GAIA_ANDROMEDA", + "CLIENT_GWS_NONTLD_DESKTOP_ZWIEBACK_ANDROMEDA", + "CLIENT_GWS_NONTLD_DESKTOP_GAIA_ANDROMEDA", + "CLIENT_GWS_NONTLD_MOBILE_ZWIEBACK_ANDROMEDA", + "CLIENT_GWS_NONTLD_MOBILE_GAIA_ANDROMEDA", + "CLIENT_ASSISTANT_NONTLD_MOBILE_ZWIEBACK_ANDROMEDA", + "CLIENT_ASSISTANT_NONTLD_DESKTOP_ZWIEBACK_ANDROMEDA", + "CLIENT_ASSISTANT_NONTLD_MOBILE_GAIA_ANDROMEDA", + "CLIENT_ASSISTANT_NONTLD_DESKTOP_GAIA_ANDROMEDA", + "CLIENT_GWS_TLD_MOBILE_ZWIEBACK_BOOTES", + "CLIENT_GWS_TLD_DESKTOP_ZWIEBACK_BOOTES", + "CLIENT_GWS_TLD_MOBILE_GAIA_BOOTES", + "CLIENT_GWS_TLD_DESKTOP_GAIA_BOOTES", + "CLIENT_ADS_DESKTOP_ZWIEBACK_BOOTES", + "CLIENT_ADS_MOBILE_ZWIEBACK_BOOTES", + "CLIENT_ADS_DESKTOP_GAIA_BOOTES", + "CLIENT_ADS_MOBILE_GAIA_BOOTES", + "CLIENT_GWS_NONTLD_DESKTOP_ZWIEBACK_BOOTES", + "CLIENT_GWS_NONTLD_DESKTOP_GAIA_BOOTES", + "CLIENT_GWS_NONTLD_MOBILE_ZWIEBACK_BOOTES", + "CLIENT_GWS_NONTLD_MOBILE_GAIA_BOOTES", + "CLIENT_ASSISTANT_NONTLD_MOBILE_ZWIEBACK_BOOTES", + "CLIENT_ASSISTANT_NONTLD_DESKTOP_ZWIEBACK_BOOTES", + "CLIENT_ASSISTANT_NONTLD_MOBILE_GAIA_BOOTES", + "CLIENT_ASSISTANT_NONTLD_DESKTOP_GAIA_BOOTES", + "CLIENT_GWS_TLD_MOBILE_ZWIEBACK_CASSIOPEIA", + "CLIENT_GWS_TLD_DESKTOP_ZWIEBACK_CASSIOPEIA", + "CLIENT_GWS_TLD_MOBILE_GAIA_CASSIOPEIA", + "CLIENT_GWS_TLD_DESKTOP_GAIA_CASSIOPEIA", + "CLIENT_ADS_DESKTOP_ZWIEBACK_CASSIOPEIA", + "CLIENT_ADS_MOBILE_ZWIEBACK_CASSIOPEIA", + "CLIENT_ADS_DESKTOP_GAIA_CASSIOPEIA", + "CLIENT_ADS_MOBILE_GAIA_CASSIOPEIA", + "CLIENT_GWS_NONTLD_DESKTOP_ZWIEBACK_CASSIOPEIA", + "CLIENT_GWS_NONTLD_DESKTOP_GAIA_CASSIOPEIA", + "CLIENT_GWS_NONTLD_MOBILE_ZWIEBACK_CASSIOPEIA", + "CLIENT_GWS_NONTLD_MOBILE_GAIA_CASSIOPEIA", + "CLIENT_ASSISTANT_NONTLD_MOBILE_ZWIEBACK_CASSIOPEIA", + "CLIENT_ASSISTANT_NONTLD_DESKTOP_ZWIEBACK_CASSIOPEIA", + "CLIENT_ASSISTANT_NONTLD_MOBILE_GAIA_CASSIOPEIA", + "CLIENT_ASSISTANT_NONTLD_DESKTOP_GAIA_CASSIOPEIA", + "CLIENT_GWS_TLD_MOBILE_ZWIEBACK_DELPHINUS", + "CLIENT_GWS_TLD_DESKTOP_ZWIEBACK_DELPHINUS", + "CLIENT_GWS_TLD_MOBILE_GAIA_DELPHINUS", + "CLIENT_GWS_TLD_DESKTOP_GAIA_DELPHINUS", + "CLIENT_ADS_DESKTOP_ZWIEBACK_DELPHINUS", + "CLIENT_ADS_MOBILE_ZWIEBACK_DELPHINUS", + "CLIENT_ADS_DESKTOP_GAIA_DELPHINUS", + "CLIENT_ADS_MOBILE_GAIA_DELPHINUS", + "CLIENT_GWS_NONTLD_DESKTOP_ZWIEBACK_DELPHINUS", + "CLIENT_GWS_NONTLD_DESKTOP_GAIA_DELPHINUS", + "CLIENT_GWS_NONTLD_MOBILE_ZWIEBACK_DELPHINUS", + "CLIENT_GWS_NONTLD_MOBILE_GAIA_DELPHINUS", + "CLIENT_ASSISTANT_NONTLD_MOBILE_ZWIEBACK_DELPHINUS", + "CLIENT_ASSISTANT_NONTLD_DESKTOP_ZWIEBACK_DELPHINUS", + "CLIENT_ASSISTANT_NONTLD_MOBILE_GAIA_DELPHINUS", + "CLIENT_ASSISTANT_NONTLD_DESKTOP_GAIA_DELPHINUS", + "CLIENT_GWS_TLD_MOBILE_ZWIEBACK_ERIDANUS", + "CLIENT_GWS_TLD_DESKTOP_ZWIEBACK_ERIDANUS", + "CLIENT_GWS_TLD_MOBILE_GAIA_ERIDANUS", + "CLIENT_GWS_TLD_DESKTOP_GAIA_ERIDANUS", + "CLIENT_ADS_DESKTOP_ZWIEBACK_ERIDANUS", + "CLIENT_ADS_MOBILE_ZWIEBACK_ERIDANUS", + "CLIENT_ADS_DESKTOP_GAIA_ERIDANUS", + "CLIENT_ADS_MOBILE_GAIA_ERIDANUS", + "CLIENT_GWS_NONTLD_DESKTOP_ZWIEBACK_ERIDANUS", + "CLIENT_GWS_NONTLD_DESKTOP_GAIA_ERIDANUS", + "CLIENT_GWS_NONTLD_MOBILE_ZWIEBACK_ERIDANUS", + "CLIENT_GWS_NONTLD_MOBILE_GAIA_ERIDANUS", + "CLIENT_ASSISTANT_NONTLD_MOBILE_ZWIEBACK_ERIDANUS", + "CLIENT_ASSISTANT_NONTLD_DESKTOP_ZWIEBACK_ERIDANUS", + "CLIENT_ASSISTANT_NONTLD_MOBILE_GAIA_ERIDANUS", + "CLIENT_ASSISTANT_NONTLD_DESKTOP_GAIA_ERIDANUS", + "CLIENT_GWS_TLD_MOBILE_ZWIEBACK_FOMAX", + "CLIENT_GWS_TLD_DESKTOP_ZWIEBACK_FOMAX", + "CLIENT_GWS_TLD_MOBILE_GAIA_FOMAX", + "CLIENT_GWS_TLD_DESKTOP_GAIA_FOMAX", + "CLIENT_ADS_DESKTOP_ZWIEBACK_FOMAX", + "CLIENT_ADS_MOBILE_ZWIEBACK_FOMAX", + "CLIENT_ADS_DESKTOP_GAIA_FOMAX", + "CLIENT_ADS_MOBILE_GAIA_FOMAX", + "CLIENT_GWS_NONTLD_DESKTOP_ZWIEBACK_FOMAX", + "CLIENT_GWS_NONTLD_DESKTOP_GAIA_FOMAX", + "CLIENT_GWS_NONTLD_MOBILE_ZWIEBACK_FOMAX", + "CLIENT_GWS_NONTLD_MOBILE_GAIA_FOMAX", + "CLIENT_ASSISTANT_NONTLD_MOBILE_ZWIEBACK_FOMAX", + "CLIENT_ASSISTANT_NONTLD_DESKTOP_ZWIEBACK_FOMAX", + "CLIENT_ASSISTANT_NONTLD_MOBILE_GAIA_FOMAX", + "CLIENT_ASSISTANT_NONTLD_DESKTOP_GAIA_FOMAX", + "CLIENT_GWS_TLD_MOBILE_ZWIEBACK_GEMINI", + "CLIENT_GWS_TLD_DESKTOP_ZWIEBACK_GEMINI", + "CLIENT_GWS_TLD_MOBILE_GAIA_GEMINI", + "CLIENT_GWS_TLD_DESKTOP_GAIA_GEMINI", + "CLIENT_ADS_DESKTOP_ZWIEBACK_GEMINI", + "CLIENT_ADS_MOBILE_ZWIEBACK_GEMINI", + "CLIENT_ADS_DESKTOP_GAIA_GEMINI", + "CLIENT_ADS_MOBILE_GAIA_GEMINI", + "CLIENT_GWS_NONTLD_DESKTOP_ZWIEBACK_GEMINI", + "CLIENT_GWS_NONTLD_DESKTOP_GAIA_GEMINI", + "CLIENT_GWS_NONTLD_MOBILE_ZWIEBACK_GEMINI", + "CLIENT_GWS_NONTLD_MOBILE_GAIA_GEMINI", + "CLIENT_ASSISTANT_NONTLD_DESKTOP_ZWIEBACK_GEMINI", + "CLIENT_ASSISTANT_NONTLD_DESKTOP_GAIA_GEMINI", + "CLIENT_ASSISTANT_NONTLD_MOBILE_ZWIEBACK_GEMINI", + "CLIENT_ASSISTANT_NONTLD_MOBILE_GAIA_GEMINI", + "CLIENT_GWS_TLD_MOBILE_ZWIEBACK_HERCULES", + "CLIENT_GWS_TLD_DESKTOP_ZWIEBACK_HERCULES", + "CLIENT_GWS_TLD_MOBILE_GAIA_HERCULES", + "CLIENT_GWS_TLD_DESKTOP_GAIA_HERCULES", + "CLIENT_ADS_DESKTOP_ZWIEBACK_HERCULES", + "CLIENT_ADS_MOBILE_ZWIEBACK_HERCULES", + "CLIENT_ADS_DESKTOP_GAIA_HERCULES", + "CLIENT_ADS_MOBILE_GAIA_HERCULES", + "CLIENT_GWS_NONTLD_DESKTOP_ZWIEBACK_HERCULES", + "CLIENT_GWS_NONTLD_DESKTOP_GAIA_HERCULES", + "CLIENT_GWS_NONTLD_MOBILE_ZWIEBACK_HERCULES", + "CLIENT_GWS_NONTLD_MOBILE_GAIA_HERCULES", + "CLIENT_ASSISTANT_NONTLD_DESKTOP_ZWIEBACK_HERCULES", + "CLIENT_ASSISTANT_NONTLD_DESKTOP_GAIA_HERCULES", + "CLIENT_ASSISTANT_NONTLD_MOBILE_ZWIEBACK_HERCULES", + "CLIENT_ASSISTANT_NONTLD_MOBILE_GAIA_HERCULES", + "CLIENT_GWS_TLD_MOBILE_ZWIEBACK_INDUS", + "CLIENT_GWS_TLD_DESKTOP_ZWIEBACK_INDUS", + "CLIENT_GWS_TLD_MOBILE_GAIA_INDUS", + "CLIENT_GWS_TLD_DESKTOP_GAIA_INDUS", + "CLIENT_ADS_DESKTOP_ZWIEBACK_INDUS", + "CLIENT_ADS_MOBILE_ZWIEBACK_INDUS", + "CLIENT_ADS_DESKTOP_GAIA_INDUS", + "CLIENT_ADS_MOBILE_GAIA_INDUS", + "CLIENT_GWS_NONTLD_DESKTOP_ZWIEBACK_INDUS", + "CLIENT_GWS_NONTLD_DESKTOP_GAIA_INDUS", + "CLIENT_GWS_NONTLD_MOBILE_ZWIEBACK_INDUS", + "CLIENT_GWS_NONTLD_MOBILE_GAIA_INDUS", + "CLIENT_ASSISTANT_NONTLD_DESKTOP_ZWIEBACK_INDUS", + "CLIENT_ASSISTANT_NONTLD_DESKTOP_GAIA_INDUS", + "CLIENT_ASSISTANT_NONTLD_MOBILE_ZWIEBACK_INDUS", + "CLIENT_ASSISTANT_NONTLD_MOBILE_GAIA_INDUS", + "CLIENT_GWS_TLD_MOBILE_ZWIEBACK_LEO", + "CLIENT_GWS_TLD_DESKTOP_ZWIEBACK_LEO", + "CLIENT_GWS_TLD_MOBILE_GAIA_LEO", + "CLIENT_GWS_TLD_DESKTOP_GAIA_LEO", + "CLIENT_ADS_DESKTOP_ZWIEBACK_LEO", + "CLIENT_ADS_MOBILE_ZWIEBACK_LEO", + "CLIENT_ADS_DESKTOP_GAIA_LEO", + "CLIENT_ADS_MOBILE_GAIA_LEO", + "CLIENT_GWS_NONTLD_DESKTOP_ZWIEBACK_LEO", + "CLIENT_GWS_NONTLD_DESKTOP_GAIA_LEO", + "CLIENT_GWS_NONTLD_MOBILE_ZWIEBACK_LEO", + "CLIENT_GWS_NONTLD_MOBILE_GAIA_LEO", + "CLIENT_ASSISTANT_NONTLD_DESKTOP_ZWIEBACK_LEO", + "CLIENT_ASSISTANT_NONTLD_DESKTOP_GAIA_LEO", + "CLIENT_ASSISTANT_NONTLD_MOBILE_ZWIEBACK_LEO", + "CLIENT_ASSISTANT_NONTLD_MOBILE_GAIA_LEO", + "CLIENT_GWS_TLD_MOBILE_ZWIEBACK_MENSA", + "CLIENT_GWS_TLD_DESKTOP_ZWIEBACK_MENSA", + "CLIENT_GWS_TLD_MOBILE_GAIA_MENSA", + "CLIENT_GWS_TLD_DESKTOP_GAIA_MENSA", + "CLIENT_ADS_DESKTOP_ZWIEBACK_MENSA", + "CLIENT_ADS_MOBILE_ZWIEBACK_MENSA", + "CLIENT_ADS_DESKTOP_GAIA_MENSA", + "CLIENT_ADS_MOBILE_GAIA_MENSA", + "CLIENT_GWS_NONTLD_DESKTOP_ZWIEBACK_MENSA", + "CLIENT_GWS_NONTLD_DESKTOP_GAIA_MENSA", + "CLIENT_GWS_NONTLD_MOBILE_ZWIEBACK_MENSA", + "CLIENT_GWS_NONTLD_MOBILE_GAIA_MENSA", + "CLIENT_ASSISTANT_NONTLD_DESKTOP_ZWIEBACK_MENSA", + "CLIENT_ASSISTANT_NONTLD_DESKTOP_GAIA_MENSA", + "CLIENT_ASSISTANT_NONTLD_MOBILE_ZWIEBACK_MENSA", + "CLIENT_ASSISTANT_NONTLD_MOBILE_GAIA_MENSA", + "CLIENT_GWS_TLD_MOBILE_ZWIEBACK_NORMA", + "CLIENT_GWS_TLD_DESKTOP_ZWIEBACK_NORMA", + "CLIENT_GWS_TLD_MOBILE_GAIA_NORMA", + "CLIENT_GWS_TLD_DESKTOP_GAIA_NORMA", + "CLIENT_ADS_DESKTOP_ZWIEBACK_NORMA", + "CLIENT_ADS_MOBILE_ZWIEBACK_NORMA", + "CLIENT_ADS_DESKTOP_GAIA_NORMA", + "CLIENT_ADS_MOBILE_GAIA_NORMA", + "CLIENT_GWS_NONTLD_DESKTOP_ZWIEBACK_NORMA", + "CLIENT_GWS_NONTLD_DESKTOP_GAIA_NORMA", + "CLIENT_GWS_NONTLD_MOBILE_ZWIEBACK_NORMA", + "CLIENT_GWS_NONTLD_MOBILE_GAIA_NORMA", + "CLIENT_ASSISTANT_NONTLD_MOBILE_ZWIEBACK_NORMA", + "CLIENT_ASSISTANT_NONTLD_DESKTOP_ZWIEBACK_NORMA", + "CLIENT_ASSISTANT_NONTLD_MOBILE_GAIA_NORMA", + "CLIENT_ASSISTANT_NONTLD_DESKTOP_GAIA_NORMA", + "CLIENT_GWS_TLD_MOBILE_ZWIEBACK_ORION", + "CLIENT_GWS_TLD_DESKTOP_ZWIEBACK_ORION", + "CLIENT_GWS_TLD_MOBILE_GAIA_ORION", + "CLIENT_GWS_TLD_DESKTOP_GAIA_ORION", + "CLIENT_ADS_DESKTOP_ZWIEBACK_ORION", + "CLIENT_ADS_MOBILE_ZWIEBACK_ORION", + "CLIENT_ADS_DESKTOP_GAIA_ORION", + "CLIENT_ADS_MOBILE_GAIA_ORION", + "CLIENT_GWS_NONTLD_DESKTOP_ZWIEBACK_ORION", + "CLIENT_GWS_NONTLD_DESKTOP_GAIA_ORION", + "CLIENT_GWS_NONTLD_MOBILE_ZWIEBACK_ORION", + "CLIENT_GWS_NONTLD_MOBILE_GAIA_ORION", + "CLIENT_ASSISTANT_NONTLD_DESKTOP_ZWIEBACK_ORION", + "CLIENT_ASSISTANT_NONTLD_DESKTOP_GAIA_ORION", + "CLIENT_ASSISTANT_NONTLD_MOBILE_ZWIEBACK_ORION", + "CLIENT_ASSISTANT_NONTLD_MOBILE_GAIA_ORION", + "CLIENT_GWS_TLD_MOBILE_ZWIEBACK_PISCES", + "CLIENT_GWS_TLD_DESKTOP_ZWIEBACK_PISCES", + "CLIENT_GWS_TLD_MOBILE_GAIA_PISCES", + "CLIENT_GWS_TLD_DESKTOP_GAIA_PISCES", + "CLIENT_ADS_DESKTOP_ZWIEBACK_PISCES", + "CLIENT_ADS_MOBILE_ZWIEBACK_PISCES", + "CLIENT_ADS_DESKTOP_GAIA_PISCES", + "CLIENT_ADS_MOBILE_GAIA_PISCES", + "CLIENT_GWS_NONTLD_DESKTOP_ZWIEBACK_PISCES", + "CLIENT_GWS_NONTLD_DESKTOP_GAIA_PISCES", + "CLIENT_GWS_NONTLD_MOBILE_ZWIEBACK_PISCES", + "CLIENT_GWS_NONTLD_MOBILE_GAIA_PISCES", + "CLIENT_ASSISTANT_NONTLD_DESKTOP_ZWIEBACK_PISCES", + "CLIENT_ASSISTANT_NONTLD_DESKTOP_GAIA_PISCES", + "CLIENT_ASSISTANT_NONTLD_MOBILE_ZWIEBACK_PISCES", + "CLIENT_ASSISTANT_NONTLD_MOBILE_GAIA_PISCES", + "CLIENT_GWS_TLD_MOBILE_ZWIEBACK_RETICULUM", + "CLIENT_GWS_TLD_DESKTOP_ZWIEBACK_RETICULUM", + "CLIENT_GWS_TLD_MOBILE_GAIA_RETICULUM", + "CLIENT_GWS_TLD_DESKTOP_GAIA_RETICULUM", + "CLIENT_ADS_DESKTOP_ZWIEBACK_RETICULUM", + "CLIENT_ADS_MOBILE_ZWIEBACK_RETICULUM", + "CLIENT_ADS_DESKTOP_GAIA_RETICULUM", + "CLIENT_ADS_MOBILE_GAIA_RETICULUM", + "CLIENT_GWS_NONTLD_DESKTOP_ZWIEBACK_RETICULUM", + "CLIENT_GWS_NONTLD_DESKTOP_GAIA_RETICULUM", + "CLIENT_GWS_NONTLD_MOBILE_ZWIEBACK_RETICULUM", + "CLIENT_GWS_NONTLD_MOBILE_GAIA_RETICULUM", + "CLIENT_ASSISTANT_NONTLD_DESKTOP_ZWIEBACK_RETICULUM", + "CLIENT_ASSISTANT_NONTLD_DESKTOP_GAIA_RETICULUM", + "CLIENT_ASSISTANT_NONTLD_MOBILE_ZWIEBACK_RETICULUM", + "CLIENT_ASSISTANT_NONTLD_MOBILE_GAIA_RETICULUM", + "CLIENT_GWS_TLD_MOBILE_ZWIEBACK_SAGITTARIUS", + "CLIENT_GWS_TLD_DESKTOP_ZWIEBACK_SAGITTARIUS", + "CLIENT_GWS_TLD_MOBILE_GAIA_SAGITTARIUS", + "CLIENT_GWS_TLD_DESKTOP_GAIA_SAGITTARIUS", + "CLIENT_ADS_DESKTOP_ZWIEBACK_SAGITTARIUS", + "CLIENT_ADS_MOBILE_ZWIEBACK_SAGITTARIUS", + "CLIENT_ADS_DESKTOP_GAIA_SAGITTARIUS", + "CLIENT_ADS_MOBILE_GAIA_SAGITTARIUS", + "CLIENT_GWS_NONTLD_DESKTOP_ZWIEBACK_SAGITTARIUS", + "CLIENT_GWS_NONTLD_DESKTOP_GAIA_SAGITTARIUS", + "CLIENT_GWS_NONTLD_MOBILE_ZWIEBACK_SAGITTARIUS", + "CLIENT_GWS_NONTLD_MOBILE_GAIA_SAGITTARIUS", + "CLIENT_ASSISTANT_NONTLD_DESKTOP_ZWIEBACK_SAGITTARIUS", + "CLIENT_ASSISTANT_NONTLD_DESKTOP_GAIA_SAGITTARIUS", + "CLIENT_ASSISTANT_NONTLD_MOBILE_ZWIEBACK_SAGITTARIUS", + "CLIENT_ASSISTANT_NONTLD_MOBILE_GAIA_SAGITTARIUS", + "CLIENT_GWS_TLD_MOBILE_ZWIEBACK_TAURUS", + "CLIENT_GWS_TLD_DESKTOP_ZWIEBACK_TAURUS", + "CLIENT_GWS_TLD_MOBILE_GAIA_TAURUS", + "CLIENT_GWS_TLD_DESKTOP_GAIA_TAURUS", + "CLIENT_ADS_DESKTOP_ZWIEBACK_TAURUS", + "CLIENT_ADS_MOBILE_ZWIEBACK_TAURUS", + "CLIENT_ADS_DESKTOP_GAIA_TAURUS", + "CLIENT_ADS_MOBILE_GAIA_TAURUS", + "CLIENT_GWS_NONTLD_DESKTOP_ZWIEBACK_TAURUS", + "CLIENT_GWS_NONTLD_DESKTOP_GAIA_TAURUS", + "CLIENT_GWS_NONTLD_MOBILE_ZWIEBACK_TAURUS", + "CLIENT_GWS_NONTLD_MOBILE_GAIA_TAURUS", + "CLIENT_ASSISTANT_NONTLD_DESKTOP_ZWIEBACK_TAURUS", + "CLIENT_ASSISTANT_NONTLD_DESKTOP_GAIA_TAURUS", + "CLIENT_ASSISTANT_NONTLD_MOBILE_ZWIEBACK_TAURUS", + "CLIENT_ASSISTANT_NONTLD_MOBILE_GAIA_TAURUS", + "CLIENT_GWS_TLD_MOBILE_ZWIEBACK_URSA_MAJOR", + "CLIENT_GWS_TLD_DESKTOP_ZWIEBACK_URSA_MAJOR", + "CLIENT_GWS_TLD_MOBILE_GAIA_URSA_MAJOR", + "CLIENT_GWS_TLD_DESKTOP_GAIA_URSA_MAJOR", + "CLIENT_ADS_DESKTOP_ZWIEBACK_URSA_MAJOR", + "CLIENT_ADS_MOBILE_ZWIEBACK_URSA_MAJOR", + "CLIENT_ADS_DESKTOP_GAIA_URSA_MAJOR", + "CLIENT_ADS_MOBILE_GAIA_URSA_MAJOR", + "CLIENT_GWS_NONTLD_DESKTOP_ZWIEBACK_URSA_MAJOR", + "CLIENT_GWS_NONTLD_DESKTOP_GAIA_URSA_MAJOR", + "CLIENT_GWS_NONTLD_MOBILE_ZWIEBACK_URSA_MAJOR", + "CLIENT_GWS_NONTLD_MOBILE_GAIA_URSA_MAJOR", + "CLIENT_ASSISTANT_NONTLD_DESKTOP_ZWIEBACK_URSA_MAJOR", + "CLIENT_ASSISTANT_NONTLD_DESKTOP_GAIA_URSA_MAJOR", + "CLIENT_ASSISTANT_NONTLD_MOBILE_ZWIEBACK_URSA_MAJOR", + "CLIENT_ASSISTANT_NONTLD_MOBILE_GAIA_URSA_MAJOR", + "CLIENT_GWS_TLD_MOBILE_ZWIEBACK_VIRGO", + "CLIENT_GWS_TLD_DESKTOP_ZWIEBACK_VIRGO", + "CLIENT_GWS_TLD_MOBILE_GAIA_VIRGO", + "CLIENT_GWS_TLD_DESKTOP_GAIA_VIRGO", + "CLIENT_ADS_DESKTOP_ZWIEBACK_VIRGO", + "CLIENT_ADS_MOBILE_ZWIEBACK_VIRGO", + "CLIENT_ADS_DESKTOP_GAIA_VIRGO", + "CLIENT_ADS_MOBILE_GAIA_VIRGO", + "CLIENT_GWS_NONTLD_DESKTOP_ZWIEBACK_VIRGO", + "CLIENT_GWS_NONTLD_DESKTOP_GAIA_VIRGO", + "CLIENT_GWS_NONTLD_MOBILE_ZWIEBACK_VIRGO", + "CLIENT_GWS_NONTLD_MOBILE_GAIA_VIRGO", + "CLIENT_ASSISTANT_NONTLD_DESKTOP_ZWIEBACK_VIRGO", + "CLIENT_ASSISTANT_NONTLD_DESKTOP_GAIA_VIRGO", + "CLIENT_ASSISTANT_NONTLD_MOBILE_ZWIEBACK_VIRGO", + "CLIENT_ASSISTANT_NONTLD_MOBILE_GAIA_VIRGO", + "CLIENT_LOGGED_CONTEXT", + "CLIENT_IPGEO_REGION", + "CLIENT_IPGEO_EVAL", + "CLIENT_GWS_TACTILE_INITIAL_VIEWPORT", + "CLIENT_GWS_MAPS_DESKTOP", + "CLIENT_GWS_MAPS_MOBILE", + "CLIENT_GWS_GMM_LOCATION_SHIFT", + "CLIENT_GWS_NONTLD_MAPS_DESKTOP_GAIA", + "CLIENT_GWS_NONTLD_MAPS_DESKTOP_ZWIEBACK", + "CLIENT_GWS_TLD_MAPS_DESKTOP_GAIA", + "CLIENT_GWS_TLD_MAPS_DESKTOP_ZWIEBACK", + "CLIENT_GWS_TLD_MAPS_MOBILE_GAIA", + "CLIENT_GWS_TLD_MAPS_MOBILE_ZWIEBACK", + "CLIENT_GWS_NONTLD_MAPS_DESKTOP_EXPERIMENTAL", + "CLIENT_GWS_NONTLD_MAPS_MOBILE_EXPERIMENTAL", + "CLIENT_SESSIONS", + "CLIENT_MANUAL", + "CLIENT_NONTLD_DEFAULT", + "CLIENT_NO_LOCATION", + "CLIENT_ONLY_LEGAL", + "CLIENT_TESTING", + "CLIENT_COARSEN_ALL_TESTING", + "CLIENT_GWS_TLD_DESKTOP_ORACLE", + "CLIENT_GWS_TLD_MOBILE_ORACLE", + "CLIENT_GWS_NONTLD_DESKTOP_ORACLE", + "CLIENT_GWS_NONTLD_MOBILE_ORACLE", + "CLIENT_COMPARE_DL", + "CLIENT_COMPARE_IP", + "CLIENT_COMPARE_IPDL", + "CLIENT_MAGICEYE_DIMENSIONS", + "CLIENT_MAPS_GUIDE_DIRECTIONS", + "CLIENT_SAFE_BROWSING", + "CLIENT_GWS_NONTLD_DESKTOP", + "CLIENT_GWS_NONTLD_MOBILE" + ], + "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, + 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, + 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, + 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, + 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, + 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, + 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, + 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, + 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, + 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, + 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, + 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, + 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, + 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, + 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, + true + ], + "enumDescriptions": [ + "Unset client ID. Never use it in production code.", + "Curio team (go/curio). Contact: curio-team@.", + "OneGoogle Service (OGS): OGS will fetch the LocationContext for the frontends that have not talked to LES yet.", + "Client id used by evaluation tools. Contact: davidreis@", + "Same as CLIENT_EVALS, but less strict, so can be used to avoid a hack when some use cases needed to send the request twice with different client ID. Contact: bohdant@", + "Client id used by go/unified-query-sourcing. Contact: query-sampling-team@", + "Client id used by Play Books. Contact: ocean-team@", + "Client id used by Bond team. Contact: sterman@ and/or id-devices-eng@", + "Client id used by Chrome User Metrics Analysis (UMA, go/chrome-data)", + "Client id used by DoubleClick Search. Contact: wdtseng@, ds3data@, go/ds", + "Client id used by youtube QoE frontend. Contact: pfish@, kathyqian@, qoe-team@", + "Client id used by youtube Real-Time QoE. Contact: jeffcohen@, tnavien@, qoe-team@", + "Client id used by youtube QoE Livyatan. Contact: kathyqian@, gaozhiquan@, qoe-team@", + "Client id used by YouTube serving frontend and shared by all downstreams of the frontend server. Contact: tubbs@, yt-serving-platform@", + "Client ids used by YouTube Shorts. See go/oolong-changes-for-yt-le for details.", + "", + "", + "", + "Client ids used by Youtube Viral.", + "", + "", + "", + "", + "Client ids used by Youtube Viral Experiments. See go/ul-experimental-slots for description.", + "", + "", + "", + "Client ids used by Youtube Viral Experiments. See go/ul-experimental-slots for description.", + "", + "", + "", + "Client ids used by Youtube Viral Experiments. See go/ul-experimental-slots for description.", + "", + "", + "", + "Client ids used by Youtube Viral Experiments. See go/ul-experimental-slots for description.", + "", + "", + "", + "Client id used by YouTube admin review tools. Contact: yurt-eng@", + "Client id used by YouTube Bad Harvest (go/badharvest). Contact: bad-harvest-eng@", + "Client id used by the speech team. Contact: xuedong@", + "Client id used by Gmail team. Contact: shine@, lianglin@", + "Client id used by Gmail/Spam. Contact: gmail-spam-eng@", + "Client id used by chromecast web interface. Contact: pierred@, bquinlan@, eureka-team@", + "Defaults to NONTLD_DEFAULT Contact: jamesjw@, pancetta-eng@", + "Client id used by GLS (Google Location Server) Contact: lmohanan@, tsuwei@, lbs-team@", + "Contact: feedback-eng@", + "Client id used by Android Metrics team. Contact: androidmetrics-eng@", + "Client id used by AdWords Usermgmt (go/usermgmt). Contact: timthom@, ads-usermgmt-eng@", + "Client id used by appremoting VM management stack which is further used by Looking Glass and Developer Shell products. Contact: looking-glass-team@, hekate-eng@.", + "Client id used by the login protections server. (go/hijacking) Contact: hijacking-eng@, danmogo@.", + "Client id used by Actionable IPs. (go/actionable-ips). Contact: amirha@, ncmec-actionableips-eng@.", + "Client id used by Display Ads. Contact: local-display@.", + "CLIENT_DISPLAY_ADS_DEFAULT is the same as CLIENT_DISPLAY_ADS, but excludes postal code trimming. This client is used to make the ProcessLocationContext call.", + "", + "", + "", + "", + "Client id used by Display Ads Preview Service. Contact: fletch-eng@.", + "Client id used by Hobbes(go/hobbes). Contact: hobbes-team@google.com", + "Client id used by Newsstand(go/dots). Contact: gnews-infra@.", + "", + "Client id used by Panoptic (News Ranking + Backend) Contact: polynews-eng@.", + "Client id used by Google Docs. Contact: doplar-eng@, jameshong@", + "Client id used by AdWords Express. Contact: boost-eng@, stephenleung@", + "Client id used by TraceDepot server. Contact: tibrewal@, kjs@", + "Client id used by MapsPro Contact: obrien@, jiazheng@", + "Client id used by Madden (go/madden) Contact: madden-eng@", + "Client id used by AccessFilter Contact: ishwarya@", + "Client id used by Google Domains (go/domain-registrar) Contact: domain-registrar-eng@", + "Client id used by Google Assistant (go/opa) Contact: assistant-infra-core@", + "", + "Client id user by Google Account Linking (go/account-linking) Contact: account-linking-team@", + "Client id used by Legal Removals. Contact: legal-removals-eng@", + "Client id used by Cloud Console (Pantheon) Contact: paninfra-sfo@.", + "Client id used by Cloud New User for Free Trial Contact: coe-nu-eng@", + "Client id used by Solutions Catalog Contact: coe-solutions@", + "Client id used by cloud media access team, go/cloud-media-access Contact: cloud-media-access-team@", + "Client id used by Dotorg G4NP Contact: g4np-eng@", + "Client id used by Crash Internal Contact: crash-team@", + "Client id used by Monlog in access/infrastructure Contact: monlog-eng@", + "Client id used by GoogleVoice Contact: voice-eng@", + "Client id used by Blogger Contact: blogger-tech@, eitzenb@", + "Thor/Google Meet backend. Contact: comms-work-backend-team@.", + "Client id used by News Contact: news-frontend-eng-team@.", + "Client id used by Google Photos", + "Client id used by Google Photos for inferred location tagging.", + "Client id used by RankBrain Debug (go/rankbrain-debug).", + "Client id used by Heterodyne (go/heterodyne) Contact: ph-eng@", + "Client id used by fraudreview (go/fraudreview) Contact: pf-review-tools@", + "Client id used by Jamboard (go/jamboard) for go/jamboard-scheduled-otas Contact: jamboard-eng@", + "Client id used by Marconi (go/marconi) Contact: marconi-eng@", + "Client id used by Aart (go/aart-docs) Contact: aart-team@", + "Client id used by the Google Arts And Culture (go/artsandculture) Contact: ci-eng@", + "Client id used by Youtube Ecommerce (go/ypc) Contact: ytr-eng@", + "Client id used by Ares managed feature providers (go/project-ares) Contact: ares-eng@", + "Client id used by LIS and the UUDE framework (go/uude) Contact: lis-eng@", + "Client id used by Google Store smashberry (go/smashberry) Contact: smashberry-eng@", + "Client id used by Dasher Auditing (go/dasher-auditing) Contact: dasher-auditing-eng@", + "Client id used by the Shopping List Server (go/shopping-list-server) Contact: shoppinglist-eng@", + "Client ID used by the Drive Item Suggest service (go/itemsuggest)", + "Client ID used by Smart Books (go/smart-books) Contact: smart-books-team@", + "Client ID used by GRADS (go/grads)", + "Client ID used by AdsRoot (go/adsroot)", + "Client ID used by Service Engine (go/seroot)", + "Client ID used by Orbit (go/ytorbit)", + "Client ID used by Project Fi (nova). This client was initially created for Nova aperture (go/aperture) but all Nova clients are recommended to use this one.", + "Client ID used by Lena Signup Defaults (go/lena-prd)", + "Client ID used by the Play Console (go/fc) Contact: play-dev-console-platform@", + "Client ID used by Finsky Enterprise (go/pfw)", + "Client ID used by Google Admin (go/google-admin)", + "Client ID used by CryptAuth (go/cryptauth, go/authzen-pdd, go/gnubby-pdd)", + "Client ID used by the GsaUniversalServer (go/gus)", + "Client ID used by the TravelFrontendTransitServer web app.", + "Client ID used by Home Cloud services (go/home-cloud)", + "Client ID used by Google Shopping Express (go/gsx)", + "Client ID used by Google Duo (go/duo)", + "Client ID used by Gaia Frontend (go/gaiafe)", + "Client ID used by Android Messages (go/bugle)", + "Client ID used by Google Lens (go/lens) Contact: lens-frontend-server-eng@", + "Client ID used by Chrome Web Store (go/cws)", + "Client ID used by Actions on Google console (go/aog-console) Contact: actions-on-google-console-eng@", + "Client ID used by Android TV Channels (go/android-tv-channels)", + "Client ID used by Assistant Web Settings (go/assistant-settings-web-ui-design)", + "Client ID used by Play User Data Server (go/play-user-data-server)", + "Client ID used by Ads Integrity (go/ads-integrity) Contact: ads-integrity-risk@", + "Client ID used by Ragnarok (go/ragnarok) Contact: ads-integrity-wat@", + "Client ID used by Firebase Console (go/fireconsole) Contact: fireconsole-contrib@", + "Client ID used by AoG Feed Validator (http://go/aog-feed-validator)", + "Client ID used by Plumeria (go/plumeria-legal-eng-intro) Contact: plumeria-eng@", + "Client ID used by Paisa (http://go/paisa) Contact: paisa-eng@", + "Client ID used by Google Pay (go/googlepay)", + "Client ID used by the Google Pay web serving stack.", + "Client ID used by Google Wallet (go/wallet)", + "Client ID used by Scroogled (go/scroogled). Contact: hijacking-team@.", + "Client ID used by Waymo ride-hailing services. Client referenced in a silo: waymo/taas/frontend3/handlers/test_base.cc Contact: taas-offboard@, chauffeur-hailing@", + "Client ID used by CROW team. Contact: crow-team@", + "Client ID used by the Security Investigation Tool of GSuite Security Center(go/security-investigation-tool). Contact: gsc-sit-eng@", + "Client ID used by the Event Threat Detection team (go/etd). Contact: etd-team@", + "Client ID used by Play Location Server (go/play-location-server). Contact: play-experiment-team@", + "Client ID used by Footplacer (go/footplacer). Contact: footplacer-eng@", + "used by dasher commerce team (go/acom) Contact: dasher-commerce-eng@", + "Client ID used by Social People Analytics (go/spa-docs). Contact: social-people-analytics@", + "Client ID used by Contacts UI surfaces (go/web-contacts). Contact: contactsplus-eng@, custard-eng@", + "Client ID used by Google Analytics (go/gafe4). Contact: gafe4-eng+code@", + "Client ID used by Places API (go/places-api). Contact: geo-enterprise-metrics@", + "", + "Client ID used by Drive Web Frontend. Contact: drive-frontend-eng@", + "Client ID used by Android OTA (go/android-ota). Contact: android-auto-ota-dev@", + "Clients of nearby stores. Contact: payments-microapps-pek-team@", + "Clients used by Fiber Address Service (gfiber-weaver-infra-team@).", + "Client ID used by Support Content (go/supportcontent) Contact: support-content-eng@", + "Logging anonymization for Offroad (GMM offline) search/suggest.", + "Client id used by Google Ads Change History (go/ch). Contact: leonxie@, kluo@, ch-dev@", + "Client ID used by Session Risk (go/session-risk). Contact: session-protection-eng@", + "Client ID used by Alps (go/alps). Contact: address-understanding-team@", + "Client ID used by discover for resolving locations according to the user's news preferences. Contact: newsx@", + "Client Id for Assistant Snapshot.", + "Client ID used by Area 120 Honeycomb (go/honeycomb) Contact: honeycomb-eng@", + "Client ID used by Play Monetary Abuse service to detect location abuse. Contact: play-monetary-abuse@", + "Client ID used by Small Business Advisors (GMB Assisted Activation). Contact: gmb-assisted-activation@", + "Client ID used by GPA Feeds Ingestion. Contact: gpa-feeds-eng@", + "Client ID used by EDU originality reports (go/plagiarism). Contact: plagiarism-eng@", + "Client ID used by Paidtasks to grab user ipgeo information. Contact: 402-eng@", + "Client ID used by Translate for country level IPGeo. Contact: website-translation-team@", + "Client ID used by Funding Choices to determine the legal jurisdiction that a user belongs to, for example, GDPR (EEA) or CCPA (California), etc. More information: go/funding-choices Contact: oncall/xads, funding-choices-eng-core@", + "Client ID used by Search Notifications (go/sno). Contact: now-push-eng-team@", + "Client ID used by Visual Semantic Service (go/vss). Contact: vss-team@", + "Client ID used by the Chrome Prefetch Proxy (go/chrome-p4)", + "Wear OS clients Contact: wear-lon-backend@", + "Client ID used by Payments Risk (go/risk-eng) Contact: payments-risk-team@", + "Client ID used by Payments Orchestration/Orchestration2 server (go/o2) Contact: payments-orchestration-eng@", + "Client ID used by Android TV IRDB (go/sabrina-irdb-service) Contact: project-axel-eng@", + "Client ID used by Trends (go/trends-eng) Contact: trends@", + "Client ID used by Colab (go/colab) Contact: colab-team@", + "Client ID for Socratic (go/bloom) Contact: bloom-edu-eng@", + "Client ID for go/ps1-location Contact: location-infra@", + "Client ID for DDM Reporting Processing go/proc Contact: ddm-reporting-stateless@", + "Client ID for go/hr-be Contact: homeroom-backend@", + "Client ID for cars categorical Contact: cars-eng@", + "Client ID used by Gpay MerchantVerticals VerticalsDiscoveryService go/vertical-discovery Contact: merchant-verticals-discovery-eng@", + "Client ID used by reCAPTCHA's Account Protections team. Shared ID used by both Account Defender and SMS Fraud Detection services. go/recaptcha-account-defender-u-bad Contact: recaptcha-account-protections@", + "Client ID used by reCAPTCHA Lite. go/recaptcha-asn-reputation-design-doc Contact: recaptcha-waf-eng@", + "Client ID used by reCAPTCHA Fraud Prevention. go/recaptcha-fraud-geocoding Contact: recatpcha-fraud@", + "Client ID used by AutoNT DNS mapchecker module. go/autont Contact: autont-team@", + "Client ID used by Transparency for All Ads Report. go/tfaar Contact: tfaa-report-eng@", + "Client ID used by GCIP Location Service. go/cicp-team Contact: cicp-eng@", + "Client ID used by OneStack Metric Collection service.", + "Client ID used by GPay Transit TapAndPay Frontend Service go/transit-recommended-agencies Contact: tp2-transit-eng@", + "Client ID used by Chronicle Security (go/malachite). go/chronicle:theres-waldo Contact: malachite-dip-engg@ Contact: malachite-eng@", + "Client ID used by the UI for Chronicle Security (go/malachite). go/chronicle-i18n-design Contact: chronicle-ui@ Contact: malachite-eng@", + "Client ID used by GPay Merchant Spot Onboarding Tool (b/186640782). Contact: gtech-google-pay-food-fte@ Contact: edisonc@", + "Client ID used by Ads scraping tool owned by Ads ExpandedMatch. go/ads-scraping-tool Contact: ads-expmatch-eng@", + "Client ID for cloud support portal frontend go/xpp-lite Contact: xpp-eng@", + "Client ID used by the LaMDA team. Contact: srrvnn@, lamda-team@ // NOTYPO NOTYPO", + "Client ID used by Access Redirection Service. (go/redirection-service) contact: access-sre-fe@google.com", + "Client ID used by Pinpoint (go/jsuite-pinpoint) Contact: backlight-eng@", + "Client ID used by Google Shopping Order History (go/shopping-order-history)", + "Client ID used by Nest camera cloud team contact: nest-camera-cloud@google.com", + "Client ID used by Panoptic SxS contact: yukang@, deepakverma@, local-fcr@google.com", + "Client ID used for About This Page external API. contact: beaton, diner-team@, go/project-diner", + "Client ID used for the Photos Analytics marketing pipeline. contact: guillo, photos-analytics@", + "Client ID for the gmscompliance server (UDEVS) contact: gmscore-trust-team@google.com", + "Client ID for Analytics Collection contact: tag-serving-eng@, go/tag-serving", + "Client ID for play console android vitals contact: play-dev-quality-all@google.com", + "Client ID for crashlytics play console crashes contact: play-dev-quality-all@google.com", + "Client ID for Payments Merchant Stories contact: merry-eng@, go/merry", + "Client ID for Cloudtop Connectivity contact: cloudtop-eng@, go/cloudtop", + "Client ID for Cloud Web (cloud.google.com) contact: cloudx-platform-eng@", + "Client for go/speakeasy-meet-consent-frontend Contact: ccp-pegasus@", + "Client for Display & Video 360 (DV3, Xbid) frontend. Contact: qypeng@, xbid-fe-eng@", + "Client for lending data manager. Contact: nest-data-infra-eng@", + "Client for ChromeOS Data Fresnel service. Contact: chromeos-data-eng@", + "Client for PPN team to provide VPN service.", + "Client ID used by Geo API Platform (go/geo:api). Contact: geo-apis-platform@", + "Client for Google One security to access Oolong data. Contact: g1-security-eng@", + "Client ID used by the Google TV Web player (go/lava) Contact: lava-eng@", + "Client ID used by the dynamite server. Contact: dynamite-eng@", + "Client ID used by the bce-client-connector. Contact: bce-client-connector-eng@", + "Client ID used by go/rde team pipeline. Contact: rde-team@.", + "Client ID used by Pinpoint UI tools (go/pinpoint). Contact: pinpoint-team@", + "Client ID for Corplogin Contact: sso-team@", + "Client ID for Monospace (go/monospace) Contact: monospace-team@", + "Client ID used by the Lighter (go/lighter). Contact: lighter-backend-eng@", + "Client ID used by P11 (go/p11-eng) Contact: eleven-sw-eng@", + "Client ID used by the new Find My Device website. Contact: fmd-eng@", + "Client ID used by Youtube TV. Contact: ott-platform-serving", + "Client ID used by Fitbit WebAccounts Contact fitbit-uam@", + "Client ID used for Chord (go/chord-g3doc) Contact: chord-eng@", + "Client ID used by Fitbit-Fi Contact fdp-gallery@", + "Client ID used by Google-Analytics-Serving Contact ga-gold-query-engine@", + "Client ID used by Google Fonts Contact fonts-eng@", + "Client ID used by project Bard Contact bard-team@", + "Client ID used by Nest Renew (go/apollo-eng) Contact apollo-energy-eng@", + "Client ID used by DeepMind Labs Contact deepmind-goodall@", + "Client ID used by One Presence Profiles Contact mcf-profiles-eng-team@", + "Client ID used by Transparency Report (go/transparency-eng) Contact: transparency-report-leads@", + "Client for Google One ML team to access Oolong data. Contact: g1-ml-eng@", + "Client for GMP Partner Gallery team to access Oolong data. Contact: gmppartnergallery-team@", + "Client for MakerSuite. Contact: makersuite-team@", + "Client for Ad Manager ToS Contact: drx-fe-infra@", + "Client ID for Chrome Remote Desktop. contact: chromotin-eng-team@, go/chromoting", + "Client for OSLO Soji (go/soji). Contact: soji-team@", + "Client ID for Workspace labs signup page. Contact: workspace-labs-signup-eng@", + "Client AIDA Contact: aida-api-team@", + "Client ID for Trust Signals Platform Contact: trust-signals-eng@", + "Client Id for AI Test Kitchen Contact: ai-sandbox-eng@", + "Client Id for Labs Tailwind Contact: labs-tailwind-eng-team@", + "Client Id for Gmail Task Assist. Contact: task-assist-eng@", + "Client Id for Pixel Weather service. Contact: pixel-apps-weather-boq-team@", + "Client Id for GPay Geo-based category billers. (go/gpay-category-biller-suggestions-design-doc) Contact: nityam-eng@, gpay-server-infra@", + "Client Id for Support Channels WhatsApp Zendesk integration. (go/cecsi-whatsapp-dd) Contact: voice-channels-eng@", + "Client ID used by Payments Anti-Financial Crimes Transaction Monitoring pipeline to fetch country-level IPGeo information.", + "Client ID for the offline batch pipeline creating the Discover query recommendation corpus.", + "Client id used by Preference Center (go/preference-center). Contact: preference-center-eng@", + "Client ID used by Developer Identity and Accounts Contact: play-dev-dia-epu@google.com.", + "Client ID used by GNP Online Evaluation Contact: gnp-ginger-eng@google.com", + "Client ID used by local suggested sets demo server (go/local-sets-demo-server-dd) Contact: local-sets-quality@", + "Client ID used by Search Labs Contact: search-labs-frontend@google.com", + "Client ID for Crowdsource Contact: crowdsource-eng@google.com", + "Client ID for Tarsier Contact: tarsier-team@google.com", + "Client Id for WorkSpace SideKick. Contact: kopi-eng@", + "Client id used by Google Photos for reminising features.", + "Client Id for Geox contamination. Contact: amt-geox-core@", + "Client Id for CloudMessageStore. Contact:tachyon-backend-eng@", + "Client Id for IP Protection Contact: ip-protection-team@", + "Client Id for Search MCF Hamsa. Contact: search-mcf-hamsa@", + "Client Id for Account Location (go/accountlocation). Contact emmett-eng@google.com, compliance-signals-eng@google.com", + "Client Id for Android Backup & Restore (http://go/br-home). Contact android-backup-server-eng@google.com", + "Client Id for Google Ads AWSM. Contact awsm-eng@google.com", + "Client Id for Stargate satellite messaging. Contact dune-server-eng-team@google.com", + "Client Id for Account Management (go/ams). Contact account-management-eng@google.com, compliance-signals-eng@google.com.", + "Client Id for User Account Creation (go/id-eco-infra:account-creation). Contact account-ecosystem-infra-team@google.com, compliance-signals-eng@google.com.", + "Client Id for Netsense (go/netsense). Contact trapdoor-team@google.com,", + "Client ID used by Fitbit Labs (go/fitbit-labs). Contact fitbit-labs-eng@", + "Client ID used by Local Services Ads. Contact sab-eng@", + "Client ID used by the User Feedback Service (go/user-feedback-service). Contact ads-integrity-transparency-team@", + "Client ID used by Bard/Gemini evals to spoof location data. Contact bard-eval-infra@ This should only be used with spoofed location data. For real user data, follow the onboarding steps at go/use-current-location", + "Client ID used by the Scenario-based Seeding Home & Work seeder. Contact loki-prod@google.com", + "Client ID used by the ADI Feature API (go/adi-feature-api)", + "Client Id for Labs Bettany Contact: bettany-eng@", + "Client Id for neco-genesis Contact: neco-eng@", + "Client ID used by Fitbit Capabilities Service (go/fitbit-capabilities). Contact fitbit-app-platform@", + "Client ID for Ads Marketing Automation (go/ce-ama) Contact: ads-marketing-automation-eng@", + "Client ID for Android Telemetry Westworld Contact: android-telemetry-infra-server@", + "Client ID for Data Security Posture Management (DSPM) Detective Controls Contact: dspm-controls-eng@", + "Client ID for CAA Insights Contact: policy-decision-service-eng@", + "Client ID for Shopping Carrier Info Contact: gpay-jp-eng-all@", + "Gws. Contact: oolong-team@.", + "", + "", + "", + "", + "", + "Search Ads clients providing similar user location to Search.", + "", + "", + "", + "", + "", + "", + "", + "Ad manager user sign up location by IP address", + "Use these within GWS iff the project is not using TLD (e.g. www.google.ch).", + "", + "", + "", + "Client Ids for Assistant via Oolong Service.", + "", + "", + "", + "Gws tld experimental clients", + "", + "", + "", + "Ads experimental clients", + "", + "", + "", + "Gws nontld experimental clients", + "", + "", + "", + "Assistant experimental clients", + "", + "", + "", + "Clients for Andromeda experimental slot. See go/ul-experimental-slots for description.", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "Clients for Bootes experimental slot. See go/ul-experimental-slots for description.", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "Clients for Cassiopeia experimental slot. See go/ul-experimental-slots for description.", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "Clients for Delphinus experimental slot. See go/ul-experimental-slots for description.", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "Clients for Eridanus experimental slot. See go/ul-experimental-slots for description.", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "Clients for Fomax experimental slot. See go/ul-experimental-slots for description.", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "Clients for Gemini experimental slot. See go/ul-experimental-slots for description.", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "Clients for Hercules experimental slot. See go/ul-experimental-slots for description.", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "Clients for Indus experimental slot. See go/ul-experimental-slots for description.", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "Clients for Leo experimental slot. See go/ul-experimental-slots for description.", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "Clients for Mensa experimental slot. See go/ul-experimental-slots for description.", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "Clients for Norma experimental slot. See go/ul-experimental-slots for description.", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "Clients for Orion experimental slot. See go/ul-experimental-slots for description.", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "Clients for Pisces experimental slot. See go/ul-experimental-slots for description.", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "Clients for Reticulum experimental slot. See go/ul-experimental-slots for description.", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "Clients for Sagittarius experimental slot. See go/ul-experimental-slots for description.", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "Clients for Taurus experimental slot. See go/ul-experimental-slots for description.", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "Clients for Ursa Major experimental slot. See go/ul-experimental-slots for description.", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "Clients for Virgo experimental slot. See go/ul-experimental-slots for description.", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "Use for LoggedContext re-geocoding. Do not use for LocationContext processing.", + "Client useful for country level IPGeo. It accepts any country regardless of the confidence. Do not use this client for any location other than country. It can be used while migrating from legacy googledata/ipgeo index. Contact: oolong-team@.", + "Client similar to CLIENT_IPGEO_REGION, but adapted to IPGeo Eval purpose. Contact: ipgeo-team@.", + "Tactile initial viewport policy. Contact: oolong-team@ Note that maps clients don't adhere to TLD restrictions.", + "", + "", + "", + "Maps clients that use glassbox.", + "", + "", + "", + "", + "", + "Experimental maps clients.", + "", + "Session IP geocoding. Contact: oolong-team@.", + "Use this client ID if you are not using oolong legal/quality annotations. A sample usecase is reverse geocoding a set of lat/lngs or mids/featureids. NOTE: do not use oolong annotations if this client is set.", + "Default client to use when TLD restrictions are not applied. This policy can change without notice. If you care about particular quality assumptions, then create a custom client id. Contact: oolong-team@", + "Does NOT annotate anything with UNIQUE_SELECTED_FOR_USER_LOCATION", + "Client id that only applies legal annotations.", + "Use for testing only. Never use this in production.", + "", + "Used for oracle eval.", + "", + "", + "", + "Clients used to compare different location source combinations.", + "", + "", + "Client used for country field in Magic Eye dimensions (go/core-dimensions).", + "Used for the go/mapsguide directions prototype.", + "Deprecated clients SafeBrowsing Team. Contact: anov@.", + "Use CLIENT_GWS_NONTLD_DESKTOP_ZWIEBACK or _GAIA Contact oolong-team@", + "Use CLIENT_GWS_NONTLD_MOBILE_ZWIEBACK or _GAIA Contact oolong-team@" + ], + "type": "string" + }, + "extractorFlags": { + "$ref": "LocationUnifiedExtractorFlags", + "description": "Flags to customize the extractors used to build this location context." + }, + "featurePool": { + "description": "The feature pool used in the location results. This is a map from feature ID to feature data, but since the feature ID is part of the Featurelet data, just a repeated field enumerating them is enough.", + "items": { + "$ref": "LocationUnifiedOolongFeature" + }, + "type": "array" + }, + "fromHulkRealtime": { + "description": "True if the location context originates from the Hulk Realtime plugin in GWS: go/hulk-realtime-in-search-ads.", + "type": "boolean" + }, + "lockStrategy": { + "description": "Defines which roles/producers can be added/edit for the context. This field is used only when locked_for_debug flag is set.", + "enum": [ + "NO_LOCKING", + "LOCK_ALL", + "LOCK_ALL_EXCEPT_EXPLICIT_IMMEDIATE_AND_DOMAIN" + ], + "enumDescriptions": [ + "Strategy which allows changing all the results.", + "Strategy which does not allow changing any result.", + "Does not allow adding any results that are not role=QUERY, USER_SPECIFIED_FOR_REQUEST or VIEWPORT, OR role/producer = CURRENT_LOCATION/GOOGLE_HOST_DOMAIN." + ], + "type": "string" + }, + "lockedForDebug": { + "description": "If true, only a selected list of descriptors will be added to this context by the standard library functions. This is so that debug parameters can be used to override the context reliably. The descriptors that can be added is determined by the lock_strategy enum. Note that policies may override and ignore this flag altogether.", + "type": "boolean" + }, + "lockedForPolicy": { + "description": "If true, the location context should be kept as is, no policy should modify it, except for: setting the client id and adding qref location.", + "type": "boolean" + }, + "nonstandardData": { + "$ref": "MessageSet" + }, + "origin": { + "$ref": "LocationUnifiedLocationContextOrigin", + "description": "Information about the origin of the location context. This is used to validate that the location context was created through a valid means, which is Oolong. DO NOT SET THIS FIELD YOURSELF. In fact, do not construct location contexts yourself." + }, + "results": { + "items": { + "$ref": "LocationUnifiedLocationResult" + }, + "type": "array" + } + }, + "type": "object" + }, + "LocationUnifiedLocationContextOrigin": { + "description": "This message stores information about how a location context was created. It is restricted in visibility to Oolong code only, so that it provides a way to easily identify location contexts that have been created from external code. (Which should NOT be done ever.) Next ID: 3", + "id": "LocationUnifiedLocationContextOrigin", + "properties": { + "dejitterModifications": { + "description": "Sequence of Dejitter modifications applied to the associated LocationContext. For monitoring and debugging use only; it should be safe to remove or change the contents of this field at any time.", + "items": { + "enum": [ + "DEJITTER_MODIFICATION_UNSPECIFIED", + "DEJITTER_REMOVED_IMPLICIT_LOCATION_RESULTS", + "DEJITTER_REMOVED_IMPLICIT_LOCATION_ANNOTATIONS", + "DEJITTER_REMOVED_IMPLICIT_SUBCOUNTRY_FEATURES" + ], + "enumDescriptions": [ + "", + "", + "", + "" + ], + "type": "string" + }, + "type": "array" + }, + "type": { + "description": "The origin of the LocationContext. May be updated by restricted Oolong libraries that modify the LocationContext after it was returned. Some Apps Framework services use this in their location propagation logic to decide whether a LocationContext is suitable for propagating to backends.", + "enum": [ + "INVALID_ORIGIN", + "TEST_UTILS", + "LES_PLC_CALL", + "OOLONG_WITH_CUSTOM_GEOCODER", + "LOCAL_SEARCH_LITE_OVERRIDE", + "OOLONG_SERVICE", + "QUALITY_BRAIN_OVERRIDE" + ], + "enumDescriptions": [ + "Default value, which means no valid origin.", + "Constructed through LocationContextBuilder, for testing.", + "Created through a call to LES to one of the ProcessLocationContext* functions (Oolong interface).", + "Created through an ipgeo-only LES or other custom-geocoder-based Oolong interface.", + "Created from local_search_lite_context_util.h, by CreateOverriddenLocationContext.", + "Created by OolongService.", + "BRAIN override" + ], + "type": "string" + } + }, + "type": "object" + }, + "LocationUnifiedLocationDescriptor": { + "description": "A LocationDescriptor is the minimal specification of a location together with its role and producer. The location \"payload\" can be specified by a variety of means (e.g., an address, an ip address, GPS coordinates, etc.) but only a single means should be used. DO NOT COMBINE MULTIPLE SPECIFICATIONS INTO A SINGLE DESCRIPTOR (e.g., a freeform street address and lat/long together). Next Id: 27", + "id": "LocationUnifiedLocationDescriptor", + "properties": { + "additionalFeatureId": { + "$ref": "LocationUnifiedFeatureIdProto", + "description": "A 128-bit feature consisting of an S2Cell and a unique feature identifier. Should be unused outside of the internal applications by the Oolong team." + }, + "attributes": { + "$ref": "LocationUnifiedLocationAttributesProto", + "description": "Supplemental attributes for a location that are not related to geocoding, but still may affect search results." + }, + "confidence": { + "description": "A confidence measure. Percentage: must be 0 to 100.", + "format": "int32", + "type": "integer" + }, + "diagnosticInfo": { + "description": "WARNING: Do not use this field without talking to the oolong-team@ first. It should never contain any Personal Identification Information (PII). You can use this field to provide diagnostic information about the location extraction code. Some examples could include the latency of getting the location, the fact that it was retrieved from the cache or not, the reason for not providing the location, software version (if that cannot be used to identify the user). Make sure to prepare a PDD that describes what is stored in this field for your project before using the field.", + "type": "string" + }, + "featureId": { + "$ref": "LocationUnifiedFeatureIdProto", + "description": "A 128-bit feature consisting of an S2Cell and a unique feature identifier." + }, + "historicalProducer": { + "description": "This field is intended for recording the producer of a historical location. It will be populated for a descriptor with role HISTORICAL_LOCATION, using the producer of the original descriptor. To enable location history to be sent via an untrusted source to a frontend, you should make sure that the historical_role-historical_producer pair of the descriptor also appears on the untrusted allowlist used by the frontend.", + "enum": [ + "UNKNOWN_PRODUCER", + "LOGGED_IN_USER_SPECIFIED", + "PREF_L_FIELD_ADDRESS", + "IP_ADDRESS", + "IP_ADDRESS_REALTIME", + "GOOGLE_HOST_DOMAIN", + "RQUERY", + "SQUERY", + "QUERY_LOCATION_OVERRIDE_PRODUCER", + "QREF", + "DEVICE_LOCATION", + "LEGACY_NEAR_PARAM", + "CARRIER_COUNTRY", + "JURISDICTION_COUNTRY", + "CLIENT_SPECIFIED_JURISDICTION_COUNTRY", + "DECODED_FROM_UNKNOWN_ROLE_PRODUCER", + "SHOWTIME_ONEBOX", + "LOCAL_UNIVERSAL", + "SEARCH_TOOLBELT", + "MOBILE_FE_HISTORY", + "GWS_MOBILE_HISTORY_ZWIEBACK", + "MOBILE_SELECTED", + "PARTNER", + "WEB_SEARCH_RESULTS_PAGE_SHARED", + "WEB_SEARCH_PREFERENCES_PAGE", + "MAPS_FRONTEND", + "PRODUCT_SEARCH_FRONTEND", + "ADS_CRITERIA_ID", + "MOBILE_APP", + "QUERY_HISTORY_INFERRED", + "QUERY_HISTORY_INFERRED_ALTERNATE", + "GMAIL_THEME", + "IGOOGLE", + "CALENDAR", + "SMS_SEARCH", + "LEGACY_GL_PARAM", + "LEGACY_PARTNER_GL_PARAM", + "LEGACY_GL_COOKIE", + "GWS_JURISDICTION_COUNTRY", + "CIRCULARS_FRONTEND", + "SHOPPING_SEARCH_API", + "OZ_FRONTEND", + "ADS_GEO_PARAM", + "ADS_PARTNER_GEO_PARAM", + "DEFAULT_LOCATION_OVERRIDE_PRODUCER", + "VIEWPORT_PARAMS", + "GAIA_LOCATION_HISTORY", + "STICKINESS_PARAMS", + "TURN_BY_TURN_NAVIGATION_REROUTE", + "SNAP_TO_PLACE_IMPLICIT", + "SNAP_TO_PLACE_EXPLICIT", + "HULK_USER_PLACES_CONFIRMED", + "HULK_USER_PLACES_INFERRED", + "TACTILE_NEARBY_PARAM", + "MAPS_ACTIVITY", + "IP_ADDRESS_ALTERNATE", + "DIRECTIONS_START_POINT", + "SEARCH_ALONG_ROUTE", + "SNAP_TO_ROUTE", + "GOOGLE_MY_BUSINESS", + "BAD_DEVICE_LOCATION", + "GMM_QUANTIZED_DEVICE_LOCATION", + "GWS_HISTORY_GAIA", + "CONTEXT_MANAGER_FORECAST", + "GMM_HEATMAP_AREA", + "NEWS", + "SHIPPING_ADDRESS", + "DEVICE_CONTEXT", + "TRAVEL_STATE_INTENT", + "HULK_ROUTINES", + "WILDCARD_PRODUCER", + "LEGACY_TOOLBAR_HEADER", + "LEGACY_MOBILE_FRONTEND_GLL", + "LEGACY_MOBILE_FRONTEND_NEAR", + "ABLATED_PRODUCER", + "OOLONG_REALTIME_CACHE", + "OOLONG_REALTIME_CACHE_ALTERNATE", + "DIRECTIONS_WAYPOINT", + "ADS_FINAL_VIEWPORT", + "SEARCH_REGION_SETTINGS_COUNTRY", + "ASSISTANT_DERIVED", + "OOLONG_DEFAULT_LOCATION", + "ADS_GLS_FINAL_VIEWPORT" + ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + 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, + true, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + true, + false, + true, + false, + false, + false, + false, + false, + false, + true, + true, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], + "enumDescriptions": [ + "THIS VALUE MUST BE THE FIRST IN THIS ENUM. Default value used to identify unset fields including those resulting from enum values unknown to an out-dated binary. This should be used only to check for errors.", + "A location specified by a logged-in user (e.g., default location from Kansas). It is a freeform address string stored in loc.", + "The user-specified default location contained in the L-field of a browser's PREF cookie. It is a freeform address string stored in loc.", + "A location based on IP address. The IP address is stored in loc in dot-decimal (IPv4) or colon-hexadecimal (IPv6) format.", + "This is the location that is derived from the realtime ipgeo index. This is a fresh version of ipgeo index which is available for a small subset of IPs.", + "A location based on the domain of the Google server (e.g., google.co.uk) servicing the request. The domain name is stored in loc.", + "The descriptor is based on a raw query (free-form). The query text is stored in loc.", + "The descriptor is based on an squery and is stored as an squery in loc.", + "The descriptor contains a location as a raw query in loc. It is geocoded and used to override the geocoding of the QUERY/RQUERY or QUERY/SQUERY descriptor. Only to be used for debugging purposes.", + "This contains the location produced by qref module in qrewrite. Currently, the location is derived from the query and this will be only used with QUERY role.", + "A location that came from determining the physical location of a device (mobile, laptop, desktop, etc.) via means such as GPS, cell network, or Wifi. Always corresponds to CURRENT_LOCATION. The accuracy of the location may be stored in the radius and/or confidence fields. NOTE: By definition, these data do not include locations collected without the user's awareness and/or consent. Users on some Google services may be notified of and consent to Google's collection and use of geographical information.", + "The descriptor was generated by a legacy \"near\" param. It always corresponds to a USER_SPECIFIED_FOR_REQUEST. Occurrences should be replaced by Oolong-style parameters (e.g., muul/luul). Note that \"near\" params synthesized by Mobile Frontend from a lat/long are handled with LEGACY_MOBILE_FRONTEND_GLL.", + "The 2-letter ISO-3166-alpha2 code for the country of the mobile carrier of the request. Always corresponds to CURRENT_LOCATION, and is stored in the loc parameter. DEPRECATED(b/109727016). Use LocationAttributesProto.carrier_ip_type.", + "The descriptor was generated when mapping disputed areas to legally approved countries. It always corresponds to a DEFAULT_LOCATION role. It is used to geocode 2-letter ISO-3166-alpha2 country codes stored in the \"loc\" parameter.", + "The 2-letter ISO-3166-alpha2 code for the jurisdiction country specified by the Google application (e.g. GMM getting the country code directly from the simcard). Use the producer with role=DEFAULT_LOCATION.", + "The location was decoded from a uuld=l debug parameter based on anonymised Gaia logs that did not contain a role/producer pair.", + "The descriptor was generated by the Showtime (movies) Onebox.", + "A location used by any Local Search client (not just LU) to force a specific location interpretation. Always corresponds to USER_SPECIFIED_FOR_REQUEST.", + "This descriptor by generated by the Google Search Toolbelt.", + "A location found in the history of a user of the Mobile Frontend. Always corresponds to HISTORICAL_LOCATION, and has a correctly set historical_role and historical_producer.", + "A location found in the history of a user of Mobile Search in GWS (Tornado). Always corresponds to HISTORICAL_LOCATION, and has a correctly set historical_role and historical_producer. DEPRECATED: replaced with the OOLONG_REALTIME_CACHE producer.", + "A location selected by the user from a list presented by a mobile UI. Always corresponds to USER_SPECIFIED_FOR_REQUEST.", + "A location passed to us by a partner UI. It typically corresponds to CURRENT_LOCATION (e.g., in an ad request to specify location targeting parameters) or USER_SPECIFIED_FOR_REQUEST.", + "The location was generated by the shared UI on the web search results page, typically for setting a default location. Always corresponds to USER_SPECIFIED_FOR_REQUEST.", + "The location was generated by the UI on the web search preferences page. Always corresponds to USER_SPECIFIED_FOR_REQUEST.", + "From Maps Frontend (MFE).", + "From one of the Product Search frontends. Always corresponds to USER_SPECIFIED_FOR_REQUEST.", + "The descriptor was generated by a legacy \"gc\" param, and corresponds to the numerical ids assigned by the Ads team to various cities and regions. It always corresponds to a USER_SPECIFIED_FOR_REQUEST. The actual id will be stored in the loc field. At the present time, this producer is only used for internal tools and debugging.", + "The descriptor was generated by a mobile application. Used by some Google Android apps and corresponds to a HISTORICAL_LOCATION.", + "The descriptor was generated from the location inferred from web history. Always corresponds to HISTORICAL_LOCATION (for now---could have an INFERRED_LOCATION role in the future).", + "Same as QUERY_HISTORY_INFERRED but only used for experiments controlled by Oolong team.", + "The descriptor was generated by Gmail for location for weather. This is to support the Gmail themes with weather. It always corresponds to a DEFAULT_LOCATION.", + "The descriptor was generated by iGoogle for getting weather data. It corresponds to USER_SPECIFIED_FOR_REQUEST in this case.", + "The descriptor was generated by Calendar for getting weather data. It always corresponds to a DEFAULT_LOCATION.", + "The descriptor was generated from the location inferred from phone number or the personalization settings of the device in SMS search. It always correspond to a DEFAULT_LOCATION.", + "The descriptor was generated from the legacy 'gl' cgi param on a normal search request. It always corresponds to a CURRENT_LOCATION. ADS_GEO_PARAM will also be present if \"gr\" and/or \"gcs\" are present.", + "The descriptor was generated from the legacy 'gl' cgi param sent as an override from a partner. It always corresponds to the CURRENT_LOCATION role. ADS_GEO_PARAM will also be present if \"gr\" and/or \"gcs\" are present.", + "The descriptor was generated from a cookie that stores a previously set legacy 'gl' cgi param. It always corresponds to the CURRENT_LOCATION role.", + "The jurisdiction country derived from the GWS FrontendRequest. Always corresponds to the CURRENT_LOCATION role.", + "Override from one of the Circulars frontends. Always corresponds to USER_SPECIFIED_FOR_REQUEST.", + "The descriptor was generated by the Search API for Shopping based on a user supplied parameter. Always corresponds to USER_SPECIFIED_FOR_REQUEST.", + "The descriptor was generated by OZ frontend. It always corresponds to USER_SPECIFIED_FOR_REQUEST", + "The descriptor generated for Ads. This is generated from gl, gr, gcs and gm parameters. If the gl=US, gr=US-CA and gcs=San+Francisco, then the location is set to \"San Francisco,CA,US\". If any parameter is missing, it is skipped from the final location string. For example, if gcs is missing above, the location would be \"CA,US\". This and LEGACY_GL_PARAM will be generated when gr/gcs are present. Always corresponds to the CURRENT_LOCATION role.", + "The descriptor generated by GWS for Ads for partner requests. This is generated from gl, gr, gcs and gm parameters passed from partners. If the gl=US, gr=US-CA and gcs=San+Francisco, then the location is set to \"San Francisco,CA,US\". If any parameter is missing, it is skipped from the final location string. For example, if gcs is missing above, the location would be \"CA,US\". This and LEGACY_PARTNER_GL_PARAM will be generated when gr/gcs are present. Always corresponds to the CURRENT_LOCATION role.", + "Overrides all other default locations. It is a freeform address string. It always corresponds to the DEFAULT_LOCATION role. It is intended for testing only. NOTE: Please talk to oolong-team before using this producer. It should be used for one-off overrides only.", + "Location specified by viewport CGI parameters sll, sspn.", + "Location extracted from Happy Hour (signed-in user). Will be used with HISTORICAL_LOCATION role.", + "Descriptor generated from stickiness params feature id.", + "Location determined by a turn-by-turn-navigation client triggered by a reroute event. A location of this producer should additionally specify a semantic with LocationSemantic members to differentiate them among each other.", + "Location containing a feature ID determined by HULK realtime snap-to-place. The latlng and timestamp will correspond to the device location at the point the snap-to-place request was made. The confidence value is the confidence of that feature according to the snap-to-place response. This will usually be used with the CURRENT_LOCATION role, although might also be a HISTORICAL_LOCATION in cases where we are expressing a series of recent snap-to-place results.", + "Location containing a feature ID determined by HULK realtime snap-to-place as in SNAP_TO_PLACE_IMPLICIT, but which was subsequently confirmed by the user. As in SNAP_TO_PLACE_IMPLICIT the confidence value will reflect the value returned by the snap-to-place response, but backends may choose to ignore that value and assume the confidence is 100% since the user has explicitly chosen to interact with the place (the ambiguity is worth capturing though since the UI flow will not necessarily constitute an actual confirmation of a user's presence in a place). This will usually be used with the CURRENT_LOCATION role, although might also be a HISTORICAL_LOCATION in cases where we are expressing a series of recent snap-to-place results.", + "Location extracted from HappyHour which correspond to user's home and work locations. These locations are fetched from HulkUserPlaces HappyHour object (go/hulk-in-happyhour). This will be used with role=DEFAULT_LOCATION and LocationSemantic will indicate whether this location is home or work. AdWords will be the first client of this data. These locations are confirmed by the user. DEPRECATED: No longer used in production.", + "Similar to the above producer, except that these locations are inferred by happyhour and are not confirmed by the user. Two different producers are being used for confirmed and inferred locations as their use might have different privacy implications. Design doc: go/homeworktargeting DEPRECATED: No longer used in production.", + "The location extracted from a search nearby request in Tactile.", + "Location determined by Maps Activity in GMM client, corresponding to a previous location of the user for which nearby places are requested. This will be used with role=USER_SPECIFIED_FOR_REQUEST.", + "This descriptor is to only be used for experiments controlled by ipgeo team. During experimentation or ramping up launches, when this is provided in addition to IP_ADDRESS, this one is guaranteed to contain the result of the baseline ip index until the launch is at 100 % for both search and ads. Note that the definition of baseline may change depending on the product that uses it. For example, in search it may contain the old index whereas in Ads it may contain the experimental index. Contact the ipgeo-team for more details.", + "This descriptor is intended for a client to pass an offset used to anonymize all pii coordinates in a SearchAlongRouteContext or EnrouteContext. Anonymized coordinates are set as relative to DIRECTIONS_START_POINT rather than as absolute locations. This should be used with role = USER_SPECIFIED_FOR_REQUEST.", + "This producer indicates the location is from the search-along-route system. This producer is not intended to be used in a raw LocationResult; rather it is a descriptor for use with downstream processed locations (such as LocationRankingTargetLocation).", + "This producer returns the best guess for the user location as projected onto a specific route that the user is following. Users using driving navigation most often follow the route they are being told. On occasion they deviate, and sometimes it is not clear whether they have deviated or not. To represent both possibilities, Google Maps for Mobile sends both (a) the user location snapped to the road network and (b) the user location snapped to the specific route the user is being told to follow. The former has DEVICE_LOCATION producer and the latter has SNAP_TO_ROUTE producer.", + "This descriptor was generated from Google My Business location as a lat/lng. Always corresponds to USER_SPECIFIED_FOR_REQUEST.", + "This is a device location that has been rejected for some reason. It is only kept in the location context so we can analyze them in logs.", + "This is a device location that has been quantized on device for privacy purposes, for use by NBN in GMM backends. Consult with pwg-geo@ and oolong-team@ before using this producer.", + "A location found in the history of a gaia user in GWS. Similar to GWS_MOBILE_HISTORY_ZWIEBACK, but works only for gaia users. Differs from GAIA_LOCATION_HISTORY - it is extracted from user search requests (not from user location reports on Android) and stored in Kansas (not in HappyHour). DEPRECATED: replaced with the OOLONG_REALTIME_CACHE producer.", + "A FUTURE_LOCATION signal originating from the user location forecast producer in Context Manager: go/context-manager.", + "A HISTORICAL_LOCATION region collected on device over time: go/gmm-terroir. DEPRECATED(2018-02-20): b/124457814.", + "The descriptor was generated by the Google News UI. Always corresponds to USER_SPECIFIED_FOR_REQUEST.", + "The descriptor was generated by the user's preferred delivery address configured in Google Shopping Express. go/shipping-address", + "Information about the device, without actual location data, e.g. ActivityRecord.", + "A FUTURE_LOCATION signal produced by travel state intent: go/travel-triggering.", + "A frequently visited place of a user, see go/hulk-routines-implementation. For Location History users only. Experimental, consult with oolong-team@ before using this producer.", + "A special enum value for representing a wildcard producer (matches any producer). This must never be used as the producer for a descriptor.", + "The descriptor was generated by Toolbar and passed via the legacy X_TOOLBAR_LOCATION header. It always corresponds to a CURRENT_LOCATION.", + "The descriptor was generated by Mobile Frontend and passed via the legacy \"gll\" and \"near\" params. It always corresponds to a CURRENT_LOCATION. The \"gll\" parameter appears in latlng (and, if applicable latlng_span) and if there's a \"near\" parameter, it appears in the loc field. Note that other uses of \"gll\" are not covered by this producer. DEPRECATED(finnegan): As of 2010/03/26. This will be renamed eventually.", + "The descriptor was generated by Mobile Frontend and passed via the legacy \"near\" param (without \"gll\"). This has different semantics from those of LEGACY_NEAR_PARAM. It always corresponds to a CURRENT_LOCATION. DEPRECATED(finnegan): As of 2010/03/26. This will be renamed eventually.", + "A result that was ablated for an experiment.", + "Location coming from Oolong location cache (go/ort-cache-dd).", + "Same as OOLONG_REALTIME_CACHE but only used for experiments controlled by Oolong team.", + "Location coming from an internal superroot call trying to resolve one directions waypoint in the context of a known one. This will be used inside DirectionsSearch flow in superroot before sending a request to the WebPlusLocal node in superroot.", + "Viewport derived in Superroot after organic results are available.", + "Location from the Search Region Settings in Search Settings (stored in the Zwieback cookie). Always combined with the DEFAULT_LOCATION role. Search uses this setting to determine the jurisdiction region (for signed-in and signed-out traffic), but does so on the GWS side and sends only the output of its logic as a GWS_JURISDICTION_COUNTRY result to Oolong Service. Thus, it does not need to use this producer. Conversely, for Assistant traffic, the jurisdiction region is determined in LES from the various input signals (including this one). Prioritization between the various signals for Assistant is described in go/assistant-region and implemented in google3/googledata/location/unified/location_service/client_configuration.textproto.", + "A location that originates in assistant. The location is contained in a LocationDescriptor across assistant. The source of the location is unknown but it is not a DEVICE_LOCATION. go/as-oolong-launch", + "A location indicated by the user as their default to be used for the current location.", + "Viewport override for GLS ad retrieval." + ], + "type": "string" + }, + "historicalProminence": { + "deprecated": true, + "description": "This field is intended for recording frequency of historical location usage. Do not use it unless you know the historical producer intention for this field. DEPRECATED: This is no longer used or populated.", + "format": "int32", + "type": "integer" + }, + "historicalRole": { + "description": "This field is intended for recording the role of a historical location. It will be populated for a descriptor with role HISTORICAL_LOCATION, using the role of the original descriptor. To enable location history to be sent via an untrusted source to a frontend, you should make sure that the historical_role-historical_producer pair of the descriptor also appears on the untrusted allowlist used by the frontend.", + "enum": [ + "UNKNOWN_ROLE", + "CURRENT_LOCATION", + "DEFAULT_LOCATION", + "QUERY", + "USER_SPECIFIED_FOR_REQUEST", + "HISTORICAL_QUERY", + "HISTORICAL_LOCATION", + "VIEWPORT", + "FUTURE_LOCATION", + "INVALID_LOCATION", + "EXPERIMENTAL_LOCATION", + "CURRENT_CONTEXT", + "FINAL_VIEWPORT", + "GLS_FINAL_VIEWPORT", + "WILDCARD_ROLE" + ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], + "enumDescriptions": [ + "THIS VALUE MUST BE THE FIRST IN THIS ENUM. Default value used to identify unset fields including those resulting from enum values unknown to an out-dated binary. This should be used only to check for errors. A descriptor with this role is invalid and should be ignored.", + "The location is the device's current, physical location. Semantics: * unique * implicit * immediate", + "A user-specified default location. The suggested interpretation is as a literal default; in the absence of better information or a reasonable understanding of the user's intent, use the default location. Semantics: * unique * explicit * persistent", + "A descriptor corresponding to the query in a request (if any). A query may or may not contain location information but a descriptor is created and geocoding attempted in case there is one. The query is specified in the loc field and can take two forms, the raw query or an squery. The form is indicated by the corresponding producer (RQUERY or SQUERY). Semantics: * unique * explicit * immediate", + "A user-specified location specific to this request but not part of a query. These typically come from the user entering an overriding location in some separate UI field and submitting a request (e.g, overriding the location of weather results or setting a new default location). The source of the override is indicated by the producer. While it is technically possible to have multiple overrides for a request, that suggests a confusing user experience. Semantics: * unique * explicit * immediate", + "DEPRECATED: This was never used in production and is replaced by HISTORICAL_LOCATION.", + "A descriptor corresponding to some past location associated with the current request. This location may have come from a variety of sources (e.g., a history of queries) and the source of the location is indicated by the producer. There can be more than one historical location in a context. Historical locations should always have an associated timestamp. The original metadata for the location should be added via the historical_role and historical_producer fields. Semantics: * repeated * implicit * persistent", + "A descriptor corresponding to a user-visible viewport (e.g., Maps viewport, Streetview viewport, mobile camera viewport). This viewport may have come from a variety of sources, indicated by the producer. We expect there to be only one viewport active (hence \"unique\" semantics). We assume that the user has explicitly accepted and is aware of the viewport (hence \"explicit\" semantics). The viewport is associated only with the current query (hence \"immediate\" semantics). Viewports are expressed via rect. Semantics: * unique * explicit * immediate", + "A descriptor corresponding to a prediction of the future location of the user issuing the request. This location may have come from a variety of sources (e.g. calendar, user profile, etc) and the source of the location is indicated by the producer. There can be more than one future location in a context. Future locations should always have associated presence_interval:s. Semantics: * repeated * implicit * persistent", + "A descriptor corresponding to an invalid location, e.g. rect is invalid in it. Producer is kept as the original producer, original role is lost. A location with this role should not be used in production. Semantics: * repeated", + "Experimental device location produced by GmsCore, not to be used in any oolong policy. Only for quality check before switch to GmsCore as X-Geo header producer in AGSA. go/agsa-xgeo-integration-dd - AGSA XGeo Context Manager integration. * repeated", + "Current location related data, without actual location information, e.g. ActivityRecord. Semantics: * unique * implicit * immediate", + "A descriptor corresponding to the viewport that will be shown to the user after the request completes, such as a query 'tour eiffel', or a direction MTV to SFO. This viewport only appears together with the ADS_FINAL_VIEWPORT producer. We expect there to be only one at a time (hence \"unique\" semantics). We assume that the user has explicitly requested it and is aware of the viewport (hence \"explicit\" semantics). The viewport is associated only with the current query (hence \"immediate\" semantics). Viewports are expressed via rect. Semantics: * unique * explicit * immediate", + "A descriptor corresponding to a viewport that will be used for GLS ad retrieval. On some surfaces (e.g. xGMM apps), the final viewport is expanded to improve ad retrieval for other ads. This larger viewport works poorly for GLS ad retrieval, so we will extract the original, unexpanded, final viewport as well. This viewport only appears together with the ADS_GLS_FINAL_VIEWPORT producer. We expect there to be only one at a time (\"unique\"). This viewport is the final displayed viewport (\"explicit\"). The viewport is associated only with the current query (\"immediate\"). Semantics: * unique * explicit * immediate", + "A special enum value for representing a wildcard role (matches any role). This must never be used as the role for a descriptor." + ], + "type": "string" + }, + "language": { + "deprecated": true, + "description": "The language used previously for query geocoding, set to the frontend language of the user during extraction. DO NOT USE THIS TO GET A USER'S LANGUAGE. INSTEAD, GET THE LANGUAGE FROM THE FrontendRequest OR THROUGH ANOTHER API! THIS FIELD WILL GO AWAY.", + "type": "string" + }, + "latlng": { + "$ref": "LocationUnifiedLatLng", + "description": "A latitude and longitude used to describe this location as a point." + }, + "latlngSpan": { + "$ref": "LocationUnifiedLatLng", + "deprecated": true, + "description": "The span of a bounding box whose center is latlng. Specifies the lengths of the sides of the box and is valid only if latlng is present. DEPRECATED(6/6/2012): b/5979511. Use 'rect' instead." + }, + "levelFeatureId": { + "$ref": "LocationUnifiedFeatureIdProto", + "description": "A 128-bit feature ID for the (indoor) level/floor of this location. If present, the floor supplements other location attributes in this descriptor. For example, in shopping malls it is quite common that one store occupies rooms on multiple levels, connected with escalators. The user can be at the exact same lat/lng and at the same GAP store, but on different levels." + }, + "levelNumber": { + "description": "The number of this location's level relative to the ground floor. 0 means ground floor; -2 is two levels below ground; +0.5 is a mezzanine.", + "format": "float", + "type": "number" + }, + "loc": { + "description": "A string containing the location payload. The format of this string may depend on the producer but it should be otherwise be treated like a freeform, human-readable string (a query, a street address, city name, postal code, district name, country, etc.). Other, producer-specific formats include IP address, host domain, and squery. time zone. Note that for some producers there is no guarantee that the string contains a valid location (e.g., a query for [pizza]).", + "type": "string" + }, + "mid": { + "description": "A 64-bit machine identifier of a geo feature in Freebase.", + "format": "uint64", + "type": "string" + }, + "permissionGranularity": { + "description": "The granularity of the location permissions that was present to get the device location that this location descriptor represents. Only relevant for device locations.", + "enum": [ + "PERMISSION_GRANULARITY_UNKNOWN", + "PERMISSION_GRANULARITY_COARSE", + "PERMISSION_GRANULARITY_FINE" + ], + "enumDescriptions": [ + "", + "The device location was retrieved with `coarse` permissions, meaning it will have a radius > 1.2 km. Note that this is *not* the common 3+1 anonymization, hence these are usually referred to as \"approximate\" in oolong.", + "The device location was retrieved with `fine` permission, meaning the radius will be as precise as reported by the device." + ], + "type": "string" + }, + "presenceInterval": { + "description": "The presence intervals associated with the location. Required for FUTURE_LOCATION signals. This field should not be logged anywhere.", + "items": { + "$ref": "LocationUnifiedPresenceInterval" + }, + "type": "array" + }, + "producer": { + "description": "The producer of this location.", + "enum": [ + "UNKNOWN_PRODUCER", + "LOGGED_IN_USER_SPECIFIED", + "PREF_L_FIELD_ADDRESS", + "IP_ADDRESS", + "IP_ADDRESS_REALTIME", + "GOOGLE_HOST_DOMAIN", + "RQUERY", + "SQUERY", + "QUERY_LOCATION_OVERRIDE_PRODUCER", + "QREF", + "DEVICE_LOCATION", + "LEGACY_NEAR_PARAM", + "CARRIER_COUNTRY", + "JURISDICTION_COUNTRY", + "CLIENT_SPECIFIED_JURISDICTION_COUNTRY", + "DECODED_FROM_UNKNOWN_ROLE_PRODUCER", + "SHOWTIME_ONEBOX", + "LOCAL_UNIVERSAL", + "SEARCH_TOOLBELT", + "MOBILE_FE_HISTORY", + "GWS_MOBILE_HISTORY_ZWIEBACK", + "MOBILE_SELECTED", + "PARTNER", + "WEB_SEARCH_RESULTS_PAGE_SHARED", + "WEB_SEARCH_PREFERENCES_PAGE", + "MAPS_FRONTEND", + "PRODUCT_SEARCH_FRONTEND", + "ADS_CRITERIA_ID", + "MOBILE_APP", + "QUERY_HISTORY_INFERRED", + "QUERY_HISTORY_INFERRED_ALTERNATE", + "GMAIL_THEME", + "IGOOGLE", + "CALENDAR", + "SMS_SEARCH", + "LEGACY_GL_PARAM", + "LEGACY_PARTNER_GL_PARAM", + "LEGACY_GL_COOKIE", + "GWS_JURISDICTION_COUNTRY", + "CIRCULARS_FRONTEND", + "SHOPPING_SEARCH_API", + "OZ_FRONTEND", + "ADS_GEO_PARAM", + "ADS_PARTNER_GEO_PARAM", + "DEFAULT_LOCATION_OVERRIDE_PRODUCER", + "VIEWPORT_PARAMS", + "GAIA_LOCATION_HISTORY", + "STICKINESS_PARAMS", + "TURN_BY_TURN_NAVIGATION_REROUTE", + "SNAP_TO_PLACE_IMPLICIT", + "SNAP_TO_PLACE_EXPLICIT", + "HULK_USER_PLACES_CONFIRMED", + "HULK_USER_PLACES_INFERRED", + "TACTILE_NEARBY_PARAM", + "MAPS_ACTIVITY", + "IP_ADDRESS_ALTERNATE", + "DIRECTIONS_START_POINT", + "SEARCH_ALONG_ROUTE", + "SNAP_TO_ROUTE", + "GOOGLE_MY_BUSINESS", + "BAD_DEVICE_LOCATION", + "GMM_QUANTIZED_DEVICE_LOCATION", + "GWS_HISTORY_GAIA", + "CONTEXT_MANAGER_FORECAST", + "GMM_HEATMAP_AREA", + "NEWS", + "SHIPPING_ADDRESS", + "DEVICE_CONTEXT", + "TRAVEL_STATE_INTENT", + "HULK_ROUTINES", + "WILDCARD_PRODUCER", + "LEGACY_TOOLBAR_HEADER", + "LEGACY_MOBILE_FRONTEND_GLL", + "LEGACY_MOBILE_FRONTEND_NEAR", + "ABLATED_PRODUCER", + "OOLONG_REALTIME_CACHE", + "OOLONG_REALTIME_CACHE_ALTERNATE", + "DIRECTIONS_WAYPOINT", + "ADS_FINAL_VIEWPORT", + "SEARCH_REGION_SETTINGS_COUNTRY", + "ASSISTANT_DERIVED", + "OOLONG_DEFAULT_LOCATION", + "ADS_GLS_FINAL_VIEWPORT" + ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + 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, + true, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + true, + false, + true, + false, + false, + false, + false, + false, + false, + true, + true, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], + "enumDescriptions": [ + "THIS VALUE MUST BE THE FIRST IN THIS ENUM. Default value used to identify unset fields including those resulting from enum values unknown to an out-dated binary. This should be used only to check for errors.", + "A location specified by a logged-in user (e.g., default location from Kansas). It is a freeform address string stored in loc.", + "The user-specified default location contained in the L-field of a browser's PREF cookie. It is a freeform address string stored in loc.", + "A location based on IP address. The IP address is stored in loc in dot-decimal (IPv4) or colon-hexadecimal (IPv6) format.", + "This is the location that is derived from the realtime ipgeo index. This is a fresh version of ipgeo index which is available for a small subset of IPs.", + "A location based on the domain of the Google server (e.g., google.co.uk) servicing the request. The domain name is stored in loc.", + "The descriptor is based on a raw query (free-form). The query text is stored in loc.", + "The descriptor is based on an squery and is stored as an squery in loc.", + "The descriptor contains a location as a raw query in loc. It is geocoded and used to override the geocoding of the QUERY/RQUERY or QUERY/SQUERY descriptor. Only to be used for debugging purposes.", + "This contains the location produced by qref module in qrewrite. Currently, the location is derived from the query and this will be only used with QUERY role.", + "A location that came from determining the physical location of a device (mobile, laptop, desktop, etc.) via means such as GPS, cell network, or Wifi. Always corresponds to CURRENT_LOCATION. The accuracy of the location may be stored in the radius and/or confidence fields. NOTE: By definition, these data do not include locations collected without the user's awareness and/or consent. Users on some Google services may be notified of and consent to Google's collection and use of geographical information.", + "The descriptor was generated by a legacy \"near\" param. It always corresponds to a USER_SPECIFIED_FOR_REQUEST. Occurrences should be replaced by Oolong-style parameters (e.g., muul/luul). Note that \"near\" params synthesized by Mobile Frontend from a lat/long are handled with LEGACY_MOBILE_FRONTEND_GLL.", + "The 2-letter ISO-3166-alpha2 code for the country of the mobile carrier of the request. Always corresponds to CURRENT_LOCATION, and is stored in the loc parameter. DEPRECATED(b/109727016). Use LocationAttributesProto.carrier_ip_type.", + "The descriptor was generated when mapping disputed areas to legally approved countries. It always corresponds to a DEFAULT_LOCATION role. It is used to geocode 2-letter ISO-3166-alpha2 country codes stored in the \"loc\" parameter.", + "The 2-letter ISO-3166-alpha2 code for the jurisdiction country specified by the Google application (e.g. GMM getting the country code directly from the simcard). Use the producer with role=DEFAULT_LOCATION.", + "The location was decoded from a uuld=l debug parameter based on anonymised Gaia logs that did not contain a role/producer pair.", + "The descriptor was generated by the Showtime (movies) Onebox.", + "A location used by any Local Search client (not just LU) to force a specific location interpretation. Always corresponds to USER_SPECIFIED_FOR_REQUEST.", + "This descriptor by generated by the Google Search Toolbelt.", + "A location found in the history of a user of the Mobile Frontend. Always corresponds to HISTORICAL_LOCATION, and has a correctly set historical_role and historical_producer.", + "A location found in the history of a user of Mobile Search in GWS (Tornado). Always corresponds to HISTORICAL_LOCATION, and has a correctly set historical_role and historical_producer. DEPRECATED: replaced with the OOLONG_REALTIME_CACHE producer.", + "A location selected by the user from a list presented by a mobile UI. Always corresponds to USER_SPECIFIED_FOR_REQUEST.", + "A location passed to us by a partner UI. It typically corresponds to CURRENT_LOCATION (e.g., in an ad request to specify location targeting parameters) or USER_SPECIFIED_FOR_REQUEST.", + "The location was generated by the shared UI on the web search results page, typically for setting a default location. Always corresponds to USER_SPECIFIED_FOR_REQUEST.", + "The location was generated by the UI on the web search preferences page. Always corresponds to USER_SPECIFIED_FOR_REQUEST.", + "From Maps Frontend (MFE).", + "From one of the Product Search frontends. Always corresponds to USER_SPECIFIED_FOR_REQUEST.", + "The descriptor was generated by a legacy \"gc\" param, and corresponds to the numerical ids assigned by the Ads team to various cities and regions. It always corresponds to a USER_SPECIFIED_FOR_REQUEST. The actual id will be stored in the loc field. At the present time, this producer is only used for internal tools and debugging.", + "The descriptor was generated by a mobile application. Used by some Google Android apps and corresponds to a HISTORICAL_LOCATION.", + "The descriptor was generated from the location inferred from web history. Always corresponds to HISTORICAL_LOCATION (for now---could have an INFERRED_LOCATION role in the future).", + "Same as QUERY_HISTORY_INFERRED but only used for experiments controlled by Oolong team.", + "The descriptor was generated by Gmail for location for weather. This is to support the Gmail themes with weather. It always corresponds to a DEFAULT_LOCATION.", + "The descriptor was generated by iGoogle for getting weather data. It corresponds to USER_SPECIFIED_FOR_REQUEST in this case.", + "The descriptor was generated by Calendar for getting weather data. It always corresponds to a DEFAULT_LOCATION.", + "The descriptor was generated from the location inferred from phone number or the personalization settings of the device in SMS search. It always correspond to a DEFAULT_LOCATION.", + "The descriptor was generated from the legacy 'gl' cgi param on a normal search request. It always corresponds to a CURRENT_LOCATION. ADS_GEO_PARAM will also be present if \"gr\" and/or \"gcs\" are present.", + "The descriptor was generated from the legacy 'gl' cgi param sent as an override from a partner. It always corresponds to the CURRENT_LOCATION role. ADS_GEO_PARAM will also be present if \"gr\" and/or \"gcs\" are present.", + "The descriptor was generated from a cookie that stores a previously set legacy 'gl' cgi param. It always corresponds to the CURRENT_LOCATION role.", + "The jurisdiction country derived from the GWS FrontendRequest. Always corresponds to the CURRENT_LOCATION role.", + "Override from one of the Circulars frontends. Always corresponds to USER_SPECIFIED_FOR_REQUEST.", + "The descriptor was generated by the Search API for Shopping based on a user supplied parameter. Always corresponds to USER_SPECIFIED_FOR_REQUEST.", + "The descriptor was generated by OZ frontend. It always corresponds to USER_SPECIFIED_FOR_REQUEST", + "The descriptor generated for Ads. This is generated from gl, gr, gcs and gm parameters. If the gl=US, gr=US-CA and gcs=San+Francisco, then the location is set to \"San Francisco,CA,US\". If any parameter is missing, it is skipped from the final location string. For example, if gcs is missing above, the location would be \"CA,US\". This and LEGACY_GL_PARAM will be generated when gr/gcs are present. Always corresponds to the CURRENT_LOCATION role.", + "The descriptor generated by GWS for Ads for partner requests. This is generated from gl, gr, gcs and gm parameters passed from partners. If the gl=US, gr=US-CA and gcs=San+Francisco, then the location is set to \"San Francisco,CA,US\". If any parameter is missing, it is skipped from the final location string. For example, if gcs is missing above, the location would be \"CA,US\". This and LEGACY_PARTNER_GL_PARAM will be generated when gr/gcs are present. Always corresponds to the CURRENT_LOCATION role.", + "Overrides all other default locations. It is a freeform address string. It always corresponds to the DEFAULT_LOCATION role. It is intended for testing only. NOTE: Please talk to oolong-team before using this producer. It should be used for one-off overrides only.", + "Location specified by viewport CGI parameters sll, sspn.", + "Location extracted from Happy Hour (signed-in user). Will be used with HISTORICAL_LOCATION role.", + "Descriptor generated from stickiness params feature id.", + "Location determined by a turn-by-turn-navigation client triggered by a reroute event. A location of this producer should additionally specify a semantic with LocationSemantic members to differentiate them among each other.", + "Location containing a feature ID determined by HULK realtime snap-to-place. The latlng and timestamp will correspond to the device location at the point the snap-to-place request was made. The confidence value is the confidence of that feature according to the snap-to-place response. This will usually be used with the CURRENT_LOCATION role, although might also be a HISTORICAL_LOCATION in cases where we are expressing a series of recent snap-to-place results.", + "Location containing a feature ID determined by HULK realtime snap-to-place as in SNAP_TO_PLACE_IMPLICIT, but which was subsequently confirmed by the user. As in SNAP_TO_PLACE_IMPLICIT the confidence value will reflect the value returned by the snap-to-place response, but backends may choose to ignore that value and assume the confidence is 100% since the user has explicitly chosen to interact with the place (the ambiguity is worth capturing though since the UI flow will not necessarily constitute an actual confirmation of a user's presence in a place). This will usually be used with the CURRENT_LOCATION role, although might also be a HISTORICAL_LOCATION in cases where we are expressing a series of recent snap-to-place results.", + "Location extracted from HappyHour which correspond to user's home and work locations. These locations are fetched from HulkUserPlaces HappyHour object (go/hulk-in-happyhour). This will be used with role=DEFAULT_LOCATION and LocationSemantic will indicate whether this location is home or work. AdWords will be the first client of this data. These locations are confirmed by the user. DEPRECATED: No longer used in production.", + "Similar to the above producer, except that these locations are inferred by happyhour and are not confirmed by the user. Two different producers are being used for confirmed and inferred locations as their use might have different privacy implications. Design doc: go/homeworktargeting DEPRECATED: No longer used in production.", + "The location extracted from a search nearby request in Tactile.", + "Location determined by Maps Activity in GMM client, corresponding to a previous location of the user for which nearby places are requested. This will be used with role=USER_SPECIFIED_FOR_REQUEST.", + "This descriptor is to only be used for experiments controlled by ipgeo team. During experimentation or ramping up launches, when this is provided in addition to IP_ADDRESS, this one is guaranteed to contain the result of the baseline ip index until the launch is at 100 % for both search and ads. Note that the definition of baseline may change depending on the product that uses it. For example, in search it may contain the old index whereas in Ads it may contain the experimental index. Contact the ipgeo-team for more details.", + "This descriptor is intended for a client to pass an offset used to anonymize all pii coordinates in a SearchAlongRouteContext or EnrouteContext. Anonymized coordinates are set as relative to DIRECTIONS_START_POINT rather than as absolute locations. This should be used with role = USER_SPECIFIED_FOR_REQUEST.", + "This producer indicates the location is from the search-along-route system. This producer is not intended to be used in a raw LocationResult; rather it is a descriptor for use with downstream processed locations (such as LocationRankingTargetLocation).", + "This producer returns the best guess for the user location as projected onto a specific route that the user is following. Users using driving navigation most often follow the route they are being told. On occasion they deviate, and sometimes it is not clear whether they have deviated or not. To represent both possibilities, Google Maps for Mobile sends both (a) the user location snapped to the road network and (b) the user location snapped to the specific route the user is being told to follow. The former has DEVICE_LOCATION producer and the latter has SNAP_TO_ROUTE producer.", + "This descriptor was generated from Google My Business location as a lat/lng. Always corresponds to USER_SPECIFIED_FOR_REQUEST.", + "This is a device location that has been rejected for some reason. It is only kept in the location context so we can analyze them in logs.", + "This is a device location that has been quantized on device for privacy purposes, for use by NBN in GMM backends. Consult with pwg-geo@ and oolong-team@ before using this producer.", + "A location found in the history of a gaia user in GWS. Similar to GWS_MOBILE_HISTORY_ZWIEBACK, but works only for gaia users. Differs from GAIA_LOCATION_HISTORY - it is extracted from user search requests (not from user location reports on Android) and stored in Kansas (not in HappyHour). DEPRECATED: replaced with the OOLONG_REALTIME_CACHE producer.", + "A FUTURE_LOCATION signal originating from the user location forecast producer in Context Manager: go/context-manager.", + "A HISTORICAL_LOCATION region collected on device over time: go/gmm-terroir. DEPRECATED(2018-02-20): b/124457814.", + "The descriptor was generated by the Google News UI. Always corresponds to USER_SPECIFIED_FOR_REQUEST.", + "The descriptor was generated by the user's preferred delivery address configured in Google Shopping Express. go/shipping-address", + "Information about the device, without actual location data, e.g. ActivityRecord.", + "A FUTURE_LOCATION signal produced by travel state intent: go/travel-triggering.", + "A frequently visited place of a user, see go/hulk-routines-implementation. For Location History users only. Experimental, consult with oolong-team@ before using this producer.", + "A special enum value for representing a wildcard producer (matches any producer). This must never be used as the producer for a descriptor.", + "The descriptor was generated by Toolbar and passed via the legacy X_TOOLBAR_LOCATION header. It always corresponds to a CURRENT_LOCATION.", + "The descriptor was generated by Mobile Frontend and passed via the legacy \"gll\" and \"near\" params. It always corresponds to a CURRENT_LOCATION. The \"gll\" parameter appears in latlng (and, if applicable latlng_span) and if there's a \"near\" parameter, it appears in the loc field. Note that other uses of \"gll\" are not covered by this producer. DEPRECATED(finnegan): As of 2010/03/26. This will be renamed eventually.", + "The descriptor was generated by Mobile Frontend and passed via the legacy \"near\" param (without \"gll\"). This has different semantics from those of LEGACY_NEAR_PARAM. It always corresponds to a CURRENT_LOCATION. DEPRECATED(finnegan): As of 2010/03/26. This will be renamed eventually.", + "A result that was ablated for an experiment.", + "Location coming from Oolong location cache (go/ort-cache-dd).", + "Same as OOLONG_REALTIME_CACHE but only used for experiments controlled by Oolong team.", + "Location coming from an internal superroot call trying to resolve one directions waypoint in the context of a known one. This will be used inside DirectionsSearch flow in superroot before sending a request to the WebPlusLocal node in superroot.", + "Viewport derived in Superroot after organic results are available.", + "Location from the Search Region Settings in Search Settings (stored in the Zwieback cookie). Always combined with the DEFAULT_LOCATION role. Search uses this setting to determine the jurisdiction region (for signed-in and signed-out traffic), but does so on the GWS side and sends only the output of its logic as a GWS_JURISDICTION_COUNTRY result to Oolong Service. Thus, it does not need to use this producer. Conversely, for Assistant traffic, the jurisdiction region is determined in LES from the various input signals (including this one). Prioritization between the various signals for Assistant is described in go/assistant-region and implemented in google3/googledata/location/unified/location_service/client_configuration.textproto.", + "A location that originates in assistant. The location is contained in a LocationDescriptor across assistant. The source of the location is unknown but it is not a DEVICE_LOCATION. go/as-oolong-launch", + "A location indicated by the user as their default to be used for the current location.", + "Viewport override for GLS ad retrieval." + ], + "type": "string" + }, + "provenance": { + "description": "Extra information about how this descriptor was obtained. Provenance is intended for logging non-semantic details about a descriptor (e.g., whether it was passed using a particular parameter or stored in a particular backend). It should *never* be used as a criterion for selection by a policy or backend (use role/producer instead). This is for bookkeeping only. You don't want this field. Really.", + "enum": [ + "UNREMARKABLE", + "TOOLBAR", + "MOBILE_FE", + "LEGACY_MOBILE_FRONTEND_GLL_PARAM", + "MAPS_FRONTEND_IL_DEBUG_IP", + "LEGACY_MOBILE_FRONTEND_NEAR_PARAM", + "GWS_MOBILE_CLIENT", + "GWS_MOBILE_CLIENT_ESSENTIAL_ONLY", + "XFF_HEADER", + "XGEO_HEADER", + "LEGACY_GEO_POSITION_HEADER", + "ASSISTANT_SETTINGS_FOR_CURRENT_DEVICE", + "ASSISTANT_DEVICE_PROPERTIES", + "EVAL_UNIQUE_SELECTED_USER_LOCATION", + "EVAL_BASE_UNIQUE_SELECTED_USER_LOCATION", + "EVAL_EXP_UNIQUE_SELECTED_USER_LOCATION", + "PERSONAL_LOCATION_MODEL_QUERY_ONLY" + ], + "enumDescriptions": [ + "THIS VALUE MUST BE THE FIRST IN THIS ENUM. Default value. Nothing interesting about the descriptor's provenance.", + "Descriptor came from the Google Toolbar.", + "Descriptor came from the Mobile Frontend", + "Descriptor came via from Mobile Frontend via the legacy \"gll\" param.", + "Descriptor came from the Maps Frontend il parameter, with a type of ip.", + "Descriptor came via from Mobile Frontend via the legacy \"near\" param.", + "Descriptor came from GWS via the client library.", + "Essential-only mode version of GWS_MOBILE_CLIENT.", + "Descriptor came from X-Forwarded-For HTTP Header.", + "Descriptor came from X-Geo HTTP header or an app-internal flow that retrieves location in an X-Geo equivalent way.", + "Descriptor came from legacy Geo-Position HTTP header.", + "Descriptor came from the Assistant settings for the current device (see also go/opa-settings).", + "Descriptor came from the Assistatn DeviceProperties.location_descriptor field. This is used by some client surfaces (e.g. KaiOS).", + "DO NOT use the following three without consulting with oolong-team. They are used by Evals to force a given location to be the chosen one.", + "", + "", + "INTERNAL ONLY DO NOT use the following values without first consulting oolong-team@. These should be considered internal details of Oolong's business logic and generally should not be used by clients. Indicates a PLM that was built using query (or query-like) inputs only." + ], + "type": "string" + }, + "radius": { + "description": "The radius within which one standard deviation (or 68%) of possible locations lie, assuming a normal distribution around latlng. This radius is normally seen in the UI of mobile maps as the blue 'accuracy circle', although the interpretation (e.g. 1sd or 2sd) may vary by platform. Units must be in mm.", + "format": "float", + "type": "number" + }, + "rect": { + "$ref": "LocationUnifiedLatLngRect", + "description": "A viewport or bounds depending on role/producer. For example, when role is VIEWPORT this field represents a viewport. 'latlng' and 'rect' are mutually exclusive." + }, + "role": { + "description": "The role of this location.", + "enum": [ + "UNKNOWN_ROLE", + "CURRENT_LOCATION", + "DEFAULT_LOCATION", + "QUERY", + "USER_SPECIFIED_FOR_REQUEST", + "HISTORICAL_QUERY", + "HISTORICAL_LOCATION", + "VIEWPORT", + "FUTURE_LOCATION", + "INVALID_LOCATION", + "EXPERIMENTAL_LOCATION", + "CURRENT_CONTEXT", + "FINAL_VIEWPORT", + "GLS_FINAL_VIEWPORT", + "WILDCARD_ROLE" + ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], + "enumDescriptions": [ + "THIS VALUE MUST BE THE FIRST IN THIS ENUM. Default value used to identify unset fields including those resulting from enum values unknown to an out-dated binary. This should be used only to check for errors. A descriptor with this role is invalid and should be ignored.", + "The location is the device's current, physical location. Semantics: * unique * implicit * immediate", + "A user-specified default location. The suggested interpretation is as a literal default; in the absence of better information or a reasonable understanding of the user's intent, use the default location. Semantics: * unique * explicit * persistent", + "A descriptor corresponding to the query in a request (if any). A query may or may not contain location information but a descriptor is created and geocoding attempted in case there is one. The query is specified in the loc field and can take two forms, the raw query or an squery. The form is indicated by the corresponding producer (RQUERY or SQUERY). Semantics: * unique * explicit * immediate", + "A user-specified location specific to this request but not part of a query. These typically come from the user entering an overriding location in some separate UI field and submitting a request (e.g, overriding the location of weather results or setting a new default location). The source of the override is indicated by the producer. While it is technically possible to have multiple overrides for a request, that suggests a confusing user experience. Semantics: * unique * explicit * immediate", + "DEPRECATED: This was never used in production and is replaced by HISTORICAL_LOCATION.", + "A descriptor corresponding to some past location associated with the current request. This location may have come from a variety of sources (e.g., a history of queries) and the source of the location is indicated by the producer. There can be more than one historical location in a context. Historical locations should always have an associated timestamp. The original metadata for the location should be added via the historical_role and historical_producer fields. Semantics: * repeated * implicit * persistent", + "A descriptor corresponding to a user-visible viewport (e.g., Maps viewport, Streetview viewport, mobile camera viewport). This viewport may have come from a variety of sources, indicated by the producer. We expect there to be only one viewport active (hence \"unique\" semantics). We assume that the user has explicitly accepted and is aware of the viewport (hence \"explicit\" semantics). The viewport is associated only with the current query (hence \"immediate\" semantics). Viewports are expressed via rect. Semantics: * unique * explicit * immediate", + "A descriptor corresponding to a prediction of the future location of the user issuing the request. This location may have come from a variety of sources (e.g. calendar, user profile, etc) and the source of the location is indicated by the producer. There can be more than one future location in a context. Future locations should always have associated presence_interval:s. Semantics: * repeated * implicit * persistent", + "A descriptor corresponding to an invalid location, e.g. rect is invalid in it. Producer is kept as the original producer, original role is lost. A location with this role should not be used in production. Semantics: * repeated", + "Experimental device location produced by GmsCore, not to be used in any oolong policy. Only for quality check before switch to GmsCore as X-Geo header producer in AGSA. go/agsa-xgeo-integration-dd - AGSA XGeo Context Manager integration. * repeated", + "Current location related data, without actual location information, e.g. ActivityRecord. Semantics: * unique * implicit * immediate", + "A descriptor corresponding to the viewport that will be shown to the user after the request completes, such as a query 'tour eiffel', or a direction MTV to SFO. This viewport only appears together with the ADS_FINAL_VIEWPORT producer. We expect there to be only one at a time (hence \"unique\" semantics). We assume that the user has explicitly requested it and is aware of the viewport (hence \"explicit\" semantics). The viewport is associated only with the current query (hence \"immediate\" semantics). Viewports are expressed via rect. Semantics: * unique * explicit * immediate", + "A descriptor corresponding to a viewport that will be used for GLS ad retrieval. On some surfaces (e.g. xGMM apps), the final viewport is expanded to improve ad retrieval for other ads. This larger viewport works poorly for GLS ad retrieval, so we will extract the original, unexpanded, final viewport as well. This viewport only appears together with the ADS_GLS_FINAL_VIEWPORT producer. We expect there to be only one at a time (\"unique\"). This viewport is the final displayed viewport (\"explicit\"). The viewport is associated only with the current query (\"immediate\"). Semantics: * unique * explicit * immediate", + "A special enum value for representing a wildcard role (matches any role). This must never be used as the role for a descriptor." + ], + "type": "string" + }, + "semantic": { + "description": "Some producers may additionally specify semantics explaining the meaning of a location, in particular to differentiate several locations with the same producer.", + "items": { + "enum": [ + "SEMANTIC_UNKNOWN", + "SEMANTIC_REROUTE_SOURCE", + "SEMANTIC_REROUTE_PROPOSED", + "SEMANTIC_REROUTE_TAKEN", + "SEMANTIC_HOME", + "SEMANTIC_WORK", + "SEMANTIC_ONBOARD_TRANSIT", + "SEMANTIC_MAPS_SEARCH", + "SEMANTIC_FREQUENT_PLACE", + "SEMANTIC_OTHER" + ], + "enumDescriptions": [ + "THIS VALUE MUST BE THE FIRST IN THIS ENUM. Default value used to identify unset fields including those resulting from enum values unknown to an out-dated binary. This should be used only to check for errors.", + "A descriptor corresponding to an already traveled location on a user's route as part of reroute information. The location producer of these should be TURN_BY_TURN_NAVIGATION_REROUTE.", + "A descriptor corresponding to a not traveled location on a user's route (before a reroute event) as part of reroute information. The location producer of these should be TURN_BY_TURN_NAVIGATION_REROUTE.", + "A descriptor corresponding to an actually traveled location (in contrast to a supposed-to travel location) as part of reroute information. The location producer of these should be TURN_BY_TURN_NAVIGATION_REROUTE.", + "A descriptor corresponding to the maps aliased location.", + "", + "A descriptor corresponding to a location of a user who is riding on a transit vehicle.", + "user searched for this place", + "user frequently visits this place", + "other maps alias icon" + ], + "type": "string" + }, + "type": "array" + }, + "semanticPlace": { + "description": "If there are multiple semantic places, then the first place is the finest, then come the parent hierarchy. This field should not be logged anywhere.", + "items": { + "$ref": "LocationUnifiedSemanticPlace" + }, + "type": "array" + }, + "timestamp": { + "description": "A timestamp associated with this location expressed as the number of microseconds since 00:00:00 Jan-1-1970 UTC. If not set, assumed to be \"now\" or irrelevant. Use this field to indicate when this location has been acquired (e.g. by requesting location from the device).", + "format": "int64", + "type": "string" + }, + "visibleNetwork": { + "deprecated": true, + "description": "A list of visible networks that describe the location and can geocoded by GLS. This field should not be logged anywhere.", + "items": { + "$ref": "LocationUnifiedVisibleNetwork" + }, + "type": "array" + } + }, + "type": "object" + }, + "LocationUnifiedLocationResult": { + "description": "All information about a single location within a context. This includes the descriptor, which can be thought of as a kind of \"query\" that minimally specifies the location, and rest (i.e., geocoding data, policy annotations, etc.). A LocationResult typically starts with just a descriptor and the rest is added later via lookups. If necessary, persistent locations can be stored as a pre-geocoded LocationResult to avoid the extra work. Next Available Tag: 14", + "id": "LocationUnifiedLocationResult", + "properties": { + "alternateAnnotations": { + "description": "Additional sets of annotations from other oolong policies.", + "items": { + "$ref": "LocationUnifiedAnnotationSet" + }, + "type": "array" + }, + "annotations": { + "description": "The annotations that have been applied to this result for use in production.", + "items": { + "$ref": "LocationUnifiedLocationAnnotation" + }, + "type": "array" + }, + "defaultBlockingData": { + "$ref": "DefaultBlockingDataProto", + "description": "Information about whether the feature hierarchy contains default-blocked features." + }, + "desc": { + "$ref": "LocationUnifiedLocationDescriptor", + "description": "The descriptor for this result. Once added, descriptors should be considered immutable. Any additional information should be included elsewhere in the result." + }, + "displayable": { + "description": "Flag to indicate this result has human-readable names for display.", + "type": "boolean" + }, + "extraData": { + "$ref": "LocationUnifiedLocationResultExtraData" + }, + "featureRefs": { + "description": "The feature hierarchy for this location result, if using the new feature-pool format instead of les_response.", + "items": { + "$ref": "LocationUnifiedFeatureReference" + }, + "type": "array" + }, + "geocoded": { + "description": "True indicates that this result has geographical information like a lat/long, bounding box, etc.). The minimum is a lat/long. False only indicates that no such data is present and does NOT explain the reason (e.g., geocoding hasn't been attempted, geocoding timed out, the descriptor does not refer to a location, etc.).", + "type": "boolean" + }, + "geocodingReason": { + "description": "Explains the specific reason for the value of the geocoded field, if any. This can be used to determine whether a descriptor needs to be geocoded. Used for making runtime decisions about whether to attempt geocoding.", + "enum": [ + "DEFAULT_REASON", + "NO_GEOCODING_RESULTS", + "RPC_FAILED" + ], + "enumDescriptions": [ + "No reason is required to explain the value of the geocoded field. For geocoded = true, geocoding data is available. For geocoded = false, geocoding has not been attempted.", + "Geocoding was attempted but returned no results for the descriptor. This usually means that the descriptor does not refer to a recognized location (e.g., the query [pizza]). Only valid for geocoded = false.", + "One or more geocoding RPCs failed." + ], + "type": "string" + }, + "lesResponse": { + "$ref": "LocationExtractorLocationExtractionResponse", + "description": "WARNING: Do not reference this field directly check go/oolong-usage on how to access the values present in this proto or contact oolong-team@google.com if you don't see what you need." + }, + "nonstandardData": { + "$ref": "MessageSet", + "description": "Allow pipelines to associate arbitrary data (e.g., specialized geo identifiers) with a result. Chiefly intended to pass custom data around backends after standard geocoding and policy execution. Oolong libraries will generally ignore such data but may strip it to guard against cache fragmentation. Using this to pass data from frontends to backends before geocoding is not recommended and at your own risk. This field will carry AnonymizedBounds data which will be used for logging purposes." + }, + "policyResult": { + "$ref": "LocationUnifiedPolicyResult", + "description": "Result data computed by the policy annotation." + }, + "sourceDescription": { + "description": "Enum describing what this result was based on (e.g. location reported by the end user's phone). Present only if the LocationContext was produced by OolongService and this result has the USFUL annotation.", + "enum": [ + "SOURCE_DESCRIPTION_UNSPECIFIED", + "FROM_YOUR_INTERNET_ADDRESS", + "FROM_YOUR_LOCATION_HISTORY", + "BASED_ON_YOUR_LOCATION_HISTORY", + "FROM_YOUR_DEVICE", + "BASED_ON_YOUR_PAST_ACTIVITY", + "FROM_YOUR_PLACES_HOME", + "FROM_YOUR_PLACES_WORK" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "", + "", + "", + "" + ], + "type": "string" + } + }, + "type": "object" + }, + "LocationUnifiedLocationResultExtraData": { + "description": "Includes data that is included only for small subset of results. Next Available Tag: 4", + "id": "LocationUnifiedLocationResultExtraData", + "properties": { + "featureDiff": { + "description": "Result caused a feature diff", + "type": "boolean" + }, + "interpretationData": { + "$ref": "LocationUnifiedInterpretationData", + "description": "For query results." + }, + "ipblockinfo": { + "$ref": "IPBlockInfoProto", + "description": "Information about an ip block, like range, speed etc. This could be the only thing present in an empty result." + } + }, + "type": "object" + }, + "LocationUnifiedOolongFeature": { + "description": "A featurelet corresponds to a single Mapfacts feature. These messages contain only the base data, without anything added by the Oolong policy (like trimming annotations or confidences). Next available tag: 11 LINT.IfChange", + "id": "LocationUnifiedOolongFeature", + "properties": { + "additionalData": { + "$ref": "MessageSet", + "description": "A field to attach additional data about the feature. For example, the location extraction server uses this field to include the ads criteria id of the featurelet if available. As specified by MessageSet, all types within the set must be unique. Using the changelist number where the message was created is a good method of ensuring uniqueness." + }, + "areaRank": { + "description": "Copy of FeatureProto->RankDetailsProto->area_rank", + "format": "float", + "type": "number" + }, + "center": { + "$ref": "GeostorePointProto", + "description": "Latitude and longitude of the feature center." + }, + "establishmentType": { + "description": "This field contains original feature's establishment type if it had one.", + "enum": [ + "TYPE_ANY", + "TYPE_UNDEFINED", + "TYPE_DEPRECATED_AVIATION", + "TYPE_BUSINESS", + "TYPE_TRAVEL_SERVICE", + "TYPE_LODGING", + "TYPE_HOTEL", + "TYPE_RESORT", + "TYPE_MOTEL", + "TYPE_HOSTEL", + "TYPE_GUESTHOUSE", + "TYPE_VACATION_RENTAL", + "TYPE_GAS_STATION", + "TYPE_REST_AREA", + "TYPE_CASH_MACHINE", + "TYPE_CAR_RENTAL", + "TYPE_CAR_REPAIR", + "TYPE_TAXI_STAND", + "TYPE_TRAVEL_AGENT", + "TYPE_BICYCLE_RENTAL_POINT", + "TYPE_ELECTRIC_VEHICLE_CHARGING_STATION", + "TYPE_SHOPPING", + "TYPE_GROCERY", + "TYPE_ANTIQUES", + "TYPE_APPAREL", + "TYPE_GIFTS", + "TYPE_JEWELRY", + "TYPE_SPORTING_GOODS", + "TYPE_VEHICLE", + "TYPE_SHOPPING_CENTER", + "TYPE_SUPERMARKET", + "TYPE_FAIRGROUNDS", + "TYPE_MARKET", + "TYPE_PRODUCE_MARKET", + "TYPE_FARMERS_MARKET", + "TYPE_LIQUOR_STORE", + "TYPE_SOUVENIR_SHOP", + "TYPE_INDUSTRIAL", + "TYPE_CONSTRUCTION", + "TYPE_BUILDING_MATERIAL", + "TYPE_SECURITY_PRODUCTS", + "TYPE_MECHANICAL", + "TYPE_TEXTILE", + "TYPE_CHEMICAL", + "TYPE_METAL", + "TYPE_TRANSPORTATION", + "TYPE_FREIGHT", + "TYPE_AVIATION", + "TYPE_COURIER", + "TYPE_MOVING", + "TYPE_PACKAGING", + "TYPE_RAIL", + "TYPE_PUBLIC_TRANSIT", + "TYPE_WAREHOUSE", + "TYPE_DEFENSE", + "TYPE_AGRICULTURE", + "TYPE_PLANTATION", + "TYPE_PLANT_NURSERY", + "TYPE_DESIGN", + "TYPE_UTILITIES", + "TYPE_POWER_PLANT", + "TYPE_SEWAGE_TREATMENT_PLANT", + "TYPE_WATER_TREATMENT_PLANT", + "TYPE_SUBSTATION", + "TYPE_MANUFACTURING", + "TYPE_BIOTECH", + "TYPE_MATERIALS", + "TYPE_MINING", + "TYPE_QUARRY", + "TYPE_TANNERY", + "TYPE_OIL_REFINERY", + "TYPE_ADVERTISING_MARKETING", + "TYPE_LEGAL", + "TYPE_FAMILY_LAW", + "TYPE_IP_LAW", + "TYPE_LABOR_LAW", + "TYPE_PERSONAL_INJURY_LAW", + "TYPE_CRIMINAL_LAW", + "TYPE_PERSONAL_FINANCE", + "TYPE_LIFE_INSURANCE", + "TYPE_LENDING", + "TYPE_ACCOUNTING", + "TYPE_INVESTING", + "TYPE_BANKING", + "TYPE_HEALTH", + "TYPE_HEALTH_EQUIPMENT", + "TYPE_NURSING", + "TYPE_HEALTH_INSURANCE", + "TYPE_HEALTH_FACILITY", + "TYPE_DIAGNOSTIC_CENTER", + "TYPE_HEALTH_RESOURCES", + "TYPE_NUTRITION", + "TYPE_VISION", + "TYPE_COUNSELING", + "TYPE_MASSAGE", + "TYPE_BLOOD_BANK", + "TYPE_HEARING", + "TYPE_HOME_GARDEN", + "TYPE_INTERIOR_DECOR", + "TYPE_DOMESTIC_SERVICES", + "TYPE_APPLIANCES", + "TYPE_PEST_CONTROL", + "TYPE_GARDENING", + "TYPE_ELECTRONICS", + "TYPE_COMPUTER", + "TYPE_COMPUTER_HARDWARE", + "TYPE_COMPUTER_SECURITY", + "TYPE_COMPUTER_SOFTWARE", + "TYPE_COMPUTER_SUPPORT", + "TYPE_AUDIO_DEVICES", + "TYPE_VIDEO_DEVICES", + "TYPE_REAL_ESTATE", + "TYPE_OFFICE_SERVICES", + "TYPE_ENTERTAINMENT", + "TYPE_GAMES", + "TYPE_CASINO", + "TYPE_LOTTO", + "TYPE_VIDEO", + "TYPE_CLUBS", + "TYPE_DISCOTHEQUE", + "TYPE_ANIMATION", + "TYPE_MODELING", + "TYPE_HUMOR", + "TYPE_MOVIES", + "TYPE_MOVIE_RENTAL", + "TYPE_MOVIE_THEATER", + "TYPE_MUSIC", + "TYPE_RADIO", + "TYPE_TV", + "TYPE_BAR", + "TYPE_PRINT_MEDIA", + "TYPE_ADULT", + "TYPE_SEXUAL_SERVICES", + "TYPE_ANIMALS", + "TYPE_PETS", + "TYPE_FISHERY", + "TYPE_ARTS", + "TYPE_BOOKS", + "TYPE_PERFORMING_ARTS", + "TYPE_GALLERY", + "TYPE_AUTOMOTIVE", + "TYPE_PARTS", + "TYPE_AUTO_FINANCE", + "TYPE_AUTO_INSURANCE", + "TYPE_RV", + "TYPE_MOTORCYCLES", + "TYPE_CARS", + "TYPE_TRUCKS_SUVS", + "TYPE_LICENSING", + "TYPE_MAINTENANCE", + "TYPE_PERSONAL_CARE", + "TYPE_BODY_ART", + "TYPE_COSMETICS", + "TYPE_FITNESS", + "TYPE_YOGA_CENTER", + "TYPE_GYM", + "TYPE_HAIR_CARE", + "TYPE_SPA", + "TYPE_BEAUTY_SALON", + "TYPE_CORPORATE_EVENTS", + "TYPE_HUMAN_RESOURCES", + "TYPE_FOOD_AND_DRINK", + "TYPE_BEVERAGE", + "TYPE_RECIPES", + "TYPE_COOKWARE", + "TYPE_CULINARY", + "TYPE_RETAIL", + "TYPE_RESTAURANT", + "TYPE_COFFEE", + "TYPE_BAKERY", + "TYPE_FOOD_CENTER", + "TYPE_TEA", + "TYPE_CAFE", + "TYPE_WINERY", + "TYPE_BREWERY", + "TYPE_FAST_FOOD", + "TYPE_FOOD_DELIVERY", + "TYPE_INTERNET", + "TYPE_WEB_DESIGN", + "TYPE_WEB_HOSTING", + "TYPE_WEB_SERVICES", + "TYPE_LIFESTYLE", + "TYPE_PHOTO_VIDEO", + "TYPE_ACTIVITIES", + "TYPE_BOATING", + "TYPE_CYCLING", + "TYPE_EQUESTRIAN", + "TYPE_FISHING", + "TYPE_HIKING", + "TYPE_HUNTING", + "TYPE_SWIMMING", + "TYPE_GOLF", + "TYPE_GOLF_COURSE", + "TYPE_BASEBALL", + "TYPE_BASKETBALL", + "TYPE_HOCKEY", + "TYPE_MOTOR_SPORTS", + "TYPE_WINTER_SPORTS", + "TYPE_FOOTBALL", + "TYPE_SOCCER", + "TYPE_ICE_SKATING", + "TYPE_BOXING", + "TYPE_CRICKET", + "TYPE_ROWING", + "TYPE_RUGBY", + "TYPE_RACQUET_SPORTS", + "TYPE_ROCK_CLIMBING", + "TYPE_REFERENCES", + "TYPE_MAPS", + "TYPE_TIME", + "TYPE_SCIENTIFIC_EQUIPMENT", + "TYPE_TELECOMMUNICATIONS", + "TYPE_EVENT_VENUE", + "TYPE_BANQUET_HALL", + "TYPE_CONFERENCE_HALL", + "TYPE_WEDDING_HALL", + "TYPE_EXHIBITION_HALL", + "TYPE_COMMUNITY_CENTER", + "TYPE_AUDITORIUM", + "TYPE_FUNCTION_HALL", + "TYPE_CONCERT_HALL", + "TYPE_AMPHITHEATER", + "TYPE_LAUNDRY", + "TYPE_LAUNDROMAT", + "TYPE_DRY_CLEANER", + "TYPE_MORTUARY", + "TYPE_REPAIR_AND_MAINTENANCE", + "TYPE_GOVERNMENT", + "TYPE_BORDER_CROSSING", + "TYPE_CITY_HALL", + "TYPE_COURTHOUSE", + "TYPE_EMBASSY", + "TYPE_LIBRARY", + "TYPE_PRISON", + "TYPE_TAX_OFFICE", + "TYPE_PROSECUTORS_OFFICE", + "TYPE_CONGRESS", + "TYPE_TOWN_COUNCIL", + "TYPE_CAPITOL_BUILDING", + "TYPE_VOTING_FACILITY", + "TYPE_CHECKPOINT", + "TYPE_SCHOOL", + "TYPE_UNIVERSITY", + "TYPE_ORPHANAGE", + "TYPE_KINDERGARTEN", + "TYPE_DAYCARE", + "TYPE_ACADEMY", + "TYPE_TRADE_SCHOOL", + "TYPE_SKILL_INSTRUCTION", + "TYPE_EMERGENCY", + "TYPE_HOSPITAL", + "TYPE_PHARMACY", + "TYPE_POLICE", + "TYPE_FIRE", + "TYPE_DOCTOR", + "TYPE_DENTIST", + "TYPE_VETERINARIAN", + "TYPE_FIRST_AID", + "TYPE_CIVIL_DEFENSE", + "TYPE_TOURIST_DESTINATION", + "TYPE_ECO_TOURIST_DESTINATION", + "TYPE_BIRD_WATCHING", + "TYPE_NATURE_RESERVE", + "TYPE_MUSEUM", + "TYPE_VISITOR_CENTER", + "TYPE_OBSERVATION_DECK", + "TYPE_OBSERVATORY", + "TYPE_SCENIC_POINT", + "TYPE_ZOO", + "TYPE_AQUARIUM", + "TYPE_AMUSEMENT_PARK", + "TYPE_MONUMENT", + "TYPE_PALACE", + "TYPE_FORT", + "TYPE_TOWER", + "TYPE_LIGHTHOUSE", + "TYPE_TEMPLE", + "TYPE_CHURCH", + "TYPE_GURUDWARA", + "TYPE_HINDU_TEMPLE", + "TYPE_MOSQUE", + "TYPE_SYNAGOGUE", + "TYPE_BUDDHIST_TEMPLE", + "TYPE_JAIN_TEMPLE", + "TYPE_BAHAI_TEMPLE", + "TYPE_SHINTO_TEMPLE", + "TYPE_MORMON_TEMPLE", + "TYPE_SPORTS_COMPLEX", + "TYPE_STADIUM", + "TYPE_BOWLING", + "TYPE_BADMINTON", + "TYPE_TENNIS", + "TYPE_TABLE_TENNIS", + "TYPE_PARK", + "TYPE_LOCAL_PARK", + "TYPE_NATIONAL_PARK", + "TYPE_US_NATIONAL_PARK", + "TYPE_US_NATIONAL_MONUMENT", + "TYPE_NATIONAL_FOREST", + "TYPE_NATIONAL_GRASSLAND", + "TYPE_NATIONAL_PRESERVE", + "TYPE_NATIONAL_RECREATION_AREA", + "TYPE_NATIONAL_MONUMENT", + "TYPE_NATIONAL_HISTORIC_AREA", + "TYPE_NATIONAL_SCENIC_AREA", + "TYPE_NATIONAL_SCENIC_ROADWAY_AREA", + "TYPE_NATIONAL_SCENIC_RIVER_AREA", + "TYPE_PROVINCIAL_PARK", + "TYPE_PROVINCIAL_FOREST", + "TYPE_CAMPGROUNDS", + "TYPE_WILDERNESS_AREA", + "TYPE_WILDLIFE_AREA", + "TYPE_BOTANICAL_GARDEN", + "TYPE_GARDEN", + "TYPE_ARBORETUM", + "TYPE_MARINE_PROTECTED_AREA", + "TYPE_AIRPORT", + "TYPE_TARMAC", + "TYPE_HELIPORT", + "TYPE_SEAPLANE_BASE", + "TYPE_MILITARY_AIRBASE", + "TYPE_CEMETERY", + "TYPE_MILITARY", + "TYPE_ENCLOSED_TRAFFIC_AREA", + "TYPE_PARKING", + "TYPE_OFF_ROAD_AREA", + "TYPE_POST_OFFICE", + "TYPE_HOUSING_DEVELOPMENT", + "TYPE_BRIDGE", + "TYPE_ARCHAEOLOGICAL", + "TYPE_HISTORICAL", + "TYPE_RUINS", + "TYPE_TUNNEL", + "TYPE_RESIDENTIAL_DWELLING", + "TYPE_DETACHED_DWELLING", + "TYPE_ATTACHED_DWELLING", + "TYPE_APARTMENT", + "TYPE_GATED_COMMUNITY", + "TYPE_RETIREMENT_HOME", + "TYPE_TOLL_BOOTH", + "TYPE_CULTURAL", + "TYPE_CULTURAL_CENTER", + "TYPE_OVERPASS", + "TYPE_REST_ROOM", + "TYPE_PUBLIC_PHONE", + "TYPE_PHONE_BOOTH", + "TYPE_MANNED_PCO", + "TYPE_RESEARCH_INSTITUTE", + "TYPE_NON_GOVERNMENTAL_ORGANIZATION", + "TYPE_OFFICE_PARK", + "TYPE_MEDITATION_CENTER", + "TYPE_RELIGIOUS", + "TYPE_MONASTERY", + "TYPE_ASHRAM", + "TYPE_PAGODA", + "TYPE_MISSION", + "TYPE_PILGRIM_DESTINATION", + "TYPE_SOCIAL_SERVICE", + "TYPE_RANGER_STATION", + "TYPE_TRANSIT_STATION", + "TYPE_BUS_STATION", + "TYPE_TRAMWAY_STATION", + "TYPE_TRAIN_STATION", + "TYPE_SUBWAY_STATION", + "TYPE_FERRY_TERMINAL", + "TYPE_CABLE_CAR_STATION", + "TYPE_GONDOLA_LIFT_STATION", + "TYPE_FUNICULAR_STATION", + "TYPE_HORSE_CARRIAGE_STATION", + "TYPE_MONORAIL_STATION", + "TYPE_SEAPORT", + "TYPE_NATURAL_FEATURE", + "TYPE_ELEVATED", + "TYPE_PEAK" + ], + "enumDescriptions": [ + "ABSTRACT", + "Can be used for features where no establishment information is available. For example, if an importer generates a TYPE_ESTABLISHMENT_BUILDING feature, but source data does not have any information on the actual purpose of the building, the importer should use TYPE_UNDEFINED for establishment type.", + "DEPRECATED", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "Note: 0xF213F is reserved to extend TYPE_INDUSTRIAL", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "0xF6F is reserved and any new types should start with 0xF6F1", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "State parks, county parks, city parks, wilderness areas. This also includes underwater preserves, wild and scenic rivers, etc. Should we have things like baseball diamonds?", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "Wildlife management area. This includes preservation areas for fish, game, and birds.", + "", + "", + "", + "", + "", + "An airport is a location where aircraft such as fixed-wing aircraft, helicopters, and blimps takeoff and land. NOTE: TYPE_TARMAC establishment type has been deprecated in favor of TYPE_TARMAC feature type. Once all data is modeled using the new feature type, the entry below should be removed.", + "DEPRECATED", + "A heliport is a small airport suitable only for use by helicopters.", + "A seaplane base is a special airport suitable for seaplanes.", + "An airbase (sometimes referred to correctly as an airfield, military airport, or Royal Air Force Station or Air Force Station) is a military airfield that provides basing and support of military aircraft.", + "", + "", + "The term \"enclosed traffic area\" is used extensively in Europe. It generally refers to a parking lot or other similar area through which traffic passes but are not generally considered to be a road. Another example is a piazza in an Italian town.", + "Establishment TYPE_PARKING is used for parking lots or garages. The actual feature type can be TYPE_ESTABLISHMENT_GROUNDS or TYPE_ESTABLISHMENT_BUILDING to distinguish between those.", + "", + "", + "In some country (like China), there will have a small area of housing development. Normally covers one or more city blocks.", + "In the Australian data we get bridges as POIs effectively. We'd like to include them so we can mapsearch for \"Sydney Harbour Bridge\" and others. Many other data sets have bridges modeled directly as segments, and so don't require this.", + "", + "In some countries historical objects are well known and important.", + "", + "Feature must be TYPE_ESTABLISHMENT_GROUNDS.", + "These types, when used with appropriate feature type (TYPE_ESTABLISHMENT_BUILDING, TYPE_ESTABLISHMENT_GROUNDS) can refer to a single building or a residential area (respectively).", + "", + "", + "All multi-unit housing such as duplex, condominium, apartment belongs to this.", + "", + "", + "In Korea most toll booths have their own names, and are often used as reference points. If an importer generates TYPE_TOLL_BOOTH establishment features with exact positions and names, then mapsearch will index them. Also this can be used to render them.", + "", + "", + "An overpass, or flyover is a structure that passes over another road or railway.", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "Hierarchy of transit station types. See go/transit-schema for more details.", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "" + ], + "type": "string" + }, + "featureId": { + "$ref": "GeostoreFeatureIdProto", + "description": "The GeoStore Feature ID for this feature. This value is also used as key into the feature pool from FeatureReference's." + }, + "kgReference": { + "$ref": "GeostoreKnowledgeGraphReferenceProto", + "description": "The reference to an entity in the KnowledgeGraph." + }, + "name": { + "description": "Each Featurelet includes the list of names that are associated with the corresponding GeoStore Feature.", + "items": { + "$ref": "GeostoreNameProto" + }, + "type": "array" + }, + "populationRank": { + "description": "Copy of FeatureProto->RankDetailsProto->population_rank", + "format": "float", + "type": "number" + }, + "rect": { + "$ref": "GeostoreRectProto", + "description": "The bounding box of this feature." + }, + "type": { + "description": "The GeoStore Feature type.", + "enum": [ + "TYPE_ANY", + "TYPE_TRANSPORTATION", + "TYPE_ROUTE", + "TYPE_DEPRECATED_HIGHWAY_DO_NOT_USE", + "TYPE_HIGHWAY", + "TYPE_HIGHWAY_1", + "TYPE_HIGHWAY_2", + "TYPE_HIGHWAY_3", + "TYPE_HIGHWAY_4", + "TYPE_HIGHWAY_5", + "TYPE_HIGHWAY_6", + "TYPE_HIGHWAY_7", + "TYPE_HIGHWAY_8", + "TYPE_HIGHWAY_9", + "TYPE_BICYCLE_ROUTE", + "TYPE_TRAIL", + "TYPE_SEGMENT", + "TYPE_ROAD", + "TYPE_RAILWAY", + "TYPE_STANDARD_TRACK", + "TYPE_JR_TRACK", + "TYPE_NARROW_TRACK", + "TYPE_MONORAIL_TRACK", + "TYPE_SUBWAY_TRACK", + "TYPE_LIGHT_RAIL_TRACK", + "TYPE_BROAD_TRACK", + "TYPE_HIGH_SPEED_RAIL", + "TYPE_TROLLEY_TRACK", + "TYPE_FERRY", + "TYPE_FERRY_BOAT", + "TYPE_FERRY_TRAIN", + "TYPE_VIRTUAL_SEGMENT", + "TYPE_INTERSECTION", + "TYPE_TRANSIT", + "TYPE_TRANSIT_STATION", + "TYPE_BUS_STATION", + "TYPE_TRAMWAY_STATION", + "TYPE_TRAIN_STATION", + "TYPE_SUBWAY_STATION", + "TYPE_FERRY_TERMINAL", + "TYPE_AIRPORT", + "TYPE_AIRPORT_CIVIL", + "TYPE_AIRPORT_MILITARY", + "TYPE_AIRPORT_MIXED", + "TYPE_HELIPORT", + "TYPE_SEAPLANE_BASE", + "TYPE_AIRSTRIP", + "TYPE_CABLE_CAR_STATION", + "TYPE_GONDOLA_LIFT_STATION", + "TYPE_FUNICULAR_STATION", + "TYPE_SPECIAL_STATION", + "TYPE_HORSE_CARRIAGE_STATION", + "TYPE_MONORAIL_STATION", + "TYPE_SEAPORT", + "TYPE_TRANSIT_STOP", + "TYPE_TRANSIT_TRIP", + "TYPE_TRANSIT_DEPARTURE", + "TYPE_TRANSIT_LEG", + "TYPE_TRANSIT_LINE", + "TYPE_TRANSIT_AGENCY_DEPRECATED_VALUE", + "TYPE_TRANSIT_TRANSFER", + "TYPE_SEGMENT_PATH", + "TYPE_ROAD_SIGN", + "TYPE_INTERSECTION_GROUP", + "TYPE_PATHWAY", + "TYPE_RESTRICTION_GROUP", + "TYPE_TOLL_CLUSTER", + "TYPE_POLITICAL", + "TYPE_COUNTRY", + "TYPE_ADMINISTRATIVE_AREA", + "TYPE_ADMINISTRATIVE_AREA1", + "TYPE_US_STATE", + "TYPE_GB_COUNTRY", + "TYPE_JP_TODOUFUKEN", + "TYPE_ADMINISTRATIVE_AREA2", + "TYPE_GB_FORMER_POSTAL_COUNTY", + "TYPE_GB_TRADITIONAL_COUNTY", + "TYPE_ADMINISTRATIVE_AREA3", + "TYPE_ADMINISTRATIVE_AREA4", + "TYPE_ADMINISTRATIVE_AREA5", + "TYPE_ADMINISTRATIVE_AREA6", + "TYPE_ADMINISTRATIVE_AREA7", + "TYPE_ADMINISTRATIVE_AREA8", + "TYPE_ADMINISTRATIVE_AREA9", + "TYPE_COLLOQUIAL_AREA", + "TYPE_RESERVATION", + "TYPE_LOCALITY", + "TYPE_GB_POST_TOWN", + "TYPE_JP_GUN", + "TYPE_JP_SHIKUCHOUSON", + "TYPE_JP_SUB_SHIKUCHOUSON", + "TYPE_COLLOQUIAL_CITY", + "TYPE_SUBLOCALITY", + "TYPE_US_BOROUGH", + "TYPE_GB_DEPENDENT_LOCALITY", + "TYPE_JP_OOAZA", + "TYPE_JP_KOAZA", + "TYPE_JP_GAIKU", + "TYPE_GB_DOUBLE_DEPENDENT_LOCALITY", + "TYPE_JP_CHIBAN", + "TYPE_JP_EDABAN", + "TYPE_SUBLOCALITY1", + "TYPE_SUBLOCALITY2", + "TYPE_SUBLOCALITY3", + "TYPE_SUBLOCALITY4", + "TYPE_SUBLOCALITY5", + "TYPE_NEIGHBORHOOD", + "TYPE_CONSTITUENCY", + "TYPE_DESIGNATED_MARKET_AREA", + "TYPE_SCHOOL_DISTRICT", + "TYPE_LAND_PARCEL", + "TYPE_DISPUTED_AREA", + "TYPE_POLICE_JURISDICTION", + "TYPE_STATISTICAL_AREA", + "TYPE_CONSTITUENCY_FUTURE", + "TYPE_PARK", + "TYPE_GOLF_COURSE", + "TYPE_LOCAL_PARK", + "TYPE_NATIONAL_PARK", + "TYPE_US_NATIONAL_PARK", + "TYPE_US_NATIONAL_MONUMENT", + "TYPE_NATIONAL_FOREST", + "TYPE_PROVINCIAL_PARK", + "TYPE_PROVINCIAL_FOREST", + "TYPE_CAMPGROUNDS", + "TYPE_HIKING_AREA", + "TYPE_BUSINESS", + "TYPE_GOVERNMENT", + "TYPE_BORDER_CROSSING", + "TYPE_CITY_HALL", + "TYPE_COURTHOUSE", + "TYPE_EMBASSY", + "TYPE_LIBRARY", + "TYPE_SCHOOL", + "TYPE_UNIVERSITY", + "TYPE_EMERGENCY", + "TYPE_HOSPITAL", + "TYPE_PHARMACY", + "TYPE_POLICE", + "TYPE_FIRE", + "TYPE_DOCTOR", + "TYPE_DENTIST", + "TYPE_VETERINARIAN", + "TYPE_TRAVEL_SERVICE", + "TYPE_LODGING", + "TYPE_RESTAURANT", + "TYPE_GAS_STATION", + "TYPE_PARKING", + "TYPE_POST_OFFICE", + "TYPE_REST_AREA", + "TYPE_CASH_MACHINE", + "TYPE_CAR_RENTAL", + "TYPE_CAR_REPAIR", + "TYPE_SHOPPING", + "TYPE_GROCERY", + "TYPE_TOURIST_DESTINATION", + "TYPE_ECO_TOURIST_DESTINATION", + "TYPE_BIRD_WATCHING", + "TYPE_FISHING", + "TYPE_HUNTING", + "TYPE_NATURE_RESERVE", + "TYPE_TEMPLE", + "TYPE_CHURCH", + "TYPE_GURUDWARA", + "TYPE_HINDU_TEMPLE", + "TYPE_MOSQUE", + "TYPE_SYNAGOGUE", + "TYPE_STADIUM", + "TYPE_BAR", + "TYPE_MOVIE_RENTAL", + "TYPE_COFFEE", + "TYPE_GOLF", + "TYPE_BANK", + "TYPE_DOODLE", + "TYPE_GROUNDS", + "TYPE_AIRPORT_GROUNDS", + "TYPE_BUILDING_GROUNDS", + "TYPE_CEMETERY", + "TYPE_HOSPITAL_GROUNDS", + "TYPE_INDUSTRIAL", + "TYPE_MILITARY", + "TYPE_SHOPPING_CENTER", + "TYPE_SPORTS_COMPLEX", + "TYPE_UNIVERSITY_GROUNDS", + "TYPE_DEPRECATED_TARMAC", + "TYPE_ENCLOSED_TRAFFIC_AREA", + "TYPE_PARKING_LOT", + "TYPE_PARKING_GARAGE", + "TYPE_OFF_ROAD_AREA", + "TYPE_BORDER", + "TYPE_BUILDING", + "TYPE_GEOCODED_ADDRESS", + "TYPE_NATURAL_FEATURE", + "TYPE_TERRAIN", + "TYPE_SAND", + "TYPE_BEACH", + "TYPE_DUNE", + "TYPE_ROCKY", + "TYPE_ICE", + "TYPE_GLACIER", + "TYPE_BUILT_UP_AREA", + "TYPE_VEGETATION", + "TYPE_SHRUBBERY", + "TYPE_WOODS", + "TYPE_AGRICULTURAL", + "TYPE_GRASSLAND", + "TYPE_TUNDRA", + "TYPE_DESERT", + "TYPE_SALT_FLAT", + "TYPE_WATER", + "TYPE_OCEAN", + "TYPE_BAY", + "TYPE_BIGHT", + "TYPE_LAGOON", + "TYPE_SEA", + "TYPE_STRAIT", + "TYPE_INLET", + "TYPE_FJORD", + "TYPE_LAKE", + "TYPE_SEASONAL_LAKE", + "TYPE_RESERVOIR", + "TYPE_POND", + "TYPE_RIVER", + "TYPE_RAPIDS", + "TYPE_DISTRIBUTARY", + "TYPE_CONFLUENCE", + "TYPE_WATERFALL", + "TYPE_SPRING", + "TYPE_GEYSER", + "TYPE_HOT_SPRING", + "TYPE_SEASONAL_RIVER", + "TYPE_WADI", + "TYPE_ESTUARY", + "TYPE_WETLAND", + "TYPE_WATER_NAVIGATION", + "TYPE_FORD", + "TYPE_CANAL", + "TYPE_HARBOR", + "TYPE_CHANNEL", + "TYPE_REEF", + "TYPE_REEF_FLAT", + "TYPE_REEF_GROWTH", + "TYPE_REEF_EXTENT", + "TYPE_REEF_ROCK_SUBMERGED", + "TYPE_IRRIGATION", + "TYPE_DAM", + "TYPE_DRINKING_WATER", + "TYPE_CURRENT", + "TYPE_WATERING_HOLE", + "TYPE_TECTONIC", + "TYPE_WATERING_HOLE_DEPRECATED", + "TYPE_VOLCANO", + "TYPE_LAVA_FIELD", + "TYPE_FISSURE", + "TYPE_FAULT", + "TYPE_LAND_MASS", + "TYPE_CONTINENT", + "TYPE_ISLAND", + "TYPE_ATOLL", + "TYPE_OCEAN_ROCK_EXPOSED", + "TYPE_CAY", + "TYPE_PENINSULA", + "TYPE_ISTHMUS", + "TYPE_ELEVATED", + "TYPE_PEAK", + "TYPE_NUNATAK", + "TYPE_SPUR", + "TYPE_PASS", + "TYPE_PLATEAU", + "TYPE_RIDGE", + "TYPE_RAVINE", + "TYPE_CRATER", + "TYPE_KARST", + "TYPE_CLIFF", + "TYPE_VISTA", + "TYPE_DIGITAL_ELEVATION_MODEL", + "TYPE_UPLAND", + "TYPE_TERRACE", + "TYPE_SLOPE", + "TYPE_CONTOUR_LINE", + "TYPE_PAN", + "TYPE_UNSTABLE_HILLSIDE", + "TYPE_MOUNTAIN_RANGE", + "TYPE_UNDERSEA", + "TYPE_SUBMARINE_SEAMOUNT", + "TYPE_SUBMARINE_RIDGE", + "TYPE_SUBMARINE_GAP", + "TYPE_SUBMARINE_PLATEAU", + "TYPE_SUBMARINE_DEEP", + "TYPE_SUBMARINE_VALLEY", + "TYPE_SUBMARINE_BASIN", + "TYPE_SUBMARINE_SLOPE", + "TYPE_SUBMARINE_CLIFF", + "TYPE_SUBMARINE_PLAIN", + "TYPE_SUBMARINE_FRACTURE_ZONE", + "TYPE_CAVE", + "TYPE_ROCK", + "TYPE_ARCHIPELAGO", + "TYPE_POSTAL", + "TYPE_POSTAL_CODE", + "TYPE_POSTAL_CODE_PREFIX", + "TYPE_PREMISE", + "TYPE_SUB_PREMISE", + "TYPE_SUITE", + "TYPE_POST_TOWN", + "TYPE_POSTAL_ROUND", + "TYPE_META_FEATURE", + "TYPE_DATA_SOURCE", + "TYPE_LOCALE", + "TYPE_TIMEZONE", + "TYPE_BUSINESS_CHAIN", + "TYPE_PHONE_NUMBER_PREFIX", + "TYPE_PHONE_NUMBER_AREA_CODE", + "TYPE_BUSINESS_CORRIDOR", + "TYPE_ADDRESS_TEMPLATE", + "TYPE_TRANSIT_AGENCY", + "TYPE_FUTURE_GEOMETRY", + "TYPE_EVENT", + "TYPE_EARTHQUAKE", + "TYPE_HURRICANE", + "TYPE_WEATHER_CONDITION", + "TYPE_TRANSIENT", + "TYPE_ENTRANCE", + "TYPE_CARTOGRAPHIC", + "TYPE_HIGH_TENSION", + "TYPE_SKI_TRAIL", + "TYPE_SKI_LIFT", + "TYPE_SKI_BOUNDARY", + "TYPE_WATERSHED_BOUNDARY", + "TYPE_TARMAC", + "TYPE_WALL", + "TYPE_PICNIC_AREA", + "TYPE_PLAY_GROUND", + "TYPE_TRAIL_HEAD", + "TYPE_GOLF_TEEING_GROUND", + "TYPE_GOLF_PUTTING_GREEN", + "TYPE_GOLF_ROUGH", + "TYPE_GOLF_SAND_BUNKER", + "TYPE_GOLF_FAIRWAY", + "TYPE_GOLF_HOLE", + "TYPE_DEPRECATED_GOLF_SHOP", + "TYPE_CAMPING_SITE", + "TYPE_DESIGNATED_BARBECUE_PIT", + "TYPE_DESIGNATED_COOKING_AREA", + "TYPE_CAMPFIRE_PIT", + "TYPE_WATER_FOUNTAIN", + "TYPE_LITTER_RECEPTACLE", + "TYPE_LOCKER_AREA", + "TYPE_ANIMAL_ENCLOSURE", + "TYPE_CARTOGRAPHIC_LINE", + "TYPE_ESTABLISHMENT", + "TYPE_ESTABLISHMENT_GROUNDS", + "TYPE_ESTABLISHMENT_BUILDING", + "TYPE_ESTABLISHMENT_POI", + "TYPE_ESTABLISHMENT_SERVICE", + "TYPE_CELESTIAL", + "TYPE_ROAD_MONITOR", + "TYPE_PUBLIC_SPACES_AND_MONUMENTS", + "TYPE_STATUE", + "TYPE_TOWN_SQUARE", + "TYPE_LEVEL", + "TYPE_COMPOUND", + "TYPE_COMPOUND_GROUNDS", + "TYPE_COMPOUND_BUILDING", + "TYPE_COMPOUND_SECTION", + "TYPE_TERMINAL_POINT", + "TYPE_REGULATED_AREA", + "TYPE_LOGICAL_BORDER", + "TYPE_GCONCEPT_ONLY", + "TYPE_DO_NOT_USE_RESERVED_TO_CATCH_GENERATED_FILES", + "TYPE_UNKNOWN" + ], + "enumDeprecated": [ + false, + 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, + true, + true, + true, + true, + true, + true, + true, + true, + true, + true, + true, + true, + true, + true, + true, + true, + true, + true, + true, + true, + true, + true, + true, + true, + false, + true, + true, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + true, + true, + true, + false, + true, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + true, + true, + true, + true, + false, + false, + true, + true, + true, + true, + true, + true, + true, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + true, + true, + true, + true, + true, + true, + true, + true, + true, + true, + true, + true, + true, + true, + true, + true, + true, + true, + true, + true, + true, + true, + true, + true, + true, + true, + true, + true, + true, + true, + true, + true, + true, + true, + true, + true, + true, + true, + true, + true, + true, + true, + true, + true, + true, + true, + true, + true, + true, + true, + true, + true, + true, + true, + true, + true, + true, + true, + true, + true, + true, + true, + true, + true, + true, + true, + true, + true, + true, + true, + true, + true, + true, + true, + true, + 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, + false, + false, + false, + false, + false, + 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, + false, + false, + false, + true, + true, + true, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + true, + true, + true, + true, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + true, + true, + false, + false, + false, + false, + false, + false, + false, + true, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + true, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + true, + false + ], + "enumDescriptions": [ + "ABSTRACT", + "ABSTRACT", + "A route is any section of road (or rails, etc.) that has a name. This includes city streets as well as highways. Road segments can belong to multiple routes (e.g. El Camino, CA-82).", + "DEPRECATED", + "ABSTRACT", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "A designated bicycle route, whose segments may consist of any combination of bicycle paths, bicycle lanes, or city streets.", + "A designated trail, which may consist of paved walkways, dirt paths, fire road, streets or highways, etc.", + "ABSTRACT", + "", + "Railroads use several different incompatible track types.", + "", + "", + "", + "", + "", + "", + "", + "", + "Tracks for streetcars, cable-cars, etc. Ferries are services that are part of the road network but are not roads. They typically involve fares and scheduled departure times.", + "ABSTRACT", + "The vast majority of ferries are ferry boats.", + "Also called a \"car transport\", a ferry train is a rail service that carries passengers and their vehicles across undrivable terrain. The Channel Tunnel (\"Chunnel\") is the most famous example, but they are also common in the Alps where they connect neighboring valleys otherwise separated by impassable mountains.", + "Any plausible 1-dimensional path through a 2+ dimensional space, for the purposes of making graph-search-based routing possible. Such segments can be used to model paths through parking lots, squares, floors of buildings and other areas.", + "An intersection consists of a collection of segments that terminate at the same location. This is topological definition: it may not match what a typical user would think of as an \"intersection\". See TYPE_INTERSECTION_GROUP, below, for more information. Each segment terminating at an intersection has an \"endpoint type\" that specifies how that segment is terminated: stop sign, yield sign, three-way light, etc.", + "ABSTRACT", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "A transit line is a collection of transit legs, associated with some invariant properties of the trips that run over the legs. See also transitline.proto", + "TYPE_TRANSIT_AGENCY was moved to 0xC91. This deprecated enum value still exists for debugging purposes only.", + "DEPRECATED", + "ABSTRACT", + "Road sign features have names, point geometry, etc. They also have segment_path data (see below) which lists the segments that refer to the sign. See segment.proto for the reference from the segment to the road sign.", + "Our TYPE_INTERSECTION feature, above, models the point where one or more segments terminate. This is topological definition: it may not match what a typical user would think of as an \"intersection\". Consider the intersections where Hayes, Market, Larkin, and 9th Street meet near (37.77765, -122.41638) in San Francisco. Most people would probably consider this a single feature, even though we model it as four separate TYPE_INTERSECTION features. This TYPE_INTERSECTION_GROUP is used to model the user's concept of a complex intersection.", + "RESERVED", + "A restriction group describes a set of segment restrictions that belong together and have a name or an associated event. See also restriction_group.proto", + "DEPRECATED", + "ABSTRACT", + "", + "ABSTRACT", + "", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "", + "DEPRECATED", + "DEPRECATED", + "", + "", + "", + "", + "", + "", + "", + "e.g. Silicon Valley", + "A reservation is a region collectively held or governed by indigenous people and officially recognized by the country’s government at the federal or state level. A reservation may be fully contained within an administrative feature or partially contained within two or more. These regions are referred to by different categorical names depending on country and even by state, including but not limited to: “Indian Reservations”, “Indian Reserves”, “Land Claim Settlement Lands”, “Indian Lands”, “Treaty Lands”, “Indigenous Territories”, etc. A reservation is not a historic indigenous territory boundary or a region which has applied for land rights but has not yet received official recognition.", + "", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "An entity widely considered to be a city, that may itself be made up of smaller political entities, some of which are cities/towns/villages themselves. For example, the colloquial view of Sydney, Australia actually comprises many smaller cities, but is regarded as a city itself. This type is not suitable for modeling official metro-/micropolitan or other statistical areas.", + "ABSTRACT", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "", + "", + "", + "", + "", + "", + "", + "Designated Market Areas (or DMAs) are used by marketing and ratings companies (such as the Nielsen Media Research company) to describe geographical regions (such as the greater New York metropolitan area) that are covered by a set of television stations. (See http://www.schooldata.com/pdfs/DMA.pdf) In the United States, DMAs should have a DMA numeric ID name, tagged with the FLAG_DESIGNATED_MARKET_AREA_ID flag.", + "", + "", + "Eventually we'll have more data for disputed areas (e.g., who makes claims on the area, who has de facto control, etc.). For the moment, we just define a type so we can simply mark areas as disputed.", + "Boundaries representing the jurisdiction of a particular police station.", + "An area used for aggregating statistical data, eg, a census region. Note that TYPE_STATISTICAL_AREA has a third nibble so we can add an abstract parent above it later if need be at 0x2E1 (and rename TYPE_STATISTICAL_AREA as TYPE_STATISTICAL_AREA1).", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "A line representing the boundary between two features. See border.proto for details.", + "DEPRECATED", + "An association of a point with an address, with no other information.", + "ABSTRACT", + "Expanses of land that share common surface attributes. These areas would look more or less uniform from a high altitude.", + "", + "", + "", + "", + "", + "", + "Terrain that looks populated.", + "Terrain that is covered in vegetation.", + "", + "", + "", + "", + "", + "", + "A flat expanse of salt left by the evaporation of a body of salt water.", + "Features can be TYPE_WATER if we don't have enough information to properly type the body of water. TYPE_WATER is also used as the type for child features that compose a TYPE_RIVER feature.", + "One of the large salt-water bodies that covers most of the globe.", + "An ocean subdivision formed by a coastal indentation. Includes coves and gulfs.", + "An open body of water formed by a slight coastal indentation.", + "", + "An ocean subdivision more or less confined by land and islands.", + "A long narrow ocean subdivision. Includes sounds.", + "", + "", + "An inland body of standing water.", + "A lake that dries up part of the year.", + "An artificial body of water, possibly created by a dam, often used for irrigation or house use.", + "", + "An inland body of moving water, or parts associated with it in which there is little or no current (backwater).", + "", + "A branch which flows away from the main river. Includes deltas.", + "A place where two or more rivers join.", + "", + "A place where ground water flows naturally out of the ground.", + "", + "", + "A river that dries up part of the year.", + "A dry riverbed that occasionally receives flashfloods.", + "A place at the end of a river where fresh and salt water mix. Includes tidal creeks and limans.", + "Land that is usually flooded. Includes bogs, marshes, flats, moors, and swamps.", + "", + "A shallow place where water may be waded through.", + "A narrow passage used by boats. Normally artificial.", + "A deep place near a shore where ships commonly drop anchor.", + "A deep part in a body of water that is suitable for navigation. Includes narrows.", + "Rocks, coral, sandbars, or other features beneath the surface of the water that pose a hazard to passing ships. Includes shoals.", + "A relatively shallow zone of the back reef located closest to the shore, that may be exposed at low tide.", + "A small section of rocks, coral, sandbars, or other features beneath the surface of the water that forms part of a reef.", + "The full extent of the reef complex.", + "A submerged rock in the water.", + "Man-made (and sometimes natural) channels used to move water. This type was used for both dam structures and water that is hold back by dams. We should use TYPE_COMPOUND_BUILDING for dam structures and TYPE_RESERVOIR for water.", + "DEPRECATED", + "", + "Includes overfalls.", + "A natural depression filled with water where animals come to drink.", + "This type is incorrectly under TYPE_TECTONIC instead of TYPE_WATER. This was a mistake and is now fixed. See TYPE_WATERING_HOLE for the replacement.", + "DEPRECATED", + "", + "", + "", + "", + "", + "", + "", + "", + "An exposed rock in the water.", + "A small, low-elevation, sandy island formed on the surface of coral reefs", + "A stretch of land projecting into water. Includes capes and spits.", + "A strip of land connecting two larger land masses, such as continents.", + "Features that are notable for being high (or low), or for having sudden changes in elevation. These features might have an \"elevation\" extension to specify the actual elevation. See ElevationProto for more information.", + "Elevations that have a distinctive peak.", + "A peak or ridge of a mountain that extends through a glacier.", + "A subsidiary peak of a mountain.", + "A route over an otherwise difficult to traverse feature. Includes saddle.", + "Elevations that are flat on top. Includes mesas and buttes.", + "A ridge is a geographical feature consisting of a chain of mountains or hills that form a continuous elevated crest with a single ridgeline for some distance.", + "Steep declines usually carved by erosion. Includes valleys, canyons, ditches, and gorges.", + "Depressions causes by impact, explosion, and sometimes sink-holes.", + "Topography formed on limestone and gypsum by dissolution with sinkholes, caves, etc.", + "A vertical or nearly vertical slope. Includes escarpments.", + "An elevated place that is notable for having a good view. Raster digital elevation data. This is not a type to be used by providers or consumed by clients.", + "RESERVED", + "Land along streams higher than the alluvial plain or stream terrace.", + "", + "Land not so steep as a cliff, but changing elevation. Includes slides.", + "All the points on the polygon are at the same elevation.", + "A near-level shallow, natural depression or basin, usually containing an intermittent lake, pond, or pool.", + "", + "A series of mountains or hills ranged in a line and connected by high ground. Mountain ranges usually consist of many smaller ridges. For example, the Himalayas, the Andes. the Alps, etc.", + "Features that are notable for being high (or low), or for having sudden changes in elevation. These features might have an \"elevation\" extension to specify the actual elevation. See ElevationProto for more information.", + "includes peaks, ranges, and spurs", + "", + "includes saddles", + "", + "", + "includes trenches and troughs", + "", + "", + "", + "", + "", + "Don't use 0xA7. Use 8 bits for additional types under TYPE_NATURAL_FEATURE, so we don't run out of space. The following are miscellaneous natural features that don't fit any of the categories above.", + "", + "A feature representing a group or chain of islands. ", + "ABSTRACT", + "This is the type for postal codes which are complete and independent enough that there should be a feature for them (e.g. US 5-digit ZIP codes). For even more detailed suffixes that further subdivide a postal code (such as the +4 component in US ZIP codes), store the information in a TYPE_POSTAL_CODE_SUFFIX address component. When a range or set of postal codes share the same geographical area, e.g. because a precise subdivision does not exist or this subdivision is unknown, this type is used for each individual postal code.", + "A prefix portion of a postal code which does not meet the requirements for TYPE_POSTAL_CODE, but which is useful to search for, for example UK outcodes.", + "DEPRECATED", + "DEPRECATED This is deprecated and we want to use TYPE_COMPOUND_SECTION instead.", + "DEPRECATED", + "The term \"post town\" is used for a locality-like-entity that is only used for postal addresses.", + "DEPRECATED", + "ABSTRACT", + "Every data source used in constructing a data repository has a corresponding feature that provides more information about that data source. The extra information is stored in the optional data_source field below.", + "A locale feature provides region specific conventions such as preferred language and formatting details for time, date, and currency values. Locales aren't necessary defined by physical geographic features, so they are classified as meta-features.", + "A timezone feature is used to specify the region covering an international timezone. When a point is covered by multiple timezone features, the most specific one can be used to compute the local time at this point. Most specific implies a much smaller region or the one that is closer to the center. A feature's timezone can be specified in the repeated related_timezone field.", + "A business chain feature is used to represent a chain, e.g. Starbucks, McDonald's, etc. Other features representing specific stores/franchises of this chain may refer to one such feature via RELATION_MEMBER_OF_CHAIN. This is not strictly reserved to commercial chains but can also be used to model organizations such as the Red Cross or the United Nations.", + "A phone number prefix feature is used to specify the region where phone numbers (typically fixed-line numbers) must begin with a certain prefix. Any phone number prefix down to any level of granularity could be represented by this type.", + "A phone number area code is a prefix which also coincides with the area code, or national destination code, of a particular region.", + "A Business Corridor is a dense cluster of semantically similar establishments. TYPE_BUSINESS_CORRIDOR features are distinguished from TYPE_COLLOQUIAL_AREA features because the corridors are not under the political hierarchy, are allowed to be nameless, and may not correspond to well-known real world locations. For more details, see go/geo-corridors-schema.", + "An address template feature provides region-specific conventions for structuring addresses. These features aren't necessarily defined by physical geographic features, so they are classified as meta-features.", + "A transit agency operates a number of lines, typically all in the same city, region or country. See also transitagency.proto", + "A feature whose geometry is planned to replace the geometry on another feature.", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "RESERVED", + "A portal of entry or exit to another feature. Examples: - Subway station entrance. - Parking lot entrance.", + "Cartographic features are used to capture real-world objects for which there is no current desire to model any specific attributes. These are only useful to make the map tiles look pretty.", + "DEPRECATED", + "Also see skitrail.proto", + "Also see skilift.proto", + "Also see skiboundary.proto", + "", + "Starting with TYPE_TARMAC, we use longer IDs, so that we can expand the number of feature types under TYPE_CARTOGRAPHIC.", + "Use TYPE_COMPOUND_GROUND and appropriate gcids for the next two.", + "DEPRECATED", + "DEPRECATED", + "", + "Sub-types within a golf course.", + "", + "", + "", + "", + "Use TYPE_ESTABLISHMENT_POI and gcid:golf_shop for golf shops instead.", + "DEPRECATED", + "DEPRECATED", + "", + "", + "", + "", + "", + "", + "Subtype within a zoo - a cage or fenced-off or otherwise delineated area containing animals.", + "A line for a cartographic detail. For example the international date line. Such features should have polyline geometry.", + "ABSTRACT This type is being replaced by TYPE_COMPOUND_GROUNDS. For further details, see go/compounds-v2", + "DEPRECATED This type has been replaced by TYPE_COMPOUND_BUILDING. For further details, see go/oyster-compounds", + "DEPRECATED", + "An establishment that has a physical location. Note that it *may* also have a service area (e.g. a restaurant that offers both dine-in and delivery). This type of business is also known as a \"hybrid\" Service Area Business. Establishment POIs can be referenced by TYPE_COMPOUND features using the RELATION_PRIMARILY_OCCUPIED_BY. This is the reciprocal relation of the RELATION_OCCUPIES.", + "NOTE(tcain): Using value 0xD441, since we could find ourselves with a need to differentiate service areas from online-only at this level in the future, but still benefit from being able to group those under a common parent, disjoint from TYPE_ESTABLISHMENT_POI.", + "The root of types of features that are in the sky, rather than on the earth. There will eventually be a hierarchy of types here.", + "Features responsible for monitoring traffic on roads (usually for speed). Includes cameras at particular points as well as monitors that cover larger spans. Features of this type should have a corresponding gcid that specifies the correct subtype (e.g. gcid:road_camera or gcid:speed_camera_zone). This type was originally named as TYPE_ROAD_CAMERA.", + "ABSTRACT", + "Note that this type does not distinguish the nature of the statue (religious, historical, memorial, tourist, ...).", + "Open space used for events, gathering, or as market-place.", + "A feature used to represent a logical level, e.g. floor.", + "ABSTRACT", + "e.g. campus, compound, parcel.", + "e.g. single family dwelling, office building.", + "e.g. suite, room, hallway, cubicle.", + "A terminal point represents a good location for a user to meet a taxi, ridesharing vehicle, or general driver.", + "An area controlled in some way by an authoritative source, such as a government-designated COVID containment zone or an area under government sanctions. Features of this type should have one or more gcids corresponding to their specific regulation, and client handling of these features may vary based on the type of regulation.", + "A grouping of TYPE_BORDER features (\"border segments\"), which together represent a border between two features of the same type.", + "A generic feature type for any geo-type that cannot be modeled under existing feature types. No new feature type should be created within feature proto after this type.", + "DEPRECATED", + "A feature of completely unknown type. This should only be used when absolutely necessary. One example in which this type is useful is in the Chinese importer, which must heuristically segment addresses into components - it often does not know what types to make those components. Please note that the Oyster address formatter does not currently support address components of TYPE_UNKNOWN well." ], "type": "string" - }, - "possibleValues": { - "description": "The list of possible values for the enumeration property. All EnumValuePairs must provide a string value. If you specify an integer value for one EnumValuePair, then all possible EnumValuePairs must provide an integer value. Both the string value and integer value must be unique over all possible values. Once set, possible values cannot be removed or modified. If you supply an ordered ranking and think you might insert additional enum values in the future, leave gaps in the initial integer values to allow adding a value in between previously registered values. The maximum number of elements is 100.", - "items": { - "$ref": "EnumValuePair" - }, - "type": "array" } }, "type": "object" }, - "EnumValuePair": { - "description": "The enumeration value pair defines two things: a required string value and an optional integer value. The string value defines the necessary query term required to retrieve that item, such as *p0* for a priority item. The integer value determines the ranking of that string value relative to other enumerated values for the same property. For example, you might associate *p0* with *0* and define another enum pair such as *p1* and *1*. You must use the integer value in combination with ordered ranking to set the ranking of a given value relative to other enumerated values for the same property name. Here, a ranking order of DESCENDING for *priority* properties results in a ranking boost for items indexed with a value of *p0* compared to items indexed with a value of *p1*. Without a specified ranking order, the integer value has no effect on item ranking.", - "id": "EnumValuePair", + "LocationUnifiedPersonalizedLocationAttributes": { + "description": "*************************************************************************** PROTO BELOW IS FOR INTERNAL USE ONLY. IT MAY CHANGE WITHOUT NOTICE, SO EVERYONE OUTSIDE OF oolong-team@ IS STRONGLY DISCOURAGED FROM USING IT. CODE STILL DOING SO WILL BE BROKEN WITHOUT NOTICE. *************************************************************************** Internal Oolong-specific personalized location attributes. Next Id: 11.", + "id": "LocationUnifiedPersonalizedLocationAttributes", "properties": { - "integerValue": { - "description": "The integer value of the EnumValuePair which must be non-negative. Optional.", + "anySupportingDays": { + "description": "Number of days the location was supported by any 'physical presence'-like or 'explicit-interest'-like location.", "format": "int32", "type": "integer" }, - "stringValue": { - "description": "The string value of the EnumValuePair. The maximum length is 32 characters.", - "type": "string" - } - }, - "type": "object" - }, - "EnumValues": { - "description": "List of enum values.", - "id": "EnumValues", - "properties": { - "values": { - "description": "The maximum allowable length for string values is 32 characters.", - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "ErrorInfo": { - "description": "Error information about the response.", - "id": "ErrorInfo", - "properties": { - "errorMessages": { - "items": { - "$ref": "ErrorMessage" - }, - "type": "array" - } - }, - "type": "object" - }, - "ErrorMessage": { - "description": "Error message per source response.", - "id": "ErrorMessage", - "properties": { - "errorMessage": { - "type": "string" - }, - "source": { - "$ref": "Source" - } - }, - "type": "object" - }, - "FacetBucket": { - "description": "A bucket in a facet is the basic unit of operation. A bucket can comprise either a single value OR a contiguous range of values, depending on the type of the field bucketed. FacetBucket is currently used only for returning the response object.", - "id": "FacetBucket", - "properties": { - "count": { - "description": "Number of results that match the bucket value. Counts are only returned for searches when count accuracy is ensured. Cloud Search does not guarantee facet counts for any query and facet counts might be present only intermittently, even for identical queries. Do not build dependencies on facet count existence; instead use facet ount percentages which are always returned.", - "format": "int32", + "eiDailyVisits": { + "description": "Binary mask representing \"explicit-interest\" daily visits in the location. EVAL-ONLY, NEVER POPULATED IN PRODUCTION OR LOGS.", + "format": "uint32", "type": "integer" }, - "filter": { - "$ref": "Filter", - "description": "Filter to be passed in the search request if the corresponding bucket is selected." + "ppDailyVisits": { + "description": "Binary mask representing \"physical-presence\" daily visits in the location. EVAL-ONLY, NEVER POPULATED IN PRODUCTION OR LOGS.", + "format": "uint32", + "type": "integer" }, - "percentage": { - "description": "Percent of results that match the bucket value. The returned value is between (0-100], and is rounded down to an integer if fractional. If the value is not explicitly returned, it represents a percentage value that rounds to 0. Percentages are returned for all searches, but are an estimate. Because percentages are always returned, you should render percentages instead of counts.", + "ppSupportingDays": { + "description": "Number of days the location was supported by any 'physical presence'-like location.", "format": "int32", "type": "integer" }, - "value": { - "$ref": "Value" - } - }, - "type": "object" - }, - "FacetOptions": { - "description": "Specifies operators to return facet results for. There will be one FacetResult for every source_name/object_type/operator_name combination.", - "id": "FacetOptions", - "properties": { - "integerFacetingOptions": { - "$ref": "IntegerFacetingOptions", - "description": "If set, describes integer faceting options for the given integer property. The corresponding integer property in the schema should be marked isFacetable. The number of buckets returned would be minimum of this and num_facet_buckets." - }, - "numFacetBuckets": { - "description": "Maximum number of facet buckets that should be returned for this facet. Defaults to 10. Maximum value is 100.", + "ppSupportingWeeks": { + "description": "Number of weeks the location was supported by any 'physical presence'-like location.", "format": "int32", "type": "integer" }, - "objectType": { - "description": "If object_type is set, only those objects of that type will be used to compute facets. If empty, then all objects will be used to compute facets.", - "type": "string" - }, - "operatorName": { - "description": "The name of the operator chosen for faceting. @see cloudsearch.SchemaPropertyOptions", - "type": "string" - }, - "sourceName": { - "description": "Source name to facet on. Format: datasources/{source_id} If empty, all data sources will be used.", - "type": "string" - } - }, - "type": "object" - }, - "FacetResult": { - "description": "Source specific facet response", - "id": "FacetResult", - "properties": { - "buckets": { - "description": "FacetBuckets for values in response containing at least a single result with the corresponding filter.", + "supportingPackedIpRanges": { + "description": "IP ranges that the location was supported by.", "items": { - "$ref": "FacetBucket" + "format": "byte", + "type": "string" }, "type": "array" - }, - "objectType": { - "description": "Object type for which facet results are returned. Can be empty.", - "type": "string" - }, - "operatorName": { - "description": "The name of the operator chosen for faceting. @see cloudsearch.SchemaPropertyOptions", - "type": "string" - }, - "sourceName": { - "description": "Source name for which facet results are returned. Will not be empty.", - "type": "string" - } - }, - "type": "object" - }, - "FieldViolation": { - "id": "FieldViolation", - "properties": { - "description": { - "description": "The description of the error.", - "type": "string" - }, - "field": { - "description": "Path of field with violation.", - "type": "string" - } - }, - "type": "object" - }, - "Filter": { - "description": "A generic way of expressing filters in a query, which supports two approaches: **1. Setting a ValueFilter.** The name must match an operator_name defined in the schema for your data source. **2. Setting a CompositeFilter.** The filters are evaluated using the logical operator. The top-level operators can only be either an AND or a NOT. AND can appear only at the top-most level. OR can appear only under a top-level AND.", - "id": "Filter", - "properties": { - "compositeFilter": { - "$ref": "CompositeFilter" - }, - "valueFilter": { - "$ref": "ValueFilter" - } - }, - "type": "object" - }, - "FilterOptions": { - "description": "Filter options to be applied on query.", - "id": "FilterOptions", - "properties": { - "filter": { - "$ref": "Filter", - "description": "Generic filter to restrict the search, such as `lang:en`, `site:xyz`." - }, - "objectType": { - "description": "If object_type is set, only objects of that type are returned. This should correspond to the name of the object that was registered within the definition of schema. The maximum length is 256 characters.", - "type": "string" } }, "type": "object" }, - "FreshnessOptions": { - "description": "Indicates which freshness property to use when adjusting search ranking for an item. Fresher, more recent dates indicate higher quality. Use the freshness option property that best works with your data. For fileshare documents, last modified time is most relevant. For calendar event data, the time when the event occurs is a more relevant freshness indicator. In this way, calendar events that occur closer to the time of the search query are considered higher quality and ranked accordingly.", - "id": "FreshnessOptions", + "LocationUnifiedPolicyResult": { + "description": "PolicyResult contains all the data that is computed based on the classifier policy for a location.", + "id": "LocationUnifiedPolicyResult", "properties": { - "freshnessDuration": { - "description": "The duration after which an object should be considered stale. The default value is 180 days (in seconds).", - "format": "google-duration", - "type": "string" - }, - "freshnessProperty": { - "description": "This property indicates the freshness level of the object in the index. If set, this property must be a top-level property within the property definitions and it must be a timestamp type or date type. Otherwise, the Indexing API uses updateTime as the freshness indicator. The maximum length is 256 characters. When a property is used to calculate freshness, the value defaults to 2 years from the current time.", - "type": "string" + "confidenceRects": { + "items": { + "$ref": "LocationUnifiedPolicyResultConfidenceRect" + }, + "type": "array" } }, "type": "object" }, - "GSuitePrincipal": { - "id": "GSuitePrincipal", + "LocationUnifiedPolicyResultConfidenceRect": { + "id": "LocationUnifiedPolicyResultConfidenceRect", "properties": { - "gsuiteDomain": { - "description": "This principal represents all users of the Google Workspace domain of the customer.", - "type": "boolean" - }, - "gsuiteGroupEmail": { - "description": "This principal references a Google Workspace group name.", - "type": "string" + "confidence": { + "description": "Confidence in the range [0, 100].", + "format": "int32", + "type": "integer" }, - "gsuiteUserEmail": { - "description": "This principal references a Google Workspace user account.", - "type": "string" + "rect": { + "$ref": "LocationUnifiedLatLngRect", + "description": "The bounding box that we believe is certain with probability given by confidence." } }, "type": "object" }, - "GetCustomerIndexStatsResponse": { - "id": "GetCustomerIndexStatsResponse", + "LocationUnifiedPresenceInterval": { + "description": "Next ID: 4.", + "id": "LocationUnifiedPresenceInterval", "properties": { - "averageIndexedItemCount": { - "description": "Average item count for the given date range for which billing is done.", - "format": "int64", + "confidence": { + "description": "Probability of presence as a percentage in [0, 100].", + "format": "uint32", + "type": "integer" + }, + "durationSec": { + "description": "Interval duration in seconds.", + "format": "uint64", "type": "string" }, - "stats": { - "description": "Summary of indexed item counts, one for each day in the requested range.", - "items": { - "$ref": "CustomerIndexStats" - }, - "type": "array" + "startOffsetSec": { + "description": "Start of the interval as the number of seconds from the time of the location.", + "format": "uint64", + "type": "string" } }, "type": "object" }, - "GetCustomerQueryStatsResponse": { - "id": "GetCustomerQueryStatsResponse", + "LocationUnifiedSemanticPlace": { + "description": "Semantic location information from HULK Next Id: 6", + "id": "LocationUnifiedSemanticPlace", "properties": { - "stats": { + "confidence": { + "enum": [ + "UNKNOWN_CONFIDENCE", + "LOW_CONFIDENCE", + "MEDIUM_CONFIDENCE", + "HIGH_CONFIDENCE" + ], + "enumDescriptions": [ + "", + "", + "", + "" + ], + "type": "string" + }, + "featureId": { + "$ref": "LocationUnifiedFeatureIdProto", + "description": "The feature id of the semantic location POI" + }, + "gconceptInstance": { + "description": "Geo Ontology GConcept Instances of the semantic location", "items": { - "$ref": "CustomerQueryStats" + "$ref": "LocationUnifiedSemanticPlaceGConceptInstanceProto" }, "type": "array" }, - "totalQueryCount": { - "description": "Total successful query count (status code 200) for the given date range.", - "format": "int64", + "score": { + "description": "The probability the user is at this place in [0 100].", + "format": "float", + "type": "number" + }, + "source": { + "enum": [ + "UNKNOWN", + "HAPPY_HOUR", + "HULK_REAL_TIME", + "ANDROID_CONTEXT" + ], + "enumDescriptions": [ + "", + "", + "", + "" + ], "type": "string" } }, "type": "object" }, - "GetCustomerSearchApplicationStatsResponse": { - "description": "Response format for search application stats for a customer.", - "id": "GetCustomerSearchApplicationStatsResponse", + "LocationUnifiedSemanticPlaceGConceptInstanceProto": { + "description": "A GConceptInstance (gcid), copied from geostore.GConceptInstanceProto. Copy is needed because - LocationDescriptor is used publicly, therefore should not have internal dependencies. - GConceptInstanceProto uses js_proto build rules which are incompatible with closure_js_proto_library rules.", + "id": "LocationUnifiedSemanticPlaceGConceptInstanceProto", "properties": { - "averageSearchApplicationCount": { - "description": "Average search application count for the given date range.", - "format": "int64", + "gconceptId": { "type": "string" }, - "stats": { - "description": "Search application stats by date.", - "items": { - "$ref": "CustomerSearchApplicationStats" - }, - "type": "array" + "prominence": { + "enum": [ + "NON_PRIMARY", + "PRIMARY" + ], + "enumDescriptions": [ + "not a prominent GConcept", + "the most prominent GConcept" + ], + "type": "string" } }, "type": "object" }, - "GetCustomerSessionStatsResponse": { - "id": "GetCustomerSessionStatsResponse", + "LocationUnifiedVisibleNetwork": { + "description": "VisibleNetwork describes a location by providing the details of one of the networks visible at that location. GLS can be used to geocode a set of VisibleNetworks into a location, as explained in go/gls-in-gws. Currently only WiFi and cell networks are supported, but the message could be extended to support additional network types (e.g. bluetooth beacons, etc) in the future. Next Id: 5", + "id": "LocationUnifiedVisibleNetwork", "properties": { - "stats": { - "items": { - "$ref": "CustomerSessionStats" - }, - "type": "array" + "cell": { + "$ref": "LocationUnifiedVisibleNetworkCell" + }, + "connected": { + "description": "True if the user's device is currently connected to the network.", + "type": "boolean" + }, + "timestampMs": { + "description": "The timestamp of this network. That is when this network was detected, expressed as the number of milliseconds since unix epoch. If not set, assumed to be \"now\" or irrelevant.", + "format": "int64", + "type": "string" + }, + "wifi": { + "$ref": "LocationUnifiedVisibleNetworkWiFi" } }, "type": "object" }, - "GetCustomerUserStatsResponse": { - "id": "GetCustomerUserStatsResponse", + "LocationUnifiedVisibleNetworkCell": { + "description": "Definition derived from https://developers.google.com/maps/documentation/geolocation/intro#cell_tower_object Next Id: 9", + "id": "LocationUnifiedVisibleNetworkCell", "properties": { - "stats": { - "items": { - "$ref": "CustomerUserStats" - }, - "type": "array" + "cellId": { + "description": "For GSM, LTE and WCDMA networks, this field holds the cell ID of the network. For CDMA networks, this field holds the base station ID of the network.", + "format": "int32", + "type": "integer" + }, + "locationAreaCode": { + "description": "For GSM and WCDMA networks, this field holds the location area code of the network. For LTE networks, this field used to hold the tracking area code of the network, but this usage has been deprecated, and that value should now be provided through tracking_area_code. For CDMA networks, this field holds the network ID of the network.", + "format": "int32", + "type": "integer" + }, + "mobileCountryCode": { + "description": "The mobile country code of the network.", + "format": "int32", + "type": "integer" + }, + "mobileNetworkCode": { + "description": "The mobile network code of the network.", + "format": "int32", + "type": "integer" + }, + "physicalCellId": { + "description": "Only set for LTE networks for which this field holds the physical cell ID.", + "format": "int32", + "type": "integer" + }, + "primaryScramblingCode": { + "description": "Only set for WCDMA networks for which this field holds the primary scrambling code of the network.", + "format": "int32", + "type": "integer" + }, + "trackingAreaCode": { + "description": "Only set for LTE networks for which this field holds the tracking area code.", + "format": "int32", + "type": "integer" + }, + "type": { + "enum": [ + "UNKNOWN", + "GSM", + "LTE", + "CDMA", + "WCDMA" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "" + ], + "type": "string" } }, "type": "object" }, - "GetDataSourceIndexStatsResponse": { - "id": "GetDataSourceIndexStatsResponse", + "LocationUnifiedVisibleNetworkWiFi": { + "description": "Definition derived from https://developers.google.com/maps/documentation/geolocation/intro#wifi_access_point_object Next Id: 3", + "id": "LocationUnifiedVisibleNetworkWiFi", "properties": { - "averageIndexedItemCount": { - "description": "Average item count for the given date range for which billing is done.", - "format": "int64", + "bssid": { + "description": "The BSSID of the network (i.e. MAC address of the access point).", "type": "string" }, - "stats": { - "description": "Summary of indexed item counts, one for each day in the requested range.", - "items": { - "$ref": "DataSourceIndexStats" - }, - "type": "array" + "levelDbm": { + "description": "The signal level of the network in dBm (RSSI).", + "format": "int32", + "type": "integer" } }, "type": "object" }, - "GetSearchApplicationQueryStatsResponse": { - "description": "Response format for getting query stats for a search application between given dates.", - "id": "GetSearchApplicationQueryStatsResponse", + "MapInfo": { + "description": "Geo information used for rendering a map that shows the user's work location.", + "id": "MapInfo", "properties": { - "stats": { - "description": "Query stats per date for a search application.", + "lat": { + "description": "Latitude in degrees", + "format": "double", + "type": "number" + }, + "locationUrl": { + "$ref": "SafeUrlProto", + "description": "URL to a view of a map centered on the user's work location in Campus Maps (for google.com) or Google Maps (external)." + }, + "long": { + "description": "Longitude in degrees", + "format": "double", + "type": "number" + }, + "mapTile": { + "description": "MapTiles for the area around a user's work location", "items": { - "$ref": "SearchApplicationQueryStats" + "$ref": "MapTile" }, "type": "array" }, - "totalQueryCount": { - "description": "Total successful query count (status code 200) for the given date range.", - "format": "int64", - "type": "string" + "zoom": { + "description": "The zoom level of the map. A constant zoom value of 18 is used for now to match the zoom of the map shown on a Moma Teams Profile page", + "format": "int32", + "type": "integer" } }, "type": "object" }, - "GetSearchApplicationSessionStatsResponse": { - "id": "GetSearchApplicationSessionStatsResponse", + "MapTile": { + "description": "Information used to render a map tile image in the proper location on a map.", + "id": "MapTile", "properties": { - "stats": { - "items": { - "$ref": "SearchApplicationSessionStats" - }, - "type": "array" + "imageUrl": { + "$ref": "SafeUrlProto", + "description": "URL to an image file containing an office layout of the user's location for their organization, if one is available. For google.com, this image is from Corp Campus Maps." + }, + "tileX": { + "description": "Map tile x coordinate", + "format": "double", + "type": "number" + }, + "tileY": { + "description": "Map tile y coordinate", + "format": "double", + "type": "number" } }, "type": "object" }, - "GetSearchApplicationUserStatsResponse": { - "id": "GetSearchApplicationUserStatsResponse", + "MatchRange": { + "description": "Matched range of a snippet [start, end).", + "id": "MatchRange", "properties": { - "stats": { - "items": { - "$ref": "SearchApplicationUserStats" - }, - "type": "array" + "end": { + "description": "End of the match in the snippet.", + "format": "int32", + "type": "integer" + }, + "start": { + "description": "Starting position of the match in the snippet.", + "format": "int32", + "type": "integer" } }, "type": "object" }, - "HtmlOperatorOptions": { - "description": "Used to provide a search operator for html properties. This is optional. Search operators let users restrict the query to specific fields relevant to the type of item being searched.", - "id": "HtmlOperatorOptions", + "Media": { + "description": "Media resource.", + "id": "Media", "properties": { - "operatorName": { - "description": "Indicates the operator name required in the query in order to isolate the html property. For example, if operatorName is *subject* and the property's name is *subjectLine*, then queries like *subject:* show results only where the value of the property named *subjectLine* matches **. By contrast, a search that uses the same ** without an operator return all items where ** matches the value of any html properties or text within the content field for the item. The operator name can only contain lowercase letters (a-z). The maximum length is 32 characters.", + "resourceName": { + "description": "Name of the media resource.", "type": "string" } }, "type": "object" }, - "HtmlPropertyOptions": { - "description": "The options for html properties.", - "id": "HtmlPropertyOptions", + "MessageSet": { + "description": "This is proto2's version of MessageSet.", + "id": "MessageSet", + "properties": {}, + "type": "object" + }, + "Metadata": { + "description": "Metadata of a matched search result.", + "id": "Metadata", "properties": { - "operatorOptions": { - "$ref": "HtmlOperatorOptions", - "description": "If set, describes how the property should be used as a search operator." + "createTime": { + "description": "The creation time for this document or object in the search result.", + "format": "google-datetime", + "type": "string" + }, + "displayOptions": { + "$ref": "ResultDisplayMetadata", + "description": "Options that specify how to display a structured data search result." + }, + "fields": { + "description": "Indexed fields in structured data, returned as a generic named property.", + "items": { + "$ref": "NamedProperty" + }, + "type": "array" + }, + "mimeType": { + "description": "Mime type of the search result.", + "type": "string" + }, + "objectType": { + "description": "Object type of the search result.", + "type": "string" + }, + "owner": { + "$ref": "Person", + "description": "Owner (usually creator) of the document or object of the search result." }, - "retrievalImportance": { - "$ref": "RetrievalImportance", - "description": "Indicates the search quality importance of the tokens within the field when used for retrieval. Can only be set to DEFAULT or NONE." + "source": { + "$ref": "Source", + "description": "The named source for the result, such as Gmail." + }, + "thumbnailUrl": { + "description": "The thumbnail URL of the result.", + "type": "string" + }, + "updateTime": { + "description": "The last modified date for the object in the search result. If not set in the item, the value returned here is empty. When `updateTime` is used for calculating freshness and is not set, this value defaults to 2 years from the current time.", + "format": "google-datetime", + "type": "string" } }, "type": "object" }, - "HtmlValues": { - "description": "List of html values.", - "id": "HtmlValues", + "Metaline": { + "description": "A metaline is a list of properties that are displayed along with the search result to provide context.", + "id": "Metaline", "properties": { - "values": { - "description": "The maximum allowable length for html values is 2048 characters.", + "properties": { + "description": "The list of displayed properties for the metaline. The maximum number of properties is 5.", "items": { - "type": "string" + "$ref": "DisplayedProperty" }, "type": "array" } }, "type": "object" }, - "IndexItemOptions": { - "id": "IndexItemOptions", + "Name": { + "description": "A person's name.", + "id": "Name", "properties": { - "allowUnknownGsuitePrincipals": { - "description": "Specifies if the index request should allow Google Workspace principals that do not exist or are deleted.", - "type": "boolean" + "displayName": { + "description": "The read-only display name formatted according to the locale specified by the viewer's account or the `Accept-Language` HTTP header.", + "type": "string" } }, "type": "object" }, - "IndexItemRequest": { - "id": "IndexItemRequest", + "NamedProperty": { + "description": "A typed name-value pair for structured data. The type of the value should be the same as the registered type for the `name` property in the object definition of `objectType`.", + "id": "NamedProperty", "properties": { - "connectorName": { - "description": "The name of connector making this call. Format: datasources/{source_id}/connectors/{ID}", - "type": "string" + "booleanValue": { + "type": "boolean" }, - "debugOptions": { - "$ref": "DebugOptions", - "description": "Common debug options." + "dateValues": { + "$ref": "DateValues" }, - "indexItemOptions": { - "$ref": "IndexItemOptions" + "doubleValues": { + "$ref": "DoubleValues" }, - "item": { - "$ref": "Item", - "description": "The name of the item. Format: datasources/{source_id}/items/{item_id}" + "enumValues": { + "$ref": "EnumValues" }, - "mode": { - "description": "Required. The RequestMode for this request.", - "enum": [ - "UNSPECIFIED", - "SYNCHRONOUS", - "ASYNCHRONOUS" - ], - "enumDescriptions": [ - "The priority is not specified in the update request. Leaving priority unspecified results in an update failure.", - "For real-time updates.", - "For changes that are executed after the response is sent back to the caller." - ], + "htmlValues": { + "$ref": "HtmlValues" + }, + "integerValues": { + "$ref": "IntegerValues" + }, + "name": { + "description": "The name of the property. This name should correspond to the name of the property that was registered for object definition in the schema. The maximum allowable length for this property is 256 characters.", "type": "string" + }, + "objectValues": { + "$ref": "ObjectValues" + }, + "textValues": { + "$ref": "TextValues" + }, + "timestampValues": { + "$ref": "TimestampValues" } }, "type": "object" }, - "InitializeCustomerRequest": { - "description": "Request message for `InitializeCustomer` method.", - "id": "InitializeCustomerRequest", - "properties": {}, + "NetStatsProto": { + "id": "NetStatsProto", + "properties": { + "bandaidBandwidthKbps": { + "$ref": "BandWidthRangeKbps" + }, + "bandwidthKbps": { + "format": "int32", + "type": "integer" + }, + "gfeBandwidthKbps": { + "$ref": "BandWidthRangeKbps" + }, + "videostatsBandwidthKbps": { + "$ref": "BandWidthRangeKbps" + } + }, "type": "object" }, - "IntegerFacetingOptions": { - "description": "Used to specify integer faceting options.", - "id": "IntegerFacetingOptions", + "ObjectDefinition": { + "description": "The definition for an object within a data source.", + "id": "ObjectDefinition", "properties": { - "integerBuckets": { - "description": "Buckets for given integer values should be in strictly ascending order. For example, if values supplied are (1,5,10,100), the following facet buckets will be formed {<1, [1,5), [5-10), [10-100), >=100}.", + "name": { + "description": "The name for the object, which then defines its type. Item indexing requests should set the objectType field equal to this value. For example, if *name* is *Document*, then indexing requests for items of type Document should set objectType equal to *Document*. Each object definition must be uniquely named within a schema. The name must start with a letter and can only contain letters (A-Z, a-z) or numbers (0-9). The maximum length is 256 characters.", + "type": "string" + }, + "options": { + "$ref": "ObjectOptions", + "description": "The optional object-specific options." + }, + "propertyDefinitions": { + "description": "The property definitions for the object. The maximum number of elements is 1000.", "items": { - "format": "int64", - "type": "string" + "$ref": "PropertyDefinition" }, "type": "array" } }, "type": "object" }, - "IntegerOperatorOptions": { - "description": "Used to provide a search operator for integer properties. This is optional. Search operators let users restrict the query to specific fields relevant to the type of item being searched.", - "id": "IntegerOperatorOptions", + "ObjectDisplayOptions": { + "description": "The display options for an object.", + "id": "ObjectDisplayOptions", "properties": { - "greaterThanOperatorName": { - "description": "Indicates the operator name required in the query in order to isolate the integer property using the greater-than operator. For example, if greaterThanOperatorName is *priorityabove* and the property's name is *priorityVal*, then queries like *priorityabove:* show results only where the value of the property named *priorityVal* is greater than **. The operator name can only contain lowercase letters (a-z). The maximum length is 32 characters.", - "type": "string" - }, - "lessThanOperatorName": { - "description": "Indicates the operator name required in the query in order to isolate the integer property using the less-than operator. For example, if lessThanOperatorName is *prioritybelow* and the property's name is *priorityVal*, then queries like *prioritybelow:* show results only where the value of the property named *priorityVal* is less than **. The operator name can only contain lowercase letters (a-z). The maximum length is 32 characters.", - "type": "string" + "metalines": { + "description": "Defines the properties that are displayed in the metalines of the search results. The property values are displayed in the order given here. If a property holds multiple values, all of the values are displayed before the next properties. For this reason, it is a good practice to specify singular properties before repeated properties in this list. All of the properties must set is_returnable to true. The maximum number of metalines is 3.", + "items": { + "$ref": "Metaline" + }, + "type": "array" }, - "operatorName": { - "description": "Indicates the operator name required in the query in order to isolate the integer property. For example, if operatorName is *priority* and the property's name is *priorityVal*, then queries like *priority:* show results only where the value of the property named *priorityVal* matches **. By contrast, a search that uses the same ** without an operator returns all items where ** matches the value of any String properties or text within the content field for the item. The operator name can only contain lowercase letters (a-z). The maximum length is 32 characters.", + "objectDisplayLabel": { + "description": "The user friendly label to display in the search result to indicate the type of the item. This is OPTIONAL; if not provided, an object label isn't displayed on the context line of the search results. The maximum length is 64 characters.", "type": "string" } }, "type": "object" }, - "IntegerPropertyOptions": { - "description": "The options for integer properties.", - "id": "IntegerPropertyOptions", + "ObjectOptions": { + "description": "The options for an object.", + "id": "ObjectOptions", "properties": { - "integerFacetingOptions": { - "$ref": "IntegerFacetingOptions", - "description": "If set, describes integer faceting options for the given integer property. The corresponding integer property should be marked isFacetable." - }, - "maximumValue": { - "description": "The maximum value of the property. The minimum and maximum values for the property are used to rank results according to the ordered ranking. Indexing requests with values greater than the maximum are accepted and ranked with the same weight as items indexed with the maximum value.", - "format": "int64", - "type": "string" - }, - "minimumValue": { - "description": "The minimum value of the property. The minimum and maximum values for the property are used to rank results according to the ordered ranking. Indexing requests with values less than the minimum are accepted and ranked with the same weight as items indexed with the minimum value.", - "format": "int64", - "type": "string" + "displayOptions": { + "$ref": "ObjectDisplayOptions", + "description": "The options that determine how the object is displayed in the Cloud Search results page." }, - "operatorOptions": { - "$ref": "IntegerOperatorOptions", - "description": "If set, describes how the integer should be used as a search operator." + "freshnessOptions": { + "$ref": "FreshnessOptions", + "description": "The freshness options for an object." }, - "orderedRanking": { - "description": "Used to specify the ordered ranking for the integer. Can only be used if isRepeatable is false.", - "enum": [ - "NO_ORDER", - "ASCENDING", - "DESCENDING" - ], - "enumDescriptions": [ - "There is no ranking order for the property. Results are not adjusted by this property's value.", - "This property is ranked in ascending order. Lower values indicate lower ranking.", - "This property is ranked in descending order. Lower values indicate higher ranking." - ], - "type": "string" + "suggestionFilteringOperators": { + "description": "Operators that can be used to filter suggestions. For Suggest API, only operators mentioned here will be honored in the FilterOptions. Only TEXT and ENUM operators are supported. NOTE: \"objecttype\", \"type\" and \"mimetype\" are already supported. This property is to configure schema specific operators. Even though this is an array, only one operator can be specified. This is an array for future extensibility. Operators mapping to multiple properties within the same object are not supported. If the operator spans across different object types, this option has to be set once for each object definition.", + "items": { + "type": "string" + }, + "type": "array" } }, "type": "object" }, - "IntegerValues": { - "description": "List of integer values.", - "id": "IntegerValues", + "ObjectPropertyOptions": { + "description": "The options for object properties.", + "id": "ObjectPropertyOptions", "properties": { - "values": { + "subobjectProperties": { + "description": "The properties of the sub-object. These properties represent a nested object. For example, if this property represents a postal address, the subobjectProperties might be named *street*, *city*, and *state*. The maximum number of elements is 1000.", "items": { - "format": "int64", - "type": "string" + "$ref": "PropertyDefinition" }, "type": "array" } }, "type": "object" }, - "Interaction": { - "description": "Represents an interaction between a user and an item.", - "id": "Interaction", + "ObjectValues": { + "description": "List of object values.", + "id": "ObjectValues", "properties": { - "interactionTime": { - "description": "The time when the user acted on the item. If multiple actions of the same type exist for a single user, only the most recent action is recorded.", - "format": "google-datetime", - "type": "string" - }, - "principal": { - "$ref": "Principal", - "description": "The user that acted on the item." - }, - "type": { - "enum": [ - "UNSPECIFIED", - "VIEW", - "EDIT" - ], - "enumDescriptions": [ - "Invalid value.", - "This interaction indicates the user viewed the item.", - "This interaction indicates the user edited the item." - ], - "type": "string" + "values": { + "items": { + "$ref": "StructuredDataObject" + }, + "type": "array" } }, "type": "object" }, - "Item": { - "description": "Represents a single object that is an item in the search index, such as a file, folder, or a database record.", - "id": "Item", + "Operation": { + "description": "This resource represents a long-running operation that is the result of a network API call.", + "id": "Operation", "properties": { - "acl": { - "$ref": "ItemAcl", - "description": "Access control list for this item." - }, - "content": { - "$ref": "ItemContent", - "description": "Item content to be indexed and made text searchable." + "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" }, - "itemType": { - "description": "The type for this item.", - "enum": [ - "UNSPECIFIED", - "CONTENT_ITEM", - "CONTAINER_ITEM", - "VIRTUAL_CONTAINER_ITEM" - ], - "enumDescriptions": [ - "", - "An item that is indexed for the only purpose of serving information. These items cannot be referred in containerName or inheritAclFrom fields.", - "An item that gets indexed and whose purpose is to supply other items with ACLs and/or contain other items.", - "An item that does not get indexed, but otherwise has the same purpose as CONTAINER_ITEM." - ], - "type": "string" + "error": { + "$ref": "Status", + "description": "The error result of the operation in case of failure or cancellation." }, "metadata": { - "$ref": "ItemMetadata", - "description": "The metadata information." + "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": { - "description": "The name of the Item. Format: datasources/{source_id}/items/{item_id} This is a required field. The maximum length is 1536 characters.", - "type": "string" - }, - "payload": { - "description": "Additional state connector can store for this item. The maximum length is 10000 bytes.", - "format": "byte", - "type": "string" - }, - "queue": { - "description": "Queue this item belongs to. The maximum length is 100 characters.", + "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" }, - "status": { - "$ref": "ItemStatus", - "description": "Status of the item. Output only field." - }, - "structuredData": { - "$ref": "ItemStructuredData", - "description": "The structured data for the item that should conform to a registered object definition in the schema for the data source." - }, - "version": { - "description": "Required. The indexing system stores the version from the datasource as a byte string and compares the Item version in the index to the version of the queued Item using lexical ordering. Cloud Search Indexing won't index or delete any queued item with a version value that is less than or equal to the version of the currently indexed item. The maximum length for this field is 1024 bytes. For information on how item version affects the deletion process, refer to [Handle revisions after manual deletes](https://developers.google.com/cloud-search/docs/guides/operations).", - "format": "byte", - "type": "string" + "response": { + "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`.", + "type": "object" } }, "type": "object" }, - "ItemAcl": { - "description": "Access control list information for the item. For more information see [Map ACLs](https://developers.google.com/cloud-search/docs/guides/acls).", - "id": "ItemAcl", + "OptInStatus": { + "description": "The status and eligibility information for a single feature.", + "id": "OptInStatus", "properties": { - "aclInheritanceType": { - "description": "Sets the type of access rules to apply when an item inherits its ACL from a parent. This should always be set in tandem with the inheritAclFrom field. Also, when the inheritAclFrom field is set, this field should be set to a valid AclInheritanceType.", + "eligibility": { + "description": "If the user is ineligible, they should not be opted in!", "enum": [ - "NOT_APPLICABLE", - "CHILD_OVERRIDE", - "PARENT_OVERRIDE", - "BOTH_PERMIT" + "UNKNOWN_ELIGIBILITY", + "ELIGIBLE", + "INELIGIBLE_DASHER", + "INELIGIBLE_GEO", + "INELIGIBLE_UNICORN", + "INELIGIBLE_OTHER" ], "enumDescriptions": [ - "The default value when this item does not inherit an ACL. Use NOT_APPLICABLE when inheritAclFrom is empty. An item without ACL inheritance can still have ACLs supplied by its own readers and deniedReaders fields.", - "During an authorization conflict, the ACL of the child item determines its read access.", - "During an authorization conflict, the ACL of the parent item specified in the inheritAclFrom field determines read access.", - "Access is granted only if this item and the parent item specified in the inheritAclFrom field both permit read access." + "Default value.", + "The user is eligible.", + "Ineligible due to Dasher restriction.", + "Ineligible due to geo (country or territory) restriction.", + "Ineligible due to Unicorn underage child account.", + "Ineligible for some other reason." ], "type": "string" }, - "deniedReaders": { - "description": "List of principals who are explicitly denied access to the item in search results. While principals are denied access by default, use denied readers to handle exceptions and override the list allowed readers. The maximum number of elements is 100.", + "optedIn": { + "description": "If the user is ineligible, they should not be opted in!", + "type": "boolean" + } + }, + "type": "object" + }, + "PeoplePromotionCard": { + "id": "PeoplePromotionCard", + "properties": { + "people": { "items": { - "$ref": "Principal" + "$ref": "PersonCore" + }, + "type": "array" + } + }, + "type": "object" + }, + "PeopleSuggestion": { + "description": "This field contains information about the person being suggested.", + "id": "PeopleSuggestion", + "properties": { + "person": { + "$ref": "Person", + "description": "Suggested person. All fields of the person object might not be populated." + } + }, + "type": "object" + }, + "Person": { + "description": "Object to represent a person.", + "id": "Person", + "properties": { + "emailAddresses": { + "description": "The person's email addresses", + "items": { + "$ref": "EmailAddress" }, "type": "array" }, - "inheritAclFrom": { - "description": "The name of the item to inherit the Access Permission List (ACL) from. Note: ACL inheritance *only* provides access permissions to child items and does not define structural relationships, nor does it provide convenient ways to delete large groups of items. Deleting an ACL parent from the index only alters the access permissions of child items that reference the parent in the inheritAclFrom field. The item is still in the index, but may not visible in search results. By contrast, deletion of a container item also deletes all items that reference the container via the containerName field. The maximum length for this field is 1536 characters.", + "name": { + "description": "The resource name of the person to provide information about. See [`People.get`](https://developers.google.com/people/api/rest/v1/people/get) from the Google People API.", "type": "string" }, - "owners": { - "description": "Optional. List of owners for the item. This field has no bearing on document access permissions. It does, however, offer a slight ranking boosts items where the querying user is an owner. The maximum number of elements is 5.", + "obfuscatedId": { + "description": "Obfuscated ID of a person.", + "type": "string" + }, + "personNames": { + "description": "The person's name", "items": { - "$ref": "Principal" + "$ref": "Name" }, "type": "array" }, - "readers": { - "description": "List of principals who are allowed to see the item in search results. Optional if inheriting permissions from another item or if the item is not intended to be visible, such as virtual containers. The maximum number of elements is 1000.", + "phoneNumbers": { + "description": "The person's phone numbers", "items": { - "$ref": "Principal" + "$ref": "PhoneNumber" + }, + "type": "array" + }, + "photos": { + "description": "A person's read-only photo. A picture shown next to the person's name to help others recognize the person in search results.", + "items": { + "$ref": "Photo" }, "type": "array" } }, "type": "object" }, - "ItemContent": { - "description": "Content of an item to be indexed and surfaced by Cloud Search. Only UTF-8 encoded strings are allowed as inlineContent. If the content is uploaded and not binary, it must be UTF-8 encoded.", - "id": "ItemContent", + "PersonCore": { + "description": "Information for rendering a person. NEXT ID: 37", + "id": "PersonCore", "properties": { - "contentDataRef": { - "$ref": "UploadItemRef", - "description": "Upload reference ID of a previously uploaded content via write method." + "addressMeAs": { + "description": "Instructions for how to address this person (e.g. custom pronouns). For google.com this is a set of pronouns from a defined list of options.", + "type": "string" }, - "contentFormat": { + "adminTo": { + "description": "People the profile owner is an admin to. Note that not all fields of these PersonCores will be set, in particular, relationships will be empty.", + "items": { + "$ref": "PersonCore" + }, + "type": "array" + }, + "admins": { + "description": "The profile owner's admins in no particular order. Note that not all fields of these PersonCores will be set, in particular, relationships will be empty.", + "items": { + "$ref": "PersonCore" + }, + "type": "array" + }, + "availabilityStatus": { "enum": [ - "UNSPECIFIED", - "HTML", - "TEXT", - "RAW" + "UNKNOWN", + "OUT_OF_OFFICE", + "OUTSIDE_WORKING_HOURS", + "AVAILABLE" ], "enumDescriptions": [ - "Invalid value.", - "contentFormat is HTML.", - "contentFormat is free text.", - "contentFormat is raw bytes." + "", + "", + "", + "" ], "type": "string" }, - "hash": { - "description": "Hashing info calculated and provided by the API client for content. Can be used with the items.push method to calculate modified state. The maximum length is 2048 characters.", - "type": "string" + "birthday": { + "$ref": "Date", + "description": "Person birthday." }, - "inlineContent": { - "description": "Content that is supplied inlined within the update method. The maximum length is 102400 bytes (100 KiB).", - "format": "byte", - "type": "string" - } - }, - "type": "object" - }, - "ItemCountByStatus": { - "id": "ItemCountByStatus", - "properties": { - "count": { - "description": "Number of items matching the status code.", - "format": "int64", - "type": "string" + "calendarUrl": { + "$ref": "SafeUrlProto", + "description": "The URL to open the profile owner's primary calendar." }, - "indexedItemsCount": { - "description": "Number of items matching the status code for which billing is done. This excludes virtual container items from the total count. This count would not be applicable for items with ERROR or NEW_ITEM status code.", - "format": "int64", - "type": "string" + "chatUrl": { + "$ref": "SafeUrlProto", + "description": "The URL to start a chat conversation with the profile owner. For google.com this is a Hangouts URL." }, - "statusCode": { - "description": "Status of the items.", - "enum": [ - "CODE_UNSPECIFIED", - "ERROR", - "MODIFIED", - "NEW_ITEM", - "ACCEPTED" - ], - "enumDescriptions": [ - "Input-only value. Used with Items.list to list all items in the queue, regardless of status.", - "Error encountered by Cloud Search while processing this item. Details of the error are in repositoryError.", - "Item has been modified in the repository, and is out of date with the version previously accepted into Cloud Search.", - "Item is known to exist in the repository, but is not yet accepted by Cloud Search. An item can be in this state when Items.push has been called for an item of this name that did not exist previously.", - "API has accepted the up-to-date data of this item." - ], - "type": "string" - } - }, - "type": "object" - }, - "ItemMetadata": { - "description": "Available metadata fields for the item.", - "id": "ItemMetadata", - "properties": { - "containerName": { - "description": "The name of the container for this item. Deletion of the container item leads to automatic deletion of this item. Note: ACLs are not inherited from a container item. To provide ACL inheritance for an item, use the inheritAclFrom field. The maximum length is 1536 characters.", + "costCenter": { + "description": "Person's cost center as a string, e.g. \"926: Googler Apps\".", "type": "string" }, - "contentLanguage": { - "description": "The BCP-47 language code for the item, such as \"en-US\" or \"sr-Latn\". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. The maximum length is 32 characters.", + "department": { + "description": "The person's Organization department, e.g. \"People Operations\". For google.com this is usually called \"area\".", "type": "string" }, - "contextAttributes": { - "description": "A set of named attributes associated with the item. This can be used for influencing the ranking of the item based on the context in the request. The maximum number of elements is 10.", + "directReports": { + "description": "A subset of the profile owner's direct reports. The number of entities here may be less than total_direct_reports_count, because typically ProfileResponse does not include all the person's reports, if there are too many to retrieve efficiently. Note that not all fields of these PersonCores will be set, in particular, relationships will be empty.", "items": { - "$ref": "ContextAttribute" + "$ref": "PersonCore" }, "type": "array" }, - "createTime": { - "description": "The time when the item was created in the source repository.", - "format": "google-datetime", - "type": "string" - }, - "hash": { - "description": "Hashing value provided by the API caller. This can be used with the items.push method to calculate modified state. The maximum length is 2048 characters.", - "type": "string" + "dottedLineManagers": { + "description": "The profile owner's direct dotted line managers in no particular order. Note that not all fields of these PersonCores will be set, in particular, relationships will be empty.", + "items": { + "$ref": "PersonCore" + }, + "type": "array" }, - "interactions": { - "description": "A list of interactions for the item. Interactions are used to improve Search quality, but are not exposed to end users. The maximum number of elements is 1000.", + "dottedLineReports": { + "description": "A subset of the profile owner's dotted-line reports. The number of entities here may be less than total_dlr_count. Note that not all fields of these PersonCores will be set, in particular, relationships will be empty.", "items": { - "$ref": "Interaction" + "$ref": "PersonCore" }, "type": "array" }, - "keywords": { - "description": "Additional keywords or phrases that should match the item. Used internally for user generated content. The maximum number of elements is 100. The maximum length is 8192 characters.", + "emails": { + "description": "E-mail addresses of the person. The primary or preferred email should be first.", "items": { "type": "string" }, "type": "array" }, - "mimeType": { - "description": "The original mime-type of ItemContent.content in the source repository. The maximum length is 256 characters.", + "employeeId": { + "description": "Person's employee number (external ID of type \"organization\") For google.com this is the badge number (e.g. 2 for Larry Page).", "type": "string" }, - "objectType": { - "description": "The type of the item. This should correspond to the name of an object definition in the schema registered for the data source. For example, if the schema for the data source contains an object definition with name 'document', then item indexing requests for objects of that type should set objectType to 'document'. The maximum length is 256 characters.", + "fingerprint": { + "description": "A fingerprint used by PAPI to reliably determine if a resource has changed Externally it is used as part of the etag.", "type": "string" }, - "searchQualityMetadata": { - "$ref": "SearchQualityMetadata", - "description": "Additional search quality metadata of the item" - }, - "sourceRepositoryUrl": { - "description": "Link to the source repository serving the data. Seach results apply this link to the title. Whitespace or special characters may cause Cloud Seach result links to trigger a redirect notice; to avoid this, encode the URL. The maximum length is 2048 characters.", + "ftePermille": { + "description": "Full-time equivalent (in ‰) (e.g. 800 for a person who's working 80%).", + "format": "int64", "type": "string" }, - "title": { - "description": "The title of the item. If given, this will be the displayed title of the Search result. The maximum length is 2048 characters.", - "type": "string" + "geoLocation": { + "$ref": "MapInfo" }, - "updateTime": { - "description": "The time when the item was last modified in the source repository.", - "format": "google-datetime", + "gmailUrl": { "type": "string" - } - }, - "type": "object" - }, - "ItemStatus": { - "description": "This contains item's status and any errors.", - "id": "ItemStatus", - "properties": { - "code": { - "description": "Status code.", - "enum": [ - "CODE_UNSPECIFIED", - "ERROR", - "MODIFIED", - "NEW_ITEM", - "ACCEPTED" - ], - "enumDescriptions": [ - "Input-only value. Used with Items.list to list all items in the queue, regardless of status.", - "Error encountered by Cloud Search while processing this item. Details of the error are in repositoryError.", - "Item has been modified in the repository, and is out of date with the version previously accepted into Cloud Search.", - "Item is known to exist in the repository, but is not yet accepted by Cloud Search. An item can be in this state when Items.push has been called for an item of this name that did not exist previously.", - "API has accepted the up-to-date data of this item." - ], + }, + "jobTitle": { + "description": "Profile owner's job title (e.g. \"Software Engineer\"). For google.com this is the Workday preferred job title.", "type": "string" }, - "processingErrors": { - "description": "Error details in case the item is in ERROR state.", + "keywordTypes": { + "description": "List of keys to use from the map 'keywords'.", "items": { - "$ref": "ProcessingError" + "type": "string" }, "type": "array" }, - "repositoryErrors": { - "description": "Repository error reported by connector.", - "items": { - "$ref": "RepositoryError" + "keywords": { + "additionalProperties": { + "type": "string" }, - "type": "array" - } - }, - "type": "object" - }, - "ItemStructuredData": { - "description": "Available structured data fields for the item.", - "id": "ItemStructuredData", - "properties": { - "hash": { - "description": "Hashing value provided by the API caller. This can be used with the items.push method to calculate modified state. The maximum length is 2048 characters.", - "type": "string" - }, - "object": { - "$ref": "StructuredDataObject", - "description": "The structured data object that should conform to a registered object definition in the schema for the data source." - } - }, - "type": "object" - }, - "ListDataSourceResponse": { - "id": "ListDataSourceResponse", - "properties": { - "nextPageToken": { - "description": "Token to retrieve the next page of results, or empty if there are no more results in the list.", - "type": "string" + "description": "Custom keywords the domain admin has added.", + "type": "object" }, - "sources": { - "items": { - "$ref": "DataSource" - }, - "type": "array" - } - }, - "type": "object" - }, - "ListItemNamesForUnmappedIdentityResponse": { - "id": "ListItemNamesForUnmappedIdentityResponse", - "properties": { - "itemNames": { + "links": { + "description": "Custom links the profile owner has added.", "items": { - "type": "string" + "$ref": "EnterpriseTopazFrontendTeamsLink" }, "type": "array" }, - "nextPageToken": { - "description": "Token to retrieve the next page of results, or empty if there are no more results in the list.", + "location": { + "description": "Detailed desk location within the company. For google.com this is the desk location code (e.g. \"DE-MUC-ARP-6T2-6T2C0C\") if the person has a desk.", "type": "string" - } - }, - "type": "object" - }, - "ListItemsResponse": { - "id": "ListItemsResponse", - "properties": { - "items": { + }, + "managers": { + "description": "The profile owner's management chain from top to bottom, where managers[0] is the CEO, manager[N-2] is the person's manager's manager and managers[N-1] is the person's direct manager. Note that not all fields of these PersonCores will be set, in particular, relationships will be empty.", "items": { - "$ref": "Item" + "$ref": "PersonCore" }, "type": "array" }, - "nextPageToken": { - "description": "Token to retrieve the next page of results, or empty if there are no more results in the list.", - "type": "string" - } - }, - "type": "object" - }, - "ListOperationsResponse": { - "description": "The response message for Operations.ListOperations.", - "id": "ListOperationsResponse", - "properties": { - "nextPageToken": { - "description": "The standard List next-page token.", + "mission": { + "description": "Custom mission statement the profile owner has added.", "type": "string" }, - "operations": { - "description": "A list of operations that matches the specified filter in the request.", - "items": { - "$ref": "Operation" - }, - "type": "array" - } - }, - "type": "object" - }, - "ListQuerySourcesResponse": { - "description": "List sources response.", - "id": "ListQuerySourcesResponse", - "properties": { - "nextPageToken": { + "name": { + "description": "Human-readable Unicode display name.", "type": "string" }, - "sources": { - "items": { - "$ref": "QuerySource" - }, - "type": "array" - } - }, - "type": "object" - }, - "ListSearchApplicationsResponse": { - "id": "ListSearchApplicationsResponse", - "properties": { - "nextPageToken": { - "description": "Token to retrieve the next page of results, or empty if there are no more results in the list.", + "officeLocation": { + "description": "Office/building identifier within the company. For google.com this is the office code (e.g. \"DE-MUC-ARP\").", "type": "string" }, - "searchApplications": { - "items": { - "$ref": "SearchApplication" - }, - "type": "array" - } - }, - "type": "object" - }, - "ListUnmappedIdentitiesResponse": { - "id": "ListUnmappedIdentitiesResponse", - "properties": { - "nextPageToken": { - "description": "Token to retrieve the next page of results, or empty if there are no more results in the list.", + "personId": { + "description": "The person's obfuscated Gaia ID.", "type": "string" }, - "unmappedIdentities": { + "phoneNumbers": { "items": { - "$ref": "UnmappedIdentity" + "$ref": "EnterpriseTopazFrontendTeamsPersonCorePhoneNumber" }, "type": "array" - } - }, - "type": "object" - }, - "MapInfo": { - "description": "Geo information used for rendering a map that shows the user's work location.", - "id": "MapInfo", - "properties": { - "lat": { - "description": "Latitude in degrees", - "format": "double", - "type": "number" }, - "locationUrl": { + "photoUrl": { "$ref": "SafeUrlProto", - "description": "URL to a view of a map centered on the user's work location in Campus Maps (for google.com) or Google Maps (external)." + "description": "Person photo." }, - "long": { - "description": "Longitude in degrees", - "format": "double", - "type": "number" + "postalAddress": { + "description": "Postal address of office/building.", + "type": "string" }, - "mapTile": { - "description": "MapTiles for the area around a user's work location", - "items": { - "$ref": "MapTile" - }, - "type": "array" + "totalDirectReportsCount": { + "description": "Total count of the profile owner's direct reports.", + "format": "int32", + "type": "integer" + }, + "totalDlrCount": { + "description": "Total count of the profile owner's dotted-line reports.", + "format": "int32", + "type": "integer" + }, + "totalFteCount": { + "description": "The sum of all profile owner's reports and their own full-time-equivalents in ‰ (e.g. 1800 if one report is working 80% and profile owner 100%).", + "format": "int64", + "type": "string" + }, + "username": { + "description": "External ID of type \"login_id\" for the profile. For google.com this is the username/LDAP.", + "type": "string" }, - "zoom": { - "description": "The zoom level of the map. A constant zoom value of 18 is used for now to match the zoom of the map shown on a Moma Teams Profile page", - "format": "int32", - "type": "integer" + "waldoComeBackTime": { + "format": "google-datetime", + "type": "string" } }, "type": "object" }, - "MapTile": { - "description": "Information used to render a map tile image in the proper location on a map.", - "id": "MapTile", + "PhoneNumber": { + "description": "A person's Phone Number", + "id": "PhoneNumber", "properties": { - "imageUrl": { - "$ref": "SafeUrlProto", - "description": "URL to an image file containing an office layout of the user's location for their organization, if one is available. For google.com, this image is from Corp Campus Maps." - }, - "tileX": { - "description": "Map tile x coordinate", - "format": "double", - "type": "number" + "phoneNumber": { + "description": "The phone number of the person.", + "type": "string" }, - "tileY": { - "description": "Map tile y coordinate", - "format": "double", - "type": "number" + "type": { + "enum": [ + "OTHER", + "MOBILE", + "OFFICE" + ], + "enumDescriptions": [ + "", + "", + "" + ], + "type": "string" } }, "type": "object" }, - "MatchRange": { - "description": "Matched range of a snippet [start, end).", - "id": "MatchRange", + "Photo": { + "description": "A person's photo.", + "id": "Photo", "properties": { - "end": { - "description": "End of the match in the snippet.", - "format": "int32", - "type": "integer" - }, - "start": { - "description": "Starting position of the match in the snippet.", - "format": "int32", - "type": "integer" + "url": { + "description": "The URL of the photo.", + "type": "string" } }, "type": "object" }, - "Media": { - "description": "Media resource.", - "id": "Media", + "PollItemsRequest": { + "id": "PollItemsRequest", "properties": { - "resourceName": { - "description": "Name of the media resource.", + "connectorName": { + "description": "The name of connector making this call. Format: datasources/{source_id}/connectors/{ID}", + "type": "string" + }, + "debugOptions": { + "$ref": "DebugOptions", + "description": "Common debug options." + }, + "limit": { + "description": "Maximum number of items to return. The maximum value is 100 and the default value is 20.", + "format": "int32", + "type": "integer" + }, + "queue": { + "description": "Queue name to fetch items from. If unspecified, PollItems will fetch from 'default' queue. The maximum length is 100 characters.", "type": "string" + }, + "statusCodes": { + "description": "Limit the items polled to the ones with these statuses.", + "items": { + "enum": [ + "CODE_UNSPECIFIED", + "ERROR", + "MODIFIED", + "NEW_ITEM", + "ACCEPTED" + ], + "enumDescriptions": [ + "Input-only value. Used with Items.list to list all items in the queue, regardless of status.", + "Error encountered by Cloud Search while processing this item. Details of the error are in repositoryError.", + "Item has been modified in the repository, and is out of date with the version previously accepted into Cloud Search.", + "Item is known to exist in the repository, but is not yet accepted by Cloud Search. An item can be in this state when Items.push has been called for an item of this name that did not exist previously.", + "API has accepted the up-to-date data of this item." + ], + "type": "string" + }, + "type": "array" } }, "type": "object" }, - "Metadata": { - "description": "Metadata of a matched search result.", - "id": "Metadata", + "PollItemsResponse": { + "id": "PollItemsResponse", "properties": { - "createTime": { - "description": "The creation time for this document or object in the search result.", - "format": "google-datetime", - "type": "string" - }, - "displayOptions": { - "$ref": "ResultDisplayMetadata", - "description": "Options that specify how to display a structured data search result." - }, - "fields": { - "description": "Indexed fields in structured data, returned as a generic named property.", + "items": { + "description": "Set of items from the queue available for connector to process. These items have the following subset of fields populated: version metadata.hash structured_data.hash content.hash payload status queue", "items": { - "$ref": "NamedProperty" + "$ref": "Item" }, "type": "array" - }, - "mimeType": { - "description": "Mime type of the search result.", - "type": "string" - }, - "objectType": { - "description": "Object type of the search result.", + } + }, + "type": "object" + }, + "Principal": { + "description": "Reference to a user, group, or domain.", + "id": "Principal", + "properties": { + "groupResourceName": { + "description": "This principal is a group identified using an external identity. The name field must specify the group resource name with this format: identitysources/{source_id}/groups/{ID}", "type": "string" }, - "owner": { - "$ref": "Person", - "description": "Owner (usually creator) of the document or object of the search result." - }, - "source": { - "$ref": "Source", - "description": "The named source for the result, such as Gmail." - }, - "thumbnailUrl": { - "description": "The thumbnail URL of the result.", - "type": "string" + "gsuitePrincipal": { + "$ref": "GSuitePrincipal", + "description": "This principal is a Google Workspace user, group or domain." }, - "updateTime": { - "description": "The last modified date for the object in the search result. If not set in the item, the value returned here is empty. When `updateTime` is used for calculating freshness and is not set, this value defaults to 2 years from the current time.", - "format": "google-datetime", + "userResourceName": { + "description": "This principal is a user identified using an external identity. The name field must specify the user resource name with this format: identitysources/{source_id}/users/{ID}", "type": "string" } }, "type": "object" }, - "Metaline": { - "description": "A metaline is a list of properties that are displayed along with the search result to provide context.", - "id": "Metaline", + "ProcessingError": { + "id": "ProcessingError", "properties": { - "properties": { - "description": "The list of displayed properties for the metaline. The maximum number of properties is 5.", + "code": { + "description": "Error code indicating the nature of the error.", + "enum": [ + "PROCESSING_ERROR_CODE_UNSPECIFIED", + "MALFORMED_REQUEST", + "UNSUPPORTED_CONTENT_FORMAT", + "INDIRECT_BROKEN_ACL", + "ACL_CYCLE" + ], + "enumDescriptions": [ + "Input only value. Use this value in Items.", + "Item's ACL, metadata, or content is malformed or in invalid state. FieldViolations contains more details on where the problem is.", + "Countent format is unsupported.", + "Items with incomplete ACL information due to inheriting other items with broken ACL or having groups with unmapped descendants.", + "ACL inheritance graph formed a cycle." + ], + "type": "string" + }, + "errorMessage": { + "description": "The description of the error.", + "type": "string" + }, + "fieldViolations": { + "description": "In case the item fields are invalid, this field contains the details about the validation errors.", "items": { - "$ref": "DisplayedProperty" + "$ref": "FieldViolation" }, "type": "array" } }, "type": "object" }, - "Name": { - "description": "A person's name.", - "id": "Name", + "ProminentEntity": { + "description": "prominent_entity(ies) field encodes the main subject(entities) which the client wants to bias the query into. For a Mini-App, it'll be the main entities in the current Mini-App page. It provides finer-granularity contexts on top of the “mode” field. Note that when QueryBiasingContext is passed to server through ClientDiscourseContext, the prominent_entity should NOT be set and the corresponding information will be merged from ClientDiscourseContext.entity field at the server side.", + "id": "ProminentEntity", "properties": { - "displayName": { - "description": "The read-only display name formatted according to the locale specified by the viewer's account or the `Accept-Language` HTTP header.", + "mid": { "type": "string" } }, "type": "object" }, - "NamedProperty": { - "description": "A typed name-value pair for structured data. The type of the value should be the same as the registered type for the `name` property in the object definition of `objectType`.", - "id": "NamedProperty", + "PropertyDefinition": { + "description": "The definition of a property within an object.", + "id": "PropertyDefinition", "properties": { - "booleanValue": { + "booleanPropertyOptions": { + "$ref": "BooleanPropertyOptions" + }, + "datePropertyOptions": { + "$ref": "DatePropertyOptions" + }, + "displayOptions": { + "$ref": "PropertyDisplayOptions", + "description": "The options that determine how the property is displayed in the Cloud Search results page if it's specified to be displayed in the object's display options." + }, + "doublePropertyOptions": { + "$ref": "DoublePropertyOptions" + }, + "enumPropertyOptions": { + "$ref": "EnumPropertyOptions" + }, + "htmlPropertyOptions": { + "$ref": "HtmlPropertyOptions" + }, + "integerPropertyOptions": { + "$ref": "IntegerPropertyOptions" + }, + "isFacetable": { + "description": "Indicates that the property can be used for generating facets. Cannot be true for properties whose type is object. IsReturnable must be true to set this option. Only supported for boolean, enum, integer, and text properties.", "type": "boolean" }, - "dateValues": { - "$ref": "DateValues" + "isRepeatable": { + "description": "Indicates that multiple values are allowed for the property. For example, a document only has one description but can have multiple comments. Cannot be true for properties whose type is a boolean. If set to false, properties that contain more than one value cause the indexing request for that item to be rejected.", + "type": "boolean" }, - "doubleValues": { - "$ref": "DoubleValues" + "isReturnable": { + "description": "Indicates that the property identifies data that should be returned in search results via the Query API. If set to *true*, indicates that Query API users can use matching property fields in results. However, storing fields requires more space allocation and uses more bandwidth for search queries, which impacts performance over large datasets. Set to *true* here only if the field is needed for search results. Cannot be true for properties whose type is an object.", + "type": "boolean" }, - "enumValues": { - "$ref": "EnumValues" + "isSortable": { + "description": "Indicates that the property can be used for sorting. Cannot be true for properties that are repeatable. Cannot be true for properties whose type is object. IsReturnable must be true to set this option. Only supported for boolean, date, double, integer, and timestamp properties.", + "type": "boolean" }, - "htmlValues": { - "$ref": "HtmlValues" + "isSuggestable": { + "description": "Indicates that the property can be used for generating query suggestions.", + "type": "boolean" }, - "integerValues": { - "$ref": "IntegerValues" + "isWildcardSearchable": { + "description": "Indicates that users can perform wildcard search for this property. Only supported for Text properties. IsReturnable must be true to set this option. In a given datasource maximum of 5 properties can be marked as is_wildcard_searchable. For more details, see [Define object properties](https://developers.google.com/cloud-search/docs/guides/schema-guide#properties)", + "type": "boolean" }, "name": { - "description": "The name of the property. This name should correspond to the name of the property that was registered for object definition in the schema. The maximum allowable length for this property is 256 characters.", + "description": "The name of the property. Item indexing requests sent to the Indexing API should set the property name equal to this value. For example, if name is *subject_line*, then indexing requests for document items with subject fields should set the name for that field equal to *subject_line*. Use the name as the identifier for the object property. Once registered as a property for an object, you cannot re-use this name for another property within that object. The name must start with a letter and can only contain letters (A-Z, a-z) or numbers (0-9). The maximum length is 256 characters.", "type": "string" }, - "objectValues": { - "$ref": "ObjectValues" + "objectPropertyOptions": { + "$ref": "ObjectPropertyOptions" }, - "textValues": { - "$ref": "TextValues" + "textPropertyOptions": { + "$ref": "TextPropertyOptions" }, - "timestampValues": { - "$ref": "TimestampValues" + "timestampPropertyOptions": { + "$ref": "TimestampPropertyOptions" } }, "type": "object" }, - "ObjectDefinition": { - "description": "The definition for an object within a data source.", - "id": "ObjectDefinition", + "PropertyDisplayOptions": { + "description": "The display options for a property.", + "id": "PropertyDisplayOptions", "properties": { - "name": { - "description": "The name for the object, which then defines its type. Item indexing requests should set the objectType field equal to this value. For example, if *name* is *Document*, then indexing requests for items of type Document should set objectType equal to *Document*. Each object definition must be uniquely named within a schema. The name must start with a letter and can only contain letters (A-Z, a-z) or numbers (0-9). The maximum length is 256 characters.", + "displayLabel": { + "description": "The user friendly label for the property that is used if the property is specified to be displayed in ObjectDisplayOptions. If provided, the display label is shown in front of the property values when the property is part of the object display options. For example, if the property value is '1', the value by itself may not be useful context for the user. If the display name given was 'priority', then the user sees 'priority : 1' in the search results which provides clear context to search users. This is OPTIONAL; if not given, only the property values are displayed. The maximum length is 64 characters.", "type": "string" - }, - "options": { - "$ref": "ObjectOptions", - "description": "The optional object-specific options." - }, - "propertyDefinitions": { - "description": "The property definitions for the object. The maximum number of elements is 1000.", - "items": { - "$ref": "PropertyDefinition" - }, - "type": "array" } }, "type": "object" }, - "ObjectDisplayOptions": { - "description": "The display options for an object.", - "id": "ObjectDisplayOptions", + "ProxyClassificationProto": { + "description": "The enums in ProxyClassificationProto have the same values as in Neustar's data, plus a NONE value, corresponding to empty value in the Neustar's data. See Neustar's IP Intelligence GeoPoint Data Glossary (https://ipintelligence.neustar.biz/portal/home#downloads) for a more detailed description of the meaning of the values. In the data as of January 2016, if the IP address is classified as a proxy, the four fields anonymizer_status, proxy_type, proxy_level and proxy_last_detected_s are all present and set to a value different from NONE; otherwise the enum fields are not set or set to the corresponding NONE constant and proxy_last_detected_s is not set.", + "id": "ProxyClassificationProto", "properties": { - "metalines": { - "description": "Defines the properties that are displayed in the metalines of the search results. The property values are displayed in the order given here. If a property holds multiple values, all of the values are displayed before the next properties. For this reason, it is a good practice to specify singular properties before repeated properties in this list. All of the properties must set is_returnable to true. The maximum number of metalines is 3.", - "items": { - "$ref": "Metaline" - }, - "type": "array" + "anonymizerStatus": { + "description": "WARNING: these fields are coming from a third party. Please consider using only privacy_proxy_operator. Before adding any new usage of this data, please talk to zszami@ and ipgeo-team@.", + "enum": [ + "NONE", + "ACTIVE", + "SUSPECT", + "INACTIVE", + "PRIVATE" + ], + "enumDescriptions": [ + "This is not a proxy or it is unknown what status it has.", + "The anonymizer tested positive within the last month when the data were generated.", + "The anonymizer tested positive within the 3 months, but not last month when the data were generated.", + "The anonymizer tested positive within the last six months, but not in the last 3 months when the data were generated.", + "An anonymizer that is not publicly accessible and as such, cannot be routinely tested with automated tools. E.g. commercial VPN services. Unlike the classifications ACTIVE/SUSPECT/INACTIVE, classification as PRIVATE gives no guarantees about the age of last proxy detection (proxy_last_detected_s) - it can be older than 6 months." + ], + "type": "string" }, - "objectDisplayLabel": { - "description": "The user friendly label to display in the search result to indicate the type of the item. This is OPTIONAL; if not provided, an object label isn't displayed on the context line of the search results. The maximum length is 64 characters.", + "hostingFacility": { + "type": "boolean" + }, + "privacyProxyOperator": { + "description": "Operator of a privacy proxy, e.g. Google One (PPN) or Apple Private Relay. Mapping maintained by Google, does not include data from Neustar. If in doubt, use privacy_proxy_operator == NONE and != NONE to check for privacy proxies.", + "enum": [ + "NONE", + "UNKNOWN_PRIVACY_PROXY", + "GOOGLE_PPN", + "APPLE_PRIVATE_RELAY", + "GOOGLE_IP_PROTECTION", + "CLOUDFLARE_WARP" + ], + "enumDescriptions": [ + "This IP is not matched to any privacy proxy feeds maintained by IPGeo. Currently, proxy_type == PRIVACY_PROXY and privacy_proxy_operator = NONE may occur as the former field may also be filled by Neustar (3rd party), while this field is a google maintained datasource.", + "Privacy proxy, but we don't know any specific operator.", + "Values below may not be populated, most clients really should rely on ==NONE or !=NONE and have general messaging around privacy proxies.", + "", + "", + "" + ], "type": "string" - } - }, - "type": "object" - }, - "ObjectOptions": { - "description": "The options for an object.", - "id": "ObjectOptions", - "properties": { - "displayOptions": { - "$ref": "ObjectDisplayOptions", - "description": "The options that determine how the object is displayed in the Cloud Search results page." }, - "freshnessOptions": { - "$ref": "FreshnessOptions", - "description": "The freshness options for an object." + "proxyLastDetectedS": { + "description": "In seconds since the Epoch.", + "format": "int64", + "type": "string" }, - "suggestionFilteringOperators": { - "description": "Operators that can be used to filter suggestions. For Suggest API, only operators mentioned here will be honored in the FilterOptions. Only TEXT and ENUM operators are supported. NOTE: \"objecttype\", \"type\" and \"mimetype\" are already supported. This property is to configure schema specific operators. Even though this is an array, only one operator can be specified. This is an array for future extensibility. Operators mapping to multiple properties within the same object are not supported. If the operator spans across different object types, this option has to be set once for each object definition.", - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "ObjectPropertyOptions": { - "description": "The options for object properties.", - "id": "ObjectPropertyOptions", - "properties": { - "subobjectProperties": { - "description": "The properties of the sub-object. These properties represent a nested object. For example, if this property represents a postal address, the subobjectProperties might be named *street*, *city*, and *state*. The maximum number of elements is 1000.", - "items": { - "$ref": "PropertyDefinition" - }, - "type": "array" - } - }, - "type": "object" - }, - "ObjectValues": { - "description": "List of object values.", - "id": "ObjectValues", - "properties": { - "values": { - "items": { - "$ref": "StructuredDataObject" - }, - "type": "array" + "proxyLevel": { + "enum": [ + "NONE", + "ANONYMOUS", + "DISTORTING", + "ELITE", + "TRANSPARENT" + ], + "enumDescriptions": [ + "This is not a proxy or it is unknown what level it has.", + "The proxy obscures the end user’s IP address and does not conceal that it is a proxy. The following information is provided in the HTTP header: REMOTE_ADDR = Proxy IP Address HTTP_VIA = Proxy IP Address HTTP_X_FORWARDED_FOR = Proxy IP Address", + "The proxy obscures the end user’s IP address and does not conceal that it is a proxy. However, the end user’s IP address is replaced with a random IP address, thus there is a degree of subterfuge. The following information is provided in the HTTP header: REMOTE_ADDR = Proxy IP Address HTTP_VIA = Proxy IP Address HTTP_X_FORWARDED_FOR = Random IP Address", + "The proxy obscures the end user’s IP address and conceals that it is a proxy. The proxy appears to be an actual end user as all HTTP header fields are configured to appear as if a proxy is not in use: REMOTE_ADDR = Proxy IP Address HTTP_VIA = Not Determined HTTP_X_FORWARDED_FOR = Not Determined", + "The proxy does not obscure the end user’s IP address, nor does it conceal that it is a proxy. These proxies are typically used for information cashing and to provide joint access to Internet for multiple computers. The following information is provided in the HTTP header: REMOTE_ADDR = Proxy IP Address HTTP_VIA = Proxy IP Address HTTP_X_FORWARDED_FOR = End User IP Address" + ], + "type": "string" + }, + "proxyType": { + "enum": [ + "NONE", + "HTTP", + "SERVICE", + "SOCKS", + "SOCKS_HTTP", + "TOR", + "UNKNOWN", + "WEB", + "PRIVACY_PROXY" + ], + "enumDescriptions": [ + "This is not a proxy or it is unknown what type it has.", + "The proxy uses the HTTP protocol and has open ports which are accessible by any Internet user.", + "The proxy is operated by an organization (often for profit) that provides access to subscribers as a service. The proxy is one of an array of proxies (often internationally distributed) that are part of a Virtual Private Network (VPN) that subscribers connect to by installing an application.", + "The proxy uses the SOCKet Secure (SOCKS) protocol and has open ports which are accessible by any Internet user.", + "The proxy has both the HTTP and SOCKS protocols setup and has open ports which are accessible by any Internet user.", + "The proxy is part of the onion router (Tor) network.", + "The proxy’s type could not be determined. (Doesn't occur in the data as of January 2016).", + "The proxy operates through the use of an Internet web browser. Users navigate to the web proxy website, enter the URL of the site they actually wish to visit, and the contents of the requested URL are returned by the web proxy website within the browser.", + "Privacy proxies are IPs leveraged by Privacy Proxy Service Providers to add additional privacy protections for end users. End user traffic is proxied through an IP, masking the end user's IP. Users do not have the ability to control the IP their traffic is proxied through or change the country from which their IP is originating. However, user traffic may be generalized to a different postal code, city, state, or region. An example for a privacy proxy is Apple Private Relay." + ], + "type": "string" } }, "type": "object" }, - "Operation": { - "description": "This resource represents a long-running operation that is the result of a network API call.", - "id": "Operation", + "PushItem": { + "description": "Represents an item to be pushed to the indexing queue.", + "id": "PushItem", "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" + "contentHash": { + "description": "Content hash of the item according to the repository. If specified, this is used to determine how to modify this item's status. Setting this field and the type field results in argument error. The maximum length is 2048 characters.", + "type": "string" }, - "error": { - "$ref": "Status", - "description": "The error result of the operation in case of failure or cancellation." + "metadataHash": { + "description": "The metadata hash of the item according to the repository. If specified, this is used to determine how to modify this item's status. Setting this field and the type field results in argument error. The maximum length is 2048 characters.", + "type": "string" }, - "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" + "payload": { + "description": "Provides additional document state information for the connector, such as an alternate repository ID and other metadata. The maximum length is 8192 bytes.", + "format": "byte", + "type": "string" }, - "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}`.", + "queue": { + "description": "Queue to which this item belongs. The `default` queue is chosen if this field is not specified. The maximum length is 512 characters.", "type": "string" }, - "response": { - "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`.", - "type": "object" + "repositoryError": { + "$ref": "RepositoryError", + "description": "Populate this field to store Connector or repository error details. This information is displayed in the Admin Console. This field may only be populated when the Type is REPOSITORY_ERROR." + }, + "structuredDataHash": { + "description": "Structured data hash of the item according to the repository. If specified, this is used to determine how to modify this item's status. Setting this field and the type field results in argument error. The maximum length is 2048 characters.", + "type": "string" + }, + "type": { + "description": "The type of the push operation that defines the push behavior.", + "enum": [ + "UNSPECIFIED", + "MODIFIED", + "NOT_MODIFIED", + "REPOSITORY_ERROR", + "REQUEUE" + ], + "enumDescriptions": [ + "Default UNSPECIFIED. Specifies that the push operation should not modify ItemStatus", + "Indicates that the repository document has been modified or updated since the previous update call. This changes status to MODIFIED state for an existing item. If this is called on a non existing item, the status is changed to NEW_ITEM.", + "Item in the repository has not been modified since the last update call. This push operation will set status to ACCEPTED state.", + "Connector is facing a repository error regarding this item. Change status to REPOSITORY_ERROR state. Item is unreserved and rescheduled at a future time determined by exponential backoff.", + "Call push with REQUEUE only for items that have been reserved. This action unreserves the item and resets its available time to the wall clock time." + ], + "type": "string" } }, "type": "object" }, - "PeoplePromotionCard": { - "id": "PeoplePromotionCard", + "PushItemRequest": { + "id": "PushItemRequest", "properties": { - "people": { - "items": { - "$ref": "PersonCore" - }, - "type": "array" + "connectorName": { + "description": "The name of connector making this call. Format: datasources/{source_id}/connectors/{ID}", + "type": "string" + }, + "debugOptions": { + "$ref": "DebugOptions", + "description": "Common debug options." + }, + "item": { + "$ref": "PushItem", + "description": "Item to push onto the queue." } }, "type": "object" }, - "PeopleSuggestion": { - "description": "This field contains information about the person being suggested.", - "id": "PeopleSuggestion", + "QueryActivity": { + "description": "Details about a user's query activity.", + "id": "QueryActivity", "properties": { - "person": { - "$ref": "Person", - "description": "Suggested person. All fields of the person object might not be populated." + "query": { + "description": "User input query to be logged/removed.", + "type": "string" } }, "type": "object" }, - "Person": { - "description": "Object to represent a person.", - "id": "Person", + "QueryBiasingContext": { + "deprecated": true, + "description": "The message encapsulates the relevant query biasing contexts from a particular client, e.g. an individual Mini-App or an individual Mini-App page. Next id: 3", + "id": "QueryBiasingContext", "properties": { - "emailAddresses": { - "description": "The person's email addresses", - "items": { - "$ref": "EmailAddress" - }, - "type": "array" - }, - "name": { - "description": "The resource name of the person to provide information about. See [`People.get`](https://developers.google.com/people/api/rest/v1/people/get) from the Google People API.", - "type": "string" - }, - "obfuscatedId": { - "description": "Obfuscated ID of a person.", - "type": "string" - }, - "personNames": { - "description": "The person's name", - "items": { - "$ref": "Name" - }, - "type": "array" - }, - "phoneNumbers": { - "description": "The person's phone numbers", - "items": { - "$ref": "PhoneNumber" - }, - "type": "array" + "mode": { + "description": "Specifies the mode to bias the queries from the client into. The mode value should be coming from the Mode enum.", + "format": "int32", + "type": "integer" }, - "photos": { - "description": "A person's read-only photo. A picture shown next to the person's name to help others recognize the person in search results.", + "prominentEntity": { "items": { - "$ref": "Photo" + "$ref": "ProminentEntity" }, "type": "array" } }, "type": "object" }, - "PersonCore": { - "description": "Information for rendering a person. NEXT ID: 37", - "id": "PersonCore", + "QueryCountByStatus": { + "id": "QueryCountByStatus", "properties": { - "addressMeAs": { - "description": "Instructions for how to address this person (e.g. custom pronouns). For google.com this is a set of pronouns from a defined list of options.", + "count": { + "format": "int64", "type": "string" }, - "adminTo": { - "description": "People the profile owner is an admin to. Note that not all fields of these PersonCores will be set, in particular, relationships will be empty.", - "items": { - "$ref": "PersonCore" - }, - "type": "array" - }, - "admins": { - "description": "The profile owner's admins in no particular order. Note that not all fields of these PersonCores will be set, in particular, relationships will be empty.", - "items": { - "$ref": "PersonCore" - }, - "type": "array" - }, - "availabilityStatus": { + "statusCode": { + "description": "This represents the http status code.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "QueryInterpretation": { + "id": "QueryInterpretation", + "properties": { + "interpretationType": { "enum": [ - "UNKNOWN", - "OUT_OF_OFFICE", - "OUTSIDE_WORKING_HOURS", - "AVAILABLE" + "NONE", + "BLEND", + "REPLACE" ], "enumDescriptions": [ - "", - "", - "", - "" + "Neither the natural language interpretation, nor a broader version of the query is used to fetch the search results.", + "The results from original query are blended with other results. The reason for blending these other results with the results from original query is populated in the 'Reason' field below.", + "The results from original query are replaced. The reason for replacing the results from original query is populated in the 'Reason' field below." ], "type": "string" }, - "birthday": { - "$ref": "Date", - "description": "Person birthday." - }, - "calendarUrl": { - "$ref": "SafeUrlProto", - "description": "The URL to open the profile owner's primary calendar." - }, - "chatUrl": { - "$ref": "SafeUrlProto", - "description": "The URL to start a chat conversation with the profile owner. For google.com this is a Hangouts URL." - }, - "costCenter": { - "description": "Person's cost center as a string, e.g. \"926: Googler Apps\".", - "type": "string" - }, - "department": { - "description": "The person's Organization department, e.g. \"People Operations\". For google.com this is usually called \"area\".", - "type": "string" - }, - "directReports": { - "description": "A subset of the profile owner's direct reports. The number of entities here may be less than total_direct_reports_count, because typically ProfileResponse does not include all the person's reports, if there are too many to retrieve efficiently. Note that not all fields of these PersonCores will be set, in particular, relationships will be empty.", - "items": { - "$ref": "PersonCore" - }, - "type": "array" - }, - "dottedLineManagers": { - "description": "The profile owner's direct dotted line managers in no particular order. Note that not all fields of these PersonCores will be set, in particular, relationships will be empty.", - "items": { - "$ref": "PersonCore" - }, - "type": "array" - }, - "dottedLineReports": { - "description": "A subset of the profile owner's dotted-line reports. The number of entities here may be less than total_dlr_count. Note that not all fields of these PersonCores will be set, in particular, relationships will be empty.", - "items": { - "$ref": "PersonCore" - }, - "type": "array" - }, - "emails": { - "description": "E-mail addresses of the person. The primary or preferred email should be first.", - "items": { - "type": "string" - }, - "type": "array" - }, - "employeeId": { - "description": "Person's employee number (external ID of type \"organization\") For google.com this is the badge number (e.g. 2 for Larry Page).", - "type": "string" - }, - "fingerprint": { - "description": "A fingerprint used by PAPI to reliably determine if a resource has changed Externally it is used as part of the etag.", + "interpretedQuery": { + "description": "The interpretation of the query used in search. For example, queries with natural language intent like \"email from john\" will be interpreted as \"from:john source:mail\". This field will not be filled when the reason is NOT_ENOUGH_RESULTS_FOUND_FOR_USER_QUERY.", "type": "string" }, - "ftePermille": { - "description": "Full-time equivalent (in ‰) (e.g. 800 for a person who's working 80%).", - "format": "int64", + "reason": { + "description": "The reason for interpretation of the query. This field will not be UNSPECIFIED if the interpretation type is not NONE.", + "enum": [ + "UNSPECIFIED", + "QUERY_HAS_NATURAL_LANGUAGE_INTENT", + "NOT_ENOUGH_RESULTS_FOUND_FOR_USER_QUERY" + ], + "enumDescriptions": [ + "", + "Natural language interpretation of the query is used to fetch the search results.", + "Query and document terms similarity is used to selectively broaden the query to retrieve additional search results since enough results were not found for the user query. Interpreted query will be empty for this case." + ], "type": "string" + } + }, + "type": "object" + }, + "QueryInterpretationConfig": { + "description": "Default options to interpret user query.", + "id": "QueryInterpretationConfig", + "properties": { + "forceDisableSupplementalResults": { + "description": "Set this flag to disable supplemental results retrieval, setting a flag here will not retrieve supplemental results for queries associated with a given search application. If this flag is set to True, it will take precedence over the option set at Query level. For the default value of False, query level flag will set the correct interpretation for supplemental results.", + "type": "boolean" }, - "geoLocation": { - "$ref": "MapInfo" + "forceVerbatimMode": { + "description": "Enable this flag to turn off all internal optimizations like natural language (NL) interpretation of queries, supplemental results retrieval, and usage of synonyms including custom ones. If this flag is set to True, it will take precedence over the option set at Query level. For the default value of False, query level flag will set the correct interpretation for verbatim mode.", + "type": "boolean" + } + }, + "type": "object" + }, + "QueryInterpretationOptions": { + "description": "Options to interpret user query.", + "id": "QueryInterpretationOptions", + "properties": { + "disableNlInterpretation": { + "description": "Flag to disable natural language (NL) interpretation of queries. Default is false, Set to true to disable natural language interpretation. NL interpretation only applies to predefined datasources.", + "type": "boolean" }, - "gmailUrl": { - "type": "string" + "disableSupplementalResults": { + "description": "Use this flag to disable supplemental results for a query. Supplemental results setting chosen at SearchApplication level will take precedence if set to True.", + "type": "boolean" }, - "jobTitle": { - "description": "Profile owner's job title (e.g. \"Software Engineer\"). For google.com this is the Workday preferred job title.", + "enableVerbatimMode": { + "description": "Enable this flag to turn off all internal optimizations like natural language (NL) interpretation of queries, supplemental result retrieval, and usage of synonyms including custom ones. Nl interpretation will be disabled if either one of the two flags is true.", + "type": "boolean" + } + }, + "type": "object" + }, + "QueryItem": { + "description": "Information relevant only to a query entry.", + "id": "QueryItem", + "properties": { + "isSynthetic": { + "description": "True if the text was generated by means other than a previous user search.", + "type": "boolean" + } + }, + "type": "object" + }, + "QueryOperator": { + "description": "The definition of a operator that can be used in a Search/Suggest request.", + "id": "QueryOperator", + "properties": { + "displayName": { + "description": "Display name of the operator", "type": "string" }, - "keywordTypes": { - "description": "List of keys to use from the map 'keywords'.", + "enumValues": { + "description": "Potential list of values for the opeatror field. This field is only filled when we can safely enumerate all the possible values of this operator.", "items": { "type": "string" }, "type": "array" }, - "keywords": { - "additionalProperties": { - "type": "string" - }, - "description": "Custom keywords the domain admin has added.", - "type": "object" - }, - "links": { - "description": "Custom links the profile owner has added.", - "items": { - "$ref": "EnterpriseTopazFrontendTeamsLink" - }, - "type": "array" - }, - "location": { - "description": "Detailed desk location within the company. For google.com this is the desk location code (e.g. \"DE-MUC-ARP-6T2-6T2C0C\") if the person has a desk.", - "type": "string" - }, - "managers": { - "description": "The profile owner's management chain from top to bottom, where managers[0] is the CEO, manager[N-2] is the person's manager's manager and managers[N-1] is the person's direct manager. Note that not all fields of these PersonCores will be set, in particular, relationships will be empty.", - "items": { - "$ref": "PersonCore" - }, - "type": "array" - }, - "mission": { - "description": "Custom mission statement the profile owner has added.", - "type": "string" - }, - "name": { - "description": "Human-readable Unicode display name.", - "type": "string" - }, - "officeLocation": { - "description": "Office/building identifier within the company. For google.com this is the office code (e.g. \"DE-MUC-ARP\").", - "type": "string" - }, - "personId": { - "description": "The person's obfuscated Gaia ID.", + "greaterThanOperatorName": { + "description": "Indicates the operator name that can be used to isolate the property using the greater-than operator.", "type": "string" }, - "phoneNumbers": { - "items": { - "$ref": "EnterpriseTopazFrontendTeamsPersonCorePhoneNumber" - }, - "type": "array" + "isFacetable": { + "description": "Can this operator be used to get facets.", + "type": "boolean" }, - "photoUrl": { - "$ref": "SafeUrlProto", - "description": "Person photo." + "isRepeatable": { + "description": "Indicates if multiple values can be set for this property.", + "type": "boolean" }, - "postalAddress": { - "description": "Postal address of office/building.", - "type": "string" + "isReturnable": { + "description": "Will the property associated with this facet be returned as part of search results.", + "type": "boolean" }, - "totalDirectReportsCount": { - "description": "Total count of the profile owner's direct reports.", - "format": "int32", - "type": "integer" + "isSortable": { + "description": "Can this operator be used to sort results.", + "type": "boolean" }, - "totalDlrCount": { - "description": "Total count of the profile owner's dotted-line reports.", - "format": "int32", - "type": "integer" + "isSuggestable": { + "description": "Can get suggestions for this field.", + "type": "boolean" }, - "totalFteCount": { - "description": "The sum of all profile owner's reports and their own full-time-equivalents in ‰ (e.g. 1800 if one report is working 80% and profile owner 100%).", - "format": "int64", + "lessThanOperatorName": { + "description": "Indicates the operator name that can be used to isolate the property using the less-than operator.", "type": "string" }, - "username": { - "description": "External ID of type \"login_id\" for the profile. For google.com this is the username/LDAP.", + "objectType": { + "description": "The name of the object corresponding to the operator. This field is only filled for schema-specific operators, and is unset for common operators.", "type": "string" }, - "waldoComeBackTime": { - "format": "google-datetime", - "type": "string" - } - }, - "type": "object" - }, - "PhoneNumber": { - "description": "A person's Phone Number", - "id": "PhoneNumber", - "properties": { - "phoneNumber": { - "description": "The phone number of the person.", + "operatorName": { + "description": "The name of the operator.", "type": "string" }, "type": { + "description": "The type of the operator.", "enum": [ - "OTHER", - "MOBILE", - "OFFICE" + "UNKNOWN", + "INTEGER", + "DOUBLE", + "TIMESTAMP", + "BOOLEAN", + "ENUM", + "DATE", + "TEXT", + "HTML" ], "enumDescriptions": [ + "Invalid value.", + "", + "", + "", + "", + "", "", "", "" @@ -6324,774 +20703,773 @@ }, "type": "object" }, - "Photo": { - "description": "A person's photo.", - "id": "Photo", - "properties": { - "url": { - "description": "The URL of the photo.", - "type": "string" - } - }, - "type": "object" - }, - "PollItemsRequest": { - "id": "PollItemsRequest", + "QuerySource": { + "description": "List of sources that the user can search using the query API.", + "id": "QuerySource", "properties": { - "connectorName": { - "description": "The name of connector making this call. Format: datasources/{source_id}/connectors/{ID}", - "type": "string" - }, - "debugOptions": { - "$ref": "DebugOptions", - "description": "Common debug options." - }, - "limit": { - "description": "Maximum number of items to return. The maximum value is 100 and the default value is 20.", - "format": "int32", - "type": "integer" - }, - "queue": { - "description": "Queue name to fetch items from. If unspecified, PollItems will fetch from 'default' queue. The maximum length is 100 characters.", + "displayName": { + "description": "Display name of the data source.", "type": "string" }, - "statusCodes": { - "description": "Limit the items polled to the ones with these statuses.", + "operators": { + "description": "List of all operators applicable for this source.", "items": { - "enum": [ - "CODE_UNSPECIFIED", - "ERROR", - "MODIFIED", - "NEW_ITEM", - "ACCEPTED" - ], - "enumDescriptions": [ - "Input-only value. Used with Items.list to list all items in the queue, regardless of status.", - "Error encountered by Cloud Search while processing this item. Details of the error are in repositoryError.", - "Item has been modified in the repository, and is out of date with the version previously accepted into Cloud Search.", - "Item is known to exist in the repository, but is not yet accepted by Cloud Search. An item can be in this state when Items.push has been called for an item of this name that did not exist previously.", - "API has accepted the up-to-date data of this item." - ], - "type": "string" + "$ref": "QueryOperator" }, "type": "array" + }, + "shortName": { + "description": "A short name or alias for the source. This value can be used with the 'source' operator.", + "type": "string" + }, + "source": { + "$ref": "Source", + "description": "The name of the source" } }, "type": "object" }, - "PollItemsResponse": { - "id": "PollItemsResponse", - "properties": { - "items": { - "description": "Set of items from the queue available for connector to process. These items have the following subset of fields populated: version metadata.hash structured_data.hash content.hash payload status queue", - "items": { - "$ref": "Item" - }, - "type": "array" - } - }, + "QuerySuggestion": { + "description": "This field does not contain anything as of now and is just used as an indicator that the suggest result was a phrase completion.", + "id": "QuerySuggestion", + "properties": {}, "type": "object" }, - "Principal": { - "description": "Reference to a user, group, or domain.", - "id": "Principal", + "RemoveActivityRequest": { + "description": "Remove Logged Activity Request.", + "id": "RemoveActivityRequest", "properties": { - "groupResourceName": { - "description": "This principal is a group identified using an external identity. The name field must specify the group resource name with this format: identitysources/{source_id}/groups/{ID}", - "type": "string" - }, - "gsuitePrincipal": { - "$ref": "GSuitePrincipal", - "description": "This principal is a Google Workspace user, group or domain." + "requestOptions": { + "$ref": "RequestOptions", + "description": "Request options, such as the search application and clientId." }, - "userResourceName": { - "description": "This principal is a user identified using an external identity. The name field must specify the user resource name with this format: identitysources/{source_id}/users/{ID}", - "type": "string" + "userActivity": { + "$ref": "UserActivity", + "description": "User Activity containing the data to be deleted." } }, "type": "object" }, - "ProcessingError": { - "id": "ProcessingError", - "properties": { - "code": { - "description": "Error code indicating the nature of the error.", - "enum": [ - "PROCESSING_ERROR_CODE_UNSPECIFIED", - "MALFORMED_REQUEST", - "UNSUPPORTED_CONTENT_FORMAT", - "INDIRECT_BROKEN_ACL", - "ACL_CYCLE" - ], - "enumDescriptions": [ - "Input only value. Use this value in Items.", - "Item's ACL, metadata, or content is malformed or in invalid state. FieldViolations contains more details on where the problem is.", - "Countent format is unsupported.", - "Items with incomplete ACL information due to inheriting other items with broken ACL or having groups with unmapped descendants.", - "ACL inheritance graph formed a cycle." - ], - "type": "string" - }, - "errorMessage": { - "description": "The description of the error.", - "type": "string" - }, - "fieldViolations": { - "description": "In case the item fields are invalid, this field contains the details about the validation errors.", - "items": { - "$ref": "FieldViolation" - }, - "type": "array" - } - }, + "RemoveActivityResponse": { + "description": "Remove Logged Activity Response. will return an empty response for now. Will be revisited in later phases.", + "id": "RemoveActivityResponse", + "properties": {}, "type": "object" }, - "PropertyDefinition": { - "description": "The definition of a property within an object.", - "id": "PropertyDefinition", + "RepositoryError": { + "description": "Errors when the connector is communicating to the source repository.", + "id": "RepositoryError", "properties": { - "booleanPropertyOptions": { - "$ref": "BooleanPropertyOptions" - }, - "datePropertyOptions": { - "$ref": "DatePropertyOptions" - }, - "displayOptions": { - "$ref": "PropertyDisplayOptions", - "description": "The options that determine how the property is displayed in the Cloud Search results page if it's specified to be displayed in the object's display options." - }, - "doublePropertyOptions": { - "$ref": "DoublePropertyOptions" - }, - "enumPropertyOptions": { - "$ref": "EnumPropertyOptions" - }, - "htmlPropertyOptions": { - "$ref": "HtmlPropertyOptions" - }, - "integerPropertyOptions": { - "$ref": "IntegerPropertyOptions" - }, - "isFacetable": { - "description": "Indicates that the property can be used for generating facets. Cannot be true for properties whose type is object. IsReturnable must be true to set this option. Only supported for boolean, enum, integer, and text properties.", - "type": "boolean" - }, - "isRepeatable": { - "description": "Indicates that multiple values are allowed for the property. For example, a document only has one description but can have multiple comments. Cannot be true for properties whose type is a boolean. If set to false, properties that contain more than one value cause the indexing request for that item to be rejected.", - "type": "boolean" - }, - "isReturnable": { - "description": "Indicates that the property identifies data that should be returned in search results via the Query API. If set to *true*, indicates that Query API users can use matching property fields in results. However, storing fields requires more space allocation and uses more bandwidth for search queries, which impacts performance over large datasets. Set to *true* here only if the field is needed for search results. Cannot be true for properties whose type is an object.", - "type": "boolean" - }, - "isSortable": { - "description": "Indicates that the property can be used for sorting. Cannot be true for properties that are repeatable. Cannot be true for properties whose type is object. IsReturnable must be true to set this option. Only supported for boolean, date, double, integer, and timestamp properties.", - "type": "boolean" - }, - "isSuggestable": { - "description": "Indicates that the property can be used for generating query suggestions.", - "type": "boolean" + "errorMessage": { + "description": "Message that describes the error. The maximum allowable length of the message is 8192 characters.", + "type": "string" }, - "isWildcardSearchable": { - "description": "Indicates that users can perform wildcard search for this property. Only supported for Text properties. IsReturnable must be true to set this option. In a given datasource maximum of 5 properties can be marked as is_wildcard_searchable. For more details, see [Define object properties](https://developers.google.com/cloud-search/docs/guides/schema-guide#properties)", - "type": "boolean" + "httpStatusCode": { + "description": "Error codes. Matches the definition of HTTP status codes.", + "format": "int32", + "type": "integer" }, - "name": { - "description": "The name of the property. Item indexing requests sent to the Indexing API should set the property name equal to this value. For example, if name is *subject_line*, then indexing requests for document items with subject fields should set the name for that field equal to *subject_line*. Use the name as the identifier for the object property. Once registered as a property for an object, you cannot re-use this name for another property within that object. The name must start with a letter and can only contain letters (A-Z, a-z) or numbers (0-9). The maximum length is 256 characters.", + "type": { + "description": "The type of error.", + "enum": [ + "UNKNOWN", + "NETWORK_ERROR", + "DNS_ERROR", + "CONNECTION_ERROR", + "AUTHENTICATION_ERROR", + "AUTHORIZATION_ERROR", + "SERVER_ERROR", + "QUOTA_EXCEEDED", + "SERVICE_UNAVAILABLE", + "CLIENT_ERROR" + ], + "enumDescriptions": [ + "Unknown error.", + "Unknown or unreachable host.", + "DNS problem, such as the DNS server is not responding.", + "Cannot connect to the repository server.", + "Failed authentication due to incorrect credentials.", + "Service account is not authorized for the repository.", + "Repository server error.", + "Quota exceeded.", + "Server temporarily unavailable.", + "Client-related error, such as an invalid request from the connector to the repository server." + ], "type": "string" + } + }, + "type": "object" + }, + "RequestOptions": { + "description": "Shared request options for all RPC methods.", + "id": "RequestOptions", + "properties": { + "debugOptions": { + "$ref": "DebugOptions", + "description": "Debug options of the request" }, - "objectPropertyOptions": { - "$ref": "ObjectPropertyOptions" + "languageCode": { + "description": "The BCP-47 language code, such as \"en-US\" or \"sr-Latn\". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. For translations. Set this field using the language set in browser or for the page. In the event that the user's language preference is known, set this field to the known user language. When specified, the documents in search results are biased towards the specified language. The Suggest API uses this field as a hint to make better third-party autocomplete predictions.", + "type": "string" }, - "textPropertyOptions": { - "$ref": "TextPropertyOptions" + "searchApplicationId": { + "description": "The ID generated when you create a search application using the [admin console](https://support.google.com/a/answer/9043922).", + "type": "string" }, - "timestampPropertyOptions": { - "$ref": "TimestampPropertyOptions" + "timeZone": { + "description": "Current user's time zone id, such as \"America/Los_Angeles\" or \"Australia/Sydney\". These IDs are defined by [Unicode Common Locale Data Repository (CLDR)](http://cldr.unicode.org/) project, and currently available in the file [timezone.xml](http://unicode.org/repos/cldr/trunk/common/bcp47/timezone.xml). This field is used to correctly interpret date and time queries. If this field is not specified, the default time zone (UTC) is used.", + "type": "string" } }, "type": "object" }, - "PropertyDisplayOptions": { - "description": "The display options for a property.", - "id": "PropertyDisplayOptions", + "ResetSearchApplicationRequest": { + "id": "ResetSearchApplicationRequest", "properties": { - "displayLabel": { - "description": "The user friendly label for the property that is used if the property is specified to be displayed in ObjectDisplayOptions. If provided, the display label is shown in front of the property values when the property is part of the object display options. For example, if the property value is '1', the value by itself may not be useful context for the user. If the display name given was 'priority', then the user sees 'priority : 1' in the search results which provides clear context to search users. This is OPTIONAL; if not given, only the property values are displayed. The maximum length is 64 characters.", - "type": "string" + "debugOptions": { + "$ref": "DebugOptions", + "description": "Common debug options." } }, "type": "object" }, - "PushItem": { - "description": "Represents an item to be pushed to the indexing queue.", - "id": "PushItem", + "ResponseDebugInfo": { + "description": "Debugging information about the response.", + "id": "ResponseDebugInfo", "properties": { - "contentHash": { - "description": "Content hash of the item according to the repository. If specified, this is used to determine how to modify this item's status. Setting this field and the type field results in argument error. The maximum length is 2048 characters.", - "type": "string" - }, - "metadataHash": { - "description": "The metadata hash of the item according to the repository. If specified, this is used to determine how to modify this item's status. Setting this field and the type field results in argument error. The maximum length is 2048 characters.", + "formattedDebugInfo": { + "description": "General debug info formatted for display.", "type": "string" + } + }, + "type": "object" + }, + "RestrictItem": { + "description": "Information relevant only to a restrict entry. NextId: 12", + "id": "RestrictItem", + "properties": { + "driveFollowUpRestrict": { + "$ref": "DriveFollowUpRestrict" }, - "payload": { - "description": "Provides additional document state information for the connector, such as an alternate repository ID and other metadata. The maximum length is 8192 bytes.", - "format": "byte", - "type": "string" + "driveLocationRestrict": { + "$ref": "DriveLocationRestrict" }, - "queue": { - "description": "Queue to which this item belongs. The `default` queue is chosen if this field is not specified. The maximum length is 512 characters.", - "type": "string" + "driveMimeTypeRestrict": { + "$ref": "DriveMimeTypeRestrict", + "description": "Drive Types." }, - "repositoryError": { - "$ref": "RepositoryError", - "description": "Populate this field to store Connector or repository error details. This information is displayed in the Admin Console. This field may only be populated when the Type is REPOSITORY_ERROR." + "driveTimeSpanRestrict": { + "$ref": "DriveTimeSpanRestrict" }, - "structuredDataHash": { - "description": "Structured data hash of the item according to the repository. If specified, this is used to determine how to modify this item's status. Setting this field and the type field results in argument error. The maximum length is 2048 characters.", + "searchOperator": { + "description": "The search restrict (e.g. \"after:2017-09-11 before:2017-09-12\").", "type": "string" - }, - "type": { - "description": "The type of the push operation that defines the push behavior.", - "enum": [ - "UNSPECIFIED", - "MODIFIED", - "NOT_MODIFIED", - "REPOSITORY_ERROR", - "REQUEUE" - ], - "enumDescriptions": [ - "Default UNSPECIFIED. Specifies that the push operation should not modify ItemStatus", - "Indicates that the repository document has been modified or updated since the previous update call. This changes status to MODIFIED state for an existing item. If this is called on a non existing item, the status is changed to NEW_ITEM.", - "Item in the repository has not been modified since the last update call. This push operation will set status to ACCEPTED state.", - "Connector is facing a repository error regarding this item. Change status to REPOSITORY_ERROR state. Item is unreserved and rescheduled at a future time determined by exponential backoff.", - "Call push with REQUEUE only for items that have been reserved. This action unreserves the item and resets its available time to the wall clock time." - ], + } + }, + "type": "object" + }, + "ResultCounts": { + "description": "Result count information", + "id": "ResultCounts", + "properties": { + "sourceResultCounts": { + "description": "Result count information for each source with results.", + "items": { + "$ref": "SourceResultCount" + }, + "type": "array" + } + }, + "type": "object" + }, + "ResultDebugInfo": { + "description": "Debugging information about the result.", + "id": "ResultDebugInfo", + "properties": { + "formattedDebugInfo": { + "description": "General debug info formatted for display.", "type": "string" } }, "type": "object" }, - "PushItemRequest": { - "id": "PushItemRequest", + "ResultDisplayField": { + "description": "Display Fields for Search Results", + "id": "ResultDisplayField", "properties": { - "connectorName": { - "description": "The name of connector making this call. Format: datasources/{source_id}/connectors/{ID}", + "label": { + "description": "The display label for the property.", "type": "string" }, - "debugOptions": { - "$ref": "DebugOptions", - "description": "Common debug options." + "operatorName": { + "description": "The operator name of the property.", + "type": "string" }, - "item": { - "$ref": "PushItem", - "description": "Item to push onto the queue." + "property": { + "$ref": "NamedProperty", + "description": "The name value pair for the property." } }, "type": "object" }, - "QueryActivity": { - "description": "Details about a user's query activity.", - "id": "QueryActivity", + "ResultDisplayLine": { + "description": "The collection of fields that make up a displayed line", + "id": "ResultDisplayLine", "properties": { - "query": { - "description": "User input query to be logged/removed.", - "type": "string" + "fields": { + "items": { + "$ref": "ResultDisplayField" + }, + "type": "array" } }, "type": "object" }, - "QueryCountByStatus": { - "id": "QueryCountByStatus", + "ResultDisplayMetadata": { + "id": "ResultDisplayMetadata", "properties": { - "count": { - "format": "int64", - "type": "string" + "metalines": { + "description": "The metalines content to be displayed with the result.", + "items": { + "$ref": "ResultDisplayLine" + }, + "type": "array" }, - "statusCode": { - "description": "This represents the http status code.", - "format": "int32", - "type": "integer" + "objectTypeLabel": { + "description": "The display label for the object.", + "type": "string" } }, "type": "object" }, - "QueryInterpretation": { - "id": "QueryInterpretation", + "RetrievalImportance": { + "id": "RetrievalImportance", "properties": { - "interpretationType": { + "importance": { + "description": "Indicates the ranking importance given to property when it is matched during retrieval. Once set, the token importance of a property cannot be changed.", "enum": [ - "NONE", - "BLEND", - "REPLACE" + "DEFAULT", + "HIGHEST", + "HIGH", + "LOW", + "NONE" ], "enumDescriptions": [ - "Neither the natural language interpretation, nor a broader version of the query is used to fetch the search results.", - "The results from original query are blended with other results. The reason for blending these other results with the results from original query is populated in the 'Reason' field below.", - "The results from original query are replaced. The reason for replacing the results from original query is populated in the 'Reason' field below." + "Treat the match like a body text match.", + "Treat the match like a match against title of the item.", + "Treat the match with higher importance than body text.", + "Treat the match with lower importance than body text.", + "Do not match against this field during retrieval. The property can still be used for operator matching, faceting, and suggest if desired." ], "type": "string" + } + }, + "type": "object" + }, + "RewrittenQueries": { + "description": "The rewritten queries returned by Apps Search Query Understanding service.", + "id": "RewrittenQueries", + "properties": { + "rewrittenQueries": { + "items": { + "$ref": "RewrittenQuery" + }, + "type": "array" }, - "interpretedQuery": { - "description": "The interpretation of the query used in search. For example, queries with natural language intent like \"email from john\" will be interpreted as \"from:john source:mail\". This field will not be filled when the reason is NOT_ENOUGH_RESULTS_FOUND_FOR_USER_QUERY.", + "selectedQueryIndex": { + "description": "The index of the selected query in `rewritten_queries` that is used by QAPI to call CSSR to get search results. If none of the queries were used (i.e. they all give empty search results), `selected_query_index` would default to -1.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "RewrittenQuery": { + "id": "RewrittenQuery", + "properties": { + "rewrittenQuery": { "type": "string" }, - "reason": { - "description": "The reason for interpretation of the query. This field will not be UNSPECIFIED if the interpretation type is not NONE.", + "score": { + "format": "double", + "type": "number" + }, + "sortBy": { "enum": [ - "UNSPECIFIED", - "QUERY_HAS_NATURAL_LANGUAGE_INTENT", - "NOT_ENOUGH_RESULTS_FOUND_FOR_USER_QUERY" + "SORTBY_UNSUPPORTED", + "SORTBY_RELEVANCY", + "SORTBY_LATEST", + "SORTBY_OLDEST", + "SORTBY_LARGEST", + "SORTBY_SMALLEST", + "SORTBY_MODIFY_LATEST", + "SORTBY_MODIFY_OLDEST", + "SORTBY_VIEW_LATEST", + "SORTBY_VIEW_OLDEST", + "SORTBY_CREATE_LATEST", + "SORTBY_CREATE_OLDEST" ], "enumDescriptions": [ "", - "Natural language interpretation of the query is used to fetch the search results.", - "Query and document terms similarity is used to selectively broaden the query to retrieve additional search results since enough results were not found for the user query. Interpreted query will be empty for this case." + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "" ], "type": "string" } }, "type": "object" }, - "QueryInterpretationConfig": { - "description": "Default options to interpret user query.", - "id": "QueryInterpretationConfig", + "SafeHtmlProto": { + "description": "IMPORTANT: It is unsafe to accept this message from an untrusted source, since it's trivial for an attacker to forge serialized messages that don't fulfill the type's safety contract -- for example, it could contain attacker controlled script. A system which receives a SafeHtmlProto implicitly trusts the producer of the SafeHtmlProto. So, it's generally safe to return this message in RPC responses, but generally unsafe to accept it in RPC requests.", + "id": "SafeHtmlProto", "properties": { - "forceDisableSupplementalResults": { - "description": "Set this flag to disable supplemental results retrieval, setting a flag here will not retrieve supplemental results for queries associated with a given search application. If this flag is set to True, it will take precedence over the option set at Query level. For the default value of False, query level flag will set the correct interpretation for supplemental results.", - "type": "boolean" - }, - "forceVerbatimMode": { - "description": "Enable this flag to turn off all internal optimizations like natural language (NL) interpretation of queries, supplemental results retrieval, and usage of synonyms including custom ones. If this flag is set to True, it will take precedence over the option set at Query level. For the default value of False, query level flag will set the correct interpretation for verbatim mode.", - "type": "boolean" + "privateDoNotAccessOrElseSafeHtmlWrappedValue": { + "description": "IMPORTANT: Never set or read this field, even from tests, it is private. See documentation at the top of .proto file for programming language packages with which to create or read this message.", + "type": "string" } }, "type": "object" }, - "QueryInterpretationOptions": { - "description": "Options to interpret user query.", - "id": "QueryInterpretationOptions", + "SafeUrlProto": { + "description": "Message containing a string that is safe to use in URL contexts in DOM APIs and HTML documents, where the URL context does not refer to a resource that loads code.", + "id": "SafeUrlProto", "properties": { - "disableNlInterpretation": { - "description": "Flag to disable natural language (NL) interpretation of queries. Default is false, Set to true to disable natural language interpretation. NL interpretation only applies to predefined datasources.", - "type": "boolean" - }, - "disableSupplementalResults": { - "description": "Use this flag to disable supplemental results for a query. Supplemental results setting chosen at SearchApplication level will take precedence if set to True.", - "type": "boolean" + "privateDoNotAccessOrElseSafeUrlWrappedValue": { + "description": "IMPORTANT: Never set or read this field, even from tests, it is private. See documentation at the top of .proto file for programming language packages with which to create or read this message.", + "type": "string" + } + }, + "type": "object" + }, + "Schema": { + "description": "The schema definition for a data source.", + "id": "Schema", + "properties": { + "objectDefinitions": { + "description": "The list of top-level objects for the data source. The maximum number of elements is 10.", + "items": { + "$ref": "ObjectDefinition" + }, + "type": "array" }, - "enableVerbatimMode": { - "description": "Enable this flag to turn off all internal optimizations like natural language (NL) interpretation of queries, supplemental result retrieval, and usage of synonyms including custom ones. Nl interpretation will be disabled if either one of the two flags is true.", - "type": "boolean" + "operationIds": { + "description": "IDs of the Long Running Operations (LROs) currently running for this schema. After modifying the schema, wait for operations to complete before indexing additional content.", + "items": { + "type": "string" + }, + "type": "array" } }, "type": "object" }, - "QueryItem": { - "description": "Information relevant only to a query entry.", - "id": "QueryItem", + "ScoringConfig": { + "description": "Scoring configurations for a source while processing a Search or Suggest request.", + "id": "ScoringConfig", "properties": { - "isSynthetic": { - "description": "True if the text was generated by means other than a previous user search.", + "disableFreshness": { + "description": "Whether to use freshness as a ranking signal. By default, freshness is used as a ranking signal. Note that this setting is not available in the Admin UI.", + "type": "boolean" + }, + "disablePersonalization": { + "description": "Whether to personalize the results. By default, personal signals will be used to boost results.", "type": "boolean" } }, "type": "object" }, - "QueryOperator": { - "description": "The definition of a operator that can be used in a Search/Suggest request.", - "id": "QueryOperator", + "SearchApplication": { + "description": "SearchApplication", + "id": "SearchApplication", "properties": { - "displayName": { - "description": "Display name of the operator", - "type": "string" + "dataSourceRestrictions": { + "description": "Retrictions applied to the configurations. The maximum number of elements is 10.", + "items": { + "$ref": "DataSourceRestriction" + }, + "type": "array" }, - "enumValues": { - "description": "Potential list of values for the opeatror field. This field is only filled when we can safely enumerate all the possible values of this operator.", + "defaultFacetOptions": { + "description": "The default fields for returning facet results. The sources specified here also have been included in data_source_restrictions above.", "items": { - "type": "string" + "$ref": "FacetOptions" }, "type": "array" }, - "greaterThanOperatorName": { - "description": "Indicates the operator name that can be used to isolate the property using the greater-than operator.", + "defaultSortOptions": { + "$ref": "SortOptions", + "description": "The default options for sorting the search results" + }, + "displayName": { + "description": "Display name of the Search Application. The maximum length is 300 characters.", "type": "string" }, - "isFacetable": { - "description": "Can this operator be used to get facets.", + "enableAuditLog": { + "description": "Indicates whether audit logging is on/off for requests made for the search application in query APIs.", "type": "boolean" }, - "isRepeatable": { - "description": "Indicates if multiple values can be set for this property.", - "type": "boolean" + "name": { + "description": "The name of the Search Application. Format: searchapplications/{application_id}.", + "type": "string" }, - "isReturnable": { - "description": "Will the property associated with this facet be returned as part of search results.", - "type": "boolean" + "operationIds": { + "description": "Output only. IDs of the Long Running Operations (LROs) currently running for this schema. Output only field.", + "items": { + "type": "string" + }, + "readOnly": true, + "type": "array" }, - "isSortable": { - "description": "Can this operator be used to sort results.", - "type": "boolean" + "queryInterpretationConfig": { + "$ref": "QueryInterpretationConfig", + "description": "The default options for query interpretation" }, - "isSuggestable": { - "description": "Can get suggestions for this field.", + "returnResultThumbnailUrls": { + "description": "With each result we should return the URI for its thumbnail (when applicable)", "type": "boolean" }, - "lessThanOperatorName": { - "description": "Indicates the operator name that can be used to isolate the property using the less-than operator.", - "type": "string" - }, - "objectType": { - "description": "The name of the object corresponding to the operator. This field is only filled for schema-specific operators, and is unset for common operators.", - "type": "string" - }, - "operatorName": { - "description": "The name of the operator.", - "type": "string" - }, - "type": { - "description": "The type of the operator.", - "enum": [ - "UNKNOWN", - "INTEGER", - "DOUBLE", - "TIMESTAMP", - "BOOLEAN", - "ENUM", - "DATE", - "TEXT", - "HTML" - ], - "enumDescriptions": [ - "Invalid value.", - "", - "", - "", - "", - "", - "", - "", - "" - ], - "type": "string" - } - }, - "type": "object" - }, - "QuerySource": { - "description": "List of sources that the user can search using the query API.", - "id": "QuerySource", - "properties": { - "displayName": { - "description": "Display name of the data source.", - "type": "string" + "scoringConfig": { + "$ref": "ScoringConfig", + "description": "Configuration for ranking results." }, - "operators": { - "description": "List of all operators applicable for this source.", + "sourceConfig": { + "description": "Configuration for a sources specified in data_source_restrictions.", "items": { - "$ref": "QueryOperator" + "$ref": "SourceConfig" }, "type": "array" - }, - "shortName": { - "description": "A short name or alias for the source. This value can be used with the 'source' operator.", - "type": "string" - }, - "source": { - "$ref": "Source", - "description": "The name of the source" } }, "type": "object" }, - "QuerySuggestion": { - "description": "This field does not contain anything as of now and is just used as an indicator that the suggest result was a phrase completion.", - "id": "QuerySuggestion", - "properties": {}, - "type": "object" - }, - "RemoveActivityRequest": { - "description": "Remove Logged Activity Request.", - "id": "RemoveActivityRequest", + "SearchApplicationQueryStats": { + "description": "Search application level query stats per date", + "id": "SearchApplicationQueryStats", "properties": { - "requestOptions": { - "$ref": "RequestOptions", - "description": "Request options, such as the search application and clientId." + "date": { + "$ref": "Date", + "description": "The date for which query stats were calculated. Stats calculated on the next day close to midnight are returned." }, - "userActivity": { - "$ref": "UserActivity", - "description": "User Activity containing the data to be deleted." + "queryCountByStatus": { + "items": { + "$ref": "QueryCountByStatus" + }, + "type": "array" } }, "type": "object" }, - "RemoveActivityResponse": { - "description": "Remove Logged Activity Response. will return an empty response for now. Will be revisited in later phases.", - "id": "RemoveActivityResponse", - "properties": {}, - "type": "object" - }, - "RepositoryError": { - "description": "Errors when the connector is communicating to the source repository.", - "id": "RepositoryError", - "properties": { - "errorMessage": { - "description": "Message that describes the error. The maximum allowable length of the message is 8192 characters.", - "type": "string" - }, - "httpStatusCode": { - "description": "Error codes. Matches the definition of HTTP status codes.", - "format": "int32", - "type": "integer" + "SearchApplicationSessionStats": { + "id": "SearchApplicationSessionStats", + "properties": { + "date": { + "$ref": "Date", + "description": "The date for which session stats were calculated. Stats are calculated on the following day, close to midnight PST, and then returned." }, - "type": { - "description": "The type of error.", - "enum": [ - "UNKNOWN", - "NETWORK_ERROR", - "DNS_ERROR", - "CONNECTION_ERROR", - "AUTHENTICATION_ERROR", - "AUTHORIZATION_ERROR", - "SERVER_ERROR", - "QUOTA_EXCEEDED", - "SERVICE_UNAVAILABLE", - "CLIENT_ERROR" - ], - "enumDescriptions": [ - "Unknown error.", - "Unknown or unreachable host.", - "DNS problem, such as the DNS server is not responding.", - "Cannot connect to the repository server.", - "Failed authentication due to incorrect credentials.", - "Service account is not authorized for the repository.", - "Repository server error.", - "Quota exceeded.", - "Server temporarily unavailable.", - "Client-related error, such as an invalid request from the connector to the repository server." - ], + "searchSessionsCount": { + "description": "The count of search sessions on the day", + "format": "int64", "type": "string" } }, "type": "object" }, - "RequestOptions": { - "description": "Shared request options for all RPC methods.", - "id": "RequestOptions", + "SearchApplicationUserStats": { + "id": "SearchApplicationUserStats", "properties": { - "debugOptions": { - "$ref": "DebugOptions", - "description": "Debug options of the request" + "date": { + "$ref": "Date", + "description": "The date for which session stats were calculated. Stats calculated on the next day close to midnight are returned." }, - "languageCode": { - "description": "The BCP-47 language code, such as \"en-US\" or \"sr-Latn\". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. For translations. Set this field using the language set in browser or for the page. In the event that the user's language preference is known, set this field to the known user language. When specified, the documents in search results are biased towards the specified language. The Suggest API uses this field as a hint to make better third-party autocomplete predictions.", + "oneDayActiveUsersCount": { + "description": "The count of unique active users in the past one day", + "format": "int64", "type": "string" }, - "searchApplicationId": { - "description": "The ID generated when you create a search application using the [admin console](https://support.google.com/a/answer/9043922).", + "sevenDaysActiveUsersCount": { + "description": "The count of unique active users in the past seven days", + "format": "int64", "type": "string" }, - "timeZone": { - "description": "Current user's time zone id, such as \"America/Los_Angeles\" or \"Australia/Sydney\". These IDs are defined by [Unicode Common Locale Data Repository (CLDR)](http://cldr.unicode.org/) project, and currently available in the file [timezone.xml](http://unicode.org/repos/cldr/trunk/common/bcp47/timezone.xml). This field is used to correctly interpret date and time queries. If this field is not specified, the default time zone (UTC) is used.", + "thirtyDaysActiveUsersCount": { + "description": "The count of unique active users in the past thirty days", + "format": "int64", "type": "string" } }, "type": "object" }, - "ResetSearchApplicationRequest": { - "id": "ResetSearchApplicationRequest", + "SearchItemsByViewUrlRequest": { + "id": "SearchItemsByViewUrlRequest", "properties": { "debugOptions": { "$ref": "DebugOptions", "description": "Common debug options." + }, + "pageToken": { + "description": "The next_page_token value returned from a previous request, if any.", + "type": "string" + }, + "viewUrl": { + "description": "Specify the full view URL to find the corresponding item. The maximum length is 2048 characters.", + "type": "string" } }, "type": "object" }, - "ResponseDebugInfo": { - "description": "Debugging information about the response.", - "id": "ResponseDebugInfo", + "SearchItemsByViewUrlResponse": { + "id": "SearchItemsByViewUrlResponse", "properties": { - "formattedDebugInfo": { - "description": "General debug info formatted for display.", + "items": { + "items": { + "$ref": "Item" + }, + "type": "array" + }, + "nextPageToken": { + "description": "Token to retrieve the next page of results, or empty if there are no more results in the list.", "type": "string" } }, "type": "object" }, - "RestrictItem": { - "description": "Information relevant only to a restrict entry. NextId: 12", - "id": "RestrictItem", + "SearchQualityMetadata": { + "description": "Additional search quality metadata of the item.", + "id": "SearchQualityMetadata", "properties": { - "driveFollowUpRestrict": { - "$ref": "DriveFollowUpRestrict" - }, - "driveLocationRestrict": { - "$ref": "DriveLocationRestrict" - }, - "driveMimeTypeRestrict": { - "$ref": "DriveMimeTypeRestrict", - "description": "Drive Types." - }, - "driveTimeSpanRestrict": { - "$ref": "DriveTimeSpanRestrict" - }, - "searchOperator": { - "description": "The search restrict (e.g. \"after:2017-09-11 before:2017-09-12\").", - "type": "string" + "quality": { + "description": "An indication of the quality of the item, used to influence search quality. Value should be between 0.0 (lowest quality) and 1.0 (highest quality). The default value is 0.0.", + "format": "double", + "type": "number" } }, "type": "object" }, - "ResultCounts": { - "description": "Result count information", - "id": "ResultCounts", + "SearchRequest": { + "description": "The search API request.", + "id": "SearchRequest", "properties": { - "sourceResultCounts": { - "description": "Result count information for each source with results.", + "contextAttributes": { + "description": "Context attributes for the request which will be used to adjust ranking of search results. The maximum number of elements is 10.", "items": { - "$ref": "SourceResultCount" + "$ref": "ContextAttribute" + }, + "type": "array" + }, + "dataSourceRestrictions": { + "description": "The sources to use for querying. If not specified, all data sources from the current search application are used.", + "items": { + "$ref": "DataSourceRestriction" + }, + "type": "array" + }, + "facetOptions": { + "items": { + "$ref": "FacetOptions" }, "type": "array" + }, + "pageSize": { + "description": "Maximum number of search results to return in one page. Valid values are between 1 and 100, inclusive. Default value is 10. Minimum value is 50 when results beyond 2000 are requested.", + "format": "int32", + "type": "integer" + }, + "query": { + "description": "The raw query string. See supported search operators in the [Narrow your search with operators](https://support.google.com/cloudsearch/answer/6172299)", + "type": "string" + }, + "queryInterpretationOptions": { + "$ref": "QueryInterpretationOptions", + "description": "Options to interpret the user query." + }, + "requestOptions": { + "$ref": "RequestOptions", + "description": "Request options, such as the search application and user timezone." + }, + "sortOptions": { + "$ref": "SortOptions", + "description": "The options for sorting the search results" + }, + "start": { + "description": "Starting index of the results.", + "format": "int32", + "type": "integer" } }, "type": "object" }, - "ResultDebugInfo": { - "description": "Debugging information about the result.", - "id": "ResultDebugInfo", + "SearchResponse": { + "description": "The search API response.", + "id": "SearchResponse", "properties": { - "formattedDebugInfo": { - "description": "General debug info formatted for display.", + "debugInfo": { + "$ref": "ResponseDebugInfo", + "description": "Debugging information about the response." + }, + "errorInfo": { + "$ref": "ErrorInfo", + "description": "Error information about the response." + }, + "facetResults": { + "description": "Repeated facet results.", + "items": { + "$ref": "FacetResult" + }, + "type": "array" + }, + "hasMoreResults": { + "description": "Whether there are more search results matching the query.", + "type": "boolean" + }, + "queryInterpretation": { + "$ref": "QueryInterpretation", + "description": "Query interpretation result for user query. Empty if query interpretation is disabled." + }, + "resultCountEstimate": { + "description": "The estimated result count for this query.", + "format": "int64", + "type": "string" + }, + "resultCountExact": { + "description": "The exact result count for this query.", + "format": "int64", "type": "string" + }, + "resultCounts": { + "$ref": "ResultCounts", + "description": "Expanded result count information." + }, + "results": { + "description": "Results from a search query.", + "items": { + "$ref": "SearchResult" + }, + "type": "array" + }, + "spellResults": { + "description": "Suggested spelling for the query.", + "items": { + "$ref": "SpellResult" + }, + "type": "array" + }, + "structuredResults": { + "description": "Structured results for the user query. These results are not counted against the page_size.", + "items": { + "$ref": "StructuredResult" + }, + "type": "array" } }, "type": "object" }, - "ResultDisplayField": { - "description": "Display Fields for Search Results", - "id": "ResultDisplayField", + "SearchResult": { + "description": "Results containing indexed information for a document.", + "id": "SearchResult", "properties": { - "label": { - "description": "The display label for the property.", + "clusteredResults": { + "description": "If source is clustered, provide list of clustered results. There will only be one level of clustered results. If current source is not enabled for clustering, this field will be empty.", + "items": { + "$ref": "SearchResult" + }, + "type": "array" + }, + "debugInfo": { + "$ref": "ResultDebugInfo", + "description": "Debugging information about this search result." + }, + "metadata": { + "$ref": "Metadata", + "description": "Metadata of the search result." + }, + "snippet": { + "$ref": "Snippet", + "description": "The concatenation of all snippets (summaries) available for this result." + }, + "title": { + "description": "Title of the search result.", "type": "string" }, - "operatorName": { - "description": "The operator name of the property.", + "url": { + "description": "The URL of the search result. The URL contains a Google redirect to the actual item. This URL is signed and shouldn't be changed.", "type": "string" - }, - "property": { - "$ref": "NamedProperty", - "description": "The name value pair for the property." - } - }, - "type": "object" - }, - "ResultDisplayLine": { - "description": "The collection of fields that make up a displayed line", - "id": "ResultDisplayLine", - "properties": { - "fields": { - "items": { - "$ref": "ResultDisplayField" - }, - "type": "array" } }, "type": "object" }, - "ResultDisplayMetadata": { - "id": "ResultDisplayMetadata", + "Snippet": { + "description": "Snippet of the search result, which summarizes the content of the resulting page.", + "id": "Snippet", "properties": { - "metalines": { - "description": "The metalines content to be displayed with the result.", + "matchRanges": { + "description": "The matched ranges in the snippet.", "items": { - "$ref": "ResultDisplayLine" + "$ref": "MatchRange" }, "type": "array" }, - "objectTypeLabel": { - "description": "The display label for the object.", + "snippet": { + "description": "The snippet of the document. May contain escaped HTML character that should be unescaped prior to rendering.", "type": "string" } }, "type": "object" }, - "RetrievalImportance": { - "id": "RetrievalImportance", + "SortOptions": { + "id": "SortOptions", "properties": { - "importance": { - "description": "Indicates the ranking importance given to property when it is matched during retrieval. Once set, the token importance of a property cannot be changed.", + "operatorName": { + "description": "The name of the operator corresponding to the field to sort on. The corresponding property must be marked as sortable.", + "type": "string" + }, + "sortOrder": { + "description": "Ascending is the default sort order", "enum": [ - "DEFAULT", - "HIGHEST", - "HIGH", - "LOW", - "NONE" + "ASCENDING", + "DESCENDING" ], "enumDescriptions": [ - "Treat the match like a body text match.", - "Treat the match like a match against title of the item.", - "Treat the match with higher importance than body text.", - "Treat the match with lower importance than body text.", - "Do not match against this field during retrieval. The property can still be used for operator matching, faceting, and suggest if desired." + "", + "" ], "type": "string" } }, "type": "object" }, - "RewrittenQueries": { - "description": "The rewritten queries returned by Apps Search Query Understanding service.", - "id": "RewrittenQueries", - "properties": { - "rewrittenQueries": { - "items": { - "$ref": "RewrittenQuery" - }, - "type": "array" - }, - "selectedQueryIndex": { - "description": "The index of the selected query in `rewritten_queries` that is used by QAPI to call CSSR to get search results. If none of the queries were used (i.e. they all give empty search results), `selected_query_index` would default to -1.", - "format": "int32", - "type": "integer" - } - }, - "type": "object" - }, - "RewrittenQuery": { - "id": "RewrittenQuery", + "Source": { + "description": "Defines sources for the suggest/search APIs.", + "id": "Source", "properties": { - "rewrittenQuery": { + "name": { + "description": "Source name for content indexed by the Indexing API.", "type": "string" }, - "score": { - "format": "double", - "type": "number" - }, - "sortBy": { + "predefinedSource": { + "description": "Predefined content source for Google Apps.", "enum": [ - "SORTBY_UNSUPPORTED", - "SORTBY_RELEVANCY", - "SORTBY_LATEST", - "SORTBY_OLDEST", - "SORTBY_LARGEST", - "SORTBY_SMALLEST", - "SORTBY_MODIFY_LATEST", - "SORTBY_MODIFY_OLDEST", - "SORTBY_VIEW_LATEST", - "SORTBY_VIEW_OLDEST", - "SORTBY_CREATE_LATEST", - "SORTBY_CREATE_OLDEST" + "NONE", + "QUERY_HISTORY", + "PERSON", + "GOOGLE_DRIVE", + "GOOGLE_GMAIL", + "GOOGLE_SITES", + "GOOGLE_GROUPS", + "GOOGLE_CALENDAR", + "GOOGLE_KEEP" ], "enumDescriptions": [ "", - "", - "", - "", - "", - "", + "Suggests queries issued by the user in the past. Only valid when used with the suggest API. Ignored when used in the query API.", + "Suggests people in the organization. Only valid when used with the suggest API. Results in an error when used in the query API.", "", "", "", @@ -7104,415 +21482,299 @@ }, "type": "object" }, - "SafeHtmlProto": { - "description": "IMPORTANT: It is unsafe to accept this message from an untrusted source, since it's trivial for an attacker to forge serialized messages that don't fulfill the type's safety contract -- for example, it could contain attacker controlled script. A system which receives a SafeHtmlProto implicitly trusts the producer of the SafeHtmlProto. So, it's generally safe to return this message in RPC responses, but generally unsafe to accept it in RPC requests.", - "id": "SafeHtmlProto", - "properties": { - "privateDoNotAccessOrElseSafeHtmlWrappedValue": { - "description": "IMPORTANT: Never set or read this field, even from tests, it is private. See documentation at the top of .proto file for programming language packages with which to create or read this message.", - "type": "string" - } - }, - "type": "object" - }, - "SafeUrlProto": { - "description": "Message containing a string that is safe to use in URL contexts in DOM APIs and HTML documents, where the URL context does not refer to a resource that loads code.", - "id": "SafeUrlProto", - "properties": { - "privateDoNotAccessOrElseSafeUrlWrappedValue": { - "description": "IMPORTANT: Never set or read this field, even from tests, it is private. See documentation at the top of .proto file for programming language packages with which to create or read this message.", - "type": "string" - } - }, - "type": "object" - }, - "Schema": { - "description": "The schema definition for a data source.", - "id": "Schema", - "properties": { - "objectDefinitions": { - "description": "The list of top-level objects for the data source. The maximum number of elements is 10.", - "items": { - "$ref": "ObjectDefinition" - }, - "type": "array" - }, - "operationIds": { - "description": "IDs of the Long Running Operations (LROs) currently running for this schema. After modifying the schema, wait for operations to complete before indexing additional content.", - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "ScoringConfig": { - "description": "Scoring configurations for a source while processing a Search or Suggest request.", - "id": "ScoringConfig", - "properties": { - "disableFreshness": { - "description": "Whether to use freshness as a ranking signal. By default, freshness is used as a ranking signal. Note that this setting is not available in the Admin UI.", - "type": "boolean" - }, - "disablePersonalization": { - "description": "Whether to personalize the results. By default, personal signals will be used to boost results.", - "type": "boolean" - } - }, - "type": "object" - }, - "SearchApplication": { - "description": "SearchApplication", - "id": "SearchApplication", + "SourceConfig": { + "description": "Configurations for a source while processing a Search or Suggest request.", + "id": "SourceConfig", "properties": { - "dataSourceRestrictions": { - "description": "Retrictions applied to the configurations. The maximum number of elements is 10.", - "items": { - "$ref": "DataSourceRestriction" - }, - "type": "array" - }, - "defaultFacetOptions": { - "description": "The default fields for returning facet results. The sources specified here also have been included in data_source_restrictions above.", - "items": { - "$ref": "FacetOptions" - }, - "type": "array" - }, - "defaultSortOptions": { - "$ref": "SortOptions", - "description": "The default options for sorting the search results" - }, - "displayName": { - "description": "Display name of the Search Application. The maximum length is 300 characters.", - "type": "string" - }, - "enableAuditLog": { - "description": "Indicates whether audit logging is on/off for requests made for the search application in query APIs.", - "type": "boolean" - }, - "name": { - "description": "The name of the Search Application. Format: searchapplications/{application_id}.", - "type": "string" - }, - "operationIds": { - "description": "Output only. IDs of the Long Running Operations (LROs) currently running for this schema. Output only field.", - "items": { - "type": "string" - }, - "readOnly": true, - "type": "array" - }, - "queryInterpretationConfig": { - "$ref": "QueryInterpretationConfig", - "description": "The default options for query interpretation" - }, - "returnResultThumbnailUrls": { - "description": "With each result we should return the URI for its thumbnail (when applicable)", - "type": "boolean" + "crowdingConfig": { + "$ref": "SourceCrowdingConfig", + "description": "The crowding configuration for the source." }, "scoringConfig": { - "$ref": "ScoringConfig", - "description": "Configuration for ranking results." - }, - "sourceConfig": { - "description": "Configuration for a sources specified in data_source_restrictions.", - "items": { - "$ref": "SourceConfig" - }, - "type": "array" - } - }, - "type": "object" - }, - "SearchApplicationQueryStats": { - "description": "Search application level query stats per date", - "id": "SearchApplicationQueryStats", - "properties": { - "date": { - "$ref": "Date", - "description": "The date for which query stats were calculated. Stats calculated on the next day close to midnight are returned." + "$ref": "SourceScoringConfig", + "description": "The scoring configuration for the source." }, - "queryCountByStatus": { - "items": { - "$ref": "QueryCountByStatus" - }, - "type": "array" + "source": { + "$ref": "Source", + "description": "The source for which this configuration is to be used." } }, "type": "object" }, - "SearchApplicationSessionStats": { - "id": "SearchApplicationSessionStats", + "SourceCrowdingConfig": { + "description": "Set search results crowding limits. Crowding is a situation in which multiple results from the same source or host \"crowd out\" other results, diminishing the quality of search for users. To foster better search quality and source diversity in search results, you can set a condition to reduce repetitive results by source.", + "id": "SourceCrowdingConfig", "properties": { - "date": { - "$ref": "Date", - "description": "The date for which session stats were calculated. Stats are calculated on the following day, close to midnight PST, and then returned." + "numResults": { + "description": "Maximum number of results allowed from a datasource in a result page as long as results from other sources are not exhausted. Value specified must not be negative. A default value is used if this value is equal to 0. To disable crowding, set the value greater than 100.", + "format": "int32", + "type": "integer" }, - "searchSessionsCount": { - "description": "The count of search sessions on the day", - "format": "int64", - "type": "string" + "numSuggestions": { + "description": "Maximum number of suggestions allowed from a source. No limits will be set on results if this value is less than or equal to 0.", + "format": "int32", + "type": "integer" } }, "type": "object" }, - "SearchApplicationUserStats": { - "id": "SearchApplicationUserStats", + "SourceResultCount": { + "description": "Per source result count information.", + "id": "SourceResultCount", "properties": { - "date": { - "$ref": "Date", - "description": "The date for which session stats were calculated. Stats calculated on the next day close to midnight are returned." + "hasMoreResults": { + "description": "Whether there are more search results for this source.", + "type": "boolean" }, - "oneDayActiveUsersCount": { - "description": "The count of unique active users in the past one day", + "resultCountEstimate": { + "description": "The estimated result count for this source.", "format": "int64", "type": "string" }, - "sevenDaysActiveUsersCount": { - "description": "The count of unique active users in the past seven days", + "resultCountExact": { + "description": "The exact result count for this source.", "format": "int64", "type": "string" }, - "thirtyDaysActiveUsersCount": { - "description": "The count of unique active users in the past thirty days", - "format": "int64", - "type": "string" + "source": { + "$ref": "Source", + "description": "The source the result count information is associated with." } }, "type": "object" }, - "SearchItemsByViewUrlRequest": { - "id": "SearchItemsByViewUrlRequest", + "SourceScoringConfig": { + "description": "Set the scoring configuration. This allows modifying the ranking of results for a source.", + "id": "SourceScoringConfig", "properties": { - "debugOptions": { - "$ref": "DebugOptions", - "description": "Common debug options." - }, - "pageToken": { - "description": "The next_page_token value returned from a previous request, if any.", - "type": "string" - }, - "viewUrl": { - "description": "Specify the full view URL to find the corresponding item. The maximum length is 2048 characters.", + "sourceImportance": { + "description": "Importance of the source.", + "enum": [ + "DEFAULT", + "LOW", + "HIGH" + ], + "enumDescriptions": [ + "", + "", + "" + ], "type": "string" } }, "type": "object" }, - "SearchItemsByViewUrlResponse": { - "id": "SearchItemsByViewUrlResponse", + "SpellResult": { + "id": "SpellResult", "properties": { - "items": { - "items": { - "$ref": "Item" - }, - "type": "array" + "suggestedQuery": { + "description": "The suggested spelling of the query.", + "type": "string" }, - "nextPageToken": { - "description": "Token to retrieve the next page of results, or empty if there are no more results in the list.", + "suggestedQueryHtml": { + "$ref": "SafeHtmlProto", + "description": "The sanitized HTML representing the spell corrected query that can be used in the UI. This usually has language-specific tags to mark up parts of the query that are spell checked." + }, + "suggestionType": { + "description": "Suggestion triggered for the current query.", + "enum": [ + "SUGGESTION_TYPE_UNSPECIFIED", + "NON_EMPTY_RESULTS_SPELL_SUGGESTION", + "ZERO_RESULTS_FULL_PAGE_REPLACEMENT" + ], + "enumDescriptions": [ + "Default spell check type", + "Spell suggestion without any results changed. The results are still shown for the original query (which has non zero / results) with a suggestion for spelling that would have results.", + "Spell suggestion triggered when original query has no results. When the original query has no results, and spell suggestion has results we trigger results for the spell corrected query." + ], "type": "string" } }, "type": "object" }, - "SearchQualityMetadata": { - "description": "Additional search quality metadata of the item.", - "id": "SearchQualityMetadata", + "StarlightConsistency": { + "id": "StarlightConsistency", "properties": { - "quality": { - "description": "An indication of the quality of the item, used to influence search quality. Value should be between 0.0 (lowest quality) and 1.0 (highest quality). The default value is 0.0.", + "consistency": { + "$ref": "MessageSet", + "description": "Optional, data-source specific, data to help achieve consistency." + }, + "timestampSec": { + "description": "Timestamp of last write operation. By setting this value, a client requests to trigger a new fresh data acquisition if the fresh model is older than this timestamp.", "format": "double", "type": "number" } }, "type": "object" }, - "SearchRequest": { - "description": "The search API request.", - "id": "SearchRequest", + "StartUploadItemRequest": { + "description": "Start upload file request.", + "id": "StartUploadItemRequest", "properties": { - "contextAttributes": { - "description": "Context attributes for the request which will be used to adjust ranking of search results. The maximum number of elements is 10.", - "items": { - "$ref": "ContextAttribute" - }, - "type": "array" - }, - "dataSourceRestrictions": { - "description": "The sources to use for querying. If not specified, all data sources from the current search application are used.", - "items": { - "$ref": "DataSourceRestriction" - }, - "type": "array" - }, - "facetOptions": { - "items": { - "$ref": "FacetOptions" - }, - "type": "array" - }, - "pageSize": { - "description": "Maximum number of search results to return in one page. Valid values are between 1 and 100, inclusive. Default value is 10. Minimum value is 50 when results beyond 2000 are requested.", - "format": "int32", - "type": "integer" - }, - "query": { - "description": "The raw query string. See supported search operators in the [Narrow your search with operators](https://support.google.com/cloudsearch/answer/6172299)", + "connectorName": { + "description": "The name of connector making this call. Format: datasources/{source_id}/connectors/{ID}", "type": "string" }, - "queryInterpretationOptions": { - "$ref": "QueryInterpretationOptions", - "description": "Options to interpret the user query." - }, - "requestOptions": { - "$ref": "RequestOptions", - "description": "Request options, such as the search application and user timezone." - }, - "sortOptions": { - "$ref": "SortOptions", - "description": "The options for sorting the search results" - }, - "start": { - "description": "Starting index of the results.", - "format": "int32", - "type": "integer" + "debugOptions": { + "$ref": "DebugOptions", + "description": "Common debug options." } }, "type": "object" }, - "SearchResponse": { - "description": "The search API response.", - "id": "SearchResponse", + "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).", + "id": "Status", "properties": { - "debugInfo": { - "$ref": "ResponseDebugInfo", - "description": "Debugging information about the response." - }, - "errorInfo": { - "$ref": "ErrorInfo", - "description": "Error information about the response." + "code": { + "description": "The status code, which should be an enum value of google.rpc.Code.", + "format": "int32", + "type": "integer" }, - "facetResults": { - "description": "Repeated facet results.", + "details": { + "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.", "items": { - "$ref": "FacetResult" + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "type": "object" }, "type": "array" }, - "hasMoreResults": { - "description": "Whether there are more search results matching the query.", - "type": "boolean" - }, - "queryInterpretation": { - "$ref": "QueryInterpretation", - "description": "Query interpretation result for user query. Empty if query interpretation is disabled." - }, - "resultCountEstimate": { - "description": "The estimated result count for this query.", - "format": "int64", - "type": "string" - }, - "resultCountExact": { - "description": "The exact result count for this query.", - "format": "int64", + "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" - }, - "resultCounts": { - "$ref": "ResultCounts", - "description": "Expanded result count information." - }, - "results": { - "description": "Results from a search query.", - "items": { - "$ref": "SearchResult" - }, - "type": "array" - }, - "spellResults": { - "description": "Suggested spelling for the query.", - "items": { - "$ref": "SpellResult" - }, - "type": "array" - }, - "structuredResults": { - "description": "Structured results for the user query. These results are not counted against the page_size.", + } + }, + "type": "object" + }, + "StructuredDataObject": { + "description": "A structured data object consisting of named properties.", + "id": "StructuredDataObject", + "properties": { + "properties": { + "description": "The properties for the object. The maximum number of elements is 1000.", "items": { - "$ref": "StructuredResult" + "$ref": "NamedProperty" }, "type": "array" } }, "type": "object" }, - "SearchResult": { - "description": "Results containing indexed information for a document.", - "id": "SearchResult", + "StructuredResult": { + "description": "Structured results that are returned as part of search request.", + "id": "StructuredResult", + "properties": { + "person": { + "$ref": "Person", + "description": "Representation of a person" + } + }, + "type": "object" + }, + "SuggestPersonalRerankDebugInfo": { + "description": "Representation of user history for personal reranking. Debug only. Can be used for: 1) Manually entering the field to Suggest http debug GUI. 2) Sending protobuf using stubby tool. 3) Unit tests. 4) Offline analysis. Next ID to use: 3.", + "id": "SuggestPersonalRerankDebugInfo", "properties": { - "clusteredResults": { - "description": "If source is clustered, provide list of clustered results. There will only be one level of clustered results. If current source is not enabled for clustering, this field will be empty.", + "additionalInfo": { + "$ref": "MessageSet", + "description": "Can be used to store additional user history." + }, + "userHistory": { + "description": "The first query is considered to be the most recent query.", "items": { - "$ref": "SearchResult" + "type": "string" }, "type": "array" - }, - "debugInfo": { - "$ref": "ResultDebugInfo", - "description": "Debugging information about this search result." - }, - "metadata": { - "$ref": "Metadata", - "description": "Metadata of the search result." - }, - "snippet": { - "$ref": "Snippet", - "description": "The concatenation of all snippets (summaries) available for this result." - }, - "title": { - "description": "Title of the search result.", - "type": "string" - }, - "url": { - "description": "The URL of the search result. The URL contains a Google redirect to the actual item. This URL is signed and shouldn't be changed.", - "type": "string" } }, "type": "object" }, - "Snippet": { - "description": "Snippet of the search result, which summarizes the content of the resulting page.", - "id": "Snippet", + "SuggestRequest": { + "description": "Request of suggest API.", + "id": "SuggestRequest", "properties": { - "matchRanges": { - "description": "The matched ranges in the snippet.", + "dataSourceRestrictions": { + "description": "The sources to use for suggestions. If not specified, the data sources are taken from the current search application. NOTE: Suggestions are only supported for the following sources: * Third-party data sources * PredefinedSource.PERSON * PredefinedSource.GOOGLE_DRIVE", "items": { - "$ref": "MatchRange" + "$ref": "DataSourceRestriction" }, "type": "array" }, - "snippet": { - "description": "The snippet of the document. May contain escaped HTML character that should be unescaped prior to rendering.", + "query": { + "description": "Partial query for which autocomplete suggestions will be shown. For example, if the query is \"sea\", then the server might return \"season\", \"search\", \"seagull\" and so on.", "type": "string" + }, + "requestOptions": { + "$ref": "RequestOptions", + "description": "Request options, such as the search application and user timezone." } }, "type": "object" }, - "SortOptions": { - "id": "SortOptions", + "SuggestRequestDebugOptions": { + "description": "Next ID to use: 13.", + "id": "SuggestRequestDebugOptions", "properties": { - "operatorName": { - "description": "The name of the operator corresponding to the field to sort on. The corresponding property must be marked as sortable.", + "annotateWithSubtype": { + "description": "Whether to add the subtype to the suggestion so it can be displayed in a side-by-side", + "type": "boolean" + }, + "debug": { + "description": "Whether to enable debug info in SuggestResults.", + "type": "boolean" + }, + "disableBadwordFiltering": { + "type": "boolean" + }, + "disableHybridCache": { + "description": "Whether to disable the hybrid cache.", + "type": "boolean" + }, + "disableKesemFiltering": { + "type": "boolean" + }, + "enableGetDataFromStarlightForPersonalSxs": { + "description": "Whether to pull personal data from Starlight like Anima profile data for personal SxS eval.", + "type": "boolean" + }, + "enablePersonal": { + "description": "Whether to add the user gaia_id to the request, so it can return personal suggestions.", + "type": "boolean" + }, + "freshMode": { + "enum": [ + "ENABLE_FRESH", + "DISABLE_FRESH", + "FORCE_FRESH", + "FORCE_FRESH_ONLY" + ], + "enumDescriptions": [ + "Activate fresh when supported - the usual case.", + "Never return fresh completions.", + "Always activate fresh completions.", + "Always return only fresh completions." + ], "type": "string" }, - "sortOrder": { - "description": "Ascending is the default sort order", + "numResults": { + "description": "Number of results to return. If 0, this options is ignored. Is NOT subject to the upper bound limit controlled by num_results_limit_max_override flag", + "format": "int32", + "type": "integer" + }, + "sxs": { + "type": "boolean" + }, + "trace": { "enum": [ - "ASCENDING", - "DESCENDING" + "NONE", + "ABBREVIATED_TRACE", + "FULL_TRACE" ], "enumDescriptions": [ + "", "", "" ], @@ -7521,275 +21783,584 @@ }, "type": "object" }, - "Source": { - "description": "Defines sources for the suggest/search APIs.", - "id": "Source", + "SuggestResponse": { + "description": "Response of the suggest API.", + "id": "SuggestResponse", + "properties": { + "suggestResults": { + "description": "List of suggestions.", + "items": { + "$ref": "SuggestResult" + }, + "type": "array" + } + }, + "type": "object" + }, + "SuggestRestrict": { + "id": "SuggestRestrict", "properties": { "name": { - "description": "Source name for content indexed by the Indexing API.", + "description": "Name of the restrict, e.g. lang.", "type": "string" }, - "predefinedSource": { - "description": "Predefined content source for Google Apps.", - "enum": [ - "NONE", - "QUERY_HISTORY", - "PERSON", - "GOOGLE_DRIVE", - "GOOGLE_GMAIL", - "GOOGLE_SITES", - "GOOGLE_GROUPS", - "GOOGLE_CALENDAR", - "GOOGLE_KEEP" - ], - "enumDescriptions": [ - "", - "Suggests queries issued by the user in the past. Only valid when used with the suggest API. Ignored when used in the query API.", - "Suggests people in the organization. Only valid when used with the suggest API. Results in an error when used in the query API.", - "", - "", - "", - "", - "", - "" - ], + "value": { + "description": "Restrict value.", "type": "string" } }, "type": "object" }, - "SourceConfig": { - "description": "Configurations for a source while processing a Search or Suggest request.", - "id": "SourceConfig", + "SuggestResult": { + "description": "One suggestion result.", + "id": "SuggestResult", "properties": { - "crowdingConfig": { - "$ref": "SourceCrowdingConfig", - "description": "The crowding configuration for the source." + "peopleSuggestion": { + "$ref": "PeopleSuggestion", + "description": "This is present when the suggestion indicates a person. It contains more information about the person - like their email ID, name etc." }, - "scoringConfig": { - "$ref": "SourceScoringConfig", - "description": "The scoring configuration for the source." + "querySuggestion": { + "$ref": "QuerySuggestion", + "description": "This field will be present if the suggested query is a word/phrase completion." }, "source": { "$ref": "Source", - "description": "The source for which this configuration is to be used." + "description": "The source of the suggestion." + }, + "suggestedQuery": { + "description": "The suggested query that will be used for search, when the user clicks on the suggestion", + "type": "string" } }, "type": "object" }, - "SourceCrowdingConfig": { - "description": "Set search results crowding limits. Crowding is a situation in which multiple results from the same source or host \"crowd out\" other results, diminishing the quality of search for users. To foster better search quality and source diversity in search results, you can set a condition to reduce repetitive results by source.", - "id": "SourceCrowdingConfig", + "SuggestSuggestRequest": { + "description": "Protos for the stubby interface. Next IDs to use: 37, 38, 39, 40, 43, 44, 46, 47, 48, 71, 77, 100.", + "id": "SuggestSuggestRequest", "properties": { - "numResults": { - "description": "Maximum number of results allowed from a datasource in a result page as long as results from other sources are not exhausted. Value specified must not be negative. A default value is used if this value is equal to 0. To disable crowding, set the value greater than 100.", + "requestdata": { + "items": { + "$ref": "SuggestSuggestRequestRequestData" + }, + "type": "array" + } + }, + "type": "object" + }, + "SuggestSuggestRequestRequestData": { + "description": "A suggest request can ask for completions for one query only. For multiple request data an error is returned. Next IDs to use: 135.", + "id": "SuggestSuggestRequestRequestData", + "properties": { + "DEPRECATEDInfiniteSuggest": { + "description": "Whether to run in Infinite Suggest mode.", + "type": "boolean" + }, + "addedCharacterCount": { + "description": "Number of sequentially added characters after a sequential deletion.", + "format": "int32", + "type": "integer" + }, + "calc": { + "description": "Enable calculator. Turning this field on will cause Complete Server to fill the SuggestResults.CalculatorSuggestion string field and it instead disables all the oneboxes (in SuggestResults.CompleteSuggestion.info), including the calculator onebox. Clients that are capable of rendering oneboxes should use the onebox calculator (and should leave this field turned off). When not specified, the default value of this field depends on the client. See suggestflow_state.cc: CommonInit().", + "type": "boolean" + }, + "cityId": { + "description": "City location ID.", + "format": "int32", + "type": "integer" + }, + "client": { + "description": "The name of the requesting client (firefox, chrome, etc.).", + "type": "string" + }, + "clientInstanceId": { + "description": "The client instance ID provided by AGSA. See http://go/client-instance-id", + "type": "string" + }, + "clientThumbnailDimensions": { + "$ref": "SuggestSuggestRequestRequestDataClientThumbnailDimensions" + }, + "complete": { + "description": "Enable completion.", + "type": "boolean" + }, + "consistency": { + "$ref": "StarlightConsistency", + "description": "Allow sending read-after-write consistency data to Starlight." + }, + "contextUrls": { + "description": "Repeated list of URLs that we use to trigger context based suggestions (currently zero-prefix).", + "items": { + "type": "string" + }, + "type": "array" + }, + "cookieInitTime": { + "description": "cookie_init_time is typically set by GoogleCookie::initial_time()", + "format": "int32", + "type": "integer" + }, + "country": { + "description": "Requested country (us, uk, jp, cn, etc.).", + "type": "string" + }, + "countryByIp": { + "description": "Country as determined by GeoIP.", + "type": "string" + }, + "cp": { + "description": "Cursor position (for result-page requests).", + "format": "int32", + "type": "integer" + }, + "dasherDomain": { + "description": "The dasher domain of the searcher.", + "format": "int64", + "type": "string" + }, + "debug": { + "description": "Enable debug output.", + "type": "boolean" + }, + "debugOptions": { + "$ref": "SuggestRequestDebugOptions" + }, + "deletedCharacters": { + "description": "Any sequentially deleted characters after the cursor position.", + "type": "string" + }, + "deviceOsVersion": { + "type": "string" + }, + "ds": { + "description": "Requested dataset (i, m, yt, etc.).", + "type": "string" + }, + "enableVisualSuggest": { + "description": "Whether to enable Visual Suggest. (Currently used for YouTube Suggest) Clients can opt to disable Visual Suggest based on current device specs and network conditions.", + "type": "boolean" + }, + "expid": { + "description": "Experiment ID.", + "type": "string" + }, + "forceUserLocation": { + "description": "Define the way to read data from the location context.", + "type": "boolean" + }, + "frozenClock": { + "description": "Parameter frozen_clock in microseconds passed by SXS eval. This will be used as random number generator bit for consistent randomization for SXS tests.", + "format": "int64", + "type": "string" + }, + "gaiaId": { + "description": "Gaia ID for personal suggestions. Format is that of http://displayserver.corp.google.com/ Use ParseLeadingHex64Value in numbers.h to convert to an uint64", + "type": "string" + }, + "hourOfTheWeek": { + "description": "Hour of the week (UTC).", "format": "int32", "type": "integer" }, - "numSuggestions": { - "description": "Maximum number of suggestions allowed from a source. No limits will be set on results if this value is less than or equal to 0.", + "includeAnswerData": { + "description": "For each completion, annotate with: https://cs.corp.google.com/#piper///depot/google3/suggest/base/ answer.proto&l=15&rcl=53295698&pv=1 which is the probability that issuing the completion as a query will result in an answer being displayed to the user (live-result,one-box, etc.) If there is no answer type for which the probability is above zero, the completion will not be annotated.", + "type": "boolean" + }, + "includeLocalSignals": { + "deprecated": true, + "type": "boolean" + }, + "includeWebrefAnnotations": { + "description": "Annotate the suggestions with webref data.", + "type": "boolean" + }, + "ipAddress": { + "description": "The user's ip address. Should NOT be used to override domain.", + "type": "string" + }, + "isConsole": { + "description": "True only when using the CS debug console.", + "type": "boolean" + }, + "isDebugIp": { + "description": "Set once by the server. Can be used for dog-fooding or tests.", + "type": "boolean" + }, + "isMobileDevice": { + "description": "The following two fields, is_mobile_device and is_mobile_ux are used to denote whether the request comes from a mobile device or a device with mobile user experience. It's possible for a device type to be different than UX type since tablet devices could receive either mobile or desktop UX, as explained in go/ux-tier-logging.", + "type": "boolean" + }, + "isMobileUx": { + "type": "boolean" + }, + "isNonCorpDasherAccount": { + "description": "For users who are using Google Apps for work (dasher) but are not internal users, we would like to turn off instant apps.", + "type": "boolean" + }, + "isRequestFromChina": { + "description": "Indicates whether the request comes from china.", + "type": "boolean" + }, + "isUnicornAccount": { + "description": "Whether the user's account is a Unicorn child account.", + "type": "boolean" + }, + "isUserInitiatedRequest": { + "description": "This field should be set to false for requests that are generated due to something other than user interaction. For example: 0-prefix requests could be sent in the background (e.g. periodically) for updating a client side cache. On Android GSA, see http://go/android-0q-cache. Backends, such as Starlight, can then use this signal, e.g. for matters like load-shedding.", + "type": "boolean" + }, + "isVoiceQuery": { + "description": "Whether the query was from voice search (set by Youtube LR)", + "type": "boolean" + }, + "lang": { + "description": "Requested language (en, ru, iw, etc.).", + "type": "string" + }, + "latitude": { + "description": "GPS coordinates of the mobile client in degrees, if known.", + "format": "float", + "type": "number" + }, + "locationContext": { + "$ref": "LocationUnifiedLocationContext", + "description": "Oolong LocationContext (see http://goto/oolong)." + }, + "locationId": { + "description": "Region location ID.", "format": "int32", "type": "integer" - } - }, - "type": "object" - }, - "SourceResultCount": { - "description": "Per source result count information.", - "id": "SourceResultCount", - "properties": { - "hasMoreResults": { - "description": "Whether there are more search results for this source.", + }, + "logFlakyBackends": { + "description": "If true, will log if there was any flaky backend in SuggestResponse.", "type": "boolean" }, - "resultCountEstimate": { - "description": "The estimated result count for this source.", - "format": "int64", - "type": "string" + "longitude": { + "format": "float", + "type": "number" }, - "resultCountExact": { - "description": "The exact result count for this source.", - "format": "int64", + "mapsMissPrefix": { + "description": "State that overrides whether or not the maps fallback flow should run.", "type": "string" }, - "source": { - "$ref": "Source", - "description": "The source the result count information is associated with." - } - }, - "type": "object" - }, - "SourceScoringConfig": { - "description": "Set the scoring configuration. This allows modifying the ranking of results for a source.", - "id": "SourceScoringConfig", - "properties": { - "sourceImportance": { - "description": "Importance of the source.", + "nav": { + "description": "Enable navsuggest.", + "type": "boolean" + }, + "news": { + "description": "Enable news.", + "type": "boolean" + }, + "numNavResults": { + "description": "Upper limit of the number of navsuggest results to return.", + "format": "int32", + "type": "integer" + }, + "numResultsLimit": { + "description": "Number of suggestions to return. * In non Generic-Suggest clients, when set, this overrides the client configuration. Subject to upper bound limit controlled by num_results_limit_max_override flag. * In Generic-Suggest clients, when set, this caps the number of suggestions in addition to the client configuration. Ignores num_results_limit_max_override flag.", + "format": "int32", + "type": "integer" + }, + "omniboxFocusType": { + "description": "Chrome Omnibox focus type. This param is passed in \"oft\" CGI param.", "enum": [ - "DEFAULT", - "LOW", - "HIGH" + "INTERACTION_DEFAULT", + "INTERACTION_FOCUS", + "INTERACTION_CLOBBER" ], "enumDescriptions": [ - "", - "", - "" + "The default value. This is used for any search requests without any special interaction annotation, including: normal omnibox searches, as-you-type omnibox suggestions, as well as non-omnibox searches.", + "This search request is triggered by the user focusing the omnibox.", + "This search request is triggered by the user deleting all of the omnibox permanent text at once, i.e. user is on \"https://example.com\", does Ctrl+L which selects the whole URL, then presses Backspace. Note that INTERACTION_CLOBBER applies in fairly limited circumstances. For example, the following cases do NOT qualify and are instead marked as INTERACTION_DEFAULT: - User deletes their own typed text. - User deletes the permanent text one character at a time. - User uses Cut (Ctrl+X) to delete the permanent text." ], "type": "string" - } - }, - "type": "object" - }, - "SpellResult": { - "id": "SpellResult", - "properties": { - "suggestedQuery": { - "description": "The suggested spelling of the query.", - "type": "string" }, - "suggestedQueryHtml": { - "$ref": "SafeHtmlProto", - "description": "The sanitized HTML representing the spell corrected query that can be used in the UI. This usually has language-specific tags to mark up parts of the query that are spell checked." + "omniboxInputType": { + "description": "Chrome Omnibox input type. This param is passed in \"oit\" CGI param.", + "enum": [ + "EMPTY", + "UNKNOWN", + "DEPRECATED_REQUESTED_URL", + "URL", + "QUERY", + "DEPRECATED_FORCED_QUERY" + ], + "enumDescriptions": [ + "Empty input", + "Valid input whose type cannot be determined", + "DEPRECATED. Input autodetected as UNKNOWN, which the user wants to treat as an URL by specifying a desired_tld.", + "Input autodetected as a URL", + "Input autodetected as a query", + "DEPRECATED. Input forced to be a query by an initial '?'" + ], + "type": "string" }, - "suggestionType": { - "description": "Suggestion triggered for the current query.", + "omniboxPageClassification": { + "description": "Chrome Omnibox page classification. This param is passed in \"pgcl\" CGI param.", "enum": [ - "SUGGESTION_TYPE_UNSPECIFIED", - "NON_EMPTY_RESULTS_SPELL_SUGGESTION", - "ZERO_RESULTS_FULL_PAGE_REPLACEMENT" + "INVALID_SPEC", + "NTP", + "BLANK", + "HOME_PAGE", + "OTHER", + "OBSOLETE_INSTANT_NTP", + "SEARCH_RESULT_PAGE_DOING_SEARCH_TERM_REPLACEMENT", + "INSTANT_NTP_WITH_OMNIBOX_AS_STARTING_FOCUS", + "INSTANT_NTP_WITH_FAKEBOX_AS_STARTING_FOCUS", + "SEARCH_RESULT_PAGE_NO_SEARCH_TERM_REPLACEMENT", + "APP_HOME", + "APP_SEARCH", + "APP_MAPS", + "SEARCH_BUTTON_AS_STARTING_FOCUS", + "CHROMEOS_APP_LIST", + "NTP_REALBOX", + "ANDROID_SEARCH_WIDGET", + "START_SURFACE_HOMEPAGE", + "START_SURFACE_NEW_TAB", + "ANDROID_SHORTCUTS_WIDGET", + "NTP_ZPS_PREFETCH", + "JOURNEYS", + "SRP_ZPS_PREFETCH", + "OTHER_ZPS_PREFETCH", + "CONTEXTUAL_SEARCHBOX", + "SEARCH_SIDE_PANEL_SEARCHBOX", + "LENS_SIDE_PANEL_SEARCHBOX", + "SEARCH_RESULT_PAGE_ON_CCT", + "OTHER_ON_CCT" ], "enumDescriptions": [ - "Default spell check type", - "Spell suggestion without any results changed. The results are still shown for the original query (which has non zero / results) with a suggestion for spelling that would have results.", - "Spell suggestion triggered when original query has no results. When the original query has no results, and spell suggestion has results we trigger results for the spell corrected query." + "BEGIN_GOOGLE_INTERNAL LINT.IfChange(omnibox_page_context) END_GOOGLE_INTERNAL An invalid URL; shouldn't happen.", + "chrome://newtab/. For modern versions of Chrome, this is only reported when an extension is replacing the new tab page. Otherwise, new tab page interactions will be reported as NTP_REALBOX, INSTANT_NTP_WITH_FAKEBOX_AS_STARTING_FOCUS or INSTANT_NTP_WITH_OMNIBOX_AS_STARTING_FOCUS. For old versions of Chrome, this was reported for the default New Tab Page.", + "about:blank.", + "The user's home page. Note that if the home page is set to any of the new tab page versions or to about:blank, then we'll classify the page into those categories, not HOME_PAGE.", + "The catch-all entry of everything not included somewhere else on this list.", + "The instant new tab page. DEPRECATED on August 2, 2013.", + "The user is on a search result page that does search term replacement. This means the search terms are shown in the omnibox instead of the URL. In other words: Query in Omnibox is Active for this SRP.", + "The new tab page in which this omnibox interaction first started with the user having focus in the omnibox.", + "The new tab page in which this omnibox interaction first started with the user having focus in the fakebox. This is replaced by NTP_REALBOX. DEPRECATED on Aug 17, 2020.", + "The user is on a search result page that does not do search term replacement. This means the URL of the SRP is shown in the omnibox. In other words: Query in Omnibox is Inactive for this SRP.", + "The user is on the home screen.", + "The user is in the search app.", + "The user is in the maps app.", + "This omnibox interaction started with the user tapping the search button.", + "This interaction started with the user focusing or typing in the search box of the ChromeOS app list (a.k.a., launcher).", + "The new tab page in which this omnibox interaction started with the user having focus in the realbox.", + "Android's Search Widget started directly from Launcher.", + "Android's Start surface homepage. DEPRECATED on Jun 17, 2022.", + "New Tab with Omnibox focused with Android's start surface finale enabled. DEPRECATED on Jun 17, 2022.", + "Android's improved Search Widget with new suggestions.", + "The New Tab Page zero-prefix suggestion prefetch. Used for prefetching suggestions and should never appear in an OmniboxEventProto or any of its derived histograms. (PageClassification enum is used in other places too, and not only OmniboxEventProto.)", + "Used for Journeys requests in its landing page, side Panel or the NTP. Should never appear in an OmniboxEventProto or any of its derived histograms. (PageClassification enum is used in other places too, and not only OmniboxEventProto.)", + "The Search Results Page zero-prefix suggestion prefetch. Used for prefetching suggestions and should never appear in an OmniboxEventProto or any of its derived histograms. (PageClassification enum is used in other places too, and not only OmniboxEventProto.)", + "The catch-all zero-prefix suggestion prefetch for everything other than NTP and SRP. Used for prefetching suggestions and should never appear in an OmniboxEventProto or any of its derived histograms. (PageClassification enum is used in other places too, and not only OmniboxEventProto.)", + "The searchbox in the lens overlay. BEGIN_GOOGLE_INTERNAL Used by the searchbox in the lens overlay (pre selection) which is contextual to the page. See go/chromnient-suggest-backend-integration for more details. END_GOOGLE_INTERNAL", + "The searchbox in the search side panel. BEGIN_GOOGLE_INTERNAL Used by the search side panel searchbox (post text-selection) which may or may not be contextual to the page. See go/chromnient-suggest-backend-integration for more details. END_GOOGLE_INTERNAL", + "The searchbox in the lens side panel. BEGIN_GOOGLE_INTERNAL Used by the lens side panel searchbox (post image-selection) which is multimodal. See go/chromnient-suggest-backend-integration for more details. END_GOOGLE_INTERNAL", + "The user is visiting a search result page using Chrome Custom Tab. Equivalent of SEARCH_RESULT_PAGE_NO_SEARCH_TERM_REPLACEMENT for CCT.", + "The user is visiting a non DSE web page using Chrome Custom Tab. Equivalent of OTHER for CCT." ], "type": "string" - } - }, - "type": "object" - }, - "StartUploadItemRequest": { - "description": "Start upload file request.", - "id": "StartUploadItemRequest", - "properties": { - "connectorName": { - "description": "The name of connector making this call. Format: datasources/{source_id}/connectors/{ID}", + }, + "opaOpaqueToken": { + "deprecated": true, + "description": "The OPA opaque token provided by OPA. NOTE: Deprecated. Please use consistency.FootprintsVersionInfo.version_info.", "type": "string" }, - "debugOptions": { - "$ref": "DebugOptions", - "description": "Common debug options." - } - }, - "type": "object" - }, - "Status": { - "description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).", - "id": "Status", - "properties": { - "code": { - "description": "The status code, which should be an enum value of google.rpc.Code.", + "optInContext": { + "$ref": "ClientOptInContext", + "description": "The opt-in context passed by GSA for App History suggestions. The opt-in context has a list of apps that should be excluded from the personalized App History suggestions. More details at: go/apphistory-suggestions." + }, + "params": { + "$ref": "MessageSet", + "description": "Any additional SuggestRequest::RequestData params, like: RequestAndReferenceOverride (see experiments/suggest_experiment.proto): overrides the default client options; useful for enabling a feature on top of existing features defined for a given client. Person: extra params required by the people flow. MapsHeadRequestParams: extra params used by the maps head flow. OnFocusRequestParams: extra params used by on-focus request. SrDataForSuggestContextualizationRequestParams: extra params used by the SR for suggest context flow. MultimodalSuggestImageSignals: extra params used by Multimodal suggest flow." + }, + "personalRerankDebugInfo": { + "$ref": "SuggestPersonalRerankDebugInfo", + "description": "The user debug info used in testing, offline analysis." + }, + "prefId": { + "deprecated": true, + "description": "Deprecated.", + "type": "string" + }, + "previousQuery": { + "description": "For result-page requests.", + "type": "string" + }, + "previousQuerySeconds": { + "description": "Seconds since the previous_query was issued. Default value -1 means this field is not set in request.", "format": "int32", "type": "integer" }, - "details": { - "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.", + "previousVideoId": { + "description": "Video id for the most recently watched Youtube Video on Android App. See go/pvideo-suggest for more details. Don't use this directly, instead use request_context->video_or_pvideo_id().", + "type": "string" + }, + "previousVideoSeconds": { + "description": "Time in seconds since end of watch on the most recently watched Youtube Video on Android App.", + "format": "int64", + "type": "string" + }, + "query": { + "description": "Ask Google Suggest server for completions for this query.", + "type": "string" + }, + "queryBiasingContext": { + "$ref": "QueryBiasingContext" + }, + "referrer": { + "description": "The HTTP request's referrer, it will be set for requests coming from web (desktop or mobile).", + "type": "string" + }, + "restrict": { + "description": "Thirdparty restricted search.", "items": { - "additionalProperties": { - "description": "Properties of the object. Contains field @type with type URL.", - "type": "any" - }, - "type": "object" + "$ref": "SuggestRestrict" }, "type": "array" }, - "message": { - "description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.", + "runtimeData": { + "$ref": "SuggestSuggestRequestRequestDataRuntimeData" + }, + "selectionEnd": { + "description": "End position of the user's selection (if any).", + "format": "int32", + "type": "integer" + }, + "shouldPersonalize": { + "description": "Specifies whether we should personalize Suggest results. Based on whether this field is set or not, we have the following interpretations: (1) this field is not set - we request a Kansas check to be done in PSuggest server (fall back to the user personalization settings) Note: this is the default behavior (2) this field is set to true - this forces personalization regardless Kansas settings (3) this field is set to false - this disables personalization (PSuggest flows are not invoked) Note: Originally, we planned to have Kansas check in GWS, however it turns out that Kansas is not on Suggest path and we were forced to implement this check in PSuggest server. See http://b/5265965 for more details.", + "type": "boolean" + }, + "siteRestrict": { + "description": "Requests suggestions for query restricted to specified site. Should be a sitename (ex: 'youtube.com')", "type": "string" - } - }, - "type": "object" - }, - "StructuredDataObject": { - "description": "A structured data object consisting of named properties.", - "id": "StructuredDataObject", - "properties": { - "properties": { - "description": "The properties for the object. The maximum number of elements is 1000.", + }, + "sourceLang": { + "description": "The source language for dictionary/translate (en, ru, iw, etc.).", + "type": "string" + }, + "spell": { + "description": "Enable spell correction.", + "type": "boolean" + }, + "spellingExperimentIds": { + "deprecated": true, + "description": "Deprecated: GWS Experiment Ids that are tagged for Spelling.", "items": { - "$ref": "NamedProperty" + "format": "int32", + "type": "integer" }, "type": "array" + }, + "startIndex": { + "description": "If non-negative, determines the start index (starting at 0) for results: a value of '0' is a no-opt; and e.g. a value of '20' would skip the first 20 suggestions, returning results 21 - ?? (e.g. ?? = 30 if num_results_limit = 10). Currently, this is only used by PSuggest, and will be ignored by all other suggest backends.", + "format": "int32", + "type": "integer" + }, + "suggestRequestId": { + "description": "Request options, filled in a runtime.", + "format": "int32", + "type": "integer" + }, + "suppressBolding": { + "description": "Suppress fragment generation and bolding.", + "type": "boolean" + }, + "suppressPluspages": { + "description": "Disables pluspage suggestions. This overrides client config. Intended for temporary UI state change as it happens when toolbar is activated.", + "type": "boolean" + }, + "targetLang": { + "description": "The target language for dictionary/translate (en, ru, iw, etc.).", + "type": "string" + }, + "textAhead": { + "description": "For querynation, this is the psychic completed part of the query. For example if the user has entered [cancun hote] in the searchbox and this completes to [cancun hotels], then text_ahead=\"ls\".", + "type": "string" + }, + "uncorrectedOriginalQuery": { + "description": "Original query before it was refined or corrected (set by Youtube LR)", + "type": "string" + }, + "userAgent": { + "description": "The user agent string, to be used temporarily within CompleteServer to accurately compute data volume estimate for additional events added to Sessions for Proxima (namely, go/search-metrics-and-triggering-proxima). ", + "type": "string" + }, + "userLocationFeatureId": { + "description": "FeatureId associated with user location (from Oolong) as a string", + "type": "string" + }, + "userLocationResult": { + "deprecated": true, + "description": "Index of the result in location_context.results field that best describes the user location.", + "format": "int32", + "type": "integer" + }, + "userPrefs": { + "$ref": "SuggestSuggestRequestRequestDataUserPreferences" + }, + "uuld": { + "description": "Override the user location. Used for debugging.", + "type": "string" + }, + "videoId": { + "description": "Video id for the currently watching Youtube Video. Don't use this directly, instead use request_context->video_or_pvideo_id().", + "type": "string" + }, + "visitorData": { + "description": "Encrypted YouTube Visitor Data (see go/visitor-id-suggest). For privacy reasons, visitor_data can only be set in absence of gaia_id.", + "type": "string" + }, + "youtubeExternalChannelId": { + "description": "External YouTube Channel ID for channel scoped suggestions. This ID is is passed through for creator features and is used to fetch channel personalized suggestions.", + "type": "string" + }, + "zwiebackId": { + "description": "zwieback_id is set by GoogleCookie::uid() For SxS we override zwieback_id, please access through SuggestFlowUtils::GetZwiebackId(...).", + "type": "string" } }, "type": "object" }, - "StructuredResult": { - "description": "Structured results that are returned as part of search request.", - "id": "StructuredResult", - "properties": { - "person": { - "$ref": "Person", - "description": "Representation of a person" - } - }, - "type": "object" - }, - "SuggestRequest": { - "description": "Request of suggest API.", - "id": "SuggestRequest", + "SuggestSuggestRequestRequestDataClientThumbnailDimensions": { + "description": "The thumbnail dimensions as per client requirements. Next ID: 5", + "id": "SuggestSuggestRequestRequestDataClientThumbnailDimensions", "properties": { - "dataSourceRestrictions": { - "description": "The sources to use for suggestions. If not specified, the data sources are taken from the current search application. NOTE: Suggestions are only supported for the following sources: * Third-party data sources * PredefinedSource.PERSON * PredefinedSource.GOOGLE_DRIVE", - "items": { - "$ref": "DataSourceRestriction" - }, - "type": "array" + "devicePixelRatio": { + "format": "double", + "type": "number" }, - "query": { - "description": "Partial query for which autocomplete suggestions will be shown. For example, if the query is \"sea\", then the server might return \"season\", \"search\", \"seagull\" and so on.", - "type": "string" + "iconSizeInDp": { + "format": "double", + "type": "number" }, - "requestOptions": { - "$ref": "RequestOptions", - "description": "Request options, such as the search application and user timezone." + "targetThumbnailHeight": { + "format": "uint32", + "type": "integer" + }, + "targetThumbnailWidth": { + "description": "Currently only used for YouTube Visual Suggest (go/ytandroid-visual-suggest).", + "format": "uint32", + "type": "integer" } }, "type": "object" }, - "SuggestResponse": { - "description": "Response of the suggest API.", - "id": "SuggestResponse", + "SuggestSuggestRequestRequestDataRuntimeData": { + "description": "Next ID: 2 TODO(b/237694378) Move this to ProcessedRequestContext.", + "id": "SuggestSuggestRequestRequestDataRuntimeData", "properties": { - "suggestResults": { - "description": "List of suggestions.", - "items": { - "$ref": "SuggestResult" - }, - "type": "array" + "sanitizedRequestLanguage": { + "type": "string" } }, "type": "object" }, - "SuggestResult": { - "description": "One suggestion result.", - "id": "SuggestResult", + "SuggestSuggestRequestRequestDataUserPreferences": { + "id": "SuggestSuggestRequestRequestDataUserPreferences", "properties": { - "peopleSuggestion": { - "$ref": "PeopleSuggestion", - "description": "This is present when the suggestion indicates a person. It contains more information about the person - like their email ID, name etc." - }, - "querySuggestion": { - "$ref": "QuerySuggestion", - "description": "This field will be present if the suggested query is a word/phrase completion." - }, - "source": { - "$ref": "Source", - "description": "The source of the suggestion." - }, - "suggestedQuery": { - "description": "The suggested query that will be used for search, when the user clicks on the suggestion", - "type": "string" + "isTrendsDisabled": { + "type": "boolean" } }, "type": "object" diff --git a/discovery/compute-alpha.json b/discovery/compute-alpha.json index d06cf7ddfb..a1321487de 100644 --- a/discovery/compute-alpha.json +++ b/discovery/compute-alpha.json @@ -14084,6 +14084,210 @@ } } }, + "instantSnapshotGroups": { + "methods": { + "delete": { + "description": "deletes a Zonal InstantSnapshotGroup resource", + "flatPath": "projects/{project}/zones/{zone}/instantSnapshotGroups/{instantSnapshotGroup}", + "httpMethod": "DELETE", + "id": "compute.instantSnapshotGroups.delete", + "parameterOrder": [ + "project", + "zone", + "instantSnapshotGroup" + ], + "parameters": { + "instantSnapshotGroup": { + "description": "Name of the InstantSnapshot resource to delete.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "required": true, + "type": "string" + }, + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "requestId": { + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + }, + "zone": { + "description": "The name of the zone for this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "required": true, + "type": "string" + } + }, + "path": "projects/{project}/zones/{zone}/instantSnapshotGroups/{instantSnapshotGroup}", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + }, + "get": { + "description": "returns the specified InstantSnapshotGroup resource in the specified zone.", + "flatPath": "projects/{project}/zones/{zone}/instantSnapshotGroups/{instantSnapshotGroup}", + "httpMethod": "GET", + "id": "compute.instantSnapshotGroups.get", + "parameterOrder": [ + "project", + "zone", + "instantSnapshotGroup" + ], + "parameters": { + "instantSnapshotGroup": { + "description": "Name of the instantSnapshotGroup resource to return.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "required": true, + "type": "string" + }, + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "zone": { + "description": "The name of the zone for this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "required": true, + "type": "string" + } + }, + "path": "projects/{project}/zones/{zone}/instantSnapshotGroups/{instantSnapshotGroup}", + "response": { + "$ref": "InstantSnapshotGroup" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" + ] + }, + "insert": { + "description": "inserts a Zonal InstantSnapshotGroup resource", + "flatPath": "projects/{project}/zones/{zone}/instantSnapshotGroups", + "httpMethod": "POST", + "id": "compute.instantSnapshotGroups.insert", + "parameterOrder": [ + "project", + "zone" + ], + "parameters": { + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "requestId": { + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + }, + "sourceConsistencyGroup": { + "description": "begin_interface: MixerMutationRequestBuilder", + "location": "query", + "type": "string" + }, + "zone": { + "description": "Name of the zone for this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "required": true, + "type": "string" + } + }, + "path": "projects/{project}/zones/{zone}/instantSnapshotGroups", + "request": { + "$ref": "InstantSnapshotGroup" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + }, + "list": { + "description": "retrieves the list of InstantSnapshotGroup resources contained within the specified zone.", + "flatPath": "projects/{project}/zones/{zone}/instantSnapshotGroups", + "httpMethod": "GET", + "id": "compute.instantSnapshotGroups.list", + "parameterOrder": [ + "project", + "zone" + ], + "parameters": { + "filter": { + "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions.", + "location": "query", + "type": "string" + }, + "maxResults": { + "default": "500", + "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", + "format": "uint32", + "location": "query", + "minimum": "0", + "type": "integer" + }, + "orderBy": { + "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", + "location": "query", + "type": "string" + }, + "pageToken": { + "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", + "location": "query", + "type": "string" + }, + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "returnPartialSuccess": { + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", + "location": "query", + "type": "boolean" + }, + "zone": { + "description": "The name of the zone for this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "required": true, + "type": "string" + } + }, + "path": "projects/{project}/zones/{zone}/instantSnapshotGroups", + "response": { + "$ref": "ListInstantSnapshotGroups" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" + ] + } + } + }, "instantSnapshots": { "methods": { "aggregatedList": { @@ -26304,6 +26508,106 @@ } } }, + "regionInstanceGroupManagerResizeRequests": { + "methods": { + "get": { + "description": "Returns all of the details about the specified resize request.", + "flatPath": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/resizeRequests/{resizeRequest}", + "httpMethod": "GET", + "id": "compute.regionInstanceGroupManagerResizeRequests.get", + "parameterOrder": [ + "project", + "region", + "instanceGroupManager", + "resizeRequest" + ], + "parameters": { + "instanceGroupManager": { + "description": "The name of the managed instance group. Name should conform to RFC1035 or be a resource ID.", + "location": "path", + "required": true, + "type": "string" + }, + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "region": { + "description": "The name of the region scoping this request. Name should conform to RFC1035.", + "location": "path", + "required": true, + "type": "string" + }, + "resizeRequest": { + "description": "The name of the resize request. Name should conform to RFC1035 or be a resource ID.", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/resizeRequests/{resizeRequest}", + "response": { + "$ref": "InstanceGroupManagerResizeRequest" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" + ] + }, + "insert": { + "description": "Creates a new Resize Request that starts provisioning VMs immediately or queues VM creation.", + "flatPath": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/resizeRequests", + "httpMethod": "POST", + "id": "compute.regionInstanceGroupManagerResizeRequests.insert", + "parameterOrder": [ + "project", + "region", + "instanceGroupManager" + ], + "parameters": { + "instanceGroupManager": { + "description": "Name of the managed instance group to which the resize request is scoped. Name should conform to RFC1035 or be a resource ID.", + "location": "path", + "required": true, + "type": "string" + }, + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "region": { + "description": "Name of the region scoping this request. Name should conform to RFC1035.", + "location": "path", + "required": true, + "type": "string" + }, + "requestId": { + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + } + }, + "path": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/resizeRequests", + "request": { + "$ref": "InstanceGroupManagerResizeRequest" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + } + } + }, "regionInstanceGroupManagers": { "methods": { "abandonInstances": { @@ -28207,6 +28511,210 @@ } } }, + "regionInstantSnapshotGroups": { + "methods": { + "delete": { + "description": "deletes a Regional InstantSnapshotGroup resource", + "flatPath": "projects/{project}/regions/{region}/instantSnapshotGroups/{instantSnapshotGroup}", + "httpMethod": "DELETE", + "id": "compute.regionInstantSnapshotGroups.delete", + "parameterOrder": [ + "project", + "region", + "instantSnapshotGroup" + ], + "parameters": { + "instantSnapshotGroup": { + "description": "Name of the InstantSnapshotGroup resource to delete.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "required": true, + "type": "string" + }, + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "region": { + "description": "The name of the region for this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "required": true, + "type": "string" + }, + "requestId": { + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + } + }, + "path": "projects/{project}/regions/{region}/instantSnapshotGroups/{instantSnapshotGroup}", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + }, + "get": { + "description": "returns the specified InstantSnapshotGroup resource in the specified region.", + "flatPath": "projects/{project}/regions/{region}/instantSnapshotGroups/{instantSnapshot}", + "httpMethod": "GET", + "id": "compute.regionInstantSnapshotGroups.get", + "parameterOrder": [ + "project", + "region", + "instantSnapshot" + ], + "parameters": { + "instantSnapshot": { + "description": "Name of the InstantSnapshotGroup resource to return.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "required": true, + "type": "string" + }, + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "region": { + "description": "The name of the region for this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "required": true, + "type": "string" + } + }, + "path": "projects/{project}/regions/{region}/instantSnapshotGroups/{instantSnapshot}", + "response": { + "$ref": "InstantSnapshotGroup" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" + ] + }, + "insert": { + "description": "creates a Regional InstantSnapshotGroup resource", + "flatPath": "projects/{project}/regions/{region}/instantSnapshotGroups", + "httpMethod": "POST", + "id": "compute.regionInstantSnapshotGroups.insert", + "parameterOrder": [ + "project", + "region" + ], + "parameters": { + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "region": { + "description": "Name of the region for this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "required": true, + "type": "string" + }, + "requestId": { + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + }, + "sourceConsistencyGroup": { + "description": "begin_interface: MixerMutationRequestBuilder", + "location": "query", + "type": "string" + } + }, + "path": "projects/{project}/regions/{region}/instantSnapshotGroups", + "request": { + "$ref": "InstantSnapshotGroup" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + }, + "list": { + "description": "retrieves the list of InstantSnapshotGroup resources contained within the specified region.", + "flatPath": "projects/{project}/regions/{region}/instantSnapshotGroups", + "httpMethod": "GET", + "id": "compute.regionInstantSnapshotGroups.list", + "parameterOrder": [ + "project", + "region" + ], + "parameters": { + "filter": { + "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions.", + "location": "query", + "type": "string" + }, + "maxResults": { + "default": "500", + "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", + "format": "uint32", + "location": "query", + "minimum": "0", + "type": "integer" + }, + "orderBy": { + "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", + "location": "query", + "type": "string" + }, + "pageToken": { + "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", + "location": "query", + "type": "string" + }, + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "region": { + "description": "The name of the region for this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "required": true, + "type": "string" + }, + "returnPartialSuccess": { + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", + "location": "query", + "type": "boolean" + } + }, + "path": "projects/{project}/regions/{region}/instantSnapshotGroups", + "response": { + "$ref": "ListInstantSnapshotGroups" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" + ] + } + } + }, "regionInstantSnapshots": { "methods": { "delete": { @@ -33564,7 +34072,7 @@ "regions": { "methods": { "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.", + "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.", "flatPath": "projects/{project}/regions/{region}", "httpMethod": "GET", "id": "compute.regions.get", @@ -44715,7 +45223,7 @@ } } }, - "revision": "20240618", + "revision": "20240707", "rootUrl": "https://compute.googleapis.com/", "schemas": { "AWSV4Signature": { @@ -46139,6 +46647,14 @@ "sourceInstanceTemplateId": { "description": "ID of the instance template used to populate reservation properties.", "type": "string" + }, + "utilizations": { + "additionalProperties": { + "format": "int64", + "type": "string" + }, + "description": "Per service utilization breakdown. The Key is the Google Cloud managed service name.", + "type": "object" } }, "type": "object" @@ -47479,11 +47995,13 @@ "description": "Specifies how to determine whether the backend of a load balancer can handle additional traffic or is fully loaded. For usage guidelines, see Connection balancing mode. Backends must use compatible balancing modes. For more information, see Supported balancing modes and target capacity settings and Restrictions and guidance for instance groups. Note: Currently, if you use the API to configure incompatible balancing modes, the configuration might be accepted even though it has no impact and is ignored. Specifically, Backend.maxUtilization is ignored when Backend.balancingMode is RATE. In the future, this incompatible combination will be rejected.", "enum": [ "CONNECTION", + "CUSTOM_METRICS", "RATE", "UTILIZATION" ], "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." ], @@ -47494,6 +48012,13 @@ "format": "float", "type": "number" }, + "customMetrics": { + "description": "List of custom metrics that are used for CUSTOM_METRICS BalancingMode and WEIGHTED_ROUND_ROBIN BackendService locality_lb_policy.", + "items": { + "$ref": "BackendCustomMetric" + }, + "type": "array" + }, "description": { "description": "An optional description of this resource. Provide this property when you create the resource.", "type": "string" @@ -47923,6 +48448,26 @@ }, "type": "object" }, + "BackendCustomMetric": { + "description": "Custom Metrics are used for CUSTOM_METRICS balancing_mode and WEIGHTED_ROUND_ROBIN BackendService locality_lb_policy.", + "id": "BackendCustomMetric", + "properties": { + "dryRun": { + "description": "If true, the metric data is collected and reported to Cloud Monitoring, but is not used for load balancing.", + "type": "boolean" + }, + "maxUtilization": { + "description": "Optional parameter to define a target utilization for the Custom Metrics balancing mode. The valid range is [0.0, 1.0].", + "format": "float", + "type": "number" + }, + "name": { + "description": "Name of a custom utilization signal. The name must be 1-24 characters long, and comply with RFC1035. Specifically, the name must be 1-24 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be 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 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" + } + }, + "type": "object" + }, "BackendService": { "description": "Represents a Backend Service resource. A backend service defines how Google Cloud load balancers distribute traffic. The backend service configuration contains a set of values, such as the protocol used to connect to backends, various distribution and session settings, health checks, and timeouts. These settings provide fine-grained control over how your load balancer behaves. Most of the settings have default values that allow for easy configuration if you need to get started quickly. Backend services in Google Compute Engine can be either regionally or globally scoped. * [Global](https://cloud.google.com/compute/docs/reference/rest/alpha/backendServices) * [Regional](https://cloud.google.com/compute/docs/reference/rest/alpha/regionBackendServices) For more information, see Backend Services.", "id": "BackendService", @@ -48105,7 +48650,8 @@ "RANDOM", "RING_HASH", "ROUND_ROBIN", - "WEIGHTED_MAGLEV" + "WEIGHTED_MAGLEV", + "WEIGHTED_ROUND_ROBIN" ], "enumDescriptions": [ "", @@ -48115,7 +48661,8 @@ "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." + "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 X-Endpoint-Load-Metrics. The reported metrics to use for computing the weights are specified via the backends[].customMetrics fields." ], "type": "string" }, @@ -48257,6 +48804,7 @@ "type": "integer" }, "usedBy": { + "description": "[Output Only] List of resources referencing given backend service.", "items": { "$ref": "BackendServiceUsedBy" }, @@ -49091,7 +49639,8 @@ "RANDOM", "RING_HASH", "ROUND_ROBIN", - "WEIGHTED_MAGLEV" + "WEIGHTED_MAGLEV", + "WEIGHTED_ROUND_ROBIN" ], "enumDescriptions": [ "", @@ -49101,7 +49650,8 @@ "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." + "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 X-Endpoint-Load-Metrics. The reported metrics to use for computing the weights are specified via the backends[].customMetrics fields." ], "type": "string" } @@ -49212,6 +49762,7 @@ "id": "BackendServiceUsedBy", "properties": { "reference": { + "description": "[Output Only] Server-defined URL for resources referencing given BackendService like UrlMaps, TargetTcpProxies, TargetSslProxies and ForwardingRule.", "type": "string" } }, @@ -50058,6 +50609,10 @@ "description": "[Output Only] Creation timestamp in RFC3339 text format.", "type": "string" }, + "customEndTimestamp": { + "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.", + "type": "string" + }, "description": { "description": "An optional description of this resource. Provide this property when you create the resource.", "type": "string" @@ -50548,6 +51103,10 @@ "cancellationInformation": { "$ref": "CommitmentResourceStatusCancellationInformation", "description": "[Output Only] An optional, contains all the needed information of cancellation." + }, + "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" } }, "type": "object" @@ -59606,8 +60165,7 @@ "type": "array" }, "baseInstanceName": { - "description": "The base instance name to use for instances in this group. The value must be 1-58 characters long. Instances are named by appending a hyphen and a random four-character string to the base instance name. The base instance name must comply with RFC1035.", - "pattern": "[a-z][-a-z0-9]{0,57}", + "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,52}-#{1,10}(\\\\[[0-9]{1,10}\\\\])?))", "type": "string" }, "creationTimestamp": { @@ -59707,6 +60265,10 @@ "description": "[Output Only] The URL of the region where the managed instance group resides (for regional resources).", "type": "string" }, + "resourcePolicies": { + "$ref": "InstanceGroupManagerResourcePolicies", + "description": "Resource policies for this managed instance group." + }, "satisfiesPzi": { "description": "[Output Only] Reserved for future use.", "type": "boolean" @@ -60749,6 +61311,16 @@ }, "type": "object" }, + "InstanceGroupManagerResourcePolicies": { + "id": "InstanceGroupManagerResourcePolicies", + "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" + } + }, + "type": "object" + }, "InstanceGroupManagerStandbyPolicy": { "id": "InstanceGroupManagerStandbyPolicy", "properties": { @@ -63797,6 +64369,101 @@ }, "type": "object" }, + "InstantSnapshotGroup": { + "id": "InstantSnapshotGroup", + "properties": { + "creationTimestamp": { + "description": "[Output Only] Creation timestamp in RFC3339 text format.", + "type": "string" + }, + "description": { + "description": "Optional. An optional description of this resource. Provide this property when you create the resource.", + "type": "string" + }, + "id": { + "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.", + "format": "uint64", + "type": "string" + }, + "kind": { + "default": "compute#instantSnapshotGroup", + "description": "[Output Only] Type of the resource. Always compute#instantSnapshotGroup for InstantSnapshotGroup resources.", + "type": "string" + }, + "name": { + "description": "Identifier. Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "type": "string" + }, + "region": { + "description": "[Output Only] URL of the region where the instant snapshot group 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" + }, + "resourceStatus": { + "$ref": "InstantSnapshotGroupResourceStatus" + }, + "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" + }, + "status": { + "description": "[Output Only]", + "enum": [ + "CREATING", + "DELETING", + "FAILED", + "INVALID", + "READY", + "UNKNOWN" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "", + "" + ], + "type": "string" + }, + "zone": { + "description": "[Output Only] URL of the zone where the instant snapshot group resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.", + "type": "string" + } + }, + "type": "object" + }, + "InstantSnapshotGroupResourceStatus": { + "id": "InstantSnapshotGroupResourceStatus", + "properties": { + "consistencyMembershipResolutionTime": { + "description": "[Output Only]", + "format": "google-datetime", + "type": "string" + }, + "sourceInfo": { + "$ref": "InstantSnapshotGroupSourceInfo", + "description": "[Output Only]" + } + }, + "type": "object" + }, + "InstantSnapshotGroupSourceInfo": { + "id": "InstantSnapshotGroupSourceInfo", + "properties": { + "consistencyGroup": { + "type": "string" + }, + "consistencyGroupId": { + "type": "string" + } + }, + "type": "object" + }, "InstantSnapshotList": { "description": "Contains a list of InstantSnapshot resources.", "id": "InstantSnapshotList", @@ -64332,6 +64999,9 @@ "bandwidthPercentagePolicy": { "$ref": "InterconnectApplicationAwareInterconnectBandwidthPercentagePolicy" }, + "egressMinBandwidthPercentagePolicy": { + "$ref": "InterconnectApplicationAwareInterconnectBandwidthPercentagePolicy" + }, "profileDescription": { "description": "A description for the AAI profile on this interconnect.", "type": "string" @@ -67126,6 +67796,168 @@ }, "type": "object" }, + "ListInstantSnapshotGroups": { + "description": "Contains a list of InstantSnapshotGroup resources.", + "id": "ListInstantSnapshotGroups", + "properties": { + "etag": { + "type": "string" + }, + "id": { + "description": "[Output Only] Unique identifier for the resource; defined by the server.", + "type": "string" + }, + "items": { + "description": "A list of InstantSnapshotGroup resources.", + "items": { + "$ref": "InstantSnapshotGroup" + }, + "type": "array" + }, + "kind": { + "default": "compute#instantSnapshotGroupsList", + "description": "Type of resource.", + "type": "string" + }, + "nextPageToken": { + "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", + "type": "string" + }, + "selfLink": { + "description": "[Output Only] Server-defined URL for this resource.", + "type": "string" + }, + "unreachables": { + "description": "[Output Only] Unreachable resources. end_interface: MixerListResponseWithEtagBuilder", + "items": { + "type": "string" + }, + "type": "array" + }, + "warning": { + "description": "[Output Only] Informational warning message.", + "properties": { + "code": { + "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", + "enum": [ + "CLEANUP_FAILED", + "DEPRECATED_RESOURCE_USED", + "DEPRECATED_TYPE_USED", + "DISK_SIZE_LARGER_THAN_IMAGE_SIZE", + "EXPERIMENTAL_TYPE_USED", + "EXTERNAL_API_WARNING", + "FIELD_VALUE_OVERRIDEN", + "INJECTED_KERNELS_DEPRECATED", + "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB", + "LARGE_DEPLOYMENT_WARNING", + "LIST_OVERHEAD_QUOTA_EXCEED", + "MISSING_TYPE_DEPENDENCY", + "NEXT_HOP_ADDRESS_NOT_ASSIGNED", + "NEXT_HOP_CANNOT_IP_FORWARD", + "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE", + "NEXT_HOP_INSTANCE_NOT_FOUND", + "NEXT_HOP_INSTANCE_NOT_ON_NETWORK", + "NEXT_HOP_NOT_RUNNING", + "NOT_CRITICAL_ERROR", + "NO_RESULTS_ON_PAGE", + "PARTIAL_SUCCESS", + "REQUIRED_TOS_AGREEMENT", + "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING", + "RESOURCE_NOT_DELETED", + "SCHEMA_VALIDATION_IGNORED", + "SINGLE_INSTANCE_PROPERTY_TEMPLATE", + "UNDECLARED_PROPERTIES", + "UNREACHABLE" + ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], + "enumDescriptions": [ + "Warning about failed cleanup of transient changes made by a failed operation.", + "A link to a deprecated resource was created.", + "When deploying and at least one of the resources has a type marked as deprecated", + "The user created a boot disk that is larger than image size.", + "When deploying and at least one of the resources has a type marked as experimental", + "Warning that is present in an external api call", + "Warning that value of a field has been overridden. Deprecated unused field.", + "The operation involved use of an injected kernel, which is deprecated.", + "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.", + "When deploying a deployment with a exceedingly large number of resources", + "Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.", + "A resource depends on a missing type", + "The route's nextHopIp address is not assigned to an instance on the network.", + "The route's next hop instance cannot ip forward.", + "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.", + "The route's nextHopInstance URL refers to an instance that does not exist.", + "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.", + "The route's next hop instance does not have a status of RUNNING.", + "Error which is not critical. We decided to continue the process despite the mentioned error.", + "No results are present on a particular list page.", + "Success is reported, but some results may be missing due to errors", + "The user attempted to use a resource that requires a TOS they have not accepted.", + "Warning that a resource is in use.", + "One or more of the resources set to auto-delete could not be deleted because they were in use.", + "When a resource schema validation is ignored.", + "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", + "When undeclared properties in the schema are present", + "A given scope cannot be reached." + ], + "type": "string" + }, + "data": { + "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ", + "items": { + "properties": { + "key": { + "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", + "type": "string" + }, + "value": { + "description": "[Output Only] A warning data value corresponding to the key.", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "message": { + "description": "[Output Only] A human-readable description of the warning code.", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, "LocalDisk": { "id": "LocalDisk", "properties": { @@ -68644,6 +69476,9 @@ "selfLinkWithId": { "description": "[Output Only] Server-defined URL for this resource with the resource id.", "type": "string" + }, + "status": { + "$ref": "MultiMigStatus" } }, "type": "object" @@ -68696,6 +69531,18 @@ }, "type": "object" }, + "MultiMigStatus": { + "id": "MultiMigStatus", + "properties": { + "memberInstanceGroupManagers": { + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "MultiMigsList": { "id": "MultiMigsList", "properties": { @@ -70061,12 +70908,6 @@ "format": "int32", "type": "integer" }, - "clientPort": { - "deprecated": true, - "description": "Represents the port number to which PSC consumer sends packets. Only valid for network endpoint groups created with CLIENT_PORT_PER_ENDPOINT mapping mode.", - "format": "int32", - "type": "integer" - }, "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" @@ -70110,19 +70951,6 @@ "$ref": "NetworkEndpointGroupAppEngine", "description": "Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set." }, - "clientPortMappingMode": { - "deprecated": true, - "description": "Only valid when networkEndpointType is GCE_VM_IP_PORT and the NEG is regional.", - "enum": [ - "CLIENT_PORT_PER_ENDPOINT", - "PORT_MAPPING_DISABLED" - ], - "enumDescriptions": [ - "For each endpoint there is exactly one client port.", - "NEG should not be used for mapping client port to destination." - ], - "type": "string" - }, "cloudFunction": { "$ref": "NetworkEndpointGroupCloudFunction", "description": "Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set." @@ -82117,6 +82945,9 @@ "vmMaintenancePolicy": { "$ref": "ResourcePolicyVmMaintenancePolicy", "description": "Resource policy applicable to VMs for infrastructure maintenance." + }, + "workloadPolicy": { + "$ref": "ResourcePolicyWorkloadPolicy" } }, "type": "object" @@ -82796,6 +83627,24 @@ }, "type": "object" }, + "ResourcePolicyWorkloadPolicy": { + "description": "Represents the workload policy.", + "id": "ResourcePolicyWorkloadPolicy", + "properties": { + "type": { + "enum": [ + "HIGH_AVAILABILITY", + "HIGH_THROUGHPUT" + ], + "enumDescriptions": [ + "VMs will be provisioned in such a way which provides high availability.", + "VMs will be provisioned in such a way which provides high throughput." + ], + "type": "string" + } + }, + "type": "object" + }, "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.", "id": "ResourceStatus", @@ -82874,7 +83723,7 @@ "id": "ResourceStatusScheduling", "properties": { "availabilityDomain": { - "description": "Specifies the availability domain (AD), which this instance should be scheduled on. The AD belongs to the spread GroupPlacementPolicy resource policy that has been assigned to the instance. Specify a value between 1-max count of availability domains in your GroupPlacementPolicy. See go/placement-policy-extension for more details.", + "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.", "format": "int32", "type": "integer" }, @@ -85854,7 +86703,7 @@ "type": "boolean" }, "availabilityDomain": { - "description": "Specifies the availability domain (AD), which this instance should be scheduled on. The AD belongs to the spread GroupPlacementPolicy resource policy that has been assigned to the instance. Specify a value between 1-max count of availability domains in your GroupPlacementPolicy. See go/placement-policy-extension for more details.", + "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.", "format": "int32", "type": "integer" }, @@ -98900,7 +99749,7 @@ "type": "string" }, "stackType": { - "description": "The stack type for this VPN gateway to identify the IP protocols that are enabled. Possible values are: IPV4_ONLY, IPV4_IPV6. If not specified, IPV4_ONLY will be used.", + "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.", "enum": [ "IPV4_IPV6", "IPV4_ONLY", diff --git a/discovery/compute-beta.json b/discovery/compute-beta.json index 4e768d5c6f..f8bd1e33cd 100644 --- a/discovery/compute-beta.json +++ b/discovery/compute-beta.json @@ -3669,6 +3669,40 @@ "https://www.googleapis.com/auth/compute" ] }, + "addPacketMirroringRule": { + "description": "Inserts a packet mirroring rule into a firewall policy.", + "flatPath": "locations/global/firewallPolicies/{firewallPolicy}/addPacketMirroringRule", + "httpMethod": "POST", + "id": "compute.firewallPolicies.addPacketMirroringRule", + "parameterOrder": [ + "firewallPolicy" + ], + "parameters": { + "firewallPolicy": { + "description": "Name of the firewall policy to update.", + "location": "path", + "pattern": "(firewallPolicies/)?[0-9]{0,20}", + "required": true, + "type": "string" + }, + "requestId": { + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + } + }, + "path": "locations/global/firewallPolicies/{firewallPolicy}/addPacketMirroringRule", + "request": { + "$ref": "FirewallPolicyRule" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + }, "addRule": { "description": "Inserts a rule into a firewall policy.", "flatPath": "locations/global/firewallPolicies/{firewallPolicy}/addRule", @@ -3862,6 +3896,39 @@ "https://www.googleapis.com/auth/compute.readonly" ] }, + "getPacketMirroringRule": { + "description": "Gets a packet mirroring rule of the specified priority.", + "flatPath": "locations/global/firewallPolicies/{firewallPolicy}/getPacketMirroringRule", + "httpMethod": "GET", + "id": "compute.firewallPolicies.getPacketMirroringRule", + "parameterOrder": [ + "firewallPolicy" + ], + "parameters": { + "firewallPolicy": { + "description": "Name of the firewall policy to which the queried rule belongs.", + "location": "path", + "pattern": "(firewallPolicies/)?[0-9]{0,20}", + "required": true, + "type": "string" + }, + "priority": { + "description": "The priority of the rule to get from the firewall policy.", + "format": "int32", + "location": "query", + "type": "integer" + } + }, + "path": "locations/global/firewallPolicies/{firewallPolicy}/getPacketMirroringRule", + "response": { + "$ref": "FirewallPolicyRule" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" + ] + }, "getRule": { "description": "Gets a rule of the specified priority.", "flatPath": "locations/global/firewallPolicies/{firewallPolicy}/getRule", @@ -4066,6 +4133,46 @@ "https://www.googleapis.com/auth/compute" ] }, + "patchPacketMirroringRule": { + "description": "Patches a packet mirroring rule of the specified priority.", + "flatPath": "locations/global/firewallPolicies/{firewallPolicy}/patchPacketMirroringRule", + "httpMethod": "POST", + "id": "compute.firewallPolicies.patchPacketMirroringRule", + "parameterOrder": [ + "firewallPolicy" + ], + "parameters": { + "firewallPolicy": { + "description": "Name of the firewall policy to update.", + "location": "path", + "pattern": "(firewallPolicies/)?[0-9]{0,20}", + "required": true, + "type": "string" + }, + "priority": { + "description": "The priority of the rule to patch.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "requestId": { + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + } + }, + "path": "locations/global/firewallPolicies/{firewallPolicy}/patchPacketMirroringRule", + "request": { + "$ref": "FirewallPolicyRule" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + }, "patchRule": { "description": "Patches a rule of the specified priority.", "flatPath": "locations/global/firewallPolicies/{firewallPolicy}/patchRule", @@ -4142,6 +4249,43 @@ "https://www.googleapis.com/auth/compute" ] }, + "removePacketMirroringRule": { + "description": "Deletes a packet mirroring rule of the specified priority.", + "flatPath": "locations/global/firewallPolicies/{firewallPolicy}/removePacketMirroringRule", + "httpMethod": "POST", + "id": "compute.firewallPolicies.removePacketMirroringRule", + "parameterOrder": [ + "firewallPolicy" + ], + "parameters": { + "firewallPolicy": { + "description": "Name of the firewall policy to update.", + "location": "path", + "pattern": "(firewallPolicies/)?[0-9]{0,20}", + "required": true, + "type": "string" + }, + "priority": { + "description": "The priority of the rule to remove from the firewall policy.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "requestId": { + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + } + }, + "path": "locations/global/firewallPolicies/{firewallPolicy}/removePacketMirroringRule", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + }, "removeRule": { "description": "Deletes a rule of the specified priority.", "flatPath": "locations/global/firewallPolicies/{firewallPolicy}/removeRule", @@ -17184,6 +17328,60 @@ "https://www.googleapis.com/auth/compute" ] }, + "addPacketMirroringRule": { + "description": "Inserts a packet mirroring rule into a firewall policy.", + "flatPath": "projects/{project}/global/firewallPolicies/{firewallPolicy}/addPacketMirroringRule", + "httpMethod": "POST", + "id": "compute.networkFirewallPolicies.addPacketMirroringRule", + "parameterOrder": [ + "project", + "firewallPolicy" + ], + "parameters": { + "firewallPolicy": { + "description": "Name of the firewall policy to update.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "required": true, + "type": "string" + }, + "maxPriority": { + "description": "When rule.priority is not specified, auto choose a unused priority between minPriority and maxPriority>. This field is exclusive with rule.priority.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "minPriority": { + "description": "When rule.priority is not specified, auto choose a unused priority between minPriority and maxPriority>. This field is exclusive with rule.priority.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "requestId": { + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + } + }, + "path": "projects/{project}/global/firewallPolicies/{firewallPolicy}/addPacketMirroringRule", + "request": { + "$ref": "FirewallPolicyRule" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + }, "addRule": { "description": "Inserts a rule into a firewall policy.", "flatPath": "projects/{project}/global/firewallPolicies/{firewallPolicy}/addRule", @@ -17437,6 +17635,47 @@ "https://www.googleapis.com/auth/compute.readonly" ] }, + "getPacketMirroringRule": { + "description": "Gets a packet mirroring rule of the specified priority.", + "flatPath": "projects/{project}/global/firewallPolicies/{firewallPolicy}/getPacketMirroringRule", + "httpMethod": "GET", + "id": "compute.networkFirewallPolicies.getPacketMirroringRule", + "parameterOrder": [ + "project", + "firewallPolicy" + ], + "parameters": { + "firewallPolicy": { + "description": "Name of the firewall policy to which the queried rule belongs.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "required": true, + "type": "string" + }, + "priority": { + "description": "The priority of the rule to get from the firewall policy.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + } + }, + "path": "projects/{project}/global/firewallPolicies/{firewallPolicy}/getPacketMirroringRule", + "response": { + "$ref": "FirewallPolicyRule" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" + ] + }, "getRule": { "description": "Gets a rule of the specified priority.", "flatPath": "projects/{project}/global/firewallPolicies/{firewallPolicy}/getRule", @@ -17609,6 +17848,54 @@ "https://www.googleapis.com/auth/compute" ] }, + "patchPacketMirroringRule": { + "description": "Patches a packet mirroring rule of the specified priority.", + "flatPath": "projects/{project}/global/firewallPolicies/{firewallPolicy}/patchPacketMirroringRule", + "httpMethod": "POST", + "id": "compute.networkFirewallPolicies.patchPacketMirroringRule", + "parameterOrder": [ + "project", + "firewallPolicy" + ], + "parameters": { + "firewallPolicy": { + "description": "Name of the firewall policy to update.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "required": true, + "type": "string" + }, + "priority": { + "description": "The priority of the rule to patch.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "requestId": { + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + } + }, + "path": "projects/{project}/global/firewallPolicies/{firewallPolicy}/patchPacketMirroringRule", + "request": { + "$ref": "FirewallPolicyRule" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + }, "patchRule": { "description": "Patches a rule of the specified priority.", "flatPath": "projects/{project}/global/firewallPolicies/{firewallPolicy}/patchRule", @@ -17701,6 +17988,51 @@ "https://www.googleapis.com/auth/compute" ] }, + "removePacketMirroringRule": { + "description": "Deletes a packet mirroring rule of the specified priority.", + "flatPath": "projects/{project}/global/firewallPolicies/{firewallPolicy}/removePacketMirroringRule", + "httpMethod": "POST", + "id": "compute.networkFirewallPolicies.removePacketMirroringRule", + "parameterOrder": [ + "project", + "firewallPolicy" + ], + "parameters": { + "firewallPolicy": { + "description": "Name of the firewall policy to update.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "required": true, + "type": "string" + }, + "priority": { + "description": "The priority of the rule to remove from the firewall policy.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "requestId": { + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + } + }, + "path": "projects/{project}/global/firewallPolicies/{firewallPolicy}/removePacketMirroringRule", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + }, "removeRule": { "description": "Deletes a rule of the specified priority.", "flatPath": "projects/{project}/global/firewallPolicies/{firewallPolicy}/removeRule", @@ -31184,7 +31516,7 @@ "regions": { "methods": { "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.", + "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.", "flatPath": "projects/{project}/regions/{region}", "httpMethod": "GET", "id": "compute.regions.get", @@ -41579,7 +41911,7 @@ } } }, - "revision": "20240618", + "revision": "20240707", "rootUrl": "https://compute.googleapis.com/", "schemas": { "AWSV4Signature": { @@ -44904,7 +45236,8 @@ "GENERATED_COOKIE", "HEADER_FIELD", "HTTP_COOKIE", - "NONE" + "NONE", + "STRONG_COOKIE_AFFINITY" ], "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.", @@ -44914,10 +45247,15 @@ "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." + "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." ], "type": "string" }, + "strongSessionAffinityCookie": { + "$ref": "BackendServiceHttpCookie", + "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." + }, "subsetting": { "$ref": "Subsetting" }, @@ -44927,6 +45265,7 @@ "type": "integer" }, "usedBy": { + "description": "[Output Only] List of resources referencing given backend service.", "items": { "$ref": "BackendServiceUsedBy" }, @@ -45293,6 +45632,25 @@ }, "type": "object" }, + "BackendServiceHttpCookie": { + "description": "The HTTP cookie used for stateful session affinity.", + "id": "BackendServiceHttpCookie", + "properties": { + "name": { + "description": "Name of the cookie.", + "type": "string" + }, + "path": { + "description": "Path to set for the cookie.", + "type": "string" + }, + "ttl": { + "$ref": "Duration", + "description": "Lifetime of the cookie." + } + }, + "type": "object" + }, "BackendServiceIAP": { "description": "Identity-Aware Proxy", "id": "BackendServiceIAP", @@ -45729,6 +46087,7 @@ "id": "BackendServiceUsedBy", "properties": { "reference": { + "description": "[Output Only] Server-defined URL for resources referencing given BackendService like UrlMaps, TargetTcpProxies, TargetSslProxies and ForwardingRule.", "type": "string" } }, @@ -46586,6 +46945,7 @@ "COMPUTE_OPTIMIZED_C3D", "COMPUTE_OPTIMIZED_H3", "GENERAL_PURPOSE", + "GENERAL_PURPOSE_C4", "GENERAL_PURPOSE_E2", "GENERAL_PURPOSE_N2", "GENERAL_PURPOSE_N2D", @@ -46616,6 +46976,7 @@ "", "", "", + "", "" ], "type": "string" @@ -49848,6 +50209,13 @@ "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" }, + "packetMirroringRules": { + "description": "A list of packet mirroring rules that belong to this policy.", + "items": { + "$ref": "FirewallPolicyRule" + }, + "type": "array" + }, "parent": { "description": "[Output Only] The parent of the firewall policy. This field is not applicable to network firewall policies.", "type": "string" @@ -55330,8 +55698,7 @@ "type": "array" }, "baseInstanceName": { - "description": "The base instance name to use for instances in this group. The value must be 1-58 characters long. Instances are named by appending a hyphen and a random four-character string to the base instance name. The base instance name must comply with RFC1035.", - "pattern": "[a-z][-a-z0-9]{0,57}", + "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,52}-#{1,10}(\\\\[[0-9]{1,10}\\\\])?))", "type": "string" }, "creationTimestamp": { @@ -58756,6 +59123,11 @@ "description": "[Output Only] The name of the firewall policy.", "type": "string" }, + "priority": { + "description": "[Output only] Priority of firewall policy association. Not applicable for type=HIERARCHY.", + "format": "int32", + "type": "integer" + }, "rules": { "description": "The rules that apply to the network.", "items": { @@ -58773,9 +59145,13 @@ "HIERARCHY", "NETWORK", "NETWORK_REGIONAL", + "SYSTEM_GLOBAL", + "SYSTEM_REGIONAL", "UNSPECIFIED" ], "enumDescriptions": [ + "", + "", "", "", "", @@ -64659,12 +65035,6 @@ "format": "int32", "type": "integer" }, - "clientPort": { - "deprecated": true, - "description": "Represents the port number to which PSC consumer sends packets. Only valid for network endpoint groups created with CLIENT_PORT_PER_ENDPOINT mapping mode.", - "format": "int32", - "type": "integer" - }, "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" @@ -64704,19 +65074,6 @@ "$ref": "NetworkEndpointGroupAppEngine", "description": "Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set." }, - "clientPortMappingMode": { - "deprecated": true, - "description": "Only valid when networkEndpointType is GCE_VM_IP_PORT and the NEG is regional.", - "enum": [ - "CLIENT_PORT_PER_ENDPOINT", - "PORT_MAPPING_DISABLED" - ], - "enumDescriptions": [ - "For each endpoint there is exactly one client port.", - "NEG should not be used for mapping client port to destination." - ], - "type": "string" - }, "cloudFunction": { "$ref": "NetworkEndpointGroupCloudFunction", "description": "Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set." @@ -73434,6 +73791,11 @@ "description": "[Output Only] The name of the firewall policy.", "type": "string" }, + "priority": { + "description": "[Output only] Priority of firewall policy association. Not applicable for type=HIERARCHY.", + "format": "int32", + "type": "integer" + }, "rules": { "description": "The rules that apply to the network.", "items": { @@ -73447,9 +73809,13 @@ "HIERARCHY", "NETWORK", "NETWORK_REGIONAL", + "SYSTEM_GLOBAL", + "SYSTEM_REGIONAL", "UNSPECIFIED" ], "enumDescriptions": [ + "", + "", "", "", "", @@ -75020,6 +75386,11 @@ "ResourceStatusScheduling": { "id": "ResourceStatusScheduling", "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.", + "format": "int32", + "type": "integer" + }, "terminationTimestamp": { "description": "Time in future when the instance will be terminated in RFC3339 text format.", "type": "string" @@ -77646,6 +78017,11 @@ "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" }, + "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.", + "format": "int32", + "type": "integer" + }, "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.", "format": "int32", @@ -86364,7 +86740,8 @@ "GENERATED_COOKIE", "HEADER_FIELD", "HTTP_COOKIE", - "NONE" + "NONE", + "STRONG_COOKIE_AFFINITY" ], "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.", @@ -86374,7 +86751,8 @@ "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." + "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." ], "type": "string" } @@ -89651,7 +90029,7 @@ "type": "string" }, "stackType": { - "description": "The stack type for this VPN gateway to identify the IP protocols that are enabled. Possible values are: IPV4_ONLY, IPV4_IPV6. If not specified, IPV4_ONLY will be used.", + "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.", "enum": [ "IPV4_IPV6", "IPV4_ONLY", diff --git a/discovery/compute-v1.json b/discovery/compute-v1.json index 9518b041c9..937a1faa10 100644 --- a/discovery/compute-v1.json +++ b/discovery/compute-v1.json @@ -27980,7 +27980,7 @@ "regions": { "methods": { "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.", + "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.", "flatPath": "projects/{project}/regions/{region}", "httpMethod": "GET", "id": "compute.regions.get", @@ -37421,7 +37421,7 @@ } } }, - "revision": "20240618", + "revision": "20240707", "rootUrl": "https://compute.googleapis.com/", "schemas": { "AWSV4Signature": { @@ -40687,6 +40687,7 @@ "type": "integer" }, "usedBy": { + "description": "[Output Only] List of resources referencing given backend service.", "items": { "$ref": "BackendServiceUsedBy" }, @@ -41489,6 +41490,7 @@ "id": "BackendServiceUsedBy", "properties": { "reference": { + "description": "[Output Only] Server-defined URL for resources referencing given BackendService like UrlMaps, TargetTcpProxies, TargetSslProxies and ForwardingRule.", "type": "string" } }, @@ -42242,6 +42244,7 @@ "COMPUTE_OPTIMIZED_C3D", "COMPUTE_OPTIMIZED_H3", "GENERAL_PURPOSE", + "GENERAL_PURPOSE_C4", "GENERAL_PURPOSE_E2", "GENERAL_PURPOSE_N2", "GENERAL_PURPOSE_N2D", @@ -42272,6 +42275,7 @@ "", "", "", + "", "" ], "type": "string" @@ -50039,8 +50043,7 @@ "type": "array" }, "baseInstanceName": { - "description": "The base instance name to use for instances in this group. The value must be 1-58 characters long. Instances are named by appending a hyphen and a random four-character string to the base instance name. The base instance name must comply with RFC1035.", - "pattern": "[a-z][-a-z0-9]{0,57}", + "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,52}-#{1,10}(\\\\[[0-9]{1,10}\\\\])?))", "type": "string" }, "creationTimestamp": { @@ -71222,6 +71225,11 @@ "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" }, + "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.", + "format": "int32", + "type": "integer" + }, "instanceTerminationAction": { "description": "Specifies the termination action for the instance.", "enum": [ @@ -82684,7 +82692,7 @@ "type": "string" }, "stackType": { - "description": "The stack type for this VPN gateway to identify the IP protocols that are enabled. Possible values are: IPV4_ONLY, IPV4_IPV6. If not specified, IPV4_ONLY will be used.", + "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.", "enum": [ "IPV4_IPV6", "IPV4_ONLY", diff --git a/discovery/connectors-v1.json b/discovery/connectors-v1.json index 26acbb8389..458d4968c0 100644 --- a/discovery/connectors-v1.json +++ b/discovery/connectors-v1.json @@ -2427,7 +2427,7 @@ } } }, - "revision": "20240625", + "revision": "20240708", "rootUrl": "https://connectors.googleapis.com/", "schemas": { "AuditConfig": { @@ -2600,7 +2600,7 @@ }, "omitQueryParams": { "description": "Optional. Omit query params from the redirect URI.", - "type": "string" + "type": "boolean" }, "scopes": { "description": "The scopes for which the user will authorize Google Cloud Connectors on the connector data source.", @@ -5892,7 +5892,7 @@ "type": "array" }, "valueSeparator": { - "description": "Required. Value separator.", + "description": "Required. Value separator. Only \",\" can be used for OAuth auth code flow scope field.", "type": "string" } }, @@ -6536,6 +6536,10 @@ ], "type": "string" }, + "defaultValue": { + "description": "The following field specifies the default value of the Parameter provided by the external system if a value is not provided.", + "type": "any" + }, "description": { "description": "A brief description of the field.", "type": "string" @@ -6547,6 +6551,10 @@ "jsonSchema": { "$ref": "JsonSchema", "description": "JsonSchema representation of this action's result" + }, + "nullable": { + "description": "Specifies whether a null value is allowed.", + "type": "boolean" } }, "type": "object" diff --git a/discovery/connectors-v2.json b/discovery/connectors-v2.json index 1da3a38be4..298e7636f8 100644 --- a/discovery/connectors-v2.json +++ b/discovery/connectors-v2.json @@ -660,7 +660,7 @@ } } }, - "revision": "20240619", + "revision": "20240708", "rootUrl": "https://connectors.googleapis.com/", "schemas": { "AccessCredentials": { @@ -2269,6 +2269,10 @@ ], "type": "string" }, + "defaultValue": { + "description": "The following field specifies the default value of the Parameter provided by the external system if a value is not provided.", + "type": "any" + }, "description": { "description": "A brief description of the metadata field.", "type": "string" @@ -2280,6 +2284,10 @@ "name": { "description": "Name of the metadata field.", "type": "string" + }, + "nullable": { + "description": "Specifies whether a null value is allowed.", + "type": "boolean" } }, "type": "object" diff --git a/discovery/contactcenterinsights-v1.json b/discovery/contactcenterinsights-v1.json index 7d799fe621..68454e646b 100644 --- a/discovery/contactcenterinsights-v1.json +++ b/discovery/contactcenterinsights-v1.json @@ -1474,7 +1474,7 @@ } } }, - "revision": "20240624", + "revision": "20240708", "rootUrl": "https://contactcenterinsights.googleapis.com/", "schemas": { "GoogleCloudContactcenterinsightsV1Analysis": { @@ -3806,6 +3806,20 @@ "query": { "description": "Query text. Article Search uses this to store the input query used to generate the search results.", "type": "string" + }, + "querySource": { + "description": "Query source for the answer.", + "enum": [ + "QUERY_SOURCE_UNSPECIFIED", + "AGENT_QUERY", + "SUGGESTED_QUERY" + ], + "enumDescriptions": [ + "Unknown query source.", + "The query is from agents.", + "The query is a query from previous suggestions, e.g. from a preceding SuggestKnowledgeAssist response." + ], + "type": "string" } }, "type": "object" @@ -6037,6 +6051,20 @@ "query": { "description": "Query text. Article Search uses this to store the input query used to generate the search results.", "type": "string" + }, + "querySource": { + "description": "Query source for the answer.", + "enum": [ + "QUERY_SOURCE_UNSPECIFIED", + "AGENT_QUERY", + "SUGGESTED_QUERY" + ], + "enumDescriptions": [ + "Unknown query source.", + "The query is from agents.", + "The query is a query from previous suggestions, e.g. from a preceding SuggestKnowledgeAssist response." + ], + "type": "string" } }, "type": "object" diff --git a/discovery/container-v1.json b/discovery/container-v1.json index 713284b93e..7e67fc14a3 100644 --- a/discovery/container-v1.json +++ b/discovery/container-v1.json @@ -2540,7 +2540,7 @@ } } }, - "revision": "20240608", + "revision": "20240619", "rootUrl": "https://container.googleapis.com/", "schemas": { "AcceleratorConfig": { @@ -2592,14 +2592,14 @@ "properties": { "maxPodsPerNode": { "$ref": "MaxPodsConstraint", - "description": "The maximum number of pods per node which use this pod network" + "description": "The maximum number of pods per node which use this pod network." }, "secondaryPodRange": { - "description": "The name of the secondary range on the subnet which provides IP address for this pod range", + "description": "The name of the secondary range on the subnet which provides IP address for this pod range.", "type": "string" }, "subnetwork": { - "description": "Name of the subnetwork where the additional pod network belongs", + "description": "Name of the subnetwork where the additional pod network belongs.", "type": "string" } }, @@ -2676,6 +2676,10 @@ "$ref": "NetworkPolicyConfig", "description": "Configuration for NetworkPolicy. This only tracks whether the addon is enabled or not on the Master, it does not track whether network policy is enabled for the nodes." }, + "rayOperatorConfig": { + "$ref": "RayOperatorConfig", + "description": "Optional. Configuration for Ray Operator addon." + }, "statefulHaConfig": { "$ref": "StatefulHAConfig", "description": "Optional. Configuration for the StatefulHA add-on." @@ -6272,6 +6276,47 @@ }, "type": "object" }, + "RayClusterLoggingConfig": { + "description": "RayClusterLoggingConfig specifies configuration of Ray logging.", + "id": "RayClusterLoggingConfig", + "properties": { + "enabled": { + "description": "Enable log collection for Ray clusters.", + "type": "boolean" + } + }, + "type": "object" + }, + "RayClusterMonitoringConfig": { + "description": "RayClusterMonitoringConfig specifies monitoring configuration for Ray clusters.", + "id": "RayClusterMonitoringConfig", + "properties": { + "enabled": { + "description": "Enable metrics collection for Ray clusters.", + "type": "boolean" + } + }, + "type": "object" + }, + "RayOperatorConfig": { + "description": "Configuration options for the Ray Operator add-on.", + "id": "RayOperatorConfig", + "properties": { + "enabled": { + "description": "Whether the Ray Operator addon is enabled for this cluster.", + "type": "boolean" + }, + "rayClusterLoggingConfig": { + "$ref": "RayClusterLoggingConfig", + "description": "Optional. Logging configuration for Ray clusters." + }, + "rayClusterMonitoringConfig": { + "$ref": "RayClusterMonitoringConfig", + "description": "Optional. Monitoring configuration for Ray clusters." + } + }, + "type": "object" + }, "RecurringTimeWindow": { "description": "Represents an arbitrary window of time that recurs.", "id": "RecurringTimeWindow", diff --git a/discovery/container-v1beta1.json b/discovery/container-v1beta1.json index 5812847424..b6694b1efc 100644 --- a/discovery/container-v1beta1.json +++ b/discovery/container-v1beta1.json @@ -2565,7 +2565,7 @@ } } }, - "revision": "20240618", + "revision": "20240619", "rootUrl": "https://container.googleapis.com/", "schemas": { "AcceleratorConfig": { @@ -2717,6 +2717,10 @@ "$ref": "NetworkPolicyConfig", "description": "Configuration for NetworkPolicy. This only tracks whether the addon is enabled or not on the Master, it does not track whether network policy is enabled for the nodes." }, + "rayOperatorConfig": { + "$ref": "RayOperatorConfig", + "description": "Optional. Configuration for Ray Operator addon." + }, "statefulHaConfig": { "$ref": "StatefulHAConfig", "description": "Optional. Configuration for the StatefulHA add-on." @@ -6792,6 +6796,47 @@ }, "type": "object" }, + "RayClusterLoggingConfig": { + "description": "RayClusterLoggingConfig specifies logging configuration for Ray clusters.", + "id": "RayClusterLoggingConfig", + "properties": { + "enabled": { + "description": "Enable log collection for Ray clusters.", + "type": "boolean" + } + }, + "type": "object" + }, + "RayClusterMonitoringConfig": { + "description": "RayClusterMonitoringConfig specifies monitoring configuration for Ray clusters.", + "id": "RayClusterMonitoringConfig", + "properties": { + "enabled": { + "description": "Enable metrics collection for Ray clusters.", + "type": "boolean" + } + }, + "type": "object" + }, + "RayOperatorConfig": { + "description": "Configuration options for the Ray Operator add-on.", + "id": "RayOperatorConfig", + "properties": { + "enabled": { + "description": "Whether the Ray addon is enabled for this cluster.", + "type": "boolean" + }, + "rayClusterLoggingConfig": { + "$ref": "RayClusterLoggingConfig", + "description": "Optional. Logging configuration for Ray clusters." + }, + "rayClusterMonitoringConfig": { + "$ref": "RayClusterMonitoringConfig", + "description": "Optional. Monitoring configuration for Ray clusters." + } + }, + "type": "object" + }, "RecurringTimeWindow": { "description": "Represents an arbitrary window of time that recurs.", "id": "RecurringTimeWindow", diff --git a/discovery/containeranalysis-v1.json b/discovery/containeranalysis-v1.json index 3fd786e2ff..6950404e88 100644 --- a/discovery/containeranalysis-v1.json +++ b/discovery/containeranalysis-v1.json @@ -17,8 +17,8 @@ "documentationLink": "https://cloud.google.com/container-analysis/api/reference/rest/", "endpoints": [ { - "description": "Regional Endpoint", "endpointUrl": "https://containeranalysis.me-central2.rep.googleapis.com/", + "description": "Regional Endpoint", "location": "me-central2" } ], @@ -1072,7 +1072,7 @@ } } }, - "revision": "20240625", + "revision": "20240704", "rootUrl": "https://containeranalysis.googleapis.com/", "schemas": { "AliasContext": { @@ -2968,26 +2968,6 @@ }, "type": "object" }, - "ContaineranalysisGoogleDevtoolsCloudbuildV1GCSLocation": { - "description": "Represents a storage location in Cloud Storage", - "id": "ContaineranalysisGoogleDevtoolsCloudbuildV1GCSLocation", - "properties": { - "bucket": { - "description": "Cloud Storage bucket. See https://cloud.google.com/storage/docs/naming#requirements", - "type": "string" - }, - "generation": { - "description": "Cloud Storage generation for the object. If the generation is omitted, the latest generation will be used.", - "format": "int64", - "type": "string" - }, - "object": { - "description": "Cloud Storage object. See https://cloud.google.com/storage/docs/naming#objectnames", - "type": "string" - } - }, - "type": "object" - }, "ContaineranalysisGoogleDevtoolsCloudbuildV1GitConfig": { "description": "GitConfig is a configuration for git operations.", "id": "ContaineranalysisGoogleDevtoolsCloudbuildV1GitConfig", @@ -3004,12 +2984,8 @@ "id": "ContaineranalysisGoogleDevtoolsCloudbuildV1GitConfigHttpConfig", "properties": { "proxySecretVersionName": { - "description": "SecretVersion resource of the HTTP proxy URL. The proxy URL should be in format protocol://@]proxyhost[:port].", + "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" - }, - "proxySslCaInfo": { - "$ref": "ContaineranalysisGoogleDevtoolsCloudbuildV1GCSLocation", - "description": "Optional. Cloud Storage object storing the certificate to use with the HTTP proxy." } }, "type": "object" @@ -3748,10 +3724,6 @@ "sbomStatus": { "$ref": "SBOMStatus", "description": "The status of an SBOM generation." - }, - "vulnerabilityAttestation": { - "$ref": "VulnerabilityAttestation", - "description": "The status of an vulnerability attestation generation." } }, "type": "object" @@ -5905,36 +5877,6 @@ }, "type": "object" }, - "VulnerabilityAttestation": { - "description": "The status of an vulnerability attestation generation.", - "id": "VulnerabilityAttestation", - "properties": { - "error": { - "description": "If failure, the error reason for why the attestation generation failed.", - "type": "string" - }, - "lastAttemptTime": { - "description": "The last time we attempted to generate an attestation.", - "format": "google-datetime", - "type": "string" - }, - "state": { - "description": "The success/failure state of the latest attestation attempt.", - "enum": [ - "VULNERABILITY_ATTESTATION_STATE_UNSPECIFIED", - "SUCCESS", - "FAILURE" - ], - "enumDescriptions": [ - "Default unknown state.", - "Attestation was successfully generated and stored.", - "Attestation was unsuccessfully generated and stored." - ], - "type": "string" - } - }, - "type": "object" - }, "VulnerabilityNote": { "description": "A security vulnerability that can be found in resources.", "id": "VulnerabilityNote", diff --git a/discovery/containeranalysis-v1alpha1.json b/discovery/containeranalysis-v1alpha1.json index 3de1414253..36411cc2d5 100644 --- a/discovery/containeranalysis-v1alpha1.json +++ b/discovery/containeranalysis-v1alpha1.json @@ -1240,7 +1240,7 @@ } } }, - "revision": "20240625", + "revision": "20240704", "rootUrl": "https://containeranalysis.googleapis.com/", "schemas": { "AnalysisCompleted": { @@ -2942,26 +2942,6 @@ }, "type": "object" }, - "ContaineranalysisGoogleDevtoolsCloudbuildV1GCSLocation": { - "description": "Represents a storage location in Cloud Storage", - "id": "ContaineranalysisGoogleDevtoolsCloudbuildV1GCSLocation", - "properties": { - "bucket": { - "description": "Cloud Storage bucket. See https://cloud.google.com/storage/docs/naming#requirements", - "type": "string" - }, - "generation": { - "description": "Cloud Storage generation for the object. If the generation is omitted, the latest generation will be used.", - "format": "int64", - "type": "string" - }, - "object": { - "description": "Cloud Storage object. See https://cloud.google.com/storage/docs/naming#objectnames", - "type": "string" - } - }, - "type": "object" - }, "ContaineranalysisGoogleDevtoolsCloudbuildV1GitConfig": { "description": "GitConfig is a configuration for git operations.", "id": "ContaineranalysisGoogleDevtoolsCloudbuildV1GitConfig", @@ -2978,12 +2958,8 @@ "id": "ContaineranalysisGoogleDevtoolsCloudbuildV1GitConfigHttpConfig", "properties": { "proxySecretVersionName": { - "description": "SecretVersion resource of the HTTP proxy URL. The proxy URL should be in format protocol://@]proxyhost[:port].", + "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" - }, - "proxySslCaInfo": { - "$ref": "ContaineranalysisGoogleDevtoolsCloudbuildV1GCSLocation", - "description": "Optional. Cloud Storage object storing the certificate to use with the HTTP proxy." } }, "type": "object" diff --git a/discovery/containeranalysis-v1beta1.json b/discovery/containeranalysis-v1beta1.json index 630b59af54..45d2a6c66b 100644 --- a/discovery/containeranalysis-v1beta1.json +++ b/discovery/containeranalysis-v1beta1.json @@ -1128,7 +1128,7 @@ } } }, - "revision": "20240625", + "revision": "20240704", "rootUrl": "https://containeranalysis.googleapis.com/", "schemas": { "AliasContext": { @@ -2924,26 +2924,6 @@ }, "type": "object" }, - "ContaineranalysisGoogleDevtoolsCloudbuildV1GCSLocation": { - "description": "Represents a storage location in Cloud Storage", - "id": "ContaineranalysisGoogleDevtoolsCloudbuildV1GCSLocation", - "properties": { - "bucket": { - "description": "Cloud Storage bucket. See https://cloud.google.com/storage/docs/naming#requirements", - "type": "string" - }, - "generation": { - "description": "Cloud Storage generation for the object. If the generation is omitted, the latest generation will be used.", - "format": "int64", - "type": "string" - }, - "object": { - "description": "Cloud Storage object. See https://cloud.google.com/storage/docs/naming#objectnames", - "type": "string" - } - }, - "type": "object" - }, "ContaineranalysisGoogleDevtoolsCloudbuildV1GitConfig": { "description": "GitConfig is a configuration for git operations.", "id": "ContaineranalysisGoogleDevtoolsCloudbuildV1GitConfig", @@ -2960,12 +2940,8 @@ "id": "ContaineranalysisGoogleDevtoolsCloudbuildV1GitConfigHttpConfig", "properties": { "proxySecretVersionName": { - "description": "SecretVersion resource of the HTTP proxy URL. The proxy URL should be in format protocol://@]proxyhost[:port].", + "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" - }, - "proxySslCaInfo": { - "$ref": "ContaineranalysisGoogleDevtoolsCloudbuildV1GCSLocation", - "description": "Optional. Cloud Storage object storing the certificate to use with the HTTP proxy." } }, "type": "object" diff --git a/discovery/css-v1.json b/discovery/css-v1.json new file mode 100644 index 0000000000..50e1f668eb --- /dev/null +++ b/discovery/css-v1.json @@ -0,0 +1,1216 @@ +{ + "auth": { + "oauth2": { + "scopes": { + "https://www.googleapis.com/auth/content": { + "description": "Manage your product listings and accounts for Google Shopping" + } + } + } + }, + "basePath": "", + "baseUrl": "https://css.googleapis.com/", + "batchPath": "batch", + "canonicalName": "Css", + "description": "Programmatically manage your Comparison Shopping Service (CSS) account data at scale.", + "discoveryVersion": "v1", + "documentationLink": "https://developers.google.com/comparison-shopping-services/api/overview", + "fullyEncodeReservedExpansion": true, + "icons": { + "x16": "http://www.google.com/images/icons/product/search-16.gif", + "x32": "http://www.google.com/images/icons/product/search-32.gif" + }, + "id": "css:v1", + "kind": "discovery#restDescription", + "mtlsRootUrl": "https://css.mtls.googleapis.com/", + "name": "css", + "ownerDomain": "google.com", + "ownerName": "Google", + "parameters": { + "$.xgafv": { + "description": "V1 error format.", + "enum": [ + "1", + "2" + ], + "enumDescriptions": [ + "v1 error format", + "v2 error format" + ], + "location": "query", + "type": "string" + }, + "access_token": { + "description": "OAuth access token.", + "location": "query", + "type": "string" + }, + "alt": { + "default": "json", + "description": "Data format for response.", + "enum": [ + "json", + "media", + "proto" + ], + "enumDescriptions": [ + "Responses with Content-Type of application/json", + "Media download with context-dependent Content-Type", + "Responses with Content-Type of application/x-protobuf" + ], + "location": "query", + "type": "string" + }, + "callback": { + "description": "JSONP", + "location": "query", + "type": "string" + }, + "fields": { + "description": "Selector specifying which fields to include in a partial response.", + "location": "query", + "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.", + "location": "query", + "type": "string" + }, + "oauth_token": { + "description": "OAuth 2.0 token for the current user.", + "location": "query", + "type": "string" + }, + "prettyPrint": { + "default": "true", + "description": "Returns response with indentations and line breaks.", + "location": "query", + "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.", + "location": "query", + "type": "string" + }, + "uploadType": { + "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", + "location": "query", + "type": "string" + }, + "upload_protocol": { + "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", + "location": "query", + "type": "string" + } + }, + "protocol": "rest", + "resources": { + "accounts": { + "methods": { + "get": { + "description": "Retrieves a single CSS/MC account by ID.", + "flatPath": "v1/accounts/{accountsId}", + "httpMethod": "GET", + "id": "css.accounts.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the managed CSS/MC account. Format: accounts/{account}", + "location": "path", + "pattern": "^accounts/[^/]+$", + "required": true, + "type": "string" + }, + "parent": { + "description": "Optional. Only required when retrieving MC account information. The CSS domain that is the parent resource of the MC account. Format: accounts/{account}", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "Account" + }, + "scopes": [ + "https://www.googleapis.com/auth/content" + ] + }, + "listChildAccounts": { + "description": "Lists all the accounts under the specified CSS account ID, and optionally filters by label ID and account name.", + "flatPath": "v1/accounts/{accountsId}:listChildAccounts", + "httpMethod": "GET", + "id": "css.accounts.listChildAccounts", + "parameterOrder": [ + "parent" + ], + "parameters": { + "fullName": { + "description": "If set, only the MC accounts with the given name (case sensitive) will be returned.", + "location": "query", + "type": "string" + }, + "labelId": { + "description": "If set, only the MC accounts with the given label ID will be returned.", + "format": "int64", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. The maximum number of accounts to return. The service may return fewer than this value. If unspecified, at most 50 accounts will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. A page token, received from a previous `ListChildAccounts` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListChildAccounts` must match the call that provided the page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent account. Must be a CSS group or domain. Format: accounts/{account}", + "location": "path", + "pattern": "^accounts/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}:listChildAccounts", + "response": { + "$ref": "ListChildAccountsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/content" + ] + }, + "updateLabels": { + "description": "Updates labels assigned to CSS/MC accounts by a CSS domain.", + "flatPath": "v1/accounts/{accountsId}:updateLabels", + "httpMethod": "POST", + "id": "css.accounts.updateLabels", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The label resource name. Format: accounts/{account}", + "location": "path", + "pattern": "^accounts/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:updateLabels", + "request": { + "$ref": "UpdateAccountLabelsRequest" + }, + "response": { + "$ref": "Account" + }, + "scopes": [ + "https://www.googleapis.com/auth/content" + ] + } + }, + "resources": { + "cssProductInputs": { + "methods": { + "delete": { + "description": "Deletes a CSS Product input from your CSS Center account. After a delete it may take several minutes until the input is no longer available.", + "flatPath": "v1/accounts/{accountsId}/cssProductInputs/{cssProductInputsId}", + "httpMethod": "DELETE", + "id": "css.accounts.cssProductInputs.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the CSS product input resource to delete. Format: accounts/{account}/cssProductInputs/{css_product_input}", + "location": "path", + "pattern": "^accounts/[^/]+/cssProductInputs/[^/]+$", + "required": true, + "type": "string" + }, + "supplementalFeedId": { + "description": "The Content API Supplemental Feed ID. The field must not be set if the action applies to a primary feed. If the field is set, then product action applies to a supplemental feed instead of primary Content API feed.", + "format": "int64", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "Empty" + }, + "scopes": [ + "https://www.googleapis.com/auth/content" + ] + }, + "insert": { + "description": "Uploads a CssProductInput to your CSS Center account. If an input with the same contentLanguage, identity, feedLabel and feedId already exists, this method replaces that entry. After inserting, updating, or deleting a CSS Product input, it may take several minutes before the processed CSS Product can be retrieved.", + "flatPath": "v1/accounts/{accountsId}/cssProductInputs:insert", + "httpMethod": "POST", + "id": "css.accounts.cssProductInputs.insert", + "parameterOrder": [ + "parent" + ], + "parameters": { + "feedId": { + "description": "Required. The primary or supplemental feed id. If CSS Product already exists and feed id provided is different, then the CSS Product will be moved to a new feed. Note: For now, CSSs do not need to provide feed ids as we create feeds on the fly. We do not have supplemental feed support for CSS Products yet.", + "format": "int64", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The account where this CSS Product will be inserted. Format: accounts/{account}", + "location": "path", + "pattern": "^accounts/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/cssProductInputs:insert", + "request": { + "$ref": "CssProductInput" + }, + "response": { + "$ref": "CssProductInput" + }, + "scopes": [ + "https://www.googleapis.com/auth/content" + ] + } + } + }, + "cssProducts": { + "methods": { + "get": { + "description": "Retrieves the processed CSS Product from your CSS Center account. After inserting, updating, or deleting a product input, it may take several minutes before the updated final product can be retrieved.", + "flatPath": "v1/accounts/{accountsId}/cssProducts/{cssProductsId}", + "httpMethod": "GET", + "id": "css.accounts.cssProducts.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the CSS product to retrieve.", + "location": "path", + "pattern": "^accounts/[^/]+/cssProducts/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "CssProduct" + }, + "scopes": [ + "https://www.googleapis.com/auth/content" + ] + }, + "list": { + "description": "Lists the processed CSS Products in your CSS Center account. The response might contain fewer items than specified by pageSize. Rely on pageToken to determine if there are more items to be requested. After inserting, updating, or deleting a CSS product input, it may take several minutes before the updated processed CSS product can be retrieved.", + "flatPath": "v1/accounts/{accountsId}/cssProducts", + "httpMethod": "GET", + "id": "css.accounts.cssProducts.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "The maximum number of CSS Products to return. The service may return fewer than this value. The maximum value is 1000; values above 1000 will be coerced to 1000. If unspecified, the maximum number of CSS products will be returned.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A page token, received from a previous `ListCssProducts` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListCssProducts` must match the call that provided the page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The account/domain to list processed CSS Products for. Format: accounts/{account}", + "location": "path", + "pattern": "^accounts/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/cssProducts", + "response": { + "$ref": "ListCssProductsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/content" + ] + } + } + }, + "labels": { + "methods": { + "create": { + "description": "Creates a new label, not assigned to any account.", + "flatPath": "v1/accounts/{accountsId}/labels", + "httpMethod": "POST", + "id": "css.accounts.labels.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The parent account. Format: accounts/{account}", + "location": "path", + "pattern": "^accounts/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/labels", + "request": { + "$ref": "AccountLabel" + }, + "response": { + "$ref": "AccountLabel" + }, + "scopes": [ + "https://www.googleapis.com/auth/content" + ] + }, + "delete": { + "description": "Deletes a label and removes it from all accounts to which it was assigned.", + "flatPath": "v1/accounts/{accountsId}/labels/{labelsId}", + "httpMethod": "DELETE", + "id": "css.accounts.labels.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the label to delete. Format: accounts/{account}/labels/{label}", + "location": "path", + "pattern": "^accounts/[^/]+/labels/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "Empty" + }, + "scopes": [ + "https://www.googleapis.com/auth/content" + ] + }, + "list": { + "description": "Lists the labels assigned to an account.", + "flatPath": "v1/accounts/{accountsId}/labels", + "httpMethod": "GET", + "id": "css.accounts.labels.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "The maximum number of labels to return. The service may return fewer than this value. If unspecified, at most 50 labels will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A page token, received from a previous `ListAccountLabels` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAccountLabels` must match the call that provided the page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent account. Format: accounts/{account}", + "location": "path", + "pattern": "^accounts/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/labels", + "response": { + "$ref": "ListAccountLabelsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/content" + ] + }, + "patch": { + "description": "Updates a label.", + "flatPath": "v1/accounts/{accountsId}/labels/{labelsId}", + "httpMethod": "PATCH", + "id": "css.accounts.labels.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The resource name of the label. Format: accounts/{account}/labels/{label}", + "location": "path", + "pattern": "^accounts/[^/]+/labels/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "request": { + "$ref": "AccountLabel" + }, + "response": { + "$ref": "AccountLabel" + }, + "scopes": [ + "https://www.googleapis.com/auth/content" + ] + } + } + } + } + } + }, + "revision": "20240712", + "rootUrl": "https://css.googleapis.com/", + "schemas": { + "Account": { + "description": "Information about CSS/MC account.", + "id": "Account", + "properties": { + "accountType": { + "description": "Output only. The type of this account.", + "enum": [ + "ACCOUNT_TYPE_UNSPECIFIED", + "CSS_GROUP", + "CSS_DOMAIN", + "MC_PRIMARY_CSS_MCA", + "MC_CSS_MCA", + "MC_MARKETPLACE_MCA", + "MC_OTHER_MCA", + "MC_STANDALONE", + "MC_MCA_SUBACCOUNT" + ], + "enumDescriptions": [ + "Unknown account type.", + "CSS group account.", + "CSS domain account.", + "MC Primary CSS MCA account.", + "MC CSS MCA account.", + "MC Marketplace MCA account.", + "MC Other MCA account.", + "MC Standalone account.", + "MC MCA sub-account." + ], + "readOnly": true, + "type": "string" + }, + "automaticLabelIds": { + "description": "Automatically created label IDs assigned to the MC account by CSS Center.", + "items": { + "format": "int64", + "type": "string" + }, + "type": "array" + }, + "displayName": { + "description": "The CSS/MC account's short display name.", + "type": "string" + }, + "fullName": { + "description": "Output only. Immutable. The CSS/MC account's full name.", + "readOnly": true, + "type": "string" + }, + "homepageUri": { + "description": "Output only. Immutable. The CSS/MC account's homepage.", + "readOnly": true, + "type": "string" + }, + "labelIds": { + "description": "Manually created label IDs assigned to the CSS/MC account by a CSS parent account.", + "items": { + "format": "int64", + "type": "string" + }, + "type": "array" + }, + "name": { + "description": "The label resource name. Format: accounts/{account}", + "type": "string" + }, + "parent": { + "description": "The CSS/MC account's parent resource. CSS group for CSS domains; CSS domain for MC accounts. Returned only if the user has access to the parent account.", + "type": "string" + } + }, + "type": "object" + }, + "AccountLabel": { + "description": "Label assigned by CSS domain or CSS group to one of its sub-accounts.", + "id": "AccountLabel", + "properties": { + "accountId": { + "description": "Output only. The ID of account this label belongs to.", + "format": "int64", + "readOnly": true, + "type": "string" + }, + "description": { + "description": "The description of this label.", + "type": "string" + }, + "displayName": { + "description": "The display name of this label.", + "type": "string" + }, + "labelId": { + "description": "Output only. The ID of the label.", + "format": "int64", + "readOnly": true, + "type": "string" + }, + "labelType": { + "description": "Output only. The type of this label.", + "enum": [ + "LABEL_TYPE_UNSPECIFIED", + "MANUAL", + "AUTOMATIC" + ], + "enumDescriptions": [ + "Unknown label type.", + "Indicates that the label was created manually.", + "Indicates that the label was created automatically by CSS Center." + ], + "readOnly": true, + "type": "string" + }, + "name": { + "description": "The resource name of the label. Format: accounts/{account}/labels/{label}", + "type": "string" + } + }, + "type": "object" + }, + "Attributes": { + "description": "Attributes for CSS Product.", + "id": "Attributes", + "properties": { + "additionalImageLinks": { + "description": "Additional URL of images of the item.", + "items": { + "type": "string" + }, + "type": "array" + }, + "adult": { + "description": "Set to true if the item is targeted towards adults.", + "type": "boolean" + }, + "ageGroup": { + "description": "Target age group of the item.", + "type": "string" + }, + "brand": { + "description": "Product Related Attributes.[14-36] Brand of the item.", + "type": "string" + }, + "certifications": { + "description": "A list of certificates claimed by the CSS for the given product.", + "items": { + "$ref": "Certification" + }, + "type": "array" + }, + "color": { + "description": "Color of the item.", + "type": "string" + }, + "cppAdsRedirect": { + "description": "Allows advertisers to override the item URL when the product is shown within the context of Product Ads.", + "type": "string" + }, + "cppLink": { + "description": "URL directly linking to your the Product Detail Page of the CSS.", + "type": "string" + }, + "cppMobileLink": { + "description": "URL for the mobile-optimized version of the Product Detail Page of the CSS.", + "type": "string" + }, + "customLabel0": { + "description": "Custom label 0 for custom grouping of items in a Shopping campaign.", + "type": "string" + }, + "customLabel1": { + "description": "Custom label 1 for custom grouping of items in a Shopping campaign.", + "type": "string" + }, + "customLabel2": { + "description": "Custom label 2 for custom grouping of items in a Shopping campaign.", + "type": "string" + }, + "customLabel3": { + "description": "Custom label 3 for custom grouping of items in a Shopping campaign.", + "type": "string" + }, + "customLabel4": { + "description": "Custom label 4 for custom grouping of items in a Shopping campaign.", + "type": "string" + }, + "description": { + "description": "Description of the item.", + "type": "string" + }, + "excludedDestinations": { + "description": "The list of destinations to exclude for this target (corresponds to unchecked check boxes in Merchant Center).", + "items": { + "type": "string" + }, + "type": "array" + }, + "expirationDate": { + "description": "Date on which the item should expire, as specified upon insertion, in [ISO 8601](http://en.wikipedia.org/wiki/ISO_8601) format. The actual expiration date is exposed in `productstatuses` as [googleExpirationDate](https://support.google.com/merchants/answer/6324499) and might be earlier if `expirationDate` is too far in the future. Note: It may take 2+ days from the expiration date for the item to actually get deleted.", + "format": "google-datetime", + "type": "string" + }, + "gender": { + "description": "Target gender of the item.", + "type": "string" + }, + "googleProductCategory": { + "description": "Google's category of the item (see [Google product taxonomy](https://support.google.com/merchants/answer/1705911)). When querying products, this field will contain the user provided value. There is currently no way to get back the auto assigned google product categories through the API.", + "type": "string" + }, + "gtin": { + "description": "Global Trade Item Number ([GTIN](https://support.google.com/merchants/answer/188494#gtin)) of the item.", + "type": "string" + }, + "headlineOfferCondition": { + "description": "Condition of the headline offer.", + "type": "string" + }, + "headlineOfferLink": { + "description": "Link to the headline offer.", + "type": "string" + }, + "headlineOfferMobileLink": { + "description": "Mobile Link to the headline offer.", + "type": "string" + }, + "headlineOfferPrice": { + "$ref": "Price", + "description": "Headline Price of the aggregate offer." + }, + "headlineOfferShippingPrice": { + "$ref": "Price", + "description": "Headline Price of the aggregate offer." + }, + "highPrice": { + "$ref": "Price", + "description": "High Price of the aggregate offer." + }, + "imageLink": { + "description": "URL of an image of the item.", + "type": "string" + }, + "includedDestinations": { + "description": "The list of destinations to include for this target (corresponds to checked check boxes in Merchant Center). Default destinations are always included unless provided in `excludedDestinations`.", + "items": { + "type": "string" + }, + "type": "array" + }, + "isBundle": { + "description": "Whether the item is a merchant-defined bundle. A bundle is a custom grouping of different products sold by a merchant for a single price.", + "type": "boolean" + }, + "itemGroupId": { + "description": "Shared identifier for all variants of the same product.", + "type": "string" + }, + "lowPrice": { + "$ref": "Price", + "description": "Low Price of the aggregate offer." + }, + "material": { + "description": "The material of which the item is made.", + "type": "string" + }, + "mpn": { + "description": "Manufacturer Part Number ([MPN](https://support.google.com/merchants/answer/188494#mpn)) of the item.", + "type": "string" + }, + "multipack": { + "description": "The number of identical products in a merchant-defined multipack.", + "format": "int64", + "type": "string" + }, + "numberOfOffers": { + "description": "The number of aggregate offers.", + "format": "int64", + "type": "string" + }, + "pattern": { + "description": "The item's pattern (e.g. polka dots).", + "type": "string" + }, + "pause": { + "description": "Publication of this item will be temporarily paused.", + "type": "string" + }, + "productDetails": { + "description": "Technical specification or additional product details.", + "items": { + "$ref": "ProductDetail" + }, + "type": "array" + }, + "productHeight": { + "$ref": "ProductDimension", + "description": "The height of the product in the units provided. The value must be between 0 (exclusive) and 3000 (inclusive)." + }, + "productHighlights": { + "description": "Bullet points describing the most relevant highlights of a product.", + "items": { + "type": "string" + }, + "type": "array" + }, + "productLength": { + "$ref": "ProductDimension", + "description": "The length of the product in the units provided. The value must be between 0 (exclusive) and 3000 (inclusive)." + }, + "productTypes": { + "description": "Categories of the item (formatted as in [products data specification](https://support.google.com/merchants/answer/6324406)).", + "items": { + "type": "string" + }, + "type": "array" + }, + "productWeight": { + "$ref": "ProductWeight", + "description": "The weight of the product in the units provided. The value must be between 0 (exclusive) and 2000 (inclusive)." + }, + "productWidth": { + "$ref": "ProductDimension", + "description": "The width of the product in the units provided. The value must be between 0 (exclusive) and 3000 (inclusive)." + }, + "size": { + "description": "Size of the item. Only one value is allowed. For variants with different sizes, insert a separate product for each size with the same `itemGroupId` value (see [https://support.google.com/merchants/answer/6324492](size definition)).", + "type": "string" + }, + "sizeSystem": { + "description": "System in which the size is specified. Recommended for apparel items.", + "type": "string" + }, + "sizeTypes": { + "description": "The cut of the item. It can be used to represent combined size types for apparel items. Maximum two of size types can be provided (see [https://support.google.com/merchants/answer/6324497](size type)).", + "items": { + "type": "string" + }, + "type": "array" + }, + "title": { + "description": "Title of the item.", + "type": "string" + } + }, + "type": "object" + }, + "Certification": { + "description": "The certification for the product.", + "id": "Certification", + "properties": { + "authority": { + "description": "Name of the certification body.", + "type": "string" + }, + "code": { + "description": "A unique code to identify the certification.", + "type": "string" + }, + "name": { + "description": "Name of the certification.", + "type": "string" + } + }, + "type": "object" + }, + "CssProduct": { + "description": "The processed CSS Product(a.k.a Aggregate Offer internally).", + "id": "CssProduct", + "properties": { + "attributes": { + "$ref": "Attributes", + "description": "Output only. A list of product attributes.", + "readOnly": true + }, + "contentLanguage": { + "description": "Output only. The two-letter [ISO 639-1](http://en.wikipedia.org/wiki/ISO_639-1) language code for the product.", + "readOnly": true, + "type": "string" + }, + "cssProductStatus": { + "$ref": "CssProductStatus", + "description": "Output only. The status of a product, data validation issues, that is, information about a product computed asynchronously.", + "readOnly": true + }, + "customAttributes": { + "description": "Output only. A list of custom (CSS-provided) attributes. It can also be used to submit any attribute of the feed specification in its generic form (for example, `{ \"name\": \"size type\", \"value\": \"regular\" }`). This is useful for submitting attributes not explicitly exposed by the API, such as additional attributes used for Buy on Google.", + "items": { + "$ref": "CustomAttribute" + }, + "readOnly": true, + "type": "array" + }, + "feedLabel": { + "description": "Output only. The feed label for the product.", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "The name of the CSS Product. Format: `\"accounts/{account}/cssProducts/{css_product}\"`", + "type": "string" + }, + "rawProvidedId": { + "description": "Output only. Your unique raw identifier for the product.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "CssProductInput": { + "description": "This resource represents input data you submit for a CSS Product, not the processed CSS Product that you see in CSS Center, in Shopping Ads, or across Google surfaces.", + "id": "CssProductInput", + "properties": { + "attributes": { + "$ref": "Attributes", + "description": "A list of CSS Product attributes." + }, + "contentLanguage": { + "description": "Required. The two-letter [ISO 639-1](http://en.wikipedia.org/wiki/ISO_639-1) language code for the CSS Product.", + "type": "string" + }, + "customAttributes": { + "description": "A list of custom (CSS-provided) attributes. It can also be used for submitting any attribute of the feed specification in its generic form (for example: `{ \"name\": \"size type\", \"value\": \"regular\" }`). This is useful for submitting attributes not explicitly exposed by the API, such as additional attributes used for Buy on Google.", + "items": { + "$ref": "CustomAttribute" + }, + "type": "array" + }, + "feedLabel": { + "description": "Required. The [feed label](https://developers.google.com/shopping-content/guides/products/feed-labels) for the CSS Product. Feed Label is synonymous to \"target country\" and hence should always be a valid region code. For example: 'DE' for Germany, 'FR' for France.", + "type": "string" + }, + "finalName": { + "description": "Output only. The name of the processed CSS Product. Format: `accounts/{account}/cssProducts/{css_product}` \"", + "readOnly": true, + "type": "string" + }, + "freshnessTime": { + "description": "Represents the existing version (freshness) of the CSS Product, which can be used to preserve the right order when multiple updates are done at the same time. This field must not be set to the future time. If set, the update is prevented if a newer version of the item already exists in our system (that is the last update time of the existing CSS products is later than the freshness time set in the update). If the update happens, the last update time is then set to this freshness time. If not set, the update will not be prevented and the last update time will default to when this request was received by the CSS API. If the operation is prevented, the aborted exception will be thrown.", + "format": "google-datetime", + "type": "string" + }, + "name": { + "description": "The name of the CSS Product input. Format: `accounts/{account}/cssProductInputs/{css_product_input}`", + "type": "string" + }, + "rawProvidedId": { + "description": "Required. Your unique identifier for the CSS Product. This is the same for the CSS Product input and processed CSS Product. We only allow ids with alphanumerics, underscores and dashes. See the [products feed specification](https://support.google.com/merchants/answer/188494#id) for details.", + "type": "string" + } + }, + "type": "object" + }, + "CssProductStatus": { + "description": "The status of the Css Product, data validation issues, that is, information about the Css Product computed asynchronously.", + "id": "CssProductStatus", + "properties": { + "creationDate": { + "description": "Date on which the item has been created, in [ISO 8601](http://en.wikipedia.org/wiki/ISO_8601) format.", + "format": "google-datetime", + "type": "string" + }, + "destinationStatuses": { + "description": "The intended destinations for the product.", + "items": { + "$ref": "DestinationStatus" + }, + "type": "array" + }, + "googleExpirationDate": { + "description": "Date on which the item expires, in [ISO 8601](http://en.wikipedia.org/wiki/ISO_8601) format.", + "format": "google-datetime", + "type": "string" + }, + "itemLevelIssues": { + "description": "A list of all issues associated with the product.", + "items": { + "$ref": "ItemLevelIssue" + }, + "type": "array" + }, + "lastUpdateDate": { + "description": "Date on which the item has been last updated, in [ISO 8601](http://en.wikipedia.org/wiki/ISO_8601) format.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "CustomAttribute": { + "description": "A message that represents custom attributes. Exactly one of `value` or `group_values` must not be empty.", + "id": "CustomAttribute", + "properties": { + "groupValues": { + "description": "Subattributes within this attribute group. If `group_values` is not empty, `value` must be empty.", + "items": { + "$ref": "CustomAttribute" + }, + "type": "array" + }, + "name": { + "description": "The name of the attribute.", + "type": "string" + }, + "value": { + "description": "The value of the attribute. If `value` is not empty, `group_values` must be empty.", + "type": "string" + } + }, + "type": "object" + }, + "DestinationStatus": { + "description": "The destination status of the product status.", + "id": "DestinationStatus", + "properties": { + "approvedCountries": { + "description": "List of country codes (ISO 3166-1 alpha-2) where the aggregate offer is approved.", + "items": { + "type": "string" + }, + "type": "array" + }, + "destination": { + "description": "The name of the destination", + "type": "string" + }, + "disapprovedCountries": { + "description": "List of country codes (ISO 3166-1 alpha-2) where the aggregate offer is disapproved.", + "items": { + "type": "string" + }, + "type": "array" + }, + "pendingCountries": { + "description": "List of country codes (ISO 3166-1 alpha-2) where the aggregate offer is pending approval.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "Empty": { + "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }", + "id": "Empty", + "properties": {}, + "type": "object" + }, + "ItemLevelIssue": { + "description": "The ItemLevelIssue of the product status.", + "id": "ItemLevelIssue", + "properties": { + "applicableCountries": { + "description": "List of country codes (ISO 3166-1 alpha-2) where issue applies to the aggregate offer.", + "items": { + "type": "string" + }, + "type": "array" + }, + "attribute": { + "description": "The attribute's name, if the issue is caused by a single attribute.", + "type": "string" + }, + "code": { + "description": "The error code of the issue.", + "type": "string" + }, + "description": { + "description": "A short issue description in English.", + "type": "string" + }, + "destination": { + "description": "The destination the issue applies to.", + "type": "string" + }, + "detail": { + "description": "A detailed issue description in English.", + "type": "string" + }, + "documentation": { + "description": "The URL of a web page to help with resolving this issue.", + "type": "string" + }, + "resolution": { + "description": "Whether the issue can be resolved by the merchant.", + "type": "string" + }, + "servability": { + "description": "How this issue affects serving of the aggregate offer.", + "type": "string" + } + }, + "type": "object" + }, + "ListAccountLabelsResponse": { + "description": "Response message for the `ListAccountLabels` method.", + "id": "ListAccountLabelsResponse", + "properties": { + "accountLabels": { + "description": "The labels from the specified account.", + "items": { + "$ref": "AccountLabel" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", + "type": "string" + } + }, + "type": "object" + }, + "ListChildAccountsResponse": { + "description": "Response message for the `ListChildAccounts` method.", + "id": "ListChildAccountsResponse", + "properties": { + "accounts": { + "description": "The CSS/MC accounts returned for the specified CSS parent account.", + "items": { + "$ref": "Account" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", + "type": "string" + } + }, + "type": "object" + }, + "ListCssProductsResponse": { + "description": "Response message for the ListCssProducts method.", + "id": "ListCssProductsResponse", + "properties": { + "cssProducts": { + "description": "The processed CSS products from the specified account. These are your processed CSS products after applying rules and supplemental feeds.", + "items": { + "$ref": "CssProduct" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", + "type": "string" + } + }, + "type": "object" + }, + "Price": { + "description": "The price represented as a number and currency.", + "id": "Price", + "properties": { + "amountMicros": { + "description": "The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros).", + "format": "int64", + "type": "string" + }, + "currencyCode": { + "description": "The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217).", + "type": "string" + } + }, + "type": "object" + }, + "ProductDetail": { + "description": "The product details.", + "id": "ProductDetail", + "properties": { + "attributeName": { + "description": "The name of the product detail.", + "type": "string" + }, + "attributeValue": { + "description": "The value of the product detail.", + "type": "string" + }, + "sectionName": { + "description": "The section header used to group a set of product details.", + "type": "string" + } + }, + "type": "object" + }, + "ProductDimension": { + "description": "The dimension of the product.", + "id": "ProductDimension", + "properties": { + "unit": { + "description": "Required. The dimension units. Acceptable values are: * \"`in`\" * \"`cm`\"", + "type": "string" + }, + "value": { + "description": "Required. The dimension value represented as a number. The value can have a maximum precision of four decimal places.", + "format": "double", + "type": "number" + } + }, + "type": "object" + }, + "ProductWeight": { + "description": "The weight of the product.", + "id": "ProductWeight", + "properties": { + "unit": { + "description": "Required. The weight unit. Acceptable values are: * \"`g`\" * \"`kg`\" * \"`oz`\" * \"`lb`\"", + "type": "string" + }, + "value": { + "description": "Required. The weight represented as a number. The weight can have a maximum precision of four decimal places.", + "format": "double", + "type": "number" + } + }, + "type": "object" + }, + "UpdateAccountLabelsRequest": { + "description": "The request message for the `UpdateLabels` method.", + "id": "UpdateAccountLabelsRequest", + "properties": { + "labelIds": { + "description": "The list of label IDs to overwrite the existing account label IDs. If the list is empty, all currently assigned label IDs will be deleted.", + "items": { + "format": "int64", + "type": "string" + }, + "type": "array" + }, + "parent": { + "description": "Optional. Only required when updating MC account labels. The CSS domain that is the parent resource of the MC account. Format: accounts/{account}", + "type": "string" + } + }, + "type": "object" + } + }, + "servicePath": "", + "title": "CSS API", + "version": "v1", + "version_module": true +} \ No newline at end of file diff --git a/discovery/dataform-v1beta1.json b/discovery/dataform-v1beta1.json index af46b374ad..d2f9f21c8c 100644 --- a/discovery/dataform-v1beta1.json +++ b/discovery/dataform-v1beta1.json @@ -2236,7 +2236,7 @@ } } }, - "revision": "20240615", + "revision": "20240706", "rootUrl": "https://dataform.googleapis.com/", "schemas": { "Assertion": { @@ -2543,6 +2543,12 @@ "readOnly": true, "type": "array" }, + "createTime": { + "description": "Output only. The timestamp of when the compilation result was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, "dataEncryptionState": { "$ref": "DataEncryptionState", "description": "Output only. Only set if the repository has a KMS Key.", @@ -3983,6 +3989,12 @@ "description": "Represents a Dataform workflow configuration.", "id": "WorkflowConfig", "properties": { + "createTime": { + "description": "Output only. The timestamp of when the WorkflowConfig was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, "cronSchedule": { "description": "Optional. Optional schedule (in cron format) for automatic execution of this workflow config.", "type": "string" @@ -4010,6 +4022,12 @@ "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). If left unspecified, the default is UTC.", "type": "string" + }, + "updateTime": { + "description": "Output only. The timestamp of when the WorkflowConfig was last updated.", + "format": "google-datetime", + "readOnly": true, + "type": "string" } }, "type": "object" diff --git a/discovery/datafusion-v1.json b/discovery/datafusion-v1.json index 9be84e33ae..60f9cef658 100644 --- a/discovery/datafusion-v1.json +++ b/discovery/datafusion-v1.json @@ -732,7 +732,7 @@ } } }, - "revision": "20240618", + "revision": "20240703", "rootUrl": "https://datafusion.googleapis.com/", "schemas": { "Accelerator": { @@ -777,6 +777,38 @@ }, "type": "object" }, + "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.", + "id": "AssetLocation", + "properties": { + "expected": { + "$ref": "IsolationExpectations", + "description": "Defines the customer expectation around ZI/ZS for this asset and ZI/ZS state of the region at the time of asset creation." + }, + "extraParameters": { + "description": "Defines extra parameters required for specific asset types.", + "items": { + "$ref": "ExtraParameter" + }, + "type": "array" + }, + "locationData": { + "description": "Contains all kinds of physical location definitions for this asset.", + "items": { + "$ref": "LocationData" + }, + "type": "array" + }, + "parentAsset": { + "description": "Defines parents assets if any in order to allow later generation of child_asset_location data via child assets.", + "items": { + "$ref": "CloudAsset" + }, + "type": "array" + } + }, + "type": "object" + }, "AuditConfig": { "description": "Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { \"audit_configs\": [ { \"service\": \"allServices\", \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\", \"exempted_members\": [ \"user:jose@example.com\" ] }, { \"log_type\": \"DATA_WRITE\" }, { \"log_type\": \"ADMIN_READ\" } ] }, { \"service\": \"sampleservice.googleapis.com\", \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\" }, { \"log_type\": \"DATA_WRITE\", \"exempted_members\": [ \"user:aliya@example.com\" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging.", "id": "AuditConfig", @@ -847,12 +879,49 @@ }, "type": "object" }, + "BlobstoreLocation": { + "description": "Policy ID that identified data placement in Blobstore as per go/blobstore-user-guide#data-metadata-placement-and-failure-domains", + "id": "BlobstoreLocation", + "properties": { + "policyId": { + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "CancelOperationRequest": { "description": "The request message for Operations.CancelOperation.", "id": "CancelOperationRequest", "properties": {}, "type": "object" }, + "CloudAsset": { + "id": "CloudAsset", + "properties": { + "assetName": { + "type": "string" + }, + "assetType": { + "type": "string" + } + }, + "type": "object" + }, + "CloudAssetComposition": { + "id": "CloudAssetComposition", + "properties": { + "childAsset": { + "items": { + "$ref": "CloudAsset" + }, + "type": "array" + } + }, + "type": "object" + }, "CryptoKeyConfig": { "description": "The crypto key configuration. This field is used by the Customer-managed encryption keys (CMEK) feature.", "id": "CryptoKeyConfig", @@ -864,6 +933,18 @@ }, "type": "object" }, + "DirectLocationAssignment": { + "id": "DirectLocationAssignment", + "properties": { + "location": { + "items": { + "$ref": "LocationAssignment" + }, + "type": "array" + } + }, + "type": "object" + }, "DnsPeering": { "description": "DNS peering configuration. These configurations are used to create DNS peering with the customer Cloud DNS.", "id": "DnsPeering", @@ -935,6 +1016,17 @@ }, "type": "object" }, + "ExtraParameter": { + "description": "Defines parameters that should only be used for specific asset types.", + "id": "ExtraParameter", + "properties": { + "regionalMigDistributionPolicy": { + "$ref": "RegionalMigDistributionPolicy", + "description": "Details about zones used by regional compute.googleapis.com/InstanceGroupManager to create instances." + } + }, + "type": "object" + }, "Instance": { "description": "Represents a Data Fusion instance.", "id": "Instance", @@ -1162,6 +1254,127 @@ }, "type": "object" }, + "IsolationExpectations": { + "id": "IsolationExpectations", + "properties": { + "ziOrgPolicy": { + "enum": [ + "ZI_UNSPECIFIED", + "ZI_UNKNOWN", + "ZI_NOT_REQUIRED", + "ZI_PREFERRED", + "ZI_REQUIRED" + ], + "enumDescriptions": [ + "", + "To be used if tracking is not available", + "", + "", + "" + ], + "type": "string" + }, + "ziRegionPolicy": { + "enum": [ + "ZI_REGION_POLICY_UNSPECIFIED", + "ZI_REGION_POLICY_UNKNOWN", + "ZI_REGION_POLICY_NOT_SET", + "ZI_REGION_POLICY_FAIL_OPEN", + "ZI_REGION_POLICY_FAIL_CLOSED" + ], + "enumDescriptions": [ + "", + "To be used if tracking is not available", + "", + "", + "" + ], + "type": "string" + }, + "ziRegionState": { + "enum": [ + "ZI_REGION_UNSPECIFIED", + "ZI_REGION_UNKNOWN", + "ZI_REGION_NOT_ENABLED", + "ZI_REGION_ENABLED" + ], + "enumDescriptions": [ + "", + "To be used if tracking is not available", + "", + "" + ], + "type": "string" + }, + "zoneIsolation": { + "deprecated": true, + "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.", + "enum": [ + "ZI_UNSPECIFIED", + "ZI_UNKNOWN", + "ZI_NOT_REQUIRED", + "ZI_PREFERRED", + "ZI_REQUIRED" + ], + "enumDescriptions": [ + "", + "To be used if tracking is not available", + "", + "", + "" + ], + "type": "string" + }, + "zoneSeparation": { + "deprecated": true, + "description": "Deprecated: use zs_org_policy, and zs_region_stateinstead for setting Zs expectations as per go/zicy-publish-physical-location.", + "enum": [ + "ZS_UNSPECIFIED", + "ZS_UNKNOWN", + "ZS_NOT_REQUIRED", + "ZS_REQUIRED" + ], + "enumDescriptions": [ + "", + "To be used if tracking is not available", + "", + "" + ], + "type": "string" + }, + "zsOrgPolicy": { + "enum": [ + "ZS_UNSPECIFIED", + "ZS_UNKNOWN", + "ZS_NOT_REQUIRED", + "ZS_REQUIRED" + ], + "enumDescriptions": [ + "", + "To be used if tracking is not available", + "", + "" + ], + "type": "string" + }, + "zsRegionState": { + "enum": [ + "ZS_REGION_UNSPECIFIED", + "ZS_REGION_UNKNOWN", + "ZS_REGION_NOT_ENABLED", + "ZS_REGION_ENABLED" + ], + "enumDescriptions": [ + "", + "To be used if tracking of the asset ZS-bit is not available", + "", + "" + ], + "type": "string" + } + }, + "type": "object" + }, "ListAvailableVersionsResponse": { "description": "Response message for the list available versions request.", "id": "ListAvailableVersionsResponse", @@ -1293,6 +1506,64 @@ }, "type": "object" }, + "LocationAssignment": { + "id": "LocationAssignment", + "properties": { + "location": { + "type": "string" + }, + "locationType": { + "enum": [ + "UNSPECIFIED", + "CLUSTER", + "POP", + "CLOUD_ZONE", + "CLOUD_REGION", + "MULTI_REGION_GEO", + "MULTI_REGION_JURISDICTION", + "GLOBAL", + "OTHER" + ], + "enumDescriptions": [ + "", + "1-10: Physical failure domains.", + "", + "11-20: Logical failure domains.", + "", + "", + "", + "", + "" + ], + "type": "string" + } + }, + "type": "object" + }, + "LocationData": { + "id": "LocationData", + "properties": { + "blobstoreLocation": { + "$ref": "BlobstoreLocation" + }, + "childAssetLocation": { + "$ref": "CloudAssetComposition" + }, + "directLocation": { + "$ref": "DirectLocationAssignment" + }, + "gcpProjectProxy": { + "$ref": "TenantProjectProxy" + }, + "placerLocation": { + "$ref": "PlacerLocation" + }, + "spannerLocation": { + "$ref": "SpannerLocation" + } + }, + "type": "object" + }, "MaintenancePolicy": { "description": "Maintenance policy of the instance.", "id": "MaintenancePolicy", @@ -1431,6 +1702,17 @@ }, "type": "object" }, + "PlacerLocation": { + "description": "Message describing that the location of the customer resource is tied to placer allocations", + "id": "PlacerLocation", + "properties": { + "placerConfig": { + "description": "Directory with a config related to it in placer (e.g. \"/placer/prod/home/my-root/my-dir\")", + "type": "string" + } + }, + "type": "object" + }, "Policy": { "description": "An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { \"bindings\": [ { \"role\": \"roles/resourcemanager.organizationAdmin\", \"members\": [ \"user:mike@example.com\", \"group:admins@example.com\", \"domain:google.com\", \"serviceAccount:my-project-id@appspot.gserviceaccount.com\" ] }, { \"role\": \"roles/resourcemanager.organizationViewer\", \"members\": [ \"user:eve@example.com\" ], \"condition\": { \"title\": \"expirable access\", \"description\": \"Does not grant access after Sep 2020\", \"expression\": \"request.time < timestamp('2020-10-01T00:00:00.000Z')\", } } ], \"etag\": \"BwWWja0YfJA=\", \"version\": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).", "id": "Policy", @@ -1497,6 +1779,25 @@ }, "type": "object" }, + "RegionalMigDistributionPolicy": { + "description": "To be used for specifying the intended distribution of regional compute.googleapis.com/InstanceGroupManager instances", + "id": "RegionalMigDistributionPolicy", + "properties": { + "targetShape": { + "description": "The shape in which the group converges around distribution of resources. Instance of proto2 enum", + "format": "int32", + "type": "integer" + }, + "zones": { + "description": "Cloud zones used by regional MIG to create instances.", + "items": { + "$ref": "ZoneConfiguration" + }, + "type": "array" + } + }, + "type": "object" + }, "RestartInstanceRequest": { "description": "Request message for restarting a Data Fusion instance.", "id": "RestartInstanceRequest", @@ -1519,6 +1820,26 @@ }, "type": "object" }, + "SpannerLocation": { + "id": "SpannerLocation", + "properties": { + "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", + "items": { + "type": "string" + }, + "type": "array" + }, + "dbName": { + "description": "Set of databases used by the resource in format /span//", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "Status": { "description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).", "id": "Status", @@ -1546,6 +1867,18 @@ }, "type": "object" }, + "TenantProjectProxy": { + "id": "TenantProjectProxy", + "properties": { + "projectNumbers": { + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "TestIamPermissionsRequest": { "description": "Request message for `TestIamPermissions` method.", "id": "TestIamPermissionsRequest", @@ -1626,6 +1959,15 @@ } }, "type": "object" + }, + "ZoneConfiguration": { + "id": "ZoneConfiguration", + "properties": { + "zone": { + "type": "string" + } + }, + "type": "object" } }, "servicePath": "", diff --git a/discovery/datafusion-v1beta1.json b/discovery/datafusion-v1beta1.json index 4c535042e2..81790755b1 100644 --- a/discovery/datafusion-v1beta1.json +++ b/discovery/datafusion-v1beta1.json @@ -930,7 +930,7 @@ } } }, - "revision": "20240618", + "revision": "20240703", "rootUrl": "https://datafusion.googleapis.com/", "schemas": { "Accelerator": { @@ -975,6 +975,38 @@ }, "type": "object" }, + "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.", + "id": "AssetLocation", + "properties": { + "expected": { + "$ref": "IsolationExpectations", + "description": "Defines the customer expectation around ZI/ZS for this asset and ZI/ZS state of the region at the time of asset creation." + }, + "extraParameters": { + "description": "Defines extra parameters required for specific asset types.", + "items": { + "$ref": "ExtraParameter" + }, + "type": "array" + }, + "locationData": { + "description": "Contains all kinds of physical location definitions for this asset.", + "items": { + "$ref": "LocationData" + }, + "type": "array" + }, + "parentAsset": { + "description": "Defines parents assets if any in order to allow later generation of child_asset_location data via child assets.", + "items": { + "$ref": "CloudAsset" + }, + "type": "array" + } + }, + "type": "object" + }, "AuditConfig": { "description": "Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { \"audit_configs\": [ { \"service\": \"allServices\", \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\", \"exempted_members\": [ \"user:jose@example.com\" ] }, { \"log_type\": \"DATA_WRITE\" }, { \"log_type\": \"ADMIN_READ\" } ] }, { \"service\": \"sampleservice.googleapis.com\", \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\" }, { \"log_type\": \"DATA_WRITE\", \"exempted_members\": [ \"user:aliya@example.com\" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging.", "id": "AuditConfig", @@ -1045,12 +1077,49 @@ }, "type": "object" }, + "BlobstoreLocation": { + "description": "Policy ID that identified data placement in Blobstore as per go/blobstore-user-guide#data-metadata-placement-and-failure-domains", + "id": "BlobstoreLocation", + "properties": { + "policyId": { + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "CancelOperationRequest": { "description": "The request message for Operations.CancelOperation.", "id": "CancelOperationRequest", "properties": {}, "type": "object" }, + "CloudAsset": { + "id": "CloudAsset", + "properties": { + "assetName": { + "type": "string" + }, + "assetType": { + "type": "string" + } + }, + "type": "object" + }, + "CloudAssetComposition": { + "id": "CloudAssetComposition", + "properties": { + "childAsset": { + "items": { + "$ref": "CloudAsset" + }, + "type": "array" + } + }, + "type": "object" + }, "CryptoKeyConfig": { "description": "The crypto key configuration. This field is used by the Customer-managed encryption keys (CMEK) feature.", "id": "CryptoKeyConfig", @@ -1062,6 +1131,18 @@ }, "type": "object" }, + "DirectLocationAssignment": { + "id": "DirectLocationAssignment", + "properties": { + "location": { + "items": { + "$ref": "LocationAssignment" + }, + "type": "array" + } + }, + "type": "object" + }, "DnsPeering": { "description": "DNS peering configuration. These configurations are used to create DNS peering with the customer Cloud DNS.", "id": "DnsPeering", @@ -1133,6 +1214,17 @@ }, "type": "object" }, + "ExtraParameter": { + "description": "Defines parameters that should only be used for specific asset types.", + "id": "ExtraParameter", + "properties": { + "regionalMigDistributionPolicy": { + "$ref": "RegionalMigDistributionPolicy", + "description": "Details about zones used by regional compute.googleapis.com/InstanceGroupManager to create instances." + } + }, + "type": "object" + }, "IAMPolicy": { "description": "IAMPolicy encapsulates the IAM policy name, definition and status of policy fetching.", "id": "IAMPolicy", @@ -1375,6 +1467,127 @@ }, "type": "object" }, + "IsolationExpectations": { + "id": "IsolationExpectations", + "properties": { + "ziOrgPolicy": { + "enum": [ + "ZI_UNSPECIFIED", + "ZI_UNKNOWN", + "ZI_NOT_REQUIRED", + "ZI_PREFERRED", + "ZI_REQUIRED" + ], + "enumDescriptions": [ + "", + "To be used if tracking is not available", + "", + "", + "" + ], + "type": "string" + }, + "ziRegionPolicy": { + "enum": [ + "ZI_REGION_POLICY_UNSPECIFIED", + "ZI_REGION_POLICY_UNKNOWN", + "ZI_REGION_POLICY_NOT_SET", + "ZI_REGION_POLICY_FAIL_OPEN", + "ZI_REGION_POLICY_FAIL_CLOSED" + ], + "enumDescriptions": [ + "", + "To be used if tracking is not available", + "", + "", + "" + ], + "type": "string" + }, + "ziRegionState": { + "enum": [ + "ZI_REGION_UNSPECIFIED", + "ZI_REGION_UNKNOWN", + "ZI_REGION_NOT_ENABLED", + "ZI_REGION_ENABLED" + ], + "enumDescriptions": [ + "", + "To be used if tracking is not available", + "", + "" + ], + "type": "string" + }, + "zoneIsolation": { + "deprecated": true, + "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.", + "enum": [ + "ZI_UNSPECIFIED", + "ZI_UNKNOWN", + "ZI_NOT_REQUIRED", + "ZI_PREFERRED", + "ZI_REQUIRED" + ], + "enumDescriptions": [ + "", + "To be used if tracking is not available", + "", + "", + "" + ], + "type": "string" + }, + "zoneSeparation": { + "deprecated": true, + "description": "Deprecated: use zs_org_policy, and zs_region_stateinstead for setting Zs expectations as per go/zicy-publish-physical-location.", + "enum": [ + "ZS_UNSPECIFIED", + "ZS_UNKNOWN", + "ZS_NOT_REQUIRED", + "ZS_REQUIRED" + ], + "enumDescriptions": [ + "", + "To be used if tracking is not available", + "", + "" + ], + "type": "string" + }, + "zsOrgPolicy": { + "enum": [ + "ZS_UNSPECIFIED", + "ZS_UNKNOWN", + "ZS_NOT_REQUIRED", + "ZS_REQUIRED" + ], + "enumDescriptions": [ + "", + "To be used if tracking is not available", + "", + "" + ], + "type": "string" + }, + "zsRegionState": { + "enum": [ + "ZS_REGION_UNSPECIFIED", + "ZS_REGION_UNKNOWN", + "ZS_REGION_NOT_ENABLED", + "ZS_REGION_ENABLED" + ], + "enumDescriptions": [ + "", + "To be used if tracking of the asset ZS-bit is not available", + "", + "" + ], + "type": "string" + } + }, + "type": "object" + }, "ListAvailableVersionsResponse": { "description": "Response message for the list available versions request.", "id": "ListAvailableVersionsResponse", @@ -1524,6 +1737,64 @@ }, "type": "object" }, + "LocationAssignment": { + "id": "LocationAssignment", + "properties": { + "location": { + "type": "string" + }, + "locationType": { + "enum": [ + "UNSPECIFIED", + "CLUSTER", + "POP", + "CLOUD_ZONE", + "CLOUD_REGION", + "MULTI_REGION_GEO", + "MULTI_REGION_JURISDICTION", + "GLOBAL", + "OTHER" + ], + "enumDescriptions": [ + "", + "1-10: Physical failure domains.", + "", + "11-20: Logical failure domains.", + "", + "", + "", + "", + "" + ], + "type": "string" + } + }, + "type": "object" + }, + "LocationData": { + "id": "LocationData", + "properties": { + "blobstoreLocation": { + "$ref": "BlobstoreLocation" + }, + "childAssetLocation": { + "$ref": "CloudAssetComposition" + }, + "directLocation": { + "$ref": "DirectLocationAssignment" + }, + "gcpProjectProxy": { + "$ref": "TenantProjectProxy" + }, + "placerLocation": { + "$ref": "PlacerLocation" + }, + "spannerLocation": { + "$ref": "SpannerLocation" + } + }, + "type": "object" + }, "MaintenancePolicy": { "description": "Maintenance policy of the instance.", "id": "MaintenancePolicy", @@ -1677,6 +1948,17 @@ }, "type": "object" }, + "PlacerLocation": { + "description": "Message describing that the location of the customer resource is tied to placer allocations", + "id": "PlacerLocation", + "properties": { + "placerConfig": { + "description": "Directory with a config related to it in placer (e.g. \"/placer/prod/home/my-root/my-dir\")", + "type": "string" + } + }, + "type": "object" + }, "Policy": { "description": "An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { \"bindings\": [ { \"role\": \"roles/resourcemanager.organizationAdmin\", \"members\": [ \"user:mike@example.com\", \"group:admins@example.com\", \"domain:google.com\", \"serviceAccount:my-project-id@appspot.gserviceaccount.com\" ] }, { \"role\": \"roles/resourcemanager.organizationViewer\", \"members\": [ \"user:eve@example.com\" ], \"condition\": { \"title\": \"expirable access\", \"description\": \"Does not grant access after Sep 2020\", \"expression\": \"request.time < timestamp('2020-10-01T00:00:00.000Z')\", } } ], \"etag\": \"BwWWja0YfJA=\", \"version\": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).", "id": "Policy", @@ -1743,6 +2025,25 @@ }, "type": "object" }, + "RegionalMigDistributionPolicy": { + "description": "To be used for specifying the intended distribution of regional compute.googleapis.com/InstanceGroupManager instances", + "id": "RegionalMigDistributionPolicy", + "properties": { + "targetShape": { + "description": "The shape in which the group converges around distribution of resources. Instance of proto2 enum", + "format": "int32", + "type": "integer" + }, + "zones": { + "description": "Cloud zones used by regional MIG to create instances.", + "items": { + "$ref": "ZoneConfiguration" + }, + "type": "array" + } + }, + "type": "object" + }, "RemoveIamPolicyRequest": { "description": "Request message for RemoveIamPolicy method.", "id": "RemoveIamPolicyRequest", @@ -1777,6 +2078,26 @@ }, "type": "object" }, + "SpannerLocation": { + "id": "SpannerLocation", + "properties": { + "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", + "items": { + "type": "string" + }, + "type": "array" + }, + "dbName": { + "description": "Set of databases used by the resource in format /span//", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "Status": { "description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).", "id": "Status", @@ -1804,6 +2125,18 @@ }, "type": "object" }, + "TenantProjectProxy": { + "id": "TenantProjectProxy", + "properties": { + "projectNumbers": { + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "TestIamPermissionsRequest": { "description": "Request message for `TestIamPermissions` method.", "id": "TestIamPermissionsRequest", @@ -1890,6 +2223,15 @@ } }, "type": "object" + }, + "ZoneConfiguration": { + "id": "ZoneConfiguration", + "properties": { + "zone": { + "type": "string" + } + }, + "type": "object" } }, "servicePath": "", diff --git a/discovery/datamigration-v1.json b/discovery/datamigration-v1.json index 5acd035000..fbee0db000 100644 --- a/discovery/datamigration-v1.json +++ b/discovery/datamigration-v1.json @@ -2125,7 +2125,7 @@ } } }, - "revision": "20240615", + "revision": "20240701", "rootUrl": "https://datamigration.googleapis.com/", "schemas": { "AlloyDbConnectionProfile": { @@ -4479,8 +4479,7 @@ "PROMOTE_IN_PROGRESS", "WAITING_FOR_SOURCE_WRITES_TO_STOP", "PREPARING_THE_DUMP", - "READY_FOR_PROMOTE", - "DIFF_BACKUP" + "READY_FOR_PROMOTE" ], "enumDescriptions": [ "The phase of the migration job is unknown.", @@ -4489,8 +4488,7 @@ "The migration job is running the promote phase.", "Only RDS flow - waiting for source writes to stop", "Only RDS flow - the sources writes stopped, waiting for dump to begin", - "The migration job is ready to be promoted.", - "The migration job is in the differential backup phase." + "The migration job is ready to be promoted." ], "readOnly": true, "type": "string" diff --git a/discovery/dataplex-v1.json b/discovery/dataplex-v1.json index f2aa3d7356..6ca0b8f798 100644 --- a/discovery/dataplex-v1.json +++ b/discovery/dataplex-v1.json @@ -176,7 +176,7 @@ ] }, "lookupEntry": { - "description": "Looks up a single entry.", + "description": "Looks up a single Entry by name using the permission on the source system.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}:lookupEntry", "httpMethod": "GET", "id": "dataplex.projects.locations.lookupEntry", @@ -185,7 +185,7 @@ ], "parameters": { "aspectTypes": { - "description": "Optional. Limits the aspects returned to the provided aspect types. Only works if the CUSTOM view is selected.", + "description": "Optional. Limits the aspects returned to the provided aspect types. It only works for CUSTOM view.", "location": "query", "repeated": true, "type": "string" @@ -203,13 +203,13 @@ "type": "string" }, "paths": { - "description": "Optional. Limits the aspects returned to those associated with the provided paths within the Entry. Only works if the CUSTOM view is selected.", + "description": "Optional. Limits the aspects returned to those associated with the provided paths within the Entry. It only works for CUSTOM view.", "location": "query", "repeated": true, "type": "string" }, "view": { - "description": "Optional. View for controlling which parts of an entry are to be returned.", + "description": "Optional. View to control which parts of an entry the service should return.", "enum": [ "ENTRY_VIEW_UNSPECIFIED", "BASIC", @@ -221,8 +221,8 @@ "Unspecified EntryView. Defaults to FULL.", "Returns entry only, without aspects.", "Returns all required aspects as well as the keys of all non-required aspects.", - "Returns aspects matching custom fields in GetEntryRequest. If the number of aspects would exceed 100, the first 100 will be returned.", - "Returns all aspects. If the number of aspects would exceed 100, the first 100 will be returned." + "Returns aspects matching custom fields in GetEntryRequest. If the number of aspects exceeds 100, the first 100 will be returned.", + "Returns all aspects. If the number of aspects exceeds 100, the first 100 will be returned." ], "location": "query", "type": "string" @@ -237,7 +237,7 @@ ] }, "searchEntries": { - "description": "Searches for entries matching given query and scope.", + "description": "Searches for Entries matching the given query and scope.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}:searchEntries", "httpMethod": "POST", "id": "dataplex.projects.locations.searchEntries", @@ -253,17 +253,18 @@ "type": "string" }, "orderBy": { - "description": "Optional. Ordering of the results. Supported options to be added later.", + "description": "Optional. Specifies the ordering of results.", "location": "query", "type": "string" }, "pageSize": { - "description": "Optional. Pagination.", + "description": "Optional. Number of results in the search page. If <=0, then defaults to 10. Max limit for page_size is 1000. Throws an invalid argument for page_size > 1000.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { + "description": "Optional. Page token received from a previous SearchEntries call. Provide this to retrieve the subsequent page.", "location": "query", "type": "string" }, @@ -273,7 +274,7 @@ "type": "string" }, "scope": { - "description": "Optional. The scope under which the search should be operating. Should either be organizations/ or projects/. If left unspecified, it will default to the organization where the project provided in name is located.", + "description": "Optional. The scope under which the search should be operating. It must either be organizations/ or projects/. If it is unspecified, it defaults to the organization where the project provided in name is located.", "location": "query", "type": "string" } @@ -291,7 +292,7 @@ "aspectTypes": { "methods": { "create": { - "description": "Creates an AspectType", + "description": "Creates an AspectType.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/aspectTypes", "httpMethod": "POST", "id": "dataplex.projects.locations.aspectTypes.create", @@ -305,14 +306,14 @@ "type": "string" }, "parent": { - "description": "Required. The resource name of the AspectType, of the form: projects/{project_number}/locations/{location_id} where location_id refers to a GCP region.", + "description": "Required. The resource name of the AspectType, of the form: projects/{project_number}/locations/{location_id} where location_id refers to a Google Cloud region.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" }, "validateOnly": { - "description": "Optional. Only validate the request, but do not perform mutations. The default is false.", + "description": "Optional. The service validates the request without performing any mutations. The default is false.", "location": "query", "type": "boolean" } @@ -329,7 +330,7 @@ ] }, "delete": { - "description": "Deletes a AspectType resource.", + "description": "Deletes an AspectType.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/aspectTypes/{aspectTypesId}", "httpMethod": "DELETE", "id": "dataplex.projects.locations.aspectTypes.delete", @@ -338,7 +339,7 @@ ], "parameters": { "etag": { - "description": "Optional. If the client provided etag value does not match the current etag value, the DeleteAspectTypeRequest method returns an ABORTED error response", + "description": "Optional. If the client provided etag value does not match the current etag value, the DeleteAspectTypeRequest method returns an ABORTED error response.", "location": "query", "type": "string" }, @@ -359,7 +360,7 @@ ] }, "get": { - "description": "Retrieves a AspectType resource.", + "description": "Gets an AspectType.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/aspectTypes/{aspectTypesId}", "httpMethod": "GET", "id": "dataplex.projects.locations.aspectTypes.get", @@ -424,28 +425,28 @@ ], "parameters": { "filter": { - "description": "Optional. Filter request. Filters are case-sensitive. The following formats are supported:labels.key1 = \"value1\" labels:key1 name = \"value\" These restrictions can be coinjoined with AND, OR and NOT conjunctions.", + "description": "Optional. Filter request. Filters are case-sensitive. The service supports the following formats: labels.key1 = \"value1\" labels:key1 name = \"value\"These restrictions can be conjoined with AND, OR, and NOT conjunctions.", "location": "query", "type": "string" }, "orderBy": { - "description": "Optional. Order by fields (name or create_time) for the result. If not specified, the ordering is undefined.", + "description": "Optional. Orders the result by name or create_time fields. If not specified, the ordering is undefined.", "location": "query", "type": "string" }, "pageSize": { - "description": "Optional. Maximum number of AspectTypes to return. The service may return fewer than this value. If unspecified, at most 10 AspectTypes will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", + "description": "Optional. Maximum number of AspectTypes to return. The service may return fewer than this value. If unspecified, the service returns at most 10 AspectTypes. The maximum value is 1000; values above 1000 will be coerced to 1000.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { - "description": "Optional. Page token received from a previous ListAspectTypes call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListAspectTypes must match the call that provided the page token.", + "description": "Optional. Page token received from a previous ListAspectTypes call. Provide this to retrieve the subsequent page. When paginating, all other parameters you provide to ListAspectTypes must match the call that provided the page token.", "location": "query", "type": "string" }, "parent": { - "description": "Required. The resource name of the AspectType location, of the form: projects/{project_number}/locations/{location_id} where location_id refers to a GCP region.", + "description": "Required. The resource name of the AspectType location, of the form: projects/{project_number}/locations/{location_id} where location_id refers to a Google Cloud region.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -461,7 +462,7 @@ ] }, "patch": { - "description": "Updates a AspectType resource.", + "description": "Updates an AspectType.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/aspectTypes/{aspectTypesId}", "httpMethod": "PATCH", "id": "dataplex.projects.locations.aspectTypes.patch", @@ -1819,7 +1820,7 @@ "entryGroups": { "methods": { "create": { - "description": "Creates an EntryGroup", + "description": "Creates an EntryGroup.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/entryGroups", "httpMethod": "POST", "id": "dataplex.projects.locations.entryGroups.create", @@ -1840,7 +1841,7 @@ "type": "string" }, "validateOnly": { - "description": "Optional. Only validate the request, but do not perform mutations. The default is false.", + "description": "Optional. The service validates the request without performing any mutations. The default is false.", "location": "query", "type": "boolean" } @@ -1857,7 +1858,7 @@ ] }, "delete": { - "description": "Deletes a EntryGroup resource.", + "description": "Deletes an EntryGroup.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}", "httpMethod": "DELETE", "id": "dataplex.projects.locations.entryGroups.delete", @@ -1866,7 +1867,7 @@ ], "parameters": { "etag": { - "description": "Optional. If the client provided etag value does not match the current etag value, the DeleteEntryGroupRequest method returns an ABORTED error response", + "description": "Optional. If the client provided etag value does not match the current etag value, the DeleteEntryGroupRequest method returns an ABORTED error response.", "location": "query", "type": "string" }, @@ -1887,7 +1888,7 @@ ] }, "get": { - "description": "Retrieves a EntryGroup resource.", + "description": "Gets an EntryGroup.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}", "httpMethod": "GET", "id": "dataplex.projects.locations.entryGroups.get", @@ -1962,18 +1963,18 @@ "type": "string" }, "pageSize": { - "description": "Optional. Maximum number of EntryGroups to return. The service may return fewer than this value. If unspecified, at most 10 EntryGroups will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", + "description": "Optional. Maximum number of EntryGroups to return. The service may return fewer than this value. If unspecified, the service returns at most 10 EntryGroups. The maximum value is 1000; values above 1000 will be coerced to 1000.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { - "description": "Optional. Page token received from a previous ListEntryGroups call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListEntryGroups must match the call that provided the page token.", + "description": "Optional. Page token received from a previous ListEntryGroups call. Provide this to retrieve the subsequent page. When paginating, all other parameters you provide to ListEntryGroups must match the call that provided the page token.", "location": "query", "type": "string" }, "parent": { - "description": "Required. The resource name of the entryGroup location, of the form: projects/{project_number}/locations/{location_id} where location_id refers to a GCP region.", + "description": "Required. The resource name of the entryGroup location, of the form: projects/{project_number}/locations/{location_id} where location_id refers to a Google Cloud region.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -1989,7 +1990,7 @@ ] }, "patch": { - "description": "Updates a EntryGroup resource.", + "description": "Updates an EntryGroup.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}", "httpMethod": "PATCH", "id": "dataplex.projects.locations.entryGroups.patch", @@ -2011,7 +2012,7 @@ "type": "string" }, "validateOnly": { - "description": "Optional. Only validate the request, but do not perform mutations. The default is false.", + "description": "Optional. The service validates the request, without performing any mutations. The default is false.", "location": "query", "type": "boolean" } @@ -2097,7 +2098,7 @@ ], "parameters": { "entryId": { - "description": "Required. Entry identifier. It has to be unique within an Entry Group.Entries corresponding to Google Cloud resources use Entry ID format based on Full Resource Names (https://cloud.google.com/apis/design/resource_names#full_resource_name). The format is a Full Resource Name of the resource without the prefix double slashes in the API Service Name part of Full Resource Name. This allows retrieval of entries using their associated resource name.For example if the Full Resource Name of a resource is //library.googleapis.com/shelves/shelf1/books/book2, then the suggested entry_id is library.googleapis.com/shelves/shelf1/books/book2.It is also suggested to follow the same convention for entries corresponding to resources from other providers or systems than Google Cloud.The maximum size of the field is 4000 characters.", + "description": "Required. Entry identifier. It has to be unique within an Entry Group.Entries corresponding to Google Cloud resources use an Entry ID format based on full resource names (https://cloud.google.com/apis/design/resource_names#full_resource_name). The format is a full resource name of the resource without the prefix double slashes in the API service name part of the full resource name. This allows retrieval of entries using their associated resource name.For example, if the full resource name of a resource is //library.googleapis.com/shelves/shelf1/books/book2, then the suggested entry_id is library.googleapis.com/shelves/shelf1/books/book2.It is also suggested to follow the same convention for entries corresponding to resources from providers or systems other than Google Cloud.The maximum size of the field is 4000 characters.", "location": "query", "type": "string" }, @@ -2146,7 +2147,7 @@ ] }, "get": { - "description": "Gets a single entry.", + "description": "Gets an Entry.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}/entries/{entriesId}", "httpMethod": "GET", "id": "dataplex.projects.locations.entryGroups.entries.get", @@ -2155,7 +2156,7 @@ ], "parameters": { "aspectTypes": { - "description": "Optional. Limits the aspects returned to the provided aspect types. Only works if the CUSTOM view is selected.", + "description": "Optional. Limits the aspects returned to the provided aspect types. It only works for CUSTOM view.", "location": "query", "repeated": true, "type": "string" @@ -2168,13 +2169,13 @@ "type": "string" }, "paths": { - "description": "Optional. Limits the aspects returned to those associated with the provided paths within the Entry. Only works if the CUSTOM view is selected.", + "description": "Optional. Limits the aspects returned to those associated with the provided paths within the Entry. It only works for CUSTOM view.", "location": "query", "repeated": true, "type": "string" }, "view": { - "description": "Optional. View for controlling which parts of an entry are to be returned.", + "description": "Optional. View to control which parts of an entry the service should return.", "enum": [ "ENTRY_VIEW_UNSPECIFIED", "BASIC", @@ -2186,8 +2187,8 @@ "Unspecified EntryView. Defaults to FULL.", "Returns entry only, without aspects.", "Returns all required aspects as well as the keys of all non-required aspects.", - "Returns aspects matching custom fields in GetEntryRequest. If the number of aspects would exceed 100, the first 100 will be returned.", - "Returns all aspects. If the number of aspects would exceed 100, the first 100 will be returned." + "Returns aspects matching custom fields in GetEntryRequest. If the number of aspects exceeds 100, the first 100 will be returned.", + "Returns all aspects. If the number of aspects exceeds 100, the first 100 will be returned." ], "location": "query", "type": "string" @@ -2202,7 +2203,7 @@ ] }, "list": { - "description": "Lists entries within an entry group.", + "description": "Lists Entries within an EntryGroup.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}/entries", "httpMethod": "GET", "id": "dataplex.projects.locations.entryGroups.entries.list", @@ -2211,17 +2212,18 @@ ], "parameters": { "filter": { - "description": "Optional. A filter on the entries to return. Filters are case-sensitive. The request can be filtered by the following fields: entry_type, entry_source.display_name. The comparison operators are =, !=, <, >, <=, >= (strings are compared according to lexical order) The logical operators AND, OR, NOT can be used in the filter. Wildcard \"*\" can be used, but for entry_type the full project id or number needs to be provided. Example filter expressions: \"entry_source.display_name=AnExampleDisplayName\" \"entry_type=projects/example-project/locations/global/entryTypes/example-entry_type\" \"entry_type=projects/example-project/locations/us/entryTypes/a* OR entry_type=projects/another-project/locations/*\" \"NOT entry_source.display_name=AnotherExampleDisplayName\"", + "description": "Optional. A filter on the entries to return. Filters are case-sensitive. You can filter the request by the following fields: entry_type entry_source.display_nameThe comparison operators are =, !=, <, >, <=, >=. The service compares strings according to lexical order.You can use the logical operators AND, OR, NOT in the filter.You can use Wildcard \"*\", but for entry_type you need to provide the full project id or number.Example filter expressions: \"entry_source.display_name=AnExampleDisplayName\" \"entry_type=projects/example-project/locations/global/entryTypes/example-entry_type\" \"entry_type=projects/example-project/locations/us/entryTypes/a* OR entry_type=projects/another-project/locations/*\" \"NOT entry_source.display_name=AnotherExampleDisplayName\"", "location": "query", "type": "string" }, "pageSize": { + "description": "Optional. Number of items to return per page. If there are remaining results, the service returns a next_page_token. If unspecified, the service returns at most 10 Entries. The maximum value is 100; values above 100 will be coerced to 100.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { - "description": "Optional. The pagination token returned by a previous request.", + "description": "Optional. Page token received from a previous ListEntries call. Provide this to retrieve the subsequent page.", "location": "query", "type": "string" }, @@ -2251,18 +2253,18 @@ ], "parameters": { "allowMissing": { - "description": "Optional. If set to true and the entry does not exist, it will be created.", + "description": "Optional. If set to true and the entry doesn't exist, the service will create it.", "location": "query", "type": "boolean" }, "aspectKeys": { - "description": "Optional. The map keys of the Aspects which should be modified. Supports the following syntaxes: * - matches aspect on given type and empty path * @path - matches aspect on given type and specified path * * - matches aspects on given type for all paths * *@path - matches aspects of all types on the given pathExisting aspects matching the syntax will not be removed unless delete_missing_aspects is set to true.If this field is left empty, it will be treated as specifying exactly those Aspects present in the request.", + "description": "Optional. The map keys of the Aspects which the service should modify. It supports the following syntaxes: - matches an aspect of the given type and empty path. @path - matches an aspect of the given type and specified path. * - matches aspects of the given type for all paths. *@path - matches aspects of all types on the given path.The service will not remove existing aspects matching the syntax unless delete_missing_aspects is set to true.If this field is left empty, the service treats it as specifying exactly those Aspects present in the request.", "location": "query", "repeated": true, "type": "string" }, "deleteMissingAspects": { - "description": "Optional. If set to true and the aspect_keys specify aspect ranges, any existing aspects from that range not provided in the request will be deleted.", + "description": "Optional. If set to true and the aspect_keys specify aspect ranges, the service deletes any existing aspects from that range that weren't provided in the request.", "location": "query", "type": "boolean" }, @@ -2274,7 +2276,7 @@ "type": "string" }, "updateMask": { - "description": "Optional. Mask of fields to update. To update Aspects, the update_mask must contain the value \"aspects\".If the update_mask is empty, all modifiable fields present in the request will be updated.", + "description": "Optional. Mask of fields to update. To update Aspects, the update_mask must contain the value \"aspects\".If the update_mask is empty, the service will update all modifiable fields present in the request.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -2298,7 +2300,7 @@ "entryTypes": { "methods": { "create": { - "description": "Creates an EntryType", + "description": "Creates an EntryType.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/entryTypes", "httpMethod": "POST", "id": "dataplex.projects.locations.entryTypes.create", @@ -2312,14 +2314,14 @@ "type": "string" }, "parent": { - "description": "Required. The resource name of the EntryType, of the form: projects/{project_number}/locations/{location_id} where location_id refers to a GCP region.", + "description": "Required. The resource name of the EntryType, of the form: projects/{project_number}/locations/{location_id} where location_id refers to a Google Cloud region.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" }, "validateOnly": { - "description": "Optional. Only validate the request, but do not perform mutations. The default is false.", + "description": "Optional. The service validates the request without performing any mutations. The default is false.", "location": "query", "type": "boolean" } @@ -2336,7 +2338,7 @@ ] }, "delete": { - "description": "Deletes a EntryType resource.", + "description": "Deletes an EntryType.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/entryTypes/{entryTypesId}", "httpMethod": "DELETE", "id": "dataplex.projects.locations.entryTypes.delete", @@ -2345,7 +2347,7 @@ ], "parameters": { "etag": { - "description": "Optional. If the client provided etag value does not match the current etag value, the DeleteEntryTypeRequest method returns an ABORTED error response", + "description": "Optional. If the client provided etag value does not match the current etag value, the DeleteEntryTypeRequest method returns an ABORTED error response.", "location": "query", "type": "string" }, @@ -2366,7 +2368,7 @@ ] }, "get": { - "description": "Retrieves a EntryType resource.", + "description": "Gets an EntryType.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/entryTypes/{entryTypesId}", "httpMethod": "GET", "id": "dataplex.projects.locations.entryTypes.get", @@ -2431,28 +2433,28 @@ ], "parameters": { "filter": { - "description": "Optional. Filter request. Filters are case-sensitive. The following formats are supported:labels.key1 = \"value1\" labels:key1 name = \"value\" These restrictions can be coinjoined with AND, OR and NOT conjunctions.", + "description": "Optional. Filter request. Filters are case-sensitive. The service supports the following formats: labels.key1 = \"value1\" labels:key1 name = \"value\"These restrictions can be conjoined with AND, OR, and NOT conjunctions.", "location": "query", "type": "string" }, "orderBy": { - "description": "Optional. Order by fields (name or create_time) for the result. If not specified, the ordering is undefined.", + "description": "Optional. Orders the result by name or create_time fields. If not specified, the ordering is undefined.", "location": "query", "type": "string" }, "pageSize": { - "description": "Optional. Maximum number of EntryTypes to return. The service may return fewer than this value. If unspecified, at most 10 EntryTypes will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", + "description": "Optional. Maximum number of EntryTypes to return. The service may return fewer than this value. If unspecified, the service returns at most 10 EntryTypes. The maximum value is 1000; values above 1000 will be coerced to 1000.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { - "description": "Optional. Page token received from a previous ListEntryTypes call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListEntryTypes must match the call that provided the page token.", + "description": "Optional. Page token received from a previous ListEntryTypes call. Provide this to retrieve the subsequent page. When paginating, all other parameters you provided to ListEntryTypes must match the call that provided the page token.", "location": "query", "type": "string" }, "parent": { - "description": "Required. The resource name of the EntryType location, of the form: projects/{project_number}/locations/{location_id} where location_id refers to a GCP region.", + "description": "Required. The resource name of the EntryType location, of the form: projects/{project_number}/locations/{location_id} where location_id refers to a Google Cloud region.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -2468,7 +2470,7 @@ ] }, "patch": { - "description": "Updates a EntryType resource.", + "description": "Updates an EntryType.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/entryTypes/{entryTypesId}", "httpMethod": "PATCH", "id": "dataplex.projects.locations.entryTypes.patch", @@ -2490,7 +2492,7 @@ "type": "string" }, "validateOnly": { - "description": "Optional. Only validate the request, but do not perform mutations. The default is false.", + "description": "Optional. The service validates the request without performing any mutations. The default is false.", "location": "query", "type": "boolean" } @@ -5271,7 +5273,7 @@ } } }, - "revision": "20240611", + "revision": "20240705", "rootUrl": "https://dataplex.googleapis.com/", "schemas": { "Empty": { @@ -5512,7 +5514,7 @@ "description": "Properties of the object.", "type": "any" }, - "description": "Required. The content of the aspect, according to its aspect type schema. This will replace content. The maximum size of the field is 120KB (encoded as UTF-8).", + "description": "Required. The content of the aspect, according to its aspect type schema. The maximum size of the field is 120KB (encoded as UTF-8).", "type": "object" }, "path": { @@ -5530,7 +5532,7 @@ "type": "object" }, "GoogleCloudDataplexV1AspectSource": { - "description": "AspectSource contains source system related information for the aspect.", + "description": "AspectSource contains information related to the source system of the Aspect.", "id": "GoogleCloudDataplexV1AspectSource", "properties": { "createTime": { @@ -5547,12 +5549,12 @@ "type": "object" }, "GoogleCloudDataplexV1AspectType": { - "description": "Aspect Type is a template for creating Aspects, and represents the JSON-schema for a given Entry, e.g., BigQuery Table Schema.", + "description": "AspectType is a template for creating Aspects, and represents the JSON-schema for a given Entry, for example, BigQuery Table Schema.", "id": "GoogleCloudDataplexV1AspectType", "properties": { "authorization": { "$ref": "GoogleCloudDataplexV1AspectTypeAuthorization", - "description": "Immutable. Authorization defined for this type." + "description": "Immutable. Defines the Authorization for this type." }, "createTime": { "description": "Output only. The time when the AspectType was created.", @@ -5569,7 +5571,7 @@ "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.", + "description": "The service computes this checksum. The client may send it on update and delete requests to ensure it has an up-to-date value before proceeding.", "type": "string" }, "labels": { @@ -5588,23 +5590,8 @@ "readOnly": true, "type": "string" }, - "transferStatus": { - "description": "Output only. Denotes the transfer status of the Aspect Type. It is unspecified for Aspect Types created from Dataplex API.", - "enum": [ - "TRANSFER_STATUS_UNSPECIFIED", - "TRANSFER_STATUS_MIGRATED", - "TRANSFER_STATUS_TRANSFERRED" - ], - "enumDescriptions": [ - "The default value. It is set for resources that were not subject for migration from Data Catalog service.", - "Indicates that a resource was migrated from Data Catalog service but it hasn't been transferred yet. In particular the resource cannot be updated from Dataplex API.", - "Indicates that a resource was transferred from Data Catalog service. The resource can only be updated from Dataplex API." - ], - "readOnly": true, - "type": "string" - }, "uid": { - "description": "Output only. System generated globally unique ID for the AspectType. This ID will be different if the AspectType is deleted and re-created with the same name.", + "description": "Output only. System generated globally unique ID for the AspectType. If you delete and recreate the AspectType with the same name, then this ID will be different.", "readOnly": true, "type": "string" }, @@ -5618,18 +5605,18 @@ "type": "object" }, "GoogleCloudDataplexV1AspectTypeAuthorization": { - "description": "Autorization for an Aspect Type.", + "description": "Autorization for an AspectType.", "id": "GoogleCloudDataplexV1AspectTypeAuthorization", "properties": { "alternateUsePermission": { - "description": "Immutable. The IAM permission grantable on the Entry Group to allow access to instantiate Aspects of Dataplex owned Aspect Types, only settable for Dataplex owned Types.", + "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.", "type": "string" } }, "type": "object" }, "GoogleCloudDataplexV1AspectTypeMetadataTemplate": { - "description": "MetadataTemplate definition for AspectType", + "description": "MetadataTemplate definition for an AspectType.", "id": "GoogleCloudDataplexV1AspectTypeMetadataTemplate", "properties": { "annotations": { @@ -5638,14 +5625,14 @@ }, "arrayItems": { "$ref": "GoogleCloudDataplexV1AspectTypeMetadataTemplate", - "description": "Optional. array_items needs to be set if the type is array. array_items can refer to a primitive field or a complex (record only) field. To specify a primitive field, just name and type needs to be set in the nested MetadataTemplate. The recommended value for the name field is item, as this is not used in the actual payload." + "description": "Optional. If the type is array, set array_items. array_items can refer to a primitive field or a complex (record only) field. To specify a primitive field, you only need to set name and type in the nested MetadataTemplate. The recommended value for the name field is item, as this isn't used in the actual payload." }, "constraints": { "$ref": "GoogleCloudDataplexV1AspectTypeMetadataTemplateConstraints", "description": "Optional. Specifies the constraints on this field." }, "enumValues": { - "description": "Optional. The list of values for an enum type. Needs to be defined if the type is enum.", + "description": "Optional. The list of values for an enum type. You must define it if the type is enum.", "items": { "$ref": "GoogleCloudDataplexV1AspectTypeMetadataTemplateEnumValue" }, @@ -5658,61 +5645,61 @@ }, "mapItems": { "$ref": "GoogleCloudDataplexV1AspectTypeMetadataTemplate", - "description": "Optional. map_items needs to be set if the type is map. map_items can refer to a primitive field or a complex (record only) field. To specify a primitive field, just name and type needs to be set in the nested MetadataTemplate. The recommended value for the name field is item, as this is not used in the actual payload." + "description": "Optional. If the type is map, set map_items. map_items can refer to a primitive field or a complex (record only) field. To specify a primitive field, you only need to set name and type in the nested MetadataTemplate. The recommended value for the name field is item, as this isn't used in the actual payload." }, "name": { "description": "Required. The name of the field.", "type": "string" }, "recordFields": { - "description": "Optional. Field definition, needs to be specified if the type is record. Defines the nested fields.", + "description": "Optional. Field definition. You must specify it if the type is record. It defines the nested fields.", "items": { "$ref": "GoogleCloudDataplexV1AspectTypeMetadataTemplate" }, "type": "array" }, "type": { - "description": "Required. The datatype of this field. The following values are supported: Primitive types (string, integer, boolean, double, datetime); 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).", + "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", "type": "string" }, "typeId": { - "description": "Optional. Id can be used if this definition of the field needs to be reused later. Id needs to be unique across the entire template. Id can only be specified if the field type is record.", + "description": "Optional. You can use type id if this definition of the field needs to be reused later. The type id must be unique across the entire template. You can only specify it if the field type is record.", "type": "string" }, "typeRef": { - "description": "Optional. A reference to another field definition (instead of an inline definition). The value must be equal to the value of an id field defined elsewhere in the MetadataTemplate. Only fields with type as record can refer to other fields.", + "description": "Optional. A reference to another field definition (not an inline definition). The value must be equal to the value of an id field defined elsewhere in the MetadataTemplate. Only fields with record type can refer to other fields.", "type": "string" } }, "type": "object" }, "GoogleCloudDataplexV1AspectTypeMetadataTemplateAnnotations": { - "description": "Definition of the annotations of a field", + "description": "Definition of the annotations of a field.", "id": "GoogleCloudDataplexV1AspectTypeMetadataTemplateAnnotations", "properties": { "deprecated": { - "description": "Optional. Marks a field as deprecated, a deprecation message can be included.", + "description": "Optional. Marks a field as deprecated. You can include a deprecation message.", "type": "string" }, "description": { - "description": "Optional. Specify a description for a field", + "description": "Optional. Description for a field.", "type": "string" }, "displayName": { - "description": "Optional. Specify a displayname for a field.", + "description": "Optional. Display name for a field.", "type": "string" }, "displayOrder": { - "description": "Optional. Specify a display order for a field. Display order can be used to reorder where a field is rendered", + "description": "Optional. Display order for a field. You can use this to reorder where a field is rendered.", "format": "int32", "type": "integer" }, "stringType": { - "description": "Optional. String Type annotations can be used to specify special meaning to string fields. The following values are supported: richText: The field must be interpreted as a rich text field. url: A fully qualified url link. resource: A service qualified resource reference.", + "description": "Optional. You can use String Type annotations to specify special meaning to string fields. The following values are supported: richText: The field must be interpreted as a rich text field. url: A fully qualified URL link. resource: A service qualified resource reference.", "type": "string" }, "stringValues": { - "description": "Optional. Suggested hints for string fields. These can be used to suggest values to users, through an UI for example.", + "description": "Optional. Suggested hints for string fields. You can use them to suggest values to users through console.", "items": { "type": "string" }, @@ -5722,31 +5709,31 @@ "type": "object" }, "GoogleCloudDataplexV1AspectTypeMetadataTemplateConstraints": { - "description": "Definition of the constraints of a field", + "description": "Definition of the constraints of a field.", "id": "GoogleCloudDataplexV1AspectTypeMetadataTemplateConstraints", "properties": { "required": { - "description": "Optional. Marks this as an optional/required field.", + "description": "Optional. Marks this field as optional or required.", "type": "boolean" } }, "type": "object" }, "GoogleCloudDataplexV1AspectTypeMetadataTemplateEnumValue": { - "description": "Definition of Enumvalue (to be used by enum fields)", + "description": "Definition of Enumvalue, to be used for enum fields.", "id": "GoogleCloudDataplexV1AspectTypeMetadataTemplateEnumValue", "properties": { "deprecated": { - "description": "Optional. Optional deprecation message to be set if an enum value needs to be deprecated.", + "description": "Optional. You can set this message if you need to deprecate an enum value.", "type": "string" }, "index": { - "description": "Required. Index for the enum. Cannot be modified.", + "description": "Required. Index for the enum value. It can't be modified.", "format": "int32", "type": "integer" }, "name": { - "description": "Required. Name of the enumvalue. This is the actual value that the aspect will contain.", + "description": "Required. Name of the enumvalue. This is the actual value that the aspect can contain.", "type": "string" } }, @@ -7709,6 +7696,12 @@ "description": "A DataScanJob represents an instance of DataScan execution.", "id": "GoogleCloudDataplexV1DataScanJob", "properties": { + "createTime": { + "description": "Output only. The time when the DataScanJob was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, "dataProfileResult": { "$ref": "GoogleCloudDataplexV1DataProfileResult", "description": "Output only. The result of the data profile scan.", @@ -8175,7 +8168,7 @@ "additionalProperties": { "$ref": "GoogleCloudDataplexV1Aspect" }, - "description": "Optional. The Aspects attached to the Entry. The format for the key can be one of the following: 1. {projectId}.{locationId}.{aspectTypeId} (if the aspect is attached directly to the entry) 2. {projectId}.{locationId}.{aspectTypeId}@{path} (if the aspect is attached to an entry's path)", + "description": "Optional. The Aspects attached to the Entry. The format for the key can be one of the following: {projectId}.{locationId}.{aspectTypeId} (if the aspect is attached directly to the entry) {projectId}.{locationId}.{aspectTypeId}@{path} (if the aspect is attached to an entry's path)", "type": "object" }, "createTime": { @@ -8186,7 +8179,7 @@ }, "entrySource": { "$ref": "GoogleCloudDataplexV1EntrySource", - "description": "Optional. Source system related information for an entry." + "description": "Optional. Information related to the source system for an entry." }, "entryType": { "description": "Required. Immutable. The resource name of the EntryType used to create this Entry.", @@ -8232,7 +8225,7 @@ "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.", + "description": "This checksum is computed by the service, and might be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.", "type": "string" }, "labels": { @@ -8247,23 +8240,8 @@ "readOnly": true, "type": "string" }, - "transferStatus": { - "description": "Output only. Denotes the transfer status of the Entry Group. It is unspecified for Entry Group created from Dataplex API.", - "enum": [ - "TRANSFER_STATUS_UNSPECIFIED", - "TRANSFER_STATUS_MIGRATED", - "TRANSFER_STATUS_TRANSFERRED" - ], - "enumDescriptions": [ - "The default value. It is set for resources that were not subject for migration from Data Catalog service.", - "Indicates that a resource was migrated from Data Catalog service but it hasn't been transferred yet. In particular the resource cannot be updated from Dataplex API.", - "Indicates that a resource was transferred from Data Catalog service. The resource can only be updated from Dataplex API." - ], - "readOnly": true, - "type": "string" - }, "uid": { - "description": "Output only. System generated globally unique ID for the EntryGroup. This ID will be different if the EntryGroup is deleted and re-created with the same name.", + "description": "Output only. System generated globally unique ID for the EntryGroup. If you delete and recreate the EntryGroup with the same name, this ID will be different.", "readOnly": true, "type": "string" }, @@ -8277,7 +8255,7 @@ "type": "object" }, "GoogleCloudDataplexV1EntrySource": { - "description": "EntrySource contains source system related information for the entry.", + "description": "EntrySource contains information related to the source system of the Entry.", "id": "GoogleCloudDataplexV1EntrySource", "properties": { "ancestors": { @@ -8308,7 +8286,7 @@ "type": "object" }, "location": { - "description": "Output only. Location of the resource in the source system. Entry will be searchable by this location. By default, this should match the location of the EntryGroup containing this entry. A different value allows capturing source location for data external to GCP.", + "description": "Output only. Location of the resource in the source system. You can search the Entry by this location. By default, this should match the location of the EntryGroup containing this entry. A different value allows capturing the source location for data external to Google Cloud.", "readOnly": true, "type": "string" }, @@ -8370,7 +8348,7 @@ "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.", + "description": "Optional. This checksum is computed by the service, and might be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.", "type": "string" }, "labels": { @@ -8401,7 +8379,7 @@ "type": "string" }, "typeAliases": { - "description": "Optional. Indicates the class this Entry Type belongs to, for example, TABLE, DATABASE, MODEL.", + "description": "Optional. Indicates the classes this Entry Type belongs to, for example, TABLE, DATABASE, MODEL.", "items": { "type": "string" }, @@ -9090,11 +9068,11 @@ "type": "object" }, "GoogleCloudDataplexV1ListAspectTypesResponse": { - "description": "List AspectTypes response", + "description": "List AspectTypes response.", "id": "GoogleCloudDataplexV1ListAspectTypesResponse", "properties": { "aspectTypes": { - "description": "ListAspectTypes under the given parent location.", + "description": "AspectTypes under the given parent location.", "items": { "$ref": "GoogleCloudDataplexV1AspectType" }, @@ -9105,7 +9083,7 @@ "type": "string" }, "unreachableLocations": { - "description": "Locations that could not be reached.", + "description": "Locations that the service couldn't reach.", "items": { "type": "string" }, @@ -9287,28 +9265,29 @@ "type": "object" }, "GoogleCloudDataplexV1ListEntriesResponse": { + "description": "List Entries response.", "id": "GoogleCloudDataplexV1ListEntriesResponse", "properties": { "entries": { - "description": "The list of entries.", + "description": "The list of entries under the given parent location.", "items": { "$ref": "GoogleCloudDataplexV1Entry" }, "type": "array" }, "nextPageToken": { - "description": "Pagination token.", + "description": "Token to retrieve the next page of results, or empty if there are no more results in the list.", "type": "string" } }, "type": "object" }, "GoogleCloudDataplexV1ListEntryGroupsResponse": { - "description": "List ListEntryGroups response.", + "description": "List entry groups response.", "id": "GoogleCloudDataplexV1ListEntryGroupsResponse", "properties": { "entryGroups": { - "description": "ListEntryGroups under the given parent location.", + "description": "Entry groups under the given parent location.", "items": { "$ref": "GoogleCloudDataplexV1EntryGroup" }, @@ -9319,7 +9298,7 @@ "type": "string" }, "unreachableLocations": { - "description": "Locations that could not be reached.", + "description": "Locations that the service couldn't reach.", "items": { "type": "string" }, @@ -9329,11 +9308,11 @@ "type": "object" }, "GoogleCloudDataplexV1ListEntryTypesResponse": { - "description": "List EntryTypes response", + "description": "List EntryTypes response.", "id": "GoogleCloudDataplexV1ListEntryTypesResponse", "properties": { "entryTypes": { - "description": "ListEntryTypes under the given parent location.", + "description": "EntryTypes under the given parent location.", "items": { "$ref": "GoogleCloudDataplexV1EntryType" }, @@ -9344,7 +9323,7 @@ "type": "string" }, "unreachableLocations": { - "description": "Locations that could not be reached.", + "description": "Locations that the service couldn't reach.", "items": { "type": "string" }, @@ -9840,7 +9819,7 @@ "id": "GoogleCloudDataplexV1SearchEntriesResponse", "properties": { "nextPageToken": { - "description": "Pagination token.", + "description": "Token to retrieve the next page of results, or empty if there are no more results in the list.", "type": "string" }, "results": { @@ -9851,12 +9830,12 @@ "type": "array" }, "totalSize": { - "description": "The estimated total number of matching entries. Not guaranteed to be accurate.", + "description": "The estimated total number of matching entries. This number isn't guaranteed to be accurate.", "format": "int32", "type": "integer" }, "unreachable": { - "description": "Unreachable locations. Search results don't include data from those locations.", + "description": "Locations that the service couldn't reach. Search results don't include data from these locations.", "items": { "type": "string" }, diff --git a/discovery/dialogflow-v2.json b/discovery/dialogflow-v2.json index 2f4cc9d6c0..ce117a7a87 100644 --- a/discovery/dialogflow-v2.json +++ b/discovery/dialogflow-v2.json @@ -4343,6 +4343,32 @@ "https://www.googleapis.com/auth/dialogflow" ] }, + "getEncryptionSpec": { + "description": "Gets location-level encryption key specification.", + "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/encryptionSpec", + "httpMethod": "GET", + "id": "dialogflow.projects.locations.getEncryptionSpec", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the encryption spec resource to get.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/encryptionSpec$", + "required": true, + "type": "string" + } + }, + "path": "v2/{+name}", + "response": { + "$ref": "GoogleCloudDialogflowV2EncryptionSpec" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + }, "list": { "description": "Lists information about the supported locations for this service.", "flatPath": "v2/projects/{projectsId}/locations", @@ -7717,6 +7743,39 @@ } } }, + "encryptionSpec": { + "methods": { + "initialize": { + "description": "Initializes a location-level encryption key specification. An error will be thrown if the location has resources already created before the initialization. Once 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.", + "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/encryptionSpec:initialize", + "httpMethod": "POST", + "id": "dialogflow.projects.locations.encryptionSpec.initialize", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Immutable. The resource name of the encryption key specification resource. Format: projects/{project}/locations/{location}/encryptionSpec", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/encryptionSpec$", + "required": true, + "type": "string" + } + }, + "path": "v2/{+name}:initialize", + "request": { + "$ref": "GoogleCloudDialogflowV2InitializeEncryptionSpecRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + } + } + }, "generators": { "methods": { "create": { @@ -8655,7 +8714,7 @@ } } }, - "revision": "20240614", + "revision": "20240704", "rootUrl": "https://dialogflow.googleapis.com/", "schemas": { "GoogleCloudDialogflowCxV3AdvancedSettings": { @@ -9167,6 +9226,10 @@ "description": "The target page to transition to. Format: `projects//locations//agents//flows//pages/`.", "type": "string" }, + "targetPlaybook": { + "description": "The target playbook to transition to. Format: `projects//locations//agents//playbooks/`.", + "type": "string" + }, "triggerFulfillment": { "$ref": "GoogleCloudDialogflowCxV3Fulfillment", "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." @@ -10472,11 +10535,11 @@ "id": "GoogleCloudDialogflowCxV3TestConfig", "properties": { "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 both are set, `page` takes precedence over `flow`. If neither is set, the test case will start with start page on the default start 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" }, "page": { - "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 both are set, `page` takes precedence over `flow`. If neither is set, the test case will start with start page on the default start flow.", + "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.", "type": "string" }, "trackingParameters": { @@ -11557,6 +11620,10 @@ "description": "The target page to transition to. Format: `projects//locations//agents//flows//pages/`.", "type": "string" }, + "targetPlaybook": { + "description": "The target playbook to transition to. Format: `projects//locations//agents//playbooks/`.", + "type": "string" + }, "triggerFulfillment": { "$ref": "GoogleCloudDialogflowCxV3beta1Fulfillment", "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." @@ -12854,11 +12921,11 @@ "id": "GoogleCloudDialogflowCxV3beta1TestConfig", "properties": { "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 both are set, `page` takes precedence over `flow`. If neither is set, the test case will start with start page on the default start 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" }, "page": { - "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 both are set, `page` takes precedence over `flow`. If neither is set, the test case will start with start page on the default start flow.", + "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.", "type": "string" }, "trackingParameters": { @@ -15013,6 +15080,21 @@ }, "type": "object" }, + "GoogleCloudDialogflowV2EncryptionSpec": { + "description": "A customer-managed encryption key specification that can be applied to all created resources (e.g. Conversation).", + "id": "GoogleCloudDialogflowV2EncryptionSpec", + "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 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" + }, + "name": { + "description": "Immutable. The resource name of the encryption key specification resource. Format: projects/{project}/locations/{location}/encryptionSpec", + "type": "string" + } + }, + "type": "object" + }, "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).", "id": "GoogleCloudDialogflowV2EntityType", @@ -16217,6 +16299,29 @@ }, "type": "object" }, + "GoogleCloudDialogflowV2InitializeEncryptionSpecMetadata": { + "description": "Metadata for initializing a location-level encryption specification.", + "id": "GoogleCloudDialogflowV2InitializeEncryptionSpecMetadata", + "properties": { + "request": { + "$ref": "GoogleCloudDialogflowV2InitializeEncryptionSpecRequest", + "description": "Output only. The original request for initialization.", + "readOnly": true + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2InitializeEncryptionSpecRequest": { + "description": "The request to initialize a location-level encryption specification.", + "id": "GoogleCloudDialogflowV2InitializeEncryptionSpecRequest", + "properties": { + "encryptionSpec": { + "$ref": "GoogleCloudDialogflowV2EncryptionSpec", + "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." + } + }, + "type": "object" + }, "GoogleCloudDialogflowV2InputAudioConfig": { "description": "Instructs the speech recognizer how to process the audio content.", "id": "GoogleCloudDialogflowV2InputAudioConfig", @@ -18581,10 +18686,54 @@ "description": "Configures speech transcription for ConversationProfile.", "id": "GoogleCloudDialogflowV2SpeechToTextConfig", "properties": { + "alternativeLanguageCodes": { + "description": "Defines the list of other language codes in addition to the one provided by the conversation profile that may be detected as the language code for the utterances over the conversation. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes.", + "items": { + "type": "string" + }, + "type": "array" + }, + "audioEncoding": { + "description": "Audio encoding of the audio content to process.", + "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" + ], + "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." + ], + "type": "string" + }, + "enableWordInfo": { + "description": "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" + }, + "languageCode": { + "description": "The language of the supplied audio. Dialogflow does not do translations. 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.", + "type": "string" + }, "model": { "description": "Which Speech model to select. Select the model best suited to your domain to get best results. If a model is not explicitly specified, then Dialogflow auto-selects a model based on other parameters in the SpeechToTextConfig and Agent settings. If enhanced speech model is enabled for the agent and an enhanced version of the specified model for the language does not exist, then the speech is recognized using the standard version of the specified model. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics#select-model) for more details. If you specify a model, the following models typically have the best performance: - phone_call (best for Agent Assist and telephony) - latest_short (best for Dialogflow non-telephony) - command_and_search Leave this field unspecified to use [Agent Speech settings](https://cloud.google.com/dialogflow/cx/docs/concept/agent#settings-speech) for model selection.", "type": "string" }, + "sampleRateHertz": { + "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.", + "format": "int32", + "type": "integer" + }, "speechModelVariant": { "description": "The speech model used in speech to text. `SPEECH_MODEL_VARIANT_UNSPECIFIED`, `USE_BEST_AVAILABLE` will be treated as `USE_ENHANCED`. It can be overridden in AnalyzeContentRequest and StreamingAnalyzeContentRequest request. If enhanced model variant is specified and an enhanced version of the specified model for the language does not exist, then it would emit an error.", "enum": [ @@ -19551,6 +19700,21 @@ }, "type": "object" }, + "GoogleCloudDialogflowV2beta1EncryptionSpec": { + "description": "A customer-managed encryption key specification that can be applied to all created resources (e.g. Conversation).", + "id": "GoogleCloudDialogflowV2beta1EncryptionSpec", + "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 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" + }, + "name": { + "description": "Immutable. The resource name of the encryption key specification resource. Format: projects/{project}/locations/{location}/encryptionSpec", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDialogflowV2beta1EntityType": { "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).", "id": "GoogleCloudDialogflowV2beta1EntityType", @@ -19755,6 +19919,29 @@ }, "type": "object" }, + "GoogleCloudDialogflowV2beta1InitializeEncryptionSpecMetadata": { + "description": "Metadata for initializing a location-level encryption specification.", + "id": "GoogleCloudDialogflowV2beta1InitializeEncryptionSpecMetadata", + "properties": { + "request": { + "$ref": "GoogleCloudDialogflowV2beta1InitializeEncryptionSpecRequest", + "description": "Output only. The original request for initialization.", + "readOnly": true + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2beta1InitializeEncryptionSpecRequest": { + "description": "The request to initialize a location-level encryption specification.", + "id": "GoogleCloudDialogflowV2beta1InitializeEncryptionSpecRequest", + "properties": { + "encryptionSpec": { + "$ref": "GoogleCloudDialogflowV2beta1EncryptionSpec", + "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." + } + }, + "type": "object" + }, "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).", "id": "GoogleCloudDialogflowV2beta1Intent", @@ -21214,6 +21401,13 @@ "readOnly": true, "type": "string" }, + "responseMessages": { + "description": "Optional. Automated agent responses.", + "items": { + "$ref": "GoogleCloudDialogflowV2beta1ResponseMessage" + }, + "type": "array" + }, "sendTime": { "description": "Optional. The time when the message was sent.", "format": "google-datetime", @@ -21363,6 +21557,125 @@ }, "type": "object" }, + "GoogleCloudDialogflowV2beta1ResponseMessage": { + "description": "Response messages from an automated agent.", + "id": "GoogleCloudDialogflowV2beta1ResponseMessage", + "properties": { + "endInteraction": { + "$ref": "GoogleCloudDialogflowV2beta1ResponseMessageEndInteraction", + "description": "A signal that indicates the interaction with the Dialogflow agent has ended." + }, + "liveAgentHandoff": { + "$ref": "GoogleCloudDialogflowV2beta1ResponseMessageLiveAgentHandoff", + "description": "Hands off conversation to a live agent." + }, + "mixedAudio": { + "$ref": "GoogleCloudDialogflowV2beta1ResponseMessageMixedAudio", + "description": "An audio response message composed of both the synthesized Dialogflow agent responses and the audios hosted in places known to the client." + }, + "payload": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Returns a response containing a custom, platform-specific payload.", + "type": "object" + }, + "telephonyTransferCall": { + "$ref": "GoogleCloudDialogflowV2beta1ResponseMessageTelephonyTransferCall", + "description": "A signal that the client should transfer the phone call connected to this agent to a third-party endpoint." + }, + "text": { + "$ref": "GoogleCloudDialogflowV2beta1ResponseMessageText", + "description": "Returns a text response." + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2beta1ResponseMessageEndInteraction": { + "description": "Indicates that interaction with the Dialogflow agent has ended.", + "id": "GoogleCloudDialogflowV2beta1ResponseMessageEndInteraction", + "properties": {}, + "type": "object" + }, + "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.", + "id": "GoogleCloudDialogflowV2beta1ResponseMessageLiveAgentHandoff", + "properties": { + "metadata": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this.", + "type": "object" + } + }, + "type": "object" + }, + "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.", + "id": "GoogleCloudDialogflowV2beta1ResponseMessageMixedAudio", + "properties": { + "segments": { + "description": "Segments this audio response is composed of.", + "items": { + "$ref": "GoogleCloudDialogflowV2beta1ResponseMessageMixedAudioSegment" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2beta1ResponseMessageMixedAudioSegment": { + "description": "Represents one segment of audio.", + "id": "GoogleCloudDialogflowV2beta1ResponseMessageMixedAudioSegment", + "properties": { + "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" + }, + "audio": { + "description": "Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request.", + "format": "byte", + "type": "string" + }, + "uri": { + "description": "Client-specific URI that points to an audio clip accessible to the client.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2beta1ResponseMessageTelephonyTransferCall": { + "description": "Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint.", + "id": "GoogleCloudDialogflowV2beta1ResponseMessageTelephonyTransferCall", + "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" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2beta1ResponseMessageText": { + "description": "The text response message.", + "id": "GoogleCloudDialogflowV2beta1ResponseMessageText", + "properties": { + "text": { + "description": "A collection of text responses.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "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.", "id": "GoogleCloudDialogflowV2beta1Sentiment", diff --git a/discovery/dialogflow-v2beta1.json b/discovery/dialogflow-v2beta1.json index cef253fd7d..260ca6e7ae 100644 --- a/discovery/dialogflow-v2beta1.json +++ b/discovery/dialogflow-v2beta1.json @@ -4108,6 +4108,32 @@ "https://www.googleapis.com/auth/dialogflow" ] }, + "getEncryptionSpec": { + "description": "Gets location-level encryption key specification.", + "flatPath": "v2beta1/projects/{projectsId}/locations/{locationsId}/encryptionSpec", + "httpMethod": "GET", + "id": "dialogflow.projects.locations.getEncryptionSpec", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the encryption spec resource to get.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/encryptionSpec$", + "required": true, + "type": "string" + } + }, + "path": "v2beta1/{+name}", + "response": { + "$ref": "GoogleCloudDialogflowV2beta1EncryptionSpec" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + }, "list": { "description": "Lists information about the supported locations for this service.", "flatPath": "v2beta1/projects/{projectsId}/locations", @@ -7109,6 +7135,39 @@ } } }, + "encryptionSpec": { + "methods": { + "initialize": { + "description": "Initializes a location-level encryption key specification. An error will be thrown if the location has resources already created before the initialization. Once 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.", + "flatPath": "v2beta1/projects/{projectsId}/locations/{locationsId}/encryptionSpec:initialize", + "httpMethod": "POST", + "id": "dialogflow.projects.locations.encryptionSpec.initialize", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Immutable. The resource name of the encryption key specification resource. Format: projects/{project}/locations/{location}/encryptionSpec", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/encryptionSpec$", + "required": true, + "type": "string" + } + }, + "path": "v2beta1/{+name}:initialize", + "request": { + "$ref": "GoogleCloudDialogflowV2beta1InitializeEncryptionSpecRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + } + } + }, "generators": { "methods": { "create": { @@ -8023,7 +8082,7 @@ } } }, - "revision": "20240614", + "revision": "20240704", "rootUrl": "https://dialogflow.googleapis.com/", "schemas": { "GoogleCloudDialogflowCxV3AdvancedSettings": { @@ -8535,6 +8594,10 @@ "description": "The target page to transition to. Format: `projects//locations//agents//flows//pages/`.", "type": "string" }, + "targetPlaybook": { + "description": "The target playbook to transition to. Format: `projects//locations//agents//playbooks/`.", + "type": "string" + }, "triggerFulfillment": { "$ref": "GoogleCloudDialogflowCxV3Fulfillment", "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." @@ -9840,11 +9903,11 @@ "id": "GoogleCloudDialogflowCxV3TestConfig", "properties": { "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 both are set, `page` takes precedence over `flow`. If neither is set, the test case will start with start page on the default start 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" }, "page": { - "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 both are set, `page` takes precedence over `flow`. If neither is set, the test case will start with start page on the default start flow.", + "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.", "type": "string" }, "trackingParameters": { @@ -10925,6 +10988,10 @@ "description": "The target page to transition to. Format: `projects//locations//agents//flows//pages/`.", "type": "string" }, + "targetPlaybook": { + "description": "The target playbook to transition to. Format: `projects//locations//agents//playbooks/`.", + "type": "string" + }, "triggerFulfillment": { "$ref": "GoogleCloudDialogflowCxV3beta1Fulfillment", "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." @@ -12222,11 +12289,11 @@ "id": "GoogleCloudDialogflowCxV3beta1TestConfig", "properties": { "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 both are set, `page` takes precedence over `flow`. If neither is set, the test case will start with start page on the default start 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" }, "page": { - "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 both are set, `page` takes precedence over `flow`. If neither is set, the test case will start with start page on the default start flow.", + "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.", "type": "string" }, "trackingParameters": { @@ -13274,6 +13341,21 @@ }, "type": "object" }, + "GoogleCloudDialogflowV2EncryptionSpec": { + "description": "A customer-managed encryption key specification that can be applied to all created resources (e.g. Conversation).", + "id": "GoogleCloudDialogflowV2EncryptionSpec", + "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 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" + }, + "name": { + "description": "Immutable. The resource name of the encryption key specification resource. Format: projects/{project}/locations/{location}/encryptionSpec", + "type": "string" + } + }, + "type": "object" + }, "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).", "id": "GoogleCloudDialogflowV2EntityType", @@ -13517,6 +13599,29 @@ }, "type": "object" }, + "GoogleCloudDialogflowV2InitializeEncryptionSpecMetadata": { + "description": "Metadata for initializing a location-level encryption specification.", + "id": "GoogleCloudDialogflowV2InitializeEncryptionSpecMetadata", + "properties": { + "request": { + "$ref": "GoogleCloudDialogflowV2InitializeEncryptionSpecRequest", + "description": "Output only. The original request for initialization.", + "readOnly": true + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2InitializeEncryptionSpecRequest": { + "description": "The request to initialize a location-level encryption specification.", + "id": "GoogleCloudDialogflowV2InitializeEncryptionSpecRequest", + "properties": { + "encryptionSpec": { + "$ref": "GoogleCloudDialogflowV2EncryptionSpec", + "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." + } + }, + "type": "object" + }, "GoogleCloudDialogflowV2InputDataset": { "description": "InputDataset used to create model or do evaluation. NextID:5", "id": "GoogleCloudDialogflowV2InputDataset", @@ -16512,6 +16617,21 @@ }, "type": "object" }, + "GoogleCloudDialogflowV2beta1EncryptionSpec": { + "description": "A customer-managed encryption key specification that can be applied to all created resources (e.g. Conversation).", + "id": "GoogleCloudDialogflowV2beta1EncryptionSpec", + "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 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" + }, + "name": { + "description": "Immutable. The resource name of the encryption key specification resource. Format: projects/{project}/locations/{location}/encryptionSpec", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDialogflowV2beta1EntityType": { "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).", "id": "GoogleCloudDialogflowV2beta1EntityType", @@ -17606,6 +17726,29 @@ }, "type": "object" }, + "GoogleCloudDialogflowV2beta1InitializeEncryptionSpecMetadata": { + "description": "Metadata for initializing a location-level encryption specification.", + "id": "GoogleCloudDialogflowV2beta1InitializeEncryptionSpecMetadata", + "properties": { + "request": { + "$ref": "GoogleCloudDialogflowV2beta1InitializeEncryptionSpecRequest", + "description": "Output only. The original request for initialization.", + "readOnly": true + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2beta1InitializeEncryptionSpecRequest": { + "description": "The request to initialize a location-level encryption specification.", + "id": "GoogleCloudDialogflowV2beta1InitializeEncryptionSpecRequest", + "properties": { + "encryptionSpec": { + "$ref": "GoogleCloudDialogflowV2beta1EncryptionSpec", + "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." + } + }, + "type": "object" + }, "GoogleCloudDialogflowV2beta1InputAudioConfig": { "description": "Instructs the speech recognizer on how to process the audio content.", "id": "GoogleCloudDialogflowV2beta1InputAudioConfig", @@ -19499,6 +19642,13 @@ "readOnly": true, "type": "string" }, + "responseMessages": { + "description": "Optional. Automated agent responses.", + "items": { + "$ref": "GoogleCloudDialogflowV2beta1ResponseMessage" + }, + "type": "array" + }, "sendTime": { "description": "Optional. The time when the message was sent.", "format": "google-datetime", @@ -20363,10 +20513,54 @@ "description": "Configures speech transcription for ConversationProfile.", "id": "GoogleCloudDialogflowV2beta1SpeechToTextConfig", "properties": { + "alternativeLanguageCodes": { + "description": "Defines the list of other language codes in addition to the one provided by the conversation profile that may be detected as the language code for the utterances over the conversation. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes.", + "items": { + "type": "string" + }, + "type": "array" + }, + "audioEncoding": { + "description": "Audio encoding of the audio content to process.", + "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" + ], + "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." + ], + "type": "string" + }, + "enableWordInfo": { + "description": "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" + }, + "languageCode": { + "description": "The language of the supplied audio. Dialogflow does not do translations. 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.", + "type": "string" + }, "model": { "description": "Which Speech model to select. Select the model best suited to your domain to get best results. If a model is not explicitly specified, then Dialogflow auto-selects a model based on other parameters in the SpeechToTextConfig and Agent settings. If enhanced speech model is enabled for the agent and an enhanced version of the specified model for the language does not exist, then the speech is recognized using the standard version of the specified model. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics#select-model) for more details. If you specify a model, the following models typically have the best performance: - phone_call (best for Agent Assist and telephony) - latest_short (best for Dialogflow non-telephony) - command_and_search Leave this field unspecified to use [Agent Speech settings](https://cloud.google.com/dialogflow/cx/docs/concept/agent#settings-speech) for model selection.", "type": "string" }, + "sampleRateHertz": { + "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.", + "format": "int32", + "type": "integer" + }, "speechModelVariant": { "description": "The speech model used in speech to text. `SPEECH_MODEL_VARIANT_UNSPECIFIED`, `USE_BEST_AVAILABLE` will be treated as `USE_ENHANCED`. It can be overridden in AnalyzeContentRequest and StreamingAnalyzeContentRequest request. If enhanced model variant is specified and an enhanced version of the specified model for the language does not exist, then it would emit an error.", "enum": [ diff --git a/discovery/dialogflow-v3.json b/discovery/dialogflow-v3.json index 63873b0e28..cc222defaa 100644 --- a/discovery/dialogflow-v3.json +++ b/discovery/dialogflow-v3.json @@ -4453,7 +4453,7 @@ } } }, - "revision": "20240614", + "revision": "20240704", "rootUrl": "https://dialogflow.googleapis.com/", "schemas": { "GoogleCloudDialogflowCxV3AdvancedSettings": { @@ -5273,6 +5273,10 @@ "description": "Diagnostic info related to the answer generation model call.", "id": "GoogleCloudDialogflowCxV3DataStoreConnectionSignalsAnswerGenerationModelCallSignals", "properties": { + "model": { + "description": "Name of the generative model. For example, \"gemini-ultra\", \"gemini-pro\", \"gemini-1.5-flash\" etc. Defaults to \"Other\" if the model is unknown.", + "type": "string" + }, "modelOutput": { "description": "Output of the generative model.", "type": "string" @@ -5364,6 +5368,10 @@ "description": "Diagnostic info related to the rewriter model call.", "id": "GoogleCloudDialogflowCxV3DataStoreConnectionSignalsRewriterModelCallSignals", "properties": { + "model": { + "description": "Name of the generative model. For example, \"gemini-ultra\", \"gemini-pro\", \"gemini-1.5-flash\" etc. Defaults to \"Other\" if the model is unknown.", + "type": "string" + }, "modelOutput": { "description": "Output of the generative model.", "type": "string" @@ -5827,6 +5835,10 @@ "description": "The target page to transition to. Format: `projects//locations//agents//flows//pages/`.", "type": "string" }, + "targetPlaybook": { + "description": "The target playbook to transition to. Format: `projects//locations//agents//playbooks/`.", + "type": "string" + }, "triggerFulfillment": { "$ref": "GoogleCloudDialogflowCxV3Fulfillment", "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." @@ -7864,6 +7876,7 @@ "NO_MATCH", "NO_INPUT", "EVENT", + "KNOWLEDGE_CONNECTOR", "PLAYBOOK" ], "enumDescriptions": [ @@ -7874,6 +7887,7 @@ "No match was found for the query.", "Indicates an empty query.", "The query directly triggered an event.", + "The query was matched to a Knowledge Connector answer.", "The query was handled by a `Playbook`." ], "type": "string" @@ -9236,11 +9250,11 @@ "id": "GoogleCloudDialogflowCxV3TestConfig", "properties": { "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 both are set, `page` takes precedence over `flow`. If neither is set, the test case will start with start page on the default start 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" }, "page": { - "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 both are set, `page` takes precedence over `flow`. If neither is set, the test case will start with start page on the default start flow.", + "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.", "type": "string" }, "trackingParameters": { @@ -10712,6 +10726,10 @@ "description": "The target page to transition to. Format: `projects//locations//agents//flows//pages/`.", "type": "string" }, + "targetPlaybook": { + "description": "The target playbook to transition to. Format: `projects//locations//agents//playbooks/`.", + "type": "string" + }, "triggerFulfillment": { "$ref": "GoogleCloudDialogflowCxV3beta1Fulfillment", "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." @@ -12009,11 +12027,11 @@ "id": "GoogleCloudDialogflowCxV3beta1TestConfig", "properties": { "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 both are set, `page` takes precedence over `flow`. If neither is set, the test case will start with start page on the default start 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" }, "page": { - "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 both are set, `page` takes precedence over `flow`. If neither is set, the test case will start with start page on the default start flow.", + "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.", "type": "string" }, "trackingParameters": { @@ -13061,6 +13079,21 @@ }, "type": "object" }, + "GoogleCloudDialogflowV2EncryptionSpec": { + "description": "A customer-managed encryption key specification that can be applied to all created resources (e.g. Conversation).", + "id": "GoogleCloudDialogflowV2EncryptionSpec", + "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 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" + }, + "name": { + "description": "Immutable. The resource name of the encryption key specification resource. Format: projects/{project}/locations/{location}/encryptionSpec", + "type": "string" + } + }, + "type": "object" + }, "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).", "id": "GoogleCloudDialogflowV2EntityType", @@ -13304,6 +13337,29 @@ }, "type": "object" }, + "GoogleCloudDialogflowV2InitializeEncryptionSpecMetadata": { + "description": "Metadata for initializing a location-level encryption specification.", + "id": "GoogleCloudDialogflowV2InitializeEncryptionSpecMetadata", + "properties": { + "request": { + "$ref": "GoogleCloudDialogflowV2InitializeEncryptionSpecRequest", + "description": "Output only. The original request for initialization.", + "readOnly": true + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2InitializeEncryptionSpecRequest": { + "description": "The request to initialize a location-level encryption specification.", + "id": "GoogleCloudDialogflowV2InitializeEncryptionSpecRequest", + "properties": { + "encryptionSpec": { + "$ref": "GoogleCloudDialogflowV2EncryptionSpec", + "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." + } + }, + "type": "object" + }, "GoogleCloudDialogflowV2InputDataset": { "description": "InputDataset used to create model or do evaluation. NextID:5", "id": "GoogleCloudDialogflowV2InputDataset", @@ -15125,6 +15181,21 @@ }, "type": "object" }, + "GoogleCloudDialogflowV2beta1EncryptionSpec": { + "description": "A customer-managed encryption key specification that can be applied to all created resources (e.g. Conversation).", + "id": "GoogleCloudDialogflowV2beta1EncryptionSpec", + "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 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" + }, + "name": { + "description": "Immutable. The resource name of the encryption key specification resource. Format: projects/{project}/locations/{location}/encryptionSpec", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDialogflowV2beta1EntityType": { "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).", "id": "GoogleCloudDialogflowV2beta1EntityType", @@ -15329,6 +15400,29 @@ }, "type": "object" }, + "GoogleCloudDialogflowV2beta1InitializeEncryptionSpecMetadata": { + "description": "Metadata for initializing a location-level encryption specification.", + "id": "GoogleCloudDialogflowV2beta1InitializeEncryptionSpecMetadata", + "properties": { + "request": { + "$ref": "GoogleCloudDialogflowV2beta1InitializeEncryptionSpecRequest", + "description": "Output only. The original request for initialization.", + "readOnly": true + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2beta1InitializeEncryptionSpecRequest": { + "description": "The request to initialize a location-level encryption specification.", + "id": "GoogleCloudDialogflowV2beta1InitializeEncryptionSpecRequest", + "properties": { + "encryptionSpec": { + "$ref": "GoogleCloudDialogflowV2beta1EncryptionSpec", + "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." + } + }, + "type": "object" + }, "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).", "id": "GoogleCloudDialogflowV2beta1Intent", @@ -16788,6 +16882,13 @@ "readOnly": true, "type": "string" }, + "responseMessages": { + "description": "Optional. Automated agent responses.", + "items": { + "$ref": "GoogleCloudDialogflowV2beta1ResponseMessage" + }, + "type": "array" + }, "sendTime": { "description": "Optional. The time when the message was sent.", "format": "google-datetime", @@ -16937,6 +17038,125 @@ }, "type": "object" }, + "GoogleCloudDialogflowV2beta1ResponseMessage": { + "description": "Response messages from an automated agent.", + "id": "GoogleCloudDialogflowV2beta1ResponseMessage", + "properties": { + "endInteraction": { + "$ref": "GoogleCloudDialogflowV2beta1ResponseMessageEndInteraction", + "description": "A signal that indicates the interaction with the Dialogflow agent has ended." + }, + "liveAgentHandoff": { + "$ref": "GoogleCloudDialogflowV2beta1ResponseMessageLiveAgentHandoff", + "description": "Hands off conversation to a live agent." + }, + "mixedAudio": { + "$ref": "GoogleCloudDialogflowV2beta1ResponseMessageMixedAudio", + "description": "An audio response message composed of both the synthesized Dialogflow agent responses and the audios hosted in places known to the client." + }, + "payload": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Returns a response containing a custom, platform-specific payload.", + "type": "object" + }, + "telephonyTransferCall": { + "$ref": "GoogleCloudDialogflowV2beta1ResponseMessageTelephonyTransferCall", + "description": "A signal that the client should transfer the phone call connected to this agent to a third-party endpoint." + }, + "text": { + "$ref": "GoogleCloudDialogflowV2beta1ResponseMessageText", + "description": "Returns a text response." + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2beta1ResponseMessageEndInteraction": { + "description": "Indicates that interaction with the Dialogflow agent has ended.", + "id": "GoogleCloudDialogflowV2beta1ResponseMessageEndInteraction", + "properties": {}, + "type": "object" + }, + "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.", + "id": "GoogleCloudDialogflowV2beta1ResponseMessageLiveAgentHandoff", + "properties": { + "metadata": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this.", + "type": "object" + } + }, + "type": "object" + }, + "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.", + "id": "GoogleCloudDialogflowV2beta1ResponseMessageMixedAudio", + "properties": { + "segments": { + "description": "Segments this audio response is composed of.", + "items": { + "$ref": "GoogleCloudDialogflowV2beta1ResponseMessageMixedAudioSegment" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2beta1ResponseMessageMixedAudioSegment": { + "description": "Represents one segment of audio.", + "id": "GoogleCloudDialogflowV2beta1ResponseMessageMixedAudioSegment", + "properties": { + "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" + }, + "audio": { + "description": "Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request.", + "format": "byte", + "type": "string" + }, + "uri": { + "description": "Client-specific URI that points to an audio clip accessible to the client.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2beta1ResponseMessageTelephonyTransferCall": { + "description": "Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint.", + "id": "GoogleCloudDialogflowV2beta1ResponseMessageTelephonyTransferCall", + "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" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2beta1ResponseMessageText": { + "description": "The text response message.", + "id": "GoogleCloudDialogflowV2beta1ResponseMessageText", + "properties": { + "text": { + "description": "A collection of text responses.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "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.", "id": "GoogleCloudDialogflowV2beta1Sentiment", diff --git a/discovery/dialogflow-v3beta1.json b/discovery/dialogflow-v3beta1.json index e8e5e5c148..e0cd8d77be 100644 --- a/discovery/dialogflow-v3beta1.json +++ b/discovery/dialogflow-v3beta1.json @@ -5185,7 +5185,7 @@ } } }, - "revision": "20240614", + "revision": "20240704", "rootUrl": "https://dialogflow.googleapis.com/", "schemas": { "GoogleCloudDialogflowCxV3AdvancedSettings": { @@ -5697,6 +5697,10 @@ "description": "The target page to transition to. Format: `projects//locations//agents//flows//pages/`.", "type": "string" }, + "targetPlaybook": { + "description": "The target playbook to transition to. Format: `projects//locations//agents//playbooks/`.", + "type": "string" + }, "triggerFulfillment": { "$ref": "GoogleCloudDialogflowCxV3Fulfillment", "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." @@ -7002,11 +7006,11 @@ "id": "GoogleCloudDialogflowCxV3TestConfig", "properties": { "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 both are set, `page` takes precedence over `flow`. If neither is set, the test case will start with start page on the default start 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" }, "page": { - "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 both are set, `page` takes precedence over `flow`. If neither is set, the test case will start with start page on the default start flow.", + "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.", "type": "string" }, "trackingParameters": { @@ -8699,6 +8703,10 @@ "description": "Diagnostic info related to the answer generation model call.", "id": "GoogleCloudDialogflowCxV3beta1DataStoreConnectionSignalsAnswerGenerationModelCallSignals", "properties": { + "model": { + "description": "Name of the generative model. For example, \"gemini-ultra\", \"gemini-pro\", \"gemini-1.5-flash\" etc. Defaults to \"Other\" if the model is unknown.", + "type": "string" + }, "modelOutput": { "description": "Output of the generative model.", "type": "string" @@ -8790,6 +8798,10 @@ "description": "Diagnostic info related to the rewriter model call.", "id": "GoogleCloudDialogflowCxV3beta1DataStoreConnectionSignalsRewriterModelCallSignals", "properties": { + "model": { + "description": "Name of the generative model. For example, \"gemini-ultra\", \"gemini-pro\", \"gemini-1.5-flash\" etc. Defaults to \"Other\" if the model is unknown.", + "type": "string" + }, "modelOutput": { "description": "Output of the generative model.", "type": "string" @@ -9257,6 +9269,10 @@ "description": "The target page to transition to. Format: `projects//locations//agents//flows//pages/`.", "type": "string" }, + "targetPlaybook": { + "description": "The target playbook to transition to. Format: `projects//locations//agents//playbooks/`.", + "type": "string" + }, "triggerFulfillment": { "$ref": "GoogleCloudDialogflowCxV3beta1Fulfillment", "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." @@ -11584,6 +11600,7 @@ "NO_MATCH", "NO_INPUT", "EVENT", + "KNOWLEDGE_CONNECTOR", "PLAYBOOK" ], "enumDescriptions": [ @@ -11594,6 +11611,7 @@ "No match was found for the query.", "Indicates an empty query.", "The query directly triggered an event.", + "The query was matched to a Knowledge Connector answer.", "The query was handled by a `Playbook`." ], "type": "string" @@ -13255,11 +13273,11 @@ "id": "GoogleCloudDialogflowCxV3beta1TestConfig", "properties": { "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 both are set, `page` takes precedence over `flow`. If neither is set, the test case will start with start page on the default start 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" }, "page": { - "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 both are set, `page` takes precedence over `flow`. If neither is set, the test case will start with start page on the default start flow.", + "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.", "type": "string" }, "trackingParameters": { @@ -14982,6 +15000,21 @@ }, "type": "object" }, + "GoogleCloudDialogflowV2EncryptionSpec": { + "description": "A customer-managed encryption key specification that can be applied to all created resources (e.g. Conversation).", + "id": "GoogleCloudDialogflowV2EncryptionSpec", + "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 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" + }, + "name": { + "description": "Immutable. The resource name of the encryption key specification resource. Format: projects/{project}/locations/{location}/encryptionSpec", + "type": "string" + } + }, + "type": "object" + }, "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).", "id": "GoogleCloudDialogflowV2EntityType", @@ -15225,6 +15258,29 @@ }, "type": "object" }, + "GoogleCloudDialogflowV2InitializeEncryptionSpecMetadata": { + "description": "Metadata for initializing a location-level encryption specification.", + "id": "GoogleCloudDialogflowV2InitializeEncryptionSpecMetadata", + "properties": { + "request": { + "$ref": "GoogleCloudDialogflowV2InitializeEncryptionSpecRequest", + "description": "Output only. The original request for initialization.", + "readOnly": true + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2InitializeEncryptionSpecRequest": { + "description": "The request to initialize a location-level encryption specification.", + "id": "GoogleCloudDialogflowV2InitializeEncryptionSpecRequest", + "properties": { + "encryptionSpec": { + "$ref": "GoogleCloudDialogflowV2EncryptionSpec", + "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." + } + }, + "type": "object" + }, "GoogleCloudDialogflowV2InputDataset": { "description": "InputDataset used to create model or do evaluation. NextID:5", "id": "GoogleCloudDialogflowV2InputDataset", @@ -17046,6 +17102,21 @@ }, "type": "object" }, + "GoogleCloudDialogflowV2beta1EncryptionSpec": { + "description": "A customer-managed encryption key specification that can be applied to all created resources (e.g. Conversation).", + "id": "GoogleCloudDialogflowV2beta1EncryptionSpec", + "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 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" + }, + "name": { + "description": "Immutable. The resource name of the encryption key specification resource. Format: projects/{project}/locations/{location}/encryptionSpec", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDialogflowV2beta1EntityType": { "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).", "id": "GoogleCloudDialogflowV2beta1EntityType", @@ -17250,6 +17321,29 @@ }, "type": "object" }, + "GoogleCloudDialogflowV2beta1InitializeEncryptionSpecMetadata": { + "description": "Metadata for initializing a location-level encryption specification.", + "id": "GoogleCloudDialogflowV2beta1InitializeEncryptionSpecMetadata", + "properties": { + "request": { + "$ref": "GoogleCloudDialogflowV2beta1InitializeEncryptionSpecRequest", + "description": "Output only. The original request for initialization.", + "readOnly": true + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2beta1InitializeEncryptionSpecRequest": { + "description": "The request to initialize a location-level encryption specification.", + "id": "GoogleCloudDialogflowV2beta1InitializeEncryptionSpecRequest", + "properties": { + "encryptionSpec": { + "$ref": "GoogleCloudDialogflowV2beta1EncryptionSpec", + "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." + } + }, + "type": "object" + }, "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).", "id": "GoogleCloudDialogflowV2beta1Intent", @@ -18709,6 +18803,13 @@ "readOnly": true, "type": "string" }, + "responseMessages": { + "description": "Optional. Automated agent responses.", + "items": { + "$ref": "GoogleCloudDialogflowV2beta1ResponseMessage" + }, + "type": "array" + }, "sendTime": { "description": "Optional. The time when the message was sent.", "format": "google-datetime", @@ -18858,6 +18959,125 @@ }, "type": "object" }, + "GoogleCloudDialogflowV2beta1ResponseMessage": { + "description": "Response messages from an automated agent.", + "id": "GoogleCloudDialogflowV2beta1ResponseMessage", + "properties": { + "endInteraction": { + "$ref": "GoogleCloudDialogflowV2beta1ResponseMessageEndInteraction", + "description": "A signal that indicates the interaction with the Dialogflow agent has ended." + }, + "liveAgentHandoff": { + "$ref": "GoogleCloudDialogflowV2beta1ResponseMessageLiveAgentHandoff", + "description": "Hands off conversation to a live agent." + }, + "mixedAudio": { + "$ref": "GoogleCloudDialogflowV2beta1ResponseMessageMixedAudio", + "description": "An audio response message composed of both the synthesized Dialogflow agent responses and the audios hosted in places known to the client." + }, + "payload": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Returns a response containing a custom, platform-specific payload.", + "type": "object" + }, + "telephonyTransferCall": { + "$ref": "GoogleCloudDialogflowV2beta1ResponseMessageTelephonyTransferCall", + "description": "A signal that the client should transfer the phone call connected to this agent to a third-party endpoint." + }, + "text": { + "$ref": "GoogleCloudDialogflowV2beta1ResponseMessageText", + "description": "Returns a text response." + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2beta1ResponseMessageEndInteraction": { + "description": "Indicates that interaction with the Dialogflow agent has ended.", + "id": "GoogleCloudDialogflowV2beta1ResponseMessageEndInteraction", + "properties": {}, + "type": "object" + }, + "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.", + "id": "GoogleCloudDialogflowV2beta1ResponseMessageLiveAgentHandoff", + "properties": { + "metadata": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this.", + "type": "object" + } + }, + "type": "object" + }, + "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.", + "id": "GoogleCloudDialogflowV2beta1ResponseMessageMixedAudio", + "properties": { + "segments": { + "description": "Segments this audio response is composed of.", + "items": { + "$ref": "GoogleCloudDialogflowV2beta1ResponseMessageMixedAudioSegment" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2beta1ResponseMessageMixedAudioSegment": { + "description": "Represents one segment of audio.", + "id": "GoogleCloudDialogflowV2beta1ResponseMessageMixedAudioSegment", + "properties": { + "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" + }, + "audio": { + "description": "Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request.", + "format": "byte", + "type": "string" + }, + "uri": { + "description": "Client-specific URI that points to an audio clip accessible to the client.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2beta1ResponseMessageTelephonyTransferCall": { + "description": "Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint.", + "id": "GoogleCloudDialogflowV2beta1ResponseMessageTelephonyTransferCall", + "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" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2beta1ResponseMessageText": { + "description": "The text response message.", + "id": "GoogleCloudDialogflowV2beta1ResponseMessageText", + "properties": { + "text": { + "description": "A collection of text responses.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "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.", "id": "GoogleCloudDialogflowV2beta1Sentiment", diff --git a/discovery/discoveryengine-v1.json b/discovery/discoveryengine-v1.json index 76f217377d..a2d12dd620 100644 --- a/discovery/discoveryengine-v1.json +++ b/discovery/discoveryengine-v1.json @@ -5428,6 +5428,80 @@ } } }, + "identity_mapping_stores": { + "resources": { + "operations": { + "methods": { + "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.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/identity_mapping_stores/{identity_mapping_storesId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "discoveryengine.projects.locations.identity_mapping_stores.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/identity_mapping_stores/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/identity_mapping_stores/{identity_mapping_storesId}/operations", + "httpMethod": "GET", + "id": "discoveryengine.projects.locations.identity_mapping_stores.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/identity_mapping_stores/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, "operations": { "methods": { "get": { @@ -5711,7 +5785,7 @@ } } }, - "revision": "20240621", + "revision": "20240715", "rootUrl": "https://discoveryengine.googleapis.com/", "schemas": { "GoogleApiHttpBody": { @@ -6177,6 +6251,11 @@ "disable": { "description": "Disable query rephraser.", "type": "boolean" + }, + "maxRephraseSteps": { + "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.", + "format": "int32", + "type": "integer" } }, "type": "object" @@ -6247,7 +6326,7 @@ "type": "string" }, "searchResultMode": { - "description": "Specifies the search result mode. If unspecified, the search result mode is based on DataStore.DocumentProcessingConfig.chunking_config: * If DataStore.DocumentProcessingConfig.chunking_config is specified, it defaults to `CHUNKS`. * Otherwise, it defaults to `DOCUMENTS`. See [parse and chunk documents](https://cloud.google.com/generative-ai-app-builder/docs/parse-chunk-documents)", + "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)", "enum": [ "SEARCH_RESULT_MODE_UNSPECIFIED", "DOCUMENTS", @@ -6398,7 +6477,7 @@ "properties": { "answer": { "$ref": "GoogleCloudDiscoveryengineV1Answer", - "description": "Answer resource object. If AnswerQueryRequest.StepSpec.max_step_count is greater than 1, use Answer.name to fetch answer information using ConversationalSearchService.GetAnswer API." + "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." }, "answerQueryToken": { "description": "A global unique ID used for logging.", @@ -6657,6 +6736,14 @@ }, "type": "array" }, + "structData": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "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" + }, "title": { "description": "Title.", "type": "string" @@ -8038,7 +8125,7 @@ "additionalProperties": { "$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig" }, - "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 or layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and or layout parsing are supported.", + "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.", "type": "object" } }, @@ -9663,6 +9750,18 @@ "description": "Whether to turn on safe search. This is only supported for website search.", "type": "boolean" }, + "searchAsYouTypeSpec": { + "$ref": "GoogleCloudDiscoveryengineV1SearchRequestSearchAsYouTypeSpec", + "description": "Search as you type configuration. Only supported for the IndustryVertical.MEDIA vertical." + }, + "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 /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": { + "$ref": "GoogleCloudDiscoveryengineV1SearchRequestSessionSpec", + "description": "Session specification. Can be used only when `session` is set." + }, "spellCorrectionSpec": { "$ref": "GoogleCloudDiscoveryengineV1SearchRequestSpellCorrectionSpec", "description": "The spell correction specification that specifies the mode under which spell correction takes effect." @@ -9728,7 +9827,7 @@ "description": "If there is no extractive_content_spec provided, there will be no extractive answer in the search response." }, "searchResultMode": { - "description": "Specifies the search result mode. If unspecified, the search result mode is based on DataStore.DocumentProcessingConfig.chunking_config: * If DataStore.DocumentProcessingConfig.chunking_config is specified, it defaults to `CHUNKS`. * Otherwise, it defaults to `DOCUMENTS`.", + "description": "Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`.", "enum": [ "SEARCH_RESULT_MODE_UNSPECIFIED", "DOCUMENTS", @@ -9885,7 +9984,7 @@ "type": "object" }, "GoogleCloudDiscoveryengineV1SearchRequestDataStoreSpec": { - "description": "A struct to define data stores to filter on in a search call and configurations for those data stores. A maximum of 1 DataStoreSpec per data_store is allowed. Otherwise, an `INVALID_ARGUMENT` error is returned.", + "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.", "id": "GoogleCloudDiscoveryengineV1SearchRequestDataStoreSpec", "properties": { "dataStore": { @@ -10005,6 +10104,43 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1SearchRequestSearchAsYouTypeSpec": { + "description": "Specification for search as you type in search requests.", + "id": "GoogleCloudDiscoveryengineV1SearchRequestSearchAsYouTypeSpec", + "properties": { + "condition": { + "description": "The condition under which search as you type should occur. Default to Condition.DISABLED.", + "enum": [ + "CONDITION_UNSPECIFIED", + "DISABLED", + "ENABLED" + ], + "enumDescriptions": [ + "Server behavior defaults to Condition.DISABLED.", + "Disables Search As You Type.", + "Enables Search As You Type." + ], + "type": "string" + } + }, + "type": "object" + }, + "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.", + "id": "GoogleCloudDiscoveryengineV1SearchRequestSessionSpec", + "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.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1SearchRequestSpellCorrectionSpec": { "description": "The specification for query spell correction.", "id": "GoogleCloudDiscoveryengineV1SearchRequestSpellCorrectionSpec", @@ -10064,6 +10200,10 @@ }, "type": "array" }, + "sessionInfo": { + "$ref": "GoogleCloudDiscoveryengineV1SearchResponseSessionInfo", + "description": "Session information. Only set if SearchRequest.session is provided. See its description for more details." + }, "summary": { "$ref": "GoogleCloudDiscoveryengineV1SearchResponseSummary", "description": "A summary as part of the search results. This field is only returned if SearchRequest.ContentSearchSpec.summary_spec is set." @@ -10153,6 +10293,21 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1SearchResponseSessionInfo": { + "description": "Information about the session.", + "id": "GoogleCloudDiscoveryengineV1SearchResponseSessionInfo", + "properties": { + "name": { + "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.", + "type": "string" + }, + "queryId": { + "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" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1SearchResponseSummary": { "description": "Summary of the top N search results specified by the summary spec.", "id": "GoogleCloudDiscoveryengineV1SearchResponseSummary", @@ -11177,6 +11332,14 @@ }, "type": "array" }, + "structData": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "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" + }, "title": { "description": "Title.", "type": "string" @@ -11493,6 +11656,12 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1alphaCreateEvaluationMetadata": { + "description": "Metadata for EvaluationService.CreateEvaluation method.", + "id": "GoogleCloudDiscoveryengineV1alphaCreateEvaluationMetadata", + "properties": {}, + "type": "object" + }, "GoogleCloudDiscoveryengineV1alphaCreateSchemaMetadata": { "description": "Metadata for Create Schema LRO.", "id": "GoogleCloudDiscoveryengineV1alphaCreateSchemaMetadata", @@ -11527,11 +11696,23 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec": { + "description": "Defines custom fine tuning spec.", + "id": "GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec", + "properties": { + "enableSearchAdaptor": { + "description": "Whether or not to enable and include custom fine tuned search adaptor model.", + "type": "boolean" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1alphaCustomTuningModel": { "description": "Metadata that describes a custom tuned model.", "id": "GoogleCloudDiscoveryengineV1alphaCustomTuningModel", "properties": { "createTime": { + "deprecated": true, "description": "Timestamp the Model was created at.", "format": "google-datetime", "type": "string" @@ -11540,6 +11721,14 @@ "description": "The display name of the model.", "type": "string" }, + "metrics": { + "additionalProperties": { + "format": "double", + "type": "number" + }, + "description": "The metrics of the trained model.", + "type": "object" + }, "modelState": { "description": "The state that the model is in (e.g.`TRAINING` or `TRAINING_FAILED`).", "enum": [ @@ -11548,7 +11737,8 @@ "TRAINING", "TRAINING_COMPLETE", "READY_FOR_SERVING", - "TRAINING_FAILED" + "TRAINING_FAILED", + "NO_IMPROVEMENT" ], "enumDescriptions": [ "Default value.", @@ -11556,7 +11746,8 @@ "The model is currently training.", "The model has successfully completed training.", "The model is ready for serving.", - "The model training failed." + "The model training failed.", + "The model training finished successfully but metrics did not improve." ], "type": "string" }, @@ -11788,7 +11979,7 @@ "additionalProperties": { "$ref": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfig" }, - "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 or layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and or layout parsing are supported.", + "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.", "type": "object" } }, @@ -12222,6 +12413,128 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1alphaEvaluation": { + "description": "An evaluation is a single execution (or run) of an evaluation process. It encapsulates the state of the evaluation and the resulting data.", + "id": "GoogleCloudDiscoveryengineV1alphaEvaluation", + "properties": { + "createTime": { + "description": "Output only. Timestamp the Evaluation was created at.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "endTime": { + "description": "Output only. Timestamp the Evaluation was completed at.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "error": { + "$ref": "GoogleRpcStatus", + "description": "Output only. The error that occurred during evaluation. Only populated when the evaluation's state is FAILED.", + "readOnly": true + }, + "errorSamples": { + "description": "Output only. A sample of errors encountered while processing the request.", + "items": { + "$ref": "GoogleRpcStatus" + }, + "readOnly": true, + "type": "array" + }, + "evaluationSpec": { + "$ref": "GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpec", + "description": "Required. The specification of the evaluation." + }, + "name": { + "description": "Immutable. 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" + }, + "qualityMetrics": { + "$ref": "GoogleCloudDiscoveryengineV1alphaQualityMetrics", + "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 + }, + "state": { + "description": "Output only. The state of the evaluation.", + "enum": [ + "STATE_UNSPECIFIED", + "PENDING", + "RUNNING", + "SUCCEEDED", + "FAILED" + ], + "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." + ], + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpec": { + "description": "Describes the specification of the evaluation.", + "id": "GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpec", + "properties": { + "querySetSpec": { + "$ref": "GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpecQuerySetSpec", + "description": "Required. The specification of the query set." + }, + "searchRequest": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequest", + "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" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpecQuerySetSpec": { + "description": "Describes the specification of the query set.", + "id": "GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpecQuerySetSpec", + "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" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaExportUserEventsMetadata": { + "description": "Metadata related to the progress of the Export operation. This is returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1alphaExportUserEventsMetadata", + "properties": { + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", + "type": "string" + }, + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaExportUserEventsResponse": { + "description": "Response of the ExportUserEventsRequest. If the long running operation was successful, then this message is returned by the google.longrunning.Operations.response field.", + "id": "GoogleCloudDiscoveryengineV1alphaExportUserEventsResponse", + "properties": { + "outputResult": { + "$ref": "GoogleCloudDiscoveryengineV1alphaOutputResult", + "description": "Output result indicating where the data were exported to." + }, + "status": { + "$ref": "GoogleRpcStatus", + "description": "The status of the export operation." + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1alphaFieldConfig": { "description": "Configurations for fields of a schema. For example, configuring a field is indexable, or searchable.", "id": "GoogleCloudDiscoveryengineV1alphaFieldConfig", @@ -12373,6 +12686,24 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1alphaGetUriPatternDocumentDataResponse": { + "description": "Response message for SiteSearchEngineService.GetUriPatternDocumentData method.", + "id": "GoogleCloudDiscoveryengineV1alphaGetUriPatternDocumentDataResponse", + "properties": { + "documentDataMap": { + "additionalProperties": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "type": "object" + }, + "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" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1alphaIdpConfig": { "description": "Identity Provider Config.", "id": "GoogleCloudDiscoveryengineV1alphaIdpConfig", @@ -12515,36 +12846,86 @@ }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesMetadata": { - "description": "Metadata related to the progress of the ImportSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesMetadata", + "GoogleCloudDiscoveryengineV1alphaImportSampleQueriesMetadata": { + "description": "Metadata related to the progress of the ImportSampleQueries operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1alphaImportSampleQueriesMetadata", "properties": { "createTime": { - "description": "Operation create time.", + "description": "ImportSampleQueries operation create time.", "format": "google-datetime", "type": "string" }, + "failureCount": { + "description": "Count of SampleQuerys that failed to be imported.", + "format": "int64", + "type": "string" + }, + "successCount": { + "description": "Count of SampleQuerys successfully imported.", + "format": "int64", + "type": "string" + }, + "totalCount": { + "description": "Total count of SampleQuerys that were processed.", + "format": "int64", + "type": "string" + }, "updateTime": { - "description": "Operation last update time. If the operation is done, this is also the finish time.", + "description": "ImportSampleQueries operation last update time. If the operation is done, this is also the finish time.", "format": "google-datetime", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesResponse": { - "description": "Response message for CompletionService.ImportSuggestionDenyListEntries method.", - "id": "GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesResponse", + "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.", + "id": "GoogleCloudDiscoveryengineV1alphaImportSampleQueriesResponse", "properties": { + "errorConfig": { + "$ref": "GoogleCloudDiscoveryengineV1alphaImportErrorConfig", + "description": "The desired location of errors incurred during the Import." + }, "errorSamples": { "description": "A sample of errors encountered while processing the request.", "items": { "$ref": "GoogleRpcStatus" }, "type": "array" - }, - "failedEntriesCount": { - "description": "Count of deny list entries that failed to be imported.", + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesMetadata": { + "description": "Metadata related to the progress of the ImportSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesMetadata", + "properties": { + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", + "type": "string" + }, + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesResponse": { + "description": "Response message for CompletionService.ImportSuggestionDenyListEntries method.", + "id": "GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesResponse", + "properties": { + "errorSamples": { + "description": "A sample of errors encountered while processing the request.", + "items": { + "$ref": "GoogleRpcStatus" + }, + "type": "array" + }, + "failedEntriesCount": { + "description": "Count of deny list entries that failed to be imported.", "format": "int64", "type": "string" }, @@ -12611,6 +12992,33 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1alphaInterval": { + "description": "A floating point interval.", + "id": "GoogleCloudDiscoveryengineV1alphaInterval", + "properties": { + "exclusiveMaximum": { + "description": "Exclusive upper bound.", + "format": "double", + "type": "number" + }, + "exclusiveMinimum": { + "description": "Exclusive lower bound.", + "format": "double", + "type": "number" + }, + "maximum": { + "description": "Inclusive upper bound.", + "format": "double", + "type": "number" + }, + "minimum": { + "description": "Inclusive lower bound.", + "format": "double", + "type": "number" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1alphaLanguageInfo": { "description": "Language info for DataStore.", "id": "GoogleCloudDiscoveryengineV1alphaLanguageInfo", @@ -12651,6 +13059,32 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1alphaOutputResult": { + "description": "Output result that stores the information about where the exported data is stored.", + "id": "GoogleCloudDiscoveryengineV1alphaOutputResult", + "properties": { + "bigqueryResult": { + "$ref": "GoogleCloudDiscoveryengineV1alphaOutputResultBigQueryOutputResult", + "description": "The BigQuery location where the result is stored." + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaOutputResultBigQueryOutputResult": { + "description": "A BigQuery output result.", + "id": "GoogleCloudDiscoveryengineV1alphaOutputResultBigQueryOutputResult", + "properties": { + "datasetId": { + "description": "The ID of a BigQuery Dataset.", + "type": "string" + }, + "tableId": { + "description": "The ID of a BigQuery Table.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1alphaProject": { "description": "Metadata and configurations for a Google Cloud project in the service.", "id": "GoogleCloudDiscoveryengineV1alphaProject", @@ -12891,6 +13325,60 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1alphaQualityMetrics": { + "description": "Describes the metrics produced by the evaluation.", + "id": "GoogleCloudDiscoveryengineV1alphaQualityMetrics", + "properties": { + "docNdcg": { + "$ref": "GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics", + "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" + }, + "docPrecision": { + "$ref": "GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics", + "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" + }, + "docRecall": { + "$ref": "GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics", + "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" + }, + "pageNdcg": { + "$ref": "GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics", + "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" + }, + "pageRecall": { + "$ref": "GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics", + "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" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics": { + "description": "Stores the metric values at specific top-k levels.", + "id": "GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics", + "properties": { + "top1": { + "description": "The top-1 value.", + "format": "double", + "type": "number" + }, + "top10": { + "description": "The top-10 value.", + "format": "double", + "type": "number" + }, + "top3": { + "description": "The top-3 value.", + "format": "double", + "type": "number" + }, + "top5": { + "description": "The top-5 value.", + "format": "double", + "type": "number" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1alphaQuery": { "description": "Defines a user inputed query.", "id": "GoogleCloudDiscoveryengineV1alphaQuery", @@ -13045,457 +13533,539 @@ }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaSession": { - "description": "External session proto definition.", - "id": "GoogleCloudDiscoveryengineV1alphaSession", + "GoogleCloudDiscoveryengineV1alphaSearchRequest": { + "description": "Request message for SearchService.Search method.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchRequest", "properties": { - "endTime": { - "description": "Output only. The time the session finished.", - "format": "google-datetime", - "readOnly": true, + "boostSpec": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpec", + "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)" + }, + "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" }, - "name": { - "description": "Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*`", + "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" }, - "startTime": { - "description": "Output only. The time the session started.", - "format": "google-datetime", - "readOnly": true, + "contentSearchSpec": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpec", + "description": "A specification for configuring the behavior of content search." + }, + "customFineTuningSpec": { + "$ref": "GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec", + "description": "Custom fine tuning configs. If set, it has higher priority than the configs set in ServingConfig.custom_fine_tuning_spec." + }, + "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.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec" + }, + "type": "array" + }, + "embeddingSpec": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpec", + "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." + }, + "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.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpec" + }, + "type": "array" + }, + "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" }, - "state": { - "description": "The state of the session.", + "imageQuery": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestImageQuery", + "description": "Raw image query." + }, + "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" + }, + "naturalLanguageQueryUnderstandingSpec": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestNaturalLanguageQueryUnderstandingSpec", + "description": "If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done." + }, + "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.", + "format": "int32", + "type": "integer" + }, + "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 for retail search, see [Ordering](https://cloud.google.com/retail/docs/filter-and-order#order) If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.", + "type": "string" + }, + "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.", + "format": "int32", + "type": "integer" + }, + "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" + }, + "params": { + "additionalProperties": { + "type": "any" + }, + "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" + }, + "query": { + "description": "Raw search query.", + "type": "string" + }, + "queryExpansionSpec": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestQueryExpansionSpec", + "description": "The query expansion specification that specifies the conditions under which query expansion occurs." + }, + "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)`.", + "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" + }, + "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.", "enum": [ - "STATE_UNSPECIFIED", - "IN_PROGRESS" + "RELEVANCE_THRESHOLD_UNSPECIFIED", + "LOWEST", + "LOW", + "MEDIUM", + "HIGH" ], "enumDescriptions": [ - "State is unspecified.", - "The session is currently open." + "Default value. In this case, server behavior defaults to Google defined threshold.", + "Lowest relevance threshold.", + "Low relevance threshold.", + "Medium relevance threshold.", + "High relevance threshold." ], "type": "string" }, - "turns": { - "description": "Turns.", - "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaSessionTurn" + "safeSearch": { + "description": "Whether to turn on safe search. This is only supported for website search.", + "type": "boolean" + }, + "searchAsYouTypeSpec": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAsYouTypeSpec", + "description": "Search as you type configuration. Only supported for the IndustryVertical.MEDIA vertical." + }, + "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" + }, + "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 /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": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestSessionSpec", + "description": "Session specification. Can be used only when `session` is set." + }, + "spellCorrectionSpec": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestSpellCorrectionSpec", + "description": "The spell correction specification that specifies the mode under which spell correction takes effect." + }, + "userInfo": { + "$ref": "GoogleCloudDiscoveryengineV1alphaUserInfo", + "description": "Information about the end user. Highly recommended for analytics. UserInfo.user_agent is used to deduce `device_type` for analytics." + }, + "userLabels": { + "additionalProperties": { + "type": "string" }, - "type": "array" + "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" }, "userPseudoId": { - "description": "A unique identifier for tracking users.", + "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" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaSessionTurn": { - "description": "Represents a turn, including a query from the user and a answer from service.", - "id": "GoogleCloudDiscoveryengineV1alphaSessionTurn", + "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpec": { + "description": "Boost specification to boost certain documents.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpec", "properties": { - "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" + "conditionBoostSpecs": { + "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.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpec" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpec": { + "description": "Boost applies to documents which match a condition.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpec", + "properties": { + "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.", + "format": "float", + "type": "number" }, - "query": { - "$ref": "GoogleCloudDiscoveryengineV1alphaQuery", - "description": "The user query." + "boostControlSpec": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpecBoostControlSpec", + "description": "Complex specification for custom ranking based on customer defined attribute value." + }, + "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" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaSiteVerificationInfo": { - "description": "Verification information for target sites in advanced site search.", - "id": "GoogleCloudDiscoveryengineV1alphaSiteVerificationInfo", + "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.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpecBoostControlSpec", "properties": { - "siteVerificationState": { - "description": "Site verification state indicating the ownership and validity.", + "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).", "enum": [ - "SITE_VERIFICATION_STATE_UNSPECIFIED", - "VERIFIED", - "UNVERIFIED", - "EXEMPTED" + "ATTRIBUTE_TYPE_UNSPECIFIED", + "NUMERICAL", + "FRESHNESS" ], "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." + "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`." ], "type": "string" }, - "verifyTime": { - "description": "Latest site verification time.", - "format": "google-datetime", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1alphaTargetSite": { - "description": "A target site for the SiteSearchEngine.", - "id": "GoogleCloudDiscoveryengineV1alphaTargetSite", - "properties": { - "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" - }, - "failureReason": { - "$ref": "GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReason", - "description": "Output only. Failure reason.", - "readOnly": true + "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.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpecBoostControlSpecControlPoint" + }, + "type": "array" }, - "generatedUriPattern": { - "description": "Output only. This is system-generated based on the provided_uri_pattern.", - "readOnly": true, + "fieldName": { + "description": "The name of the field whose value will be used to determine the boost amount.", "type": "string" }, - "indexingStatus": { - "description": "Output only. Indexing status.", + "interpolationType": { + "description": "The interpolation type to be applied to connect the control points listed below.", "enum": [ - "INDEXING_STATUS_UNSPECIFIED", - "PENDING", - "FAILED", - "SUCCEEDED", - "DELETING" + "INTERPOLATION_TYPE_UNSPECIFIED", + "LINEAR" ], "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." + "Interpolation type is unspecified. In this case, it defaults to Linear.", + "Piecewise linear interpolation will be applied." ], - "readOnly": true, - "type": "string" - }, - "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": "object" + }, + "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).", + "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpecBoostControlSpecControlPoint", + "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" }, - "rootDomainUri": { - "description": "Output only. Root domain of the provided_uri_pattern.", - "readOnly": true, - "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.", + "format": "float", + "type": "number" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpec": { + "description": "A specification for configuring the behavior of content search.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpec", + "properties": { + "chunkSpec": { + "$ref": "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" }, - "siteVerificationInfo": { - "$ref": "GoogleCloudDiscoveryengineV1alphaSiteVerificationInfo", - "description": "Output only. Site ownership and validity verification status.", - "readOnly": true + "extractiveContentSpec": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecExtractiveContentSpec", + "description": "If there is no extractive_content_spec provided, there will be no extractive answer in the search response." }, - "type": { - "description": "The type of the target site, e.g., whether the site is to be included or excluded.", + "searchResultMode": { + "description": "Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`.", "enum": [ - "TYPE_UNSPECIFIED", - "INCLUDE", - "EXCLUDE" + "SEARCH_RESULT_MODE_UNSPECIFIED", + "DOCUMENTS", + "CHUNKS" ], "enumDescriptions": [ - "This value is unused. In this case, server behavior defaults to Type.INCLUDE.", - "Include the target site.", - "Exclude the target site." + "Default value.", + "Returns documents in the search result.", + "Returns chunks in the search result. Only available if the DataStore.DocumentProcessingConfig.chunking_config is specified." ], "type": "string" }, - "updateTime": { - "description": "Output only. The target site's last updated time.", - "format": "google-datetime", - "readOnly": true, - "type": "string" + "snippetSpec": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSnippetSpec", + "description": "If `snippetSpec` is not specified, snippets are not included in the search response." + }, + "summarySpec": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpec", + "description": "If `summarySpec` is not specified, summaries are not included in the search response." } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReason": { - "description": "Site search indexing failure reasons.", - "id": "GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReason", + "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", + "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecChunkSpec", "properties": { - "quotaFailure": { - "$ref": "GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReasonQuotaFailure", - "description": "Failed due to insufficient quota." + "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.", + "format": "int32", + "type": "integer" + }, + "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.", + "format": "int32", + "type": "integer" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReasonQuotaFailure": { - "description": "Failed due to insufficient quota.", - "id": "GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReasonQuotaFailure", + "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecExtractiveContentSpec": { + "description": "A specification for configuring the extractive content in a search response.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecExtractiveContentSpec", "properties": { - "totalRequiredQuota": { - "description": "This number is an estimation on how much total quota this project needs to successfully complete indexing.", - "format": "int64", - "type": "string" + "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.", + "format": "int32", + "type": "integer" + }, + "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`.", + "format": "int32", + "type": "integer" + }, + "numNextSegments": { + "description": "Return at most `num_next_segments` segments after each selected segments.", + "format": "int32", + "type": "integer" + }, + "numPreviousSegments": { + "description": "Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments.", + "format": "int32", + "type": "integer" + }, + "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" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaTrainCustomModelMetadata": { - "description": "Metadata related to the progress of the TrainCustomModel operation. This is returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1alphaTrainCustomModelMetadata", + "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSnippetSpec": { + "description": "A specification for configuring snippets in a search response.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSnippetSpec", "properties": { - "createTime": { - "description": "Operation create time.", - "format": "google-datetime", - "type": "string" + "maxSnippetCount": { + "deprecated": true, + "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.", + "format": "int32", + "type": "integer" }, - "updateTime": { - "description": "Operation last update time. If the operation is done, this is also the finish time.", - "format": "google-datetime", - "type": "string" + "referenceOnly": { + "deprecated": true, + "description": "[DEPRECATED] This field is deprecated and will have no affect on the snippet.", + "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" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaTrainCustomModelResponse": { - "description": "Response of the TrainCustomModelRequest. This message is returned by the google.longrunning.Operations.response field.", - "id": "GoogleCloudDiscoveryengineV1alphaTrainCustomModelResponse", + "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpec": { + "description": "A specification for configuring a summary returned in a search response.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpec", "properties": { - "errorConfig": { - "$ref": "GoogleCloudDiscoveryengineV1alphaImportErrorConfig", - "description": "Echoes the destination for the complete errors in the request if set." + "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" }, - "errorSamples": { - "description": "A sample of errors encountered while processing the data.", - "items": { - "$ref": "GoogleRpcStatus" - }, - "type": "array" + "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" }, - "metrics": { - "additionalProperties": { - "format": "double", - "type": "number" - }, - "description": "The metrics of the trained model.", - "type": "object" + "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" }, - "modelName": { - "description": "Fully qualified name of the CustomTuningModel.", + "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" }, - "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" + "modelPromptSpec": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelPromptSpec", + "description": "If specified, the spec will be used to modify the prompt provided to the LLM." + }, + "modelSpec": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelSpec", + "description": "If specified, the spec will be used to modify the model specification provided to the LLM." + }, + "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.", + "format": "int32", + "type": "integer" + }, + "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" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaTuneEngineMetadata": { - "description": "Metadata associated with a tune operation.", - "id": "GoogleCloudDiscoveryengineV1alphaTuneEngineMetadata", + "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelPromptSpec": { + "description": "Specification of the prompt to use with the model.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelPromptSpec", "properties": { - "engine": { - "description": "Required. The resource name of the engine that this tune applies to. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`", + "preamble": { + "description": "Text at the beginning of the prompt that instructs the assistant. Examples are available in the user guide.", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaTuneEngineResponse": { - "description": "Response associated with a tune operation.", - "id": "GoogleCloudDiscoveryengineV1alphaTuneEngineResponse", - "properties": {}, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1alphaUpdateSchemaMetadata": { - "description": "Metadata for UpdateSchema LRO.", - "id": "GoogleCloudDiscoveryengineV1alphaUpdateSchemaMetadata", + "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelSpec": { + "description": "Specification of the model.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelSpec", "properties": { - "createTime": { - "description": "Operation create time.", - "format": "google-datetime", - "type": "string" - }, - "updateTime": { - "description": "Operation last update time. If the operation is done, this is also the finish time.", - "format": "google-datetime", + "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" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaUpdateTargetSiteMetadata": { - "description": "Metadata related to the progress of the SiteSearchEngineService.UpdateTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1alphaUpdateTargetSiteMetadata", + "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` error is returned.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec", "properties": { - "createTime": { - "description": "Operation create time.", - "format": "google-datetime", - "type": "string" - }, - "updateTime": { - "description": "Operation last update time. If the operation is done, this is also the finish time.", - "format": "google-datetime", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1betaBatchCreateTargetSiteMetadata": { - "description": "Metadata related to the progress of the SiteSearchEngineService.BatchCreateTargetSites operation. This will be returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1betaBatchCreateTargetSiteMetadata", - "properties": { - "createTime": { - "description": "Operation create time.", - "format": "google-datetime", - "type": "string" - }, - "updateTime": { - "description": "Operation last update time. If the operation is done, this is also the finish time.", - "format": "google-datetime", + "dataStore": { + "description": "Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`.", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1betaBatchCreateTargetSitesResponse": { - "description": "Response message for SiteSearchEngineService.BatchCreateTargetSites method.", - "id": "GoogleCloudDiscoveryengineV1betaBatchCreateTargetSitesResponse", + "GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpec": { + "description": "The specification that uses customized query embedding vector to do semantic document retrieval.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpec", "properties": { - "targetSites": { - "description": "TargetSites created.", + "embeddingVectors": { + "description": "The embedding vector used for retrieval. Limit to 1.", "items": { - "$ref": "GoogleCloudDiscoveryengineV1betaTargetSite" + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpecEmbeddingVector" }, "type": "array" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1betaCondition": { - "description": "Defines circumstances to be checked before allowing a behavior", - "id": "GoogleCloudDiscoveryengineV1betaCondition", + "GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpecEmbeddingVector": { + "description": "Embedding vector.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpecEmbeddingVector", "properties": { - "activeTimeRange": { - "description": "Range of time(s) specifying when condition is active. Maximum of 10 time ranges.", - "items": { - "$ref": "GoogleCloudDiscoveryengineV1betaConditionTimeRange" - }, - "type": "array" + "fieldPath": { + "description": "Embedding field path in schema.", + "type": "string" }, - "queryTerms": { - "description": "Search only A list of terms to match the query on. Maximum of 10 query terms.", + "vector": { + "description": "Query embedding vector.", "items": { - "$ref": "GoogleCloudDiscoveryengineV1betaConditionQueryTerm" + "format": "float", + "type": "number" }, "type": "array" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1betaConditionQueryTerm": { - "description": "Matcher for search request query", - "id": "GoogleCloudDiscoveryengineV1betaConditionQueryTerm", + "GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpec": { + "description": "A facet specification to perform faceted search.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpec", "properties": { - "fullMatch": { - "description": "Whether the search query needs to exactly match the query term.", + "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" }, - "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" - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1betaConditionTimeRange": { - "description": "Used for time-dependent conditions.", - "id": "GoogleCloudDiscoveryengineV1betaConditionTimeRange", - "properties": { - "endTime": { - "description": "End of time range. Range is inclusive. Must be in the future.", - "format": "google-datetime", - "type": "string" + "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.", + "items": { + "type": "string" + }, + "type": "array" }, - "startTime": { - "description": "Start of time range. Range is inclusive.", - "format": "google-datetime", - "type": "string" + "facetKey": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpecFacetKey", + "description": "Required. The facet key specification." + }, + "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.", + "format": "int32", + "type": "integer" } }, "type": "object" }, - "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`.", - "id": "GoogleCloudDiscoveryengineV1betaControl", + "GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpecFacetKey": { + "description": "Specifies how a facet is computed.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpecFacetKey", "properties": { - "associatedServingConfigIds": { - "description": "Output only. List of all ServingConfig ids this control is attached to. May take up to 10 minutes to update after changes.", + "caseInsensitive": { + "description": "True to make facet keys case insensitive when getting faceting values with prefixes or contains; false otherwise.", + "type": "boolean" + }, + "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.", "items": { "type": "string" }, - "readOnly": true, "type": "array" }, - "boostAction": { - "$ref": "GoogleCloudDiscoveryengineV1betaControlBoostAction", - "description": "Defines a boost-type control" - }, - "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.", + "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.", "items": { - "$ref": "GoogleCloudDiscoveryengineV1betaCondition" + "$ref": "GoogleCloudDiscoveryengineV1alphaInterval" }, "type": "array" }, - "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" - }, - "filterAction": { - "$ref": "GoogleCloudDiscoveryengineV1betaControlFilterAction", - "description": "Defines a filter-type control Currently not supported by Recommendation" - }, - "name": { - "description": "Immutable. Fully qualified name `projects/*/locations/global/dataStore/*/controls/*`", + "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" }, - "redirectAction": { - "$ref": "GoogleCloudDiscoveryengineV1betaControlRedirectAction", - "description": "Defines a redirect-type control." - }, - "solutionType": { - "description": "Required. Immutable. What solution the control belongs to. Must be compatible with vertical of resource. Otherwise an INVALID ARGUMENT error is thrown.", - "enum": [ - "SOLUTION_TYPE_UNSPECIFIED", - "SOLUTION_TYPE_RECOMMENDATION", - "SOLUTION_TYPE_SEARCH", - "SOLUTION_TYPE_CHAT", - "SOLUTION_TYPE_GENERATIVE_CHAT" - ], - "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." - ], + "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" }, - "synonymsAction": { - "$ref": "GoogleCloudDiscoveryengineV1betaControlSynonymsAction", - "description": "Treats a group of terms as synonyms of one another." + "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.", + "items": { + "type": "string" + }, + "type": "array" }, - "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.", + "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.", "items": { - "enum": [ - "SEARCH_USE_CASE_UNSPECIFIED", - "SEARCH_USE_CASE_SEARCH", - "SEARCH_USE_CASE_BROWSE" - ], - "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." - ], "type": "string" }, "type": "array" @@ -13503,120 +14073,192 @@ }, "type": "object" }, - "GoogleCloudDiscoveryengineV1betaControlBoostAction": { - "description": "Adjusts order of products in returned list.", - "id": "GoogleCloudDiscoveryengineV1betaControlBoostAction", + "GoogleCloudDiscoveryengineV1alphaSearchRequestImageQuery": { + "description": "Specifies the image query input.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestImageQuery", "properties": { - "boost": { - "description": "Required. Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0 (No-op).", - "format": "float", - "type": "number" - }, - "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" - }, - "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.", + "imageBytes": { + "description": "Base64 encoded image bytes. Supported image formats: JPEG, PNG, and BMP.", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1betaControlFilterAction": { - "description": "Specified which products may be included in results. Uses same filter as boost.", - "id": "GoogleCloudDiscoveryengineV1betaControlFilterAction", + "GoogleCloudDiscoveryengineV1alphaSearchRequestNaturalLanguageQueryUnderstandingSpec": { + "description": "Specification to enable natural language understanding capabilities for search requests.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestNaturalLanguageQueryUnderstandingSpec", "properties": { - "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", + "filterExtractionCondition": { + "description": "The condition under which filter extraction should occur. Default to Condition.DISABLED.", + "enum": [ + "CONDITION_UNSPECIFIED", + "DISABLED", + "ENABLED" + ], + "enumDescriptions": [ + "Server behavior defaults to Condition.DISABLED.", + "Disables NL filter extraction.", + "Enables NL filter extraction." + ], "type": "string" }, - "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" + "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.", + "items": { + "type": "string" + }, + "type": "array" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1betaControlRedirectAction": { - "description": "Redirects a shopper to the provided URI.", - "id": "GoogleCloudDiscoveryengineV1betaControlRedirectAction", + "GoogleCloudDiscoveryengineV1alphaSearchRequestQueryExpansionSpec": { + "description": "Specification to determine under which conditions query expansion should occur.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestQueryExpansionSpec", "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.", + "condition": { + "description": "The condition under which query expansion should occur. Default to Condition.DISABLED.", + "enum": [ + "CONDITION_UNSPECIFIED", + "DISABLED", + "AUTO" + ], + "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." + ], "type": "string" + }, + "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" } }, "type": "object" }, - "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\".", - "id": "GoogleCloudDiscoveryengineV1betaControlSynonymsAction", + "GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAsYouTypeSpec": { + "description": "Specification for search as you type in search requests.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAsYouTypeSpec", "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.", - "items": { - "type": "string" - }, - "type": "array" + "condition": { + "description": "The condition under which search as you type should occur. Default to Condition.DISABLED.", + "enum": [ + "CONDITION_UNSPECIFIED", + "DISABLED", + "ENABLED" + ], + "enumDescriptions": [ + "Server behavior defaults to Condition.DISABLED.", + "Disables Search As You Type.", + "Enables Search As You Type." + ], + "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1betaCreateDataStoreMetadata": { - "description": "Metadata related to the progress of the DataStoreService.CreateDataStore operation. This will be returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1betaCreateDataStoreMetadata", + "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.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestSessionSpec", "properties": { - "createTime": { - "description": "Operation create time.", - "format": "google-datetime", + "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" }, - "updateTime": { - "description": "Operation last update time. If the operation is done, this is also the finish time.", - "format": "google-datetime", - "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.", + "format": "int32", + "type": "integer" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1betaCreateEngineMetadata": { - "description": "Metadata related to the progress of the EngineService.CreateEngine operation. This will be returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1betaCreateEngineMetadata", + "GoogleCloudDiscoveryengineV1alphaSearchRequestSpellCorrectionSpec": { + "description": "The specification for query spell correction.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestSpellCorrectionSpec", "properties": { - "createTime": { - "description": "Operation create time.", + "mode": { + "description": "The mode under which spell correction replaces the original search query. Defaults to Mode.AUTO.", + "enum": [ + "MODE_UNSPECIFIED", + "SUGGESTION_ONLY", + "AUTO" + ], + "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." + ], + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaSession": { + "description": "External session proto definition.", + "id": "GoogleCloudDiscoveryengineV1alphaSession", + "properties": { + "endTime": { + "description": "Output only. The time the session finished.", "format": "google-datetime", + "readOnly": true, "type": "string" }, - "updateTime": { - "description": "Operation last update time. If the operation is done, this is also the finish time.", + "name": { + "description": "Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*`", + "type": "string" + }, + "startTime": { + "description": "Output only. The time the session started.", "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "state": { + "description": "The state of the session.", + "enum": [ + "STATE_UNSPECIFIED", + "IN_PROGRESS" + ], + "enumDescriptions": [ + "State is unspecified.", + "The session is currently open." + ], + "type": "string" + }, + "turns": { + "description": "Turns.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSessionTurn" + }, + "type": "array" + }, + "userPseudoId": { + "description": "A unique identifier for tracking users.", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1betaCreateSchemaMetadata": { - "description": "Metadata for Create Schema LRO.", - "id": "GoogleCloudDiscoveryengineV1betaCreateSchemaMetadata", + "GoogleCloudDiscoveryengineV1alphaSessionTurn": { + "description": "Represents a turn, including a query from the user and a answer from service.", + "id": "GoogleCloudDiscoveryengineV1alphaSessionTurn", "properties": { - "createTime": { - "description": "Operation create time.", - "format": "google-datetime", + "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" }, - "updateTime": { - "description": "Operation last update time. If the operation is done, this is also the finish time.", - "format": "google-datetime", - "type": "string" + "query": { + "$ref": "GoogleCloudDiscoveryengineV1alphaQuery", + "description": "The user query." } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1betaCreateTargetSiteMetadata": { - "description": "Metadata related to the progress of the SiteSearchEngineService.CreateTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1betaCreateTargetSiteMetadata", + "GoogleCloudDiscoveryengineV1alphaSetUriPatternDocumentDataMetadata": { + "description": "Metadata related to the progress of the SiteSearchEngineService.SetUriPatternDocumentData operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1alphaSetUriPatternDocumentDataMetadata", "properties": { "createTime": { "description": "Operation create time.", @@ -13631,167 +14273,145 @@ }, "type": "object" }, - "GoogleCloudDiscoveryengineV1betaCustomTuningModel": { - "description": "Metadata that describes a custom tuned model.", - "id": "GoogleCloudDiscoveryengineV1betaCustomTuningModel", + "GoogleCloudDiscoveryengineV1alphaSetUriPatternDocumentDataResponse": { + "description": "Response message for SiteSearchEngineService.SetUriPatternDocumentData method.", + "id": "GoogleCloudDiscoveryengineV1alphaSetUriPatternDocumentDataResponse", + "properties": {}, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaSiteVerificationInfo": { + "description": "Verification information for target sites in advanced site search.", + "id": "GoogleCloudDiscoveryengineV1alphaSiteVerificationInfo", "properties": { - "createTime": { - "description": "Timestamp the Model was created at.", - "format": "google-datetime", - "type": "string" - }, - "displayName": { - "description": "The display name of the model.", - "type": "string" - }, - "modelState": { - "description": "The state that the model is in (e.g.`TRAINING` or `TRAINING_FAILED`).", + "siteVerificationState": { + "description": "Site verification state indicating the ownership and validity.", "enum": [ - "MODEL_STATE_UNSPECIFIED", - "TRAINING_PAUSED", - "TRAINING", - "TRAINING_COMPLETE", - "READY_FOR_SERVING", - "TRAINING_FAILED" + "SITE_VERIFICATION_STATE_UNSPECIFIED", + "VERIFIED", + "UNVERIFIED", + "EXEMPTED" ], "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." + "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." ], "type": "string" }, - "modelVersion": { - "description": "The version of the model.", - "format": "int64", - "type": "string" - }, - "name": { - "description": "Required. The fully qualified resource name of the model. Format: `projects/{project_number}/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" - }, - "trainingStartTime": { - "description": "Timestamp the model training was initiated.", + "verifyTime": { + "description": "Latest site verification time.", "format": "google-datetime", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1betaDataStore": { - "description": "DataStore captures global settings and configs at the DataStore level.", - "id": "GoogleCloudDiscoveryengineV1betaDataStore", + "GoogleCloudDiscoveryengineV1alphaTargetSite": { + "description": "A target site for the SiteSearchEngine.", + "id": "GoogleCloudDiscoveryengineV1alphaTargetSite", "properties": { - "contentConfig": { - "description": "Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT.", + "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" + }, + "failureReason": { + "$ref": "GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReason", + "description": "Output only. Failure reason.", + "readOnly": true + }, + "generatedUriPattern": { + "description": "Output only. This is system-generated based on the provided_uri_pattern.", + "readOnly": true, + "type": "string" + }, + "indexingStatus": { + "description": "Output only. Indexing status.", "enum": [ - "CONTENT_CONFIG_UNSPECIFIED", - "NO_CONTENT", - "CONTENT_REQUIRED", - "PUBLIC_WEBSITE" + "INDEXING_STATUS_UNSPECIFIED", + "PENDING", + "FAILED", + "SUCCEEDED", + "DELETING" ], "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." + "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." ], + "readOnly": true, "type": "string" }, - "createTime": { - "description": "Output only. Timestamp the DataStore was created at.", - "format": "google-datetime", + "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" }, - "defaultSchemaId": { - "description": "Output only. The id of the default Schema asscociated to this data store.", - "readOnly": true, + "providedUriPattern": { + "description": "Required. Input only. The user provided URI pattern from which the `generated_uri_pattern` is generated.", "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.", + "rootDomainUri": { + "description": "Output only. Root domain of the provided_uri_pattern.", + "readOnly": true, "type": "string" }, - "documentProcessingConfig": { - "$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfig", - "description": "Configuration for Document understanding and enrichment." + "siteVerificationInfo": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSiteVerificationInfo", + "description": "Output only. Site ownership and validity verification status.", + "readOnly": true }, - "industryVertical": { - "description": "Immutable. The industry vertical that the data store registers.", + "type": { + "description": "The type of the target site, e.g., whether the site is to be included or excluded.", "enum": [ - "INDUSTRY_VERTICAL_UNSPECIFIED", - "GENERIC", - "MEDIA", - "HEALTHCARE_FHIR" + "TYPE_UNSPECIFIED", + "INCLUDE", + "EXCLUDE" ], "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." + "This value is unused. In this case, server behavior defaults to Type.INCLUDE.", + "Include the target site.", + "Exclude the target site." ], "type": "string" }, - "languageInfo": { - "$ref": "GoogleCloudDiscoveryengineV1betaLanguageInfo", - "description": "Language info for DataStore." - }, - "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.", + "updateTime": { + "description": "Output only. The target site's last updated time.", + "format": "google-datetime", + "readOnly": true, "type": "string" - }, - "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.", - "items": { - "enum": [ - "SOLUTION_TYPE_UNSPECIFIED", - "SOLUTION_TYPE_RECOMMENDATION", - "SOLUTION_TYPE_SEARCH", - "SOLUTION_TYPE_CHAT", - "SOLUTION_TYPE_GENERATIVE_CHAT" - ], - "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." - ], - "type": "string" - }, - "type": "array" - }, - "startingSchema": { - "$ref": "GoogleCloudDiscoveryengineV1betaSchema", - "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)." } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1betaDeleteDataStoreMetadata": { - "description": "Metadata related to the progress of the DataStoreService.DeleteDataStore operation. This will be returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1betaDeleteDataStoreMetadata", + "GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReason": { + "description": "Site search indexing failure reasons.", + "id": "GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReason", "properties": { - "createTime": { - "description": "Operation create time.", - "format": "google-datetime", - "type": "string" - }, - "updateTime": { - "description": "Operation last update time. If the operation is done, this is also the finish time.", - "format": "google-datetime", + "quotaFailure": { + "$ref": "GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReasonQuotaFailure", + "description": "Failed due to insufficient quota." + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReasonQuotaFailure": { + "description": "Failed due to insufficient quota.", + "id": "GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReasonQuotaFailure", + "properties": { + "totalRequiredQuota": { + "description": "This number is an estimation on how much total quota this project needs to successfully complete indexing.", + "format": "int64", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1betaDeleteEngineMetadata": { - "description": "Metadata related to the progress of the EngineService.DeleteEngine operation. This will be returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1betaDeleteEngineMetadata", + "GoogleCloudDiscoveryengineV1alphaTrainCustomModelMetadata": { + "description": "Metadata related to the progress of the TrainCustomModel operation. This is returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1alphaTrainCustomModelMetadata", "properties": { "createTime": { "description": "Operation create time.", @@ -13806,26 +14426,60 @@ }, "type": "object" }, - "GoogleCloudDiscoveryengineV1betaDeleteSchemaMetadata": { - "description": "Metadata for DeleteSchema LRO.", - "id": "GoogleCloudDiscoveryengineV1betaDeleteSchemaMetadata", + "GoogleCloudDiscoveryengineV1alphaTrainCustomModelResponse": { + "description": "Response of the TrainCustomModelRequest. This message is returned by the google.longrunning.Operations.response field.", + "id": "GoogleCloudDiscoveryengineV1alphaTrainCustomModelResponse", "properties": { - "createTime": { - "description": "Operation create time.", - "format": "google-datetime", + "errorConfig": { + "$ref": "GoogleCloudDiscoveryengineV1alphaImportErrorConfig", + "description": "Echoes the destination for the complete errors in the request if set." + }, + "errorSamples": { + "description": "A sample of errors encountered while processing the data.", + "items": { + "$ref": "GoogleRpcStatus" + }, + "type": "array" + }, + "metrics": { + "additionalProperties": { + "format": "double", + "type": "number" + }, + "description": "The metrics of the trained model.", + "type": "object" + }, + "modelName": { + "description": "Fully qualified name of the CustomTuningModel.", "type": "string" }, - "updateTime": { - "description": "Operation last update time. If the operation is done, this is also the finish time.", - "format": "google-datetime", + "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" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1betaDeleteTargetSiteMetadata": { - "description": "Metadata related to the progress of the SiteSearchEngineService.DeleteTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1betaDeleteTargetSiteMetadata", + "GoogleCloudDiscoveryengineV1alphaTuneEngineMetadata": { + "description": "Metadata associated with a tune operation.", + "id": "GoogleCloudDiscoveryengineV1alphaTuneEngineMetadata", + "properties": { + "engine": { + "description": "Required. The resource name of the engine that this tune applies to. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaTuneEngineResponse": { + "description": "Response associated with a tune operation.", + "id": "GoogleCloudDiscoveryengineV1alphaTuneEngineResponse", + "properties": {}, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaUpdateSchemaMetadata": { + "description": "Metadata for UpdateSchema LRO.", + "id": "GoogleCloudDiscoveryengineV1alphaUpdateSchemaMetadata", "properties": { "createTime": { "description": "Operation create time.", @@ -13840,9 +14494,9 @@ }, "type": "object" }, - "GoogleCloudDiscoveryengineV1betaDisableAdvancedSiteSearchMetadata": { - "description": "Metadata related to the progress of the SiteSearchEngineService.DisableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1betaDisableAdvancedSiteSearchMetadata", + "GoogleCloudDiscoveryengineV1alphaUpdateTargetSiteMetadata": { + "description": "Metadata related to the progress of the SiteSearchEngineService.UpdateTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1alphaUpdateTargetSiteMetadata", "properties": { "createTime": { "description": "Operation create time.", @@ -13857,198 +14511,146 @@ }, "type": "object" }, - "GoogleCloudDiscoveryengineV1betaDisableAdvancedSiteSearchResponse": { - "description": "Response message for SiteSearchEngineService.DisableAdvancedSiteSearch method.", - "id": "GoogleCloudDiscoveryengineV1betaDisableAdvancedSiteSearchResponse", - "properties": {}, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfig": { - "description": "A singleton resource of DataStore. It's empty when DataStore is created, which defaults to digital parser. The first call to DataStoreService.UpdateDocumentProcessingConfig method will initialize the config.", - "id": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfig", + "GoogleCloudDiscoveryengineV1alphaUserInfo": { + "description": "Information of an end user.", + "id": "GoogleCloudDiscoveryengineV1alphaUserInfo", "properties": { - "chunkingConfig": { - "$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfig", - "description": "Whether chunking mode is enabled." - }, - "defaultParsingConfig": { - "$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig", - "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." - }, - "name": { - "description": "The full resource name of the Document Processing Config. Format: `projects/*/locations/*/collections/*/dataStores/*/documentProcessingConfig`.", + "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" }, - "parsingConfigOverrides": { - "additionalProperties": { - "$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig" - }, - "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 or layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and or layout parsing are supported.", - "type": "object" + "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" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfig": { - "description": "Configuration for chunking config.", - "id": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfig", + "GoogleCloudDiscoveryengineV1betaBatchCreateTargetSiteMetadata": { + "description": "Metadata related to the progress of the SiteSearchEngineService.BatchCreateTargetSites operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1betaBatchCreateTargetSiteMetadata", "properties": { - "layoutBasedChunkingConfig": { - "$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig", - "description": "Configuration for the layout based chunking." + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", + "type": "string" + }, + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", + "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig": { - "description": "Configuration for the layout based chunking.", - "id": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig", + "GoogleCloudDiscoveryengineV1betaBatchCreateTargetSitesResponse": { + "description": "Response message for SiteSearchEngineService.BatchCreateTargetSites method.", + "id": "GoogleCloudDiscoveryengineV1betaBatchCreateTargetSitesResponse", "properties": { - "chunkSize": { - "description": "The token size limit for each chunk. Supported values: 100-500 (inclusive). Default value: 500.", - "format": "int32", - "type": "integer" - }, - "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" + "targetSites": { + "description": "TargetSites created.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1betaTargetSite" + }, + "type": "array" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig": { - "description": "Related configurations applied to a specific type of document parser.", - "id": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig", + "GoogleCloudDiscoveryengineV1betaCondition": { + "description": "Defines circumstances to be checked before allowing a behavior", + "id": "GoogleCloudDiscoveryengineV1betaCondition", "properties": { - "digitalParsingConfig": { - "$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigDigitalParsingConfig", - "description": "Configurations applied to digital parser." - }, - "layoutParsingConfig": { - "$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigLayoutParsingConfig", - "description": "Configurations applied to layout parser." + "activeTimeRange": { + "description": "Range of time(s) specifying when condition is active. Maximum of 10 time ranges.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1betaConditionTimeRange" + }, + "type": "array" }, - "ocrParsingConfig": { - "$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsingConfig", - "description": "Configurations applied to OCR parser. Currently it only applies to PDFs." + "queryTerms": { + "description": "Search only A list of terms to match the query on. Maximum of 10 query terms.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1betaConditionQueryTerm" + }, + "type": "array" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigDigitalParsingConfig": { - "description": "The digital parsing configurations for documents.", - "id": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigDigitalParsingConfig", - "properties": {}, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigLayoutParsingConfig": { - "description": "The layout parsing configurations for documents.", - "id": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigLayoutParsingConfig", - "properties": {}, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsingConfig": { - "description": "The OCR parsing configurations for documents.", - "id": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsingConfig", + "GoogleCloudDiscoveryengineV1betaConditionQueryTerm": { + "description": "Matcher for search request query", + "id": "GoogleCloudDiscoveryengineV1betaConditionQueryTerm", "properties": { - "enhancedDocumentElements": { - "deprecated": true, - "description": "[DEPRECATED] This field is deprecated. To use the additional enhanced document elements processing, please switch to `layout_parsing_config`.", - "items": { - "type": "string" - }, - "type": "array" - }, - "useNativeText": { - "description": "If true, will use native text instead of OCR text on pages containing native text.", + "fullMatch": { + "description": "Whether the search query needs to exactly match the query term.", "type": "boolean" + }, + "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" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1betaEnableAdvancedSiteSearchMetadata": { - "description": "Metadata related to the progress of the SiteSearchEngineService.EnableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1betaEnableAdvancedSiteSearchMetadata", + "GoogleCloudDiscoveryengineV1betaConditionTimeRange": { + "description": "Used for time-dependent conditions.", + "id": "GoogleCloudDiscoveryengineV1betaConditionTimeRange", "properties": { - "createTime": { - "description": "Operation create time.", + "endTime": { + "description": "End of time range. Range is inclusive. Must be in the future.", "format": "google-datetime", "type": "string" }, - "updateTime": { - "description": "Operation last update time. If the operation is done, this is also the finish time.", + "startTime": { + "description": "Start of time range. Range is inclusive.", "format": "google-datetime", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1betaEnableAdvancedSiteSearchResponse": { - "description": "Response message for SiteSearchEngineService.EnableAdvancedSiteSearch method.", - "id": "GoogleCloudDiscoveryengineV1betaEnableAdvancedSiteSearchResponse", - "properties": {}, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1betaEngine": { - "description": "Metadata that describes the training and serving parameters of an Engine.", - "id": "GoogleCloudDiscoveryengineV1betaEngine", + "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`.", + "id": "GoogleCloudDiscoveryengineV1betaControl", "properties": { - "chatEngineConfig": { - "$ref": "GoogleCloudDiscoveryengineV1betaEngineChatEngineConfig", - "description": "Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT." - }, - "chatEngineMetadata": { - "$ref": "GoogleCloudDiscoveryengineV1betaEngineChatEngineMetadata", - "description": "Output only. Additional information of the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.", - "readOnly": true - }, - "commonConfig": { - "$ref": "GoogleCloudDiscoveryengineV1betaEngineCommonConfig", - "description": "Common config spec that specifies the metadata of the engine." - }, - "createTime": { - "description": "Output only. Timestamp the Recommendation Engine was created at.", - "format": "google-datetime", + "associatedServingConfigIds": { + "description": "Output only. List of all ServingConfig ids this control is attached to. May take up to 10 minutes to update after changes.", + "items": { + "type": "string" + }, "readOnly": true, - "type": "string" + "type": "array" }, - "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.", + "boostAction": { + "$ref": "GoogleCloudDiscoveryengineV1betaControlBoostAction", + "description": "Defines a boost-type control" + }, + "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.", "items": { - "type": "string" + "$ref": "GoogleCloudDiscoveryengineV1betaCondition" }, "type": "array" }, "displayName": { - "description": "Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters.", + "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" }, - "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.", - "enum": [ - "INDUSTRY_VERTICAL_UNSPECIFIED", - "GENERIC", - "MEDIA", - "HEALTHCARE_FHIR" - ], - "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." - ], - "type": "string" + "filterAction": { + "$ref": "GoogleCloudDiscoveryengineV1betaControlFilterAction", + "description": "Defines a filter-type control Currently not supported by Recommendation" }, "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_number}/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.", + "description": "Immutable. Fully qualified name `projects/*/locations/global/dataStore/*/controls/*`", "type": "string" }, - "searchEngineConfig": { - "$ref": "GoogleCloudDiscoveryengineV1betaEngineSearchEngineConfig", - "description": "Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH." + "redirectAction": { + "$ref": "GoogleCloudDiscoveryengineV1betaControlRedirectAction", + "description": "Defines a redirect-type control." }, "solutionType": { - "description": "Required. The solutions of the engine.", + "description": "Required. Immutable. What solution the control belongs to. Must be compatible with vertical of resource. Otherwise an INVALID ARGUMENT error is thrown.", "enum": [ "SOLUTION_TYPE_UNSPECIFIED", "SOLUTION_TYPE_RECOMMENDATION", @@ -14065,130 +14667,99 @@ ], "type": "string" }, - "updateTime": { - "description": "Output only. Timestamp the Recommendation Engine was last updated.", - "format": "google-datetime", - "readOnly": true, - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1betaEngineChatEngineConfig": { - "description": "Configurations for a Chat Engine.", - "id": "GoogleCloudDiscoveryengineV1betaEngineChatEngineConfig", - "properties": { - "agentCreationConfig": { - "$ref": "GoogleCloudDiscoveryengineV1betaEngineChatEngineConfigAgentCreationConfig", - "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." + "synonymsAction": { + "$ref": "GoogleCloudDiscoveryengineV1betaControlSynonymsAction", + "description": "Treats a group of terms as synonyms of one another." }, - "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" + "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.", + "items": { + "enum": [ + "SEARCH_USE_CASE_UNSPECIFIED", + "SEARCH_USE_CASE_SEARCH", + "SEARCH_USE_CASE_BROWSE" + ], + "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." + ], + "type": "string" + }, + "type": "array" } }, "type": "object" }, - "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.", - "id": "GoogleCloudDiscoveryengineV1betaEngineChatEngineConfigAgentCreationConfig", + "GoogleCloudDiscoveryengineV1betaControlBoostAction": { + "description": "Adjusts order of products in returned list.", + "id": "GoogleCloudDiscoveryengineV1betaControlBoostAction", "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" + "boost": { + "description": "Required. Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0 (No-op).", + "format": "float", + "type": "number" }, - "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.", + "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" }, - "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.", + "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" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1betaEngineChatEngineMetadata": { - "description": "Additional information of a Chat Engine. Fields in this message are output only.", - "id": "GoogleCloudDiscoveryengineV1betaEngineChatEngineMetadata", + "GoogleCloudDiscoveryengineV1betaControlFilterAction": { + "description": "Specified which products may be included in results. Uses same filter as boost.", + "id": "GoogleCloudDiscoveryengineV1betaControlFilterAction", "properties": { - "dialogflowAgent": { - "description": "The resource name of a Dialogflow agent, that this Chat Engine refers to. Format: `projects//locations//agents/`.", + "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" + }, + "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" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1betaEngineCommonConfig": { - "description": "Common configurations for an Engine.", - "id": "GoogleCloudDiscoveryengineV1betaEngineCommonConfig", + "GoogleCloudDiscoveryengineV1betaControlRedirectAction": { + "description": "Redirects a shopper to the provided URI.", + "id": "GoogleCloudDiscoveryengineV1betaControlRedirectAction", "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.", + "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" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1betaEngineSearchEngineConfig": { - "description": "Configurations for a Search Engine.", - "id": "GoogleCloudDiscoveryengineV1betaEngineSearchEngineConfig", + "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\".", + "id": "GoogleCloudDiscoveryengineV1betaControlSynonymsAction", "properties": { - "searchAddOns": { - "description": "The add-on that this search engine enables.", + "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.", "items": { - "enum": [ - "SEARCH_ADD_ON_UNSPECIFIED", - "SEARCH_ADD_ON_LLM" - ], - "enumDescriptions": [ - "Default value when the enum is unspecified. This is invalid to use.", - "Large language model add-on." - ], "type": "string" }, "type": "array" - }, - "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.", - "enum": [ - "SEARCH_TIER_UNSPECIFIED", - "SEARCH_TIER_STANDARD", - "SEARCH_TIER_ENTERPRISE" - ], - "enumDescriptions": [ - "Default value when the enum is unspecified. This is invalid to use.", - "Standard tier.", - "Enterprise tier." - ], - "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1betaImportCompletionSuggestionsMetadata": { - "description": "Metadata related to the progress of the ImportCompletionSuggestions operation. This will be returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1betaImportCompletionSuggestionsMetadata", + "GoogleCloudDiscoveryengineV1betaCreateDataStoreMetadata": { + "description": "Metadata related to the progress of the DataStoreService.CreateDataStore operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1betaCreateDataStoreMetadata", "properties": { "createTime": { "description": "Operation create time.", "format": "google-datetime", "type": "string" }, - "failureCount": { - "description": "Count of CompletionSuggestions that failed to be imported.", - "format": "int64", - "type": "string" - }, - "successCount": { - "description": "Count of CompletionSuggestions successfully imported.", - "format": "int64", - "type": "string" - }, "updateTime": { "description": "Operation last update time. If the operation is done, this is also the finish time.", "format": "google-datetime", @@ -14197,46 +14768,53 @@ }, "type": "object" }, - "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.", - "id": "GoogleCloudDiscoveryengineV1betaImportCompletionSuggestionsResponse", + "GoogleCloudDiscoveryengineV1betaCreateEngineMetadata": { + "description": "Metadata related to the progress of the EngineService.CreateEngine operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1betaCreateEngineMetadata", "properties": { - "errorConfig": { - "$ref": "GoogleCloudDiscoveryengineV1betaImportErrorConfig", - "description": "The desired location of errors incurred during the Import." + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", + "type": "string" }, - "errorSamples": { - "description": "A sample of errors encountered while processing the request.", - "items": { - "$ref": "GoogleRpcStatus" - }, - "type": "array" + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", + "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1betaImportDocumentsMetadata": { - "description": "Metadata related to the progress of the ImportDocuments operation. This is returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1betaImportDocumentsMetadata", + "GoogleCloudDiscoveryengineV1betaCreateEvaluationMetadata": { + "description": "Metadata for EvaluationService.CreateEvaluation method.", + "id": "GoogleCloudDiscoveryengineV1betaCreateEvaluationMetadata", + "properties": {}, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaCreateSchemaMetadata": { + "description": "Metadata for Create Schema LRO.", + "id": "GoogleCloudDiscoveryengineV1betaCreateSchemaMetadata", "properties": { "createTime": { "description": "Operation create time.", "format": "google-datetime", "type": "string" }, - "failureCount": { - "description": "Count of entries that encountered errors while processing.", - "format": "int64", - "type": "string" - }, - "successCount": { - "description": "Count of entries that were processed successfully.", - "format": "int64", + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", "type": "string" - }, - "totalCount": { - "description": "Total count of entries that were processed.", - "format": "int64", + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaCreateTargetSiteMetadata": { + "description": "Metadata related to the progress of the SiteSearchEngineService.CreateTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1betaCreateTargetSiteMetadata", + "properties": { + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", "type": "string" }, "updateTime": { @@ -14247,38 +14825,161 @@ }, "type": "object" }, - "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.", - "id": "GoogleCloudDiscoveryengineV1betaImportDocumentsResponse", - "properties": { - "errorConfig": { - "$ref": "GoogleCloudDiscoveryengineV1betaImportErrorConfig", - "description": "Echoes the destination for the complete errors in the request if set." + "GoogleCloudDiscoveryengineV1betaCustomTuningModel": { + "description": "Metadata that describes a custom tuned model.", + "id": "GoogleCloudDiscoveryengineV1betaCustomTuningModel", + "properties": { + "createTime": { + "deprecated": true, + "description": "Timestamp the Model was created at.", + "format": "google-datetime", + "type": "string" }, - "errorSamples": { - "description": "A sample of errors encountered while processing the request.", - "items": { - "$ref": "GoogleRpcStatus" + "displayName": { + "description": "The display name of the model.", + "type": "string" + }, + "metrics": { + "additionalProperties": { + "format": "double", + "type": "number" }, - "type": "array" + "description": "The metrics of the trained model.", + "type": "object" + }, + "modelState": { + "description": "The state that the model is in (e.g.`TRAINING` or `TRAINING_FAILED`).", + "enum": [ + "MODEL_STATE_UNSPECIFIED", + "TRAINING_PAUSED", + "TRAINING", + "TRAINING_COMPLETE", + "READY_FOR_SERVING", + "TRAINING_FAILED", + "NO_IMPROVEMENT" + ], + "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." + ], + "type": "string" + }, + "modelVersion": { + "description": "The version of the model.", + "format": "int64", + "type": "string" + }, + "name": { + "description": "Required. The fully qualified resource name of the model. Format: `projects/{project_number}/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" + }, + "trainingStartTime": { + "description": "Timestamp the model training was initiated.", + "format": "google-datetime", + "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1betaImportErrorConfig": { - "description": "Configuration of destination for Import related errors.", - "id": "GoogleCloudDiscoveryengineV1betaImportErrorConfig", + "GoogleCloudDiscoveryengineV1betaDataStore": { + "description": "DataStore captures global settings and configs at the DataStore level.", + "id": "GoogleCloudDiscoveryengineV1betaDataStore", "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.", + "contentConfig": { + "description": "Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT.", + "enum": [ + "CONTENT_CONFIG_UNSPECIFIED", + "NO_CONTENT", + "CONTENT_REQUIRED", + "PUBLIC_WEBSITE" + ], + "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." + ], + "type": "string" + }, + "createTime": { + "description": "Output only. Timestamp the DataStore was created at.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "defaultSchemaId": { + "description": "Output only. The id of the default Schema asscociated to this data store.", + "readOnly": true, + "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" + }, + "documentProcessingConfig": { + "$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfig", + "description": "Configuration for Document understanding and enrichment." + }, + "industryVertical": { + "description": "Immutable. The industry vertical that the data store registers.", + "enum": [ + "INDUSTRY_VERTICAL_UNSPECIFIED", + "GENERIC", + "MEDIA", + "HEALTHCARE_FHIR" + ], + "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." + ], + "type": "string" + }, + "languageInfo": { + "$ref": "GoogleCloudDiscoveryengineV1betaLanguageInfo", + "description": "Language info for DataStore." + }, + "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" + }, + "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.", + "items": { + "enum": [ + "SOLUTION_TYPE_UNSPECIFIED", + "SOLUTION_TYPE_RECOMMENDATION", + "SOLUTION_TYPE_SEARCH", + "SOLUTION_TYPE_CHAT", + "SOLUTION_TYPE_GENERATIVE_CHAT" + ], + "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." + ], + "type": "string" + }, + "type": "array" + }, + "startingSchema": { + "$ref": "GoogleCloudDiscoveryengineV1betaSchema", + "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)." } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1betaImportSuggestionDenyListEntriesMetadata": { - "description": "Metadata related to the progress of the ImportSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1betaImportSuggestionDenyListEntriesMetadata", + "GoogleCloudDiscoveryengineV1betaDeleteDataStoreMetadata": { + "description": "Metadata related to the progress of the DataStoreService.DeleteDataStore operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1betaDeleteDataStoreMetadata", "properties": { "createTime": { "description": "Operation create time.", @@ -14293,49 +14994,32 @@ }, "type": "object" }, - "GoogleCloudDiscoveryengineV1betaImportSuggestionDenyListEntriesResponse": { - "description": "Response message for CompletionService.ImportSuggestionDenyListEntries method.", - "id": "GoogleCloudDiscoveryengineV1betaImportSuggestionDenyListEntriesResponse", + "GoogleCloudDiscoveryengineV1betaDeleteEngineMetadata": { + "description": "Metadata related to the progress of the EngineService.DeleteEngine operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1betaDeleteEngineMetadata", "properties": { - "errorSamples": { - "description": "A sample of errors encountered while processing the request.", - "items": { - "$ref": "GoogleRpcStatus" - }, - "type": "array" - }, - "failedEntriesCount": { - "description": "Count of deny list entries that failed to be imported.", - "format": "int64", + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", "type": "string" }, - "importedEntriesCount": { - "description": "Count of deny list entries successfully imported.", - "format": "int64", + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1betaImportUserEventsMetadata": { - "description": "Metadata related to the progress of the Import operation. This is returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1betaImportUserEventsMetadata", + "GoogleCloudDiscoveryengineV1betaDeleteSchemaMetadata": { + "description": "Metadata for DeleteSchema LRO.", + "id": "GoogleCloudDiscoveryengineV1betaDeleteSchemaMetadata", "properties": { "createTime": { "description": "Operation create time.", "format": "google-datetime", "type": "string" }, - "failureCount": { - "description": "Count of entries that encountered errors while processing.", - "format": "int64", - "type": "string" - }, - "successCount": { - "description": "Count of entries that were processed successfully.", - "format": "int64", - "type": "string" - }, "updateTime": { "description": "Operation last update time. If the operation is done, this is also the finish time.", "format": "google-datetime", @@ -14344,196 +15028,1554 @@ }, "type": "object" }, - "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.", - "id": "GoogleCloudDiscoveryengineV1betaImportUserEventsResponse", + "GoogleCloudDiscoveryengineV1betaDeleteTargetSiteMetadata": { + "description": "Metadata related to the progress of the SiteSearchEngineService.DeleteTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1betaDeleteTargetSiteMetadata", "properties": { - "errorConfig": { - "$ref": "GoogleCloudDiscoveryengineV1betaImportErrorConfig", - "description": "Echoes the destination for the complete errors if this field was set in the request." - }, - "errorSamples": { - "description": "A sample of errors encountered while processing the request.", - "items": { - "$ref": "GoogleRpcStatus" - }, - "type": "array" - }, - "joinedEventsCount": { - "description": "Count of user events imported with complete existing Documents.", - "format": "int64", + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", "type": "string" }, - "unjoinedEventsCount": { - "description": "Count of user events imported, but with Document information not found in the existing Branch.", - "format": "int64", + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1betaLanguageInfo": { - "description": "Language info for DataStore.", - "id": "GoogleCloudDiscoveryengineV1betaLanguageInfo", + "GoogleCloudDiscoveryengineV1betaDisableAdvancedSiteSearchMetadata": { + "description": "Metadata related to the progress of the SiteSearchEngineService.DisableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1betaDisableAdvancedSiteSearchMetadata", "properties": { - "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" - }, - "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, + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", "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, + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1betaListCustomModelsResponse": { - "description": "Response message for SearchTuningService.ListCustomModels method.", - "id": "GoogleCloudDiscoveryengineV1betaListCustomModelsResponse", - "properties": { - "models": { + "GoogleCloudDiscoveryengineV1betaDisableAdvancedSiteSearchResponse": { + "description": "Response message for SiteSearchEngineService.DisableAdvancedSiteSearch method.", + "id": "GoogleCloudDiscoveryengineV1betaDisableAdvancedSiteSearchResponse", + "properties": {}, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfig": { + "description": "A singleton resource of DataStore. It's empty when DataStore is created, which defaults to digital parser. The first call to DataStoreService.UpdateDocumentProcessingConfig method will initialize the config.", + "id": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfig", + "properties": { + "chunkingConfig": { + "$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfig", + "description": "Whether chunking mode is enabled." + }, + "defaultParsingConfig": { + "$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig", + "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." + }, + "name": { + "description": "The full resource name of the Document Processing Config. Format: `projects/*/locations/*/collections/*/dataStores/*/documentProcessingConfig`.", + "type": "string" + }, + "parsingConfigOverrides": { + "additionalProperties": { + "$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig" + }, + "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.", + "type": "object" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfig": { + "description": "Configuration for chunking config.", + "id": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfig", + "properties": { + "layoutBasedChunkingConfig": { + "$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig", + "description": "Configuration for the layout based chunking." + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig": { + "description": "Configuration for the layout based chunking.", + "id": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig", + "properties": { + "chunkSize": { + "description": "The token size limit for each chunk. Supported values: 100-500 (inclusive). Default value: 500.", + "format": "int32", + "type": "integer" + }, + "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" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig": { + "description": "Related configurations applied to a specific type of document parser.", + "id": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig", + "properties": { + "digitalParsingConfig": { + "$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigDigitalParsingConfig", + "description": "Configurations applied to digital parser." + }, + "layoutParsingConfig": { + "$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigLayoutParsingConfig", + "description": "Configurations applied to layout parser." + }, + "ocrParsingConfig": { + "$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsingConfig", + "description": "Configurations applied to OCR parser. Currently it only applies to PDFs." + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigDigitalParsingConfig": { + "description": "The digital parsing configurations for documents.", + "id": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigDigitalParsingConfig", + "properties": {}, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigLayoutParsingConfig": { + "description": "The layout parsing configurations for documents.", + "id": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigLayoutParsingConfig", + "properties": {}, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsingConfig": { + "description": "The OCR parsing configurations for documents.", + "id": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsingConfig", + "properties": { + "enhancedDocumentElements": { + "deprecated": true, + "description": "[DEPRECATED] This field is deprecated. To use the additional enhanced document elements processing, please switch to `layout_parsing_config`.", + "items": { + "type": "string" + }, + "type": "array" + }, + "useNativeText": { + "description": "If true, will use native text instead of OCR text on pages containing native text.", + "type": "boolean" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaEnableAdvancedSiteSearchMetadata": { + "description": "Metadata related to the progress of the SiteSearchEngineService.EnableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1betaEnableAdvancedSiteSearchMetadata", + "properties": { + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", + "type": "string" + }, + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaEnableAdvancedSiteSearchResponse": { + "description": "Response message for SiteSearchEngineService.EnableAdvancedSiteSearch method.", + "id": "GoogleCloudDiscoveryengineV1betaEnableAdvancedSiteSearchResponse", + "properties": {}, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaEngine": { + "description": "Metadata that describes the training and serving parameters of an Engine.", + "id": "GoogleCloudDiscoveryengineV1betaEngine", + "properties": { + "chatEngineConfig": { + "$ref": "GoogleCloudDiscoveryengineV1betaEngineChatEngineConfig", + "description": "Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT." + }, + "chatEngineMetadata": { + "$ref": "GoogleCloudDiscoveryengineV1betaEngineChatEngineMetadata", + "description": "Output only. Additional information of the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.", + "readOnly": true + }, + "commonConfig": { + "$ref": "GoogleCloudDiscoveryengineV1betaEngineCommonConfig", + "description": "Common config spec that specifies the metadata of the engine." + }, + "createTime": { + "description": "Output only. Timestamp the Recommendation Engine was created at.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "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.", + "items": { + "type": "string" + }, + "type": "array" + }, + "displayName": { + "description": "Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters.", + "type": "string" + }, + "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.", + "enum": [ + "INDUSTRY_VERTICAL_UNSPECIFIED", + "GENERIC", + "MEDIA", + "HEALTHCARE_FHIR" + ], + "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." + ], + "type": "string" + }, + "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_number}/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" + }, + "searchEngineConfig": { + "$ref": "GoogleCloudDiscoveryengineV1betaEngineSearchEngineConfig", + "description": "Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH." + }, + "solutionType": { + "description": "Required. The solutions of the engine.", + "enum": [ + "SOLUTION_TYPE_UNSPECIFIED", + "SOLUTION_TYPE_RECOMMENDATION", + "SOLUTION_TYPE_SEARCH", + "SOLUTION_TYPE_CHAT", + "SOLUTION_TYPE_GENERATIVE_CHAT" + ], + "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." + ], + "type": "string" + }, + "updateTime": { + "description": "Output only. Timestamp the Recommendation Engine was last updated.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaEngineChatEngineConfig": { + "description": "Configurations for a Chat Engine.", + "id": "GoogleCloudDiscoveryengineV1betaEngineChatEngineConfig", + "properties": { + "agentCreationConfig": { + "$ref": "GoogleCloudDiscoveryengineV1betaEngineChatEngineConfigAgentCreationConfig", + "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." + }, + "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" + } + }, + "type": "object" + }, + "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.", + "id": "GoogleCloudDiscoveryengineV1betaEngineChatEngineConfigAgentCreationConfig", + "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" + }, + "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" + }, + "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" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaEngineChatEngineMetadata": { + "description": "Additional information of a Chat Engine. Fields in this message are output only.", + "id": "GoogleCloudDiscoveryengineV1betaEngineChatEngineMetadata", + "properties": { + "dialogflowAgent": { + "description": "The resource name of a Dialogflow agent, that this Chat Engine refers to. Format: `projects//locations//agents/`.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaEngineCommonConfig": { + "description": "Common configurations for an Engine.", + "id": "GoogleCloudDiscoveryengineV1betaEngineCommonConfig", + "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" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaEngineSearchEngineConfig": { + "description": "Configurations for a Search Engine.", + "id": "GoogleCloudDiscoveryengineV1betaEngineSearchEngineConfig", + "properties": { + "searchAddOns": { + "description": "The add-on that this search engine enables.", + "items": { + "enum": [ + "SEARCH_ADD_ON_UNSPECIFIED", + "SEARCH_ADD_ON_LLM" + ], + "enumDescriptions": [ + "Default value when the enum is unspecified. This is invalid to use.", + "Large language model add-on." + ], + "type": "string" + }, + "type": "array" + }, + "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.", + "enum": [ + "SEARCH_TIER_UNSPECIFIED", + "SEARCH_TIER_STANDARD", + "SEARCH_TIER_ENTERPRISE" + ], + "enumDescriptions": [ + "Default value when the enum is unspecified. This is invalid to use.", + "Standard tier.", + "Enterprise tier." + ], + "type": "string" + } + }, + "type": "object" + }, + "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.", + "id": "GoogleCloudDiscoveryengineV1betaEvaluation", + "properties": { + "createTime": { + "description": "Output only. Timestamp the Evaluation was created at.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "endTime": { + "description": "Output only. Timestamp the Evaluation was completed at.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "error": { + "$ref": "GoogleRpcStatus", + "description": "Output only. The error that occurred during evaluation. Only populated when the evaluation's state is FAILED.", + "readOnly": true + }, + "errorSamples": { + "description": "Output only. A sample of errors encountered while processing the request.", + "items": { + "$ref": "GoogleRpcStatus" + }, + "readOnly": true, + "type": "array" + }, + "evaluationSpec": { + "$ref": "GoogleCloudDiscoveryengineV1betaEvaluationEvaluationSpec", + "description": "Required. The specification of the evaluation." + }, + "name": { + "description": "Immutable. 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" + }, + "qualityMetrics": { + "$ref": "GoogleCloudDiscoveryengineV1betaQualityMetrics", + "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 + }, + "state": { + "description": "Output only. The state of the evaluation.", + "enum": [ + "STATE_UNSPECIFIED", + "PENDING", + "RUNNING", + "SUCCEEDED", + "FAILED" + ], + "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." + ], + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaEvaluationEvaluationSpec": { + "description": "Describes the specification of the evaluation.", + "id": "GoogleCloudDiscoveryengineV1betaEvaluationEvaluationSpec", + "properties": { + "querySetSpec": { + "$ref": "GoogleCloudDiscoveryengineV1betaEvaluationEvaluationSpecQuerySetSpec", + "description": "Required. The specification of the query set." + }, + "searchRequest": { + "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequest", + "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" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaEvaluationEvaluationSpecQuerySetSpec": { + "description": "Describes the specification of the query set.", + "id": "GoogleCloudDiscoveryengineV1betaEvaluationEvaluationSpecQuerySetSpec", + "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" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaImportCompletionSuggestionsMetadata": { + "description": "Metadata related to the progress of the ImportCompletionSuggestions operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1betaImportCompletionSuggestionsMetadata", + "properties": { + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", + "type": "string" + }, + "failureCount": { + "description": "Count of CompletionSuggestions that failed to be imported.", + "format": "int64", + "type": "string" + }, + "successCount": { + "description": "Count of CompletionSuggestions successfully imported.", + "format": "int64", + "type": "string" + }, + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "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.", + "id": "GoogleCloudDiscoveryengineV1betaImportCompletionSuggestionsResponse", + "properties": { + "errorConfig": { + "$ref": "GoogleCloudDiscoveryengineV1betaImportErrorConfig", + "description": "The desired location of errors incurred during the Import." + }, + "errorSamples": { + "description": "A sample of errors encountered while processing the request.", + "items": { + "$ref": "GoogleRpcStatus" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaImportDocumentsMetadata": { + "description": "Metadata related to the progress of the ImportDocuments operation. This is returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1betaImportDocumentsMetadata", + "properties": { + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", + "type": "string" + }, + "failureCount": { + "description": "Count of entries that encountered errors while processing.", + "format": "int64", + "type": "string" + }, + "successCount": { + "description": "Count of entries that were processed successfully.", + "format": "int64", + "type": "string" + }, + "totalCount": { + "description": "Total count of entries that were processed.", + "format": "int64", + "type": "string" + }, + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "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.", + "id": "GoogleCloudDiscoveryengineV1betaImportDocumentsResponse", + "properties": { + "errorConfig": { + "$ref": "GoogleCloudDiscoveryengineV1betaImportErrorConfig", + "description": "Echoes the destination for the complete errors in the request if set." + }, + "errorSamples": { + "description": "A sample of errors encountered while processing the request.", + "items": { + "$ref": "GoogleRpcStatus" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaImportErrorConfig": { + "description": "Configuration of destination for Import related errors.", + "id": "GoogleCloudDiscoveryengineV1betaImportErrorConfig", + "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" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaImportSampleQueriesMetadata": { + "description": "Metadata related to the progress of the ImportSampleQueries operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1betaImportSampleQueriesMetadata", + "properties": { + "createTime": { + "description": "ImportSampleQueries operation create time.", + "format": "google-datetime", + "type": "string" + }, + "failureCount": { + "description": "Count of SampleQuerys that failed to be imported.", + "format": "int64", + "type": "string" + }, + "successCount": { + "description": "Count of SampleQuerys successfully imported.", + "format": "int64", + "type": "string" + }, + "totalCount": { + "description": "Total count of SampleQuerys that were processed.", + "format": "int64", + "type": "string" + }, + "updateTime": { + "description": "ImportSampleQueries operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "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.", + "id": "GoogleCloudDiscoveryengineV1betaImportSampleQueriesResponse", + "properties": { + "errorConfig": { + "$ref": "GoogleCloudDiscoveryengineV1betaImportErrorConfig", + "description": "The desired location of errors incurred during the Import." + }, + "errorSamples": { + "description": "A sample of errors encountered while processing the request.", + "items": { + "$ref": "GoogleRpcStatus" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaImportSuggestionDenyListEntriesMetadata": { + "description": "Metadata related to the progress of the ImportSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1betaImportSuggestionDenyListEntriesMetadata", + "properties": { + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", + "type": "string" + }, + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaImportSuggestionDenyListEntriesResponse": { + "description": "Response message for CompletionService.ImportSuggestionDenyListEntries method.", + "id": "GoogleCloudDiscoveryengineV1betaImportSuggestionDenyListEntriesResponse", + "properties": { + "errorSamples": { + "description": "A sample of errors encountered while processing the request.", + "items": { + "$ref": "GoogleRpcStatus" + }, + "type": "array" + }, + "failedEntriesCount": { + "description": "Count of deny list entries that failed to be imported.", + "format": "int64", + "type": "string" + }, + "importedEntriesCount": { + "description": "Count of deny list entries successfully imported.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaImportUserEventsMetadata": { + "description": "Metadata related to the progress of the Import operation. This is returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1betaImportUserEventsMetadata", + "properties": { + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", + "type": "string" + }, + "failureCount": { + "description": "Count of entries that encountered errors while processing.", + "format": "int64", + "type": "string" + }, + "successCount": { + "description": "Count of entries that were processed successfully.", + "format": "int64", + "type": "string" + }, + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "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.", + "id": "GoogleCloudDiscoveryengineV1betaImportUserEventsResponse", + "properties": { + "errorConfig": { + "$ref": "GoogleCloudDiscoveryengineV1betaImportErrorConfig", + "description": "Echoes the destination for the complete errors if this field was set in the request." + }, + "errorSamples": { + "description": "A sample of errors encountered while processing the request.", + "items": { + "$ref": "GoogleRpcStatus" + }, + "type": "array" + }, + "joinedEventsCount": { + "description": "Count of user events imported with complete existing Documents.", + "format": "int64", + "type": "string" + }, + "unjoinedEventsCount": { + "description": "Count of user events imported, but with Document information not found in the existing Branch.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaInterval": { + "description": "A floating point interval.", + "id": "GoogleCloudDiscoveryengineV1betaInterval", + "properties": { + "exclusiveMaximum": { + "description": "Exclusive upper bound.", + "format": "double", + "type": "number" + }, + "exclusiveMinimum": { + "description": "Exclusive lower bound.", + "format": "double", + "type": "number" + }, + "maximum": { + "description": "Inclusive upper bound.", + "format": "double", + "type": "number" + }, + "minimum": { + "description": "Inclusive lower bound.", + "format": "double", + "type": "number" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaLanguageInfo": { + "description": "Language info for DataStore.", + "id": "GoogleCloudDiscoveryengineV1betaLanguageInfo", + "properties": { + "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" + }, + "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" + }, + "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" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaListCustomModelsResponse": { + "description": "Response message for SearchTuningService.ListCustomModels method.", + "id": "GoogleCloudDiscoveryengineV1betaListCustomModelsResponse", + "properties": { + "models": { "description": "List of custom tuning models.", "items": { - "$ref": "GoogleCloudDiscoveryengineV1betaCustomTuningModel" + "$ref": "GoogleCloudDiscoveryengineV1betaCustomTuningModel" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaProject": { + "description": "Metadata and configurations for a Google Cloud project in the service.", + "id": "GoogleCloudDiscoveryengineV1betaProject", + "properties": { + "createTime": { + "description": "Output only. The timestamp when this project is created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "Output only. Full resource name of the project, for example `projects/{project_number}`. 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" + }, + "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.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "serviceTermsMap": { + "additionalProperties": { + "$ref": "GoogleCloudDiscoveryengineV1betaProjectServiceTerms" + }, + "description": "Output only. A map of terms of services. The key is the `id` of ServiceTerms.", + "readOnly": true, + "type": "object" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaProjectServiceTerms": { + "description": "Metadata about the terms of service.", + "id": "GoogleCloudDiscoveryengineV1betaProjectServiceTerms", + "properties": { + "acceptTime": { + "description": "The last time when the project agreed to the terms of service.", + "format": "google-datetime", + "type": "string" + }, + "declineTime": { + "description": "The last time when the project declined or revoked the agreement to terms of service.", + "format": "google-datetime", + "type": "string" + }, + "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" + }, + "state": { + "description": "Whether the project has accepted/rejected the service terms or it is still pending.", + "enum": [ + "STATE_UNSPECIFIED", + "TERMS_ACCEPTED", + "TERMS_PENDING", + "TERMS_DECLINED" + ], + "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." + ], + "type": "string" + }, + "version": { + "description": "The version string of the terms of service. For acceptable values, see the comments for id above.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaProvisionProjectMetadata": { + "description": "Metadata associated with a project provision operation.", + "id": "GoogleCloudDiscoveryengineV1betaProvisionProjectMetadata", + "properties": {}, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaPurgeDocumentsMetadata": { + "description": "Metadata related to the progress of the PurgeDocuments operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1betaPurgeDocumentsMetadata", + "properties": { + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", + "type": "string" + }, + "failureCount": { + "description": "Count of entries that encountered errors while processing.", + "format": "int64", + "type": "string" + }, + "ignoredCount": { + "description": "Count of entries that were ignored as entries were not found.", + "format": "int64", + "type": "string" + }, + "successCount": { + "description": "Count of entries that were deleted successfully.", + "format": "int64", + "type": "string" + }, + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "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.", + "id": "GoogleCloudDiscoveryengineV1betaPurgeDocumentsResponse", + "properties": { + "purgeCount": { + "description": "The total count of documents purged as a result of the operation.", + "format": "int64", + "type": "string" + }, + "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.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaPurgeSuggestionDenyListEntriesMetadata": { + "description": "Metadata related to the progress of the PurgeSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1betaPurgeSuggestionDenyListEntriesMetadata", + "properties": { + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", + "type": "string" + }, + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaPurgeSuggestionDenyListEntriesResponse": { + "description": "Response message for CompletionService.PurgeSuggestionDenyListEntries method.", + "id": "GoogleCloudDiscoveryengineV1betaPurgeSuggestionDenyListEntriesResponse", + "properties": { + "errorSamples": { + "description": "A sample of errors encountered while processing the request.", + "items": { + "$ref": "GoogleRpcStatus" + }, + "type": "array" + }, + "purgeCount": { + "description": "Number of suggestion deny list entries purged.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaQualityMetrics": { + "description": "Describes the metrics produced by the evaluation.", + "id": "GoogleCloudDiscoveryengineV1betaQualityMetrics", + "properties": { + "docNdcg": { + "$ref": "GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics", + "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" + }, + "docPrecision": { + "$ref": "GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics", + "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" + }, + "docRecall": { + "$ref": "GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics", + "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" + }, + "pageNdcg": { + "$ref": "GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics", + "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" + }, + "pageRecall": { + "$ref": "GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics", + "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" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics": { + "description": "Stores the metric values at specific top-k levels.", + "id": "GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics", + "properties": { + "top1": { + "description": "The top-1 value.", + "format": "double", + "type": "number" + }, + "top10": { + "description": "The top-10 value.", + "format": "double", + "type": "number" + }, + "top3": { + "description": "The top-3 value.", + "format": "double", + "type": "number" + }, + "top5": { + "description": "The top-5 value.", + "format": "double", + "type": "number" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaSchema": { + "description": "Defines the structure and layout of a type of document data.", + "id": "GoogleCloudDiscoveryengineV1betaSchema", + "properties": { + "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" + }, + "structSchema": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "The structured representation of the schema.", + "type": "object" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaSearchRequest": { + "description": "Request message for SearchService.Search method.", + "id": "GoogleCloudDiscoveryengineV1betaSearchRequest", + "properties": { + "boostSpec": { + "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpec", + "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)" + }, + "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" + }, + "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" + }, + "contentSearchSpec": { + "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpec", + "description": "A specification for configuring the behavior of content search." + }, + "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.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec" + }, + "type": "array" + }, + "embeddingSpec": { + "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpec", + "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." + }, + "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.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestFacetSpec" + }, + "type": "array" + }, + "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" + }, + "imageQuery": { + "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestImageQuery", + "description": "Raw image query." + }, + "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" + }, + "naturalLanguageQueryUnderstandingSpec": { + "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestNaturalLanguageQueryUnderstandingSpec", + "description": "If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done." + }, + "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.", + "format": "int32", + "type": "integer" + }, + "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 for retail search, see [Ordering](https://cloud.google.com/retail/docs/filter-and-order#order) If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.", + "type": "string" + }, + "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.", + "format": "int32", + "type": "integer" + }, + "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" + }, + "params": { + "additionalProperties": { + "type": "any" + }, + "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" + }, + "query": { + "description": "Raw search query.", + "type": "string" + }, + "queryExpansionSpec": { + "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestQueryExpansionSpec", + "description": "The query expansion specification that specifies the conditions under which query expansion occurs." + }, + "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)`.", + "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" + }, + "safeSearch": { + "description": "Whether to turn on safe search. This is only supported for website search.", + "type": "boolean" + }, + "searchAsYouTypeSpec": { + "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestSearchAsYouTypeSpec", + "description": "Search as you type configuration. Only supported for the IndustryVertical.MEDIA vertical." + }, + "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" + }, + "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 /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": { + "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestSessionSpec", + "description": "Session specification. Can be used only when `session` is set." + }, + "spellCorrectionSpec": { + "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestSpellCorrectionSpec", + "description": "The spell correction specification that specifies the mode under which spell correction takes effect." + }, + "userInfo": { + "$ref": "GoogleCloudDiscoveryengineV1betaUserInfo", + "description": "Information about the end user. Highly recommended for analytics. UserInfo.user_agent is used to deduce `device_type` for analytics." + }, + "userLabels": { + "additionalProperties": { + "type": "string" + }, + "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" + }, + "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" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpec": { + "description": "Boost specification to boost certain documents.", + "id": "GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpec", + "properties": { + "conditionBoostSpecs": { + "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.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpec" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpec": { + "description": "Boost applies to documents which match a condition.", + "id": "GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpec", + "properties": { + "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.", + "format": "float", + "type": "number" + }, + "boostControlSpec": { + "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpecBoostControlSpec", + "description": "Complex specification for custom ranking based on customer defined attribute value." + }, + "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" + } + }, + "type": "object" + }, + "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.", + "id": "GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpecBoostControlSpec", + "properties": { + "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).", + "enum": [ + "ATTRIBUTE_TYPE_UNSPECIFIED", + "NUMERICAL", + "FRESHNESS" + ], + "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`." + ], + "type": "string" + }, + "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.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpecBoostControlSpecControlPoint" + }, + "type": "array" + }, + "fieldName": { + "description": "The name of the field whose value will be used to determine the boost amount.", + "type": "string" + }, + "interpolationType": { + "description": "The interpolation type to be applied to connect the control points listed below.", + "enum": [ + "INTERPOLATION_TYPE_UNSPECIFIED", + "LINEAR" + ], + "enumDescriptions": [ + "Interpolation type is unspecified. In this case, it defaults to Linear.", + "Piecewise linear interpolation will be applied." + ], + "type": "string" + } + }, + "type": "object" + }, + "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).", + "id": "GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpecBoostControlSpecControlPoint", + "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.", + "format": "float", + "type": "number" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpec": { + "description": "A specification for configuring the behavior of content search.", + "id": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpec", + "properties": { + "chunkSpec": { + "$ref": "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" + }, + "extractiveContentSpec": { + "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecExtractiveContentSpec", + "description": "If there is no extractive_content_spec provided, there will be no extractive answer in the search response." + }, + "searchResultMode": { + "description": "Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`.", + "enum": [ + "SEARCH_RESULT_MODE_UNSPECIFIED", + "DOCUMENTS", + "CHUNKS" + ], + "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." + ], + "type": "string" + }, + "snippetSpec": { + "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSnippetSpec", + "description": "If `snippetSpec` is not specified, snippets are not included in the search response." + }, + "summarySpec": { + "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpec", + "description": "If `summarySpec` is not specified, summaries are not included in the search response." + } + }, + "type": "object" + }, + "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", + "id": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecChunkSpec", + "properties": { + "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.", + "format": "int32", + "type": "integer" + }, + "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.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecExtractiveContentSpec": { + "description": "A specification for configuring the extractive content in a search response.", + "id": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecExtractiveContentSpec", + "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.", + "format": "int32", + "type": "integer" + }, + "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`.", + "format": "int32", + "type": "integer" + }, + "numNextSegments": { + "description": "Return at most `num_next_segments` segments after each selected segments.", + "format": "int32", + "type": "integer" + }, + "numPreviousSegments": { + "description": "Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments.", + "format": "int32", + "type": "integer" + }, + "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" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSnippetSpec": { + "description": "A specification for configuring snippets in a search response.", + "id": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSnippetSpec", + "properties": { + "maxSnippetCount": { + "deprecated": true, + "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.", + "format": "int32", + "type": "integer" + }, + "referenceOnly": { + "deprecated": true, + "description": "[DEPRECATED] This field is deprecated and will have no affect on the snippet.", + "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" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpec": { + "description": "A specification for configuring a summary returned in a search response.", + "id": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpec", + "properties": { + "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" + }, + "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" + }, + "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" + }, + "modelPromptSpec": { + "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelPromptSpec", + "description": "If specified, the spec will be used to modify the prompt provided to the LLM." + }, + "modelSpec": { + "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelSpec", + "description": "If specified, the spec will be used to modify the model specification provided to the LLM." + }, + "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.", + "format": "int32", + "type": "integer" + }, + "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" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelPromptSpec": { + "description": "Specification of the prompt to use with the model.", + "id": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelPromptSpec", + "properties": { + "preamble": { + "description": "Text at the beginning of the prompt that instructs the assistant. Examples are available in the user guide.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelSpec": { + "description": "Specification of the model.", + "id": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelSpec", + "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" + } + }, + "type": "object" + }, + "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.", + "id": "GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec", + "properties": { + "dataStore": { + "description": "Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpec": { + "description": "The specification that uses customized query embedding vector to do semantic document retrieval.", + "id": "GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpec", + "properties": { + "embeddingVectors": { + "description": "The embedding vector used for retrieval. Limit to 1.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpecEmbeddingVector" }, "type": "array" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1betaProject": { - "description": "Metadata and configurations for a Google Cloud project in the service.", - "id": "GoogleCloudDiscoveryengineV1betaProject", + "GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpecEmbeddingVector": { + "description": "Embedding vector.", + "id": "GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpecEmbeddingVector", "properties": { - "createTime": { - "description": "Output only. The timestamp when this project is created.", - "format": "google-datetime", - "readOnly": true, - "type": "string" - }, - "name": { - "description": "Output only. Full resource name of the project, for example `projects/{project_number}`. 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" - }, - "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.", - "format": "google-datetime", - "readOnly": true, + "fieldPath": { + "description": "Embedding field path in schema.", "type": "string" }, - "serviceTermsMap": { - "additionalProperties": { - "$ref": "GoogleCloudDiscoveryengineV1betaProjectServiceTerms" + "vector": { + "description": "Query embedding vector.", + "items": { + "format": "float", + "type": "number" }, - "description": "Output only. A map of terms of services. The key is the `id` of ServiceTerms.", - "readOnly": true, - "type": "object" + "type": "array" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1betaProjectServiceTerms": { - "description": "Metadata about the terms of service.", - "id": "GoogleCloudDiscoveryengineV1betaProjectServiceTerms", + "GoogleCloudDiscoveryengineV1betaSearchRequestFacetSpec": { + "description": "A facet specification to perform faceted search.", + "id": "GoogleCloudDiscoveryengineV1betaSearchRequestFacetSpec", "properties": { - "acceptTime": { - "description": "The last time when the project agreed to the terms of service.", - "format": "google-datetime", - "type": "string" - }, - "declineTime": { - "description": "The last time when the project declined or revoked the agreement to terms of service.", - "format": "google-datetime", - "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" }, - "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" + "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.", + "items": { + "type": "string" + }, + "type": "array" }, - "state": { - "description": "Whether the project has accepted/rejected the service terms or it is still pending.", - "enum": [ - "STATE_UNSPECIFIED", - "TERMS_ACCEPTED", - "TERMS_PENDING", - "TERMS_DECLINED" - ], - "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." - ], - "type": "string" + "facetKey": { + "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestFacetSpecFacetKey", + "description": "Required. The facet key specification." }, - "version": { - "description": "The version string of the terms of service. For acceptable values, see the comments for id above.", - "type": "string" + "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.", + "format": "int32", + "type": "integer" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1betaProvisionProjectMetadata": { - "description": "Metadata associated with a project provision operation.", - "id": "GoogleCloudDiscoveryengineV1betaProvisionProjectMetadata", - "properties": {}, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1betaPurgeDocumentsMetadata": { - "description": "Metadata related to the progress of the PurgeDocuments operation. This will be returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1betaPurgeDocumentsMetadata", + "GoogleCloudDiscoveryengineV1betaSearchRequestFacetSpecFacetKey": { + "description": "Specifies how a facet is computed.", + "id": "GoogleCloudDiscoveryengineV1betaSearchRequestFacetSpecFacetKey", "properties": { - "createTime": { - "description": "Operation create time.", - "format": "google-datetime", - "type": "string" + "caseInsensitive": { + "description": "True to make facet keys case insensitive when getting faceting values with prefixes or contains; false otherwise.", + "type": "boolean" }, - "failureCount": { - "description": "Count of entries that encountered errors while processing.", - "format": "int64", - "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.", + "items": { + "type": "string" + }, + "type": "array" }, - "ignoredCount": { - "description": "Count of entries that were ignored as entries were not found.", - "format": "int64", + "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.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1betaInterval" + }, + "type": "array" + }, + "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" }, - "successCount": { - "description": "Count of entries that were deleted successfully.", - "format": "int64", + "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" }, - "updateTime": { - "description": "Operation last update time. If the operation is done, this is also the finish time.", - "format": "google-datetime", + "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.", + "items": { + "type": "string" + }, + "type": "array" + }, + "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.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaSearchRequestImageQuery": { + "description": "Specifies the image query input.", + "id": "GoogleCloudDiscoveryengineV1betaSearchRequestImageQuery", + "properties": { + "imageBytes": { + "description": "Base64 encoded image bytes. Supported image formats: JPEG, PNG, and BMP.", "type": "string" } }, "type": "object" }, - "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.", - "id": "GoogleCloudDiscoveryengineV1betaPurgeDocumentsResponse", + "GoogleCloudDiscoveryengineV1betaSearchRequestNaturalLanguageQueryUnderstandingSpec": { + "description": "Specification to enable natural language understanding capabilities for search requests.", + "id": "GoogleCloudDiscoveryengineV1betaSearchRequestNaturalLanguageQueryUnderstandingSpec", "properties": { - "purgeCount": { - "description": "The total count of documents purged as a result of the operation.", - "format": "int64", + "filterExtractionCondition": { + "description": "The condition under which filter extraction should occur. Default to Condition.DISABLED.", + "enum": [ + "CONDITION_UNSPECIFIED", + "DISABLED", + "ENABLED" + ], + "enumDescriptions": [ + "Server behavior defaults to Condition.DISABLED.", + "Disables NL filter extraction.", + "Enables NL filter extraction." + ], "type": "string" }, - "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.", + "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.", "items": { "type": "string" }, @@ -14542,61 +16584,85 @@ }, "type": "object" }, - "GoogleCloudDiscoveryengineV1betaPurgeSuggestionDenyListEntriesMetadata": { - "description": "Metadata related to the progress of the PurgeSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1betaPurgeSuggestionDenyListEntriesMetadata", + "GoogleCloudDiscoveryengineV1betaSearchRequestQueryExpansionSpec": { + "description": "Specification to determine under which conditions query expansion should occur.", + "id": "GoogleCloudDiscoveryengineV1betaSearchRequestQueryExpansionSpec", "properties": { - "createTime": { - "description": "Operation create time.", - "format": "google-datetime", + "condition": { + "description": "The condition under which query expansion should occur. Default to Condition.DISABLED.", + "enum": [ + "CONDITION_UNSPECIFIED", + "DISABLED", + "AUTO" + ], + "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." + ], "type": "string" }, - "updateTime": { - "description": "Operation last update time. If the operation is done, this is also the finish time.", - "format": "google-datetime", - "type": "string" + "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" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1betaPurgeSuggestionDenyListEntriesResponse": { - "description": "Response message for CompletionService.PurgeSuggestionDenyListEntries method.", - "id": "GoogleCloudDiscoveryengineV1betaPurgeSuggestionDenyListEntriesResponse", + "GoogleCloudDiscoveryengineV1betaSearchRequestSearchAsYouTypeSpec": { + "description": "Specification for search as you type in search requests.", + "id": "GoogleCloudDiscoveryengineV1betaSearchRequestSearchAsYouTypeSpec", "properties": { - "errorSamples": { - "description": "A sample of errors encountered while processing the request.", - "items": { - "$ref": "GoogleRpcStatus" - }, - "type": "array" - }, - "purgeCount": { - "description": "Number of suggestion deny list entries purged.", - "format": "int64", + "condition": { + "description": "The condition under which search as you type should occur. Default to Condition.DISABLED.", + "enum": [ + "CONDITION_UNSPECIFIED", + "DISABLED", + "ENABLED" + ], + "enumDescriptions": [ + "Server behavior defaults to Condition.DISABLED.", + "Disables Search As You Type.", + "Enables Search As You Type." + ], "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1betaSchema": { - "description": "Defines the structure and layout of a type of document data.", - "id": "GoogleCloudDiscoveryengineV1betaSchema", + "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.", + "id": "GoogleCloudDiscoveryengineV1betaSearchRequestSessionSpec", "properties": { - "jsonSchema": { - "description": "The JSON representation of the schema.", + "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" }, - "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.", + "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.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaSearchRequestSpellCorrectionSpec": { + "description": "The specification for query spell correction.", + "id": "GoogleCloudDiscoveryengineV1betaSearchRequestSpellCorrectionSpec", + "properties": { + "mode": { + "description": "The mode under which spell correction replaces the original search query. Defaults to Mode.AUTO.", + "enum": [ + "MODE_UNSPECIFIED", + "SUGGESTION_ONLY", + "AUTO" + ], + "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." + ], "type": "string" - }, - "structSchema": { - "additionalProperties": { - "description": "Properties of the object.", - "type": "any" - }, - "description": "The structured representation of the schema.", - "type": "object" } }, "type": "object" @@ -14833,6 +16899,21 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1betaUserInfo": { + "description": "Information of an end user.", + "id": "GoogleCloudDiscoveryengineV1betaUserInfo", + "properties": { + "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" + }, + "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" + } + }, + "type": "object" + }, "GoogleLongrunningCancelOperationRequest": { "description": "The request message for Operations.CancelOperation.", "id": "GoogleLongrunningCancelOperationRequest", diff --git a/discovery/discoveryengine-v1alpha.json b/discovery/discoveryengine-v1alpha.json index ca7b3a84cb..8a3eac98c9 100644 --- a/discovery/discoveryengine-v1alpha.json +++ b/discovery/discoveryengine-v1alpha.json @@ -2428,6 +2428,31 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "getUriPatternDocumentData": { + "description": "Gets the URI Pattern to Document data mapping for an Advanced Site Search DataStore.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/siteSearchEngine:getUriPatternDocumentData", + "httpMethod": "GET", + "id": "discoveryengine.projects.locations.collections.dataStores.siteSearchEngine.getUriPatternDocumentData", + "parameterOrder": [ + "siteSearchEngine" + ], + "parameters": { + "siteSearchEngine": { + "description": "Required. Full resource name of the SiteSearchEngine, such as `projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/siteSearchEngine$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+siteSearchEngine}:getUriPatternDocumentData", + "response": { + "$ref": "GoogleCloudDiscoveryengineV1alphaGetUriPatternDocumentDataResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "recrawlUris": { "description": "Request on-demand recrawl for a list of URIs.", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/siteSearchEngine:recrawlUris", @@ -2455,6 +2480,34 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] + }, + "setUriPatternDocumentData": { + "description": "Sets the URI Pattern to Document data mapping for an Advanced Site Search DataStore.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/siteSearchEngine:setUriPatternDocumentData", + "httpMethod": "POST", + "id": "discoveryengine.projects.locations.collections.dataStores.siteSearchEngine.setUriPatternDocumentData", + "parameterOrder": [ + "siteSearchEngine" + ], + "parameters": { + "siteSearchEngine": { + "description": "Required. Full resource name of the SiteSearchEngine, such as `projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/siteSearchEngine$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+siteSearchEngine}:setUriPatternDocumentData", + "request": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSetUriPatternDocumentDataRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] } }, "resources": { @@ -6377,6 +6430,133 @@ } }, "evaluations": { + "methods": { + "create": { + "description": "Creates a Evaluation. Upon creation, the evaluation will be automatically triggered and begin execution.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/evaluations", + "httpMethod": "POST", + "id": "discoveryengine.projects.locations.evaluations.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The parent resource name, such as `projects/{project}/locations/{location}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+parent}/evaluations", + "request": { + "$ref": "GoogleCloudDiscoveryengineV1alphaEvaluation" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets a Evaluation.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/evaluations/{evaluationsId}", + "httpMethod": "GET", + "id": "discoveryengine.projects.locations.evaluations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Full resource name of Evaluation, such as `projects/{project}/locations/{location}/evaluations/{evaluation}`. If the caller does not have permission to access the Evaluation, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested Evaluation does not exist, a NOT_FOUND error is returned.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/evaluations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "response": { + "$ref": "GoogleCloudDiscoveryengineV1alphaEvaluation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Gets a list of Evaluations.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/evaluations", + "httpMethod": "GET", + "id": "discoveryengine.projects.locations.evaluations.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "Maximum number of Evaluations to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A page token ListEvaluationsResponse.next_page_token, received from a previous EvaluationService.ListEvaluations call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to EvaluationService.ListEvaluations must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent location resource name, such as `projects/{project}/locations/{location}`. If the caller does not have permission to list Evaluations under this location, regardless of whether or not this location exists, a `PERMISSION_DENIED` error is returned.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+parent}/evaluations", + "response": { + "$ref": "GoogleCloudDiscoveryengineV1alphaListEvaluationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "listResults": { + "description": "Gets a list of results for a given a Evaluation.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/evaluations/{evaluationsId}:listResults", + "httpMethod": "GET", + "id": "discoveryengine.projects.locations.evaluations.listResults", + "parameterOrder": [ + "evaluation" + ], + "parameters": { + "evaluation": { + "description": "Required. The evaluation resource name, such as `projects/{project}/locations/{location}/evaluations/{evaluation}`. If the caller does not have permission to list EvaluationResult under this evaluation, regardless of whether or not this evaluation set exists, a `PERMISSION_DENIED` error is returned.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/evaluations/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "Maximum number of EvaluationResult to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A page token ListEvaluationResultsResponse.next_page_token, received from a previous EvaluationService.ListEvaluationResults call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to EvaluationService.ListEvaluationResults must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned.", + "location": "query", + "type": "string" + } + }, + "path": "v1alpha/{+evaluation}:listResults", + "response": { + "$ref": "GoogleCloudDiscoveryengineV1alphaListEvaluationResultsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, "resources": { "operations": { "methods": { @@ -6441,6 +6621,80 @@ } } }, + "identity_mapping_stores": { + "resources": { + "operations": { + "methods": { + "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.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/identity_mapping_stores/{identity_mapping_storesId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "discoveryengine.projects.locations.identity_mapping_stores.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/identity_mapping_stores/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/identity_mapping_stores/{identity_mapping_storesId}/operations", + "httpMethod": "GET", + "id": "discoveryengine.projects.locations.identity_mapping_stores.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/identity_mapping_stores/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + } + }, + "path": "v1alpha/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, "operations": { "methods": { "get": { @@ -6576,535 +6830,1984 @@ } }, "sampleQuerySets": { - "resources": { - "operations": { - "methods": { - "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.", - "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/sampleQuerySets/{sampleQuerySetsId}/operations/{operationsId}", - "httpMethod": "GET", - "id": "discoveryengine.projects.locations.sampleQuerySets.operations.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/sampleQuerySets/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1alpha/{+name}", - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - } - } - } - }, - "userEvents": { "methods": { - "collect": { - "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.", - "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/userEvents:collect", - "httpMethod": "GET", - "id": "discoveryengine.projects.locations.userEvents.collect", + "create": { + "description": "Creates a SampleQuerySet", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/sampleQuerySets", + "httpMethod": "POST", + "id": "discoveryengine.projects.locations.sampleQuerySets.create", "parameterOrder": [ "parent" ], "parameters": { - "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.", - "format": "int64", - "location": "query", - "type": "string" - }, "parent": { - "description": "Required. The parent DataStore resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`.", + "description": "Required. The parent resource name, such as `projects/{project}/locations/{location}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "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 third-party requests.", + "sampleQuerySetId": { + "description": "Required. The ID to use for the SampleQuerySet, which will become the final component of the SampleQuerySet.name. If the caller does not have permission to create the SampleQuerySet, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. This field must be unique among all SampleQuerySets with the same parent. Otherwise, an `ALREADY_EXISTS` error is returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.", "location": "query", "type": "string" - }, - "userEvent": { - "description": "Required. URL encoded UserEvent proto with a length limit of 2,000,000 characters.", - "location": "query", + } + }, + "path": "v1alpha/{+parent}/sampleQuerySets", + "request": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSampleQuerySet" + }, + "response": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSampleQuerySet" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a SampleQuerySet.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/sampleQuerySets/{sampleQuerySetsId}", + "httpMethod": "DELETE", + "id": "discoveryengine.projects.locations.sampleQuerySets.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Full resource name of SampleQuerySet, such as `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`. If the caller does not have permission to delete the SampleQuerySet, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the SampleQuerySet to delete does not exist, a `NOT_FOUND` error is returned.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/sampleQuerySets/[^/]+$", + "required": true, "type": "string" } }, - "path": "v1alpha/{+parent}/userEvents:collect", + "path": "v1alpha/{+name}", "response": { - "$ref": "GoogleApiHttpBody" + "$ref": "GoogleProtobufEmpty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, - "write": { - "description": "Writes a single user event.", - "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/userEvents:write", - "httpMethod": "POST", - "id": "discoveryengine.projects.locations.userEvents.write", + "get": { + "description": "Gets a SampleQuerySet.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/sampleQuerySets/{sampleQuerySetsId}", + "httpMethod": "GET", + "id": "discoveryengine.projects.locations.sampleQuerySets.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Full resource name of SampleQuerySet, such as `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`. If the caller does not have permission to access the SampleQuerySet, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested SampleQuerySet does not exist, a NOT_FOUND error is returned.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/sampleQuerySets/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "response": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSampleQuerySet" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Gets a list of SampleQuerySets.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/sampleQuerySets", + "httpMethod": "GET", + "id": "discoveryengine.projects.locations.sampleQuerySets.list", "parameterOrder": [ "parent" ], "parameters": { + "pageSize": { + "description": "Maximum number of SampleQuerySets to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A page token ListSampleQuerySetsResponse.next_page_token, received from a previous SampleQuerySetService.ListSampleQuerySets call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SampleQuerySetService.ListSampleQuerySets must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned.", + "location": "query", + "type": "string" + }, "parent": { - "description": "Required. The parent resource name. If the write user event action is applied in DataStore level, the format is: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`. If the write user event action is applied in Location level, for example, the event with Document across multiple DataStore, the format is: `projects/{project}/locations/{location}`.", + "description": "Required. The parent location resource name, such as `projects/{project}/locations/{location}`. If the caller does not have permission to list SampleQuerySets under this location, regardless of whether or not this location exists, a `PERMISSION_DENIED` error is returned.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" + } + }, + "path": "v1alpha/{+parent}/sampleQuerySets", + "response": { + "$ref": "GoogleCloudDiscoveryengineV1alphaListSampleQuerySetsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates a SampleQuerySet.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/sampleQuerySets/{sampleQuerySetsId}", + "httpMethod": "PATCH", + "id": "discoveryengine.projects.locations.sampleQuerySets.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Immutable. The full resource name of the SampleQuerySet, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/sampleQuerySets/[^/]+$", + "required": true, + "type": "string" }, - "writeAsync": { - "description": "If set to true, the user event is written asynchronously after validation, and the API responds without waiting for the write.", + "updateMask": { + "description": "Indicates which fields in the provided imported 'sample query set' to update. If not set, will by default update all fields.", + "format": "google-fieldmask", "location": "query", - "type": "boolean" + "type": "string" } }, - "path": "v1alpha/{+parent}/userEvents:write", + "path": "v1alpha/{+name}", "request": { - "$ref": "GoogleCloudDiscoveryengineV1alphaUserEvent" + "$ref": "GoogleCloudDiscoveryengineV1alphaSampleQuerySet" }, "response": { - "$ref": "GoogleCloudDiscoveryengineV1alphaUserEvent" + "$ref": "GoogleCloudDiscoveryengineV1alphaSampleQuerySet" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] } - } - } - } - }, - "operations": { - "methods": { - "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.", - "flatPath": "v1alpha/projects/{projectsId}/operations/{operationsId}", - "httpMethod": "GET", - "id": "discoveryengine.projects.operations.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource.", - "location": "path", - "pattern": "^projects/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1alpha/{+name}", - "response": { - "$ref": "GoogleLongrunningOperation" }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "list": { - "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", - "flatPath": "v1alpha/projects/{projectsId}/operations", - "httpMethod": "GET", - "id": "discoveryengine.projects.operations.list", - "parameterOrder": [ - "name" - ], - "parameters": { - "filter": { - "description": "The standard list filter.", - "location": "query", - "type": "string" - }, - "name": { - "description": "The name of the operation's parent resource.", - "location": "path", - "pattern": "^projects/[^/]+$", - "required": true, - "type": "string" - }, - "pageSize": { - "description": "The standard list page size.", - "format": "int32", - "location": "query", - "type": "integer" + "resources": { + "operations": { + "methods": { + "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.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/sampleQuerySets/{sampleQuerySetsId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "discoveryengine.projects.locations.sampleQuerySets.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/sampleQuerySets/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } }, - "pageToken": { - "description": "The standard list page token.", - "location": "query", - "type": "string" - } - }, - "path": "v1alpha/{+name}/operations", - "response": { - "$ref": "GoogleLongrunningListOperationsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - } - } - } - } - }, - "revision": "20240621", - "rootUrl": "https://discoveryengine.googleapis.com/", - "schemas": { - "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.", - "id": "GoogleApiDistribution", - "properties": { - "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).", - "items": { - "format": "int64", - "type": "string" - }, - "type": "array" - }, - "bucketOptions": { - "$ref": "GoogleApiDistributionBucketOptions", - "description": "Defines the histogram bucket boundaries. If the distribution does not contain a histogram, then omit this field." - }, - "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.", - "format": "int64", - "type": "string" - }, - "exemplars": { - "description": "Must be in increasing order of `value` field.", - "items": { - "$ref": "GoogleApiDistributionExemplar" - }, - "type": "array" - }, - "mean": { - "description": "The arithmetic mean of the values in the population. If `count` is zero then this field must be zero.", - "format": "double", - "type": "number" - }, - "range": { - "$ref": "GoogleApiDistributionRange", - "description": "If specified, contains the range of the population values. The field must not be present if the `count` is zero." - }, - "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.", - "format": "double", - "type": "number" - } - }, - "type": "object" - }, - "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.", - "id": "GoogleApiDistributionBucketOptions", - "properties": { - "explicitBuckets": { - "$ref": "GoogleApiDistributionBucketOptionsExplicit", - "description": "The explicit buckets." - }, - "exponentialBuckets": { - "$ref": "GoogleApiDistributionBucketOptionsExponential", - "description": "The exponential buckets." - }, - "linearBuckets": { - "$ref": "GoogleApiDistributionBucketOptionsLinear", - "description": "The linear bucket." + "sampleQueries": { + "methods": { + "create": { + "description": "Creates a SampleQuery", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/sampleQuerySets/{sampleQuerySetsId}/sampleQueries", + "httpMethod": "POST", + "id": "discoveryengine.projects.locations.sampleQuerySets.sampleQueries.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The parent resource name, such as `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/sampleQuerySets/[^/]+$", + "required": true, + "type": "string" + }, + "sampleQueryId": { + "description": "Required. The ID to use for the SampleQuery, which will become the final component of the SampleQuery.name. If the caller does not have permission to create the SampleQuery, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. This field must be unique among all SampleQuerys with the same parent. Otherwise, an `ALREADY_EXISTS` error is returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.", + "location": "query", + "type": "string" + } + }, + "path": "v1alpha/{+parent}/sampleQueries", + "request": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSampleQuery" + }, + "response": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSampleQuery" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a SampleQuery.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/sampleQuerySets/{sampleQuerySetsId}/sampleQueries/{sampleQueriesId}", + "httpMethod": "DELETE", + "id": "discoveryengine.projects.locations.sampleQuerySets.sampleQueries.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Full resource name of SampleQuery, such as `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}/sampleQueries/{sampleQuery}`. If the caller does not have permission to delete the SampleQuery, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the SampleQuery to delete does not exist, a `NOT_FOUND` error is returned.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/sampleQuerySets/[^/]+/sampleQueries/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets a SampleQuery.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/sampleQuerySets/{sampleQuerySetsId}/sampleQueries/{sampleQueriesId}", + "httpMethod": "GET", + "id": "discoveryengine.projects.locations.sampleQuerySets.sampleQueries.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Full resource name of SampleQuery, such as `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}/sampleQueries/{sampleQuery}`. If the caller does not have permission to access the SampleQuery, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested SampleQuery does not exist, a NOT_FOUND error is returned.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/sampleQuerySets/[^/]+/sampleQueries/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "response": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSampleQuery" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "import": { + "description": "Bulk import of multiple SampleQuerys. Sample queries that already exist may be deleted. Note: It is possible for a subset of the SampleQuerys to be successfully imported.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/sampleQuerySets/{sampleQuerySetsId}/sampleQueries:import", + "httpMethod": "POST", + "id": "discoveryengine.projects.locations.sampleQuerySets.sampleQueries.import", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The parent sample query set resource name, such as `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`. If the caller does not have permission to list SampleQuerys under this sample query set, regardless of whether or not this sample query set exists, a `PERMISSION_DENIED` error is returned.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/sampleQuerySets/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+parent}/sampleQueries:import", + "request": { + "$ref": "GoogleCloudDiscoveryengineV1alphaImportSampleQueriesRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Gets a list of SampleQuerys.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/sampleQuerySets/{sampleQuerySetsId}/sampleQueries", + "httpMethod": "GET", + "id": "discoveryengine.projects.locations.sampleQuerySets.sampleQueries.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "Maximum number of SampleQuerys to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A page token ListSampleQueriesResponse.next_page_token, received from a previous SampleQueryService.ListSampleQueries call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SampleQueryService.ListSampleQueries must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent sample query set resource name, such as `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`. If the caller does not have permission to list SampleQuerys under this sample query set, regardless of whether or not this sample query set exists, a `PERMISSION_DENIED` error is returned.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/sampleQuerySets/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+parent}/sampleQueries", + "response": { + "$ref": "GoogleCloudDiscoveryengineV1alphaListSampleQueriesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates a SampleQuery.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/sampleQuerySets/{sampleQuerySetsId}/sampleQueries/{sampleQueriesId}", + "httpMethod": "PATCH", + "id": "discoveryengine.projects.locations.sampleQuerySets.sampleQueries.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Immutable. The full resource name of the sample query, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}/sampleQueries/{sampleQuery}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/sampleQuerySets/[^/]+/sampleQueries/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Indicates which fields in the provided imported 'simple query' to update. If not set, will by default update all fields.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "request": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSampleQuery" + }, + "response": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSampleQuery" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, + "userEvents": { + "methods": { + "collect": { + "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.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/userEvents:collect", + "httpMethod": "GET", + "id": "discoveryengine.projects.locations.userEvents.collect", + "parameterOrder": [ + "parent" + ], + "parameters": { + "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.", + "format": "int64", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent DataStore resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "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 third-party requests.", + "location": "query", + "type": "string" + }, + "userEvent": { + "description": "Required. URL encoded UserEvent proto with a length limit of 2,000,000 characters.", + "location": "query", + "type": "string" + } + }, + "path": "v1alpha/{+parent}/userEvents:collect", + "response": { + "$ref": "GoogleApiHttpBody" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "write": { + "description": "Writes a single user event.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/userEvents:write", + "httpMethod": "POST", + "id": "discoveryengine.projects.locations.userEvents.write", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The parent resource name. If the write user event action is applied in DataStore level, the format is: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`. If the write user event action is applied in Location level, for example, the event with Document across multiple DataStore, the format is: `projects/{project}/locations/{location}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + }, + "writeAsync": { + "description": "If set to true, the user event is written asynchronously after validation, and the API responds without waiting for the write.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1alpha/{+parent}/userEvents:write", + "request": { + "$ref": "GoogleCloudDiscoveryengineV1alphaUserEvent" + }, + "response": { + "$ref": "GoogleCloudDiscoveryengineV1alphaUserEvent" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, + "operations": { + "methods": { + "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.", + "flatPath": "v1alpha/projects/{projectsId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "discoveryengine.projects.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^projects/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1alpha/projects/{projectsId}/operations", + "httpMethod": "GET", + "id": "discoveryengine.projects.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^projects/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + } + }, + "path": "v1alpha/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + } + }, + "revision": "20240715", + "rootUrl": "https://discoveryengine.googleapis.com/", + "schemas": { + "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.", + "id": "GoogleApiDistribution", + "properties": { + "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).", + "items": { + "format": "int64", + "type": "string" + }, + "type": "array" + }, + "bucketOptions": { + "$ref": "GoogleApiDistributionBucketOptions", + "description": "Defines the histogram bucket boundaries. If the distribution does not contain a histogram, then omit this field." + }, + "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.", + "format": "int64", + "type": "string" + }, + "exemplars": { + "description": "Must be in increasing order of `value` field.", + "items": { + "$ref": "GoogleApiDistributionExemplar" + }, + "type": "array" + }, + "mean": { + "description": "The arithmetic mean of the values in the population. If `count` is zero then this field must be zero.", + "format": "double", + "type": "number" + }, + "range": { + "$ref": "GoogleApiDistributionRange", + "description": "If specified, contains the range of the population values. The field must not be present if the `count` is zero." + }, + "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.", + "format": "double", + "type": "number" + } + }, + "type": "object" + }, + "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.", + "id": "GoogleApiDistributionBucketOptions", + "properties": { + "explicitBuckets": { + "$ref": "GoogleApiDistributionBucketOptionsExplicit", + "description": "The explicit buckets." + }, + "exponentialBuckets": { + "$ref": "GoogleApiDistributionBucketOptionsExponential", + "description": "The exponential buckets." + }, + "linearBuckets": { + "$ref": "GoogleApiDistributionBucketOptionsLinear", + "description": "The linear bucket." + } + }, + "type": "object" + }, + "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.", + "id": "GoogleApiDistributionBucketOptionsExplicit", + "properties": { + "bounds": { + "description": "The values must be monotonically increasing.", + "items": { + "format": "double", + "type": "number" + }, + "type": "array" + } + }, + "type": "object" + }, + "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)).", + "id": "GoogleApiDistributionBucketOptionsExponential", + "properties": { + "growthFactor": { + "description": "Must be greater than 1.", + "format": "double", + "type": "number" + }, + "numFiniteBuckets": { + "description": "Must be greater than 0.", + "format": "int32", + "type": "integer" + }, + "scale": { + "description": "Must be greater than 0.", + "format": "double", + "type": "number" + } + }, + "type": "object" + }, + "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)).", + "id": "GoogleApiDistributionBucketOptionsLinear", + "properties": { + "numFiniteBuckets": { + "description": "Must be greater than 0.", + "format": "int32", + "type": "integer" + }, + "offset": { + "description": "Lower bound of the first bucket.", + "format": "double", + "type": "number" + }, + "width": { + "description": "Must be greater than 0.", + "format": "double", + "type": "number" + } + }, + "type": "object" + }, + "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.", + "id": "GoogleApiDistributionExemplar", + "properties": { + "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.", + "items": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "type": "object" + }, + "type": "array" + }, + "timestamp": { + "description": "The observation (sampling) time of the above value.", + "format": "google-datetime", + "type": "string" + }, + "value": { + "description": "Value of the exemplar point. This value determines to which bucket the exemplar belongs.", + "format": "double", + "type": "number" + } + }, + "type": "object" + }, + "GoogleApiDistributionRange": { + "description": "The range of the population values.", + "id": "GoogleApiDistributionRange", + "properties": { + "max": { + "description": "The maximum of the population values.", + "format": "double", + "type": "number" + }, + "min": { + "description": "The minimum of the population values.", + "format": "double", + "type": "number" + } + }, + "type": "object" + }, + "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.", + "id": "GoogleApiHttpBody", + "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" + }, + "extensions": { + "description": "Application specific response metadata. Must be set in the first response for streaming APIs.", + "items": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "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\" }}", + "id": "GoogleApiMonitoredResource", + "properties": { + "labels": { + "additionalProperties": { + "type": "string" + }, + "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" + }, + "type": { + "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`.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineLoggingErrorContext": { + "description": "A description of the context in which an error occurred.", + "id": "GoogleCloudDiscoveryengineLoggingErrorContext", + "properties": { + "httpRequest": { + "$ref": "GoogleCloudDiscoveryengineLoggingHttpRequestContext", + "description": "The HTTP request which was processed when the error was triggered." + }, + "reportLocation": { + "$ref": "GoogleCloudDiscoveryengineLoggingSourceLocation", + "description": "The location in the source code where the decision was made to report the error, usually the place where it was logged." + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineLoggingErrorLog": { + "description": "An error log which is reported to the Error Reporting system.", + "id": "GoogleCloudDiscoveryengineLoggingErrorLog", + "properties": { + "context": { + "$ref": "GoogleCloudDiscoveryengineLoggingErrorContext", + "description": "A description of the context in which the error occurred." + }, + "importPayload": { + "$ref": "GoogleCloudDiscoveryengineLoggingImportErrorContext", + "description": "The error payload that is populated on LRO import APIs." + }, + "message": { + "description": "A message describing the error.", + "type": "string" + }, + "requestPayload": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "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" + }, + "responsePayload": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "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" + }, + "serviceContext": { + "$ref": "GoogleCloudDiscoveryengineLoggingServiceContext", + "description": "The service context in which this error has occurred." + }, + "status": { + "$ref": "GoogleRpcStatus", + "description": "The RPC status associated with the error log." + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineLoggingHttpRequestContext": { + "description": "HTTP request data that is related to a reported error.", + "id": "GoogleCloudDiscoveryengineLoggingHttpRequestContext", + "properties": { + "responseStatusCode": { + "description": "The HTTP response status code for the request.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "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`", + "id": "GoogleCloudDiscoveryengineLoggingImportErrorContext", + "properties": { + "document": { + "description": "The detailed content which caused the error on importing a document.", + "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" + }, + "operation": { + "description": "The operation resource name of the LRO.", + "type": "string" + }, + "userEvent": { + "description": "The detailed content which caused the error on importing a user event.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineLoggingServiceContext": { + "description": "Describes a running service that sends errors.", + "id": "GoogleCloudDiscoveryengineLoggingServiceContext", + "properties": { + "service": { + "description": "An identifier of the service—for example, `discoveryengine.googleapis.com`.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineLoggingSourceLocation": { + "description": "Indicates a location in the source code of the service for which errors are reported.", + "id": "GoogleCloudDiscoveryengineLoggingSourceLocation", + "properties": { + "functionName": { + "description": "Human-readable name of a function or method—for example, `google.cloud.discoveryengine.v1alpha.RecommendationService.Recommend`.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1BatchCreateTargetSiteMetadata": { + "description": "Metadata related to the progress of the SiteSearchEngineService.BatchCreateTargetSites operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1BatchCreateTargetSiteMetadata", + "properties": { + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", + "type": "string" + }, + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1BatchCreateTargetSitesResponse": { + "description": "Response message for SiteSearchEngineService.BatchCreateTargetSites method.", + "id": "GoogleCloudDiscoveryengineV1BatchCreateTargetSitesResponse", + "properties": { + "targetSites": { + "description": "TargetSites created.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1TargetSite" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1Condition": { + "description": "Defines circumstances to be checked before allowing a behavior", + "id": "GoogleCloudDiscoveryengineV1Condition", + "properties": { + "activeTimeRange": { + "description": "Range of time(s) specifying when condition is active. Maximum of 10 time ranges.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1ConditionTimeRange" + }, + "type": "array" + }, + "queryTerms": { + "description": "Search only A list of terms to match the query on. Maximum of 10 query terms.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1ConditionQueryTerm" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1ConditionQueryTerm": { + "description": "Matcher for search request query", + "id": "GoogleCloudDiscoveryengineV1ConditionQueryTerm", + "properties": { + "fullMatch": { + "description": "Whether the search query needs to exactly match the query term.", + "type": "boolean" + }, + "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" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1ConditionTimeRange": { + "description": "Used for time-dependent conditions.", + "id": "GoogleCloudDiscoveryengineV1ConditionTimeRange", + "properties": { + "endTime": { + "description": "End of time range. Range is inclusive. Must be in the future.", + "format": "google-datetime", + "type": "string" + }, + "startTime": { + "description": "Start of time range. Range is inclusive.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "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`.", + "id": "GoogleCloudDiscoveryengineV1Control", + "properties": { + "associatedServingConfigIds": { + "description": "Output only. List of all ServingConfig ids this control is attached to. May take up to 10 minutes to update after changes.", + "items": { + "type": "string" + }, + "readOnly": true, + "type": "array" + }, + "boostAction": { + "$ref": "GoogleCloudDiscoveryengineV1ControlBoostAction", + "description": "Defines a boost-type control" + }, + "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.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1Condition" + }, + "type": "array" + }, + "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" + }, + "filterAction": { + "$ref": "GoogleCloudDiscoveryengineV1ControlFilterAction", + "description": "Defines a filter-type control Currently not supported by Recommendation" + }, + "name": { + "description": "Immutable. Fully qualified name `projects/*/locations/global/dataStore/*/controls/*`", + "type": "string" + }, + "redirectAction": { + "$ref": "GoogleCloudDiscoveryengineV1ControlRedirectAction", + "description": "Defines a redirect-type control." + }, + "solutionType": { + "description": "Required. Immutable. What solution the control belongs to. Must be compatible with vertical of resource. Otherwise an INVALID ARGUMENT error is thrown.", + "enum": [ + "SOLUTION_TYPE_UNSPECIFIED", + "SOLUTION_TYPE_RECOMMENDATION", + "SOLUTION_TYPE_SEARCH", + "SOLUTION_TYPE_CHAT", + "SOLUTION_TYPE_GENERATIVE_CHAT" + ], + "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." + ], + "type": "string" + }, + "synonymsAction": { + "$ref": "GoogleCloudDiscoveryengineV1ControlSynonymsAction", + "description": "Treats a group of terms as synonyms of one another." + }, + "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.", + "items": { + "enum": [ + "SEARCH_USE_CASE_UNSPECIFIED", + "SEARCH_USE_CASE_SEARCH", + "SEARCH_USE_CASE_BROWSE" + ], + "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." + ], + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1ControlBoostAction": { + "description": "Adjusts order of products in returned list.", + "id": "GoogleCloudDiscoveryengineV1ControlBoostAction", + "properties": { + "boost": { + "description": "Required. Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0 (No-op).", + "format": "float", + "type": "number" + }, + "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" + }, + "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" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1ControlFilterAction": { + "description": "Specified which products may be included in results. Uses same filter as boost.", + "id": "GoogleCloudDiscoveryengineV1ControlFilterAction", + "properties": { + "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" + }, + "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" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1ControlRedirectAction": { + "description": "Redirects a shopper to the provided URI.", + "id": "GoogleCloudDiscoveryengineV1ControlRedirectAction", + "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" + } + }, + "type": "object" + }, + "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\".", + "id": "GoogleCloudDiscoveryengineV1ControlSynonymsAction", + "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.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1CreateDataStoreMetadata": { + "description": "Metadata related to the progress of the DataStoreService.CreateDataStore operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1CreateDataStoreMetadata", + "properties": { + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", + "type": "string" + }, + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1CreateEngineMetadata": { + "description": "Metadata related to the progress of the EngineService.CreateEngine operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1CreateEngineMetadata", + "properties": { + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", + "type": "string" + }, + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1CreateSchemaMetadata": { + "description": "Metadata for Create Schema LRO.", + "id": "GoogleCloudDiscoveryengineV1CreateSchemaMetadata", + "properties": { + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", + "type": "string" + }, + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1CreateTargetSiteMetadata": { + "description": "Metadata related to the progress of the SiteSearchEngineService.CreateTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1CreateTargetSiteMetadata", + "properties": { + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", + "type": "string" + }, + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1DataStore": { + "description": "DataStore captures global settings and configs at the DataStore level.", + "id": "GoogleCloudDiscoveryengineV1DataStore", + "properties": { + "contentConfig": { + "description": "Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT.", + "enum": [ + "CONTENT_CONFIG_UNSPECIFIED", + "NO_CONTENT", + "CONTENT_REQUIRED", + "PUBLIC_WEBSITE" + ], + "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." + ], + "type": "string" + }, + "createTime": { + "description": "Output only. Timestamp the DataStore was created at.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "defaultSchemaId": { + "description": "Output only. The id of the default Schema asscociated to this data store.", + "readOnly": true, + "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" + }, + "documentProcessingConfig": { + "$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfig", + "description": "Configuration for Document understanding and enrichment." + }, + "industryVertical": { + "description": "Immutable. The industry vertical that the data store registers.", + "enum": [ + "INDUSTRY_VERTICAL_UNSPECIFIED", + "GENERIC", + "MEDIA", + "HEALTHCARE_FHIR" + ], + "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." + ], + "type": "string" + }, + "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" + }, + "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.", + "items": { + "enum": [ + "SOLUTION_TYPE_UNSPECIFIED", + "SOLUTION_TYPE_RECOMMENDATION", + "SOLUTION_TYPE_SEARCH", + "SOLUTION_TYPE_CHAT", + "SOLUTION_TYPE_GENERATIVE_CHAT" + ], + "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." + ], + "type": "string" + }, + "type": "array" + }, + "startingSchema": { + "$ref": "GoogleCloudDiscoveryengineV1Schema", + "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)." + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1DeleteDataStoreMetadata": { + "description": "Metadata related to the progress of the DataStoreService.DeleteDataStore operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1DeleteDataStoreMetadata", + "properties": { + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", + "type": "string" + }, + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1DeleteEngineMetadata": { + "description": "Metadata related to the progress of the EngineService.DeleteEngine operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1DeleteEngineMetadata", + "properties": { + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", + "type": "string" + }, + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1DeleteSchemaMetadata": { + "description": "Metadata for DeleteSchema LRO.", + "id": "GoogleCloudDiscoveryengineV1DeleteSchemaMetadata", + "properties": { + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", + "type": "string" + }, + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1DeleteTargetSiteMetadata": { + "description": "Metadata related to the progress of the SiteSearchEngineService.DeleteTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1DeleteTargetSiteMetadata", + "properties": { + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", + "type": "string" + }, + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1DisableAdvancedSiteSearchMetadata": { + "description": "Metadata related to the progress of the SiteSearchEngineService.DisableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1DisableAdvancedSiteSearchMetadata", + "properties": { + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", + "type": "string" + }, + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1DisableAdvancedSiteSearchResponse": { + "description": "Response message for SiteSearchEngineService.DisableAdvancedSiteSearch method.", + "id": "GoogleCloudDiscoveryengineV1DisableAdvancedSiteSearchResponse", + "properties": {}, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1DocumentProcessingConfig": { + "description": "A singleton resource of DataStore. It's empty when DataStore is created, which defaults to digital parser. The first call to DataStoreService.UpdateDocumentProcessingConfig method will initialize the config.", + "id": "GoogleCloudDiscoveryengineV1DocumentProcessingConfig", + "properties": { + "chunkingConfig": { + "$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfig", + "description": "Whether chunking mode is enabled." + }, + "defaultParsingConfig": { + "$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig", + "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." + }, + "name": { + "description": "The full resource name of the Document Processing Config. Format: `projects/*/locations/*/collections/*/dataStores/*/documentProcessingConfig`.", + "type": "string" + }, + "parsingConfigOverrides": { + "additionalProperties": { + "$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig" + }, + "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.", + "type": "object" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfig": { + "description": "Configuration for chunking config.", + "id": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfig", + "properties": { + "layoutBasedChunkingConfig": { + "$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig", + "description": "Configuration for the layout based chunking." + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig": { + "description": "Configuration for the layout based chunking.", + "id": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig", + "properties": { + "chunkSize": { + "description": "The token size limit for each chunk. Supported values: 100-500 (inclusive). Default value: 500.", + "format": "int32", + "type": "integer" + }, + "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" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig": { + "description": "Related configurations applied to a specific type of document parser.", + "id": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig", + "properties": { + "digitalParsingConfig": { + "$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigDigitalParsingConfig", + "description": "Configurations applied to digital parser." + }, + "layoutParsingConfig": { + "$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigLayoutParsingConfig", + "description": "Configurations applied to layout parser." + }, + "ocrParsingConfig": { + "$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigOcrParsingConfig", + "description": "Configurations applied to OCR parser. Currently it only applies to PDFs." + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigDigitalParsingConfig": { + "description": "The digital parsing configurations for documents.", + "id": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigDigitalParsingConfig", + "properties": {}, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigLayoutParsingConfig": { + "description": "The layout parsing configurations for documents.", + "id": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigLayoutParsingConfig", + "properties": {}, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigOcrParsingConfig": { + "description": "The OCR parsing configurations for documents.", + "id": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigOcrParsingConfig", + "properties": { + "enhancedDocumentElements": { + "deprecated": true, + "description": "[DEPRECATED] This field is deprecated. To use the additional enhanced document elements processing, please switch to `layout_parsing_config`.", + "items": { + "type": "string" + }, + "type": "array" + }, + "useNativeText": { + "description": "If true, will use native text instead of OCR text on pages containing native text.", + "type": "boolean" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1EnableAdvancedSiteSearchMetadata": { + "description": "Metadata related to the progress of the SiteSearchEngineService.EnableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1EnableAdvancedSiteSearchMetadata", + "properties": { + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", + "type": "string" + }, + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1EnableAdvancedSiteSearchResponse": { + "description": "Response message for SiteSearchEngineService.EnableAdvancedSiteSearch method.", + "id": "GoogleCloudDiscoveryengineV1EnableAdvancedSiteSearchResponse", + "properties": {}, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1Engine": { + "description": "Metadata that describes the training and serving parameters of an Engine.", + "id": "GoogleCloudDiscoveryengineV1Engine", + "properties": { + "chatEngineConfig": { + "$ref": "GoogleCloudDiscoveryengineV1EngineChatEngineConfig", + "description": "Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT." + }, + "chatEngineMetadata": { + "$ref": "GoogleCloudDiscoveryengineV1EngineChatEngineMetadata", + "description": "Output only. Additional information of the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.", + "readOnly": true + }, + "commonConfig": { + "$ref": "GoogleCloudDiscoveryengineV1EngineCommonConfig", + "description": "Common config spec that specifies the metadata of the engine." + }, + "createTime": { + "description": "Output only. Timestamp the Recommendation Engine was created at.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "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.", + "items": { + "type": "string" + }, + "type": "array" + }, + "displayName": { + "description": "Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters.", + "type": "string" + }, + "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.", + "enum": [ + "INDUSTRY_VERTICAL_UNSPECIFIED", + "GENERIC", + "MEDIA", + "HEALTHCARE_FHIR" + ], + "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." + ], + "type": "string" + }, + "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_number}/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" + }, + "searchEngineConfig": { + "$ref": "GoogleCloudDiscoveryengineV1EngineSearchEngineConfig", + "description": "Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH." + }, + "solutionType": { + "description": "Required. The solutions of the engine.", + "enum": [ + "SOLUTION_TYPE_UNSPECIFIED", + "SOLUTION_TYPE_RECOMMENDATION", + "SOLUTION_TYPE_SEARCH", + "SOLUTION_TYPE_CHAT", + "SOLUTION_TYPE_GENERATIVE_CHAT" + ], + "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." + ], + "type": "string" + }, + "updateTime": { + "description": "Output only. Timestamp the Recommendation Engine was last updated.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1EngineChatEngineConfig": { + "description": "Configurations for a Chat Engine.", + "id": "GoogleCloudDiscoveryengineV1EngineChatEngineConfig", + "properties": { + "agentCreationConfig": { + "$ref": "GoogleCloudDiscoveryengineV1EngineChatEngineConfigAgentCreationConfig", + "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." + }, + "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" + } + }, + "type": "object" + }, + "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.", + "id": "GoogleCloudDiscoveryengineV1EngineChatEngineConfigAgentCreationConfig", + "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" + }, + "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" + }, + "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" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1EngineChatEngineMetadata": { + "description": "Additional information of a Chat Engine. Fields in this message are output only.", + "id": "GoogleCloudDiscoveryengineV1EngineChatEngineMetadata", + "properties": { + "dialogflowAgent": { + "description": "The resource name of a Dialogflow agent, that this Chat Engine refers to. Format: `projects//locations//agents/`.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1EngineCommonConfig": { + "description": "Common configurations for an Engine.", + "id": "GoogleCloudDiscoveryengineV1EngineCommonConfig", + "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" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1EngineSearchEngineConfig": { + "description": "Configurations for a Search Engine.", + "id": "GoogleCloudDiscoveryengineV1EngineSearchEngineConfig", + "properties": { + "searchAddOns": { + "description": "The add-on that this search engine enables.", + "items": { + "enum": [ + "SEARCH_ADD_ON_UNSPECIFIED", + "SEARCH_ADD_ON_LLM" + ], + "enumDescriptions": [ + "Default value when the enum is unspecified. This is invalid to use.", + "Large language model add-on." + ], + "type": "string" + }, + "type": "array" + }, + "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.", + "enum": [ + "SEARCH_TIER_UNSPECIFIED", + "SEARCH_TIER_STANDARD", + "SEARCH_TIER_ENTERPRISE" + ], + "enumDescriptions": [ + "Default value when the enum is unspecified. This is invalid to use.", + "Standard tier.", + "Enterprise tier." + ], + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1ImportCompletionSuggestionsMetadata": { + "description": "Metadata related to the progress of the ImportCompletionSuggestions operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1ImportCompletionSuggestionsMetadata", + "properties": { + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", + "type": "string" + }, + "failureCount": { + "description": "Count of CompletionSuggestions that failed to be imported.", + "format": "int64", + "type": "string" + }, + "successCount": { + "description": "Count of CompletionSuggestions successfully imported.", + "format": "int64", + "type": "string" + }, + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "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.", + "id": "GoogleCloudDiscoveryengineV1ImportCompletionSuggestionsResponse", + "properties": { + "errorConfig": { + "$ref": "GoogleCloudDiscoveryengineV1ImportErrorConfig", + "description": "The desired location of errors incurred during the Import." + }, + "errorSamples": { + "description": "A sample of errors encountered while processing the request.", + "items": { + "$ref": "GoogleRpcStatus" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1ImportDocumentsMetadata": { + "description": "Metadata related to the progress of the ImportDocuments operation. This is returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1ImportDocumentsMetadata", + "properties": { + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", + "type": "string" + }, + "failureCount": { + "description": "Count of entries that encountered errors while processing.", + "format": "int64", + "type": "string" + }, + "successCount": { + "description": "Count of entries that were processed successfully.", + "format": "int64", + "type": "string" + }, + "totalCount": { + "description": "Total count of entries that were processed.", + "format": "int64", + "type": "string" + }, + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", + "type": "string" } }, "type": "object" }, - "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.", - "id": "GoogleApiDistributionBucketOptionsExplicit", + "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.", + "id": "GoogleCloudDiscoveryengineV1ImportDocumentsResponse", "properties": { - "bounds": { - "description": "The values must be monotonically increasing.", + "errorConfig": { + "$ref": "GoogleCloudDiscoveryengineV1ImportErrorConfig", + "description": "Echoes the destination for the complete errors in the request if set." + }, + "errorSamples": { + "description": "A sample of errors encountered while processing the request.", "items": { - "format": "double", - "type": "number" + "$ref": "GoogleRpcStatus" }, "type": "array" } }, "type": "object" }, - "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)).", - "id": "GoogleApiDistributionBucketOptionsExponential", + "GoogleCloudDiscoveryengineV1ImportErrorConfig": { + "description": "Configuration of destination for Import related errors.", + "id": "GoogleCloudDiscoveryengineV1ImportErrorConfig", "properties": { - "growthFactor": { - "description": "Must be greater than 1.", - "format": "double", - "type": "number" - }, - "numFiniteBuckets": { - "description": "Must be greater than 0.", - "format": "int32", - "type": "integer" - }, - "scale": { - "description": "Must be greater than 0.", - "format": "double", - "type": "number" + "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" } }, "type": "object" }, - "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)).", - "id": "GoogleApiDistributionBucketOptionsLinear", + "GoogleCloudDiscoveryengineV1ImportSuggestionDenyListEntriesMetadata": { + "description": "Metadata related to the progress of the ImportSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1ImportSuggestionDenyListEntriesMetadata", "properties": { - "numFiniteBuckets": { - "description": "Must be greater than 0.", - "format": "int32", - "type": "integer" - }, - "offset": { - "description": "Lower bound of the first bucket.", - "format": "double", - "type": "number" + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", + "type": "string" }, - "width": { - "description": "Must be greater than 0.", - "format": "double", - "type": "number" + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", + "type": "string" } }, "type": "object" }, - "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.", - "id": "GoogleApiDistributionExemplar", + "GoogleCloudDiscoveryengineV1ImportSuggestionDenyListEntriesResponse": { + "description": "Response message for CompletionService.ImportSuggestionDenyListEntries method.", + "id": "GoogleCloudDiscoveryengineV1ImportSuggestionDenyListEntriesResponse", "properties": { - "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.", + "errorSamples": { + "description": "A sample of errors encountered while processing the request.", "items": { - "additionalProperties": { - "description": "Properties of the object. Contains field @type with type URL.", - "type": "any" - }, - "type": "object" + "$ref": "GoogleRpcStatus" }, "type": "array" }, - "timestamp": { - "description": "The observation (sampling) time of the above value.", - "format": "google-datetime", + "failedEntriesCount": { + "description": "Count of deny list entries that failed to be imported.", + "format": "int64", "type": "string" }, - "value": { - "description": "Value of the exemplar point. This value determines to which bucket the exemplar belongs.", - "format": "double", - "type": "number" + "importedEntriesCount": { + "description": "Count of deny list entries successfully imported.", + "format": "int64", + "type": "string" } }, "type": "object" }, - "GoogleApiDistributionRange": { - "description": "The range of the population values.", - "id": "GoogleApiDistributionRange", + "GoogleCloudDiscoveryengineV1ImportUserEventsMetadata": { + "description": "Metadata related to the progress of the Import operation. This is returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1ImportUserEventsMetadata", "properties": { - "max": { - "description": "The maximum of the population values.", - "format": "double", - "type": "number" + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", + "type": "string" }, - "min": { - "description": "The minimum of the population values.", - "format": "double", - "type": "number" - } - }, - "type": "object" - }, - "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.", - "id": "GoogleApiHttpBody", - "properties": { - "contentType": { - "description": "The HTTP Content-Type header value specifying the content type of the body.", + "failureCount": { + "description": "Count of entries that encountered errors while processing.", + "format": "int64", "type": "string" }, - "data": { - "description": "The HTTP request/response body as raw binary.", - "format": "byte", + "successCount": { + "description": "Count of entries that were processed successfully.", + "format": "int64", "type": "string" }, - "extensions": { - "description": "Application specific response metadata. Must be set in the first response for streaming APIs.", - "items": { - "additionalProperties": { - "description": "Properties of the object. Contains field @type with type URL.", - "type": "any" - }, - "type": "object" - }, - "type": "array" + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", + "type": "string" } }, "type": "object" }, - "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\" }}", - "id": "GoogleApiMonitoredResource", + "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.", + "id": "GoogleCloudDiscoveryengineV1ImportUserEventsResponse", "properties": { - "labels": { - "additionalProperties": { - "type": "string" + "errorConfig": { + "$ref": "GoogleCloudDiscoveryengineV1ImportErrorConfig", + "description": "Echoes the destination for the complete errors if this field was set in the request." + }, + "errorSamples": { + "description": "A sample of errors encountered while processing the request.", + "items": { + "$ref": "GoogleRpcStatus" }, - "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" + "type": "array" }, - "type": { - "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`.", + "joinedEventsCount": { + "description": "Count of user events imported with complete existing Documents.", + "format": "int64", "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineLoggingErrorContext": { - "description": "A description of the context in which an error occurred.", - "id": "GoogleCloudDiscoveryengineLoggingErrorContext", - "properties": { - "httpRequest": { - "$ref": "GoogleCloudDiscoveryengineLoggingHttpRequestContext", - "description": "The HTTP request which was processed when the error was triggered." }, - "reportLocation": { - "$ref": "GoogleCloudDiscoveryengineLoggingSourceLocation", - "description": "The location in the source code where the decision was made to report the error, usually the place where it was logged." + "unjoinedEventsCount": { + "description": "Count of user events imported, but with Document information not found in the existing Branch.", + "format": "int64", + "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineLoggingErrorLog": { - "description": "An error log which is reported to the Error Reporting system.", - "id": "GoogleCloudDiscoveryengineLoggingErrorLog", + "GoogleCloudDiscoveryengineV1Project": { + "description": "Metadata and configurations for a Google Cloud project in the service.", + "id": "GoogleCloudDiscoveryengineV1Project", "properties": { - "context": { - "$ref": "GoogleCloudDiscoveryengineLoggingErrorContext", - "description": "A description of the context in which the error occurred." - }, - "importPayload": { - "$ref": "GoogleCloudDiscoveryengineLoggingImportErrorContext", - "description": "The error payload that is populated on LRO import APIs." + "createTime": { + "description": "Output only. The timestamp when this project is created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" }, - "message": { - "description": "A message describing the error.", + "name": { + "description": "Output only. Full resource name of the project, for example `projects/{project_number}`. 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" }, - "requestPayload": { - "additionalProperties": { - "description": "Properties of the object.", - "type": "any" - }, - "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" + "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.", + "format": "google-datetime", + "readOnly": true, + "type": "string" }, - "responsePayload": { + "serviceTermsMap": { "additionalProperties": { - "description": "Properties of the object.", - "type": "any" - }, - "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" - }, - "serviceContext": { - "$ref": "GoogleCloudDiscoveryengineLoggingServiceContext", - "description": "The service context in which this error has occurred." - }, - "status": { - "$ref": "GoogleRpcStatus", - "description": "The RPC status associated with the error log." - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineLoggingHttpRequestContext": { - "description": "HTTP request data that is related to a reported error.", - "id": "GoogleCloudDiscoveryengineLoggingHttpRequestContext", - "properties": { - "responseStatusCode": { - "description": "The HTTP response status code for the request.", - "format": "int32", - "type": "integer" + "$ref": "GoogleCloudDiscoveryengineV1ProjectServiceTerms" + }, + "description": "Output only. A map of terms of services. The key is the `id` of ServiceTerms.", + "readOnly": true, + "type": "object" } }, "type": "object" }, - "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`", - "id": "GoogleCloudDiscoveryengineLoggingImportErrorContext", + "GoogleCloudDiscoveryengineV1ProjectServiceTerms": { + "description": "Metadata about the terms of service.", + "id": "GoogleCloudDiscoveryengineV1ProjectServiceTerms", "properties": { - "document": { - "description": "The detailed content which caused the error on importing a document.", + "acceptTime": { + "description": "The last time when the project agreed to the terms of service.", + "format": "google-datetime", "type": "string" }, - "gcsPath": { - "description": "Google Cloud Storage file path of the import source. Can be set for batch operation error.", + "declineTime": { + "description": "The last time when the project declined or revoked the agreement to terms of service.", + "format": "google-datetime", "type": "string" }, - "lineNumber": { - "description": "Line number of the content in file. Should be empty for permission or batch operation error.", + "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" }, - "operation": { - "description": "The operation resource name of the LRO.", + "state": { + "description": "Whether the project has accepted/rejected the service terms or it is still pending.", + "enum": [ + "STATE_UNSPECIFIED", + "TERMS_ACCEPTED", + "TERMS_PENDING", + "TERMS_DECLINED" + ], + "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." + ], "type": "string" }, - "userEvent": { - "description": "The detailed content which caused the error on importing a user event.", + "version": { + "description": "The version string of the terms of service. For acceptable values, see the comments for id above.", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineLoggingServiceContext": { - "description": "Describes a running service that sends errors.", - "id": "GoogleCloudDiscoveryengineLoggingServiceContext", + "GoogleCloudDiscoveryengineV1ProvisionProjectMetadata": { + "description": "Metadata associated with a project provision operation.", + "id": "GoogleCloudDiscoveryengineV1ProvisionProjectMetadata", + "properties": {}, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1PurgeCompletionSuggestionsMetadata": { + "description": "Metadata related to the progress of the PurgeCompletionSuggestions operation. This is returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1PurgeCompletionSuggestionsMetadata", "properties": { - "service": { - "description": "An identifier of the service—for example, `discoveryengine.googleapis.com`.", + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", + "type": "string" + }, + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineLoggingSourceLocation": { - "description": "Indicates a location in the source code of the service for which errors are reported.", - "id": "GoogleCloudDiscoveryengineLoggingSourceLocation", + "GoogleCloudDiscoveryengineV1PurgeCompletionSuggestionsResponse": { + "description": "Response message for CompletionService.PurgeCompletionSuggestions method.", + "id": "GoogleCloudDiscoveryengineV1PurgeCompletionSuggestionsResponse", "properties": { - "functionName": { - "description": "Human-readable name of a function or method—for example, `google.cloud.discoveryengine.v1alpha.RecommendationService.Recommend`.", - "type": "string" + "errorSamples": { + "description": "A sample of errors encountered while processing the request.", + "items": { + "$ref": "GoogleRpcStatus" + }, + "type": "array" + }, + "purgeSucceeded": { + "description": "Whether the completion suggestions were successfully purged.", + "type": "boolean" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1BatchCreateTargetSiteMetadata": { - "description": "Metadata related to the progress of the SiteSearchEngineService.BatchCreateTargetSites operation. This will be returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1BatchCreateTargetSiteMetadata", + "GoogleCloudDiscoveryengineV1PurgeDocumentsMetadata": { + "description": "Metadata related to the progress of the PurgeDocuments operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1PurgeDocumentsMetadata", "properties": { "createTime": { "description": "Operation create time.", "format": "google-datetime", "type": "string" }, + "failureCount": { + "description": "Count of entries that encountered errors while processing.", + "format": "int64", + "type": "string" + }, + "ignoredCount": { + "description": "Count of entries that were ignored as entries were not found.", + "format": "int64", + "type": "string" + }, + "successCount": { + "description": "Count of entries that were deleted successfully.", + "format": "int64", + "type": "string" + }, "updateTime": { "description": "Operation last update time. If the operation is done, this is also the finish time.", "format": "google-datetime", @@ -7113,217 +8816,217 @@ }, "type": "object" }, - "GoogleCloudDiscoveryengineV1BatchCreateTargetSitesResponse": { - "description": "Response message for SiteSearchEngineService.BatchCreateTargetSites method.", - "id": "GoogleCloudDiscoveryengineV1BatchCreateTargetSitesResponse", + "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.", + "id": "GoogleCloudDiscoveryengineV1PurgeDocumentsResponse", "properties": { - "targetSites": { - "description": "TargetSites created.", + "purgeCount": { + "description": "The total count of documents purged as a result of the operation.", + "format": "int64", + "type": "string" + }, + "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.", "items": { - "$ref": "GoogleCloudDiscoveryengineV1TargetSite" + "type": "string" }, "type": "array" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1Condition": { - "description": "Defines circumstances to be checked before allowing a behavior", - "id": "GoogleCloudDiscoveryengineV1Condition", + "GoogleCloudDiscoveryengineV1PurgeSuggestionDenyListEntriesMetadata": { + "description": "Metadata related to the progress of the PurgeSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1PurgeSuggestionDenyListEntriesMetadata", "properties": { - "activeTimeRange": { - "description": "Range of time(s) specifying when condition is active. Maximum of 10 time ranges.", - "items": { - "$ref": "GoogleCloudDiscoveryengineV1ConditionTimeRange" - }, - "type": "array" + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", + "type": "string" }, - "queryTerms": { - "description": "Search only A list of terms to match the query on. Maximum of 10 query terms.", + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1PurgeSuggestionDenyListEntriesResponse": { + "description": "Response message for CompletionService.PurgeSuggestionDenyListEntries method.", + "id": "GoogleCloudDiscoveryengineV1PurgeSuggestionDenyListEntriesResponse", + "properties": { + "errorSamples": { + "description": "A sample of errors encountered while processing the request.", "items": { - "$ref": "GoogleCloudDiscoveryengineV1ConditionQueryTerm" + "$ref": "GoogleRpcStatus" }, "type": "array" + }, + "purgeCount": { + "description": "Number of suggestion deny list entries purged.", + "format": "int64", + "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1ConditionQueryTerm": { - "description": "Matcher for search request query", - "id": "GoogleCloudDiscoveryengineV1ConditionQueryTerm", + "GoogleCloudDiscoveryengineV1Schema": { + "description": "Defines the structure and layout of a type of document data.", + "id": "GoogleCloudDiscoveryengineV1Schema", "properties": { - "fullMatch": { - "description": "Whether the search query needs to exactly match the query term.", - "type": "boolean" + "jsonSchema": { + "description": "The JSON representation of the schema.", + "type": "string" }, - "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.", + "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" + }, + "structSchema": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "The structured representation of the schema.", + "type": "object" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1ConditionTimeRange": { - "description": "Used for time-dependent conditions.", - "id": "GoogleCloudDiscoveryengineV1ConditionTimeRange", + "GoogleCloudDiscoveryengineV1SiteVerificationInfo": { + "description": "Verification information for target sites in advanced site search.", + "id": "GoogleCloudDiscoveryengineV1SiteVerificationInfo", "properties": { - "endTime": { - "description": "End of time range. Range is inclusive. Must be in the future.", - "format": "google-datetime", + "siteVerificationState": { + "description": "Site verification state indicating the ownership and validity.", + "enum": [ + "SITE_VERIFICATION_STATE_UNSPECIFIED", + "VERIFIED", + "UNVERIFIED", + "EXEMPTED" + ], + "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." + ], "type": "string" }, - "startTime": { - "description": "Start of time range. Range is inclusive.", + "verifyTime": { + "description": "Latest site verification time.", "format": "google-datetime", "type": "string" } }, "type": "object" }, - "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`.", - "id": "GoogleCloudDiscoveryengineV1Control", + "GoogleCloudDiscoveryengineV1TargetSite": { + "description": "A target site for the SiteSearchEngine.", + "id": "GoogleCloudDiscoveryengineV1TargetSite", "properties": { - "associatedServingConfigIds": { - "description": "Output only. List of all ServingConfig ids this control is attached to. May take up to 10 minutes to update after changes.", - "items": { - "type": "string" - }, - "readOnly": true, - "type": "array" - }, - "boostAction": { - "$ref": "GoogleCloudDiscoveryengineV1ControlBoostAction", - "description": "Defines a boost-type control" - }, - "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.", - "items": { - "$ref": "GoogleCloudDiscoveryengineV1Condition" - }, - "type": "array" - }, - "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" + "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" }, - "filterAction": { - "$ref": "GoogleCloudDiscoveryengineV1ControlFilterAction", - "description": "Defines a filter-type control Currently not supported by Recommendation" + "failureReason": { + "$ref": "GoogleCloudDiscoveryengineV1TargetSiteFailureReason", + "description": "Output only. Failure reason.", + "readOnly": true }, - "name": { - "description": "Immutable. Fully qualified name `projects/*/locations/global/dataStore/*/controls/*`", + "generatedUriPattern": { + "description": "Output only. This is system-generated based on the provided_uri_pattern.", + "readOnly": true, "type": "string" }, - "redirectAction": { - "$ref": "GoogleCloudDiscoveryengineV1ControlRedirectAction", - "description": "Defines a redirect-type control." - }, - "solutionType": { - "description": "Required. Immutable. What solution the control belongs to. Must be compatible with vertical of resource. Otherwise an INVALID ARGUMENT error is thrown.", + "indexingStatus": { + "description": "Output only. Indexing status.", "enum": [ - "SOLUTION_TYPE_UNSPECIFIED", - "SOLUTION_TYPE_RECOMMENDATION", - "SOLUTION_TYPE_SEARCH", - "SOLUTION_TYPE_CHAT", - "SOLUTION_TYPE_GENERATIVE_CHAT" + "INDEXING_STATUS_UNSPECIFIED", + "PENDING", + "FAILED", + "SUCCEEDED", + "DELETING" ], "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." + "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." ], + "readOnly": true, "type": "string" }, - "synonymsAction": { - "$ref": "GoogleCloudDiscoveryengineV1ControlSynonymsAction", - "description": "Treats a group of terms as synonyms of one another." - }, - "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.", - "items": { - "enum": [ - "SEARCH_USE_CASE_UNSPECIFIED", - "SEARCH_USE_CASE_SEARCH", - "SEARCH_USE_CASE_BROWSE" - ], - "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." - ], - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1ControlBoostAction": { - "description": "Adjusts order of products in returned list.", - "id": "GoogleCloudDiscoveryengineV1ControlBoostAction", - "properties": { - "boost": { - "description": "Required. Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0 (No-op).", - "format": "float", - "type": "number" + "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" }, - "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", + "providedUriPattern": { + "description": "Required. Input only. The user provided URI pattern from which the `generated_uri_pattern` is generated.", "type": "string" }, - "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.", + "rootDomainUri": { + "description": "Output only. Root domain of the provided_uri_pattern.", + "readOnly": true, "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1ControlFilterAction": { - "description": "Specified which products may be included in results. Uses same filter as boost.", - "id": "GoogleCloudDiscoveryengineV1ControlFilterAction", - "properties": { - "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", + }, + "siteVerificationInfo": { + "$ref": "GoogleCloudDiscoveryengineV1SiteVerificationInfo", + "description": "Output only. Site ownership and validity verification status.", + "readOnly": true + }, + "type": { + "description": "The type of the target site, e.g., whether the site is to be included or excluded.", + "enum": [ + "TYPE_UNSPECIFIED", + "INCLUDE", + "EXCLUDE" + ], + "enumDescriptions": [ + "This value is unused. In this case, server behavior defaults to Type.INCLUDE.", + "Include the target site.", + "Exclude the target site." + ], "type": "string" }, - "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.", + "updateTime": { + "description": "Output only. The target site's last updated time.", + "format": "google-datetime", + "readOnly": true, "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1ControlRedirectAction": { - "description": "Redirects a shopper to the provided URI.", - "id": "GoogleCloudDiscoveryengineV1ControlRedirectAction", + "GoogleCloudDiscoveryengineV1TargetSiteFailureReason": { + "description": "Site search indexing failure reasons.", + "id": "GoogleCloudDiscoveryengineV1TargetSiteFailureReason", "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" + "quotaFailure": { + "$ref": "GoogleCloudDiscoveryengineV1TargetSiteFailureReasonQuotaFailure", + "description": "Failed due to insufficient quota." } }, "type": "object" }, - "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\".", - "id": "GoogleCloudDiscoveryengineV1ControlSynonymsAction", + "GoogleCloudDiscoveryengineV1TargetSiteFailureReasonQuotaFailure": { + "description": "Failed due to insufficient quota.", + "id": "GoogleCloudDiscoveryengineV1TargetSiteFailureReasonQuotaFailure", "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.", - "items": { - "type": "string" - }, - "type": "array" + "totalRequiredQuota": { + "description": "This number is an estimation on how much total quota this project needs to successfully complete indexing.", + "format": "int64", + "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1CreateDataStoreMetadata": { - "description": "Metadata related to the progress of the DataStoreService.CreateDataStore operation. This will be returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1CreateDataStoreMetadata", + "GoogleCloudDiscoveryengineV1UpdateSchemaMetadata": { + "description": "Metadata for UpdateSchema LRO.", + "id": "GoogleCloudDiscoveryengineV1UpdateSchemaMetadata", "properties": { "createTime": { "description": "Operation create time.", @@ -7338,9 +9041,9 @@ }, "type": "object" }, - "GoogleCloudDiscoveryengineV1CreateEngineMetadata": { - "description": "Metadata related to the progress of the EngineService.CreateEngine operation. This will be returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1CreateEngineMetadata", + "GoogleCloudDiscoveryengineV1UpdateTargetSiteMetadata": { + "description": "Metadata related to the progress of the SiteSearchEngineService.UpdateTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1UpdateTargetSiteMetadata", "properties": { "createTime": { "description": "Operation create time.", @@ -7355,895 +9058,895 @@ }, "type": "object" }, - "GoogleCloudDiscoveryengineV1CreateSchemaMetadata": { - "description": "Metadata for Create Schema LRO.", - "id": "GoogleCloudDiscoveryengineV1CreateSchemaMetadata", + "GoogleCloudDiscoveryengineV1alphaAclConfig": { + "description": "Access Control Configuration.", + "id": "GoogleCloudDiscoveryengineV1alphaAclConfig", "properties": { - "createTime": { - "description": "Operation create time.", - "format": "google-datetime", - "type": "string" + "idpConfig": { + "$ref": "GoogleCloudDiscoveryengineV1alphaIdpConfig", + "description": "Identity provider config." }, - "updateTime": { - "description": "Operation last update time. If the operation is done, this is also the finish time.", - "format": "google-datetime", + "name": { + "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" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1CreateTargetSiteMetadata": { - "description": "Metadata related to the progress of the SiteSearchEngineService.CreateTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1CreateTargetSiteMetadata", + "GoogleCloudDiscoveryengineV1alphaAlloyDbSource": { + "description": "AlloyDB source import data from.", + "id": "GoogleCloudDiscoveryengineV1alphaAlloyDbSource", "properties": { - "createTime": { - "description": "Operation create time.", - "format": "google-datetime", + "clusterId": { + "description": "Required. The AlloyDB cluster to copy the data from with a length limit of 256 characters.", "type": "string" }, - "updateTime": { - "description": "Operation last update time. If the operation is done, this is also the finish time.", - "format": "google-datetime", + "databaseId": { + "description": "Required. The AlloyDB database 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" + }, + "locationId": { + "description": "Required. The AlloyDB location to copy the data from with a length limit of 256 characters.", + "type": "string" + }, + "projectId": { + "description": "The project ID that the AlloyDB source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request.", + "type": "string" + }, + "tableId": { + "description": "Required. The AlloyDB table to copy the data from with a length limit of 256 characters.", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1DataStore": { - "description": "DataStore captures global settings and configs at the DataStore level.", - "id": "GoogleCloudDiscoveryengineV1DataStore", + "GoogleCloudDiscoveryengineV1alphaAnswer": { + "description": "Defines an answer.", + "id": "GoogleCloudDiscoveryengineV1alphaAnswer", "properties": { - "contentConfig": { - "description": "Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT.", - "enum": [ - "CONTENT_CONFIG_UNSPECIFIED", - "NO_CONTENT", - "CONTENT_REQUIRED", - "PUBLIC_WEBSITE" - ], - "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." - ], + "answerSkippedReasons": { + "description": "Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set.", + "items": { + "enum": [ + "ANSWER_SKIPPED_REASON_UNSPECIFIED", + "ADVERSARIAL_QUERY_IGNORED", + "NON_ANSWER_SEEKING_QUERY_IGNORED", + "OUT_OF_DOMAIN_QUERY_IGNORED", + "POTENTIAL_POLICY_VIOLATION", + "NO_RELEVANT_CONTENT" + ], + "enumDescriptions": [ + "Default value. The answer skipped reason is not specified.", + "The adversarial query ignored case.", + "The non-answer seeking query ignored case.", + "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." + ], + "type": "string" + }, + "type": "array" + }, + "answerText": { + "description": "The textual answer.", + "type": "string" + }, + "citations": { + "description": "Citations.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerCitation" + }, + "type": "array" + }, + "completeTime": { + "description": "Output only. Answer completed timestamp.", + "format": "google-datetime", + "readOnly": true, "type": "string" }, "createTime": { - "description": "Output only. Timestamp the DataStore was created at.", + "description": "Output only. Answer creation timestamp.", "format": "google-datetime", "readOnly": true, "type": "string" }, - "defaultSchemaId": { - "description": "Output only. The id of the default Schema asscociated to this data store.", - "readOnly": true, + "name": { + "description": "Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*/answers/*`", "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" + "queryUnderstandingInfo": { + "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfo", + "description": "Query understanding information." }, - "documentProcessingConfig": { - "$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfig", - "description": "Configuration for Document understanding and enrichment." + "references": { + "description": "References.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerReference" + }, + "type": "array" }, - "industryVertical": { - "description": "Immutable. The industry vertical that the data store registers.", + "relatedQuestions": { + "description": "Suggested related questions.", + "items": { + "type": "string" + }, + "type": "array" + }, + "state": { + "description": "The state of the answer generation.", "enum": [ - "INDUSTRY_VERTICAL_UNSPECIFIED", - "GENERIC", - "MEDIA", - "HEALTHCARE_FHIR" + "STATE_UNSPECIFIED", + "IN_PROGRESS", + "FAILED", + "SUCCEEDED" ], "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." + "Unknown.", + "Answer generation is currently in progress.", + "Answer generation currently failed.", + "Answer generation has succeeded." ], "type": "string" }, - "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" - }, - "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.", + "steps": { + "description": "Answer generation steps.", "items": { - "enum": [ - "SOLUTION_TYPE_UNSPECIFIED", - "SOLUTION_TYPE_RECOMMENDATION", - "SOLUTION_TYPE_SEARCH", - "SOLUTION_TYPE_CHAT", - "SOLUTION_TYPE_GENERATIVE_CHAT" - ], - "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." - ], - "type": "string" + "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerStep" }, "type": "array" - }, - "startingSchema": { - "$ref": "GoogleCloudDiscoveryengineV1Schema", - "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)." } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1DeleteDataStoreMetadata": { - "description": "Metadata related to the progress of the DataStoreService.DeleteDataStore operation. This will be returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1DeleteDataStoreMetadata", + "GoogleCloudDiscoveryengineV1alphaAnswerCitation": { + "description": "Citation info for a segment.", + "id": "GoogleCloudDiscoveryengineV1alphaAnswerCitation", "properties": { - "createTime": { - "description": "Operation create time.", - "format": "google-datetime", + "endIndex": { + "description": "End of the attributed segment, exclusive.", + "format": "int64", "type": "string" }, - "updateTime": { - "description": "Operation last update time. If the operation is done, this is also the finish time.", - "format": "google-datetime", + "sources": { + "description": "Citation sources for the attributed segment.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerCitationSource" + }, + "type": "array" + }, + "startIndex": { + "description": "Index indicates the start of the segment, measured in bytes (UTF-8 unicode).", + "format": "int64", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1DeleteEngineMetadata": { - "description": "Metadata related to the progress of the EngineService.DeleteEngine operation. This will be returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1DeleteEngineMetadata", + "GoogleCloudDiscoveryengineV1alphaAnswerCitationSource": { + "description": "Citation source.", + "id": "GoogleCloudDiscoveryengineV1alphaAnswerCitationSource", "properties": { - "createTime": { - "description": "Operation create time.", - "format": "google-datetime", - "type": "string" - }, - "updateTime": { - "description": "Operation last update time. If the operation is done, this is also the finish time.", - "format": "google-datetime", + "referenceId": { + "description": "ID of the citation source.", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1DeleteSchemaMetadata": { - "description": "Metadata for DeleteSchema LRO.", - "id": "GoogleCloudDiscoveryengineV1DeleteSchemaMetadata", + "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequest": { + "description": "Request message for ConversationalSearchService.AnswerQuery method.", + "id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequest", "properties": { - "createTime": { - "description": "Operation create time.", - "format": "google-datetime", + "answerGenerationSpec": { + "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestAnswerGenerationSpec", + "description": "Answer generation specification." + }, + "asynchronousMode": { + "description": "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.", + "type": "boolean" + }, + "query": { + "$ref": "GoogleCloudDiscoveryengineV1alphaQuery", + "description": "Required. Current user query." + }, + "queryUnderstandingSpec": { + "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestQueryUnderstandingSpec", + "description": "Query understanding specification." + }, + "relatedQuestionsSpec": { + "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestRelatedQuestionsSpec", + "description": "Related questions specification." + }, + "safetySpec": { + "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSafetySpec", + "description": "Model specification." + }, + "searchSpec": { + "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpec", + "description": "Search specification." + }, + "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.", "type": "string" }, - "updateTime": { - "description": "Operation last update time. If the operation is done, this is also the finish time.", - "format": "google-datetime", + "userLabels": { + "additionalProperties": { + "type": "string" + }, + "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" + }, + "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" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1DeleteTargetSiteMetadata": { - "description": "Metadata related to the progress of the SiteSearchEngineService.DeleteTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1DeleteTargetSiteMetadata", + "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestAnswerGenerationSpec": { + "description": "Answer generation specification.", + "id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestAnswerGenerationSpec", "properties": { - "createTime": { - "description": "Operation create time.", - "format": "google-datetime", + "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" }, - "updateTime": { - "description": "Operation last update time. If the operation is done, this is also the finish time.", - "format": "google-datetime", - "type": "string" + "ignoreAdversarialQuery": { + "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" + }, + "ignoreLowRelevantContent": { + "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" + }, + "ignoreNonAnswerSeekingQuery": { + "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.", + "type": "boolean" + }, + "includeCitations": { + "description": "Specifies whether to include citation metadata in the answer. The default value is `false`.", + "type": "boolean" + }, + "modelSpec": { + "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestAnswerGenerationSpecModelSpec", + "description": "Answer generation model specification." + }, + "promptSpec": { + "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestAnswerGenerationSpecPromptSpec", + "description": "Answer generation prompt specification." } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1DisableAdvancedSiteSearchMetadata": { - "description": "Metadata related to the progress of the SiteSearchEngineService.DisableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1DisableAdvancedSiteSearchMetadata", + "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestAnswerGenerationSpecModelSpec": { + "description": "Answer Generation Model specification.", + "id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestAnswerGenerationSpecModelSpec", "properties": { - "createTime": { - "description": "Operation create time.", - "format": "google-datetime", - "type": "string" - }, - "updateTime": { - "description": "Operation last update time. If the operation is done, this is also the finish time.", - "format": "google-datetime", + "modelVersion": { + "description": "Model version. If not set, it will use the default stable model. Allowed values are: stable, preview.", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1DisableAdvancedSiteSearchResponse": { - "description": "Response message for SiteSearchEngineService.DisableAdvancedSiteSearch method.", - "id": "GoogleCloudDiscoveryengineV1DisableAdvancedSiteSearchResponse", - "properties": {}, + "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestAnswerGenerationSpecPromptSpec": { + "description": "Answer generation prompt specification.", + "id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestAnswerGenerationSpecPromptSpec", + "properties": { + "preamble": { + "description": "Customized preamble.", + "type": "string" + } + }, "type": "object" }, - "GoogleCloudDiscoveryengineV1DocumentProcessingConfig": { - "description": "A singleton resource of DataStore. It's empty when DataStore is created, which defaults to digital parser. The first call to DataStoreService.UpdateDocumentProcessingConfig method will initialize the config.", - "id": "GoogleCloudDiscoveryengineV1DocumentProcessingConfig", + "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestQueryUnderstandingSpec": { + "description": "Query understanding specification.", + "id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestQueryUnderstandingSpec", "properties": { - "chunkingConfig": { - "$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfig", - "description": "Whether chunking mode is enabled." - }, - "defaultParsingConfig": { - "$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig", - "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." - }, - "name": { - "description": "The full resource name of the Document Processing Config. Format: `projects/*/locations/*/collections/*/dataStores/*/documentProcessingConfig`.", - "type": "string" + "queryClassificationSpec": { + "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestQueryUnderstandingSpecQueryClassificationSpec", + "description": "Query classification specification." }, - "parsingConfigOverrides": { - "additionalProperties": { - "$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig" - }, - "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 or layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and or layout parsing are supported.", - "type": "object" + "queryRephraserSpec": { + "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestQueryUnderstandingSpecQueryRephraserSpec", + "description": "Query rephraser specification." } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfig": { - "description": "Configuration for chunking config.", - "id": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfig", + "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestQueryUnderstandingSpecQueryClassificationSpec": { + "description": "Query classification specification.", + "id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestQueryUnderstandingSpecQueryClassificationSpec", "properties": { - "layoutBasedChunkingConfig": { - "$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig", - "description": "Configuration for the layout based chunking." + "types": { + "description": "Enabled query classification types.", + "items": { + "enum": [ + "TYPE_UNSPECIFIED", + "ADVERSARIAL_QUERY", + "NON_ANSWER_SEEKING_QUERY" + ], + "enumDescriptions": [ + "Unspecified query classification type.", + "Adversarial query classification type.", + "Non-answer-seeking query classification type." + ], + "type": "string" + }, + "type": "array" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig": { - "description": "Configuration for the layout based chunking.", - "id": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig", + "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestQueryUnderstandingSpecQueryRephraserSpec": { + "description": "Query rephraser specification.", + "id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestQueryUnderstandingSpecQueryRephraserSpec", "properties": { - "chunkSize": { - "description": "The token size limit for each chunk. Supported values: 100-500 (inclusive). Default value: 500.", + "disable": { + "description": "Disable query rephraser.", + "type": "boolean" + }, + "maxRephraseSteps": { + "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.", "format": "int32", "type": "integer" - }, - "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" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig": { - "description": "Related configurations applied to a specific type of document parser.", - "id": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig", + "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestRelatedQuestionsSpec": { + "description": "Related questions specification.", + "id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestRelatedQuestionsSpec", "properties": { - "digitalParsingConfig": { - "$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigDigitalParsingConfig", - "description": "Configurations applied to digital parser." - }, - "layoutParsingConfig": { - "$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigLayoutParsingConfig", - "description": "Configurations applied to layout parser." - }, - "ocrParsingConfig": { - "$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigOcrParsingConfig", - "description": "Configurations applied to OCR parser. Currently it only applies to PDFs." + "enable": { + "description": "Enable related questions feature if true.", + "type": "boolean" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigDigitalParsingConfig": { - "description": "The digital parsing configurations for documents.", - "id": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigDigitalParsingConfig", - "properties": {}, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigLayoutParsingConfig": { - "description": "The layout parsing configurations for documents.", - "id": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigLayoutParsingConfig", - "properties": {}, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigOcrParsingConfig": { - "description": "The OCR parsing configurations for documents.", - "id": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigOcrParsingConfig", + "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSafetySpec": { + "description": "Safety specification.", + "id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSafetySpec", "properties": { - "enhancedDocumentElements": { - "deprecated": true, - "description": "[DEPRECATED] This field is deprecated. To use the additional enhanced document elements processing, please switch to `layout_parsing_config`.", - "items": { - "type": "string" - }, - "type": "array" - }, - "useNativeText": { - "description": "If true, will use native text instead of OCR text on pages containing native text.", + "enable": { + "description": "Enable the safety filtering on the answer response. It is false by default.", "type": "boolean" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1EnableAdvancedSiteSearchMetadata": { - "description": "Metadata related to the progress of the SiteSearchEngineService.EnableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1EnableAdvancedSiteSearchMetadata", + "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpec": { + "description": "Search specification.", + "id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpec", "properties": { - "createTime": { - "description": "Operation create time.", - "format": "google-datetime", - "type": "string" + "searchParams": { + "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchParams", + "description": "Search parameters." }, - "updateTime": { - "description": "Operation last update time. If the operation is done, this is also the finish time.", - "format": "google-datetime", - "type": "string" + "searchResultList": { + "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultList", + "description": "Search result list." } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1EnableAdvancedSiteSearchResponse": { - "description": "Response message for SiteSearchEngineService.EnableAdvancedSiteSearch method.", - "id": "GoogleCloudDiscoveryengineV1EnableAdvancedSiteSearchResponse", - "properties": {}, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1Engine": { - "description": "Metadata that describes the training and serving parameters of an Engine.", - "id": "GoogleCloudDiscoveryengineV1Engine", + "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchParams": { + "description": "Search parameters.", + "id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchParams", "properties": { - "chatEngineConfig": { - "$ref": "GoogleCloudDiscoveryengineV1EngineChatEngineConfig", - "description": "Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT." - }, - "chatEngineMetadata": { - "$ref": "GoogleCloudDiscoveryengineV1EngineChatEngineMetadata", - "description": "Output only. Additional information of the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.", - "readOnly": true - }, - "commonConfig": { - "$ref": "GoogleCloudDiscoveryengineV1EngineCommonConfig", - "description": "Common config spec that specifies the metadata of the engine." + "boostSpec": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpec", + "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)" }, - "createTime": { - "description": "Output only. Timestamp the Recommendation Engine was created at.", - "format": "google-datetime", - "readOnly": true, - "type": "string" + "customFineTuningSpec": { + "$ref": "GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec", + "description": "Custom fine tuning configs." }, - "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.", + "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.", "items": { - "type": "string" + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec" }, "type": "array" }, - "displayName": { - "description": "Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters.", + "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" }, - "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.", - "enum": [ - "INDUSTRY_VERTICAL_UNSPECIFIED", - "GENERIC", - "MEDIA", - "HEALTHCARE_FHIR" - ], - "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." - ], - "type": "string" + "maxReturnResults": { + "description": "Number of search results to return. The default value is 10.", + "format": "int32", + "type": "integer" }, - "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_number}/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.", + "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" }, - "searchEngineConfig": { - "$ref": "GoogleCloudDiscoveryengineV1EngineSearchEngineConfig", - "description": "Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH." - }, - "solutionType": { - "description": "Required. The solutions of the engine.", + "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)", "enum": [ - "SOLUTION_TYPE_UNSPECIFIED", - "SOLUTION_TYPE_RECOMMENDATION", - "SOLUTION_TYPE_SEARCH", - "SOLUTION_TYPE_CHAT", - "SOLUTION_TYPE_GENERATIVE_CHAT" + "SEARCH_RESULT_MODE_UNSPECIFIED", + "DOCUMENTS", + "CHUNKS" ], "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." + "Returns documents in the search result.", + "Returns chunks in the search result. Only available if the DataStore.DocumentProcessingConfig.chunking_config is specified." ], "type": "string" - }, - "updateTime": { - "description": "Output only. Timestamp the Recommendation Engine was last updated.", - "format": "google-datetime", - "readOnly": true, - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1EngineChatEngineConfig": { - "description": "Configurations for a Chat Engine.", - "id": "GoogleCloudDiscoveryengineV1EngineChatEngineConfig", - "properties": { - "agentCreationConfig": { - "$ref": "GoogleCloudDiscoveryengineV1EngineChatEngineConfigAgentCreationConfig", - "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." - }, - "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" } }, "type": "object" }, - "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.", - "id": "GoogleCloudDiscoveryengineV1EngineChatEngineConfigAgentCreationConfig", + "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultList": { + "description": "Search result list.", + "id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultList", "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" - }, - "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" - }, - "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" + "searchResults": { + "description": "Search results.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResult" + }, + "type": "array" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1EngineChatEngineMetadata": { - "description": "Additional information of a Chat Engine. Fields in this message are output only.", - "id": "GoogleCloudDiscoveryengineV1EngineChatEngineMetadata", + "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResult": { + "description": "Search result.", + "id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResult", "properties": { - "dialogflowAgent": { - "description": "The resource name of a Dialogflow agent, that this Chat Engine refers to. Format: `projects//locations//agents/`.", - "type": "string" + "chunkInfo": { + "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultChunkInfo", + "description": "Chunk information." + }, + "unstructuredDocumentInfo": { + "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfo", + "description": "Unstructured document information." } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1EngineCommonConfig": { - "description": "Common configurations for an Engine.", - "id": "GoogleCloudDiscoveryengineV1EngineCommonConfig", + "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultChunkInfo": { + "description": "Chunk information.", + "id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultChunkInfo", "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.", + "chunk": { + "description": "Chunk resource name.", + "type": "string" + }, + "content": { + "description": "Chunk textual content.", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1EngineSearchEngineConfig": { - "description": "Configurations for a Search Engine.", - "id": "GoogleCloudDiscoveryengineV1EngineSearchEngineConfig", + "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfo": { + "description": "Unstructured document information.", + "id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfo", "properties": { - "searchAddOns": { - "description": "The add-on that this search engine enables.", + "document": { + "description": "Document resource name.", + "type": "string" + }, + "documentContexts": { + "description": "List of document contexts.", "items": { - "enum": [ - "SEARCH_ADD_ON_UNSPECIFIED", - "SEARCH_ADD_ON_LLM" - ], - "enumDescriptions": [ - "Default value when the enum is unspecified. This is invalid to use.", - "Large language model add-on." - ], - "type": "string" + "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoDocumentContext" }, "type": "array" }, - "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.", - "enum": [ - "SEARCH_TIER_UNSPECIFIED", - "SEARCH_TIER_STANDARD", - "SEARCH_TIER_ENTERPRISE" - ], - "enumDescriptions": [ - "Default value when the enum is unspecified. This is invalid to use.", - "Standard tier.", - "Enterprise tier." - ], + "extractiveAnswers": { + "description": "List of extractive answers.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoExtractiveAnswer" + }, + "type": "array" + }, + "extractiveSegments": { + "description": "List of extractive segments.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoExtractiveSegment" + }, + "type": "array" + }, + "title": { + "description": "Title.", + "type": "string" + }, + "uri": { + "description": "URI for the document.", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1ImportCompletionSuggestionsMetadata": { - "description": "Metadata related to the progress of the ImportCompletionSuggestions operation. This will be returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1ImportCompletionSuggestionsMetadata", + "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoDocumentContext": { + "description": "Document context.", + "id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoDocumentContext", "properties": { - "createTime": { - "description": "Operation create time.", - "format": "google-datetime", - "type": "string" - }, - "failureCount": { - "description": "Count of CompletionSuggestions that failed to be imported.", - "format": "int64", - "type": "string" - }, - "successCount": { - "description": "Count of CompletionSuggestions successfully imported.", - "format": "int64", + "content": { + "description": "Document content.", "type": "string" }, - "updateTime": { - "description": "Operation last update time. If the operation is done, this is also the finish time.", - "format": "google-datetime", + "pageIdentifier": { + "description": "Page identifier.", "type": "string" } }, "type": "object" }, - "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.", - "id": "GoogleCloudDiscoveryengineV1ImportCompletionSuggestionsResponse", + "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoExtractiveAnswer": { + "description": "Extractive answer. [Guide](https://cloud.google.com/generative-ai-app-builder/docs/snippets#get-answers)", + "id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoExtractiveAnswer", "properties": { - "errorConfig": { - "$ref": "GoogleCloudDiscoveryengineV1ImportErrorConfig", - "description": "The desired location of errors incurred during the Import." + "content": { + "description": "Extractive answer content.", + "type": "string" }, - "errorSamples": { - "description": "A sample of errors encountered while processing the request.", - "items": { - "$ref": "GoogleRpcStatus" - }, - "type": "array" + "pageIdentifier": { + "description": "Page identifier.", + "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1ImportDocumentsMetadata": { - "description": "Metadata related to the progress of the ImportDocuments operation. This is returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1ImportDocumentsMetadata", + "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoExtractiveSegment": { + "description": "Extractive segment. [Guide](https://cloud.google.com/generative-ai-app-builder/docs/snippets#extractive-segments)", + "id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoExtractiveSegment", "properties": { - "createTime": { - "description": "Operation create time.", - "format": "google-datetime", - "type": "string" - }, - "failureCount": { - "description": "Count of entries that encountered errors while processing.", - "format": "int64", + "content": { + "description": "Extractive segment content.", "type": "string" }, - "successCount": { - "description": "Count of entries that were processed successfully.", - "format": "int64", + "pageIdentifier": { + "description": "Page identifier.", "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaAnswerQueryResponse": { + "description": "Response message for ConversationalSearchService.AnswerQuery method.", + "id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryResponse", + "properties": { + "answer": { + "$ref": "GoogleCloudDiscoveryengineV1alphaAnswer", + "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." }, - "totalCount": { - "description": "Total count of entries that were processed.", - "format": "int64", + "answerQueryToken": { + "description": "A global unique ID used for logging.", "type": "string" }, - "updateTime": { - "description": "Operation last update time. If the operation is done, this is also the finish time.", - "format": "google-datetime", - "type": "string" + "session": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSession", + "description": "Session resource object. It will be only available when session field is set and valid in the AnswerQueryRequest request." } }, "type": "object" }, - "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.", - "id": "GoogleCloudDiscoveryengineV1ImportDocumentsResponse", + "GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfo": { + "description": "Query understanding information.", + "id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfo", "properties": { - "errorConfig": { - "$ref": "GoogleCloudDiscoveryengineV1ImportErrorConfig", - "description": "Echoes the destination for the complete errors in the request if set." - }, - "errorSamples": { - "description": "A sample of errors encountered while processing the request.", + "queryClassificationInfo": { + "description": "Query classification information.", "items": { - "$ref": "GoogleRpcStatus" + "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfoQueryClassificationInfo" }, "type": "array" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1ImportErrorConfig": { - "description": "Configuration of destination for Import related errors.", - "id": "GoogleCloudDiscoveryengineV1ImportErrorConfig", + "GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfoQueryClassificationInfo": { + "description": "Query classification information.", + "id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfoQueryClassificationInfo", "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.", + "positive": { + "description": "Classification output.", + "type": "boolean" + }, + "type": { + "description": "Query classification type.", + "enum": [ + "TYPE_UNSPECIFIED", + "ADVERSARIAL_QUERY", + "NON_ANSWER_SEEKING_QUERY" + ], + "enumDescriptions": [ + "Unspecified query classification type.", + "Adversarial query classification type.", + "Non-answer-seeking query classification type." + ], "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1ImportSuggestionDenyListEntriesMetadata": { - "description": "Metadata related to the progress of the ImportSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1ImportSuggestionDenyListEntriesMetadata", + "GoogleCloudDiscoveryengineV1alphaAnswerReference": { + "description": "Reference.", + "id": "GoogleCloudDiscoveryengineV1alphaAnswerReference", "properties": { - "createTime": { - "description": "Operation create time.", - "format": "google-datetime", - "type": "string" + "chunkInfo": { + "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfo", + "description": "Chunk information." }, - "updateTime": { - "description": "Operation last update time. If the operation is done, this is also the finish time.", - "format": "google-datetime", - "type": "string" + "unstructuredDocumentInfo": { + "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfo", + "description": "Unstructured document information." } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1ImportSuggestionDenyListEntriesResponse": { - "description": "Response message for CompletionService.ImportSuggestionDenyListEntries method.", - "id": "GoogleCloudDiscoveryengineV1ImportSuggestionDenyListEntriesResponse", + "GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfo": { + "description": "Chunk information.", + "id": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfo", "properties": { - "errorSamples": { - "description": "A sample of errors encountered while processing the request.", - "items": { - "$ref": "GoogleRpcStatus" - }, - "type": "array" - }, - "failedEntriesCount": { - "description": "Count of deny list entries that failed to be imported.", - "format": "int64", + "chunk": { + "description": "Chunk resource name.", "type": "string" }, - "importedEntriesCount": { - "description": "Count of deny list entries successfully imported.", - "format": "int64", + "content": { + "description": "Chunk textual content.", "type": "string" + }, + "documentMetadata": { + "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfoDocumentMetadata", + "description": "Document metadata." + }, + "relevanceScore": { + "description": "Relevance score.", + "format": "float", + "type": "number" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1ImportUserEventsMetadata": { - "description": "Metadata related to the progress of the Import operation. This is returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1ImportUserEventsMetadata", + "GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfoDocumentMetadata": { + "description": "Document metadata.", + "id": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfoDocumentMetadata", "properties": { - "createTime": { - "description": "Operation create time.", - "format": "google-datetime", + "document": { + "description": "Document resource name.", "type": "string" }, - "failureCount": { - "description": "Count of entries that encountered errors while processing.", - "format": "int64", + "pageIdentifier": { + "description": "Page identifier.", "type": "string" }, - "successCount": { - "description": "Count of entries that were processed successfully.", - "format": "int64", + "structData": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "The structured JSON metadata for the document. It is populated from the struct data from the Chunk in search result.", + "type": "object" + }, + "title": { + "description": "Title.", "type": "string" }, - "updateTime": { - "description": "Operation last update time. If the operation is done, this is also the finish time.", - "format": "google-datetime", + "uri": { + "description": "URI for the document.", "type": "string" } }, "type": "object" }, - "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.", - "id": "GoogleCloudDiscoveryengineV1ImportUserEventsResponse", + "GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfo": { + "description": "Unstructured document information.", + "id": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfo", "properties": { - "errorConfig": { - "$ref": "GoogleCloudDiscoveryengineV1ImportErrorConfig", - "description": "Echoes the destination for the complete errors if this field was set in the request." - }, - "errorSamples": { - "description": "A sample of errors encountered while processing the request.", + "chunkContents": { + "description": "List of cited chunk contents derived from document content.", "items": { - "$ref": "GoogleRpcStatus" + "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfoChunkContent" }, "type": "array" }, - "joinedEventsCount": { - "description": "Count of user events imported with complete existing Documents.", - "format": "int64", + "document": { + "description": "Document resource name.", "type": "string" }, - "unjoinedEventsCount": { - "description": "Count of user events imported, but with Document information not found in the existing Branch.", - "format": "int64", + "structData": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "The structured JSON metadata for the document. It is populated from the struct data from the Chunk in search result.", + "type": "object" + }, + "title": { + "description": "Title.", + "type": "string" + }, + "uri": { + "description": "URI for the document.", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1Project": { - "description": "Metadata and configurations for a Google Cloud project in the service.", - "id": "GoogleCloudDiscoveryengineV1Project", + "GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfoChunkContent": { + "description": "Chunk content.", + "id": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfoChunkContent", "properties": { - "createTime": { - "description": "Output only. The timestamp when this project is created.", - "format": "google-datetime", - "readOnly": true, - "type": "string" - }, - "name": { - "description": "Output only. Full resource name of the project, for example `projects/{project_number}`. Note that when making requests, project number and project id are both acceptable, but the server will always respond in project number.", - "readOnly": true, + "content": { + "description": "Chunk textual content.", "type": "string" }, - "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.", - "format": "google-datetime", - "readOnly": true, + "pageIdentifier": { + "description": "Page identifier.", "type": "string" - }, - "serviceTermsMap": { - "additionalProperties": { - "$ref": "GoogleCloudDiscoveryengineV1ProjectServiceTerms" - }, - "description": "Output only. A map of terms of services. The key is the `id` of ServiceTerms.", - "readOnly": true, - "type": "object" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1ProjectServiceTerms": { - "description": "Metadata about the terms of service.", - "id": "GoogleCloudDiscoveryengineV1ProjectServiceTerms", + "GoogleCloudDiscoveryengineV1alphaAnswerStep": { + "description": "Step information.", + "id": "GoogleCloudDiscoveryengineV1alphaAnswerStep", "properties": { - "acceptTime": { - "description": "The last time when the project agreed to the terms of service.", - "format": "google-datetime", - "type": "string" - }, - "declineTime": { - "description": "The last time when the project declined or revoked the agreement to terms of service.", - "format": "google-datetime", - "type": "string" + "actions": { + "description": "Actions.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerStepAction" + }, + "type": "array" }, - "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`.", + "description": { + "description": "The description of the step.", "type": "string" }, "state": { - "description": "Whether the project has accepted/rejected the service terms or it is still pending.", + "description": "The state of the step.", "enum": [ "STATE_UNSPECIFIED", - "TERMS_ACCEPTED", - "TERMS_PENDING", - "TERMS_DECLINED" + "IN_PROGRESS", + "FAILED", + "SUCCEEDED" ], "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." + "Unknown.", + "Step is currently in progress.", + "Step currently failed.", + "Step has succeeded." ], "type": "string" }, - "version": { - "description": "The version string of the terms of service. For acceptable values, see the comments for id above.", + "thought": { + "description": "The thought of the step.", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1ProvisionProjectMetadata": { - "description": "Metadata associated with a project provision operation.", - "id": "GoogleCloudDiscoveryengineV1ProvisionProjectMetadata", - "properties": {}, + "GoogleCloudDiscoveryengineV1alphaAnswerStepAction": { + "description": "Action.", + "id": "GoogleCloudDiscoveryengineV1alphaAnswerStepAction", + "properties": { + "observation": { + "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservation", + "description": "Observation." + }, + "searchAction": { + "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionSearchAction", + "description": "Search action." + } + }, "type": "object" }, - "GoogleCloudDiscoveryengineV1PurgeCompletionSuggestionsMetadata": { - "description": "Metadata related to the progress of the PurgeCompletionSuggestions operation. This is returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1PurgeCompletionSuggestionsMetadata", + "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservation": { + "description": "Observation.", + "id": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservation", "properties": { - "createTime": { - "description": "Operation create time.", - "format": "google-datetime", - "type": "string" - }, - "updateTime": { - "description": "Operation last update time. If the operation is done, this is also the finish time.", - "format": "google-datetime", - "type": "string" + "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.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResult" + }, + "type": "array" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1PurgeCompletionSuggestionsResponse": { - "description": "Response message for CompletionService.PurgeCompletionSuggestions method.", - "id": "GoogleCloudDiscoveryengineV1PurgeCompletionSuggestionsResponse", + "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResult": { + "id": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResult", "properties": { - "errorSamples": { - "description": "A sample of errors encountered while processing the request.", + "chunkInfo": { + "description": "If citation_type is CHUNK_LEVEL_CITATION and chunk mode is on, populate chunk info.", "items": { - "$ref": "GoogleRpcStatus" + "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultChunkInfo" }, "type": "array" }, - "purgeSucceeded": { - "description": "Whether the completion suggestions were successfully purged.", - "type": "boolean" + "document": { + "description": "Document resource name.", + "type": "string" + }, + "snippetInfo": { + "description": "If citation_type is DOCUMENT_LEVEL_CITATION, populate document level snippets.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultSnippetInfo" + }, + "type": "array" + }, + "structData": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "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" + }, + "title": { + "description": "Title.", + "type": "string" + }, + "uri": { + "description": "URI for the document.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultChunkInfo": { + "description": "Chunk information.", + "id": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultChunkInfo", + "properties": { + "chunk": { + "description": "Chunk resource name.", + "type": "string" + }, + "content": { + "description": "Chunk textual content.", + "type": "string" + }, + "relevanceScore": { + "description": "Relevance score.", + "format": "float", + "type": "number" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1PurgeDocumentsMetadata": { - "description": "Metadata related to the progress of the PurgeDocuments operation. This will be returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1PurgeDocumentsMetadata", + "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultSnippetInfo": { + "description": "Snippet information.", + "id": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultSnippetInfo", "properties": { - "createTime": { - "description": "Operation create time.", - "format": "google-datetime", - "type": "string" - }, - "failureCount": { - "description": "Count of entries that encountered errors while processing.", - "format": "int64", - "type": "string" - }, - "ignoredCount": { - "description": "Count of entries that were ignored as entries were not found.", - "format": "int64", - "type": "string" - }, - "successCount": { - "description": "Count of entries that were deleted successfully.", - "format": "int64", + "snippet": { + "description": "Snippet content.", "type": "string" }, - "updateTime": { - "description": "Operation last update time. If the operation is done, this is also the finish time.", - "format": "google-datetime", + "snippetStatus": { + "description": "Status of the snippet defined by the search team.", "type": "string" } }, "type": "object" }, - "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.", - "id": "GoogleCloudDiscoveryengineV1PurgeDocumentsResponse", + "GoogleCloudDiscoveryengineV1alphaAnswerStepActionSearchAction": { + "description": "Search action.", + "id": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionSearchAction", "properties": { - "purgeCount": { - "description": "The total count of documents purged as a result of the operation.", - "format": "int64", + "query": { + "description": "The query to search.", "type": "string" - }, - "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.", - "items": { - "type": "string" - }, - "type": "array" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1PurgeSuggestionDenyListEntriesMetadata": { - "description": "Metadata related to the progress of the PurgeSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1PurgeSuggestionDenyListEntriesMetadata", + "GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSiteMetadata": { + "description": "Metadata related to the progress of the SiteSearchEngineService.BatchCreateTargetSites operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSiteMetadata", "properties": { "createTime": { "description": "Operation create time.", @@ -8258,1093 +9961,1349 @@ }, "type": "object" }, - "GoogleCloudDiscoveryengineV1PurgeSuggestionDenyListEntriesResponse": { - "description": "Response message for CompletionService.PurgeSuggestionDenyListEntries method.", - "id": "GoogleCloudDiscoveryengineV1PurgeSuggestionDenyListEntriesResponse", + "GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSitesRequest": { + "description": "Request message for SiteSearchEngineService.BatchCreateTargetSites method.", + "id": "GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSitesRequest", "properties": { - "errorSamples": { - "description": "A sample of errors encountered while processing the request.", + "requests": { + "description": "Required. The request message specifying the resources to create. A maximum of 20 TargetSites can be created in a batch.", "items": { - "$ref": "GoogleRpcStatus" + "$ref": "GoogleCloudDiscoveryengineV1alphaCreateTargetSiteRequest" }, "type": "array" - }, - "purgeCount": { - "description": "Number of suggestion deny list entries purged.", - "format": "int64", - "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1Schema": { - "description": "Defines the structure and layout of a type of document data.", - "id": "GoogleCloudDiscoveryengineV1Schema", + "GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSitesResponse": { + "description": "Response message for SiteSearchEngineService.BatchCreateTargetSites method.", + "id": "GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSitesResponse", "properties": { - "jsonSchema": { - "description": "The JSON representation of the schema.", + "targetSites": { + "description": "TargetSites created.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaTargetSite" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaBatchVerifyTargetSitesRequest": { + "description": "Request message for SiteSearchEngineService.BatchVerifyTargetSites method.", + "id": "GoogleCloudDiscoveryengineV1alphaBatchVerifyTargetSitesRequest", + "properties": {}, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaBigQuerySource": { + "description": "BigQuery source import data from.", + "id": "GoogleCloudDiscoveryengineV1alphaBigQuerySource", + "properties": { + "dataSchema": { + "description": "The schema to use when parsing the data from the source. Supported values for user event imports: * `user_event` (default): One UserEvent per row. Supported values for document imports: * `document` (default): One Document format per row. Each document must have a valid Document.id and one of Document.json_data or Document.struct_data. * `custom`: One custom data per row in arbitrary format that conforms to the defined Schema of the data store. This can only be used by the GENERIC Data Store vertical.", "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.", + "datasetId": { + "description": "Required. The BigQuery data set to copy the data from with a length limit of 1,024 characters.", "type": "string" }, - "structSchema": { + "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" + }, + "partitionDate": { + "$ref": "GoogleTypeDate", + "description": "BigQuery time partitioned table's _PARTITIONDATE in YYYY-MM-DD format." + }, + "projectId": { + "description": "The project ID (can be project # or ID) that the BigQuery source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request.", + "type": "string" + }, + "tableId": { + "description": "Required. The BigQuery table to copy the data from with a length limit of 1,024 characters.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaBigtableOptions": { + "description": "The Bigtable Options object that contains information to support the import.", + "id": "GoogleCloudDiscoveryengineV1alphaBigtableOptions", + "properties": { + "families": { "additionalProperties": { - "description": "Properties of the object.", - "type": "any" + "$ref": "GoogleCloudDiscoveryengineV1alphaBigtableOptionsBigtableColumnFamily" }, - "description": "The structured representation of the schema.", + "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" + }, + "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*`.", + "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1SiteVerificationInfo": { - "description": "Verification information for target sites in advanced site search.", - "id": "GoogleCloudDiscoveryengineV1SiteVerificationInfo", + "GoogleCloudDiscoveryengineV1alphaBigtableOptionsBigtableColumn": { + "description": "The column of the Bigtable.", + "id": "GoogleCloudDiscoveryengineV1alphaBigtableOptionsBigtableColumn", "properties": { - "siteVerificationState": { - "description": "Site verification state indicating the ownership and validity.", + "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.", "enum": [ - "SITE_VERIFICATION_STATE_UNSPECIFIED", - "VERIFIED", - "UNVERIFIED", - "EXEMPTED" + "ENCODING_UNSPECIFIED", + "TEXT", + "BINARY" ], "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." + "The encoding is unspecified.", + "Text encoding.", + "Binary encoding." ], "type": "string" }, - "verifyTime": { - "description": "Latest site verification time.", - "format": "google-datetime", + "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" - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1TargetSite": { - "description": "A target site for the SiteSearchEngine.", - "id": "GoogleCloudDiscoveryengineV1TargetSite", - "properties": { - "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" }, - "failureReason": { - "$ref": "GoogleCloudDiscoveryengineV1TargetSiteFailureReason", - "description": "Output only. Failure reason.", - "readOnly": true - }, - "generatedUriPattern": { - "description": "Output only. This is system-generated based on the provided_uri_pattern.", - "readOnly": true, + "qualifier": { + "description": "Required. Qualifier of the column. If it cannot be decoded with utf-8, use a base-64 encoded string instead.", + "format": "byte", "type": "string" }, - "indexingStatus": { - "description": "Output only. Indexing status.", + "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`.", "enum": [ - "INDEXING_STATUS_UNSPECIFIED", - "PENDING", - "FAILED", - "SUCCEEDED", - "DELETING" + "TYPE_UNSPECIFIED", + "STRING", + "NUMBER", + "INTEGER", + "VAR_INTEGER", + "BIG_NUMERIC", + "BOOLEAN", + "JSON" ], "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 type is unspecified.", + "String type.", + "Numerical type.", + "Integer type.", + "Variable length integer type.", + "BigDecimal type.", + "Boolean type.", + "JSON type." ], - "readOnly": true, - "type": "string" - }, - "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" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaBigtableOptionsBigtableColumnFamily": { + "description": "The column family of the Bigtable.", + "id": "GoogleCloudDiscoveryengineV1alphaBigtableOptionsBigtableColumnFamily", + "properties": { + "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.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaBigtableOptionsBigtableColumn" + }, + "type": "array" }, - "providedUriPattern": { - "description": "Required. Input only. The user provided URI pattern from which the `generated_uri_pattern` is generated.", + "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.", + "enum": [ + "ENCODING_UNSPECIFIED", + "TEXT", + "BINARY" + ], + "enumDescriptions": [ + "The encoding is unspecified.", + "Text encoding.", + "Binary encoding." + ], "type": "string" }, - "rootDomainUri": { - "description": "Output only. Root domain of the provided_uri_pattern.", - "readOnly": true, + "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" }, - "siteVerificationInfo": { - "$ref": "GoogleCloudDiscoveryengineV1SiteVerificationInfo", - "description": "Output only. Site ownership and validity verification status.", - "readOnly": true - }, "type": { - "description": "The type of the target site, e.g., whether the site is to be included or excluded.", + "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`.", "enum": [ "TYPE_UNSPECIFIED", - "INCLUDE", - "EXCLUDE" + "STRING", + "NUMBER", + "INTEGER", + "VAR_INTEGER", + "BIG_NUMERIC", + "BOOLEAN", + "JSON" ], "enumDescriptions": [ - "This value is unused. In this case, server behavior defaults to Type.INCLUDE.", - "Include the target site.", - "Exclude the target site." + "The type is unspecified.", + "String type.", + "Numerical type.", + "Integer type.", + "Variable length integer type.", + "BigDecimal type.", + "Boolean type.", + "JSON type." ], "type": "string" - }, - "updateTime": { - "description": "Output only. The target site's last updated time.", - "format": "google-datetime", - "readOnly": true, - "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1TargetSiteFailureReason": { - "description": "Site search indexing failure reasons.", - "id": "GoogleCloudDiscoveryengineV1TargetSiteFailureReason", + "GoogleCloudDiscoveryengineV1alphaBigtableSource": { + "description": "The Cloud Bigtable source for importing data.", + "id": "GoogleCloudDiscoveryengineV1alphaBigtableSource", "properties": { - "quotaFailure": { - "$ref": "GoogleCloudDiscoveryengineV1TargetSiteFailureReasonQuotaFailure", - "description": "Failed due to insufficient quota." + "bigtableOptions": { + "$ref": "GoogleCloudDiscoveryengineV1alphaBigtableOptions", + "description": "Required. Bigtable options that contains information needed when parsing data into typed structures. For example, column type annotations." + }, + "instanceId": { + "description": "Required. The instance ID of the Cloud Bigtable that needs to be imported.", + "type": "string" + }, + "projectId": { + "description": "The project ID that the Bigtable source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request.", + "type": "string" + }, + "tableId": { + "description": "Required. The table ID of the Cloud Bigtable that needs to be imported.", + "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1TargetSiteFailureReasonQuotaFailure": { - "description": "Failed due to insufficient quota.", - "id": "GoogleCloudDiscoveryengineV1TargetSiteFailureReasonQuotaFailure", + "GoogleCloudDiscoveryengineV1alphaCheckGroundingRequest": { + "description": "Request message for GroundedGenerationService.CheckGrounding method.", + "id": "GoogleCloudDiscoveryengineV1alphaCheckGroundingRequest", "properties": { - "totalRequiredQuota": { - "description": "This number is an estimation on how much total quota this project needs to successfully complete indexing.", - "format": "int64", + "answerCandidate": { + "description": "Answer candidate to check. Can have a maximum length of 1024 characters.", "type": "string" + }, + "facts": { + "description": "List of facts for the grounding check. We support up to 200 facts.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaGroundingFact" + }, + "type": "array" + }, + "groundingSpec": { + "$ref": "GoogleCloudDiscoveryengineV1alphaCheckGroundingSpec", + "description": "Configuration of the grounding check." + }, + "userLabels": { + "additionalProperties": { + "type": "string" + }, + "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" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1UpdateSchemaMetadata": { - "description": "Metadata for UpdateSchema LRO.", - "id": "GoogleCloudDiscoveryengineV1UpdateSchemaMetadata", + "GoogleCloudDiscoveryengineV1alphaCheckGroundingResponse": { + "description": "Response message for the GroundedGenerationService.CheckGrounding method.", + "id": "GoogleCloudDiscoveryengineV1alphaCheckGroundingResponse", "properties": { - "createTime": { - "description": "Operation create time.", - "format": "google-datetime", - "type": "string" + "citedChunks": { + "description": "List of facts cited across all claims in the answer candidate. These are derived from the facts supplied in the request.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaFactChunk" + }, + "type": "array" }, - "updateTime": { - "description": "Operation last update time. If the operation is done, this is also the finish time.", - "format": "google-datetime", - "type": "string" + "claims": { + "description": "Claim texts and citation info across all claims in the answer candidate.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaCheckGroundingResponseClaim" + }, + "type": "array" + }, + "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.", + "format": "float", + "type": "number" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1UpdateTargetSiteMetadata": { - "description": "Metadata related to the progress of the SiteSearchEngineService.UpdateTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1UpdateTargetSiteMetadata", + "GoogleCloudDiscoveryengineV1alphaCheckGroundingResponseClaim": { + "description": "Text and citation info for a claim in the answer candidate.", + "id": "GoogleCloudDiscoveryengineV1alphaCheckGroundingResponseClaim", "properties": { - "createTime": { - "description": "Operation create time.", - "format": "google-datetime", - "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.", + "items": { + "format": "int32", + "type": "integer" + }, + "type": "array" }, - "updateTime": { - "description": "Operation last update time. If the operation is done, this is also the finish time.", - "format": "google-datetime", + "claimText": { + "description": "Text for the claim in the answer candidate. Always provided regardless of whether citations or anti-citations are found.", "type": "string" + }, + "endPos": { + "description": "Position indicating the end of the claim in the answer candidate, exclusive.", + "format": "int32", + "type": "integer" + }, + "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, and anti_citation_indices should not be returned.", + "type": "boolean" + }, + "startPos": { + "description": "Position indicating the start of the claim in the answer candidate, measured in bytes.", + "format": "int32", + "type": "integer" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaAclConfig": { - "description": "Access Control Configuration.", - "id": "GoogleCloudDiscoveryengineV1alphaAclConfig", + "GoogleCloudDiscoveryengineV1alphaCheckGroundingSpec": { + "description": "Specification for the grounding check.", + "id": "GoogleCloudDiscoveryengineV1alphaCheckGroundingSpec", "properties": { - "idpConfig": { - "$ref": "GoogleCloudDiscoveryengineV1alphaIdpConfig", - "description": "Identity provider config." - }, - "name": { - "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" + "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.", + "format": "double", + "type": "number" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaAlloyDbSource": { - "description": "AlloyDB source import data from.", - "id": "GoogleCloudDiscoveryengineV1alphaAlloyDbSource", + "GoogleCloudDiscoveryengineV1alphaCheckRequirementRequest": { + "description": "Request for CheckRequirement method.", + "id": "GoogleCloudDiscoveryengineV1alphaCheckRequirementRequest", "properties": { - "clusterId": { - "description": "Required. The AlloyDB cluster to copy the data from with a length limit of 256 characters.", + "requirementType": { + "description": "The type specifying the requirement to check. The supported types are: * `discoveryengine.googleapis.com/media_recs/general/all/warning` * `discoveryengine.googleapis.com/media_recs/oyml/cvr/warning` * `discoveryengine.googleapis.com/media_recs/rfy/cvr/warning` * `discoveryengine.googleapis.com/media_recs/mlt/cvr/warning` * `discoveryengine.googleapis.com/media_recs/mp/cvr/warning` * `discoveryengine.googleapis.com/media_recs/oyml/wdps/warning` * `discoveryengine.googleapis.com/media_recs/rfy/wdps/warning` * `discoveryengine.googleapis.com/media_recs/mlt/wdps/warning`", "type": "string" }, - "databaseId": { - "description": "Required. The AlloyDB database to copy the data from with a length limit of 256 characters.", + "resources": { + "description": "The type needed for the monitored resources: * `discoveryengine.googleapis.com/Branch`. * The labels needed for this resource: * `project`_`number` * `location`_`id` * `collection`_`id` * `datastore`_`id` * `branch`_`id` * `discoveryengine.googleapis.com/DataStore` * The labels needed for this resource: * `project`_`number` * `location`_`id` * `collection`_`id` * `datastore`_`id`", + "items": { + "$ref": "GoogleApiMonitoredResource" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaCheckRequirementResponse": { + "description": "Response for the CheckRequirement method.", + "id": "GoogleCloudDiscoveryengineV1alphaCheckRequirementResponse", + "properties": { + "metricResults": { + "description": "Metric results.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaCheckRequirementResponseMetricQueryResult" + }, + "type": "array" + }, + "oldestMetricTimestamp": { + "description": "Timestamp of the oldest calculated metric (i.e. the most stale metric). Indicates that the `requirement_result` may not accurately reflect any Event and Product Catalog updates performed after this time.", + "format": "google-datetime", "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.", + "requirement": { + "$ref": "GoogleCloudDiscoveryengineV1alphaRequirement", + "description": "Requirement definition." + }, + "requirementCondition": { + "$ref": "GoogleTypeExpr", + "description": "The condition for evaluating the requirement result." + }, + "requirementResult": { + "description": "Requirement result, e.g. pass or fail.", + "enum": [ + "UNKNOWN", + "SUCCESS", + "FAILURE", + "WARNING" + ], + "enumDescriptions": [ + "The requirement is unknown.", + "The requirement check is passed.", + "The requirement check fails to meet at least one blocking threshold.", + "The requirement check fails at least one warning threshold, but passes all blocking thresholds." + ], + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaCheckRequirementResponseMetricQueryResult": { + "description": "Metric result. The metric are in the requirement_condition.", + "id": "GoogleCloudDiscoveryengineV1alphaCheckRequirementResponseMetricQueryResult", + "properties": { + "metricType": { + "description": "Type identifier of the metric corresponding to this query result.", "type": "string" }, - "locationId": { - "description": "Required. The AlloyDB location to copy the data from with a length limit of 256 characters.", + "name": { + "description": "This metric query name is mapping to variables in the requirement_condition.", "type": "string" }, - "projectId": { - "description": "The project ID that the AlloyDB source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request.", + "timestamp": { + "description": "Time corresponding to when this metric value was calculated.", + "format": "google-datetime", "type": "string" }, - "tableId": { - "description": "Required. The AlloyDB table to copy the data from with a length limit of 256 characters.", + "unit": { + "description": "The unit in which this metric is reported. Follows [The Unified Code for Units of Measure](https://unitsofmeasure.org/ucum.html) standard.", "type": "string" + }, + "value": { + "$ref": "GoogleMonitoringV3TypedValue", + "description": "Value of the metric query." } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaAnswer": { - "description": "Defines an answer.", - "id": "GoogleCloudDiscoveryengineV1alphaAnswer", + "GoogleCloudDiscoveryengineV1alphaChunk": { + "description": "Chunk captures all raw metadata information of items to be recommended or searched in the chunk mode.", + "id": "GoogleCloudDiscoveryengineV1alphaChunk", "properties": { - "answerSkippedReasons": { - "description": "Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set.", - "items": { - "enum": [ - "ANSWER_SKIPPED_REASON_UNSPECIFIED", - "ADVERSARIAL_QUERY_IGNORED", - "NON_ANSWER_SEEKING_QUERY_IGNORED", - "OUT_OF_DOMAIN_QUERY_IGNORED", - "POTENTIAL_POLICY_VIOLATION", - "NO_RELEVANT_CONTENT" - ], - "enumDescriptions": [ - "Default value. The answer skipped reason is not specified.", - "The adversarial query ignored case.", - "The non-answer seeking query ignored case.", - "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." - ], - "type": "string" - }, - "type": "array" + "chunkMetadata": { + "$ref": "GoogleCloudDiscoveryengineV1alphaChunkChunkMetadata", + "description": "Output only. Metadata of the current chunk.", + "readOnly": true }, - "answerText": { - "description": "The textual answer.", + "content": { + "description": "Content is a string from a document (parsed content).", "type": "string" }, - "citations": { - "description": "Citations.", - "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerCitation" + "derivedStructData": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" }, - "type": "array" - }, - "completeTime": { - "description": "Output only. Answer completed timestamp.", - "format": "google-datetime", + "description": "Output only. This field is OUTPUT_ONLY. It contains derived data that are not in the original input document.", "readOnly": true, - "type": "string" + "type": "object" }, - "createTime": { - "description": "Output only. Answer creation timestamp.", - "format": "google-datetime", - "readOnly": true, + "documentMetadata": { + "$ref": "GoogleCloudDiscoveryengineV1alphaChunkDocumentMetadata", + "description": "Metadata of the document from the current chunk." + }, + "id": { + "description": "Unique chunk ID of the current chunk.", "type": "string" }, "name": { - "description": "Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*/answers/*`", + "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" }, - "queryUnderstandingInfo": { - "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfo", - "description": "Query understanding information." - }, - "references": { - "description": "References.", - "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerReference" - }, - "type": "array" + "pageSpan": { + "$ref": "GoogleCloudDiscoveryengineV1alphaChunkPageSpan", + "description": "Page span of the chunk." }, - "relatedQuestions": { - "description": "Suggested related questions.", + "relevanceScore": { + "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.", + "format": "double", + "readOnly": true, + "type": "number" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaChunkChunkMetadata": { + "description": "Metadata of the current chunk. This field is only populated on SearchService.Search API.", + "id": "GoogleCloudDiscoveryengineV1alphaChunkChunkMetadata", + "properties": { + "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.", "items": { - "type": "string" + "$ref": "GoogleCloudDiscoveryengineV1alphaChunk" }, "type": "array" }, - "state": { - "description": "The state of the answer generation.", - "enum": [ - "STATE_UNSPECIFIED", - "IN_PROGRESS", - "FAILED", - "SUCCEEDED" - ], - "enumDescriptions": [ - "Unknown.", - "Answer generation is currently in progress.", - "Answer generation currently failed.", - "Answer generation has succeeded." - ], - "type": "string" - }, - "steps": { - "description": "Answer generation steps.", + "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.", "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerStep" + "$ref": "GoogleCloudDiscoveryengineV1alphaChunk" }, "type": "array" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaAnswerCitation": { - "description": "Citation info for a segment.", - "id": "GoogleCloudDiscoveryengineV1alphaAnswerCitation", + "GoogleCloudDiscoveryengineV1alphaChunkDocumentMetadata": { + "description": "Document metadata contains the information of the document of the current chunk.", + "id": "GoogleCloudDiscoveryengineV1alphaChunkDocumentMetadata", "properties": { - "endIndex": { - "description": "End of the attributed segment, exclusive.", - "format": "int64", - "type": "string" - }, - "sources": { - "description": "Citation sources for the attributed segment.", - "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerCitationSource" + "structData": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" }, - "type": "array" + "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" }, - "startIndex": { - "description": "Index indicates the start of the segment, measured in bytes (UTF-8 unicode).", - "format": "int64", + "title": { + "description": "Title of the document.", "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1alphaAnswerCitationSource": { - "description": "Citation source.", - "id": "GoogleCloudDiscoveryengineV1alphaAnswerCitationSource", - "properties": { - "referenceId": { - "description": "ID of the citation source.", + }, + "uri": { + "description": "Uri of the document.", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequest": { - "description": "Request message for ConversationalSearchService.AnswerQuery method.", - "id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequest", + "GoogleCloudDiscoveryengineV1alphaChunkPageSpan": { + "description": "Page span of the chunk.", + "id": "GoogleCloudDiscoveryengineV1alphaChunkPageSpan", "properties": { - "answerGenerationSpec": { - "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestAnswerGenerationSpec", - "description": "Answer generation specification." - }, - "asynchronousMode": { - "description": "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.", - "type": "boolean" - }, - "query": { - "$ref": "GoogleCloudDiscoveryengineV1alphaQuery", - "description": "Required. Current user query." - }, - "queryUnderstandingSpec": { - "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestQueryUnderstandingSpec", - "description": "Query understanding specification." - }, - "relatedQuestionsSpec": { - "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestRelatedQuestionsSpec", - "description": "Related questions specification." - }, - "safetySpec": { - "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSafetySpec", - "description": "Model specification." - }, - "searchSpec": { - "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpec", - "description": "Search specification." - }, - "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.", - "type": "string" - }, - "userLabels": { - "additionalProperties": { - "type": "string" - }, - "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" + "pageEnd": { + "description": "The end page of the chunk.", + "format": "int32", + "type": "integer" }, - "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" + "pageStart": { + "description": "The start page of the chunk.", + "format": "int32", + "type": "integer" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestAnswerGenerationSpec": { - "description": "Answer generation specification.", - "id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestAnswerGenerationSpec", + "GoogleCloudDiscoveryengineV1alphaCloudSqlSource": { + "description": "Cloud SQL source import data from.", + "id": "GoogleCloudDiscoveryengineV1alphaCloudSqlSource", "properties": { - "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.", + "databaseId": { + "description": "Required. The Cloud SQL database to copy the data from with a length limit of 256 characters.", "type": "string" }, - "ignoreAdversarialQuery": { - "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" - }, - "ignoreLowRelevantContent": { - "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" + "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.", + "type": "string" }, - "ignoreNonAnswerSeekingQuery": { - "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.", - "type": "boolean" + "instanceId": { + "description": "Required. The Cloud SQL instance to copy the data from with a length limit of 256 characters.", + "type": "string" }, - "includeCitations": { - "description": "Specifies whether to include citation metadata in the answer. The default value is `false`.", + "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" }, - "modelSpec": { - "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestAnswerGenerationSpecModelSpec", - "description": "Answer generation model specification." - }, - "promptSpec": { - "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestAnswerGenerationSpecPromptSpec", - "description": "Answer generation prompt specification." + "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" + }, + "tableId": { + "description": "Required. The Cloud SQL table to copy the data from with a length limit of 256 characters.", + "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestAnswerGenerationSpecModelSpec": { - "description": "Answer Generation Model specification.", - "id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestAnswerGenerationSpecModelSpec", + "GoogleCloudDiscoveryengineV1alphaCompleteQueryResponse": { + "description": "Response message for CompletionService.CompleteQuery method.", + "id": "GoogleCloudDiscoveryengineV1alphaCompleteQueryResponse", "properties": { - "modelVersion": { - "description": "Model version. If not set, it will use the default stable model. Allowed values are: stable, preview.", - "type": "string" + "querySuggestions": { + "description": "Results of the matched query suggestions. The result list is ordered and the first result is a top suggestion.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaCompleteQueryResponseQuerySuggestion" + }, + "type": "array" + }, + "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" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestAnswerGenerationSpecPromptSpec": { - "description": "Answer generation prompt specification.", - "id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestAnswerGenerationSpecPromptSpec", + "GoogleCloudDiscoveryengineV1alphaCompleteQueryResponseQuerySuggestion": { + "description": "Suggestions as search queries.", + "id": "GoogleCloudDiscoveryengineV1alphaCompleteQueryResponseQuerySuggestion", "properties": { - "preamble": { - "description": "Customized preamble.", + "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.", + "items": { + "type": "string" + }, + "type": "array" + }, + "suggestion": { + "description": "The suggestion for the query.", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestQueryUnderstandingSpec": { - "description": "Query understanding specification.", - "id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestQueryUnderstandingSpec", + "GoogleCloudDiscoveryengineV1alphaCompletionInfo": { + "description": "Detailed completion information including completion attribution token and clicked completion info.", + "id": "GoogleCloudDiscoveryengineV1alphaCompletionInfo", "properties": { - "queryClassificationSpec": { - "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestQueryUnderstandingSpecQueryClassificationSpec", - "description": "Query classification specification." + "selectedPosition": { + "description": "End user selected CompleteQueryResponse.QuerySuggestion.suggestion position, starting from 0.", + "format": "int32", + "type": "integer" }, - "queryRephraserSpec": { - "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestQueryUnderstandingSpecQueryRephraserSpec", - "description": "Query rephraser specification." + "selectedSuggestion": { + "description": "End user selected CompleteQueryResponse.QuerySuggestion.suggestion.", + "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestQueryUnderstandingSpecQueryClassificationSpec": { - "description": "Query classification specification.", - "id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestQueryUnderstandingSpecQueryClassificationSpec", + "GoogleCloudDiscoveryengineV1alphaCompletionSuggestion": { + "description": "Autocomplete suggestions that are imported from Customer.", + "id": "GoogleCloudDiscoveryengineV1alphaCompletionSuggestion", "properties": { - "types": { - "description": "Enabled query classification types.", + "alternativePhrases": { + "description": "Alternative matching phrases for this suggestion.", "items": { - "enum": [ - "TYPE_UNSPECIFIED", - "ADVERSARIAL_QUERY", - "NON_ANSWER_SEEKING_QUERY" - ], - "enumDescriptions": [ - "Unspecified query classification type.", - "Adversarial query classification type.", - "Non-answer-seeking query classification type." - ], "type": "string" }, "type": "array" - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestQueryUnderstandingSpecQueryRephraserSpec": { - "description": "Query rephraser specification.", - "id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestQueryUnderstandingSpecQueryRephraserSpec", - "properties": { - "disable": { - "description": "Disable query rephraser.", - "type": "boolean" }, - "maxRephraseSteps": { - "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.", - "format": "int32", - "type": "integer" + "frequency": { + "description": "Frequency of this suggestion. Will be used to rank suggestions when score is not available.", + "format": "int64", + "type": "string" + }, + "globalScore": { + "description": "Global score of this suggestion. Control how this suggestion would be scored / ranked.", + "format": "double", + "type": "number" + }, + "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" + }, + "groupScore": { + "description": "The score of this suggestion within its group.", + "format": "double", + "type": "number" + }, + "languageCode": { + "description": "BCP-47 language code of this suggestion.", + "type": "string" + }, + "suggestion": { + "description": "Required. The suggestion text.", + "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestRelatedQuestionsSpec": { - "description": "Related questions specification.", - "id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestRelatedQuestionsSpec", + "GoogleCloudDiscoveryengineV1alphaCondition": { + "description": "Defines circumstances to be checked before allowing a behavior", + "id": "GoogleCloudDiscoveryengineV1alphaCondition", "properties": { - "enable": { - "description": "Enable related questions feature if true.", - "type": "boolean" + "activeTimeRange": { + "description": "Range of time(s) specifying when condition is active. Maximum of 10 time ranges.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaConditionTimeRange" + }, + "type": "array" + }, + "queryTerms": { + "description": "Search only A list of terms to match the query on. Maximum of 10 query terms.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaConditionQueryTerm" + }, + "type": "array" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSafetySpec": { - "description": "Safety specification.", - "id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSafetySpec", + "GoogleCloudDiscoveryengineV1alphaConditionQueryTerm": { + "description": "Matcher for search request query", + "id": "GoogleCloudDiscoveryengineV1alphaConditionQueryTerm", "properties": { - "enable": { - "description": "Enable the safety filtering on the answer response. It is false by default.", + "fullMatch": { + "description": "Whether the search query needs to exactly match the query term.", "type": "boolean" + }, + "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" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpec": { - "description": "Search specification.", - "id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpec", + "GoogleCloudDiscoveryengineV1alphaConditionTimeRange": { + "description": "Used for time-dependent conditions.", + "id": "GoogleCloudDiscoveryengineV1alphaConditionTimeRange", "properties": { - "searchParams": { - "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchParams", - "description": "Search parameters." + "endTime": { + "description": "End of time range. Range is inclusive. Must be in the future.", + "format": "google-datetime", + "type": "string" }, - "searchResultList": { - "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultList", - "description": "Search result list." + "startTime": { + "description": "Start of time range. Range is inclusive.", + "format": "google-datetime", + "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchParams": { - "description": "Search parameters.", - "id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchParams", + "GoogleCloudDiscoveryengineV1alphaControl": { + "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`.", + "id": "GoogleCloudDiscoveryengineV1alphaControl", "properties": { - "boostSpec": { - "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpec", - "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)" + "associatedServingConfigIds": { + "description": "Output only. List of all ServingConfig ids this control is attached to. May take up to 10 minutes to update after changes.", + "items": { + "type": "string" + }, + "readOnly": true, + "type": "array" }, - "customFineTuningSpec": { - "$ref": "GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec", - "description": "Custom fine tuning configs." + "boostAction": { + "$ref": "GoogleCloudDiscoveryengineV1alphaControlBoostAction", + "description": "Defines a boost-type control" }, - "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.", + "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.", "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec" + "$ref": "GoogleCloudDiscoveryengineV1alphaCondition" }, "type": "array" }, - "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)", + "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" }, - "maxReturnResults": { - "description": "Number of search results to return. The default value is 10.", - "format": "int32", - "type": "integer" + "filterAction": { + "$ref": "GoogleCloudDiscoveryengineV1alphaControlFilterAction", + "description": "Defines a filter-type control Currently not supported by Recommendation" }, - "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.", + "name": { + "description": "Immutable. Fully qualified name `projects/*/locations/global/dataStore/*/controls/*`", "type": "string" }, - "searchResultMode": { - "description": "Specifies the search result mode. If unspecified, the search result mode is based on DataStore.DocumentProcessingConfig.chunking_config: * If DataStore.DocumentProcessingConfig.chunking_config is specified, it defaults to `CHUNKS`. * Otherwise, it defaults to `DOCUMENTS`. See [parse and chunk documents](https://cloud.google.com/generative-ai-app-builder/docs/parse-chunk-documents)", + "redirectAction": { + "$ref": "GoogleCloudDiscoveryengineV1alphaControlRedirectAction", + "description": "Defines a redirect-type control." + }, + "solutionType": { + "description": "Required. Immutable. What solution the control belongs to. Must be compatible with vertical of resource. Otherwise an INVALID ARGUMENT error is thrown.", "enum": [ - "SEARCH_RESULT_MODE_UNSPECIFIED", - "DOCUMENTS", - "CHUNKS" - ], - "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." + "SOLUTION_TYPE_UNSPECIFIED", + "SOLUTION_TYPE_RECOMMENDATION", + "SOLUTION_TYPE_SEARCH", + "SOLUTION_TYPE_CHAT", + "SOLUTION_TYPE_GENERATIVE_CHAT" ], - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultList": { - "description": "Search result list.", - "id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultList", - "properties": { - "searchResults": { - "description": "Search results.", + "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." + ], + "type": "string" + }, + "synonymsAction": { + "$ref": "GoogleCloudDiscoveryengineV1alphaControlSynonymsAction", + "description": "Treats a group of terms as synonyms of one another." + }, + "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.", "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResult" + "enum": [ + "SEARCH_USE_CASE_UNSPECIFIED", + "SEARCH_USE_CASE_SEARCH", + "SEARCH_USE_CASE_BROWSE" + ], + "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." + ], + "type": "string" }, "type": "array" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResult": { - "description": "Search result.", - "id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResult", + "GoogleCloudDiscoveryengineV1alphaControlBoostAction": { + "description": "Adjusts order of products in returned list.", + "id": "GoogleCloudDiscoveryengineV1alphaControlBoostAction", "properties": { - "chunkInfo": { - "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultChunkInfo", - "description": "Chunk information." + "boost": { + "description": "Required. Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0 (No-op).", + "format": "float", + "type": "number" }, - "unstructuredDocumentInfo": { - "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfo", - "description": "Unstructured document information." + "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" + }, + "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" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultChunkInfo": { - "description": "Chunk information.", - "id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultChunkInfo", + "GoogleCloudDiscoveryengineV1alphaControlFilterAction": { + "description": "Specified which products may be included in results. Uses same filter as boost.", + "id": "GoogleCloudDiscoveryengineV1alphaControlFilterAction", "properties": { - "chunk": { - "description": "Chunk resource name.", + "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" }, - "content": { - "description": "Chunk textual content.", + "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" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfo": { - "description": "Unstructured document information.", - "id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfo", + "GoogleCloudDiscoveryengineV1alphaControlRedirectAction": { + "description": "Redirects a shopper to the provided URI.", + "id": "GoogleCloudDiscoveryengineV1alphaControlRedirectAction", "properties": { - "document": { - "description": "Document resource name.", + "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" - }, - "documentContexts": { - "description": "List of document contexts.", - "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoDocumentContext" - }, - "type": "array" - }, - "extractiveAnswers": { - "description": "List of extractive answers.", + } + }, + "type": "object" + }, + "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\".", + "id": "GoogleCloudDiscoveryengineV1alphaControlSynonymsAction", + "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.", "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoExtractiveAnswer" + "type": "string" }, "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaConversation": { + "description": "External conversation proto definition.", + "id": "GoogleCloudDiscoveryengineV1alphaConversation", + "properties": { + "endTime": { + "description": "Output only. The time the conversation finished.", + "format": "google-datetime", + "readOnly": true, + "type": "string" }, - "extractiveSegments": { - "description": "List of extractive segments.", + "messages": { + "description": "Conversation messages.", "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoExtractiveSegment" + "$ref": "GoogleCloudDiscoveryengineV1alphaConversationMessage" }, "type": "array" }, - "title": { - "description": "Title.", + "name": { + "description": "Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/dataStore/*/conversations/*` or `projects/{project}/locations/global/collections/{collection}/engines/*/conversations/*`.", "type": "string" }, - "uri": { - "description": "URI for the document.", + "startTime": { + "description": "Output only. The time the conversation started.", + "format": "google-datetime", + "readOnly": true, "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoDocumentContext": { - "description": "Document context.", - "id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoDocumentContext", - "properties": { - "content": { - "description": "Document content.", + }, + "state": { + "description": "The state of the Conversation.", + "enum": [ + "STATE_UNSPECIFIED", + "IN_PROGRESS", + "COMPLETED" + ], + "enumDescriptions": [ + "Unknown.", + "Conversation is currently open.", + "Conversation has been completed." + ], "type": "string" }, - "pageIdentifier": { - "description": "Page identifier.", + "userPseudoId": { + "description": "A unique identifier for tracking users.", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoExtractiveAnswer": { - "description": "Extractive answer. [Guide](https://cloud.google.com/generative-ai-app-builder/docs/snippets#get-answers)", - "id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoExtractiveAnswer", + "GoogleCloudDiscoveryengineV1alphaConversationContext": { + "description": "Defines context of the conversation", + "id": "GoogleCloudDiscoveryengineV1alphaConversationContext", "properties": { - "content": { - "description": "Extractive answer content.", + "activeDocument": { + "description": "The current active document the user opened. It contains the document resource reference.", "type": "string" }, - "pageIdentifier": { - "description": "Page identifier.", - "type": "string" + "contextDocuments": { + "description": "The current list of documents the user is seeing. It contains the document resource references.", + "items": { + "type": "string" + }, + "type": "array" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoExtractiveSegment": { - "description": "Extractive segment. [Guide](https://cloud.google.com/generative-ai-app-builder/docs/snippets#extractive-segments)", - "id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoExtractiveSegment", + "GoogleCloudDiscoveryengineV1alphaConversationMessage": { + "description": "Defines a conversation message.", + "id": "GoogleCloudDiscoveryengineV1alphaConversationMessage", "properties": { - "content": { - "description": "Extractive segment content.", + "createTime": { + "description": "Output only. Message creation timestamp.", + "format": "google-datetime", + "readOnly": true, "type": "string" }, - "pageIdentifier": { - "description": "Page identifier.", - "type": "string" + "reply": { + "$ref": "GoogleCloudDiscoveryengineV1alphaReply", + "description": "Search reply." + }, + "userInput": { + "$ref": "GoogleCloudDiscoveryengineV1alphaTextInput", + "description": "User text input." } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaAnswerQueryResponse": { - "description": "Response message for ConversationalSearchService.AnswerQuery method.", - "id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryResponse", + "GoogleCloudDiscoveryengineV1alphaConverseConversationRequest": { + "description": "Request message for ConversationalSearchService.ConverseConversation method.", + "id": "GoogleCloudDiscoveryengineV1alphaConverseConversationRequest", "properties": { - "answer": { - "$ref": "GoogleCloudDiscoveryengineV1alphaAnswer", - "description": "Answer resource object. If AnswerQueryRequest.StepSpec.max_step_count is greater than 1, use Answer.name to fetch answer information using ConversationalSearchService.GetAnswer API." + "boostSpec": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpec", + "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)" }, - "answerQueryToken": { - "description": "A global unique ID used for logging.", + "conversation": { + "$ref": "GoogleCloudDiscoveryengineV1alphaConversation", + "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." + }, + "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" }, - "session": { - "$ref": "GoogleCloudDiscoveryengineV1alphaSession", - "description": "Session resource object. It will be only available when session field is set and valid in the AnswerQueryRequest request." + "query": { + "$ref": "GoogleCloudDiscoveryengineV1alphaTextInput", + "description": "Required. Current user input." + }, + "safeSearch": { + "description": "Whether to turn on safe search.", + "type": "boolean" + }, + "servingConfig": { + "description": "The resource name of the Serving Config to use. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/servingConfigs/{serving_config_id}` If this is not set, the default serving config will be used.", + "type": "string" + }, + "summarySpec": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpec", + "description": "A specification for configuring the summary returned in the response." + }, + "userLabels": { + "additionalProperties": { + "type": "string" + }, + "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" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfo": { - "description": "Query understanding information.", - "id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfo", + "GoogleCloudDiscoveryengineV1alphaConverseConversationResponse": { + "description": "Response message for ConversationalSearchService.ConverseConversation method.", + "id": "GoogleCloudDiscoveryengineV1alphaConverseConversationResponse", "properties": { - "queryClassificationInfo": { - "description": "Query classification information.", + "conversation": { + "$ref": "GoogleCloudDiscoveryengineV1alphaConversation", + "description": "Updated conversation including the answer." + }, + "relatedQuestions": { + "description": "Suggested related questions.", + "items": { + "type": "string" + }, + "type": "array" + }, + "reply": { + "$ref": "GoogleCloudDiscoveryengineV1alphaReply", + "description": "Answer to the current query." + }, + "searchResults": { + "description": "Search Results.", "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfoQueryClassificationInfo" + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseSearchResult" }, "type": "array" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfoQueryClassificationInfo": { - "description": "Query classification information.", - "id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfoQueryClassificationInfo", + "GoogleCloudDiscoveryengineV1alphaCreateDataStoreMetadata": { + "description": "Metadata related to the progress of the DataStoreService.CreateDataStore operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1alphaCreateDataStoreMetadata", "properties": { - "positive": { - "description": "Classification output.", - "type": "boolean" + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", + "type": "string" }, - "type": { - "description": "Query classification type.", - "enum": [ - "TYPE_UNSPECIFIED", - "ADVERSARIAL_QUERY", - "NON_ANSWER_SEEKING_QUERY" - ], - "enumDescriptions": [ - "Unspecified query classification type.", - "Adversarial query classification type.", - "Non-answer-seeking query classification type." - ], + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaAnswerReference": { - "description": "Reference.", - "id": "GoogleCloudDiscoveryengineV1alphaAnswerReference", + "GoogleCloudDiscoveryengineV1alphaCreateEngineMetadata": { + "description": "Metadata related to the progress of the EngineService.CreateEngine operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1alphaCreateEngineMetadata", "properties": { - "chunkInfo": { - "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfo", - "description": "Chunk information." + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", + "type": "string" }, - "unstructuredDocumentInfo": { - "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfo", - "description": "Unstructured document information." + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", + "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfo": { - "description": "Chunk information.", - "id": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfo", + "GoogleCloudDiscoveryengineV1alphaCreateEvaluationMetadata": { + "description": "Metadata for EvaluationService.CreateEvaluation method.", + "id": "GoogleCloudDiscoveryengineV1alphaCreateEvaluationMetadata", + "properties": {}, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaCreateSchemaMetadata": { + "description": "Metadata for Create Schema LRO.", + "id": "GoogleCloudDiscoveryengineV1alphaCreateSchemaMetadata", "properties": { - "chunk": { - "description": "Chunk resource name.", + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", "type": "string" }, - "content": { - "description": "Chunk textual content.", + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", "type": "string" - }, - "documentMetadata": { - "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfoDocumentMetadata", - "description": "Document metadata." - }, - "relevanceScore": { - "description": "Relevance score.", - "format": "float", - "type": "number" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfoDocumentMetadata": { - "description": "Document metadata.", - "id": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfoDocumentMetadata", + "GoogleCloudDiscoveryengineV1alphaCreateTargetSiteMetadata": { + "description": "Metadata related to the progress of the SiteSearchEngineService.CreateTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1alphaCreateTargetSiteMetadata", "properties": { - "document": { - "description": "Document resource name.", + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", "type": "string" }, - "pageIdentifier": { - "description": "Page identifier.", + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", "type": "string" - }, - "structData": { - "additionalProperties": { - "description": "Properties of the object.", - "type": "any" - }, - "description": "The structured JSON metadata for the document. It is populated from the struct data from the Chunk in search result.", - "type": "object" - }, - "title": { - "description": "Title.", + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaCreateTargetSiteRequest": { + "description": "Request message for SiteSearchEngineService.CreateTargetSite method.", + "id": "GoogleCloudDiscoveryengineV1alphaCreateTargetSiteRequest", + "properties": { + "parent": { + "description": "Required. Parent resource name of TargetSite, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine`.", "type": "string" }, - "uri": { - "description": "URI for the document.", - "type": "string" + "targetSite": { + "$ref": "GoogleCloudDiscoveryengineV1alphaTargetSite", + "description": "Required. The TargetSite to create." } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfo": { - "description": "Unstructured document information.", - "id": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfo", + "GoogleCloudDiscoveryengineV1alphaCustomAttribute": { + "description": "A custom attribute that is not explicitly modeled in a resource, e.g. UserEvent.", + "id": "GoogleCloudDiscoveryengineV1alphaCustomAttribute", "properties": { - "chunkContents": { - "description": "List of cited chunk contents derived from document content.", + "numbers": { + "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.", "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfoChunkContent" + "format": "double", + "type": "number" }, "type": "array" }, - "document": { - "description": "Document resource name.", + "text": { + "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.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec": { + "description": "Defines custom fine tuning spec.", + "id": "GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec", + "properties": { + "enableSearchAdaptor": { + "description": "Whether or not to enable and include custom fine tuned search adaptor model.", + "type": "boolean" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaCustomTuningModel": { + "description": "Metadata that describes a custom tuned model.", + "id": "GoogleCloudDiscoveryengineV1alphaCustomTuningModel", + "properties": { + "createTime": { + "deprecated": true, + "description": "Timestamp the Model was created at.", + "format": "google-datetime", "type": "string" }, - "structData": { + "displayName": { + "description": "The display name of the model.", + "type": "string" + }, + "metrics": { "additionalProperties": { - "description": "Properties of the object.", - "type": "any" + "format": "double", + "type": "number" }, - "description": "The structured JSON metadata for the document. It is populated from the struct data from the Chunk in search result.", + "description": "The metrics of the trained model.", "type": "object" }, - "title": { - "description": "Title.", + "modelState": { + "description": "The state that the model is in (e.g.`TRAINING` or `TRAINING_FAILED`).", + "enum": [ + "MODEL_STATE_UNSPECIFIED", + "TRAINING_PAUSED", + "TRAINING", + "TRAINING_COMPLETE", + "READY_FOR_SERVING", + "TRAINING_FAILED", + "NO_IMPROVEMENT" + ], + "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." + ], "type": "string" }, - "uri": { - "description": "URI for the document.", + "modelVersion": { + "description": "The version of the model.", + "format": "int64", "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfoChunkContent": { - "description": "Chunk content.", - "id": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfoChunkContent", - "properties": { - "content": { - "description": "Chunk textual content.", + }, + "name": { + "description": "Required. The fully qualified resource name of the model. Format: `projects/{project_number}/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" }, - "pageIdentifier": { - "description": "Page identifier.", + "trainingStartTime": { + "description": "Timestamp the model training was initiated.", + "format": "google-datetime", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaAnswerStep": { - "description": "Step information.", - "id": "GoogleCloudDiscoveryengineV1alphaAnswerStep", + "GoogleCloudDiscoveryengineV1alphaDataStore": { + "description": "DataStore captures global settings and configs at the DataStore level.", + "id": "GoogleCloudDiscoveryengineV1alphaDataStore", "properties": { - "actions": { - "description": "Actions.", - "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerStepAction" - }, - "type": "array" + "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" + }, + "contentConfig": { + "description": "Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT.", + "enum": [ + "CONTENT_CONFIG_UNSPECIFIED", + "NO_CONTENT", + "CONTENT_REQUIRED", + "PUBLIC_WEBSITE" + ], + "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." + ], + "type": "string" + }, + "createTime": { + "description": "Output only. Timestamp the DataStore was created at.", + "format": "google-datetime", + "readOnly": true, + "type": "string" }, - "description": { - "description": "The description of the step.", + "defaultSchemaId": { + "description": "Output only. The id of the default Schema asscociated to this data store.", + "readOnly": true, "type": "string" }, - "state": { - "description": "The state of the step.", + "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" + }, + "documentProcessingConfig": { + "$ref": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig", + "description": "Configuration for Document understanding and enrichment." + }, + "idpConfig": { + "$ref": "GoogleCloudDiscoveryengineV1alphaIdpConfig", + "description": "Output only. Data store level identity provider config.", + "readOnly": true + }, + "industryVertical": { + "description": "Immutable. The industry vertical that the data store registers.", "enum": [ - "STATE_UNSPECIFIED", - "IN_PROGRESS", - "FAILED", - "SUCCEEDED" + "INDUSTRY_VERTICAL_UNSPECIFIED", + "GENERIC", + "MEDIA", + "HEALTHCARE_FHIR" ], "enumDescriptions": [ - "Unknown.", - "Step is currently in progress.", - "Step currently failed.", - "Step has succeeded." + "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." ], "type": "string" }, - "thought": { - "description": "The thought of the step.", + "languageInfo": { + "$ref": "GoogleCloudDiscoveryengineV1alphaLanguageInfo", + "description": "Language info for DataStore." + }, + "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" - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1alphaAnswerStepAction": { - "description": "Action.", - "id": "GoogleCloudDiscoveryengineV1alphaAnswerStepAction", - "properties": { - "observation": { - "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservation", - "description": "Observation." }, - "searchAction": { - "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionSearchAction", - "description": "Search action." - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservation": { - "description": "Observation.", - "id": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservation", - "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.", + "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.", "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResult" + "enum": [ + "SOLUTION_TYPE_UNSPECIFIED", + "SOLUTION_TYPE_RECOMMENDATION", + "SOLUTION_TYPE_SEARCH", + "SOLUTION_TYPE_CHAT", + "SOLUTION_TYPE_GENERATIVE_CHAT" + ], + "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." + ], + "type": "string" }, "type": "array" + }, + "startingSchema": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSchema", + "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)." } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResult": { - "id": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResult", + "GoogleCloudDiscoveryengineV1alphaDeleteDataStoreMetadata": { + "description": "Metadata related to the progress of the DataStoreService.DeleteDataStore operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1alphaDeleteDataStoreMetadata", "properties": { - "chunkInfo": { - "description": "If citation_type is CHUNK_LEVEL_CITATION and chunk mode is on, populate chunk info.", - "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultChunkInfo" - }, - "type": "array" - }, - "document": { - "description": "Document resource name.", - "type": "string" - }, - "snippetInfo": { - "description": "If citation_type is DOCUMENT_LEVEL_CITATION, populate document level snippets.", - "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultSnippetInfo" - }, - "type": "array" - }, - "title": { - "description": "Title.", + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", "type": "string" }, - "uri": { - "description": "URI for the document.", + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultChunkInfo": { - "description": "Chunk information.", - "id": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultChunkInfo", + "GoogleCloudDiscoveryengineV1alphaDeleteEngineMetadata": { + "description": "Metadata related to the progress of the EngineService.DeleteEngine operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1alphaDeleteEngineMetadata", "properties": { - "chunk": { - "description": "Chunk resource name.", + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", "type": "string" }, - "content": { - "description": "Chunk textual content.", + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", "type": "string" - }, - "relevanceScore": { - "description": "Relevance score.", - "format": "float", - "type": "number" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultSnippetInfo": { - "description": "Snippet information.", - "id": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultSnippetInfo", + "GoogleCloudDiscoveryengineV1alphaDeleteSchemaMetadata": { + "description": "Metadata for DeleteSchema LRO.", + "id": "GoogleCloudDiscoveryengineV1alphaDeleteSchemaMetadata", "properties": { - "snippet": { - "description": "Snippet content.", + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", "type": "string" }, - "snippetStatus": { - "description": "Status of the snippet defined by the search team.", + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaAnswerStepActionSearchAction": { - "description": "Search action.", - "id": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionSearchAction", + "GoogleCloudDiscoveryengineV1alphaDeleteTargetSiteMetadata": { + "description": "Metadata related to the progress of the SiteSearchEngineService.DeleteTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1alphaDeleteTargetSiteMetadata", "properties": { - "query": { - "description": "The query to search.", + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", + "type": "string" + }, + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSiteMetadata": { - "description": "Metadata related to the progress of the SiteSearchEngineService.BatchCreateTargetSites operation. This will be returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSiteMetadata", + "GoogleCloudDiscoveryengineV1alphaDisableAdvancedSiteSearchMetadata": { + "description": "Metadata related to the progress of the SiteSearchEngineService.DisableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1alphaDisableAdvancedSiteSearchMetadata", "properties": { "createTime": { "description": "Operation create time.", @@ -9359,1092 +11318,1075 @@ }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSitesRequest": { - "description": "Request message for SiteSearchEngineService.BatchCreateTargetSites method.", - "id": "GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSitesRequest", + "GoogleCloudDiscoveryengineV1alphaDisableAdvancedSiteSearchRequest": { + "description": "Request message for SiteSearchEngineService.DisableAdvancedSiteSearch method.", + "id": "GoogleCloudDiscoveryengineV1alphaDisableAdvancedSiteSearchRequest", + "properties": {}, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaDisableAdvancedSiteSearchResponse": { + "description": "Response message for SiteSearchEngineService.DisableAdvancedSiteSearch method.", + "id": "GoogleCloudDiscoveryengineV1alphaDisableAdvancedSiteSearchResponse", + "properties": {}, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaDocument": { + "description": "Document captures all raw metadata information of items to be recommended or searched.", + "id": "GoogleCloudDiscoveryengineV1alphaDocument", + "properties": { + "aclInfo": { + "$ref": "GoogleCloudDiscoveryengineV1alphaDocumentAclInfo", + "description": "Access control information for the document." + }, + "content": { + "$ref": "GoogleCloudDiscoveryengineV1alphaDocumentContent", + "description": "The unstructured data linked to this document. Content must be set if this document is under a `CONTENT_REQUIRED` data store." + }, + "derivedStructData": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Output only. This field is OUTPUT_ONLY. It contains derived data that are not in the original input document.", + "readOnly": true, + "type": "object" + }, + "id": { + "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" + }, + "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.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "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" + }, + "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.", + "type": "string" + }, + "parentDocumentId": { + "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.", + "type": "string" + }, + "schemaId": { + "description": "The identifier of the schema located in the same data store.", + "type": "string" + }, + "structData": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "The structured JSON data for the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown.", + "type": "object" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaDocumentAclInfo": { + "description": "ACL Information of the Document.", + "id": "GoogleCloudDiscoveryengineV1alphaDocumentAclInfo", "properties": { - "requests": { - "description": "Required. The request message specifying the resources to create. A maximum of 20 TargetSites can be created in a batch.", + "readers": { + "description": "Readers of the document.", "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaCreateTargetSiteRequest" + "$ref": "GoogleCloudDiscoveryengineV1alphaDocumentAclInfoAccessRestriction" }, "type": "array" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSitesResponse": { - "description": "Response message for SiteSearchEngineService.BatchCreateTargetSites method.", - "id": "GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSitesResponse", + "GoogleCloudDiscoveryengineV1alphaDocumentAclInfoAccessRestriction": { + "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\" } ], } ] } }", + "id": "GoogleCloudDiscoveryengineV1alphaDocumentAclInfoAccessRestriction", "properties": { - "targetSites": { - "description": "TargetSites created.", + "principals": { + "description": "List of principals.", "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaTargetSite" + "$ref": "GoogleCloudDiscoveryengineV1alphaPrincipal" }, "type": "array" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaBatchVerifyTargetSitesRequest": { - "description": "Request message for SiteSearchEngineService.BatchVerifyTargetSites method.", - "id": "GoogleCloudDiscoveryengineV1alphaBatchVerifyTargetSitesRequest", - "properties": {}, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1alphaBigQuerySource": { - "description": "BigQuery source import data from.", - "id": "GoogleCloudDiscoveryengineV1alphaBigQuerySource", + "GoogleCloudDiscoveryengineV1alphaDocumentContent": { + "description": "Unstructured data linked to this document.", + "id": "GoogleCloudDiscoveryengineV1alphaDocumentContent", "properties": { - "dataSchema": { - "description": "The schema to use when parsing the data from the source. Supported values for user event imports: * `user_event` (default): One UserEvent per row. Supported values for document imports: * `document` (default): One Document format per row. Each document must have a valid Document.id and one of Document.json_data or Document.struct_data. * `custom`: One custom data per row in arbitrary format that conforms to the defined Schema of the data store. This can only be used by the GENERIC Data Store vertical.", - "type": "string" - }, - "datasetId": { - "description": "Required. The BigQuery data set 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.", - "type": "string" - }, - "partitionDate": { - "$ref": "GoogleTypeDate", - "description": "BigQuery time partitioned table's _PARTITIONDATE in YYYY-MM-DD format." - }, - "projectId": { - "description": "The project ID (can be project # or ID) that the BigQuery source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request.", + "mimeType": { + "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.", "type": "string" }, - "tableId": { - "description": "Required. The BigQuery table to copy the data from with a length limit of 1,024 characters.", + "rawBytes": { + "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.", + "format": "byte", "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1alphaBigtableOptions": { - "description": "The Bigtable Options object that contains information to support the import.", - "id": "GoogleCloudDiscoveryengineV1alphaBigtableOptions", - "properties": { - "families": { - "additionalProperties": { - "$ref": "GoogleCloudDiscoveryengineV1alphaBigtableOptionsBigtableColumnFamily" - }, - "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" }, - "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": "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" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaBigtableOptionsBigtableColumn": { - "description": "The column of the Bigtable.", - "id": "GoogleCloudDiscoveryengineV1alphaBigtableOptionsBigtableColumn", + "GoogleCloudDiscoveryengineV1alphaDocumentInfo": { + "description": "Detailed document information associated with a user event.", + "id": "GoogleCloudDiscoveryengineV1alphaDocumentInfo", "properties": { - "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.", - "enum": [ - "ENCODING_UNSPECIFIED", - "TEXT", - "BINARY" - ], - "enumDescriptions": [ - "The encoding is unspecified.", - "Text encoding.", - "Binary encoding." - ], + "id": { + "description": "The Document resource ID.", "type": "string" }, - "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.", + "name": { + "description": "The Document resource full name, of the form: `projects/{project_id}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/branches/{branch_id}/documents/{document_id}`", "type": "string" }, - "qualifier": { - "description": "Required. Qualifier of the column. If it cannot be decoded with utf-8, use a base-64 encoded string instead.", - "format": "byte", - "type": "string" + "promotionIds": { + "description": "The promotion IDs associated with this Document. Currently, this field is restricted to at most one ID.", + "items": { + "type": "string" + }, + "type": "array" }, - "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`.", - "enum": [ - "TYPE_UNSPECIFIED", - "STRING", - "NUMBER", - "INTEGER", - "VAR_INTEGER", - "BIG_NUMERIC", - "BOOLEAN", - "JSON" - ], - "enumDescriptions": [ - "The type is unspecified.", - "String type.", - "Numerical type.", - "Integer type.", - "Variable length integer type.", - "BigDecimal type.", - "Boolean type.", - "JSON type." - ], + "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`", + "format": "int32", + "type": "integer" + }, + "uri": { + "description": "The Document URI - only allowed for website data stores.", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaBigtableOptionsBigtableColumnFamily": { - "description": "The column family of the Bigtable.", - "id": "GoogleCloudDiscoveryengineV1alphaBigtableOptionsBigtableColumnFamily", + "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig": { + "description": "A singleton resource of DataStore. It's empty when DataStore is created, which defaults to digital parser. The first call to DataStoreService.UpdateDocumentProcessingConfig method will initialize the config.", + "id": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig", "properties": { - "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.", - "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaBigtableOptionsBigtableColumn" - }, - "type": "array" + "chunkingConfig": { + "$ref": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfig", + "description": "Whether chunking mode is enabled." }, - "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.", - "enum": [ - "ENCODING_UNSPECIFIED", - "TEXT", - "BINARY" - ], - "enumDescriptions": [ - "The encoding is unspecified.", - "Text encoding.", - "Binary encoding." - ], - "type": "string" + "defaultParsingConfig": { + "$ref": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfig", + "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." }, - "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.", + "name": { + "description": "The full resource name of the Document Processing Config. Format: `projects/*/locations/*/collections/*/dataStores/*/documentProcessingConfig`.", "type": "string" }, - "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`.", - "enum": [ - "TYPE_UNSPECIFIED", - "STRING", - "NUMBER", - "INTEGER", - "VAR_INTEGER", - "BIG_NUMERIC", - "BOOLEAN", - "JSON" - ], - "enumDescriptions": [ - "The type is unspecified.", - "String type.", - "Numerical type.", - "Integer type.", - "Variable length integer type.", - "BigDecimal type.", - "Boolean type.", - "JSON type." - ], - "type": "string" + "parsingConfigOverrides": { + "additionalProperties": { + "$ref": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfig" + }, + "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.", + "type": "object" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaBigtableSource": { - "description": "The Cloud Bigtable source for importing data.", - "id": "GoogleCloudDiscoveryengineV1alphaBigtableSource", + "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfig": { + "description": "Configuration for chunking config.", + "id": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfig", "properties": { - "bigtableOptions": { - "$ref": "GoogleCloudDiscoveryengineV1alphaBigtableOptions", - "description": "Required. Bigtable options that contains information needed when parsing data into typed structures. For example, column type annotations." - }, - "instanceId": { - "description": "Required. The instance ID of the Cloud Bigtable that needs to be imported.", - "type": "string" - }, - "projectId": { - "description": "The project ID that the Bigtable source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request.", - "type": "string" - }, - "tableId": { - "description": "Required. The table ID of the Cloud Bigtable that needs to be imported.", - "type": "string" + "layoutBasedChunkingConfig": { + "$ref": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig", + "description": "Configuration for the layout based chunking." } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaCheckGroundingRequest": { - "description": "Request message for GroundedGenerationService.CheckGrounding method.", - "id": "GoogleCloudDiscoveryengineV1alphaCheckGroundingRequest", + "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig": { + "description": "Configuration for the layout based chunking.", + "id": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig", "properties": { - "answerCandidate": { - "description": "Answer candidate to check. Can have a maximum length of 1024 characters.", - "type": "string" + "chunkSize": { + "description": "The token size limit for each chunk. Supported values: 100-500 (inclusive). Default value: 500.", + "format": "int32", + "type": "integer" }, - "facts": { - "description": "List of facts for the grounding check. We support up to 200 facts.", - "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaGroundingFact" - }, - "type": "array" + "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" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfig": { + "description": "Related configurations applied to a specific type of document parser.", + "id": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfig", + "properties": { + "digitalParsingConfig": { + "$ref": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigDigitalParsingConfig", + "description": "Configurations applied to digital parser." }, - "groundingSpec": { - "$ref": "GoogleCloudDiscoveryengineV1alphaCheckGroundingSpec", - "description": "Configuration of the grounding check." + "layoutParsingConfig": { + "$ref": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigLayoutParsingConfig", + "description": "Configurations applied to layout parser." }, - "userLabels": { - "additionalProperties": { - "type": "string" - }, - "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" + "ocrParsingConfig": { + "$ref": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigOcrParsingConfig", + "description": "Configurations applied to OCR parser. Currently it only applies to PDFs." } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaCheckGroundingResponse": { - "description": "Response message for the GroundedGenerationService.CheckGrounding method.", - "id": "GoogleCloudDiscoveryengineV1alphaCheckGroundingResponse", + "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigDigitalParsingConfig": { + "description": "The digital parsing configurations for documents.", + "id": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigDigitalParsingConfig", + "properties": {}, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigLayoutParsingConfig": { + "description": "The layout parsing configurations for documents.", + "id": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigLayoutParsingConfig", + "properties": {}, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigOcrParsingConfig": { + "description": "The OCR parsing configurations for documents.", + "id": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigOcrParsingConfig", "properties": { - "citedChunks": { - "description": "List of facts cited across all claims in the answer candidate. These are derived from the facts supplied in the request.", - "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaFactChunk" - }, - "type": "array" - }, - "claims": { - "description": "Claim texts and citation info across all claims in the answer candidate.", + "enhancedDocumentElements": { + "deprecated": true, + "description": "[DEPRECATED] This field is deprecated. To use the additional enhanced document elements processing, please switch to `layout_parsing_config`.", "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaCheckGroundingResponseClaim" + "type": "string" }, "type": "array" }, - "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.", - "format": "float", - "type": "number" + "useNativeText": { + "description": "If true, will use native text instead of OCR text on pages containing native text.", + "type": "boolean" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaCheckGroundingResponseClaim": { - "description": "Text and citation info for a claim in the answer candidate.", - "id": "GoogleCloudDiscoveryengineV1alphaCheckGroundingResponseClaim", + "GoogleCloudDiscoveryengineV1alphaDoubleList": { + "description": "Double list.", + "id": "GoogleCloudDiscoveryengineV1alphaDoubleList", "properties": { - "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.", + "values": { + "description": "Double values.", "items": { - "format": "int32", - "type": "integer" + "format": "double", + "type": "number" }, "type": "array" - }, - "claimText": { - "description": "Text for the claim in the answer candidate. Always provided regardless of whether citations or anti-citations are found.", - "type": "string" - }, - "endPos": { - "description": "Position indicating the end of the claim in the answer candidate, exclusive.", - "format": "int32", - "type": "integer" - }, - "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, and anti_citation_indices should not be returned.", - "type": "boolean" - }, - "startPos": { - "description": "Position indicating the start of the claim in the answer candidate, measured in bytes.", - "format": "int32", - "type": "integer" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaCheckGroundingSpec": { - "description": "Specification for the grounding check.", - "id": "GoogleCloudDiscoveryengineV1alphaCheckGroundingSpec", + "GoogleCloudDiscoveryengineV1alphaEmbeddingConfig": { + "description": "Defines embedding config, used for bring your own embeddings feature.", + "id": "GoogleCloudDiscoveryengineV1alphaEmbeddingConfig", "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.", - "format": "double", - "type": "number" + "fieldPath": { + "description": "Full field path in the schema mapped as embedding field.", + "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaCheckRequirementRequest": { - "description": "Request for CheckRequirement method.", - "id": "GoogleCloudDiscoveryengineV1alphaCheckRequirementRequest", + "GoogleCloudDiscoveryengineV1alphaEnableAdvancedSiteSearchMetadata": { + "description": "Metadata related to the progress of the SiteSearchEngineService.EnableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1alphaEnableAdvancedSiteSearchMetadata", "properties": { - "requirementType": { - "description": "The type specifying the requirement to check. The supported types are: * `discoveryengine.googleapis.com/media_recs/general/all/warning` * `discoveryengine.googleapis.com/media_recs/oyml/cvr/warning` * `discoveryengine.googleapis.com/media_recs/rfy/cvr/warning` * `discoveryengine.googleapis.com/media_recs/mlt/cvr/warning` * `discoveryengine.googleapis.com/media_recs/mp/cvr/warning` * `discoveryengine.googleapis.com/media_recs/oyml/wdps/warning` * `discoveryengine.googleapis.com/media_recs/rfy/wdps/warning` * `discoveryengine.googleapis.com/media_recs/mlt/wdps/warning`", + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", "type": "string" }, - "resources": { - "description": "The type needed for the monitored resources: * `discoveryengine.googleapis.com/Branch`. * The labels needed for this resource: * `project_number` * `location_id` * `collection_id` * `datastore_id` * `branch_id` * `discoveryengine.googleapis.com/DataStore` * The labels needed for this resource: * `project_number` * `location_id` * `collection_id` * `datastore_id`", - "items": { - "$ref": "GoogleApiMonitoredResource" - }, - "type": "array" + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", + "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaCheckRequirementResponse": { - "description": "Response for the CheckRequirement method.", - "id": "GoogleCloudDiscoveryengineV1alphaCheckRequirementResponse", + "GoogleCloudDiscoveryengineV1alphaEnableAdvancedSiteSearchRequest": { + "description": "Request message for SiteSearchEngineService.EnableAdvancedSiteSearch method.", + "id": "GoogleCloudDiscoveryengineV1alphaEnableAdvancedSiteSearchRequest", + "properties": {}, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaEnableAdvancedSiteSearchResponse": { + "description": "Response message for SiteSearchEngineService.EnableAdvancedSiteSearch method.", + "id": "GoogleCloudDiscoveryengineV1alphaEnableAdvancedSiteSearchResponse", + "properties": {}, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaEngine": { + "description": "Metadata that describes the training and serving parameters of an Engine.", + "id": "GoogleCloudDiscoveryengineV1alphaEngine", "properties": { - "metricResults": { - "description": "Metric results.", + "chatEngineConfig": { + "$ref": "GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfig", + "description": "Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT." + }, + "chatEngineMetadata": { + "$ref": "GoogleCloudDiscoveryengineV1alphaEngineChatEngineMetadata", + "description": "Output only. Additional information of the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.", + "readOnly": true + }, + "commonConfig": { + "$ref": "GoogleCloudDiscoveryengineV1alphaEngineCommonConfig", + "description": "Common config spec that specifies the metadata of the engine." + }, + "createTime": { + "description": "Output only. Timestamp the Recommendation Engine was created at.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "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.", "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaCheckRequirementResponseMetricQueryResult" + "type": "string" }, "type": "array" }, - "oldestMetricTimestamp": { - "description": "Timestamp of the oldest calculated metric (i.e. the most stale metric). Indicates that the `requirement_result` may not accurately reflect any Event and Product Catalog updates performed after this time.", - "format": "google-datetime", + "displayName": { + "description": "Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters.", "type": "string" }, - "requirement": { - "$ref": "GoogleCloudDiscoveryengineV1alphaRequirement", - "description": "Requirement definition." + "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.", + "enum": [ + "INDUSTRY_VERTICAL_UNSPECIFIED", + "GENERIC", + "MEDIA", + "HEALTHCARE_FHIR" + ], + "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." + ], + "type": "string" }, - "requirementCondition": { - "$ref": "GoogleTypeExpr", - "description": "The condition for evaluating the requirement result." + "mediaRecommendationEngineConfig": { + "$ref": "GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfig", + "description": "Configurations for the Media Engine. Only applicable on the data stores with solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical." }, - "requirementResult": { - "description": "Requirement result, e.g. pass or fail.", + "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_number}/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" + }, + "recommendationMetadata": { + "$ref": "GoogleCloudDiscoveryengineV1alphaEngineRecommendationMetadata", + "description": "Output only. Additional information of a recommendation engine. Only applicable if solution_type is SOLUTION_TYPE_RECOMMENDATION.", + "readOnly": true + }, + "searchEngineConfig": { + "$ref": "GoogleCloudDiscoveryengineV1alphaEngineSearchEngineConfig", + "description": "Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH." + }, + "similarDocumentsConfig": { + "$ref": "GoogleCloudDiscoveryengineV1alphaEngineSimilarDocumentsEngineConfig", + "description": "Additional config specs for a `similar-items` engine." + }, + "solutionType": { + "description": "Required. The solutions of the engine.", "enum": [ - "UNKNOWN", - "SUCCESS", - "FAILURE", - "WARNING" + "SOLUTION_TYPE_UNSPECIFIED", + "SOLUTION_TYPE_RECOMMENDATION", + "SOLUTION_TYPE_SEARCH", + "SOLUTION_TYPE_CHAT", + "SOLUTION_TYPE_GENERATIVE_CHAT" ], "enumDescriptions": [ - "The requirement is unknown.", - "The requirement check is passed.", - "The requirement check fails to meet at least one blocking threshold.", - "The requirement check fails at least one warning threshold, but passes all blocking thresholds." + "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." ], "type": "string" + }, + "updateTime": { + "description": "Output only. Timestamp the Recommendation Engine was last updated.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfig": { + "description": "Configurations for a Chat Engine.", + "id": "GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfig", + "properties": { + "agentCreationConfig": { + "$ref": "GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfigAgentCreationConfig", + "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." + }, + "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" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaCheckRequirementResponseMetricQueryResult": { - "description": "Metric result. The metric are in the requirement_condition.", - "id": "GoogleCloudDiscoveryengineV1alphaCheckRequirementResponseMetricQueryResult", + "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.", + "id": "GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfigAgentCreationConfig", "properties": { - "metricType": { - "description": "Type identifier of the metric corresponding to this query result.", + "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" }, - "name": { - "description": "This metric query name is mapping to variables in the requirement_condition.", + "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" }, - "timestamp": { - "description": "Time corresponding to when this metric value was calculated.", - "format": "google-datetime", + "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" }, - "unit": { - "description": "The unit in which this metric is reported. Follows [The Unified Code for Units of Measure](https://unitsofmeasure.org/ucum.html) standard.", + "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" - }, - "value": { - "$ref": "GoogleMonitoringV3TypedValue", - "description": "Value of the metric query." } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaChunk": { - "description": "Chunk captures all raw metadata information of items to be recommended or searched in the chunk mode.", - "id": "GoogleCloudDiscoveryengineV1alphaChunk", + "GoogleCloudDiscoveryengineV1alphaEngineChatEngineMetadata": { + "description": "Additional information of a Chat Engine. Fields in this message are output only.", + "id": "GoogleCloudDiscoveryengineV1alphaEngineChatEngineMetadata", "properties": { - "chunkMetadata": { - "$ref": "GoogleCloudDiscoveryengineV1alphaChunkChunkMetadata", - "description": "Output only. Metadata of the current chunk.", - "readOnly": true - }, - "content": { - "description": "Content is a string from a document (parsed content).", - "type": "string" - }, - "derivedStructData": { - "additionalProperties": { - "description": "Properties of the object.", - "type": "any" - }, - "description": "Output only. This field is OUTPUT_ONLY. It contains derived data that are not in the original input document.", - "readOnly": true, - "type": "object" - }, - "documentMetadata": { - "$ref": "GoogleCloudDiscoveryengineV1alphaChunkDocumentMetadata", - "description": "Metadata of the document from the current chunk." - }, - "id": { - "description": "Unique chunk ID of the current chunk.", - "type": "string" - }, - "name": { - "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.", + "dialogflowAgent": { + "description": "The resource name of a Dialogflow agent, that this Chat Engine refers to. Format: `projects//locations//agents/`.", "type": "string" - }, - "pageSpan": { - "$ref": "GoogleCloudDiscoveryengineV1alphaChunkPageSpan", - "description": "Page span of the chunk." - }, - "relevanceScore": { - "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.", - "format": "double", - "readOnly": true, - "type": "number" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaChunkChunkMetadata": { - "description": "Metadata of the current chunk. This field is only populated on SearchService.Search API.", - "id": "GoogleCloudDiscoveryengineV1alphaChunkChunkMetadata", + "GoogleCloudDiscoveryengineV1alphaEngineCommonConfig": { + "description": "Common configurations for an Engine.", + "id": "GoogleCloudDiscoveryengineV1alphaEngineCommonConfig", "properties": { - "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.", - "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaChunk" - }, - "type": "array" - }, - "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.", - "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaChunk" - }, - "type": "array" + "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" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaChunkDocumentMetadata": { - "description": "Document metadata contains the information of the document of the current chunk.", - "id": "GoogleCloudDiscoveryengineV1alphaChunkDocumentMetadata", + "GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfig": { + "description": "Additional config specs for a Media Recommendation engine.", + "id": "GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfig", "properties": { - "structData": { - "additionalProperties": { - "description": "Properties of the object.", - "type": "any" - }, - "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" + "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" }, - "title": { - "description": "Title of the document.", + "optimizationObjectiveConfig": { + "$ref": "GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigOptimizationObjectiveConfig", + "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)." + }, + "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.", + "enum": [ + "TRAINING_STATE_UNSPECIFIED", + "PAUSED", + "TRAINING" + ], + "enumDescriptions": [ + "Unspecified training state.", + "The engine training is paused.", + "The engine is training." + ], "type": "string" }, - "uri": { - "description": "Uri of the document.", + "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" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaChunkPageSpan": { - "description": "Page span of the chunk.", - "id": "GoogleCloudDiscoveryengineV1alphaChunkPageSpan", + "GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigOptimizationObjectiveConfig": { + "description": "Custom threshold for `cvr` optimization_objective.", + "id": "GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigOptimizationObjectiveConfig", "properties": { - "pageEnd": { - "description": "The end page of the chunk.", - "format": "int32", - "type": "integer" + "targetField": { + "description": "Required. The name of the field to target. Currently supported values: `watch-percentage`, `watch-time`.", + "type": "string" }, - "pageStart": { - "description": "The start page of the chunk.", - "format": "int32", - "type": "integer" + "targetFieldValueFloat": { + "description": "Required. The threshold to be applied to the target (e.g., 0.5).", + "format": "float", + "type": "number" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaCloudSqlSource": { - "description": "Cloud SQL source import data from.", - "id": "GoogleCloudDiscoveryengineV1alphaCloudSqlSource", + "GoogleCloudDiscoveryengineV1alphaEngineRecommendationMetadata": { + "description": "Additional information of a recommendation engine.", + "id": "GoogleCloudDiscoveryengineV1alphaEngineRecommendationMetadata", "properties": { - "databaseId": { - "description": "Required. The Cloud SQL database 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 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.", + "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.", + "enum": [ + "DATA_STATE_UNSPECIFIED", + "DATA_OK", + "DATA_ERROR" + ], + "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." + ], + "readOnly": true, "type": "string" }, - "instanceId": { - "description": "Required. The Cloud SQL instance to copy the data from with a length limit of 256 characters.", + "lastTuneTime": { + "description": "Output only. The timestamp when the latest successful tune finished. Only applicable on Media Recommendation engines.", + "format": "google-datetime", + "readOnly": true, "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" - }, - "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.", + "servingState": { + "description": "Output only. The serving state of the engine: `ACTIVE`, `NOT_ACTIVE`.", + "enum": [ + "SERVING_STATE_UNSPECIFIED", + "INACTIVE", + "ACTIVE", + "TUNED" + ], + "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." + ], + "readOnly": true, "type": "string" }, - "tableId": { - "description": "Required. The Cloud SQL table to copy the data from with a length limit of 256 characters.", + "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" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaCompleteQueryResponse": { - "description": "Response message for CompletionService.CompleteQuery method.", - "id": "GoogleCloudDiscoveryengineV1alphaCompleteQueryResponse", + "GoogleCloudDiscoveryengineV1alphaEngineSearchEngineConfig": { + "description": "Configurations for a Search Engine.", + "id": "GoogleCloudDiscoveryengineV1alphaEngineSearchEngineConfig", "properties": { - "querySuggestions": { - "description": "Results of the matched query suggestions. The result list is ordered and the first result is a top suggestion.", + "searchAddOns": { + "description": "The add-on that this search engine enables.", "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaCompleteQueryResponseQuerySuggestion" + "enum": [ + "SEARCH_ADD_ON_UNSPECIFIED", + "SEARCH_ADD_ON_LLM" + ], + "enumDescriptions": [ + "Default value when the enum is unspecified. This is invalid to use.", + "Large language model add-on." + ], + "type": "string" }, "type": "array" }, - "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" + "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.", + "enum": [ + "SEARCH_TIER_UNSPECIFIED", + "SEARCH_TIER_STANDARD", + "SEARCH_TIER_ENTERPRISE" + ], + "enumDescriptions": [ + "Default value when the enum is unspecified. This is invalid to use.", + "Standard tier.", + "Enterprise tier." + ], + "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaCompleteQueryResponseQuerySuggestion": { - "description": "Suggestions as search queries.", - "id": "GoogleCloudDiscoveryengineV1alphaCompleteQueryResponseQuerySuggestion", + "GoogleCloudDiscoveryengineV1alphaEngineSimilarDocumentsEngineConfig": { + "description": "Additional config specs for a `similar-items` engine.", + "id": "GoogleCloudDiscoveryengineV1alphaEngineSimilarDocumentsEngineConfig", + "properties": {}, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaEstimateDataSizeMetadata": { + "description": "Metadata related to the progress of the EstimateDataSize operation. This is returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1alphaEstimateDataSizeMetadata", "properties": { - "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.", - "items": { - "type": "string" - }, - "type": "array" - }, - "suggestion": { - "description": "The suggestion for the query.", + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaCompletionInfo": { - "description": "Detailed completion information including completion attribution token and clicked completion info.", - "id": "GoogleCloudDiscoveryengineV1alphaCompletionInfo", + "GoogleCloudDiscoveryengineV1alphaEstimateDataSizeRequest": { + "description": "Request message for EstimateBillingService.EstimateDataSize method", + "id": "GoogleCloudDiscoveryengineV1alphaEstimateDataSizeRequest", "properties": { - "selectedPosition": { - "description": "End user selected CompleteQueryResponse.QuerySuggestion.suggestion position, starting from 0.", - "format": "int32", - "type": "integer" + "fileDataSource": { + "$ref": "GoogleCloudDiscoveryengineV1alphaEstimateDataSizeRequestFileDataSource", + "description": "Structured or unstructured data." }, - "selectedSuggestion": { - "description": "End user selected CompleteQueryResponse.QuerySuggestion.suggestion.", - "type": "string" + "websiteDataSource": { + "$ref": "GoogleCloudDiscoveryengineV1alphaEstimateDataSizeRequestWebsiteDataSource", + "description": "Website data." } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaCompletionSuggestion": { - "description": "Autocomplete suggestions that are imported from Customer.", - "id": "GoogleCloudDiscoveryengineV1alphaCompletionSuggestion", + "GoogleCloudDiscoveryengineV1alphaEstimateDataSizeRequestFileDataSource": { + "description": "Data source contains files either in Cloud Storage or BigQuery.", + "id": "GoogleCloudDiscoveryengineV1alphaEstimateDataSizeRequestFileDataSource", "properties": { - "alternativePhrases": { - "description": "Alternative matching phrases for this suggestion.", - "items": { - "type": "string" - }, - "type": "array" - }, - "frequency": { - "description": "Frequency of this suggestion. Will be used to rank suggestions when score is not available.", - "format": "int64", - "type": "string" - }, - "globalScore": { - "description": "Global score of this suggestion. Control how this suggestion would be scored / ranked.", - "format": "double", - "type": "number" - }, - "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" - }, - "groupScore": { - "description": "The score of this suggestion within its group.", - "format": "double", - "type": "number" - }, - "languageCode": { - "description": "BCP-47 language code of this suggestion.", - "type": "string" + "bigquerySource": { + "$ref": "GoogleCloudDiscoveryengineV1alphaBigQuerySource", + "description": "BigQuery input source." }, - "suggestion": { - "description": "Required. The suggestion text.", - "type": "string" + "gcsSource": { + "$ref": "GoogleCloudDiscoveryengineV1alphaGcsSource", + "description": "Cloud Storage location for the input content." } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaCondition": { - "description": "Defines circumstances to be checked before allowing a behavior", - "id": "GoogleCloudDiscoveryengineV1alphaCondition", + "GoogleCloudDiscoveryengineV1alphaEstimateDataSizeRequestWebsiteDataSource": { + "description": "Data source is a set of website patterns that we crawl to get the total number of websites.", + "id": "GoogleCloudDiscoveryengineV1alphaEstimateDataSizeRequestWebsiteDataSource", "properties": { - "activeTimeRange": { - "description": "Range of time(s) specifying when condition is active. Maximum of 10 time ranges.", - "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaConditionTimeRange" - }, - "type": "array" - }, - "queryTerms": { - "description": "Search only A list of terms to match the query on. Maximum of 10 query terms.", + "estimatorUriPatterns": { + "description": "Required. The URI patterns to estimate the data sizes. At most 10 patterns are allowed, otherwise an INVALID_ARGUMENT error is thrown.", "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaConditionQueryTerm" + "$ref": "GoogleCloudDiscoveryengineV1alphaEstimateDataSizeRequestWebsiteDataSourceEstimatorUriPattern" }, "type": "array" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaConditionQueryTerm": { - "description": "Matcher for search request query", - "id": "GoogleCloudDiscoveryengineV1alphaConditionQueryTerm", + "GoogleCloudDiscoveryengineV1alphaEstimateDataSizeRequestWebsiteDataSourceEstimatorUriPattern": { + "description": "URI patterns that we use to crawl.", + "id": "GoogleCloudDiscoveryengineV1alphaEstimateDataSizeRequestWebsiteDataSourceEstimatorUriPattern", "properties": { - "fullMatch": { - "description": "Whether the search query needs to exactly match the query term.", + "exactMatch": { + "description": "Whether we infer the generated URI or use the exact provided one.", "type": "boolean" }, - "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.", + "exclusive": { + "description": "Whether the pattern is exclusive or not. If set to true, the pattern is considered exclusive. If unset or set to false, the pattern is considered inclusive by default.", + "type": "boolean" + }, + "providedUriPattern": { + "description": "User provided URI pattern. For example, `foo.com/bar/*`.", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaConditionTimeRange": { - "description": "Used for time-dependent conditions.", - "id": "GoogleCloudDiscoveryengineV1alphaConditionTimeRange", + "GoogleCloudDiscoveryengineV1alphaEstimateDataSizeResponse": { + "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.", + "id": "GoogleCloudDiscoveryengineV1alphaEstimateDataSizeResponse", "properties": { - "endTime": { - "description": "End of time range. Range is inclusive. Must be in the future.", - "format": "google-datetime", + "dataSizeBytes": { + "description": "Data size in terms of bytes.", + "format": "int64", "type": "string" }, - "startTime": { - "description": "Start of time range. Range is inclusive.", - "format": "google-datetime", + "documentCount": { + "description": "Total number of documents.", + "format": "int64", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaControl": { - "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`.", - "id": "GoogleCloudDiscoveryengineV1alphaControl", + "GoogleCloudDiscoveryengineV1alphaEvaluation": { + "description": "An evaluation is a single execution (or run) of an evaluation process. It encapsulates the state of the evaluation and the resulting data.", + "id": "GoogleCloudDiscoveryengineV1alphaEvaluation", "properties": { - "associatedServingConfigIds": { - "description": "Output only. List of all ServingConfig ids this control is attached to. May take up to 10 minutes to update after changes.", - "items": { - "type": "string" - }, + "createTime": { + "description": "Output only. Timestamp the Evaluation was created at.", + "format": "google-datetime", "readOnly": true, - "type": "array" + "type": "string" }, - "boostAction": { - "$ref": "GoogleCloudDiscoveryengineV1alphaControlBoostAction", - "description": "Defines a boost-type control" + "endTime": { + "description": "Output only. Timestamp the Evaluation was completed at.", + "format": "google-datetime", + "readOnly": true, + "type": "string" }, - "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.", + "error": { + "$ref": "GoogleRpcStatus", + "description": "Output only. The error that occurred during evaluation. Only populated when the evaluation's state is FAILED.", + "readOnly": true + }, + "errorSamples": { + "description": "Output only. A sample of errors encountered while processing the request.", "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaCondition" + "$ref": "GoogleRpcStatus" }, + "readOnly": true, "type": "array" }, - "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" - }, - "filterAction": { - "$ref": "GoogleCloudDiscoveryengineV1alphaControlFilterAction", - "description": "Defines a filter-type control Currently not supported by Recommendation" + "evaluationSpec": { + "$ref": "GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpec", + "description": "Required. The specification of the evaluation." }, "name": { - "description": "Immutable. Fully qualified name `projects/*/locations/global/dataStore/*/controls/*`", + "description": "Immutable. 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" }, - "redirectAction": { - "$ref": "GoogleCloudDiscoveryengineV1alphaControlRedirectAction", - "description": "Defines a redirect-type control." + "qualityMetrics": { + "$ref": "GoogleCloudDiscoveryengineV1alphaQualityMetrics", + "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 }, - "solutionType": { - "description": "Required. Immutable. What solution the control belongs to. Must be compatible with vertical of resource. Otherwise an INVALID ARGUMENT error is thrown.", + "state": { + "description": "Output only. The state of the evaluation.", "enum": [ - "SOLUTION_TYPE_UNSPECIFIED", - "SOLUTION_TYPE_RECOMMENDATION", - "SOLUTION_TYPE_SEARCH", - "SOLUTION_TYPE_CHAT", - "SOLUTION_TYPE_GENERATIVE_CHAT" + "STATE_UNSPECIFIED", + "PENDING", + "RUNNING", + "SUCCEEDED", + "FAILED" ], "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." + "The evaluation is unspecified.", + "The service is preparing to run the evaluation.", + "The evaluation is in progress.", + "The evaluation completed successfully.", + "The evaluation failed." ], - "type": "string" - }, - "synonymsAction": { - "$ref": "GoogleCloudDiscoveryengineV1alphaControlSynonymsAction", - "description": "Treats a group of terms as synonyms of one another." - }, - "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.", - "items": { - "enum": [ - "SEARCH_USE_CASE_UNSPECIFIED", - "SEARCH_USE_CASE_SEARCH", - "SEARCH_USE_CASE_BROWSE" - ], - "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." - ], - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1alphaControlBoostAction": { - "description": "Adjusts order of products in returned list.", - "id": "GoogleCloudDiscoveryengineV1alphaControlBoostAction", - "properties": { - "boost": { - "description": "Required. Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0 (No-op).", - "format": "float", - "type": "number" - }, - "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" - }, - "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.", + "readOnly": true, "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaControlFilterAction": { - "description": "Specified which products may be included in results. Uses same filter as boost.", - "id": "GoogleCloudDiscoveryengineV1alphaControlFilterAction", + "GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpec": { + "description": "Describes the specification of the evaluation.", + "id": "GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpec", "properties": { - "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" + "querySetSpec": { + "$ref": "GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpecQuerySetSpec", + "description": "Required. The specification of the query set." }, - "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" - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1alphaControlRedirectAction": { - "description": "Redirects a shopper to the provided URI.", - "id": "GoogleCloudDiscoveryengineV1alphaControlRedirectAction", - "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" + "searchRequest": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequest", + "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" } }, "type": "object" }, - "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\".", - "id": "GoogleCloudDiscoveryengineV1alphaControlSynonymsAction", + "GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpecQuerySetSpec": { + "description": "Describes the specification of the query set.", + "id": "GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpecQuerySetSpec", "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.", - "items": { - "type": "string" - }, - "type": "array" + "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" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaConversation": { - "description": "External conversation proto definition.", - "id": "GoogleCloudDiscoveryengineV1alphaConversation", + "GoogleCloudDiscoveryengineV1alphaExportUserEventsMetadata": { + "description": "Metadata related to the progress of the Export operation. This is returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1alphaExportUserEventsMetadata", "properties": { - "endTime": { - "description": "Output only. The time the conversation finished.", + "createTime": { + "description": "Operation create time.", "format": "google-datetime", - "readOnly": true, - "type": "string" - }, - "messages": { - "description": "Conversation messages.", - "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaConversationMessage" - }, - "type": "array" - }, - "name": { - "description": "Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/dataStore/*/conversations/*` or `projects/{project}/locations/global/collections/{collection}/engines/*/conversations/*`.", "type": "string" }, - "startTime": { - "description": "Output only. The time the conversation started.", + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", "format": "google-datetime", - "readOnly": true, "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaExportUserEventsResponse": { + "description": "Response of the ExportUserEventsRequest. If the long running operation was successful, then this message is returned by the google.longrunning.Operations.response field.", + "id": "GoogleCloudDiscoveryengineV1alphaExportUserEventsResponse", + "properties": { + "outputResult": { + "$ref": "GoogleCloudDiscoveryengineV1alphaOutputResult", + "description": "Output result indicating where the data were exported to." }, - "state": { - "description": "The state of the Conversation.", - "enum": [ - "STATE_UNSPECIFIED", - "IN_PROGRESS", - "COMPLETED" - ], - "enumDescriptions": [ - "Unknown.", - "Conversation is currently open.", - "Conversation has been completed." - ], + "status": { + "$ref": "GoogleRpcStatus", + "description": "The status of the export operation." + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaFactChunk": { + "description": "Fact Chunk.", + "id": "GoogleCloudDiscoveryengineV1alphaFactChunk", + "properties": { + "chunkText": { + "description": "Text content of the fact chunk. Can be at most 10K characters long.", "type": "string" }, - "userPseudoId": { - "description": "A unique identifier for tracking users.", + "index": { + "description": "The index of this chunk. Currently, only used for the streaming mode.", + "format": "int32", + "type": "integer" + }, + "source": { + "description": "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" + }, + "sourceMetadata": { + "additionalProperties": { + "type": "string" + }, + "description": "More fine-grained information for the source reference.", + "type": "object" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaConversationContext": { - "description": "Defines context of the conversation", - "id": "GoogleCloudDiscoveryengineV1alphaConversationContext", + "GoogleCloudDiscoveryengineV1alphaFetchDomainVerificationStatusResponse": { + "description": "Response message for SiteSearchEngineService.FetchDomainVerificationStatus method.", + "id": "GoogleCloudDiscoveryengineV1alphaFetchDomainVerificationStatusResponse", "properties": { - "activeDocument": { - "description": "The current active document the user opened. It contains the document resource reference.", + "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" }, - "contextDocuments": { - "description": "The current list of documents the user is seeing. It contains the document resource references.", + "targetSites": { + "description": "List of TargetSites containing the site verification status.", "items": { - "type": "string" + "$ref": "GoogleCloudDiscoveryengineV1alphaTargetSite" }, "type": "array" + }, + "totalSize": { + "description": "The total number of items matching the request. This will always be populated in the response.", + "format": "int32", + "type": "integer" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaConversationMessage": { - "description": "Defines a conversation message.", - "id": "GoogleCloudDiscoveryengineV1alphaConversationMessage", + "GoogleCloudDiscoveryengineV1alphaFhirStoreSource": { + "description": "Cloud FhirStore source import data from.", + "id": "GoogleCloudDiscoveryengineV1alphaFhirStoreSource", "properties": { - "createTime": { - "description": "Output only. Message creation timestamp.", - "format": "google-datetime", - "readOnly": true, + "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" }, - "reply": { - "$ref": "GoogleCloudDiscoveryengineV1alphaReply", - "description": "Search reply." - }, - "userInput": { - "$ref": "GoogleCloudDiscoveryengineV1alphaTextInput", - "description": "User text input." + "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" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaConverseConversationRequest": { - "description": "Request message for ConversationalSearchService.ConverseConversation method.", - "id": "GoogleCloudDiscoveryengineV1alphaConverseConversationRequest", + "GoogleCloudDiscoveryengineV1alphaFieldConfig": { + "description": "Configurations for fields of a schema. For example, configuring a field is indexable, or searchable.", + "id": "GoogleCloudDiscoveryengineV1alphaFieldConfig", "properties": { - "boostSpec": { - "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpec", - "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)" + "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 ``.", + "items": { + "enum": [ + "ADVANCED_SITE_SEARCH_DATA_SOURCE_UNSPECIFIED", + "METATAGS", + "PAGEMAP", + "SCHEMA_ORG" + ], + "enumDescriptions": [ + "Value used when unset.", + "Retrieve value from meta tag.", + "Retrieve value from page map.", + "Retrieve value from schema.org data." + ], + "type": "string" + }, + "type": "array" }, - "conversation": { - "$ref": "GoogleCloudDiscoveryengineV1alphaConversation", - "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." + "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.", + "enum": [ + "COMPLETABLE_OPTION_UNSPECIFIED", + "COMPLETABLE_ENABLED", + "COMPLETABLE_DISABLED" + ], + "enumDescriptions": [ + "Value used when unset.", + "Completable option enabled for a schema field.", + "Completable option disabled for a schema field." + ], + "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. 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)", + "dynamicFacetableOption": { + "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.", + "enum": [ + "DYNAMIC_FACETABLE_OPTION_UNSPECIFIED", + "DYNAMIC_FACETABLE_ENABLED", + "DYNAMIC_FACETABLE_DISABLED" + ], + "enumDescriptions": [ + "Value used when unset.", + "Dynamic facetable option enabled for a schema field.", + "Dynamic facetable option disabled for a schema field." + ], "type": "string" }, - "query": { - "$ref": "GoogleCloudDiscoveryengineV1alphaTextInput", - "description": "Required. Current user input." + "fieldPath": { + "description": "Required. Field path of the schema field. For example: `title`, `description`, `release_info.release_year`.", + "type": "string" }, - "safeSearch": { - "description": "Whether to turn on safe search.", - "type": "boolean" + "fieldType": { + "description": "Output only. Raw type of the field.", + "enum": [ + "FIELD_TYPE_UNSPECIFIED", + "OBJECT", + "STRING", + "NUMBER", + "INTEGER", + "BOOLEAN", + "GEOLOCATION", + "DATETIME" + ], + "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\"`" + ], + "readOnly": true, + "type": "string" }, - "servingConfig": { - "description": "The resource name of the Serving Config to use. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/servingConfigs/{serving_config_id}` If this is not set, the default serving config will be used.", + "indexableOption": { + "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.", + "enum": [ + "INDEXABLE_OPTION_UNSPECIFIED", + "INDEXABLE_ENABLED", + "INDEXABLE_DISABLED" + ], + "enumDescriptions": [ + "Value used when unset.", + "Indexable option enabled for a schema field.", + "Indexable option disabled for a schema field." + ], + "type": "string" + }, + "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" + }, + "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.", + "enum": [ + "FILTERABLE_OPTION_UNSPECIFIED", + "FILTERABLE_ENABLED", + "FILTERABLE_DISABLED" + ], + "enumDescriptions": [ + "Value used when unset.", + "Filterable option enabled for a schema field.", + "Filterable option disabled for a schema field." + ], + "type": "string" + }, + "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.", + "enum": [ + "RETRIEVABLE_OPTION_UNSPECIFIED", + "RETRIEVABLE_ENABLED", + "RETRIEVABLE_DISABLED" + ], + "enumDescriptions": [ + "Value used when unset.", + "Retrievable option enabled for a schema field.", + "Retrievable option disabled for a schema field." + ], "type": "string" }, - "summarySpec": { - "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpec", - "description": "A specification for configuring the summary returned in the response." - }, - "userLabels": { - "additionalProperties": { - "type": "string" - }, - "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" - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1alphaConverseConversationResponse": { - "description": "Response message for ConversationalSearchService.ConverseConversation method.", - "id": "GoogleCloudDiscoveryengineV1alphaConverseConversationResponse", - "properties": { - "conversation": { - "$ref": "GoogleCloudDiscoveryengineV1alphaConversation", - "description": "Updated conversation including the answer." - }, - "relatedQuestions": { - "description": "Suggested related questions.", + "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", "items": { "type": "string" }, "type": "array" }, - "reply": { - "$ref": "GoogleCloudDiscoveryengineV1alphaReply", - "description": "Answer to the current query." - }, - "searchResults": { - "description": "Search Results.", - "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseSearchResult" - }, - "type": "array" - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1alphaCreateDataStoreMetadata": { - "description": "Metadata related to the progress of the DataStoreService.CreateDataStore operation. This will be returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1alphaCreateDataStoreMetadata", - "properties": { - "createTime": { - "description": "Operation create time.", - "format": "google-datetime", - "type": "string" - }, - "updateTime": { - "description": "Operation last update time. If the operation is done, this is also the finish time.", - "format": "google-datetime", + "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.", + "enum": [ + "SEARCHABLE_OPTION_UNSPECIFIED", + "SEARCHABLE_ENABLED", + "SEARCHABLE_DISABLED" + ], + "enumDescriptions": [ + "Value used when unset.", + "Searchable option enabled for a schema field.", + "Searchable option disabled for a schema field." + ], "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaCreateEngineMetadata": { - "description": "Metadata related to the progress of the EngineService.CreateEngine operation. This will be returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1alphaCreateEngineMetadata", + "GoogleCloudDiscoveryengineV1alphaFirestoreSource": { + "description": "Firestore source import data from.", + "id": "GoogleCloudDiscoveryengineV1alphaFirestoreSource", "properties": { - "createTime": { - "description": "Operation create time.", - "format": "google-datetime", + "collectionId": { + "description": "Required. The Firestore collection (or entity) to copy the data from with a length limit of 1,500 characters.", "type": "string" }, - "updateTime": { - "description": "Operation last update time. If the operation is done, this is also the finish time.", - "format": "google-datetime", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1alphaCreateSchemaMetadata": { - "description": "Metadata for Create Schema LRO.", - "id": "GoogleCloudDiscoveryengineV1alphaCreateSchemaMetadata", - "properties": { - "createTime": { - "description": "Operation create time.", - "format": "google-datetime", + "databaseId": { + "description": "Required. The Firestore database to copy the data from with a length limit of 256 characters.", "type": "string" }, - "updateTime": { - "description": "Operation last update time. If the operation is done, this is also the finish time.", - "format": "google-datetime", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1alphaCreateTargetSiteMetadata": { - "description": "Metadata related to the progress of the SiteSearchEngineService.CreateTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1alphaCreateTargetSiteMetadata", - "properties": { - "createTime": { - "description": "Operation create time.", - "format": "google-datetime", + "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.", "type": "string" }, - "updateTime": { - "description": "Operation last update time. If the operation is done, this is also the finish time.", - "format": "google-datetime", + "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" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaCreateTargetSiteRequest": { - "description": "Request message for SiteSearchEngineService.CreateTargetSite method.", - "id": "GoogleCloudDiscoveryengineV1alphaCreateTargetSiteRequest", + "GoogleCloudDiscoveryengineV1alphaGcsSource": { + "description": "Cloud Storage location for input content.", + "id": "GoogleCloudDiscoveryengineV1alphaGcsSource", "properties": { - "parent": { - "description": "Required. Parent resource name of TargetSite, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine`.", + "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" }, - "targetSite": { - "$ref": "GoogleCloudDiscoveryengineV1alphaTargetSite", - "description": "Required. The TargetSite to create." - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1alphaCustomAttribute": { - "description": "A custom attribute that is not explicitly modeled in a resource, e.g. UserEvent.", - "id": "GoogleCloudDiscoveryengineV1alphaCustomAttribute", - "properties": { - "numbers": { - "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.", - "items": { - "format": "double", - "type": "number" - }, - "type": "array" - }, - "text": { - "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.", + "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`).", "items": { "type": "string" }, @@ -10453,193 +12395,117 @@ }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec": { - "description": "Defines custom fine tuning spec.", - "id": "GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec", + "GoogleCloudDiscoveryengineV1alphaGetUriPatternDocumentDataResponse": { + "description": "Response message for SiteSearchEngineService.GetUriPatternDocumentData method.", + "id": "GoogleCloudDiscoveryengineV1alphaGetUriPatternDocumentDataResponse", "properties": { - "enableSearchAdaptor": { - "description": "Whether or not to enable and include custom fine tuned search adaptor model.", - "type": "boolean" + "documentDataMap": { + "additionalProperties": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "type": "object" + }, + "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" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaCustomTuningModel": { - "description": "Metadata that describes a custom tuned model.", - "id": "GoogleCloudDiscoveryengineV1alphaCustomTuningModel", + "GoogleCloudDiscoveryengineV1alphaGroundingFact": { + "description": "Grounding Fact.", + "id": "GoogleCloudDiscoveryengineV1alphaGroundingFact", "properties": { - "createTime": { - "description": "Timestamp the Model was created at.", - "format": "google-datetime", - "type": "string" - }, - "displayName": { - "description": "The display name of the model.", - "type": "string" - }, - "modelState": { - "description": "The state that the model is in (e.g.`TRAINING` or `TRAINING_FAILED`).", - "enum": [ - "MODEL_STATE_UNSPECIFIED", - "TRAINING_PAUSED", - "TRAINING", - "TRAINING_COMPLETE", - "READY_FOR_SERVING", - "TRAINING_FAILED" - ], - "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." - ], - "type": "string" - }, - "modelVersion": { - "description": "The version of the model.", - "format": "int64", - "type": "string" - }, - "name": { - "description": "Required. The fully qualified resource name of the model. Format: `projects/{project_number}/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" + "attributes": { + "additionalProperties": { + "type": "string" + }, + "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" }, - "trainingStartTime": { - "description": "Timestamp the model training was initiated.", - "format": "google-datetime", + "factText": { + "description": "Text content of the fact. Can be at most 10K characters long.", "type": "string" } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1alphaDataStore": { - "description": "DataStore captures global settings and configs at the DataStore level.", - "id": "GoogleCloudDiscoveryengineV1alphaDataStore", - "properties": { - "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" - }, - "contentConfig": { - "description": "Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT.", - "enum": [ - "CONTENT_CONFIG_UNSPECIFIED", - "NO_CONTENT", - "CONTENT_REQUIRED", - "PUBLIC_WEBSITE" - ], - "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." - ], - "type": "string" - }, - "createTime": { - "description": "Output only. Timestamp the DataStore was created at.", - "format": "google-datetime", - "readOnly": true, - "type": "string" - }, - "defaultSchemaId": { - "description": "Output only. The id of the default Schema asscociated to this data store.", - "readOnly": true, - "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" + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaGuidedSearchSpec": { + "description": "Defines guided search spec.", + "id": "GoogleCloudDiscoveryengineV1alphaGuidedSearchSpec", + "properties": { + "enableRefinementAttributes": { + "description": "Whether or not to enable and include refinement attributes in gudied search result.", + "type": "boolean" }, - "documentProcessingConfig": { - "$ref": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig", - "description": "Configuration for Document understanding and enrichment." + "enableRelatedQuestions": { + "description": "Whether or not to enable and include related questions in search response.", + "type": "boolean" }, - "idpConfig": { - "$ref": "GoogleCloudDiscoveryengineV1alphaIdpConfig", - "description": "Output only. Data store level identity provider config.", - "readOnly": true + "maxRelatedQuestions": { + "description": "Max number of related questions to be returned. The valid range is [1, 5]. If enable_related_questions is true, the default value is 3.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaIdpConfig": { + "description": "Identity Provider Config.", + "id": "GoogleCloudDiscoveryengineV1alphaIdpConfig", + "properties": { + "externalIdpConfig": { + "$ref": "GoogleCloudDiscoveryengineV1alphaIdpConfigExternalIdpConfig", + "description": "External Identity provider config." }, - "industryVertical": { - "description": "Immutable. The industry vertical that the data store registers.", + "idpType": { + "description": "Identity provider type configured.", "enum": [ - "INDUSTRY_VERTICAL_UNSPECIFIED", - "GENERIC", - "MEDIA", - "HEALTHCARE_FHIR" + "IDP_TYPE_UNSPECIFIED", + "GSUITE", + "THIRD_PARTY" ], "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." + "Default value. ACL search not enabled.", + "Google 1P provider.", + "Third party provider." ], "type": "string" - }, - "languageInfo": { - "$ref": "GoogleCloudDiscoveryengineV1alphaLanguageInfo", - "description": "Language info for DataStore." - }, - "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" - }, - "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.", - "items": { - "enum": [ - "SOLUTION_TYPE_UNSPECIFIED", - "SOLUTION_TYPE_RECOMMENDATION", - "SOLUTION_TYPE_SEARCH", - "SOLUTION_TYPE_CHAT", - "SOLUTION_TYPE_GENERATIVE_CHAT" - ], - "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." - ], - "type": "string" - }, - "type": "array" - }, - "startingSchema": { - "$ref": "GoogleCloudDiscoveryengineV1alphaSchema", - "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)." } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaDeleteDataStoreMetadata": { - "description": "Metadata related to the progress of the DataStoreService.DeleteDataStore operation. This will be returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1alphaDeleteDataStoreMetadata", + "GoogleCloudDiscoveryengineV1alphaIdpConfigExternalIdpConfig": { + "description": "Third party IDP Config.", + "id": "GoogleCloudDiscoveryengineV1alphaIdpConfigExternalIdpConfig", "properties": { - "createTime": { - "description": "Operation create time.", - "format": "google-datetime", - "type": "string" - }, - "updateTime": { - "description": "Operation last update time. If the operation is done, this is also the finish time.", - "format": "google-datetime", + "workforcePoolName": { + "description": "Workforce pool name. Example: \"locations/global/workforcePools/pool_id\"", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaDeleteEngineMetadata": { - "description": "Metadata related to the progress of the EngineService.DeleteEngine operation. This will be returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1alphaDeleteEngineMetadata", + "GoogleCloudDiscoveryengineV1alphaImportCompletionSuggestionsMetadata": { + "description": "Metadata related to the progress of the ImportCompletionSuggestions operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1alphaImportCompletionSuggestionsMetadata", "properties": { "createTime": { "description": "Operation create time.", "format": "google-datetime", "type": "string" }, + "failureCount": { + "description": "Count of CompletionSuggestions that failed to be imported.", + "format": "int64", + "type": "string" + }, + "successCount": { + "description": "Count of CompletionSuggestions successfully imported.", + "format": "int64", + "type": "string" + }, "updateTime": { "description": "Operation last update time. If the operation is done, this is also the finish time.", "format": "google-datetime", @@ -10648,49 +12514,85 @@ }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaDeleteSchemaMetadata": { - "description": "Metadata for DeleteSchema LRO.", - "id": "GoogleCloudDiscoveryengineV1alphaDeleteSchemaMetadata", + "GoogleCloudDiscoveryengineV1alphaImportCompletionSuggestionsRequest": { + "description": "Request message for CompletionService.ImportCompletionSuggestions method.", + "id": "GoogleCloudDiscoveryengineV1alphaImportCompletionSuggestionsRequest", "properties": { - "createTime": { - "description": "Operation create time.", - "format": "google-datetime", - "type": "string" + "bigquerySource": { + "$ref": "GoogleCloudDiscoveryengineV1alphaBigQuerySource", + "description": "BigQuery input source." }, - "updateTime": { - "description": "Operation last update time. If the operation is done, this is also the finish time.", - "format": "google-datetime", - "type": "string" + "errorConfig": { + "$ref": "GoogleCloudDiscoveryengineV1alphaImportErrorConfig", + "description": "The desired location of errors incurred during the Import." + }, + "gcsSource": { + "$ref": "GoogleCloudDiscoveryengineV1alphaGcsSource", + "description": "Cloud Storage location for the input content." + }, + "inlineSource": { + "$ref": "GoogleCloudDiscoveryengineV1alphaImportCompletionSuggestionsRequestInlineSource", + "description": "The Inline source for suggestion entries." } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaDeleteTargetSiteMetadata": { - "description": "Metadata related to the progress of the SiteSearchEngineService.DeleteTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1alphaDeleteTargetSiteMetadata", + "GoogleCloudDiscoveryengineV1alphaImportCompletionSuggestionsRequestInlineSource": { + "description": "The inline source for CompletionSuggestions.", + "id": "GoogleCloudDiscoveryengineV1alphaImportCompletionSuggestionsRequestInlineSource", "properties": { - "createTime": { - "description": "Operation create time.", - "format": "google-datetime", - "type": "string" + "suggestions": { + "description": "Required. A list of all denylist entries to import. Max of 1000 items.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaCompletionSuggestion" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaImportCompletionSuggestionsResponse": { + "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.", + "id": "GoogleCloudDiscoveryengineV1alphaImportCompletionSuggestionsResponse", + "properties": { + "errorConfig": { + "$ref": "GoogleCloudDiscoveryengineV1alphaImportErrorConfig", + "description": "The desired location of errors incurred during the Import." }, - "updateTime": { - "description": "Operation last update time. If the operation is done, this is also the finish time.", - "format": "google-datetime", - "type": "string" + "errorSamples": { + "description": "A sample of errors encountered while processing the request.", + "items": { + "$ref": "GoogleRpcStatus" + }, + "type": "array" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaDisableAdvancedSiteSearchMetadata": { - "description": "Metadata related to the progress of the SiteSearchEngineService.DisableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1alphaDisableAdvancedSiteSearchMetadata", + "GoogleCloudDiscoveryengineV1alphaImportDocumentsMetadata": { + "description": "Metadata related to the progress of the ImportDocuments operation. This is returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1alphaImportDocumentsMetadata", "properties": { "createTime": { "description": "Operation create time.", "format": "google-datetime", "type": "string" }, + "failureCount": { + "description": "Count of entries that encountered errors while processing.", + "format": "int64", + "type": "string" + }, + "successCount": { + "description": "Count of entries that were processed successfully.", + "format": "int64", + "type": "string" + }, + "totalCount": { + "description": "Total count of entries that were processed.", + "format": "int64", + "type": "string" + }, "updateTime": { "description": "Operation last update time. If the operation is done, this is also the finish time.", "format": "google-datetime", @@ -10699,293 +12601,299 @@ }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaDisableAdvancedSiteSearchRequest": { - "description": "Request message for SiteSearchEngineService.DisableAdvancedSiteSearch method.", - "id": "GoogleCloudDiscoveryengineV1alphaDisableAdvancedSiteSearchRequest", - "properties": {}, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1alphaDisableAdvancedSiteSearchResponse": { - "description": "Response message for SiteSearchEngineService.DisableAdvancedSiteSearch method.", - "id": "GoogleCloudDiscoveryengineV1alphaDisableAdvancedSiteSearchResponse", - "properties": {}, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1alphaDocument": { - "description": "Document captures all raw metadata information of items to be recommended or searched.", - "id": "GoogleCloudDiscoveryengineV1alphaDocument", + "GoogleCloudDiscoveryengineV1alphaImportDocumentsRequest": { + "description": "Request message for Import methods.", + "id": "GoogleCloudDiscoveryengineV1alphaImportDocumentsRequest", "properties": { - "aclInfo": { - "$ref": "GoogleCloudDiscoveryengineV1alphaDocumentAclInfo", - "description": "Access control information for the document." + "alloyDbSource": { + "$ref": "GoogleCloudDiscoveryengineV1alphaAlloyDbSource", + "description": "AlloyDB input source." }, - "content": { - "$ref": "GoogleCloudDiscoveryengineV1alphaDocumentContent", - "description": "The unstructured data linked to this document. Content must be set if this document is under a `CONTENT_REQUIRED` data store." + "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" }, - "derivedStructData": { - "additionalProperties": { - "description": "Properties of the object.", - "type": "any" - }, - "description": "Output only. This field is OUTPUT_ONLY. It contains derived data that are not in the original input document.", - "readOnly": true, - "type": "object" + "bigquerySource": { + "$ref": "GoogleCloudDiscoveryengineV1alphaBigQuerySource", + "description": "BigQuery input source." + }, + "bigtableSource": { + "$ref": "GoogleCloudDiscoveryengineV1alphaBigtableSource", + "description": "Cloud Bigtable input source." + }, + "cloudSqlSource": { + "$ref": "GoogleCloudDiscoveryengineV1alphaCloudSqlSource", + "description": "Cloud SQL input source." + }, + "errorConfig": { + "$ref": "GoogleCloudDiscoveryengineV1alphaImportErrorConfig", + "description": "The desired location of errors incurred during the Import." }, - "id": { - "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" + "fhirStoreSource": { + "$ref": "GoogleCloudDiscoveryengineV1alphaFhirStoreSource", + "description": "FhirStore input source." }, - "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.", - "format": "google-datetime", - "readOnly": true, - "type": "string" + "firestoreSource": { + "$ref": "GoogleCloudDiscoveryengineV1alphaFirestoreSource", + "description": "Firestore input source." }, - "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" + "gcsSource": { + "$ref": "GoogleCloudDiscoveryengineV1alphaGcsSource", + "description": "Cloud Storage location for the input content." }, - "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.", + "idField": { + "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" }, - "parentDocumentId": { - "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.", - "type": "string" + "inlineSource": { + "$ref": "GoogleCloudDiscoveryengineV1alphaImportDocumentsRequestInlineSource", + "description": "The Inline source for the input content for documents." }, - "schemaId": { - "description": "The identifier of the schema located in the same data store.", + "reconciliationMode": { + "description": "The mode of reconciliation between existing documents and the documents to be imported. Defaults to ReconciliationMode.INCREMENTAL.", + "enum": [ + "RECONCILIATION_MODE_UNSPECIFIED", + "INCREMENTAL", + "FULL" + ], + "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." + ], "type": "string" }, - "structData": { - "additionalProperties": { - "description": "Properties of the object.", - "type": "any" - }, - "description": "The structured JSON data for the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown.", - "type": "object" + "spannerSource": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSpannerSource", + "description": "Spanner input source." + }, + "updateMask": { + "description": "Indicates which fields in the provided imported documents to update. If not set, the default is to update all fields.", + "format": "google-fieldmask", + "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaDocumentAclInfo": { - "description": "ACL Information of the Document.", - "id": "GoogleCloudDiscoveryengineV1alphaDocumentAclInfo", + "GoogleCloudDiscoveryengineV1alphaImportDocumentsRequestInlineSource": { + "description": "The inline source for the input config for ImportDocuments method.", + "id": "GoogleCloudDiscoveryengineV1alphaImportDocumentsRequestInlineSource", "properties": { - "readers": { - "description": "Readers of the document.", + "documents": { + "description": "Required. A list of documents to update/create. Each document must have a valid Document.id. Recommended max of 100 items.", "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaDocumentAclInfoAccessRestriction" + "$ref": "GoogleCloudDiscoveryengineV1alphaDocument" }, "type": "array" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaDocumentAclInfoAccessRestriction": { - "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\" } ], } ] } }", - "id": "GoogleCloudDiscoveryengineV1alphaDocumentAclInfoAccessRestriction", + "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.", + "id": "GoogleCloudDiscoveryengineV1alphaImportDocumentsResponse", "properties": { - "principals": { - "description": "List of principals.", + "errorConfig": { + "$ref": "GoogleCloudDiscoveryengineV1alphaImportErrorConfig", + "description": "Echoes the destination for the complete errors in the request if set." + }, + "errorSamples": { + "description": "A sample of errors encountered while processing the request.", "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaPrincipal" + "$ref": "GoogleRpcStatus" }, "type": "array" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaDocumentContent": { - "description": "Unstructured data linked to this document.", - "id": "GoogleCloudDiscoveryengineV1alphaDocumentContent", + "GoogleCloudDiscoveryengineV1alphaImportErrorConfig": { + "description": "Configuration of destination for Import related errors.", + "id": "GoogleCloudDiscoveryengineV1alphaImportErrorConfig", "properties": { - "mimeType": { - "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.", - "type": "string" - }, - "rawBytes": { - "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.", - "format": "byte", - "type": "string" - }, - "uri": { - "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.", + "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" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaDocumentInfo": { - "description": "Detailed document information associated with a user event.", - "id": "GoogleCloudDiscoveryengineV1alphaDocumentInfo", + "GoogleCloudDiscoveryengineV1alphaImportSampleQueriesMetadata": { + "description": "Metadata related to the progress of the ImportSampleQueries operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1alphaImportSampleQueriesMetadata", "properties": { - "id": { - "description": "The Document resource ID.", + "createTime": { + "description": "ImportSampleQueries operation create time.", + "format": "google-datetime", "type": "string" }, - "name": { - "description": "The Document resource full name, of the form: `projects/{project_id}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/branches/{branch_id}/documents/{document_id}`", + "failureCount": { + "description": "Count of SampleQuerys that failed to be imported.", + "format": "int64", "type": "string" }, - "promotionIds": { - "description": "The promotion IDs associated with this Document. Currently, this field is restricted to at most one ID.", - "items": { - "type": "string" - }, - "type": "array" + "successCount": { + "description": "Count of SampleQuerys successfully imported.", + "format": "int64", + "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`", - "format": "int32", - "type": "integer" + "totalCount": { + "description": "Total count of SampleQuerys that were processed.", + "format": "int64", + "type": "string" }, - "uri": { - "description": "The Document URI - only allowed for website data stores.", + "updateTime": { + "description": "ImportSampleQueries operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig": { - "description": "A singleton resource of DataStore. It's empty when DataStore is created, which defaults to digital parser. The first call to DataStoreService.UpdateDocumentProcessingConfig method will initialize the config.", - "id": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig", + "GoogleCloudDiscoveryengineV1alphaImportSampleQueriesRequest": { + "description": "Request message for SampleQueryService.ImportSampleQueries method.", + "id": "GoogleCloudDiscoveryengineV1alphaImportSampleQueriesRequest", "properties": { - "chunkingConfig": { - "$ref": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfig", - "description": "Whether chunking mode is enabled." + "bigquerySource": { + "$ref": "GoogleCloudDiscoveryengineV1alphaBigQuerySource", + "description": "BigQuery input source." }, - "defaultParsingConfig": { - "$ref": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfig", - "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." + "errorConfig": { + "$ref": "GoogleCloudDiscoveryengineV1alphaImportErrorConfig", + "description": "The desired location of errors incurred during the Import." }, - "name": { - "description": "The full resource name of the Document Processing Config. Format: `projects/*/locations/*/collections/*/dataStores/*/documentProcessingConfig`.", - "type": "string" + "gcsSource": { + "$ref": "GoogleCloudDiscoveryengineV1alphaGcsSource", + "description": "Cloud Storage location for the input content." }, - "parsingConfigOverrides": { - "additionalProperties": { - "$ref": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfig" - }, - "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 or layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and or layout parsing are supported.", - "type": "object" + "inlineSource": { + "$ref": "GoogleCloudDiscoveryengineV1alphaImportSampleQueriesRequestInlineSource", + "description": "The Inline source for sample query entries." } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfig": { - "description": "Configuration for chunking config.", - "id": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfig", + "GoogleCloudDiscoveryengineV1alphaImportSampleQueriesRequestInlineSource": { + "description": "The inline source for SampleQuerys.", + "id": "GoogleCloudDiscoveryengineV1alphaImportSampleQueriesRequestInlineSource", "properties": { - "layoutBasedChunkingConfig": { - "$ref": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig", - "description": "Configuration for the layout based chunking." + "sampleQueries": { + "description": "Required. A list of SampleQuerys to import. Max of 1000 items.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSampleQuery" + }, + "type": "array" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig": { - "description": "Configuration for the layout based chunking.", - "id": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig", + "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.", + "id": "GoogleCloudDiscoveryengineV1alphaImportSampleQueriesResponse", "properties": { - "chunkSize": { - "description": "The token size limit for each chunk. Supported values: 100-500 (inclusive). Default value: 500.", - "format": "int32", - "type": "integer" + "errorConfig": { + "$ref": "GoogleCloudDiscoveryengineV1alphaImportErrorConfig", + "description": "The desired location of errors incurred during the Import." }, - "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" + "errorSamples": { + "description": "A sample of errors encountered while processing the request.", + "items": { + "$ref": "GoogleRpcStatus" + }, + "type": "array" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfig": { - "description": "Related configurations applied to a specific type of document parser.", - "id": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfig", + "GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesMetadata": { + "description": "Metadata related to the progress of the ImportSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesMetadata", "properties": { - "digitalParsingConfig": { - "$ref": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigDigitalParsingConfig", - "description": "Configurations applied to digital parser." - }, - "layoutParsingConfig": { - "$ref": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigLayoutParsingConfig", - "description": "Configurations applied to layout parser." + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", + "type": "string" }, - "ocrParsingConfig": { - "$ref": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigOcrParsingConfig", - "description": "Configurations applied to OCR parser. Currently it only applies to PDFs." + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", + "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigDigitalParsingConfig": { - "description": "The digital parsing configurations for documents.", - "id": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigDigitalParsingConfig", - "properties": {}, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigLayoutParsingConfig": { - "description": "The layout parsing configurations for documents.", - "id": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigLayoutParsingConfig", - "properties": {}, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigOcrParsingConfig": { - "description": "The OCR parsing configurations for documents.", - "id": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigOcrParsingConfig", + "GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesRequest": { + "description": "Request message for CompletionService.ImportSuggestionDenyListEntries method.", + "id": "GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesRequest", "properties": { - "enhancedDocumentElements": { - "deprecated": true, - "description": "[DEPRECATED] This field is deprecated. To use the additional enhanced document elements processing, please switch to `layout_parsing_config`.", - "items": { - "type": "string" - }, - "type": "array" + "gcsSource": { + "$ref": "GoogleCloudDiscoveryengineV1alphaGcsSource", + "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." }, - "useNativeText": { - "description": "If true, will use native text instead of OCR text on pages containing native text.", - "type": "boolean" + "inlineSource": { + "$ref": "GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesRequestInlineSource", + "description": "The Inline source for the input content for suggestion deny list entries." } }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1alphaDoubleList": { - "description": "Double list.", - "id": "GoogleCloudDiscoveryengineV1alphaDoubleList", + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesRequestInlineSource": { + "description": "The inline source for SuggestionDenyListEntry.", + "id": "GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesRequestInlineSource", "properties": { - "values": { - "description": "Double values.", + "entries": { + "description": "Required. A list of all denylist entries to import. Max of 1000 items.", "items": { - "format": "double", - "type": "number" + "$ref": "GoogleCloudDiscoveryengineV1alphaSuggestionDenyListEntry" }, "type": "array" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaEmbeddingConfig": { - "description": "Defines embedding config, used for bring your own embeddings feature.", - "id": "GoogleCloudDiscoveryengineV1alphaEmbeddingConfig", + "GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesResponse": { + "description": "Response message for CompletionService.ImportSuggestionDenyListEntries method.", + "id": "GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesResponse", "properties": { - "fieldPath": { - "description": "Full field path in the schema mapped as embedding field.", + "errorSamples": { + "description": "A sample of errors encountered while processing the request.", + "items": { + "$ref": "GoogleRpcStatus" + }, + "type": "array" + }, + "failedEntriesCount": { + "description": "Count of deny list entries that failed to be imported.", + "format": "int64", + "type": "string" + }, + "importedEntriesCount": { + "description": "Count of deny list entries successfully imported.", + "format": "int64", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaEnableAdvancedSiteSearchMetadata": { - "description": "Metadata related to the progress of the SiteSearchEngineService.EnableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1alphaEnableAdvancedSiteSearchMetadata", + "GoogleCloudDiscoveryengineV1alphaImportUserEventsMetadata": { + "description": "Metadata related to the progress of the Import operation. This is returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1alphaImportUserEventsMetadata", "properties": { "createTime": { "description": "Operation create time.", "format": "google-datetime", "type": "string" }, + "failureCount": { + "description": "Count of entries that encountered errors while processing.", + "format": "int64", + "type": "string" + }, + "successCount": { + "description": "Count of entries that were processed successfully.", + "format": "int64", + "type": "string" + }, "updateTime": { "description": "Operation last update time. If the operation is done, this is also the finish time.", "format": "google-datetime", @@ -10994,446 +12902,399 @@ }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaEnableAdvancedSiteSearchRequest": { - "description": "Request message for SiteSearchEngineService.EnableAdvancedSiteSearch method.", - "id": "GoogleCloudDiscoveryengineV1alphaEnableAdvancedSiteSearchRequest", - "properties": {}, + "GoogleCloudDiscoveryengineV1alphaImportUserEventsRequest": { + "description": "Request message for the ImportUserEvents request.", + "id": "GoogleCloudDiscoveryengineV1alphaImportUserEventsRequest", + "properties": { + "bigquerySource": { + "$ref": "GoogleCloudDiscoveryengineV1alphaBigQuerySource", + "description": "BigQuery input source." + }, + "errorConfig": { + "$ref": "GoogleCloudDiscoveryengineV1alphaImportErrorConfig", + "description": "The desired location of errors incurred during the Import. Cannot be set for inline user event imports." + }, + "gcsSource": { + "$ref": "GoogleCloudDiscoveryengineV1alphaGcsSource", + "description": "Cloud Storage location for the input content." + }, + "inlineSource": { + "$ref": "GoogleCloudDiscoveryengineV1alphaImportUserEventsRequestInlineSource", + "description": "The Inline source for the input content for UserEvents." + } + }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaEnableAdvancedSiteSearchResponse": { - "description": "Response message for SiteSearchEngineService.EnableAdvancedSiteSearch method.", - "id": "GoogleCloudDiscoveryengineV1alphaEnableAdvancedSiteSearchResponse", - "properties": {}, + "GoogleCloudDiscoveryengineV1alphaImportUserEventsRequestInlineSource": { + "description": "The inline source for the input config for ImportUserEvents method.", + "id": "GoogleCloudDiscoveryengineV1alphaImportUserEventsRequestInlineSource", + "properties": { + "userEvents": { + "description": "Required. A list of user events to import. Recommended max of 10k items.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaUserEvent" + }, + "type": "array" + } + }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaEngine": { - "description": "Metadata that describes the training and serving parameters of an Engine.", - "id": "GoogleCloudDiscoveryengineV1alphaEngine", + "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.", + "id": "GoogleCloudDiscoveryengineV1alphaImportUserEventsResponse", "properties": { - "chatEngineConfig": { - "$ref": "GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfig", - "description": "Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT." - }, - "chatEngineMetadata": { - "$ref": "GoogleCloudDiscoveryengineV1alphaEngineChatEngineMetadata", - "description": "Output only. Additional information of the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.", - "readOnly": true - }, - "commonConfig": { - "$ref": "GoogleCloudDiscoveryengineV1alphaEngineCommonConfig", - "description": "Common config spec that specifies the metadata of the engine." - }, - "createTime": { - "description": "Output only. Timestamp the Recommendation Engine was created at.", - "format": "google-datetime", - "readOnly": true, - "type": "string" + "errorConfig": { + "$ref": "GoogleCloudDiscoveryengineV1alphaImportErrorConfig", + "description": "Echoes the destination for the complete errors if this field was set in the request." }, - "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.", + "errorSamples": { + "description": "A sample of errors encountered while processing the request.", "items": { - "type": "string" + "$ref": "GoogleRpcStatus" }, "type": "array" }, - "displayName": { - "description": "Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters.", - "type": "string" - }, - "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.", - "enum": [ - "INDUSTRY_VERTICAL_UNSPECIFIED", - "GENERIC", - "MEDIA", - "HEALTHCARE_FHIR" - ], - "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." - ], - "type": "string" - }, - "mediaRecommendationEngineConfig": { - "$ref": "GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfig", - "description": "Configurations for the Media Engine. Only applicable on the data stores with solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical." - }, - "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_number}/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" - }, - "recommendationMetadata": { - "$ref": "GoogleCloudDiscoveryengineV1alphaEngineRecommendationMetadata", - "description": "Output only. Additional information of a recommendation engine. Only applicable if solution_type is SOLUTION_TYPE_RECOMMENDATION.", - "readOnly": true - }, - "searchEngineConfig": { - "$ref": "GoogleCloudDiscoveryengineV1alphaEngineSearchEngineConfig", - "description": "Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH." - }, - "similarDocumentsConfig": { - "$ref": "GoogleCloudDiscoveryengineV1alphaEngineSimilarDocumentsEngineConfig", - "description": "Additional config specs for a `similar-items` engine." - }, - "solutionType": { - "description": "Required. The solutions of the engine.", - "enum": [ - "SOLUTION_TYPE_UNSPECIFIED", - "SOLUTION_TYPE_RECOMMENDATION", - "SOLUTION_TYPE_SEARCH", - "SOLUTION_TYPE_CHAT", - "SOLUTION_TYPE_GENERATIVE_CHAT" - ], - "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." - ], + "joinedEventsCount": { + "description": "Count of user events imported with complete existing Documents.", + "format": "int64", "type": "string" }, - "updateTime": { - "description": "Output only. Timestamp the Recommendation Engine was last updated.", - "format": "google-datetime", - "readOnly": true, + "unjoinedEventsCount": { + "description": "Count of user events imported, but with Document information not found in the existing Branch.", + "format": "int64", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfig": { - "description": "Configurations for a Chat Engine.", - "id": "GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfig", + "GoogleCloudDiscoveryengineV1alphaInterval": { + "description": "A floating point interval.", + "id": "GoogleCloudDiscoveryengineV1alphaInterval", "properties": { - "agentCreationConfig": { - "$ref": "GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfigAgentCreationConfig", - "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." + "exclusiveMaximum": { + "description": "Exclusive upper bound.", + "format": "double", + "type": "number" }, - "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" + "exclusiveMinimum": { + "description": "Exclusive lower bound.", + "format": "double", + "type": "number" + }, + "maximum": { + "description": "Inclusive upper bound.", + "format": "double", + "type": "number" + }, + "minimum": { + "description": "Inclusive lower bound.", + "format": "double", + "type": "number" } }, "type": "object" }, - "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.", - "id": "GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfigAgentCreationConfig", + "GoogleCloudDiscoveryengineV1alphaLanguageInfo": { + "description": "Language info for DataStore.", + "id": "GoogleCloudDiscoveryengineV1alphaLanguageInfo", "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.", + "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" }, - "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.", + "languageCode": { + "description": "The language code for the DataStore.", "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.", + "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" + }, + "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" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaListChunksResponse": { + "description": "Response message for ChunkService.ListChunks method.", + "id": "GoogleCloudDiscoveryengineV1alphaListChunksResponse", + "properties": { + "chunks": { + "description": "The Chunks.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaChunk" + }, + "type": "array" }, - "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.", + "nextPageToken": { + "description": "A token that can be sent as ListChunksRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaEngineChatEngineMetadata": { - "description": "Additional information of a Chat Engine. Fields in this message are output only.", - "id": "GoogleCloudDiscoveryengineV1alphaEngineChatEngineMetadata", + "GoogleCloudDiscoveryengineV1alphaListControlsResponse": { + "description": "Response for ListControls method.", + "id": "GoogleCloudDiscoveryengineV1alphaListControlsResponse", "properties": { - "dialogflowAgent": { - "description": "The resource name of a Dialogflow agent, that this Chat Engine refers to. Format: `projects//locations//agents/`.", + "controls": { + "description": "All the Controls for a given data store.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaControl" + }, + "type": "array" + }, + "nextPageToken": { + "description": "Pagination token, if not returned indicates the last page.", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaEngineCommonConfig": { - "description": "Common configurations for an Engine.", - "id": "GoogleCloudDiscoveryengineV1alphaEngineCommonConfig", + "GoogleCloudDiscoveryengineV1alphaListConversationsResponse": { + "description": "Response for ListConversations method.", + "id": "GoogleCloudDiscoveryengineV1alphaListConversationsResponse", "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.", + "conversations": { + "description": "All the Conversations for a given data store.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaConversation" + }, + "type": "array" + }, + "nextPageToken": { + "description": "Pagination token, if not returned indicates the last page.", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfig": { - "description": "Additional config specs for a Media Recommendation engine.", - "id": "GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfig", + "GoogleCloudDiscoveryengineV1alphaListCustomModelsResponse": { + "description": "Response message for SearchTuningService.ListCustomModels method.", + "id": "GoogleCloudDiscoveryengineV1alphaListCustomModelsResponse", "properties": { - "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": { - "$ref": "GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigOptimizationObjectiveConfig", - "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)." - }, - "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.", - "enum": [ - "TRAINING_STATE_UNSPECIFIED", - "PAUSED", - "TRAINING" - ], - "enumDescriptions": [ - "Unspecified training state.", - "The engine training is paused.", - "The engine is training." - ], - "type": "string" - }, - "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" + "models": { + "description": "List of custom tuning models.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaCustomTuningModel" + }, + "type": "array" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigOptimizationObjectiveConfig": { - "description": "Custom threshold for `cvr` optimization_objective.", - "id": "GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigOptimizationObjectiveConfig", + "GoogleCloudDiscoveryengineV1alphaListDataStoresResponse": { + "description": "Response message for DataStoreService.ListDataStores method.", + "id": "GoogleCloudDiscoveryengineV1alphaListDataStoresResponse", "properties": { - "targetField": { - "description": "Required. The name of the field to target. Currently supported values: `watch-percentage`, `watch-time`.", - "type": "string" + "dataStores": { + "description": "All the customer's DataStores.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaDataStore" + }, + "type": "array" }, - "targetFieldValueFloat": { - "description": "Required. The threshold to be applied to the target (e.g., 0.5).", - "format": "float", - "type": "number" + "nextPageToken": { + "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.", + "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaEngineRecommendationMetadata": { - "description": "Additional information of a recommendation engine.", - "id": "GoogleCloudDiscoveryengineV1alphaEngineRecommendationMetadata", + "GoogleCloudDiscoveryengineV1alphaListDocumentsResponse": { + "description": "Response message for DocumentService.ListDocuments method.", + "id": "GoogleCloudDiscoveryengineV1alphaListDocumentsResponse", "properties": { - "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.", - "enum": [ - "DATA_STATE_UNSPECIFIED", - "DATA_OK", - "DATA_ERROR" - ], - "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." - ], - "readOnly": true, - "type": "string" - }, - "lastTuneTime": { - "description": "Output only. The timestamp when the latest successful tune finished. Only applicable on Media Recommendation engines.", - "format": "google-datetime", - "readOnly": true, - "type": "string" - }, - "servingState": { - "description": "Output only. The serving state of the engine: `ACTIVE`, `NOT_ACTIVE`.", - "enum": [ - "SERVING_STATE_UNSPECIFIED", - "INACTIVE", - "ACTIVE", - "TUNED" - ], - "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." - ], - "readOnly": true, - "type": "string" + "documents": { + "description": "The Documents.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaDocument" + }, + "type": "array" }, - "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, + "nextPageToken": { + "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" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaEngineSearchEngineConfig": { - "description": "Configurations for a Search Engine.", - "id": "GoogleCloudDiscoveryengineV1alphaEngineSearchEngineConfig", + "GoogleCloudDiscoveryengineV1alphaListEnginesResponse": { + "description": "Response message for EngineService.ListEngines method.", + "id": "GoogleCloudDiscoveryengineV1alphaListEnginesResponse", "properties": { - "searchAddOns": { - "description": "The add-on that this search engine enables.", + "engines": { + "description": "All the customer's Engines.", "items": { - "enum": [ - "SEARCH_ADD_ON_UNSPECIFIED", - "SEARCH_ADD_ON_LLM" - ], - "enumDescriptions": [ - "Default value when the enum is unspecified. This is invalid to use.", - "Large language model add-on." - ], - "type": "string" + "$ref": "GoogleCloudDiscoveryengineV1alphaEngine" }, "type": "array" }, - "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.", - "enum": [ - "SEARCH_TIER_UNSPECIFIED", - "SEARCH_TIER_STANDARD", - "SEARCH_TIER_ENTERPRISE" - ], - "enumDescriptions": [ - "Default value when the enum is unspecified. This is invalid to use.", - "Standard tier.", - "Enterprise tier." - ], + "nextPageToken": { + "description": "Not supported.", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaEngineSimilarDocumentsEngineConfig": { - "description": "Additional config specs for a `similar-items` engine.", - "id": "GoogleCloudDiscoveryengineV1alphaEngineSimilarDocumentsEngineConfig", - "properties": {}, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1alphaEstimateDataSizeMetadata": { - "description": "Metadata related to the progress of the EstimateDataSize operation. This is returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1alphaEstimateDataSizeMetadata", + "GoogleCloudDiscoveryengineV1alphaListEvaluationResultsResponse": { + "description": "Response message for EvaluationService.ListEvaluationResults method.", + "id": "GoogleCloudDiscoveryengineV1alphaListEvaluationResultsResponse", "properties": { - "createTime": { - "description": "Operation create time.", - "format": "google-datetime", + "evaluationResults": { + "description": "The EvaluationResults.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaListEvaluationResultsResponseEvaluationResult" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token that can be sent as ListEvaluationResultsRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaEstimateDataSizeRequest": { - "description": "Request message for EstimateBillingService.EstimateDataSize method", - "id": "GoogleCloudDiscoveryengineV1alphaEstimateDataSizeRequest", + "GoogleCloudDiscoveryengineV1alphaListEvaluationResultsResponseEvaluationResult": { + "description": "Represents the results of an evaluation for a single SampleQuery.", + "id": "GoogleCloudDiscoveryengineV1alphaListEvaluationResultsResponseEvaluationResult", "properties": { - "fileDataSource": { - "$ref": "GoogleCloudDiscoveryengineV1alphaEstimateDataSizeRequestFileDataSource", - "description": "Structured or unstructured data." + "qualityMetrics": { + "$ref": "GoogleCloudDiscoveryengineV1alphaQualityMetrics", + "description": "Output only. The metrics produced by the evaluation, for a given SampleQuery.", + "readOnly": true }, - "websiteDataSource": { - "$ref": "GoogleCloudDiscoveryengineV1alphaEstimateDataSizeRequestWebsiteDataSource", - "description": "Website data." + "sampleQuery": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSampleQuery", + "description": "Output only. The SampleQuery that was evaluated.", + "readOnly": true } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaEstimateDataSizeRequestFileDataSource": { - "description": "Data source contains files either in Cloud Storage or BigQuery.", - "id": "GoogleCloudDiscoveryengineV1alphaEstimateDataSizeRequestFileDataSource", + "GoogleCloudDiscoveryengineV1alphaListEvaluationsResponse": { + "description": "Response message for EvaluationService.ListEvaluations method.", + "id": "GoogleCloudDiscoveryengineV1alphaListEvaluationsResponse", "properties": { - "bigquerySource": { - "$ref": "GoogleCloudDiscoveryengineV1alphaBigQuerySource", - "description": "BigQuery input source." + "evaluations": { + "description": "The Evaluations.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaEvaluation" + }, + "type": "array" }, - "gcsSource": { - "$ref": "GoogleCloudDiscoveryengineV1alphaGcsSource", - "description": "Cloud Storage location for the input content." + "nextPageToken": { + "description": "A token that can be sent as ListEvaluationsRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.", + "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaEstimateDataSizeRequestWebsiteDataSource": { - "description": "Data source is a set of website patterns that we crawl to get the total number of websites.", - "id": "GoogleCloudDiscoveryengineV1alphaEstimateDataSizeRequestWebsiteDataSource", + "GoogleCloudDiscoveryengineV1alphaListSampleQueriesResponse": { + "description": "Response message for SampleQueryService.ListSampleQueries method.", + "id": "GoogleCloudDiscoveryengineV1alphaListSampleQueriesResponse", "properties": { - "estimatorUriPatterns": { - "description": "Required. The URI patterns to estimate the data sizes. At most 10 patterns are allowed, otherwise an INVALID_ARGUMENT error is thrown.", + "nextPageToken": { + "description": "A token that can be sent as ListSampleQueriesRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.", + "type": "string" + }, + "sampleQueries": { + "description": "The SampleQuerys.", "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaEstimateDataSizeRequestWebsiteDataSourceEstimatorUriPattern" + "$ref": "GoogleCloudDiscoveryengineV1alphaSampleQuery" }, "type": "array" } }, "type": "object" - }, - "GoogleCloudDiscoveryengineV1alphaEstimateDataSizeRequestWebsiteDataSourceEstimatorUriPattern": { - "description": "URI patterns that we use to crawl.", - "id": "GoogleCloudDiscoveryengineV1alphaEstimateDataSizeRequestWebsiteDataSourceEstimatorUriPattern", - "properties": { - "exactMatch": { - "description": "Whether we infer the generated URI or use the exact provided one.", - "type": "boolean" - }, - "exclusive": { - "description": "Whether the pattern is exclusive or not. If set to true, the pattern is considered exclusive. If unset or set to false, the pattern is considered inclusive by default.", - "type": "boolean" - }, - "providedUriPattern": { - "description": "User provided URI pattern. For example, `foo.com/bar/*`.", + }, + "GoogleCloudDiscoveryengineV1alphaListSampleQuerySetsResponse": { + "description": "Response message for SampleQuerySetService.ListSampleQuerySets method.", + "id": "GoogleCloudDiscoveryengineV1alphaListSampleQuerySetsResponse", + "properties": { + "nextPageToken": { + "description": "A token that can be sent as ListSampleQuerySetsRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.", "type": "string" + }, + "sampleQuerySets": { + "description": "The SampleQuerySets.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSampleQuerySet" + }, + "type": "array" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaEstimateDataSizeResponse": { - "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.", - "id": "GoogleCloudDiscoveryengineV1alphaEstimateDataSizeResponse", + "GoogleCloudDiscoveryengineV1alphaListSchemasResponse": { + "description": "Response message for SchemaService.ListSchemas method.", + "id": "GoogleCloudDiscoveryengineV1alphaListSchemasResponse", "properties": { - "dataSizeBytes": { - "description": "Data size in terms of bytes.", - "format": "int64", + "nextPageToken": { + "description": "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" }, - "documentCount": { - "description": "Total number of documents.", - "format": "int64", - "type": "string" + "schemas": { + "description": "The Schemas.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSchema" + }, + "type": "array" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaFactChunk": { - "description": "Fact Chunk.", - "id": "GoogleCloudDiscoveryengineV1alphaFactChunk", + "GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse": { + "description": "Response for ListServingConfigs method.", + "id": "GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse", "properties": { - "chunkText": { - "description": "Text content of the fact chunk. Can be at most 10K characters long.", + "nextPageToken": { + "description": "Pagination token, if not returned indicates the last page.", "type": "string" }, - "index": { - "description": "The index of this chunk. Currently, only used for the streaming mode.", - "format": "int32", - "type": "integer" - }, - "source": { - "description": "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.", + "servingConfigs": { + "description": "All the ServingConfigs for a given dataStore.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaServingConfig" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaListSessionsResponse": { + "description": "Response for ListSessions method.", + "id": "GoogleCloudDiscoveryengineV1alphaListSessionsResponse", + "properties": { + "nextPageToken": { + "description": "Pagination token, if not returned indicates the last page.", "type": "string" }, - "sourceMetadata": { - "additionalProperties": { - "type": "string" + "sessions": { + "description": "All the Sessions for a given data store.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSession" }, - "description": "More fine-grained information for the source reference.", - "type": "object" + "type": "array" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaFetchDomainVerificationStatusResponse": { - "description": "Response message for SiteSearchEngineService.FetchDomainVerificationStatus method.", - "id": "GoogleCloudDiscoveryengineV1alphaFetchDomainVerificationStatusResponse", + "GoogleCloudDiscoveryengineV1alphaListTargetSitesResponse": { + "description": "Response message for SiteSearchEngineService.ListTargetSites method.", + "id": "GoogleCloudDiscoveryengineV1alphaListTargetSitesResponse", "properties": { "nextPageToken": { "description": "A token that can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", "type": "string" }, "targetSites": { - "description": "List of TargetSites containing the site verification status.", + "description": "List of TargetSites.", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaTargetSite" }, @@ -11447,306 +13308,236 @@ }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaFhirStoreSource": { - "description": "Cloud FhirStore source import data from.", - "id": "GoogleCloudDiscoveryengineV1alphaFhirStoreSource", + "GoogleCloudDiscoveryengineV1alphaMediaInfo": { + "description": "Media-specific user event information.", + "id": "GoogleCloudDiscoveryengineV1alphaMediaInfo", "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}`.", + "mediaProgressDuration": { + "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.", + "format": "google-duration", "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" + "mediaProgressPercentage": { + "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.", + "format": "float", + "type": "number" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaFieldConfig": { - "description": "Configurations for fields of a schema. For example, configuring a field is indexable, or searchable.", - "id": "GoogleCloudDiscoveryengineV1alphaFieldConfig", + "GoogleCloudDiscoveryengineV1alphaOutputResult": { + "description": "Output result that stores the information about where the exported data is stored.", + "id": "GoogleCloudDiscoveryengineV1alphaOutputResult", "properties": { - "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 ``.", - "items": { - "enum": [ - "ADVANCED_SITE_SEARCH_DATA_SOURCE_UNSPECIFIED", - "METATAGS", - "PAGEMAP", - "SCHEMA_ORG" - ], - "enumDescriptions": [ - "Value used when unset.", - "Retrieve value from meta tag.", - "Retrieve value from page map.", - "Retrieve value from schema.org data." - ], - "type": "string" - }, - "type": "array" - }, - "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.", - "enum": [ - "COMPLETABLE_OPTION_UNSPECIFIED", - "COMPLETABLE_ENABLED", - "COMPLETABLE_DISABLED" - ], - "enumDescriptions": [ - "Value used when unset.", - "Completable option enabled for a schema field.", - "Completable option disabled for a schema field." - ], - "type": "string" - }, - "dynamicFacetableOption": { - "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.", - "enum": [ - "DYNAMIC_FACETABLE_OPTION_UNSPECIFIED", - "DYNAMIC_FACETABLE_ENABLED", - "DYNAMIC_FACETABLE_DISABLED" - ], - "enumDescriptions": [ - "Value used when unset.", - "Dynamic facetable option enabled for a schema field.", - "Dynamic facetable option disabled for a schema field." - ], - "type": "string" - }, - "fieldPath": { - "description": "Required. Field path of the schema field. For example: `title`, `description`, `release_info.release_year`.", - "type": "string" - }, - "fieldType": { - "description": "Output only. Raw type of the field.", - "enum": [ - "FIELD_TYPE_UNSPECIFIED", - "OBJECT", - "STRING", - "NUMBER", - "INTEGER", - "BOOLEAN", - "GEOLOCATION", - "DATETIME" - ], - "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\"`" - ], - "readOnly": true, - "type": "string" - }, - "indexableOption": { - "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.", - "enum": [ - "INDEXABLE_OPTION_UNSPECIFIED", - "INDEXABLE_ENABLED", - "INDEXABLE_DISABLED" - ], - "enumDescriptions": [ - "Value used when unset.", - "Indexable option enabled for a schema field.", - "Indexable option disabled for a schema field." - ], - "type": "string" - }, - "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, + "bigqueryResult": { + "$ref": "GoogleCloudDiscoveryengineV1alphaOutputResultBigQueryOutputResult", + "description": "The BigQuery location where the result is stored." + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaOutputResultBigQueryOutputResult": { + "description": "A BigQuery output result.", + "id": "GoogleCloudDiscoveryengineV1alphaOutputResultBigQueryOutputResult", + "properties": { + "datasetId": { + "description": "The ID of a BigQuery Dataset.", "type": "string" }, - "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.", - "enum": [ - "FILTERABLE_OPTION_UNSPECIFIED", - "FILTERABLE_ENABLED", - "FILTERABLE_DISABLED" - ], - "enumDescriptions": [ - "Value used when unset.", - "Filterable option enabled for a schema field.", - "Filterable option disabled for a schema field." - ], + "tableId": { + "description": "The ID of a BigQuery Table.", "type": "string" - }, - "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.", - "enum": [ - "RETRIEVABLE_OPTION_UNSPECIFIED", - "RETRIEVABLE_ENABLED", - "RETRIEVABLE_DISABLED" - ], - "enumDescriptions": [ - "Value used when unset.", - "Retrievable option enabled for a schema field.", - "Retrievable option disabled for a schema field." - ], + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaPageInfo": { + "description": "Detailed page information.", + "id": "GoogleCloudDiscoveryengineV1alphaPageInfo", + "properties": { + "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" }, - "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", - "items": { - "type": "string" - }, - "type": "array" - }, - "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.", - "enum": [ - "SEARCHABLE_OPTION_UNSPECIFIED", - "SEARCHABLE_ENABLED", - "SEARCHABLE_DISABLED" - ], - "enumDescriptions": [ - "Value used when unset.", - "Searchable option enabled for a schema field.", - "Searchable option disabled for a schema field." - ], + "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" + }, + "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" + }, + "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" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaFirestoreSource": { - "description": "Firestore source import data from.", - "id": "GoogleCloudDiscoveryengineV1alphaFirestoreSource", + "GoogleCloudDiscoveryengineV1alphaPanelInfo": { + "description": "Detailed panel information associated with a user event.", + "id": "GoogleCloudDiscoveryengineV1alphaPanelInfo", "properties": { - "collectionId": { - "description": "Required. The Firestore collection (or entity) to copy the data from with a length limit of 1,500 characters.", + "displayName": { + "description": "The display name of the panel.", "type": "string" }, - "databaseId": { - "description": "Required. The Firestore database to copy the data from with a length limit of 256 characters.", + "panelId": { + "description": "Required. The panel ID.", "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.", - "type": "string" + "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.", + "format": "int32", + "type": "integer" }, - "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" + "totalPanels": { + "description": "The total number of panels, including this one, shown to the user. Must be set if panel_position is set.", + "format": "int32", + "type": "integer" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaGcsSource": { - "description": "Cloud Storage location for input content.", - "id": "GoogleCloudDiscoveryengineV1alphaGcsSource", + "GoogleCloudDiscoveryengineV1alphaPauseEngineRequest": { + "description": "Request for pausing training of an engine.", + "id": "GoogleCloudDiscoveryengineV1alphaPauseEngineRequest", + "properties": {}, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaPrincipal": { + "description": "Principal identifier of a user or a group.", + "id": "GoogleCloudDiscoveryengineV1alphaPrincipal", "properties": { - "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.", + "groupId": { + "description": "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" }, - "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`).", - "items": { - "type": "string" - }, - "type": "array" + "userId": { + "description": "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" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaGroundingFact": { - "description": "Grounding Fact.", - "id": "GoogleCloudDiscoveryengineV1alphaGroundingFact", + "GoogleCloudDiscoveryengineV1alphaProcessedDocument": { + "description": "Document captures all raw metadata information of items to be recommended or searched.", + "id": "GoogleCloudDiscoveryengineV1alphaProcessedDocument", "properties": { - "attributes": { - "additionalProperties": { - "type": "string" - }, - "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" + "document": { + "description": "Required. Full resource name of the referenced document, in the format `projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*`.", + "type": "string" }, - "factText": { - "description": "Text content of the fact. Can be at most 10K characters long.", + "jsonData": { + "description": "The JSON string representation of the processed document.", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaGuidedSearchSpec": { - "description": "Defines guided search spec.", - "id": "GoogleCloudDiscoveryengineV1alphaGuidedSearchSpec", + "GoogleCloudDiscoveryengineV1alphaProject": { + "description": "Metadata and configurations for a Google Cloud project in the service.", + "id": "GoogleCloudDiscoveryengineV1alphaProject", "properties": { - "enableRefinementAttributes": { - "description": "Whether or not to enable and include refinement attributes in gudied search result.", - "type": "boolean" + "createTime": { + "description": "Output only. The timestamp when this project is created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" }, - "enableRelatedQuestions": { - "description": "Whether or not to enable and include related questions in search response.", - "type": "boolean" + "name": { + "description": "Output only. Full resource name of the project, for example `projects/{project_number}`. 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" }, - "maxRelatedQuestions": { - "description": "Max number of related questions to be returned. The valid range is [1, 5]. If enable_related_questions is true, the default value is 3.", - "format": "int32", - "type": "integer" + "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.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "serviceTermsMap": { + "additionalProperties": { + "$ref": "GoogleCloudDiscoveryengineV1alphaProjectServiceTerms" + }, + "description": "Output only. A map of terms of services. The key is the `id` of ServiceTerms.", + "readOnly": true, + "type": "object" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaIdpConfig": { - "description": "Identity Provider Config.", - "id": "GoogleCloudDiscoveryengineV1alphaIdpConfig", + "GoogleCloudDiscoveryengineV1alphaProjectServiceTerms": { + "description": "Metadata about the terms of service.", + "id": "GoogleCloudDiscoveryengineV1alphaProjectServiceTerms", "properties": { - "externalIdpConfig": { - "$ref": "GoogleCloudDiscoveryengineV1alphaIdpConfigExternalIdpConfig", - "description": "External Identity provider config." + "acceptTime": { + "description": "The last time when the project agreed to the terms of service.", + "format": "google-datetime", + "type": "string" }, - "idpType": { - "description": "Identity provider type configured.", + "declineTime": { + "description": "The last time when the project declined or revoked the agreement to terms of service.", + "format": "google-datetime", + "type": "string" + }, + "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" + }, + "state": { + "description": "Whether the project has accepted/rejected the service terms or it is still pending.", "enum": [ - "IDP_TYPE_UNSPECIFIED", - "GSUITE", - "THIRD_PARTY" + "STATE_UNSPECIFIED", + "TERMS_ACCEPTED", + "TERMS_PENDING", + "TERMS_DECLINED" ], "enumDescriptions": [ - "Default value. ACL search not enabled.", - "Google 1P provider.", - "Third party provider." + "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." ], "type": "string" + }, + "version": { + "description": "The version string of the terms of service. For acceptable values, see the comments for id above.", + "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaIdpConfigExternalIdpConfig": { - "description": "Third party IDP Config.", - "id": "GoogleCloudDiscoveryengineV1alphaIdpConfigExternalIdpConfig", + "GoogleCloudDiscoveryengineV1alphaProvisionProjectMetadata": { + "description": "Metadata associated with a project provision operation.", + "id": "GoogleCloudDiscoveryengineV1alphaProvisionProjectMetadata", + "properties": {}, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaProvisionProjectRequest": { + "description": "Request for ProjectService.ProvisionProject method.", + "id": "GoogleCloudDiscoveryengineV1alphaProvisionProjectRequest", "properties": { - "workforcePoolName": { - "description": "Workforce pool name. Example: \"locations/global/workforcePools/pool_id\"", + "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.", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaImportCompletionSuggestionsMetadata": { - "description": "Metadata related to the progress of the ImportCompletionSuggestions operation. This will be returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1alphaImportCompletionSuggestionsMetadata", + "GoogleCloudDiscoveryengineV1alphaPurgeCompletionSuggestionsMetadata": { + "description": "Metadata related to the progress of the PurgeCompletionSuggestions operation. This is returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1alphaPurgeCompletionSuggestionsMetadata", "properties": { "createTime": { "description": "Operation create time.", "format": "google-datetime", "type": "string" }, - "failureCount": { - "description": "Count of CompletionSuggestions that failed to be imported.", - "format": "int64", - "type": "string" - }, - "successCount": { - "description": "Count of CompletionSuggestions successfully imported.", - "format": "int64", - "type": "string" - }, "updateTime": { "description": "Operation last update time. If the operation is done, this is also the finish time.", "format": "google-datetime", @@ -11755,64 +13546,33 @@ }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaImportCompletionSuggestionsRequest": { - "description": "Request message for CompletionService.ImportCompletionSuggestions method.", - "id": "GoogleCloudDiscoveryengineV1alphaImportCompletionSuggestionsRequest", - "properties": { - "bigquerySource": { - "$ref": "GoogleCloudDiscoveryengineV1alphaBigQuerySource", - "description": "BigQuery input source." - }, - "errorConfig": { - "$ref": "GoogleCloudDiscoveryengineV1alphaImportErrorConfig", - "description": "The desired location of errors incurred during the Import." - }, - "gcsSource": { - "$ref": "GoogleCloudDiscoveryengineV1alphaGcsSource", - "description": "Cloud Storage location for the input content." - }, - "inlineSource": { - "$ref": "GoogleCloudDiscoveryengineV1alphaImportCompletionSuggestionsRequestInlineSource", - "description": "The Inline source for suggestion entries." - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1alphaImportCompletionSuggestionsRequestInlineSource": { - "description": "The inline source for CompletionSuggestions.", - "id": "GoogleCloudDiscoveryengineV1alphaImportCompletionSuggestionsRequestInlineSource", - "properties": { - "suggestions": { - "description": "Required. A list of all denylist entries to import. Max of 1000 items.", - "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaCompletionSuggestion" - }, - "type": "array" - } - }, + "GoogleCloudDiscoveryengineV1alphaPurgeCompletionSuggestionsRequest": { + "description": "Request message for CompletionService.PurgeCompletionSuggestions method.", + "id": "GoogleCloudDiscoveryengineV1alphaPurgeCompletionSuggestionsRequest", + "properties": {}, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaImportCompletionSuggestionsResponse": { - "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.", - "id": "GoogleCloudDiscoveryengineV1alphaImportCompletionSuggestionsResponse", + "GoogleCloudDiscoveryengineV1alphaPurgeCompletionSuggestionsResponse": { + "description": "Response message for CompletionService.PurgeCompletionSuggestions method.", + "id": "GoogleCloudDiscoveryengineV1alphaPurgeCompletionSuggestionsResponse", "properties": { - "errorConfig": { - "$ref": "GoogleCloudDiscoveryengineV1alphaImportErrorConfig", - "description": "The desired location of errors incurred during the Import." - }, "errorSamples": { "description": "A sample of errors encountered while processing the request.", "items": { "$ref": "GoogleRpcStatus" }, "type": "array" + }, + "purgeSucceeded": { + "description": "Whether the completion suggestions were successfully purged.", + "type": "boolean" } }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1alphaImportDocumentsMetadata": { - "description": "Metadata related to the progress of the ImportDocuments operation. This is returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1alphaImportDocumentsMetadata", + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaPurgeDocumentsMetadata": { + "description": "Metadata related to the progress of the PurgeDocuments operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1alphaPurgeDocumentsMetadata", "properties": { "createTime": { "description": "Operation create time.", @@ -11824,13 +13584,13 @@ "format": "int64", "type": "string" }, - "successCount": { - "description": "Count of entries that were processed successfully.", + "ignoredCount": { + "description": "Count of entries that were ignored as entries were not found.", "format": "int64", "type": "string" }, - "totalCount": { - "description": "Total count of entries that were processed.", + "successCount": { + "description": "Count of entries that were deleted successfully.", "format": "int64", "type": "string" }, @@ -11842,132 +13602,120 @@ }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaImportDocumentsRequest": { - "description": "Request message for Import methods.", - "id": "GoogleCloudDiscoveryengineV1alphaImportDocumentsRequest", + "GoogleCloudDiscoveryengineV1alphaPurgeDocumentsRequest": { + "description": "Request message for DocumentService.PurgeDocuments method.", + "id": "GoogleCloudDiscoveryengineV1alphaPurgeDocumentsRequest", "properties": { - "alloyDbSource": { - "$ref": "GoogleCloudDiscoveryengineV1alphaAlloyDbSource", - "description": "AlloyDB input source." - }, - "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" - }, - "bigquerySource": { - "$ref": "GoogleCloudDiscoveryengineV1alphaBigQuerySource", - "description": "BigQuery input source." - }, - "bigtableSource": { - "$ref": "GoogleCloudDiscoveryengineV1alphaBigtableSource", - "description": "Cloud Bigtable input source." - }, - "cloudSqlSource": { - "$ref": "GoogleCloudDiscoveryengineV1alphaCloudSqlSource", - "description": "Cloud SQL input source." - }, "errorConfig": { - "$ref": "GoogleCloudDiscoveryengineV1alphaImportErrorConfig", - "description": "The desired location of errors incurred during the Import." + "$ref": "GoogleCloudDiscoveryengineV1alphaPurgeErrorConfig", + "description": "The desired location of errors incurred during the purge." }, - "fhirStoreSource": { - "$ref": "GoogleCloudDiscoveryengineV1alphaFhirStoreSource", - "description": "FhirStore input source." + "filter": { + "description": "Required. Filter matching documents to purge. Only currently supported value is `*` (all items).", + "type": "string" }, - "firestoreSource": { - "$ref": "GoogleCloudDiscoveryengineV1alphaFirestoreSource", - "description": "Firestore input source." + "force": { + "description": "Actually performs the purge. If `force` is set to false, return the expected purge count without deleting any documents.", + "type": "boolean" }, "gcsSource": { "$ref": "GoogleCloudDiscoveryengineV1alphaGcsSource", - "description": "Cloud Storage location for the input content." - }, - "idField": { - "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" - }, - "inlineSource": { - "$ref": "GoogleCloudDiscoveryengineV1alphaImportDocumentsRequestInlineSource", - "description": "The Inline source for the input content for documents." - }, - "reconciliationMode": { - "description": "The mode of reconciliation between existing documents and the documents to be imported. Defaults to ReconciliationMode.INCREMENTAL.", - "enum": [ - "RECONCILIATION_MODE_UNSPECIFIED", - "INCREMENTAL", - "FULL" - ], - "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." - ], - "type": "string" - }, - "spannerSource": { - "$ref": "GoogleCloudDiscoveryengineV1alphaSpannerSource", - "description": "Spanner input source." - }, - "updateMask": { - "description": "Indicates which fields in the provided imported documents to update. If not set, the default is to update all fields.", - "format": "google-fieldmask", - "type": "string" + "description": "Cloud Storage location for the input content. Supported `data_schema`: * `document_id`: One valid Document.id per line." } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaImportDocumentsRequestInlineSource": { - "description": "The inline source for the input config for ImportDocuments method.", - "id": "GoogleCloudDiscoveryengineV1alphaImportDocumentsRequestInlineSource", + "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.", + "id": "GoogleCloudDiscoveryengineV1alphaPurgeDocumentsResponse", "properties": { - "documents": { - "description": "Required. A list of documents to update/create. Each document must have a valid Document.id. Recommended max of 100 items.", + "purgeCount": { + "description": "The total count of documents purged as a result of the operation.", + "format": "int64", + "type": "string" + }, + "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.", "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaDocument" + "type": "string" }, "type": "array" } }, "type": "object" }, - "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.", - "id": "GoogleCloudDiscoveryengineV1alphaImportDocumentsResponse", + "GoogleCloudDiscoveryengineV1alphaPurgeErrorConfig": { + "description": "Configuration of destination for Purge related errors.", + "id": "GoogleCloudDiscoveryengineV1alphaPurgeErrorConfig", "properties": { - "errorConfig": { - "$ref": "GoogleCloudDiscoveryengineV1alphaImportErrorConfig", - "description": "Echoes the destination for the complete errors in the request if set." + "gcsPrefix": { + "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.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaPurgeSuggestionDenyListEntriesMetadata": { + "description": "Metadata related to the progress of the PurgeSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1alphaPurgeSuggestionDenyListEntriesMetadata", + "properties": { + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", + "type": "string" }, + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaPurgeSuggestionDenyListEntriesRequest": { + "description": "Request message for CompletionService.PurgeSuggestionDenyListEntries method.", + "id": "GoogleCloudDiscoveryengineV1alphaPurgeSuggestionDenyListEntriesRequest", + "properties": {}, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaPurgeSuggestionDenyListEntriesResponse": { + "description": "Response message for CompletionService.PurgeSuggestionDenyListEntries method.", + "id": "GoogleCloudDiscoveryengineV1alphaPurgeSuggestionDenyListEntriesResponse", + "properties": { "errorSamples": { "description": "A sample of errors encountered while processing the request.", "items": { "$ref": "GoogleRpcStatus" }, "type": "array" - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1alphaImportErrorConfig": { - "description": "Configuration of destination for Import related errors.", - "id": "GoogleCloudDiscoveryengineV1alphaImportErrorConfig", - "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.", + }, + "purgeCount": { + "description": "Number of suggestion deny list entries purged.", + "format": "int64", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesMetadata": { - "description": "Metadata related to the progress of the ImportSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesMetadata", + "GoogleCloudDiscoveryengineV1alphaPurgeUserEventsMetadata": { + "description": "Metadata related to the progress of the PurgeUserEvents operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1alphaPurgeUserEventsMetadata", "properties": { "createTime": { "description": "Operation create time.", "format": "google-datetime", "type": "string" }, + "failureCount": { + "description": "Count of entries that encountered errors while processing.", + "format": "int64", + "type": "string" + }, + "successCount": { + "description": "Count of entries that were deleted successfully.", + "format": "int64", + "type": "string" + }, "updateTime": { "description": "Operation last update time. If the operation is done, this is also the finish time.", "format": "google-datetime", @@ -11976,2453 +13724,2870 @@ }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesRequest": { - "description": "Request message for CompletionService.ImportSuggestionDenyListEntries method.", - "id": "GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesRequest", + "GoogleCloudDiscoveryengineV1alphaPurgeUserEventsRequest": { + "description": "Request message for PurgeUserEvents method.", + "id": "GoogleCloudDiscoveryengineV1alphaPurgeUserEventsRequest", "properties": { - "gcsSource": { - "$ref": "GoogleCloudDiscoveryengineV1alphaGcsSource", - "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." + "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. 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.", + "type": "string" }, - "inlineSource": { - "$ref": "GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesRequestInlineSource", - "description": "The Inline source for the input content for suggestion deny list entries." + "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" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesRequestInlineSource": { - "description": "The inline source for SuggestionDenyListEntry.", - "id": "GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesRequestInlineSource", + "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.", + "id": "GoogleCloudDiscoveryengineV1alphaPurgeUserEventsResponse", "properties": { - "entries": { - "description": "Required. A list of all denylist entries to import. Max of 1000 items.", - "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaSuggestionDenyListEntry" - }, - "type": "array" + "purgeCount": { + "description": "The total count of events purged as a result of the operation.", + "format": "int64", + "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesResponse": { - "description": "Response message for CompletionService.ImportSuggestionDenyListEntries method.", - "id": "GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesResponse", + "GoogleCloudDiscoveryengineV1alphaQualityMetrics": { + "description": "Describes the metrics produced by the evaluation.", + "id": "GoogleCloudDiscoveryengineV1alphaQualityMetrics", "properties": { - "errorSamples": { - "description": "A sample of errors encountered while processing the request.", - "items": { - "$ref": "GoogleRpcStatus" - }, - "type": "array" + "docNdcg": { + "$ref": "GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics", + "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" }, - "failedEntriesCount": { - "description": "Count of deny list entries that failed to be imported.", - "format": "int64", + "docPrecision": { + "$ref": "GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics", + "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" + }, + "docRecall": { + "$ref": "GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics", + "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" + }, + "pageNdcg": { + "$ref": "GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics", + "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" + }, + "pageRecall": { + "$ref": "GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics", + "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" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics": { + "description": "Stores the metric values at specific top-k levels.", + "id": "GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics", + "properties": { + "top1": { + "description": "The top-1 value.", + "format": "double", + "type": "number" + }, + "top10": { + "description": "The top-10 value.", + "format": "double", + "type": "number" + }, + "top3": { + "description": "The top-3 value.", + "format": "double", + "type": "number" + }, + "top5": { + "description": "The top-5 value.", + "format": "double", + "type": "number" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaQuery": { + "description": "Defines a user inputed query.", + "id": "GoogleCloudDiscoveryengineV1alphaQuery", + "properties": { + "queryId": { + "description": "Unique Id for the query.", "type": "string" }, - "importedEntriesCount": { - "description": "Count of deny list entries successfully imported.", - "format": "int64", + "text": { + "description": "Plain text.", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaImportUserEventsMetadata": { - "description": "Metadata related to the progress of the Import operation. This is returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1alphaImportUserEventsMetadata", + "GoogleCloudDiscoveryengineV1alphaRankRequest": { + "description": "Request message for RankService.Rank method.", + "id": "GoogleCloudDiscoveryengineV1alphaRankRequest", "properties": { - "createTime": { - "description": "Operation create time.", - "format": "google-datetime", - "type": "string" - }, - "failureCount": { - "description": "Count of entries that encountered errors while processing.", - "format": "int64", - "type": "string" + "ignoreRecordDetailsInResponse": { + "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" }, - "successCount": { - "description": "Count of entries that were processed successfully.", - "format": "int64", + "model": { + "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.", "type": "string" }, - "updateTime": { - "description": "Operation last update time. If the operation is done, this is also the finish time.", - "format": "google-datetime", + "query": { + "description": "The query to use.", "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1alphaImportUserEventsRequest": { - "description": "Request message for the ImportUserEvents request.", - "id": "GoogleCloudDiscoveryengineV1alphaImportUserEventsRequest", - "properties": { - "bigquerySource": { - "$ref": "GoogleCloudDiscoveryengineV1alphaBigQuerySource", - "description": "BigQuery input source." }, - "errorConfig": { - "$ref": "GoogleCloudDiscoveryengineV1alphaImportErrorConfig", - "description": "The desired location of errors incurred during the Import. Cannot be set for inline user event imports." + "records": { + "description": "Required. A list of records to rank. At most 200 records to rank.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaRankingRecord" + }, + "type": "array" }, - "gcsSource": { - "$ref": "GoogleCloudDiscoveryengineV1alphaGcsSource", - "description": "Cloud Storage location for the input content." + "topN": { + "description": "The number of results to return. If this is unset or no bigger than zero, returns all results.", + "format": "int32", + "type": "integer" }, - "inlineSource": { - "$ref": "GoogleCloudDiscoveryengineV1alphaImportUserEventsRequestInlineSource", - "description": "The Inline source for the input content for UserEvents." + "userLabels": { + "additionalProperties": { + "type": "string" + }, + "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" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaImportUserEventsRequestInlineSource": { - "description": "The inline source for the input config for ImportUserEvents method.", - "id": "GoogleCloudDiscoveryengineV1alphaImportUserEventsRequestInlineSource", + "GoogleCloudDiscoveryengineV1alphaRankResponse": { + "description": "Response message for RankService.Rank method.", + "id": "GoogleCloudDiscoveryengineV1alphaRankResponse", "properties": { - "userEvents": { - "description": "Required. A list of user events to import. Recommended max of 10k items.", + "records": { + "description": "A list of records sorted by descending score.", "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaUserEvent" + "$ref": "GoogleCloudDiscoveryengineV1alphaRankingRecord" }, "type": "array" } }, "type": "object" }, - "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.", - "id": "GoogleCloudDiscoveryengineV1alphaImportUserEventsResponse", + "GoogleCloudDiscoveryengineV1alphaRankingRecord": { + "description": "Record message for RankService.Rank method.", + "id": "GoogleCloudDiscoveryengineV1alphaRankingRecord", "properties": { - "errorConfig": { - "$ref": "GoogleCloudDiscoveryengineV1alphaImportErrorConfig", - "description": "Echoes the destination for the complete errors if this field was set in the request." - }, - "errorSamples": { - "description": "A sample of errors encountered while processing the request.", - "items": { - "$ref": "GoogleRpcStatus" - }, - "type": "array" + "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.", + "type": "string" }, - "joinedEventsCount": { - "description": "Count of user events imported with complete existing Documents.", - "format": "int64", + "id": { + "description": "The unique ID to represent the record.", "type": "string" }, - "unjoinedEventsCount": { - "description": "Count of user events imported, but with Document information not found in the existing Branch.", - "format": "int64", + "score": { + "description": "The score of this record based on the given query and selected model.", + "format": "float", + "type": "number" + }, + "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.", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaInterval": { - "description": "A floating point interval.", - "id": "GoogleCloudDiscoveryengineV1alphaInterval", + "GoogleCloudDiscoveryengineV1alphaRecommendRequest": { + "description": "Request message for Recommend method.", + "id": "GoogleCloudDiscoveryengineV1alphaRecommendRequest", "properties": { - "exclusiveMaximum": { - "description": "Exclusive upper bound.", - "format": "double", - "type": "number" + "filter": { + "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.", + "type": "string" }, - "exclusiveMinimum": { - "description": "Exclusive lower bound.", - "format": "double", - "type": "number" + "pageSize": { + "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.", + "format": "int32", + "type": "integer" }, - "maximum": { - "description": "Inclusive upper bound.", - "format": "double", - "type": "number" + "params": { + "additionalProperties": { + "type": "any" + }, + "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" }, - "minimum": { - "description": "Inclusive lower bound.", - "format": "double", - "type": "number" + "userEvent": { + "$ref": "GoogleCloudDiscoveryengineV1alphaUserEvent", + "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." + }, + "userLabels": { + "additionalProperties": { + "type": "string" + }, + "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" + }, + "validateOnly": { + "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.", + "type": "boolean" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaLanguageInfo": { - "description": "Language info for DataStore.", - "id": "GoogleCloudDiscoveryengineV1alphaLanguageInfo", + "GoogleCloudDiscoveryengineV1alphaRecommendResponse": { + "description": "Response message for Recommend method.", + "id": "GoogleCloudDiscoveryengineV1alphaRecommendResponse", "properties": { - "language": { - "description": "Output only. Language part of normalized_language_code. E.g.: `en-US` -> `en`, `zh-Hans-HK` -> `zh`, `en` -> `en`.", - "readOnly": true, + "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" }, - "languageCode": { - "description": "The language code for the DataStore.", - "type": "string" + "missingIds": { + "description": "IDs of documents in the request that were missing from the default Branch associated with the requested ServingConfig.", + "items": { + "type": "string" + }, + "type": "array" }, - "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" + "results": { + "description": "A list of recommended Documents. The order represents the ranking (from the most relevant Document to the least).", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaRecommendResponseRecommendationResult" + }, + "type": "array" }, - "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" + "validateOnly": { + "description": "True if RecommendRequest.validate_only was set.", + "type": "boolean" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaListChunksResponse": { - "description": "Response message for ChunkService.ListChunks method.", - "id": "GoogleCloudDiscoveryengineV1alphaListChunksResponse", + "GoogleCloudDiscoveryengineV1alphaRecommendResponseRecommendationResult": { + "description": "RecommendationResult represents a generic recommendation result with associated metadata.", + "id": "GoogleCloudDiscoveryengineV1alphaRecommendResponseRecommendationResult", "properties": { - "chunks": { - "description": "The Chunks.", - "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaChunk" - }, - "type": "array" + "document": { + "$ref": "GoogleCloudDiscoveryengineV1alphaDocument", + "description": "Set if `returnDocument` is set to true in RecommendRequest.params." }, - "nextPageToken": { - "description": "A token that can be sent as ListChunksRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.", + "id": { + "description": "Resource ID of the recommended Document.", "type": "string" + }, + "metadata": { + "additionalProperties": { + "type": "any" + }, + "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.", + "type": "object" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaListControlsResponse": { - "description": "Response for ListControls method.", - "id": "GoogleCloudDiscoveryengineV1alphaListControlsResponse", + "GoogleCloudDiscoveryengineV1alphaRecrawlUrisMetadata": { + "description": "Metadata related to the progress of the SiteSearchEngineService.RecrawlUris operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1alphaRecrawlUrisMetadata", "properties": { - "controls": { - "description": "All the Controls for a given data store.", + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", + "type": "string" + }, + "invalidUris": { + "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.", "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaControl" + "type": "string" }, "type": "array" }, - "nextPageToken": { - "description": "Pagination token, if not returned indicates the last page.", + "pendingCount": { + "description": "Total number of URIs that have yet to be crawled.", + "format": "int32", + "type": "integer" + }, + "quotaExceededCount": { + "description": "Total number of URIs that were rejected due to insufficient indexing resources.", + "format": "int32", + "type": "integer" + }, + "successCount": { + "description": "Total number of URIs that have been crawled so far.", + "format": "int32", + "type": "integer" + }, + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", "type": "string" + }, + "validUrisCount": { + "description": "Total number of unique URIs in the request that are not in invalid_uris.", + "format": "int32", + "type": "integer" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaListConversationsResponse": { - "description": "Response for ListConversations method.", - "id": "GoogleCloudDiscoveryengineV1alphaListConversationsResponse", + "GoogleCloudDiscoveryengineV1alphaRecrawlUrisRequest": { + "description": "Request message for SiteSearchEngineService.RecrawlUris method.", + "id": "GoogleCloudDiscoveryengineV1alphaRecrawlUrisRequest", "properties": { - "conversations": { - "description": "All the Conversations for a given data store.", + "uris": { + "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`.", "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaConversation" + "type": "string" }, "type": "array" - }, - "nextPageToken": { - "description": "Pagination token, if not returned indicates the last page.", - "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaListCustomModelsResponse": { - "description": "Response message for SearchTuningService.ListCustomModels method.", - "id": "GoogleCloudDiscoveryengineV1alphaListCustomModelsResponse", + "GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponse": { + "description": "Response message for SiteSearchEngineService.RecrawlUris method.", + "id": "GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponse", "properties": { - "models": { - "description": "List of custom tuning models.", + "failedUris": { + "description": "URIs that were not crawled before the LRO terminated.", "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaCustomTuningModel" + "type": "string" + }, + "type": "array" + }, + "failureSamples": { + "description": "Details for a sample of up to 10 `failed_uris`.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfo" }, "type": "array" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaListDataStoresResponse": { - "description": "Response message for DataStoreService.ListDataStores method.", - "id": "GoogleCloudDiscoveryengineV1alphaListDataStoresResponse", + "GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfo": { + "description": "Details about why a particular URI failed to be crawled. Each FailureInfo contains one FailureReason per CorpusType.", + "id": "GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfo", "properties": { - "dataStores": { - "description": "All the customer's DataStores.", + "failureReasons": { + "description": "List of failure reasons by corpus type (e.g. desktop, mobile).", "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaDataStore" + "$ref": "GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfoFailureReason" }, "type": "array" }, - "nextPageToken": { - "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.", + "uri": { + "description": "URI that failed to be crawled.", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaListDocumentsResponse": { - "description": "Response message for DocumentService.ListDocuments method.", - "id": "GoogleCloudDiscoveryengineV1alphaListDocumentsResponse", + "GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfoFailureReason": { + "description": "Details about why crawling failed for a particular CorpusType, e.g., DESKTOP and MOBILE crawling may fail for different reasons.", + "id": "GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfoFailureReason", "properties": { - "documents": { - "description": "The Documents.", - "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaDocument" - }, - "type": "array" + "corpusType": { + "description": "DESKTOP, MOBILE, or CORPUS_TYPE_UNSPECIFIED.", + "enum": [ + "CORPUS_TYPE_UNSPECIFIED", + "DESKTOP", + "MOBILE" + ], + "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." + ], + "type": "string" }, - "nextPageToken": { - "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.", + "errorMessage": { + "description": "Reason why the URI was not crawled.", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaListEnginesResponse": { - "description": "Response message for EngineService.ListEngines method.", - "id": "GoogleCloudDiscoveryengineV1alphaListEnginesResponse", + "GoogleCloudDiscoveryengineV1alphaReply": { + "description": "Defines a reply message to user.", + "id": "GoogleCloudDiscoveryengineV1alphaReply", "properties": { - "engines": { - "description": "All the customer's Engines.", + "references": { + "deprecated": true, + "description": "References in the reply.", "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaEngine" + "$ref": "GoogleCloudDiscoveryengineV1alphaReplyReference" }, "type": "array" }, - "nextPageToken": { - "description": "Not supported.", + "reply": { + "deprecated": true, + "description": "DEPRECATED: use `summary` instead. Text reply.", "type": "string" + }, + "summary": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseSummary", + "description": "Summary based on search results." } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaListSchemasResponse": { - "description": "Response message for SchemaService.ListSchemas method.", - "id": "GoogleCloudDiscoveryengineV1alphaListSchemasResponse", + "GoogleCloudDiscoveryengineV1alphaReplyReference": { + "deprecated": true, + "description": "Defines reference in reply.", + "id": "GoogleCloudDiscoveryengineV1alphaReplyReference", "properties": { - "nextPageToken": { - "description": "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.", + "anchorText": { + "description": "Anchor text.", "type": "string" }, - "schemas": { - "description": "The Schemas.", - "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaSchema" - }, - "type": "array" + "end": { + "description": "Anchor text end index.", + "format": "int32", + "type": "integer" + }, + "start": { + "description": "Anchor text start index.", + "format": "int32", + "type": "integer" + }, + "uri": { + "description": "URI link reference.", + "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse": { - "description": "Response for ListServingConfigs method.", - "id": "GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse", + "GoogleCloudDiscoveryengineV1alphaReportConsentChangeRequest": { + "description": "Request for ReportConsentChange method.", + "id": "GoogleCloudDiscoveryengineV1alphaReportConsentChangeRequest", "properties": { - "nextPageToken": { - "description": "Pagination token, if not returned indicates the last page.", + "consentChangeAction": { + "description": "Required. Whether customer decides to accept or decline service term. At this moment, only accept action is supported.", + "enum": [ + "CONSENT_CHANGE_ACTION_UNSPECIFIED", + "ACCEPT" + ], + "enumDescriptions": [ + "Invalid action, user must specify accept/decline", + "User accepts service terms." + ], "type": "string" }, - "servingConfigs": { - "description": "All the ServingConfigs for a given dataStore.", - "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaServingConfig" - }, - "type": "array" + "serviceTermId": { + "description": "Required. The unique identifier of the terms of service to update. Available term ids: * `GA_DATA_USE_TERMS`: [Terms for data use](https://cloud.google.com/retail/data-use-terms). When using this service term id, the acceptable service_term_version to provide is `2022-11-23`.", + "type": "string" + }, + "serviceTermVersion": { + "description": "Required. The version string of the terms of service to update.", + "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaListSessionsResponse": { - "description": "Response for ListSessions method.", - "id": "GoogleCloudDiscoveryengineV1alphaListSessionsResponse", + "GoogleCloudDiscoveryengineV1alphaRequirement": { + "description": "A data requirement.", + "id": "GoogleCloudDiscoveryengineV1alphaRequirement", "properties": { - "nextPageToken": { - "description": "Pagination token, if not returned indicates the last page.", + "condition": { + "$ref": "GoogleTypeExpr", + "description": "The condition for evaluating the requirement result. Variables in the expression should be provided by `metrics_bindings` or `threshold_bindings`. Where `metrics_bindings` are used for computed metrics and `threshold_bindings` are used to define thresholds for corresponding `metric_bindings`." + }, + "description": { + "description": "The description of the requirement.", "type": "string" }, - "sessions": { - "description": "All the Sessions for a given data store.", + "displayName": { + "description": "The name of the requirement.", + "type": "string" + }, + "metricBindings": { + "description": "A list of the metric bindings to be used in `condition`.", "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaSession" + "$ref": "GoogleCloudDiscoveryengineV1alphaRequirementMetricBinding" }, "type": "array" - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1alphaListTargetSitesResponse": { - "description": "Response message for SiteSearchEngineService.ListTargetSites method.", - "id": "GoogleCloudDiscoveryengineV1alphaListTargetSitesResponse", - "properties": { - "nextPageToken": { - "description": "A token that can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", - "type": "string" }, - "targetSites": { - "description": "List of TargetSites.", + "thresholdBindings": { + "description": "A list of threshold bindings to be used in `condition`.", "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaTargetSite" + "$ref": "GoogleCloudDiscoveryengineV1alphaRequirementThresholdBinding" }, "type": "array" }, - "totalSize": { - "description": "The total number of items matching the request. This will always be populated in the response.", - "format": "int32", - "type": "integer" + "type": { + "description": "The requirement type, used as an identifier. Must be unique. The type should prefix with service name to avoid possible collision. It's encouraged to use natural hierarchical grouping for similar requirements. Examples: * `library.googleapis.com/books/min_available_books` * `discoveryengine.googleapis.com/media_rec/recommended_for_you/conversion_rate`", + "type": "string" + }, + "violationSamplesBindings": { + "description": "A list of the metric bindings to be used in `condition`.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaRequirementViolationSamplesBinding" + }, + "type": "array" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaMediaInfo": { - "description": "Media-specific user event information.", - "id": "GoogleCloudDiscoveryengineV1alphaMediaInfo", + "GoogleCloudDiscoveryengineV1alphaRequirementMetricBinding": { + "description": "Specifies a metrics query and bind its result to a variable which will be used in the `condition`.", + "id": "GoogleCloudDiscoveryengineV1alphaRequirementMetricBinding", "properties": { - "mediaProgressDuration": { - "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.", - "format": "google-duration", + "category": { + "description": "The category of the metric's target resource. Example: \"Events\"", "type": "string" }, - "mediaProgressPercentage": { - "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.", - "format": "float", - "type": "number" + "description": { + "description": "Human readable description of the corresponding metric filter.", + "type": "string" + }, + "metricFilter": { + "description": "The filter string used for metrics query. Example: \"metric.type = \\\"discoveryengine.googleapis.com/events/day_count\\\" AND \" \"metric.conditions.time_range = \\\"NINETY_DAYS\\\"\"", + "type": "string" + }, + "resourceType": { + "description": "The resource being monitored for the metric.", + "type": "string" + }, + "variableId": { + "description": "The variable id to be referenced in `condition`.", + "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaPageInfo": { - "description": "Detailed page information.", - "id": "GoogleCloudDiscoveryengineV1alphaPageInfo", + "GoogleCloudDiscoveryengineV1alphaRequirementThresholdBinding": { + "description": "Specifies a multi-level threshold to apply to apply to a `metric_bindings` in the `condition` CEL expression.", + "id": "GoogleCloudDiscoveryengineV1alphaRequirementThresholdBinding", "properties": { - "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" + "blockingThreshold": { + "description": "Threshold to trigger a blocking failure. If not met, the requirement will evaluate as a `FAILURE`.", + "format": "double", + "type": "number" }, - "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.", + "description": { + "description": "Human readable description of the corresponding threshold and sub-requirement.", "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.", + "variableId": { + "description": "The variable id to be referenced in `condition`. Must be unique across all `metric_bindings` and `threshold_bindings`.", "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.", - "type": "string" + "warningThreshold": { + "description": "Threshold to trigger a warning. If not met, the requirement will evaluate as a `WARNING`.", + "format": "double", + "type": "number" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaPanelInfo": { - "description": "Detailed panel information associated with a user event.", - "id": "GoogleCloudDiscoveryengineV1alphaPanelInfo", + "GoogleCloudDiscoveryengineV1alphaRequirementViolationSamplesBinding": { + "description": "Specifies a samples query and bind its result to a variable which will be used in the `condition`.", + "id": "GoogleCloudDiscoveryengineV1alphaRequirementViolationSamplesBinding", "properties": { - "displayName": { - "description": "The display name of the panel.", + "description": { + "description": "Description of this sample binding. Used by the UI to render user friendly descriptions for each requirement condition. Should be less than 128 characters long.", "type": "string" }, - "panelId": { - "description": "Required. The panel ID.", + "sampleFilter": { + "description": "The filter string used for samples query. Example: \"sample.type = \\\"retail.googleapis.com/user_event\\\" AND \" \"sample.labels.event_type = \\\"PURCHASE\\\" \"", "type": "string" }, - "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.", - "format": "int32", - "type": "integer" - }, - "totalPanels": { - "description": "The total number of panels, including this one, shown to the user. Must be set if panel_position is set.", - "format": "int32", - "type": "integer" + "variableId": { + "description": "The variable id to be referenced in `condition`.", + "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaPauseEngineRequest": { - "description": "Request for pausing training of an engine.", - "id": "GoogleCloudDiscoveryengineV1alphaPauseEngineRequest", + "GoogleCloudDiscoveryengineV1alphaResumeEngineRequest": { + "description": "Request for resuming training of an engine.", + "id": "GoogleCloudDiscoveryengineV1alphaResumeEngineRequest", "properties": {}, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaPrincipal": { - "description": "Principal identifier of a user or a group.", - "id": "GoogleCloudDiscoveryengineV1alphaPrincipal", + "GoogleCloudDiscoveryengineV1alphaSampleQuery": { + "description": "Sample Query captures metadata to be used for evaluation.", + "id": "GoogleCloudDiscoveryengineV1alphaSampleQuery", "properties": { - "groupId": { - "description": "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.", + "createTime": { + "description": "Output only. Timestamp the SampleQuery was created at.", + "format": "google-datetime", + "readOnly": true, "type": "string" }, - "userId": { - "description": "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.", + "name": { + "description": "Immutable. The full resource name of the sample query, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}/sampleQueries/{sampleQuery}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", "type": "string" + }, + "queryEntry": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSampleQueryQueryEntry", + "description": "The query entry." } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaProcessedDocument": { - "description": "Document captures all raw metadata information of items to be recommended or searched.", - "id": "GoogleCloudDiscoveryengineV1alphaProcessedDocument", + "GoogleCloudDiscoveryengineV1alphaSampleQueryQueryEntry": { + "description": "Query Entry captures metadata to be used for search evaluation.", + "id": "GoogleCloudDiscoveryengineV1alphaSampleQueryQueryEntry", "properties": { - "document": { - "description": "Required. Full resource name of the referenced document, in the format `projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*`.", + "query": { + "description": "Required. The query.", "type": "string" }, - "jsonData": { - "description": "The JSON string representation of the processed document.", - "type": "string" + "targets": { + "description": "List of targets for the query.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSampleQueryQueryEntryTarget" + }, + "type": "array" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaProject": { - "description": "Metadata and configurations for a Google Cloud project in the service.", - "id": "GoogleCloudDiscoveryengineV1alphaProject", + "GoogleCloudDiscoveryengineV1alphaSampleQueryQueryEntryTarget": { + "description": "Defines the parameters of the query's expected outcome.", + "id": "GoogleCloudDiscoveryengineV1alphaSampleQueryQueryEntryTarget", "properties": { - "createTime": { - "description": "Output only. The timestamp when this project is created.", - "format": "google-datetime", - "readOnly": true, - "type": "string" + "pageNumbers": { + "description": "Expected page numbers of the target. Each page number must be non negative.", + "items": { + "format": "int32", + "type": "integer" + }, + "type": "array" }, - "name": { - "description": "Output only. Full resource name of the project, for example `projects/{project_number}`. 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" + "score": { + "description": "Relevance score of the target.", + "format": "double", + "type": "number" }, - "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.", - "format": "google-datetime", - "readOnly": true, + "uri": { + "description": "Expected uri of the target. This field must be a UTF-8 encoded string with a length limit of 2048 characters. Example of valid uris: `https://example.com/abc`, `gcs://example/example.pdf`.", "type": "string" - }, - "serviceTermsMap": { - "additionalProperties": { - "$ref": "GoogleCloudDiscoveryengineV1alphaProjectServiceTerms" - }, - "description": "Output only. A map of terms of services. The key is the `id` of ServiceTerms.", - "readOnly": true, - "type": "object" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaProjectServiceTerms": { - "description": "Metadata about the terms of service.", - "id": "GoogleCloudDiscoveryengineV1alphaProjectServiceTerms", + "GoogleCloudDiscoveryengineV1alphaSampleQuerySet": { + "description": "A SampleQuerySet is the parent resource of SampleQuery, and contains the configurations shared by all SampleQuery under it.", + "id": "GoogleCloudDiscoveryengineV1alphaSampleQuerySet", "properties": { - "acceptTime": { - "description": "The last time when the project agreed to the terms of service.", - "format": "google-datetime", - "type": "string" - }, - "declineTime": { - "description": "The last time when the project declined or revoked the agreement to terms of service.", + "createTime": { + "description": "Output only. Timestamp the SampleQuerySet was created at.", "format": "google-datetime", + "readOnly": true, "type": "string" }, - "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`.", + "description": { + "description": "The description of the SampleQuerySet.", "type": "string" }, - "state": { - "description": "Whether the project has accepted/rejected the service terms or it is still pending.", - "enum": [ - "STATE_UNSPECIFIED", - "TERMS_ACCEPTED", - "TERMS_PENDING", - "TERMS_DECLINED" - ], - "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." - ], + "displayName": { + "description": "Required. The sample query set display name. This field must be a UTF-8 encoded string with a length limit of 128 characters.", "type": "string" }, - "version": { - "description": "The version string of the terms of service. For acceptable values, see the comments for id above.", + "name": { + "description": "Immutable. The full resource name of the SampleQuerySet, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaProvisionProjectMetadata": { - "description": "Metadata associated with a project provision operation.", - "id": "GoogleCloudDiscoveryengineV1alphaProvisionProjectMetadata", - "properties": {}, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1alphaProvisionProjectRequest": { - "description": "Request for ProjectService.ProvisionProject method.", - "id": "GoogleCloudDiscoveryengineV1alphaProvisionProjectRequest", + "GoogleCloudDiscoveryengineV1alphaSchema": { + "description": "Defines the structure and layout of a type of document data.", + "id": "GoogleCloudDiscoveryengineV1alphaSchema", "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" + "fieldConfigs": { + "description": "Output only. Configurations for fields of the schema.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaFieldConfig" + }, + "readOnly": true, + "type": "array" }, - "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.", + "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" + }, + "structSchema": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "The structured representation of the schema.", + "type": "object" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaPurgeCompletionSuggestionsMetadata": { - "description": "Metadata related to the progress of the PurgeCompletionSuggestions operation. This is returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1alphaPurgeCompletionSuggestionsMetadata", + "GoogleCloudDiscoveryengineV1alphaSearchInfo": { + "description": "Detailed search information.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchInfo", "properties": { - "createTime": { - "description": "Operation create time.", - "format": "google-datetime", + "offset": { + "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.", + "format": "int32", + "type": "integer" + }, + "orderBy": { + "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" }, - "updateTime": { - "description": "Operation last update time. If the operation is done, this is also the finish time.", - "format": "google-datetime", + "searchQuery": { + "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.", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaPurgeCompletionSuggestionsRequest": { - "description": "Request message for CompletionService.PurgeCompletionSuggestions method.", - "id": "GoogleCloudDiscoveryengineV1alphaPurgeCompletionSuggestionsRequest", - "properties": {}, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1alphaPurgeCompletionSuggestionsResponse": { - "description": "Response message for CompletionService.PurgeCompletionSuggestions method.", - "id": "GoogleCloudDiscoveryengineV1alphaPurgeCompletionSuggestionsResponse", + "GoogleCloudDiscoveryengineV1alphaSearchRequest": { + "description": "Request message for SearchService.Search method.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchRequest", "properties": { - "errorSamples": { - "description": "A sample of errors encountered while processing the request.", + "boostSpec": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpec", + "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)" + }, + "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" + }, + "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" + }, + "contentSearchSpec": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpec", + "description": "A specification for configuring the behavior of content search." + }, + "customFineTuningSpec": { + "$ref": "GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec", + "description": "Custom fine tuning configs. If set, it has higher priority than the configs set in ServingConfig.custom_fine_tuning_spec." + }, + "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.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec" + }, + "type": "array" + }, + "embeddingSpec": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpec", + "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." + }, + "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.", "items": { - "$ref": "GoogleRpcStatus" + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpec" }, "type": "array" }, - "purgeSucceeded": { - "description": "Whether the completion suggestions were successfully purged.", - "type": "boolean" - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1alphaPurgeDocumentsMetadata": { - "description": "Metadata related to the progress of the PurgeDocuments operation. This will be returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1alphaPurgeDocumentsMetadata", - "properties": { - "createTime": { - "description": "Operation create time.", - "format": "google-datetime", + "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" }, - "failureCount": { - "description": "Count of entries that encountered errors while processing.", - "format": "int64", + "imageQuery": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestImageQuery", + "description": "Raw image query." + }, + "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" }, - "ignoredCount": { - "description": "Count of entries that were ignored as entries were not found.", - "format": "int64", + "naturalLanguageQueryUnderstandingSpec": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestNaturalLanguageQueryUnderstandingSpec", + "description": "If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done." + }, + "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.", + "format": "int32", + "type": "integer" + }, + "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 for retail search, see [Ordering](https://cloud.google.com/retail/docs/filter-and-order#order) If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.", "type": "string" }, - "successCount": { - "description": "Count of entries that were deleted successfully.", - "format": "int64", + "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.", + "format": "int32", + "type": "integer" + }, + "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" }, - "updateTime": { - "description": "Operation last update time. If the operation is done, this is also the finish time.", - "format": "google-datetime", + "params": { + "additionalProperties": { + "type": "any" + }, + "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" + }, + "query": { + "description": "Raw search query.", "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1alphaPurgeDocumentsRequest": { - "description": "Request message for DocumentService.PurgeDocuments method.", - "id": "GoogleCloudDiscoveryengineV1alphaPurgeDocumentsRequest", - "properties": { - "errorConfig": { - "$ref": "GoogleCloudDiscoveryengineV1alphaPurgeErrorConfig", - "description": "The desired location of errors incurred during the purge." }, - "filter": { - "description": "Required. Filter matching documents to purge. Only currently supported value is `*` (all items).", + "queryExpansionSpec": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestQueryExpansionSpec", + "description": "The query expansion specification that specifies the conditions under which query expansion occurs." + }, + "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)`.", "type": "string" }, - "force": { - "description": "Actually performs the purge. If `force` is set to false, return the expected purge count without deleting any documents.", + "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" + }, + "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.", + "enum": [ + "RELEVANCE_THRESHOLD_UNSPECIFIED", + "LOWEST", + "LOW", + "MEDIUM", + "HIGH" + ], + "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." + ], + "type": "string" + }, + "safeSearch": { + "description": "Whether to turn on safe search. This is only supported for website search.", "type": "boolean" }, - "gcsSource": { - "$ref": "GoogleCloudDiscoveryengineV1alphaGcsSource", - "description": "Cloud Storage location for the input content. Supported `data_schema`: * `document_id`: One valid Document.id per line." - } - }, - "type": "object" - }, - "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.", - "id": "GoogleCloudDiscoveryengineV1alphaPurgeDocumentsResponse", - "properties": { - "purgeCount": { - "description": "The total count of documents purged as a result of the operation.", - "format": "int64", + "searchAsYouTypeSpec": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAsYouTypeSpec", + "description": "Search as you type configuration. Only supported for the IndustryVertical.MEDIA vertical." + }, + "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" }, - "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.", - "items": { + "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 /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": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestSessionSpec", + "description": "Session specification. Can be used only when `session` is set." + }, + "spellCorrectionSpec": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestSpellCorrectionSpec", + "description": "The spell correction specification that specifies the mode under which spell correction takes effect." + }, + "userInfo": { + "$ref": "GoogleCloudDiscoveryengineV1alphaUserInfo", + "description": "Information about the end user. Highly recommended for analytics. UserInfo.user_agent is used to deduce `device_type` for analytics." + }, + "userLabels": { + "additionalProperties": { "type": "string" }, - "type": "array" - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1alphaPurgeErrorConfig": { - "description": "Configuration of destination for Purge related errors.", - "id": "GoogleCloudDiscoveryengineV1alphaPurgeErrorConfig", - "properties": { - "gcsPrefix": { - "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.", + "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" + }, + "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" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaPurgeSuggestionDenyListEntriesMetadata": { - "description": "Metadata related to the progress of the PurgeSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1alphaPurgeSuggestionDenyListEntriesMetadata", + "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpec": { + "description": "Boost specification to boost certain documents.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpec", "properties": { - "createTime": { - "description": "Operation create time.", - "format": "google-datetime", - "type": "string" - }, - "updateTime": { - "description": "Operation last update time. If the operation is done, this is also the finish time.", - "format": "google-datetime", - "type": "string" + "conditionBoostSpecs": { + "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.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpec" + }, + "type": "array" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaPurgeSuggestionDenyListEntriesRequest": { - "description": "Request message for CompletionService.PurgeSuggestionDenyListEntries method.", - "id": "GoogleCloudDiscoveryengineV1alphaPurgeSuggestionDenyListEntriesRequest", - "properties": {}, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1alphaPurgeSuggestionDenyListEntriesResponse": { - "description": "Response message for CompletionService.PurgeSuggestionDenyListEntries method.", - "id": "GoogleCloudDiscoveryengineV1alphaPurgeSuggestionDenyListEntriesResponse", + "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpec": { + "description": "Boost applies to documents which match a condition.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpec", "properties": { - "errorSamples": { - "description": "A sample of errors encountered while processing the request.", - "items": { - "$ref": "GoogleRpcStatus" - }, - "type": "array" + "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.", + "format": "float", + "type": "number" }, - "purgeCount": { - "description": "Number of suggestion deny list entries purged.", - "format": "int64", + "boostControlSpec": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpecBoostControlSpec", + "description": "Complex specification for custom ranking based on customer defined attribute value." + }, + "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" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaPurgeUserEventsMetadata": { - "description": "Metadata related to the progress of the PurgeUserEvents operation. This will be returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1alphaPurgeUserEventsMetadata", + "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.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpecBoostControlSpec", "properties": { - "createTime": { - "description": "Operation create time.", - "format": "google-datetime", + "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).", + "enum": [ + "ATTRIBUTE_TYPE_UNSPECIFIED", + "NUMERICAL", + "FRESHNESS" + ], + "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`." + ], "type": "string" }, - "failureCount": { - "description": "Count of entries that encountered errors while processing.", - "format": "int64", - "type": "string" + "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.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpecBoostControlSpecControlPoint" + }, + "type": "array" }, - "successCount": { - "description": "Count of entries that were deleted successfully.", - "format": "int64", + "fieldName": { + "description": "The name of the field whose value will be used to determine the boost amount.", "type": "string" }, - "updateTime": { - "description": "Operation last update time. If the operation is done, this is also the finish time.", - "format": "google-datetime", + "interpolationType": { + "description": "The interpolation type to be applied to connect the control points listed below.", + "enum": [ + "INTERPOLATION_TYPE_UNSPECIFIED", + "LINEAR" + ], + "enumDescriptions": [ + "Interpolation type is unspecified. In this case, it defaults to Linear.", + "Piecewise linear interpolation will be applied." + ], "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaPurgeUserEventsRequest": { - "description": "Request message for PurgeUserEvents method.", - "id": "GoogleCloudDiscoveryengineV1alphaPurgeUserEventsRequest", + "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).", + "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpecBoostControlSpecControlPoint", "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. 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.", + "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" }, - "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" + "boostAmount": { + "description": "The value between -1 to 1 by which to boost the score if the attribute_value evaluates to the value specified above.", + "format": "float", + "type": "number" } }, "type": "object" }, - "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.", - "id": "GoogleCloudDiscoveryengineV1alphaPurgeUserEventsResponse", + "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpec": { + "description": "A specification for configuring the behavior of content search.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpec", "properties": { - "purgeCount": { - "description": "The total count of events purged as a result of the operation.", - "format": "int64", + "chunkSpec": { + "$ref": "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" + }, + "extractiveContentSpec": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecExtractiveContentSpec", + "description": "If there is no extractive_content_spec provided, there will be no extractive answer in the search response." + }, + "searchResultMode": { + "description": "Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`.", + "enum": [ + "SEARCH_RESULT_MODE_UNSPECIFIED", + "DOCUMENTS", + "CHUNKS" + ], + "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." + ], "type": "string" + }, + "snippetSpec": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSnippetSpec", + "description": "If `snippetSpec` is not specified, snippets are not included in the search response." + }, + "summarySpec": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpec", + "description": "If `summarySpec` is not specified, summaries are not included in the search response." } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaQuery": { - "description": "Defines a user inputed query.", - "id": "GoogleCloudDiscoveryengineV1alphaQuery", + "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", + "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecChunkSpec", "properties": { - "queryId": { - "description": "Unique Id for the query.", - "type": "string" + "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.", + "format": "int32", + "type": "integer" }, - "text": { - "description": "Plain text.", - "type": "string" + "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.", + "format": "int32", + "type": "integer" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaRankRequest": { - "description": "Request message for RankService.Rank method.", - "id": "GoogleCloudDiscoveryengineV1alphaRankRequest", + "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecExtractiveContentSpec": { + "description": "A specification for configuring the extractive content in a search response.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecExtractiveContentSpec", "properties": { - "ignoreRecordDetailsInResponse": { - "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" - }, - "model": { - "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.", - "type": "string" + "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.", + "format": "int32", + "type": "integer" }, - "query": { - "description": "The query to use.", - "type": "string" + "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`.", + "format": "int32", + "type": "integer" }, - "records": { - "description": "Required. A list of records to rank. At most 200 records to rank.", - "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaRankingRecord" - }, - "type": "array" + "numNextSegments": { + "description": "Return at most `num_next_segments` segments after each selected segments.", + "format": "int32", + "type": "integer" }, - "topN": { - "description": "The number of results to return. If this is unset or no bigger than zero, returns all results.", + "numPreviousSegments": { + "description": "Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments.", "format": "int32", "type": "integer" }, - "userLabels": { - "additionalProperties": { - "type": "string" - }, - "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" + "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" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaRankResponse": { - "description": "Response message for RankService.Rank method.", - "id": "GoogleCloudDiscoveryengineV1alphaRankResponse", + "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSnippetSpec": { + "description": "A specification for configuring snippets in a search response.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSnippetSpec", "properties": { - "records": { - "description": "A list of records sorted by descending score.", - "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaRankingRecord" - }, - "type": "array" + "maxSnippetCount": { + "deprecated": true, + "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.", + "format": "int32", + "type": "integer" + }, + "referenceOnly": { + "deprecated": true, + "description": "[DEPRECATED] This field is deprecated and will have no affect on the snippet.", + "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" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaRankingRecord": { - "description": "Record message for RankService.Rank method.", - "id": "GoogleCloudDiscoveryengineV1alphaRankingRecord", + "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpec": { + "description": "A specification for configuring a summary returned in a search response.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpec", "properties": { - "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.", - "type": "string" + "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" }, - "id": { - "description": "The unique ID to represent the record.", - "type": "string" + "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" }, - "score": { - "description": "The score of this record based on the given query and selected model.", - "format": "float", - "type": "number" + "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" }, - "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.", + "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" + }, + "modelPromptSpec": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelPromptSpec", + "description": "If specified, the spec will be used to modify the prompt provided to the LLM." + }, + "modelSpec": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelSpec", + "description": "If specified, the spec will be used to modify the model specification provided to the LLM." + }, + "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.", + "format": "int32", + "type": "integer" + }, + "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" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaRecommendRequest": { - "description": "Request message for Recommend method.", - "id": "GoogleCloudDiscoveryengineV1alphaRecommendRequest", + "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelPromptSpec": { + "description": "Specification of the prompt to use with the model.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelPromptSpec", "properties": { - "filter": { - "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.", + "preamble": { + "description": "Text at the beginning of the prompt that instructs the assistant. Examples are available in the user guide.", "type": "string" - }, - "pageSize": { - "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.", - "format": "int32", - "type": "integer" - }, - "params": { - "additionalProperties": { - "type": "any" - }, - "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" - }, - "userEvent": { - "$ref": "GoogleCloudDiscoveryengineV1alphaUserEvent", - "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." - }, - "userLabels": { - "additionalProperties": { - "type": "string" - }, - "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" - }, - "validateOnly": { - "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.", - "type": "boolean" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaRecommendResponse": { - "description": "Response message for Recommend method.", - "id": "GoogleCloudDiscoveryengineV1alphaRecommendResponse", + "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelSpec": { + "description": "Specification of the model.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelSpec", "properties": { - "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.", + "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" - }, - "missingIds": { - "description": "IDs of documents in the request that were missing from the default Branch associated with the requested ServingConfig.", - "items": { - "type": "string" - }, - "type": "array" - }, - "results": { - "description": "A list of recommended Documents. The order represents the ranking (from the most relevant Document to the least).", + } + }, + "type": "object" + }, + "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` error is returned.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec", + "properties": { + "dataStore": { + "description": "Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpec": { + "description": "The specification that uses customized query embedding vector to do semantic document retrieval.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpec", + "properties": { + "embeddingVectors": { + "description": "The embedding vector used for retrieval. Limit to 1.", "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaRecommendResponseRecommendationResult" + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpecEmbeddingVector" }, "type": "array" - }, - "validateOnly": { - "description": "True if RecommendRequest.validate_only was set.", - "type": "boolean" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaRecommendResponseRecommendationResult": { - "description": "RecommendationResult represents a generic recommendation result with associated metadata.", - "id": "GoogleCloudDiscoveryengineV1alphaRecommendResponseRecommendationResult", + "GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpecEmbeddingVector": { + "description": "Embedding vector.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpecEmbeddingVector", "properties": { - "document": { - "$ref": "GoogleCloudDiscoveryengineV1alphaDocument", - "description": "Set if `returnDocument` is set to true in RecommendRequest.params." - }, - "id": { - "description": "Resource ID of the recommended Document.", + "fieldPath": { + "description": "Embedding field path in schema.", "type": "string" }, - "metadata": { - "additionalProperties": { - "type": "any" + "vector": { + "description": "Query embedding vector.", + "items": { + "format": "float", + "type": "number" }, - "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.", - "type": "object" + "type": "array" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaRecrawlUrisMetadata": { - "description": "Metadata related to the progress of the SiteSearchEngineService.RecrawlUris operation. This will be returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1alphaRecrawlUrisMetadata", + "GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpec": { + "description": "A facet specification to perform faceted search.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpec", "properties": { - "createTime": { - "description": "Operation create time.", - "format": "google-datetime", - "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" }, - "invalidUris": { - "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.", + "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.", "items": { "type": "string" }, "type": "array" }, - "pendingCount": { - "description": "Total number of URIs that have yet to be crawled.", - "format": "int32", - "type": "integer" - }, - "quotaExceededCount": { - "description": "Total number of URIs that were rejected due to insufficient indexing resources.", - "format": "int32", - "type": "integer" - }, - "successCount": { - "description": "Total number of URIs that have been crawled so far.", - "format": "int32", - "type": "integer" - }, - "updateTime": { - "description": "Operation last update time. If the operation is done, this is also the finish time.", - "format": "google-datetime", - "type": "string" + "facetKey": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpecFacetKey", + "description": "Required. The facet key specification." }, - "validUrisCount": { - "description": "Total number of unique URIs in the request that are not in invalid_uris.", + "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.", "format": "int32", "type": "integer" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaRecrawlUrisRequest": { - "description": "Request message for SiteSearchEngineService.RecrawlUris method.", - "id": "GoogleCloudDiscoveryengineV1alphaRecrawlUrisRequest", + "GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpecFacetKey": { + "description": "Specifies how a facet is computed.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpecFacetKey", "properties": { - "uris": { - "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`.", + "caseInsensitive": { + "description": "True to make facet keys case insensitive when getting faceting values with prefixes or contains; false otherwise.", + "type": "boolean" + }, + "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.", "items": { "type": "string" }, "type": "array" - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponse": { - "description": "Response message for SiteSearchEngineService.RecrawlUris method.", - "id": "GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponse", - "properties": { - "failedUris": { - "description": "URIs that were not crawled before the LRO terminated.", + }, + "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.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaInterval" + }, + "type": "array" + }, + "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" + }, + "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" + }, + "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.", "items": { "type": "string" }, "type": "array" }, - "failureSamples": { - "description": "Details for a sample of up to 10 `failed_uris`.", + "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.", "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfo" + "type": "string" }, "type": "array" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfo": { - "description": "Details about why a particular URI failed to be crawled. Each FailureInfo contains one FailureReason per CorpusType.", - "id": "GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfo", + "GoogleCloudDiscoveryengineV1alphaSearchRequestImageQuery": { + "description": "Specifies the image query input.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestImageQuery", "properties": { - "failureReasons": { - "description": "List of failure reasons by corpus type (e.g. desktop, mobile).", + "imageBytes": { + "description": "Base64 encoded image bytes. Supported image formats: JPEG, PNG, and BMP.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaSearchRequestNaturalLanguageQueryUnderstandingSpec": { + "description": "Specification to enable natural language understanding capabilities for search requests.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestNaturalLanguageQueryUnderstandingSpec", + "properties": { + "filterExtractionCondition": { + "description": "The condition under which filter extraction should occur. Default to Condition.DISABLED.", + "enum": [ + "CONDITION_UNSPECIFIED", + "DISABLED", + "ENABLED" + ], + "enumDescriptions": [ + "Server behavior defaults to Condition.DISABLED.", + "Disables NL filter extraction.", + "Enables NL filter extraction." + ], + "type": "string" + }, + "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.", "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfoFailureReason" + "type": "string" }, "type": "array" - }, - "uri": { - "description": "URI that failed to be crawled.", - "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfoFailureReason": { - "description": "Details about why crawling failed for a particular CorpusType, e.g., DESKTOP and MOBILE crawling may fail for different reasons.", - "id": "GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfoFailureReason", + "GoogleCloudDiscoveryengineV1alphaSearchRequestQueryExpansionSpec": { + "description": "Specification to determine under which conditions query expansion should occur.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestQueryExpansionSpec", "properties": { - "corpusType": { - "description": "DESKTOP, MOBILE, or CORPUS_TYPE_UNSPECIFIED.", + "condition": { + "description": "The condition under which query expansion should occur. Default to Condition.DISABLED.", "enum": [ - "CORPUS_TYPE_UNSPECIFIED", - "DESKTOP", - "MOBILE" + "CONDITION_UNSPECIFIED", + "DISABLED", + "AUTO" ], "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 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." ], "type": "string" }, - "errorMessage": { - "description": "Reason why the URI was not crawled.", - "type": "string" + "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" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaReply": { - "description": "Defines a reply message to user.", - "id": "GoogleCloudDiscoveryengineV1alphaReply", + "GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAsYouTypeSpec": { + "description": "Specification for search as you type in search requests.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAsYouTypeSpec", "properties": { - "references": { - "deprecated": true, - "description": "References in the reply.", - "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaReplyReference" - }, - "type": "array" - }, - "reply": { - "deprecated": true, - "description": "DEPRECATED: use `summary` instead. Text reply.", + "condition": { + "description": "The condition under which search as you type should occur. Default to Condition.DISABLED.", + "enum": [ + "CONDITION_UNSPECIFIED", + "DISABLED", + "ENABLED" + ], + "enumDescriptions": [ + "Server behavior defaults to Condition.DISABLED.", + "Disables Search As You Type.", + "Enables Search As You Type." + ], "type": "string" - }, - "summary": { - "$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseSummary", - "description": "Summary based on search results." } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaReplyReference": { - "deprecated": true, - "description": "Defines reference in reply.", - "id": "GoogleCloudDiscoveryengineV1alphaReplyReference", + "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.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestSessionSpec", "properties": { - "anchorText": { - "description": "Anchor text.", + "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" }, - "end": { - "description": "Anchor text end index.", - "format": "int32", - "type": "integer" - }, - "start": { - "description": "Anchor text start index.", + "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.", "format": "int32", "type": "integer" - }, - "uri": { - "description": "URI link reference.", - "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaReportConsentChangeRequest": { - "description": "Request for ReportConsentChange method.", - "id": "GoogleCloudDiscoveryengineV1alphaReportConsentChangeRequest", + "GoogleCloudDiscoveryengineV1alphaSearchRequestSpellCorrectionSpec": { + "description": "The specification for query spell correction.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestSpellCorrectionSpec", "properties": { - "consentChangeAction": { - "description": "Required. Whether customer decides to accept or decline service term. At this moment, only accept action is supported.", + "mode": { + "description": "The mode under which spell correction replaces the original search query. Defaults to Mode.AUTO.", "enum": [ - "CONSENT_CHANGE_ACTION_UNSPECIFIED", - "ACCEPT" + "MODE_UNSPECIFIED", + "SUGGESTION_ONLY", + "AUTO" ], "enumDescriptions": [ - "Invalid action, user must specify accept/decline", - "User accepts service terms." + "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." ], "type": "string" - }, - "serviceTermId": { - "description": "Required. The unique identifier of the terms of service to update. Available term ids: * `GA_DATA_USE_TERMS`: [Terms for data use](https://cloud.google.com/retail/data-use-terms). When using this service term id, the acceptable service_term_version to provide is `2022-11-23`.", - "type": "string" - }, - "serviceTermVersion": { - "description": "Required. The version string of the terms of service to update.", - "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaRequirement": { - "description": "A data requirement.", - "id": "GoogleCloudDiscoveryengineV1alphaRequirement", + "GoogleCloudDiscoveryengineV1alphaSearchResponse": { + "description": "Response message for SearchService.Search method.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchResponse", "properties": { - "condition": { - "$ref": "GoogleTypeExpr", - "description": "The condition for evaluating the requirement result. Variables in the expression should be provided by `metrics_bindings` or `threshold_bindings`. Where `metrics_bindings` are used for computed metrics and `threshold_bindings` are used to define thresholds for corresponding `metric_bindings`." + "appliedControls": { + "description": "Controls applied as part of the Control service.", + "items": { + "type": "string" + }, + "type": "array" }, - "description": { - "description": "The description of the requirement.", + "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.", "type": "string" }, - "displayName": { - "description": "The name of the requirement.", + "correctedQuery": { + "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.", "type": "string" }, - "metricBindings": { - "description": "A list of the metric bindings to be used in `condition`.", + "facets": { + "description": "Results of facets requested by user.", "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaRequirementMetricBinding" + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseFacet" }, "type": "array" }, - "thresholdBindings": { - "description": "A list of threshold bindings to be used in `condition`.", + "geoSearchDebugInfo": { "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaRequirementThresholdBinding" + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseGeoSearchDebugInfo" }, "type": "array" }, - "type": { - "description": "The requirement type, used as an identifier. Must be unique. The type should prefix with service name to avoid possible collision. It's encouraged to use natural hierarchical grouping for similar requirements. Examples: * `library.googleapis.com/books/min_available_books` * `discoveryengine.googleapis.com/media_rec/recommended_for_you/conversion_rate`", - "type": "string" + "guidedSearchResult": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseGuidedSearchResult", + "description": "Guided search result." }, - "violationSamplesBindings": { - "description": "A list of the metric bindings to be used in `condition`.", - "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaRequirementViolationSamplesBinding" - }, - "type": "array" - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1alphaRequirementMetricBinding": { - "description": "Specifies a metrics query and bind its result to a variable which will be used in the `condition`.", - "id": "GoogleCloudDiscoveryengineV1alphaRequirementMetricBinding", - "properties": { - "category": { - "description": "The category of the metric's target resource. Example: \"Events\"", - "type": "string" + "naturalLanguageQueryUnderstandingInfo": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfo", + "description": "Natural language query understanding information for the returned results." }, - "description": { - "description": "Human readable description of the corresponding metric filter.", + "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.", "type": "string" }, - "metricFilter": { - "description": "The filter string used for metrics query. Example: \"metric.type = \\\"discoveryengine.googleapis.com/events/day_count\\\" AND \" \"metric.conditions.time_range = \\\"NINETY_DAYS\\\"\"", - "type": "string" + "queryExpansionInfo": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseQueryExpansionInfo", + "description": "Query expansion information for the returned results." }, - "resourceType": { - "description": "The resource being monitored for the metric.", + "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.", "type": "string" }, - "variableId": { - "description": "The variable id to be referenced in `condition`.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1alphaRequirementThresholdBinding": { - "description": "Specifies a multi-level threshold to apply to apply to a `metric_bindings` in the `condition` CEL expression.", - "id": "GoogleCloudDiscoveryengineV1alphaRequirementThresholdBinding", - "properties": { - "blockingThreshold": { - "description": "Threshold to trigger a blocking failure. If not met, the requirement will evaluate as a `FAILURE`.", - "format": "double", - "type": "number" + "results": { + "description": "A list of matched documents. The order represents the ranking.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseSearchResult" + }, + "type": "array" }, - "description": { - "description": "Human readable description of the corresponding threshold and sub-requirement.", - "type": "string" + "sessionInfo": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseSessionInfo", + "description": "Session information. Only set if SearchRequest.session is provided. See its description for more details." }, - "variableId": { - "description": "The variable id to be referenced in `condition`. Must be unique across all `metric_bindings` and `threshold_bindings`.", - "type": "string" + "summary": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseSummary", + "description": "A summary as part of the search results. This field is only returned if SearchRequest.ContentSearchSpec.summary_spec is set." }, - "warningThreshold": { - "description": "Threshold to trigger a warning. If not met, the requirement will evaluate as a `WARNING`.", - "format": "double", - "type": "number" + "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.", + "format": "int32", + "type": "integer" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaRequirementViolationSamplesBinding": { - "description": "Specifies a samples query and bind its result to a variable which will be used in the `condition`.", - "id": "GoogleCloudDiscoveryengineV1alphaRequirementViolationSamplesBinding", + "GoogleCloudDiscoveryengineV1alphaSearchResponseFacet": { + "description": "A facet result.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchResponseFacet", "properties": { - "description": { - "description": "Description of this sample binding. Used by the UI to render user friendly descriptions for each requirement condition. Should be less than 128 characters long.", - "type": "string" + "dynamicFacet": { + "description": "Whether the facet is dynamically generated.", + "type": "boolean" }, - "sampleFilter": { - "description": "The filter string used for samples query. Example: \"sample.type = \\\"retail.googleapis.com/user_event\\\" AND \" \"sample.labels.event_type = \\\"PURCHASE\\\" \"", + "key": { + "description": "The key for this facet. For example, `\"colors\"` or `\"price\"`. It matches SearchRequest.FacetSpec.FacetKey.key.", "type": "string" }, - "variableId": { - "description": "The variable id to be referenced in `condition`.", - "type": "string" + "values": { + "description": "The facet values for this field.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseFacetFacetValue" + }, + "type": "array" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaResumeEngineRequest": { - "description": "Request for resuming training of an engine.", - "id": "GoogleCloudDiscoveryengineV1alphaResumeEngineRequest", - "properties": {}, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1alphaSchema": { - "description": "Defines the structure and layout of a type of document data.", - "id": "GoogleCloudDiscoveryengineV1alphaSchema", + "GoogleCloudDiscoveryengineV1alphaSearchResponseFacetFacetValue": { + "description": "A facet value which contains value names and their count.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchResponseFacetFacetValue", "properties": { - "fieldConfigs": { - "description": "Output only. Configurations for fields of the schema.", - "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaFieldConfig" - }, - "readOnly": true, - "type": "array" - }, - "jsonSchema": { - "description": "The JSON representation of the schema.", + "count": { + "description": "Number of items that have this facet value.", + "format": "int64", "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" + "interval": { + "$ref": "GoogleCloudDiscoveryengineV1alphaInterval", + "description": "Interval value for a facet, such as 10, 20) for facet \"price\". It matches [SearchRequest.FacetSpec.FacetKey.intervals." }, - "structSchema": { - "additionalProperties": { - "description": "Properties of the object.", - "type": "any" - }, - "description": "The structured representation of the schema.", - "type": "object" + "value": { + "description": "Text value of a facet, such as \"Black\" for facet \"colors\".", + "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaSearchInfo": { - "description": "Detailed search information.", - "id": "GoogleCloudDiscoveryengineV1alphaSearchInfo", + "GoogleCloudDiscoveryengineV1alphaSearchResponseGeoSearchDebugInfo": { + "description": "Debug information specifically related to forward geocoding issues arising from Geolocation Search.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchResponseGeoSearchDebugInfo", "properties": { - "offset": { - "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.", - "format": "int32", - "type": "integer" - }, - "orderBy": { - "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.", + "errorMessage": { + "description": "The error produced.", "type": "string" }, - "searchQuery": { - "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.", + "originalAddressQuery": { + "description": "The address from which forward geocoding ingestion produced issues.", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaSearchRequest": { - "description": "Request message for SearchService.Search method.", - "id": "GoogleCloudDiscoveryengineV1alphaSearchRequest", + "GoogleCloudDiscoveryengineV1alphaSearchResponseGuidedSearchResult": { + "description": "Guided search result. The guided search helps user to refine the search results and narrow down to the real needs from a broaded search results.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchResponseGuidedSearchResult", "properties": { - "boostSpec": { - "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpec", - "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)" - }, - "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" - }, - "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" - }, - "contentSearchSpec": { - "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpec", - "description": "A specification for configuring the behavior of content search." - }, - "customFineTuningSpec": { - "$ref": "GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec", - "description": "Custom fine tuning configs." - }, - "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.", - "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec" - }, - "type": "array" - }, - "embeddingSpec": { - "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpec", - "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." - }, - "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.", + "followUpQuestions": { + "description": "Suggested follow-up questions.", "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpec" + "type": "string" }, "type": "array" }, - "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)", + "refinementAttributes": { + "description": "A list of ranked refinement attributes.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseGuidedSearchResultRefinementAttribute" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaSearchResponseGuidedSearchResultRefinementAttribute": { + "description": "Useful attribute for search result refinements.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchResponseGuidedSearchResultRefinementAttribute", + "properties": { + "attributeKey": { + "description": "Attribute key used to refine the results. For example, `\"movie_type\"`.", "type": "string" }, - "imageQuery": { - "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestImageQuery", - "description": "Raw image query." - }, - "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.", + "attributeValue": { + "description": "Attribute value used to refine the results. For example, `\"drama\"`.", "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.", - "format": "int32", - "type": "integer" - }, - "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 for retail search, see [Ordering](https://cloud.google.com/retail/docs/filter-and-order#order) If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.", + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfo": { + "description": "Information describing what natural language understanding was done on the input query.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfo", + "properties": { + "extractedFilters": { + "description": "The filters that were extracted from the input query.", "type": "string" }, - "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.", - "format": "int32", - "type": "integer" - }, - "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.", + "rewrittenQuery": { + "description": "Rewritten input query minus the extracted filters.", "type": "string" }, - "params": { - "additionalProperties": { - "type": "any" + "structuredExtractedFilter": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilter", + "description": "The filters that were extracted from the input query represented in a structured form." + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilter": { + "description": "The filters that were extracted from the input query represented in a structured form.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilter", + "properties": { + "expression": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterExpression", + "description": "The expression denoting the filter that was extracted from the input query in a structured form. It can be a simple expression denoting a single string, numerical or geolocation constraint or a compound expression which is a combination of multiple expressions connected using logical (OR and AND) operators." + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterAndExpression": { + "description": "Logical `And` operator.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterAndExpression", + "properties": { + "expressions": { + "description": "The expressions that were ANDed together.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterExpression" }, - "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" + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterExpression": { + "description": "The expression denoting the filter that was extracted from the input query.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterExpression", + "properties": { + "andExpr": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterAndExpression", + "description": "Logical \"And\" compound operator connecting multiple expressions." }, - "query": { - "description": "Raw search query.", - "type": "string" + "geolocationConstraint": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterGeolocationConstraint", + "description": "Geolocation constraint expression." }, - "queryExpansionSpec": { - "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestQueryExpansionSpec", - "description": "The query expansion specification that specifies the conditions under which query expansion occurs." + "numberConstraint": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterNumberConstraint", + "description": "Numerical constraint expression." }, - "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 joint 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)`.", + "orExpr": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterOrExpression", + "description": "Logical \"Or\" compound operator connecting multiple expressions." + }, + "stringConstraint": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterStringConstraint", + "description": "String constraint expression." + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterGeolocationConstraint": { + "description": "Constraint of a geolocation field. Name of the geolocation field as defined in the schema.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterGeolocationConstraint", + "properties": { + "address": { + "description": "The reference address that was inferred from the input query. The proximity of the reference address to the geolocation field will be used to filter the results.", "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.", + "fieldName": { + "description": "The name of the geolocation field as defined in the schema.", "type": "string" }, - "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.", + "radiusInMeters": { + "description": "The radius in meters around the address. The record is returned if the location of the geolocation field is within the radius.", + "format": "float", + "type": "number" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterNumberConstraint": { + "description": "Constraint expression of a number field. Example: price < 100.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterNumberConstraint", + "properties": { + "comparison": { + "description": "The comparison operation performed between the field value and the value specified in the constraint.", "enum": [ - "RELEVANCE_THRESHOLD_UNSPECIFIED", - "LOWEST", - "LOW", - "MEDIUM", - "HIGH" + "COMPARISON_UNSPECIFIED", + "EQUALS", + "LESS_THAN_EQUALS", + "LESS_THAN", + "GREATER_THAN_EQUALS", + "GREATER_THAN" ], "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." + "Undefined comparison operator.", + "Denotes equality `=` operator.", + "Denotes less than or equal to `<=` operator.", + "Denotes less than `<` operator.", + "Denotes greater than or equal to `>=` operator.", + "Denotes greater than `>` operator." ], "type": "string" }, - "safeSearch": { - "description": "Whether to turn on safe search. This is only supported for website search.", + "fieldName": { + "description": "Name of the numerical field as defined in the schema.", + "type": "string" + }, + "value": { + "description": "The value specified in the numerical constraint.", + "format": "double", + "type": "number" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterOrExpression": { + "description": "Logical `Or` operator.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterOrExpression", + "properties": { + "expressions": { + "description": "The expressions that were ORed together.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterExpression" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterStringConstraint": { + "description": "Constraint expression of a string field.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterStringConstraint", + "properties": { + "fieldName": { + "description": "Name of the string field as defined in the schema.", + "type": "string" + }, + "values": { + "description": "Values of the string field. The record will only be returned if the field value matches one of the values specified here.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaSearchResponseQueryExpansionInfo": { + "description": "Information describing query expansion including whether expansion has occurred.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchResponseQueryExpansionInfo", + "properties": { + "expandedQuery": { + "description": "Bool describing whether query expansion has occurred.", "type": "boolean" }, - "searchAsYouTypeSpec": { - "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAsYouTypeSpec", - "description": "Search as you type configuration. Only supported for the IndustryVertical.MEDIA vertical." + "pinnedResultCount": { + "description": "Number of pinned results. This field will only be set when expansion happens and SearchRequest.QueryExpansionSpec.pin_unexpanded_results is set to true.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaSearchResponseSearchResult": { + "description": "Represents the search results.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchResponseSearchResult", + "properties": { + "chunk": { + "$ref": "GoogleCloudDiscoveryengineV1alphaChunk", + "description": "The chunk data in the search response if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS." }, - "spellCorrectionSpec": { - "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestSpellCorrectionSpec", - "description": "The spell correction specification that specifies the mode under which spell correction takes effect." + "document": { + "$ref": "GoogleCloudDiscoveryengineV1alphaDocument", + "description": "The document data snippet in the search response. Only fields that are marked as `retrievable` are populated." }, - "userInfo": { - "$ref": "GoogleCloudDiscoveryengineV1alphaUserInfo", - "description": "Information about the end user. Highly recommended for analytics. UserInfo.user_agent is used to deduce `device_type` for analytics." + "id": { + "description": "Document.id of the searched Document.", + "type": "string" }, - "userLabels": { + "modelScores": { "additionalProperties": { - "type": "string" + "$ref": "GoogleCloudDiscoveryengineV1alphaDoubleList" }, - "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.", + "description": "Google provided available scores.", "type": "object" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaSearchResponseSessionInfo": { + "description": "Information about the session.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchResponseSessionInfo", + "properties": { + "name": { + "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.", + "type": "string" }, - "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.", + "queryId": { + "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" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpec": { - "description": "Boost specification to boost certain documents.", - "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpec", + "GoogleCloudDiscoveryengineV1alphaSearchResponseSummary": { + "description": "Summary of the top N search results specified by the summary spec.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchResponseSummary", "properties": { - "conditionBoostSpecs": { - "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.", + "safetyAttributes": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseSummarySafetyAttributes", + "description": "A collection of Safety Attribute categories and their associated confidence scores." + }, + "summarySkippedReasons": { + "description": "Additional summary-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set.", "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpec" + "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" + ], + "enumDescriptions": [ + "Default value. The summary skipped reason is not specified.", + "The adversarial query ignored case. Only populated when SummarySpec.ignore_adversarial_query is set to `true`.", + "The non-summary seeking query ignored case. Only populated 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." + ], + "type": "string" }, "type": "array" + }, + "summaryText": { + "description": "The summary content.", + "type": "string" + }, + "summaryWithMetadata": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseSummarySummaryWithMetadata", + "description": "Summary with metadata information." } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpec": { - "description": "Boost applies to documents which match a condition.", - "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpec", + "GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryCitation": { + "description": "Citation info for a segment.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryCitation", "properties": { - "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.", - "format": "float", - "type": "number" + "endIndex": { + "description": "End of the attributed segment, exclusive.", + "format": "int64", + "type": "string" }, - "boostControlSpec": { - "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpecBoostControlSpec", - "description": "Complex specification for custom ranking based on customer defined attribute value." + "sources": { + "description": "Citation sources for the attributed segment.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryCitationSource" + }, + "type": "array" }, - "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\"))`", + "startIndex": { + "description": "Index indicates the start of the segment, measured in bytes/unicode.", + "format": "int64", "type": "string" } }, "type": "object" }, - "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.", - "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpecBoostControlSpec", + "GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryCitationMetadata": { + "description": "Citation metadata.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryCitationMetadata", "properties": { - "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).", - "enum": [ - "ATTRIBUTE_TYPE_UNSPECIFIED", - "NUMERICAL", - "FRESHNESS" - ], - "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`." - ], - "type": "string" - }, - "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.", + "citations": { + "description": "Citations for segments.", "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpecBoostControlSpecControlPoint" + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryCitation" }, "type": "array" - }, - "fieldName": { - "description": "The name of the field whose value will be used to determine the boost amount.", - "type": "string" - }, - "interpolationType": { - "description": "The interpolation type to be applied to connect the control points listed below.", - "enum": [ - "INTERPOLATION_TYPE_UNSPECIFIED", - "LINEAR" - ], - "enumDescriptions": [ - "Interpolation type is unspecified. In this case, it defaults to Linear.", - "Piecewise linear interpolation will be applied." - ], - "type": "string" } }, "type": "object" }, - "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).", - "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpecBoostControlSpecControlPoint", + "GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryCitationSource": { + "description": "Citation source.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryCitationSource", "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]`.", + "referenceIndex": { + "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.", + "format": "int64", "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.", - "format": "float", - "type": "number" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpec": { - "description": "A specification for configuring the behavior of content search.", - "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpec", + "GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryReference": { + "description": "Document reference.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryReference", "properties": { - "chunkSpec": { - "$ref": "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" - }, - "extractiveContentSpec": { - "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecExtractiveContentSpec", - "description": "If there is no extractive_content_spec provided, there will be no extractive answer in the search response." + "chunkContents": { + "description": "List of cited chunk contents derived from document content.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryReferenceChunkContent" + }, + "type": "array" }, - "searchResultMode": { - "description": "Specifies the search result mode. If unspecified, the search result mode is based on DataStore.DocumentProcessingConfig.chunking_config: * If DataStore.DocumentProcessingConfig.chunking_config is specified, it defaults to `CHUNKS`. * Otherwise, it defaults to `DOCUMENTS`.", - "enum": [ - "SEARCH_RESULT_MODE_UNSPECIFIED", - "DOCUMENTS", - "CHUNKS" - ], - "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." - ], + "document": { + "description": "Required. Document.name of the document. Full resource name of the referenced document, in the format `projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*`.", "type": "string" }, - "snippetSpec": { - "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSnippetSpec", - "description": "If `snippetSpec` is not specified, snippets are not included in the search response." + "title": { + "description": "Title of the document.", + "type": "string" }, - "summarySpec": { - "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpec", - "description": "If `summarySpec` is not specified, summaries are not included in the search response." + "uri": { + "description": "Cloud Storage or HTTP uri for the document.", + "type": "string" } }, "type": "object" }, - "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", - "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecChunkSpec", + "GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryReferenceChunkContent": { + "description": "Chunk content.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryReferenceChunkContent", "properties": { - "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.", - "format": "int32", - "type": "integer" + "content": { + "description": "Chunk textual content.", + "type": "string" }, - "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.", - "format": "int32", - "type": "integer" + "pageIdentifier": { + "description": "Page identifier.", + "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecExtractiveContentSpec": { - "description": "A specification for configuring the extractive content in a search response.", - "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecExtractiveContentSpec", + "GoogleCloudDiscoveryengineV1alphaSearchResponseSummarySafetyAttributes": { + "description": "Safety Attribute categories and their associated confidence scores.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchResponseSummarySafetyAttributes", "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.", - "format": "int32", - "type": "integer" - }, - "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`.", - "format": "int32", - "type": "integer" - }, - "numNextSegments": { - "description": "Return at most `num_next_segments` segments after each selected segments.", - "format": "int32", - "type": "integer" - }, - "numPreviousSegments": { - "description": "Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments.", - "format": "int32", - "type": "integer" + "categories": { + "description": "The display names of Safety Attribute categories associated with the generated content. Order matches the Scores.", + "items": { + "type": "string" + }, + "type": "array" }, - "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" + "scores": { + "description": "The confidence scores of the each category, higher value means higher confidence. Order matches the Categories.", + "items": { + "format": "float", + "type": "number" + }, + "type": "array" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSnippetSpec": { - "description": "A specification for configuring snippets in a search response.", - "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSnippetSpec", + "GoogleCloudDiscoveryengineV1alphaSearchResponseSummarySummaryWithMetadata": { + "description": "Summary with metadata information.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchResponseSummarySummaryWithMetadata", "properties": { - "maxSnippetCount": { - "deprecated": true, - "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.", - "format": "int32", - "type": "integer" + "citationMetadata": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryCitationMetadata", + "description": "Citation metadata for given summary." }, - "referenceOnly": { - "deprecated": true, - "description": "[DEPRECATED] This field is deprecated and will have no affect on the snippet.", - "type": "boolean" + "references": { + "description": "Document References.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryReference" + }, + "type": "array" }, - "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" + "summary": { + "description": "Summary text with no citation information.", + "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpec": { - "description": "A specification for configuring a summary returned in a search response.", - "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpec", + "GoogleCloudDiscoveryengineV1alphaServingConfig": { + "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.", + "id": "GoogleCloudDiscoveryengineV1alphaServingConfig", "properties": { - "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" + "boostControlIds": { + "description": "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.", + "items": { + "type": "string" + }, + "type": "array" + }, + "createTime": { + "description": "Output only. ServingConfig created timestamp.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "customFineTuningSpec": { + "$ref": "GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec", + "description": "Custom fine tuning configs. If SearchRequest.custom_fine_tuning_spec is set, it has higher priority than the configs set here." + }, + "displayName": { + "description": "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" + }, + "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.", + "items": { + "type": "string" + }, + "type": "array" + }, + "diversityLevel": { + "description": "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" + }, + "embeddingConfig": { + "$ref": "GoogleCloudDiscoveryengineV1alphaEmbeddingConfig", + "description": "Bring your own embedding config. The config is used for search semantic retrieval. The retrieval is based on the dot product of SearchRequest.EmbeddingSpec.EmbeddingVector.vector and the document embeddings that are provided by this EmbeddingConfig. If SearchRequest.EmbeddingSpec.EmbeddingVector.vector is provided, it overrides this ServingConfig.embedding_config." + }, + "filterControlIds": { + "description": "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.", + "items": { + "type": "string" + }, + "type": "array" + }, + "genericConfig": { + "$ref": "GoogleCloudDiscoveryengineV1alphaServingConfigGenericConfig", + "description": "The GenericConfig of the serving configuration." + }, + "guidedSearchSpec": { + "$ref": "GoogleCloudDiscoveryengineV1alphaGuidedSearchSpec", + "description": "Guided search configs." + }, + "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.", + "items": { + "type": "string" + }, + "type": "array" }, - "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" + "mediaConfig": { + "$ref": "GoogleCloudDiscoveryengineV1alphaServingConfigMediaConfig", + "description": "The MediaConfig of the serving configuration." }, - "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" + "modelId": { + "description": "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" }, - "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.", + "name": { + "description": "Immutable. Fully qualified name `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}/servingConfigs/{serving_config_id}`", "type": "string" }, - "modelPromptSpec": { - "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelPromptSpec", - "description": "If specified, the spec will be used to modify the prompt provided to the LLM." + "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.", + "items": { + "type": "string" + }, + "type": "array" }, - "modelSpec": { - "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelSpec", - "description": "If specified, the spec will be used to modify the model specification provided to the LLM." + "rankingExpression": { + "description": "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" }, - "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.", - "format": "int32", - "type": "integer" + "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.", + "items": { + "type": "string" + }, + "type": "array" }, - "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" - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelPromptSpec": { - "description": "Specification of the prompt to use with the model.", - "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelPromptSpec", - "properties": { - "preamble": { - "description": "Text at the beginning of the prompt that instructs the assistant. Examples are available in the user guide.", + "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.", + "items": { + "type": "string" + }, + "type": "array" + }, + "solutionType": { + "description": "Required. Immutable. Specifies the solution type that a serving config can be associated with.", + "enum": [ + "SOLUTION_TYPE_UNSPECIFIED", + "SOLUTION_TYPE_RECOMMENDATION", + "SOLUTION_TYPE_SEARCH", + "SOLUTION_TYPE_CHAT", + "SOLUTION_TYPE_GENERATIVE_CHAT" + ], + "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." + ], + "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.", + "items": { + "type": "string" + }, + "type": "array" + }, + "updateTime": { + "description": "Output only. ServingConfig updated timestamp.", + "format": "google-datetime", + "readOnly": true, "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelSpec": { - "description": "Specification of the model.", - "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelSpec", + "GoogleCloudDiscoveryengineV1alphaServingConfigGenericConfig": { + "description": "Specifies the configurations needed for Generic Discovery.Currently we support: * `content_search_spec`: configuration for generic content search.", + "id": "GoogleCloudDiscoveryengineV1alphaServingConfigGenericConfig", "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" + "contentSearchSpec": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpec", + "description": "Specifies the expected behavior of content search. Only valid for content-search enabled data store." } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec": { - "description": "A struct to define data stores to filter on in a search call and configurations for those data stores. A maximum of 1 DataStoreSpec per data_store is allowed. Otherwise, an `INVALID_ARGUMENT` error is returned.", - "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec", + "GoogleCloudDiscoveryengineV1alphaServingConfigMediaConfig": { + "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.", + "id": "GoogleCloudDiscoveryengineV1alphaServingConfigMediaConfig", "properties": { - "dataStore": { - "description": "Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`.", + "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.", + "format": "int32", + "type": "integer" + }, + "contentWatchedPercentageThreshold": { + "description": "Specifies the content watched percentage threshold for demotion. Threshold value must be between [0, 1.0] inclusive.", + "format": "float", + "type": "number" + }, + "contentWatchedSecondsThreshold": { + "description": "Specifies the content watched minutes threshold for demotion.", + "format": "float", + "type": "number" + }, + "demotionEventType": { + "description": "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" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpec": { - "description": "The specification that uses customized query embedding vector to do semantic document retrieval.", - "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpec", + "GoogleCloudDiscoveryengineV1alphaSession": { + "description": "External session proto definition.", + "id": "GoogleCloudDiscoveryengineV1alphaSession", "properties": { - "embeddingVectors": { - "description": "The embedding vector used for retrieval. Limit to 1.", + "endTime": { + "description": "Output only. The time the session finished.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*`", + "type": "string" + }, + "startTime": { + "description": "Output only. The time the session started.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "state": { + "description": "The state of the session.", + "enum": [ + "STATE_UNSPECIFIED", + "IN_PROGRESS" + ], + "enumDescriptions": [ + "State is unspecified.", + "The session is currently open." + ], + "type": "string" + }, + "turns": { + "description": "Turns.", "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpecEmbeddingVector" + "$ref": "GoogleCloudDiscoveryengineV1alphaSessionTurn" }, "type": "array" + }, + "userPseudoId": { + "description": "A unique identifier for tracking users.", + "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpecEmbeddingVector": { - "description": "Embedding vector.", - "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpecEmbeddingVector", + "GoogleCloudDiscoveryengineV1alphaSessionTurn": { + "description": "Represents a turn, including a query from the user and a answer from service.", + "id": "GoogleCloudDiscoveryengineV1alphaSessionTurn", "properties": { - "fieldPath": { - "description": "Embedding field path in schema.", + "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" }, - "vector": { - "description": "Query embedding vector.", - "items": { - "format": "float", - "type": "number" - }, - "type": "array" + "query": { + "$ref": "GoogleCloudDiscoveryengineV1alphaQuery", + "description": "The user query." } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpec": { - "description": "A facet specification to perform faceted search.", - "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpec", + "GoogleCloudDiscoveryengineV1alphaSetUriPatternDocumentDataMetadata": { + "description": "Metadata related to the progress of the SiteSearchEngineService.SetUriPatternDocumentData operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1alphaSetUriPatternDocumentDataMetadata", "properties": { - "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" - }, - "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.", - "items": { - "type": "string" - }, - "type": "array" - }, - "facetKey": { - "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpecFacetKey", - "description": "Required. The facet key specification." + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", + "type": "string" }, - "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.", - "format": "int32", - "type": "integer" + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", + "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpecFacetKey": { - "description": "Specifies how a facet is computed.", - "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpecFacetKey", + "GoogleCloudDiscoveryengineV1alphaSetUriPatternDocumentDataRequest": { + "description": "Request message for SiteSearchEngineService.SetUriPatternDocumentData method.", + "id": "GoogleCloudDiscoveryengineV1alphaSetUriPatternDocumentDataRequest", "properties": { - "caseInsensitive": { - "description": "True to make facet keys case insensitive when getting faceting values with prefixes or contains; false otherwise.", - "type": "boolean" - }, - "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.", - "items": { - "type": "string" - }, - "type": "array" - }, - "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.", - "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaInterval" - }, - "type": "array" - }, - "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" - }, - "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" - }, - "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.", - "items": { - "type": "string" + "documentDataMap": { + "additionalProperties": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "type": "object" }, - "type": "array" + "description": "Document data keyed by URI pattern. Each entry must be consistent with the Schema. For example: Schema = { \"type\": \"object\", \"properties\": { \"Categories\": { \"type\": \"array\", \"items\": { \"retrievable\": true, \"type\": \"string\" } } } document_data_map = { \"www.url1.com/*\": { \"Categories\": [\"category1\", \"category2\"] }, \"www.url2.com/*\": { \"Categories\": [\"category3\"] } }", + "type": "object" }, - "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.", - "items": { - "type": "string" + "emptyDocumentDataMap": { + "description": "If true, clears the document data map. If true, SetUriPatternDocumentDataRequest.document_data_map must be empty.", + "type": "boolean" + }, + "schema": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" }, - "type": "array" + "description": "Optional. If not provided, the current Schema is used. If provided, validates and updates the Schema. If validation fails, an error is returned.", + "type": "object" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaSearchRequestImageQuery": { - "description": "Specifies the image query input.", - "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestImageQuery", + "GoogleCloudDiscoveryengineV1alphaSetUriPatternDocumentDataResponse": { + "description": "Response message for SiteSearchEngineService.SetUriPatternDocumentData method.", + "id": "GoogleCloudDiscoveryengineV1alphaSetUriPatternDocumentDataResponse", + "properties": {}, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaSiteSearchEngine": { + "description": "SiteSearchEngine captures DataStore level site search persisting configurations. It is a singleton value per data store.", + "id": "GoogleCloudDiscoveryengineV1alphaSiteSearchEngine", "properties": { - "imageBytes": { - "description": "Base64 encoded image bytes. Supported image formats: JPEG, PNG, and BMP.", + "name": { + "description": "The fully qualified resource name of the site search engine. Format: `projects/*/locations/*/dataStores/*/siteSearchEngine`", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaSearchRequestQueryExpansionSpec": { - "description": "Specification to determine under which conditions query expansion should occur.", - "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestQueryExpansionSpec", + "GoogleCloudDiscoveryengineV1alphaSiteVerificationInfo": { + "description": "Verification information for target sites in advanced site search.", + "id": "GoogleCloudDiscoveryengineV1alphaSiteVerificationInfo", "properties": { - "condition": { - "description": "The condition under which query expansion should occur. Default to Condition.DISABLED.", + "siteVerificationState": { + "description": "Site verification state indicating the ownership and validity.", "enum": [ - "CONDITION_UNSPECIFIED", - "DISABLED", - "AUTO" + "SITE_VERIFICATION_STATE_UNSPECIFIED", + "VERIFIED", + "UNVERIFIED", + "EXEMPTED" ], "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." + "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." ], "type": "string" }, - "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" + "verifyTime": { + "description": "Latest site verification time.", + "format": "google-datetime", + "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAsYouTypeSpec": { - "description": "Specification for search as you type in search requests.", - "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAsYouTypeSpec", + "GoogleCloudDiscoveryengineV1alphaSpannerSource": { + "description": "The Spanner source for importing data", + "id": "GoogleCloudDiscoveryengineV1alphaSpannerSource", "properties": { - "condition": { - "description": "The condition under which search as you type should occur. Default to Condition.DISABLED.", - "enum": [ - "CONDITION_UNSPECIFIED", - "DISABLED", - "ENABLED" - ], - "enumDescriptions": [ - "Server behavior defaults to Condition.DISABLED.", - "Disables Search As You Type.", - "Enables Search As You Type." - ], + "databaseId": { + "description": "Required. The database ID of the source Spanner table.", + "type": "string" + }, + "enableDataBoost": { + "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" + }, + "instanceId": { + "description": "Required. The instance ID of the source Spanner table.", + "type": "string" + }, + "projectId": { + "description": "The project ID that the Spanner source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request.", + "type": "string" + }, + "tableId": { + "description": "Required. The table name of the Spanner database that needs to be imported.", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaSearchRequestSpellCorrectionSpec": { - "description": "The specification for query spell correction.", - "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestSpellCorrectionSpec", + "GoogleCloudDiscoveryengineV1alphaSuggestionDenyListEntry": { + "description": "Suggestion deny list entry identifying the phrase to block from suggestions and the applied operation for the phrase.", + "id": "GoogleCloudDiscoveryengineV1alphaSuggestionDenyListEntry", "properties": { - "mode": { - "description": "The mode under which spell correction replaces the original search query. Defaults to Mode.AUTO.", + "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.", "enum": [ - "MODE_UNSPECIFIED", - "SUGGESTION_ONLY", - "AUTO" + "MATCH_OPERATOR_UNSPECIFIED", + "EXACT_MATCH", + "CONTAINS" ], "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." + "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." ], "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaSearchResponse": { - "description": "Response message for SearchService.Search method.", - "id": "GoogleCloudDiscoveryengineV1alphaSearchResponse", + "GoogleCloudDiscoveryengineV1alphaTargetSite": { + "description": "A target site for the SiteSearchEngine.", + "id": "GoogleCloudDiscoveryengineV1alphaTargetSite", "properties": { - "appliedControls": { - "description": "Controls applied as part of the Control service.", - "items": { - "type": "string" - }, - "type": "array" + "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" }, - "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.", - "type": "string" + "failureReason": { + "$ref": "GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReason", + "description": "Output only. Failure reason.", + "readOnly": true }, - "correctedQuery": { - "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.", + "generatedUriPattern": { + "description": "Output only. This is system-generated based on the provided_uri_pattern.", + "readOnly": true, "type": "string" }, - "facets": { - "description": "Results of facets requested by user.", - "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseFacet" - }, - "type": "array" - }, - "geoSearchDebugInfo": { - "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseGeoSearchDebugInfo" - }, - "type": "array" - }, - "guidedSearchResult": { - "$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseGuidedSearchResult", - "description": "Guided search result." + "indexingStatus": { + "description": "Output only. Indexing status.", + "enum": [ + "INDEXING_STATUS_UNSPECIFIED", + "PENDING", + "FAILED", + "SUCCEEDED", + "DELETING" + ], + "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." + ], + "readOnly": true, + "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.", + "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" }, - "queryExpansionInfo": { - "$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseQueryExpansionInfo", - "description": "Query expansion information for the returned results." + "providedUriPattern": { + "description": "Required. Input only. The user provided URI pattern from which the `generated_uri_pattern` is generated.", + "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.", + "rootDomainUri": { + "description": "Output only. Root domain of the provided_uri_pattern.", + "readOnly": true, "type": "string" }, - "results": { - "description": "A list of matched documents. The order represents the ranking.", - "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseSearchResult" - }, - "type": "array" + "siteVerificationInfo": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSiteVerificationInfo", + "description": "Output only. Site ownership and validity verification status.", + "readOnly": true }, - "summary": { - "$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseSummary", - "description": "A summary as part of the search results. This field is only returned if SearchRequest.ContentSearchSpec.summary_spec is set." + "type": { + "description": "The type of the target site, e.g., whether the site is to be included or excluded.", + "enum": [ + "TYPE_UNSPECIFIED", + "INCLUDE", + "EXCLUDE" + ], + "enumDescriptions": [ + "This value is unused. In this case, server behavior defaults to Type.INCLUDE.", + "Include the target site.", + "Exclude the target site." + ], + "type": "string" }, - "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.", - "format": "int32", - "type": "integer" + "updateTime": { + "description": "Output only. The target site's last updated time.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReason": { + "description": "Site search indexing failure reasons.", + "id": "GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReason", + "properties": { + "quotaFailure": { + "$ref": "GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReasonQuotaFailure", + "description": "Failed due to insufficient quota." + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReasonQuotaFailure": { + "description": "Failed due to insufficient quota.", + "id": "GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReasonQuotaFailure", + "properties": { + "totalRequiredQuota": { + "description": "This number is an estimation on how much total quota this project needs to successfully complete indexing.", + "format": "int64", + "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaSearchResponseFacet": { - "description": "A facet result.", - "id": "GoogleCloudDiscoveryengineV1alphaSearchResponseFacet", + "GoogleCloudDiscoveryengineV1alphaTextInput": { + "description": "Defines text input.", + "id": "GoogleCloudDiscoveryengineV1alphaTextInput", "properties": { - "dynamicFacet": { - "description": "Whether the facet is dynamically generated.", - "type": "boolean" + "context": { + "$ref": "GoogleCloudDiscoveryengineV1alphaConversationContext", + "description": "Conversation context of the input." }, - "key": { - "description": "The key for this facet. For example, `\"colors\"` or `\"price\"`. It matches SearchRequest.FacetSpec.FacetKey.key.", + "input": { + "description": "Text input.", "type": "string" - }, - "values": { - "description": "The facet values for this field.", - "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseFacetFacetValue" - }, - "type": "array" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaSearchResponseFacetFacetValue": { - "description": "A facet value which contains value names and their count.", - "id": "GoogleCloudDiscoveryengineV1alphaSearchResponseFacetFacetValue", + "GoogleCloudDiscoveryengineV1alphaTrainCustomModelMetadata": { + "description": "Metadata related to the progress of the TrainCustomModel operation. This is returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1alphaTrainCustomModelMetadata", "properties": { - "count": { - "description": "Number of items that have this facet value.", - "format": "int64", + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", "type": "string" }, - "interval": { - "$ref": "GoogleCloudDiscoveryengineV1alphaInterval", - "description": "Interval value for a facet, such as 10, 20) for facet \"price\". It matches [SearchRequest.FacetSpec.FacetKey.intervals." + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaTrainCustomModelRequest": { + "description": "Request message for SearchTuningService.TrainCustomModel method.", + "id": "GoogleCloudDiscoveryengineV1alphaTrainCustomModelRequest", + "properties": { + "errorConfig": { + "$ref": "GoogleCloudDiscoveryengineV1alphaImportErrorConfig", + "description": "The desired location of errors incurred during the data ingestion and training." }, - "value": { - "description": "Text value of a facet, such as \"Black\" for facet \"colors\".", + "gcsTrainingInput": { + "$ref": "GoogleCloudDiscoveryengineV1alphaTrainCustomModelRequestGcsTrainingInput", + "description": "Cloud Storage training input." + }, + "modelId": { + "description": "If not provided, a UUID will be generated.", + "type": "string" + }, + "modelType": { + "description": "Model to be trained. Supported values are: * **search-tuning**: Fine tuning the search system based on data provided.", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaSearchResponseGeoSearchDebugInfo": { - "description": "Debug information specifically related to forward geocoding issues arising from Geolocation Search.", - "id": "GoogleCloudDiscoveryengineV1alphaSearchResponseGeoSearchDebugInfo", + "GoogleCloudDiscoveryengineV1alphaTrainCustomModelRequestGcsTrainingInput": { + "description": "Cloud Storage training data input.", + "id": "GoogleCloudDiscoveryengineV1alphaTrainCustomModelRequestGcsTrainingInput", "properties": { - "errorMessage": { - "description": "The error produced.", + "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" }, - "originalAddressQuery": { - "description": "The address from which forward geocoding ingestion produced issues.", + "queryDataPath": { + "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" + }, + "testDataPath": { + "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" + }, + "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" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaSearchResponseGuidedSearchResult": { - "description": "Guided search result. The guided search helps user to refine the search results and narrow down to the real needs from a broaded search results.", - "id": "GoogleCloudDiscoveryengineV1alphaSearchResponseGuidedSearchResult", + "GoogleCloudDiscoveryengineV1alphaTrainCustomModelResponse": { + "description": "Response of the TrainCustomModelRequest. This message is returned by the google.longrunning.Operations.response field.", + "id": "GoogleCloudDiscoveryengineV1alphaTrainCustomModelResponse", "properties": { - "followUpQuestions": { - "description": "Suggested follow-up questions.", + "errorConfig": { + "$ref": "GoogleCloudDiscoveryengineV1alphaImportErrorConfig", + "description": "Echoes the destination for the complete errors in the request if set." + }, + "errorSamples": { + "description": "A sample of errors encountered while processing the data.", "items": { - "type": "string" + "$ref": "GoogleRpcStatus" }, "type": "array" }, - "refinementAttributes": { - "description": "A list of ranked refinement attributes.", - "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseGuidedSearchResultRefinementAttribute" + "metrics": { + "additionalProperties": { + "format": "double", + "type": "number" }, - "type": "array" + "description": "The metrics of the trained model.", + "type": "object" + }, + "modelName": { + "description": "Fully qualified name of the CustomTuningModel.", + "type": "string" + }, + "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" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaSearchResponseGuidedSearchResultRefinementAttribute": { - "description": "Useful attribute for search result refinements.", - "id": "GoogleCloudDiscoveryengineV1alphaSearchResponseGuidedSearchResultRefinementAttribute", + "GoogleCloudDiscoveryengineV1alphaTransactionInfo": { + "description": "A transaction represents the entire purchase transaction.", + "id": "GoogleCloudDiscoveryengineV1alphaTransactionInfo", "properties": { - "attributeKey": { - "description": "Attribute key used to refine the results. For example, `\"movie_type\"`.", + "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", + "format": "float", + "type": "number" + }, + "currency": { + "description": "Required. Currency code. Use three-character ISO-4217 code.", "type": "string" }, - "attributeValue": { - "description": "Attribute value used to refine the results. For example, `\"drama\"`.", + "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", + "format": "float", + "type": "number" + }, + "tax": { + "description": "All the taxes associated with the transaction.", + "format": "float", + "type": "number" + }, + "transactionId": { + "description": "The transaction ID with a length limit of 128 characters.", "type": "string" + }, + "value": { + "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.", + "format": "float", + "type": "number" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaSearchResponseQueryExpansionInfo": { - "description": "Information describing query expansion including whether expansion has occurred.", - "id": "GoogleCloudDiscoveryengineV1alphaSearchResponseQueryExpansionInfo", + "GoogleCloudDiscoveryengineV1alphaTuneEngineMetadata": { + "description": "Metadata associated with a tune operation.", + "id": "GoogleCloudDiscoveryengineV1alphaTuneEngineMetadata", "properties": { - "expandedQuery": { - "description": "Bool describing whether query expansion has occurred.", - "type": "boolean" - }, - "pinnedResultCount": { - "description": "Number of pinned results. This field will only be set when expansion happens and SearchRequest.QueryExpansionSpec.pin_unexpanded_results is set to true.", - "format": "int64", + "engine": { + "description": "Required. The resource name of the engine that this tune applies to. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaSearchResponseSearchResult": { - "description": "Represents the search results.", - "id": "GoogleCloudDiscoveryengineV1alphaSearchResponseSearchResult", + "GoogleCloudDiscoveryengineV1alphaTuneEngineRequest": { + "description": "Request to manually start a tuning process now (instead of waiting for the periodically scheduled tuning to happen).", + "id": "GoogleCloudDiscoveryengineV1alphaTuneEngineRequest", + "properties": {}, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaTuneEngineResponse": { + "description": "Response associated with a tune operation.", + "id": "GoogleCloudDiscoveryengineV1alphaTuneEngineResponse", + "properties": {}, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaUpdateSchemaMetadata": { + "description": "Metadata for UpdateSchema LRO.", + "id": "GoogleCloudDiscoveryengineV1alphaUpdateSchemaMetadata", "properties": { - "chunk": { - "$ref": "GoogleCloudDiscoveryengineV1alphaChunk", - "description": "The chunk data in the search response if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS." - }, - "document": { - "$ref": "GoogleCloudDiscoveryengineV1alphaDocument", - "description": "The document data snippet in the search response. Only fields that are marked as `retrievable` are populated." + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", + "type": "string" }, - "id": { - "description": "Document.id of the searched Document.", + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaUpdateTargetSiteMetadata": { + "description": "Metadata related to the progress of the SiteSearchEngineService.UpdateTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1alphaUpdateTargetSiteMetadata", + "properties": { + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", "type": "string" }, - "modelScores": { - "additionalProperties": { - "$ref": "GoogleCloudDiscoveryengineV1alphaDoubleList" - }, - "description": "Google provided available scores.", - "type": "object" + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", + "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaSearchResponseSummary": { - "description": "Summary of the top N search results specified by the summary spec.", - "id": "GoogleCloudDiscoveryengineV1alphaSearchResponseSummary", + "GoogleCloudDiscoveryengineV1alphaUserEvent": { + "description": "UserEvent captures all metadata information Discovery Engine API needs to know about how end users interact with your website.", + "id": "GoogleCloudDiscoveryengineV1alphaUserEvent", "properties": { - "safetyAttributes": { - "$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseSummarySafetyAttributes", - "description": "A collection of Safety Attribute categories and their associated confidence scores." + "attributes": { + "additionalProperties": { + "$ref": "GoogleCloudDiscoveryengineV1alphaCustomAttribute" + }, + "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" + }, + "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" + }, + "completionInfo": { + "$ref": "GoogleCloudDiscoveryengineV1alphaCompletionInfo", + "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." + }, + "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" + }, + "directUserRequest": { + "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" }, - "summarySkippedReasons": { - "description": "Additional summary-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set.", + "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.", "items": { - "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" - ], - "enumDescriptions": [ - "Default value. The summary skipped reason is not specified.", - "The adversarial query ignored case. Only populated when SummarySpec.ignore_adversarial_query is set to `true`.", - "The non-summary seeking query ignored case. Only populated 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." - ], - "type": "string" + "$ref": "GoogleCloudDiscoveryengineV1alphaDocumentInfo" }, "type": "array" }, - "summaryText": { - "description": "The summary content.", + "engine": { + "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.", "type": "string" }, - "summaryWithMetadata": { - "$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseSummarySummaryWithMetadata", - "description": "Summary with metadata information." - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryCitation": { - "description": "Citation info for a segment.", - "id": "GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryCitation", - "properties": { - "endIndex": { - "description": "End of the attributed segment, exclusive.", - "format": "int64", + "eventTime": { + "description": "Only required for UserEventService.ImportUserEvents method. Timestamp of when the user event happened.", + "format": "google-datetime", "type": "string" }, - "sources": { - "description": "Citation sources for the attributed segment.", + "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 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" + }, + "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" + }, + "mediaInfo": { + "$ref": "GoogleCloudDiscoveryengineV1alphaMediaInfo", + "description": "Media-specific info." + }, + "pageInfo": { + "$ref": "GoogleCloudDiscoveryengineV1alphaPageInfo", + "description": "Page metadata such as categories and other critical information for certain event types such as `view-category-page`." + }, + "panel": { + "$ref": "GoogleCloudDiscoveryengineV1alphaPanelInfo", + "description": "Panel metadata associated with this user event." + }, + "promotionIds": { + "description": "The promotion IDs if this is an event associated with promotions. Currently, this field is restricted to at most one ID.", "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryCitationSource" + "type": "string" }, "type": "array" }, - "startIndex": { - "description": "Index indicates the start of the segment, measured in bytes/unicode.", - "format": "int64", + "searchInfo": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchInfo", + "description": "SearchService.Search details related to the event. This field should be set for `search` event." + }, + "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" - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryCitationMetadata": { - "description": "Citation metadata.", - "id": "GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryCitationMetadata", - "properties": { - "citations": { - "description": "Citations for segments.", + }, + "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.", "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryCitation" + "type": "string" }, "type": "array" + }, + "transactionInfo": { + "$ref": "GoogleCloudDiscoveryengineV1alphaTransactionInfo", + "description": "The transaction metadata (if any) associated with this user event." + }, + "userInfo": { + "$ref": "GoogleCloudDiscoveryengineV1alphaUserInfo", + "description": "Information about the end user." + }, + "userPseudoId": { + "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.", + "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryCitationSource": { - "description": "Citation source.", - "id": "GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryCitationSource", + "GoogleCloudDiscoveryengineV1alphaUserInfo": { + "description": "Information of an end user.", + "id": "GoogleCloudDiscoveryengineV1alphaUserInfo", "properties": { - "referenceIndex": { - "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.", - "format": "int64", + "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" + }, + "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" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryReference": { - "description": "Document reference.", - "id": "GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryReference", + "GoogleCloudDiscoveryengineV1betaBatchCreateTargetSiteMetadata": { + "description": "Metadata related to the progress of the SiteSearchEngineService.BatchCreateTargetSites operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1betaBatchCreateTargetSiteMetadata", "properties": { - "chunkContents": { - "description": "List of cited chunk contents derived from document content.", - "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryReferenceChunkContent" - }, - "type": "array" - }, - "document": { - "description": "Required. Document.name of the document. Full resource name of the referenced document, in the format `projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*`.", - "type": "string" - }, - "title": { - "description": "Title of the document.", + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", "type": "string" }, - "uri": { - "description": "Cloud Storage or HTTP uri for the document.", + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryReferenceChunkContent": { - "description": "Chunk content.", - "id": "GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryReferenceChunkContent", + "GoogleCloudDiscoveryengineV1betaBatchCreateTargetSitesResponse": { + "description": "Response message for SiteSearchEngineService.BatchCreateTargetSites method.", + "id": "GoogleCloudDiscoveryengineV1betaBatchCreateTargetSitesResponse", "properties": { - "content": { - "description": "Chunk textual content.", - "type": "string" - }, - "pageIdentifier": { - "description": "Page identifier.", - "type": "string" + "targetSites": { + "description": "TargetSites created.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1betaTargetSite" + }, + "type": "array" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaSearchResponseSummarySafetyAttributes": { - "description": "Safety Attribute categories and their associated confidence scores.", - "id": "GoogleCloudDiscoveryengineV1alphaSearchResponseSummarySafetyAttributes", + "GoogleCloudDiscoveryengineV1betaCondition": { + "description": "Defines circumstances to be checked before allowing a behavior", + "id": "GoogleCloudDiscoveryengineV1betaCondition", "properties": { - "categories": { - "description": "The display names of Safety Attribute categories associated with the generated content. Order matches the Scores.", + "activeTimeRange": { + "description": "Range of time(s) specifying when condition is active. Maximum of 10 time ranges.", "items": { - "type": "string" + "$ref": "GoogleCloudDiscoveryengineV1betaConditionTimeRange" }, "type": "array" }, - "scores": { - "description": "The confidence scores of the each category, higher value means higher confidence. Order matches the Categories.", + "queryTerms": { + "description": "Search only A list of terms to match the query on. Maximum of 10 query terms.", "items": { - "format": "float", - "type": "number" + "$ref": "GoogleCloudDiscoveryengineV1betaConditionQueryTerm" }, "type": "array" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaSearchResponseSummarySummaryWithMetadata": { - "description": "Summary with metadata information.", - "id": "GoogleCloudDiscoveryengineV1alphaSearchResponseSummarySummaryWithMetadata", + "GoogleCloudDiscoveryengineV1betaConditionQueryTerm": { + "description": "Matcher for search request query", + "id": "GoogleCloudDiscoveryengineV1betaConditionQueryTerm", "properties": { - "citationMetadata": { - "$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryCitationMetadata", - "description": "Citation metadata for given summary." - }, - "references": { - "description": "Document References.", - "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryReference" - }, - "type": "array" + "fullMatch": { + "description": "Whether the search query needs to exactly match the query term.", + "type": "boolean" }, - "summary": { - "description": "Summary text with no citation information.", + "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" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaServingConfig": { - "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.", - "id": "GoogleCloudDiscoveryengineV1alphaServingConfig", + "GoogleCloudDiscoveryengineV1betaConditionTimeRange": { + "description": "Used for time-dependent conditions.", + "id": "GoogleCloudDiscoveryengineV1betaConditionTimeRange", "properties": { - "boostControlIds": { - "description": "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.", - "items": { - "type": "string" - }, - "type": "array" - }, - "createTime": { - "description": "Output only. ServingConfig created timestamp.", + "endTime": { + "description": "End of time range. Range is inclusive. Must be in the future.", "format": "google-datetime", - "readOnly": true, - "type": "string" - }, - "customFineTuningSpec": { - "$ref": "GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec", - "description": "Custom fine tuning configs." - }, - "displayName": { - "description": "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" }, - "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.", - "items": { - "type": "string" - }, - "type": "array" - }, - "diversityLevel": { - "description": "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.", + "startTime": { + "description": "Start of time range. Range is inclusive.", + "format": "google-datetime", "type": "string" - }, - "embeddingConfig": { - "$ref": "GoogleCloudDiscoveryengineV1alphaEmbeddingConfig", - "description": "Bring your own embedding config. The config is used for search semantic retrieval. The retrieval is based on the dot product of SearchRequest.EmbeddingSpec.EmbeddingVector.vector and the document embeddings that are provided by this EmbeddingConfig. If SearchRequest.EmbeddingSpec.EmbeddingVector.vector is provided, it overrides this ServingConfig.embedding_config." - }, - "filterControlIds": { - "description": "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": "object" + }, + "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`.", + "id": "GoogleCloudDiscoveryengineV1betaControl", + "properties": { + "associatedServingConfigIds": { + "description": "Output only. List of all ServingConfig ids this control is attached to. May take up to 10 minutes to update after changes.", "items": { "type": "string" }, + "readOnly": true, "type": "array" }, - "genericConfig": { - "$ref": "GoogleCloudDiscoveryengineV1alphaServingConfigGenericConfig", - "description": "The GenericConfig of the serving configuration." - }, - "guidedSearchSpec": { - "$ref": "GoogleCloudDiscoveryengineV1alphaGuidedSearchSpec", - "description": "Guided search configs." + "boostAction": { + "$ref": "GoogleCloudDiscoveryengineV1betaControlBoostAction", + "description": "Defines a boost-type control" }, - "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.", + "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.", "items": { - "type": "string" + "$ref": "GoogleCloudDiscoveryengineV1betaCondition" }, "type": "array" }, - "mediaConfig": { - "$ref": "GoogleCloudDiscoveryengineV1alphaServingConfigMediaConfig", - "description": "The MediaConfig of the serving configuration." - }, - "modelId": { - "description": "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" - }, - "name": { - "description": "Immutable. Fully qualified name `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}/servingConfigs/{serving_config_id}`", + "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" }, - "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.", - "items": { - "type": "string" - }, - "type": "array" + "filterAction": { + "$ref": "GoogleCloudDiscoveryengineV1betaControlFilterAction", + "description": "Defines a filter-type control Currently not supported by Recommendation" }, - "rankingExpression": { - "description": "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).", + "name": { + "description": "Immutable. Fully qualified name `projects/*/locations/global/dataStore/*/controls/*`", "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.", - "items": { - "type": "string" - }, - "type": "array" - }, - "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.", - "items": { - "type": "string" - }, - "type": "array" + "redirectAction": { + "$ref": "GoogleCloudDiscoveryengineV1betaControlRedirectAction", + "description": "Defines a redirect-type control." }, "solutionType": { - "description": "Required. Immutable. Specifies the solution type that a serving config can be associated with.", + "description": "Required. Immutable. What solution the control belongs to. Must be compatible with vertical of resource. Otherwise an INVALID ARGUMENT error is thrown.", "enum": [ "SOLUTION_TYPE_UNSPECIFIED", "SOLUTION_TYPE_RECOMMENDATION", @@ -14439,331 +16604,387 @@ ], "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.", + "synonymsAction": { + "$ref": "GoogleCloudDiscoveryengineV1betaControlSynonymsAction", + "description": "Treats a group of terms as synonyms of one another." + }, + "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.", "items": { + "enum": [ + "SEARCH_USE_CASE_UNSPECIFIED", + "SEARCH_USE_CASE_SEARCH", + "SEARCH_USE_CASE_BROWSE" + ], + "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." + ], "type": "string" }, "type": "array" - }, - "updateTime": { - "description": "Output only. ServingConfig updated timestamp.", - "format": "google-datetime", - "readOnly": true, - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1alphaServingConfigGenericConfig": { - "description": "Specifies the configurations needed for Generic Discovery.Currently we support: * `content_search_spec`: configuration for generic content search.", - "id": "GoogleCloudDiscoveryengineV1alphaServingConfigGenericConfig", - "properties": { - "contentSearchSpec": { - "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpec", - "description": "Specifies the expected behavior of content search. Only valid for content-search enabled data store." } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaServingConfigMediaConfig": { - "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.", - "id": "GoogleCloudDiscoveryengineV1alphaServingConfigMediaConfig", + "GoogleCloudDiscoveryengineV1betaControlBoostAction": { + "description": "Adjusts order of products in returned list.", + "id": "GoogleCloudDiscoveryengineV1betaControlBoostAction", "properties": { - "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.", - "format": "int32", - "type": "integer" - }, - "contentWatchedPercentageThreshold": { - "description": "Specifies the content watched percentage threshold for demotion. Threshold value must be between [0, 1.0] inclusive.", + "boost": { + "description": "Required. Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0 (No-op).", "format": "float", "type": "number" }, - "contentWatchedSecondsThreshold": { - "description": "Specifies the content watched minutes threshold for demotion.", - "format": "float", - "type": "number" + "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" }, - "demotionEventType": { - "description": "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.", + "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" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaSession": { - "description": "External session proto definition.", - "id": "GoogleCloudDiscoveryengineV1alphaSession", + "GoogleCloudDiscoveryengineV1betaControlFilterAction": { + "description": "Specified which products may be included in results. Uses same filter as boost.", + "id": "GoogleCloudDiscoveryengineV1betaControlFilterAction", "properties": { - "endTime": { - "description": "Output only. The time the session finished.", - "format": "google-datetime", - "readOnly": true, - "type": "string" - }, - "name": { - "description": "Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*`", + "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" }, - "startTime": { - "description": "Output only. The time the session started.", - "format": "google-datetime", - "readOnly": true, + "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" - }, - "state": { - "description": "The state of the session.", - "enum": [ - "STATE_UNSPECIFIED", - "IN_PROGRESS" - ], - "enumDescriptions": [ - "State is unspecified.", - "The session is currently open." - ], + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaControlRedirectAction": { + "description": "Redirects a shopper to the provided URI.", + "id": "GoogleCloudDiscoveryengineV1betaControlRedirectAction", + "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" - }, - "turns": { - "description": "Turns.", + } + }, + "type": "object" + }, + "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\".", + "id": "GoogleCloudDiscoveryengineV1betaControlSynonymsAction", + "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.", "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaSessionTurn" + "type": "string" }, "type": "array" - }, - "userPseudoId": { - "description": "A unique identifier for tracking users.", - "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaSessionTurn": { - "description": "Represents a turn, including a query from the user and a answer from service.", - "id": "GoogleCloudDiscoveryengineV1alphaSessionTurn", + "GoogleCloudDiscoveryengineV1betaCreateDataStoreMetadata": { + "description": "Metadata related to the progress of the DataStoreService.CreateDataStore operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1betaCreateDataStoreMetadata", "properties": { - "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.", + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", "type": "string" }, - "query": { - "$ref": "GoogleCloudDiscoveryengineV1alphaQuery", - "description": "The user query." + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", + "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaSiteSearchEngine": { - "description": "SiteSearchEngine captures DataStore level site search persisting configurations. It is a singleton value per data store.", - "id": "GoogleCloudDiscoveryengineV1alphaSiteSearchEngine", + "GoogleCloudDiscoveryengineV1betaCreateEngineMetadata": { + "description": "Metadata related to the progress of the EngineService.CreateEngine operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1betaCreateEngineMetadata", "properties": { - "name": { - "description": "The fully qualified resource name of the site search engine. Format: `projects/*/locations/*/dataStores/*/siteSearchEngine`", + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", + "type": "string" + }, + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaSiteVerificationInfo": { - "description": "Verification information for target sites in advanced site search.", - "id": "GoogleCloudDiscoveryengineV1alphaSiteVerificationInfo", + "GoogleCloudDiscoveryengineV1betaCreateEvaluationMetadata": { + "description": "Metadata for EvaluationService.CreateEvaluation method.", + "id": "GoogleCloudDiscoveryengineV1betaCreateEvaluationMetadata", + "properties": {}, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaCreateSchemaMetadata": { + "description": "Metadata for Create Schema LRO.", + "id": "GoogleCloudDiscoveryengineV1betaCreateSchemaMetadata", "properties": { - "siteVerificationState": { - "description": "Site verification state indicating the ownership and validity.", - "enum": [ - "SITE_VERIFICATION_STATE_UNSPECIFIED", - "VERIFIED", - "UNVERIFIED", - "EXEMPTED" - ], - "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." - ], + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", "type": "string" }, - "verifyTime": { - "description": "Latest site verification time.", + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", "format": "google-datetime", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaSpannerSource": { - "description": "The Spanner source for importing data", - "id": "GoogleCloudDiscoveryengineV1alphaSpannerSource", + "GoogleCloudDiscoveryengineV1betaCreateTargetSiteMetadata": { + "description": "Metadata related to the progress of the SiteSearchEngineService.CreateTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1betaCreateTargetSiteMetadata", "properties": { - "databaseId": { - "description": "Required. The database ID of the source Spanner table.", - "type": "string" - }, - "enableDataBoost": { - "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" - }, - "instanceId": { - "description": "Required. The instance ID of the source Spanner table.", - "type": "string" - }, - "projectId": { - "description": "The project ID that the Spanner source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request.", + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", "type": "string" }, - "tableId": { - "description": "Required. The table name of the Spanner database that needs to be imported.", + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaSuggestionDenyListEntry": { - "description": "Suggestion deny list entry identifying the phrase to block from suggestions and the applied operation for the phrase.", - "id": "GoogleCloudDiscoveryengineV1alphaSuggestionDenyListEntry", + "GoogleCloudDiscoveryengineV1betaCustomTuningModel": { + "description": "Metadata that describes a custom tuned model.", + "id": "GoogleCloudDiscoveryengineV1betaCustomTuningModel", "properties": { - "blockPhrase": { - "description": "Required. Phrase to block from suggestions served. Can be maximum 125 characters.", + "createTime": { + "deprecated": true, + "description": "Timestamp the Model was created at.", + "format": "google-datetime", "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.", + "displayName": { + "description": "The display name of the model.", + "type": "string" + }, + "metrics": { + "additionalProperties": { + "format": "double", + "type": "number" + }, + "description": "The metrics of the trained model.", + "type": "object" + }, + "modelState": { + "description": "The state that the model is in (e.g.`TRAINING` or `TRAINING_FAILED`).", "enum": [ - "MATCH_OPERATOR_UNSPECIFIED", - "EXACT_MATCH", - "CONTAINS" + "MODEL_STATE_UNSPECIFIED", + "TRAINING_PAUSED", + "TRAINING", + "TRAINING_COMPLETE", + "READY_FOR_SERVING", + "TRAINING_FAILED", + "NO_IMPROVEMENT" ], "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." + "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." ], "type": "string" + }, + "modelVersion": { + "description": "The version of the model.", + "format": "int64", + "type": "string" + }, + "name": { + "description": "Required. The fully qualified resource name of the model. Format: `projects/{project_number}/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" + }, + "trainingStartTime": { + "description": "Timestamp the model training was initiated.", + "format": "google-datetime", + "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaTargetSite": { - "description": "A target site for the SiteSearchEngine.", - "id": "GoogleCloudDiscoveryengineV1alphaTargetSite", + "GoogleCloudDiscoveryengineV1betaDataStore": { + "description": "DataStore captures global settings and configs at the DataStore level.", + "id": "GoogleCloudDiscoveryengineV1betaDataStore", "properties": { - "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" - }, - "failureReason": { - "$ref": "GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReason", - "description": "Output only. Failure reason.", - "readOnly": true - }, - "generatedUriPattern": { - "description": "Output only. This is system-generated based on the provided_uri_pattern.", - "readOnly": true, - "type": "string" - }, - "indexingStatus": { - "description": "Output only. Indexing status.", + "contentConfig": { + "description": "Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT.", "enum": [ - "INDEXING_STATUS_UNSPECIFIED", - "PENDING", - "FAILED", - "SUCCEEDED", - "DELETING" + "CONTENT_CONFIG_UNSPECIFIED", + "NO_CONTENT", + "CONTENT_REQUIRED", + "PUBLIC_WEBSITE" ], "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." + "Default value.", + "Only contains documents without any Document.content.", + "Only contains documents with Document.content.", + "The data store is used for public website search." ], - "readOnly": true, "type": "string" }, - "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.", + "createTime": { + "description": "Output only. Timestamp the DataStore was created at.", + "format": "google-datetime", "readOnly": true, "type": "string" }, - "providedUriPattern": { - "description": "Required. Input only. The user provided URI pattern from which the `generated_uri_pattern` is generated.", + "defaultSchemaId": { + "description": "Output only. The id of the default Schema asscociated to this data store.", + "readOnly": true, "type": "string" }, - "rootDomainUri": { - "description": "Output only. Root domain of the provided_uri_pattern.", - "readOnly": true, + "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" }, - "siteVerificationInfo": { - "$ref": "GoogleCloudDiscoveryengineV1alphaSiteVerificationInfo", - "description": "Output only. Site ownership and validity verification status.", - "readOnly": true + "documentProcessingConfig": { + "$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfig", + "description": "Configuration for Document understanding and enrichment." }, - "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.", "enum": [ - "TYPE_UNSPECIFIED", - "INCLUDE", - "EXCLUDE" + "INDUSTRY_VERTICAL_UNSPECIFIED", + "GENERIC", + "MEDIA", + "HEALTHCARE_FHIR" ], "enumDescriptions": [ - "This value is unused. In this case, server behavior defaults to Type.INCLUDE.", - "Include the target site.", - "Exclude the target site." + "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." ], "type": "string" }, + "languageInfo": { + "$ref": "GoogleCloudDiscoveryengineV1betaLanguageInfo", + "description": "Language info for DataStore." + }, + "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" + }, + "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.", + "items": { + "enum": [ + "SOLUTION_TYPE_UNSPECIFIED", + "SOLUTION_TYPE_RECOMMENDATION", + "SOLUTION_TYPE_SEARCH", + "SOLUTION_TYPE_CHAT", + "SOLUTION_TYPE_GENERATIVE_CHAT" + ], + "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." + ], + "type": "string" + }, + "type": "array" + }, + "startingSchema": { + "$ref": "GoogleCloudDiscoveryengineV1betaSchema", + "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)." + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaDeleteDataStoreMetadata": { + "description": "Metadata related to the progress of the DataStoreService.DeleteDataStore operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1betaDeleteDataStoreMetadata", + "properties": { + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", + "type": "string" + }, "updateTime": { - "description": "Output only. The target site's last updated time.", + "description": "Operation last update time. If the operation is done, this is also the finish time.", "format": "google-datetime", - "readOnly": true, "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReason": { - "description": "Site search indexing failure reasons.", - "id": "GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReason", + "GoogleCloudDiscoveryengineV1betaDeleteEngineMetadata": { + "description": "Metadata related to the progress of the EngineService.DeleteEngine operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1betaDeleteEngineMetadata", "properties": { - "quotaFailure": { - "$ref": "GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReasonQuotaFailure", - "description": "Failed due to insufficient quota." + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", + "type": "string" + }, + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", + "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReasonQuotaFailure": { - "description": "Failed due to insufficient quota.", - "id": "GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReasonQuotaFailure", + "GoogleCloudDiscoveryengineV1betaDeleteSchemaMetadata": { + "description": "Metadata for DeleteSchema LRO.", + "id": "GoogleCloudDiscoveryengineV1betaDeleteSchemaMetadata", "properties": { - "totalRequiredQuota": { - "description": "This number is an estimation on how much total quota this project needs to successfully complete indexing.", - "format": "int64", + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", + "type": "string" + }, + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", "type": "string" } }, "type": "object" - }, - "GoogleCloudDiscoveryengineV1alphaTextInput": { - "description": "Defines text input.", - "id": "GoogleCloudDiscoveryengineV1alphaTextInput", + }, + "GoogleCloudDiscoveryengineV1betaDeleteTargetSiteMetadata": { + "description": "Metadata related to the progress of the SiteSearchEngineService.DeleteTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1betaDeleteTargetSiteMetadata", "properties": { - "context": { - "$ref": "GoogleCloudDiscoveryengineV1alphaConversationContext", - "description": "Conversation context of the input." + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", + "type": "string" }, - "input": { - "description": "Text input.", + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaTrainCustomModelMetadata": { - "description": "Metadata related to the progress of the TrainCustomModel operation. This is returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1alphaTrainCustomModelMetadata", + "GoogleCloudDiscoveryengineV1betaDisableAdvancedSiteSearchMetadata": { + "description": "Metadata related to the progress of the SiteSearchEngineService.DisableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1betaDisableAdvancedSiteSearchMetadata", "properties": { "createTime": { "description": "Operation create time.", @@ -14778,544 +16999,625 @@ }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaTrainCustomModelRequest": { - "description": "Request message for SearchTuningService.TrainCustomModel method.", - "id": "GoogleCloudDiscoveryengineV1alphaTrainCustomModelRequest", + "GoogleCloudDiscoveryengineV1betaDisableAdvancedSiteSearchResponse": { + "description": "Response message for SiteSearchEngineService.DisableAdvancedSiteSearch method.", + "id": "GoogleCloudDiscoveryengineV1betaDisableAdvancedSiteSearchResponse", + "properties": {}, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfig": { + "description": "A singleton resource of DataStore. It's empty when DataStore is created, which defaults to digital parser. The first call to DataStoreService.UpdateDocumentProcessingConfig method will initialize the config.", + "id": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfig", "properties": { - "errorConfig": { - "$ref": "GoogleCloudDiscoveryengineV1alphaImportErrorConfig", - "description": "The desired location of errors incurred during the data ingestion and training." + "chunkingConfig": { + "$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfig", + "description": "Whether chunking mode is enabled." }, - "gcsTrainingInput": { - "$ref": "GoogleCloudDiscoveryengineV1alphaTrainCustomModelRequestGcsTrainingInput", - "description": "Cloud Storage training input." + "defaultParsingConfig": { + "$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig", + "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." }, - "modelId": { - "description": "If not provided, a UUID will be generated.", + "name": { + "description": "The full resource name of the Document Processing Config. Format: `projects/*/locations/*/collections/*/dataStores/*/documentProcessingConfig`.", "type": "string" }, - "modelType": { - "description": "Model to be trained. Supported values are: * **search-tuning**: Fine tuning the search system based on data provided.", - "type": "string" + "parsingConfigOverrides": { + "additionalProperties": { + "$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig" + }, + "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.", + "type": "object" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaTrainCustomModelRequestGcsTrainingInput": { - "description": "Cloud Storage training data input.", - "id": "GoogleCloudDiscoveryengineV1alphaTrainCustomModelRequestGcsTrainingInput", + "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfig": { + "description": "Configuration for chunking config.", + "id": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfig", "properties": { - "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" + "layoutBasedChunkingConfig": { + "$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig", + "description": "Configuration for the layout based chunking." + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig": { + "description": "Configuration for the layout based chunking.", + "id": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig", + "properties": { + "chunkSize": { + "description": "The token size limit for each chunk. Supported values: 100-500 (inclusive). Default value: 500.", + "format": "int32", + "type": "integer" }, - "queryDataPath": { - "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" + "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" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig": { + "description": "Related configurations applied to a specific type of document parser.", + "id": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig", + "properties": { + "digitalParsingConfig": { + "$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigDigitalParsingConfig", + "description": "Configurations applied to digital parser." }, - "testDataPath": { - "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" + "layoutParsingConfig": { + "$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigLayoutParsingConfig", + "description": "Configurations applied to layout parser." }, - "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" + "ocrParsingConfig": { + "$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsingConfig", + "description": "Configurations applied to OCR parser. Currently it only applies to PDFs." } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaTrainCustomModelResponse": { - "description": "Response of the TrainCustomModelRequest. This message is returned by the google.longrunning.Operations.response field.", - "id": "GoogleCloudDiscoveryengineV1alphaTrainCustomModelResponse", + "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigDigitalParsingConfig": { + "description": "The digital parsing configurations for documents.", + "id": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigDigitalParsingConfig", + "properties": {}, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigLayoutParsingConfig": { + "description": "The layout parsing configurations for documents.", + "id": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigLayoutParsingConfig", + "properties": {}, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsingConfig": { + "description": "The OCR parsing configurations for documents.", + "id": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsingConfig", "properties": { - "errorConfig": { - "$ref": "GoogleCloudDiscoveryengineV1alphaImportErrorConfig", - "description": "Echoes the destination for the complete errors in the request if set." - }, - "errorSamples": { - "description": "A sample of errors encountered while processing the data.", + "enhancedDocumentElements": { + "deprecated": true, + "description": "[DEPRECATED] This field is deprecated. To use the additional enhanced document elements processing, please switch to `layout_parsing_config`.", "items": { - "$ref": "GoogleRpcStatus" + "type": "string" }, "type": "array" }, - "metrics": { - "additionalProperties": { - "format": "double", - "type": "number" - }, - "description": "The metrics of the trained model.", - "type": "object" - }, - "modelName": { - "description": "Fully qualified name of the CustomTuningModel.", + "useNativeText": { + "description": "If true, will use native text instead of OCR text on pages containing native text.", + "type": "boolean" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaEnableAdvancedSiteSearchMetadata": { + "description": "Metadata related to the progress of the SiteSearchEngineService.EnableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1betaEnableAdvancedSiteSearchMetadata", + "properties": { + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", "type": "string" }, - "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.", + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaTransactionInfo": { - "description": "A transaction represents the entire purchase transaction.", - "id": "GoogleCloudDiscoveryengineV1alphaTransactionInfo", + "GoogleCloudDiscoveryengineV1betaEnableAdvancedSiteSearchResponse": { + "description": "Response message for SiteSearchEngineService.EnableAdvancedSiteSearch method.", + "id": "GoogleCloudDiscoveryengineV1betaEnableAdvancedSiteSearchResponse", + "properties": {}, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaEngine": { + "description": "Metadata that describes the training and serving parameters of an Engine.", + "id": "GoogleCloudDiscoveryengineV1betaEngine", "properties": { - "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", - "format": "float", - "type": "number" + "chatEngineConfig": { + "$ref": "GoogleCloudDiscoveryengineV1betaEngineChatEngineConfig", + "description": "Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT." }, - "currency": { - "description": "Required. Currency code. Use three-character ISO-4217 code.", + "chatEngineMetadata": { + "$ref": "GoogleCloudDiscoveryengineV1betaEngineChatEngineMetadata", + "description": "Output only. Additional information of the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.", + "readOnly": true + }, + "commonConfig": { + "$ref": "GoogleCloudDiscoveryengineV1betaEngineCommonConfig", + "description": "Common config spec that specifies the metadata of the engine." + }, + "createTime": { + "description": "Output only. Timestamp the Recommendation Engine was created at.", + "format": "google-datetime", + "readOnly": true, "type": "string" }, - "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", - "format": "float", - "type": "number" + "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.", + "items": { + "type": "string" + }, + "type": "array" }, - "tax": { - "description": "All the taxes associated with the transaction.", - "format": "float", - "type": "number" + "displayName": { + "description": "Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters.", + "type": "string" }, - "transactionId": { - "description": "The transaction ID with a length limit of 128 characters.", + "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.", + "enum": [ + "INDUSTRY_VERTICAL_UNSPECIFIED", + "GENERIC", + "MEDIA", + "HEALTHCARE_FHIR" + ], + "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." + ], + "type": "string" + }, + "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_number}/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" + }, + "searchEngineConfig": { + "$ref": "GoogleCloudDiscoveryengineV1betaEngineSearchEngineConfig", + "description": "Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH." + }, + "solutionType": { + "description": "Required. The solutions of the engine.", + "enum": [ + "SOLUTION_TYPE_UNSPECIFIED", + "SOLUTION_TYPE_RECOMMENDATION", + "SOLUTION_TYPE_SEARCH", + "SOLUTION_TYPE_CHAT", + "SOLUTION_TYPE_GENERATIVE_CHAT" + ], + "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." + ], "type": "string" }, - "value": { - "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.", - "format": "float", - "type": "number" + "updateTime": { + "description": "Output only. Timestamp the Recommendation Engine was last updated.", + "format": "google-datetime", + "readOnly": true, + "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaTuneEngineMetadata": { - "description": "Metadata associated with a tune operation.", - "id": "GoogleCloudDiscoveryengineV1alphaTuneEngineMetadata", + "GoogleCloudDiscoveryengineV1betaEngineChatEngineConfig": { + "description": "Configurations for a Chat Engine.", + "id": "GoogleCloudDiscoveryengineV1betaEngineChatEngineConfig", "properties": { - "engine": { - "description": "Required. The resource name of the engine that this tune applies to. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`", + "agentCreationConfig": { + "$ref": "GoogleCloudDiscoveryengineV1betaEngineChatEngineConfigAgentCreationConfig", + "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." + }, + "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" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaTuneEngineRequest": { - "description": "Request to manually start a tuning process now (instead of waiting for the periodically scheduled tuning to happen).", - "id": "GoogleCloudDiscoveryengineV1alphaTuneEngineRequest", - "properties": {}, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1alphaTuneEngineResponse": { - "description": "Response associated with a tune operation.", - "id": "GoogleCloudDiscoveryengineV1alphaTuneEngineResponse", - "properties": {}, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1alphaUpdateSchemaMetadata": { - "description": "Metadata for UpdateSchema LRO.", - "id": "GoogleCloudDiscoveryengineV1alphaUpdateSchemaMetadata", + "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.", + "id": "GoogleCloudDiscoveryengineV1betaEngineChatEngineConfigAgentCreationConfig", "properties": { - "createTime": { - "description": "Operation create time.", - "format": "google-datetime", + "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" }, - "updateTime": { - "description": "Operation last update time. If the operation is done, this is also the finish time.", - "format": "google-datetime", + "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" + }, + "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" + }, + "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" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaUpdateTargetSiteMetadata": { - "description": "Metadata related to the progress of the SiteSearchEngineService.UpdateTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1alphaUpdateTargetSiteMetadata", + "GoogleCloudDiscoveryengineV1betaEngineChatEngineMetadata": { + "description": "Additional information of a Chat Engine. Fields in this message are output only.", + "id": "GoogleCloudDiscoveryengineV1betaEngineChatEngineMetadata", "properties": { - "createTime": { - "description": "Operation create time.", - "format": "google-datetime", - "type": "string" - }, - "updateTime": { - "description": "Operation last update time. If the operation is done, this is also the finish time.", - "format": "google-datetime", + "dialogflowAgent": { + "description": "The resource name of a Dialogflow agent, that this Chat Engine refers to. Format: `projects//locations//agents/`.", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaUserEvent": { - "description": "UserEvent captures all metadata information Discovery Engine API needs to know about how end users interact with your website.", - "id": "GoogleCloudDiscoveryengineV1alphaUserEvent", + "GoogleCloudDiscoveryengineV1betaEngineCommonConfig": { + "description": "Common configurations for an Engine.", + "id": "GoogleCloudDiscoveryengineV1betaEngineCommonConfig", "properties": { - "attributes": { - "additionalProperties": { - "$ref": "GoogleCloudDiscoveryengineV1alphaCustomAttribute" - }, - "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" - }, - "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" - }, - "completionInfo": { - "$ref": "GoogleCloudDiscoveryengineV1alphaCompletionInfo", - "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." - }, - "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" - }, - "directUserRequest": { - "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" - }, - "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.", - "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaDocumentInfo" - }, - "type": "array" - }, - "engine": { - "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.", - "type": "string" - }, - "eventTime": { - "description": "Only required for UserEventService.ImportUserEvents method. Timestamp of when the user event happened.", - "format": "google-datetime", - "type": "string" - }, - "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 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" - }, - "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" - }, - "mediaInfo": { - "$ref": "GoogleCloudDiscoveryengineV1alphaMediaInfo", - "description": "Media-specific info." - }, - "pageInfo": { - "$ref": "GoogleCloudDiscoveryengineV1alphaPageInfo", - "description": "Page metadata such as categories and other critical information for certain event types such as `view-category-page`." - }, - "panel": { - "$ref": "GoogleCloudDiscoveryengineV1alphaPanelInfo", - "description": "Panel metadata associated with this user event." - }, - "promotionIds": { - "description": "The promotion IDs if this is an event associated with promotions. Currently, this field is restricted to at most one ID.", - "items": { - "type": "string" - }, - "type": "array" - }, - "searchInfo": { - "$ref": "GoogleCloudDiscoveryengineV1alphaSearchInfo", - "description": "SearchService.Search details related to the event. This field should be set for `search` event." - }, - "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" - }, - "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.", - "items": { - "type": "string" - }, - "type": "array" - }, - "transactionInfo": { - "$ref": "GoogleCloudDiscoveryengineV1alphaTransactionInfo", - "description": "The transaction metadata (if any) associated with this user event." - }, - "userInfo": { - "$ref": "GoogleCloudDiscoveryengineV1alphaUserInfo", - "description": "Information about the end user." - }, - "userPseudoId": { - "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.", + "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" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaUserInfo": { - "description": "Information of an end user.", - "id": "GoogleCloudDiscoveryengineV1alphaUserInfo", + "GoogleCloudDiscoveryengineV1betaEngineSearchEngineConfig": { + "description": "Configurations for a Search Engine.", + "id": "GoogleCloudDiscoveryengineV1betaEngineSearchEngineConfig", "properties": { - "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" + "searchAddOns": { + "description": "The add-on that this search engine enables.", + "items": { + "enum": [ + "SEARCH_ADD_ON_UNSPECIFIED", + "SEARCH_ADD_ON_LLM" + ], + "enumDescriptions": [ + "Default value when the enum is unspecified. This is invalid to use.", + "Large language model add-on." + ], + "type": "string" + }, + "type": "array" }, - "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.", + "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.", + "enum": [ + "SEARCH_TIER_UNSPECIFIED", + "SEARCH_TIER_STANDARD", + "SEARCH_TIER_ENTERPRISE" + ], + "enumDescriptions": [ + "Default value when the enum is unspecified. This is invalid to use.", + "Standard tier.", + "Enterprise tier." + ], "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1betaBatchCreateTargetSiteMetadata": { - "description": "Metadata related to the progress of the SiteSearchEngineService.BatchCreateTargetSites operation. This will be returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1betaBatchCreateTargetSiteMetadata", + "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.", + "id": "GoogleCloudDiscoveryengineV1betaEvaluation", "properties": { "createTime": { - "description": "Operation create time.", + "description": "Output only. Timestamp the Evaluation was created at.", "format": "google-datetime", + "readOnly": true, "type": "string" }, - "updateTime": { - "description": "Operation last update time. If the operation is done, this is also the finish time.", + "endTime": { + "description": "Output only. Timestamp the Evaluation was completed at.", "format": "google-datetime", + "readOnly": true, "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1betaBatchCreateTargetSitesResponse": { - "description": "Response message for SiteSearchEngineService.BatchCreateTargetSites method.", - "id": "GoogleCloudDiscoveryengineV1betaBatchCreateTargetSitesResponse", - "properties": { - "targetSites": { - "description": "TargetSites created.", + }, + "error": { + "$ref": "GoogleRpcStatus", + "description": "Output only. The error that occurred during evaluation. Only populated when the evaluation's state is FAILED.", + "readOnly": true + }, + "errorSamples": { + "description": "Output only. A sample of errors encountered while processing the request.", "items": { - "$ref": "GoogleCloudDiscoveryengineV1betaTargetSite" + "$ref": "GoogleRpcStatus" }, + "readOnly": true, "type": "array" + }, + "evaluationSpec": { + "$ref": "GoogleCloudDiscoveryengineV1betaEvaluationEvaluationSpec", + "description": "Required. The specification of the evaluation." + }, + "name": { + "description": "Immutable. 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" + }, + "qualityMetrics": { + "$ref": "GoogleCloudDiscoveryengineV1betaQualityMetrics", + "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 + }, + "state": { + "description": "Output only. The state of the evaluation.", + "enum": [ + "STATE_UNSPECIFIED", + "PENDING", + "RUNNING", + "SUCCEEDED", + "FAILED" + ], + "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." + ], + "readOnly": true, + "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1betaCondition": { - "description": "Defines circumstances to be checked before allowing a behavior", - "id": "GoogleCloudDiscoveryengineV1betaCondition", + "GoogleCloudDiscoveryengineV1betaEvaluationEvaluationSpec": { + "description": "Describes the specification of the evaluation.", + "id": "GoogleCloudDiscoveryengineV1betaEvaluationEvaluationSpec", "properties": { - "activeTimeRange": { - "description": "Range of time(s) specifying when condition is active. Maximum of 10 time ranges.", - "items": { - "$ref": "GoogleCloudDiscoveryengineV1betaConditionTimeRange" - }, - "type": "array" + "querySetSpec": { + "$ref": "GoogleCloudDiscoveryengineV1betaEvaluationEvaluationSpecQuerySetSpec", + "description": "Required. The specification of the query set." }, - "queryTerms": { - "description": "Search only A list of terms to match the query on. Maximum of 10 query terms.", - "items": { - "$ref": "GoogleCloudDiscoveryengineV1betaConditionQueryTerm" - }, - "type": "array" + "searchRequest": { + "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequest", + "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" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1betaConditionQueryTerm": { - "description": "Matcher for search request query", - "id": "GoogleCloudDiscoveryengineV1betaConditionQueryTerm", + "GoogleCloudDiscoveryengineV1betaEvaluationEvaluationSpecQuerySetSpec": { + "description": "Describes the specification of the query set.", + "id": "GoogleCloudDiscoveryengineV1betaEvaluationEvaluationSpecQuerySetSpec", "properties": { - "fullMatch": { - "description": "Whether the search query needs to exactly match the query term.", - "type": "boolean" - }, - "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.", + "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" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1betaConditionTimeRange": { - "description": "Used for time-dependent conditions.", - "id": "GoogleCloudDiscoveryengineV1betaConditionTimeRange", + "GoogleCloudDiscoveryengineV1betaImportCompletionSuggestionsMetadata": { + "description": "Metadata related to the progress of the ImportCompletionSuggestions operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1betaImportCompletionSuggestionsMetadata", "properties": { - "endTime": { - "description": "End of time range. Range is inclusive. Must be in the future.", + "createTime": { + "description": "Operation create time.", "format": "google-datetime", "type": "string" }, - "startTime": { - "description": "Start of time range. Range is inclusive.", + "failureCount": { + "description": "Count of CompletionSuggestions that failed to be imported.", + "format": "int64", + "type": "string" + }, + "successCount": { + "description": "Count of CompletionSuggestions successfully imported.", + "format": "int64", + "type": "string" + }, + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", "format": "google-datetime", "type": "string" } }, "type": "object" }, - "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`.", - "id": "GoogleCloudDiscoveryengineV1betaControl", + "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.", + "id": "GoogleCloudDiscoveryengineV1betaImportCompletionSuggestionsResponse", "properties": { - "associatedServingConfigIds": { - "description": "Output only. List of all ServingConfig ids this control is attached to. May take up to 10 minutes to update after changes.", - "items": { - "type": "string" - }, - "readOnly": true, - "type": "array" - }, - "boostAction": { - "$ref": "GoogleCloudDiscoveryengineV1betaControlBoostAction", - "description": "Defines a boost-type control" + "errorConfig": { + "$ref": "GoogleCloudDiscoveryengineV1betaImportErrorConfig", + "description": "The desired location of errors incurred during the Import." }, - "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.", + "errorSamples": { + "description": "A sample of errors encountered while processing the request.", "items": { - "$ref": "GoogleCloudDiscoveryengineV1betaCondition" + "$ref": "GoogleRpcStatus" }, "type": "array" - }, - "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": "object" + }, + "GoogleCloudDiscoveryengineV1betaImportDocumentsMetadata": { + "description": "Metadata related to the progress of the ImportDocuments operation. This is returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1betaImportDocumentsMetadata", + "properties": { + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", "type": "string" }, - "filterAction": { - "$ref": "GoogleCloudDiscoveryengineV1betaControlFilterAction", - "description": "Defines a filter-type control Currently not supported by Recommendation" - }, - "name": { - "description": "Immutable. Fully qualified name `projects/*/locations/global/dataStore/*/controls/*`", + "failureCount": { + "description": "Count of entries that encountered errors while processing.", + "format": "int64", "type": "string" }, - "redirectAction": { - "$ref": "GoogleCloudDiscoveryengineV1betaControlRedirectAction", - "description": "Defines a redirect-type control." + "successCount": { + "description": "Count of entries that were processed successfully.", + "format": "int64", + "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.", - "enum": [ - "SOLUTION_TYPE_UNSPECIFIED", - "SOLUTION_TYPE_RECOMMENDATION", - "SOLUTION_TYPE_SEARCH", - "SOLUTION_TYPE_CHAT", - "SOLUTION_TYPE_GENERATIVE_CHAT" - ], - "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." - ], + "totalCount": { + "description": "Total count of entries that were processed.", + "format": "int64", "type": "string" }, - "synonymsAction": { - "$ref": "GoogleCloudDiscoveryengineV1betaControlSynonymsAction", - "description": "Treats a group of terms as synonyms of one another." + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "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.", + "id": "GoogleCloudDiscoveryengineV1betaImportDocumentsResponse", + "properties": { + "errorConfig": { + "$ref": "GoogleCloudDiscoveryengineV1betaImportErrorConfig", + "description": "Echoes the destination for the complete errors in the request if set." }, - "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.", + "errorSamples": { + "description": "A sample of errors encountered while processing the request.", "items": { - "enum": [ - "SEARCH_USE_CASE_UNSPECIFIED", - "SEARCH_USE_CASE_SEARCH", - "SEARCH_USE_CASE_BROWSE" - ], - "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." - ], - "type": "string" + "$ref": "GoogleRpcStatus" }, "type": "array" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1betaControlBoostAction": { - "description": "Adjusts order of products in returned list.", - "id": "GoogleCloudDiscoveryengineV1betaControlBoostAction", + "GoogleCloudDiscoveryengineV1betaImportErrorConfig": { + "description": "Configuration of destination for Import related errors.", + "id": "GoogleCloudDiscoveryengineV1betaImportErrorConfig", "properties": { - "boost": { - "description": "Required. Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0 (No-op).", - "format": "float", - "type": "number" - }, - "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" - }, - "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.", + "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" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1betaControlFilterAction": { - "description": "Specified which products may be included in results. Uses same filter as boost.", - "id": "GoogleCloudDiscoveryengineV1betaControlFilterAction", + "GoogleCloudDiscoveryengineV1betaImportSampleQueriesMetadata": { + "description": "Metadata related to the progress of the ImportSampleQueries operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1betaImportSampleQueriesMetadata", "properties": { - "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", + "createTime": { + "description": "ImportSampleQueries operation create time.", + "format": "google-datetime", "type": "string" }, - "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.", + "failureCount": { + "description": "Count of SampleQuerys that failed to be imported.", + "format": "int64", "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1betaControlRedirectAction": { - "description": "Redirects a shopper to the provided URI.", - "id": "GoogleCloudDiscoveryengineV1betaControlRedirectAction", - "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.", + }, + "successCount": { + "description": "Count of SampleQuerys successfully imported.", + "format": "int64", + "type": "string" + }, + "totalCount": { + "description": "Total count of SampleQuerys that were processed.", + "format": "int64", + "type": "string" + }, + "updateTime": { + "description": "ImportSampleQueries operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", "type": "string" } }, "type": "object" }, - "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\".", - "id": "GoogleCloudDiscoveryengineV1betaControlSynonymsAction", + "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.", + "id": "GoogleCloudDiscoveryengineV1betaImportSampleQueriesResponse", "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.", + "errorConfig": { + "$ref": "GoogleCloudDiscoveryengineV1betaImportErrorConfig", + "description": "The desired location of errors incurred during the Import." + }, + "errorSamples": { + "description": "A sample of errors encountered while processing the request.", "items": { - "type": "string" + "$ref": "GoogleRpcStatus" }, "type": "array" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1betaCreateDataStoreMetadata": { - "description": "Metadata related to the progress of the DataStoreService.CreateDataStore operation. This will be returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1betaCreateDataStoreMetadata", + "GoogleCloudDiscoveryengineV1betaImportSuggestionDenyListEntriesMetadata": { + "description": "Metadata related to the progress of the ImportSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1betaImportSuggestionDenyListEntriesMetadata", "properties": { "createTime": { "description": "Operation create time.", "format": "google-datetime", "type": "string" }, - "updateTime": { - "description": "Operation last update time. If the operation is done, this is also the finish time.", - "format": "google-datetime", + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaImportSuggestionDenyListEntriesResponse": { + "description": "Response message for CompletionService.ImportSuggestionDenyListEntries method.", + "id": "GoogleCloudDiscoveryengineV1betaImportSuggestionDenyListEntriesResponse", + "properties": { + "errorSamples": { + "description": "A sample of errors encountered while processing the request.", + "items": { + "$ref": "GoogleRpcStatus" + }, + "type": "array" + }, + "failedEntriesCount": { + "description": "Count of deny list entries that failed to be imported.", + "format": "int64", + "type": "string" + }, + "importedEntriesCount": { + "description": "Count of deny list entries successfully imported.", + "format": "int64", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1betaCreateEngineMetadata": { - "description": "Metadata related to the progress of the EngineService.CreateEngine operation. This will be returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1betaCreateEngineMetadata", + "GoogleCloudDiscoveryengineV1betaImportUserEventsMetadata": { + "description": "Metadata related to the progress of the Import operation. This is returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1betaImportUserEventsMetadata", "properties": { "createTime": { "description": "Operation create time.", "format": "google-datetime", "type": "string" }, + "failureCount": { + "description": "Count of entries that encountered errors while processing.", + "format": "int64", + "type": "string" + }, + "successCount": { + "description": "Count of entries that were processed successfully.", + "format": "int64", + "type": "string" + }, "updateTime": { "description": "Operation last update time. If the operation is done, this is also the finish time.", "format": "google-datetime", @@ -15324,205 +17626,202 @@ }, "type": "object" }, - "GoogleCloudDiscoveryengineV1betaCreateSchemaMetadata": { - "description": "Metadata for Create Schema LRO.", - "id": "GoogleCloudDiscoveryengineV1betaCreateSchemaMetadata", + "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.", + "id": "GoogleCloudDiscoveryengineV1betaImportUserEventsResponse", "properties": { - "createTime": { - "description": "Operation create time.", - "format": "google-datetime", + "errorConfig": { + "$ref": "GoogleCloudDiscoveryengineV1betaImportErrorConfig", + "description": "Echoes the destination for the complete errors if this field was set in the request." + }, + "errorSamples": { + "description": "A sample of errors encountered while processing the request.", + "items": { + "$ref": "GoogleRpcStatus" + }, + "type": "array" + }, + "joinedEventsCount": { + "description": "Count of user events imported with complete existing Documents.", + "format": "int64", "type": "string" }, - "updateTime": { - "description": "Operation last update time. If the operation is done, this is also the finish time.", - "format": "google-datetime", + "unjoinedEventsCount": { + "description": "Count of user events imported, but with Document information not found in the existing Branch.", + "format": "int64", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1betaCreateTargetSiteMetadata": { - "description": "Metadata related to the progress of the SiteSearchEngineService.CreateTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1betaCreateTargetSiteMetadata", + "GoogleCloudDiscoveryengineV1betaInterval": { + "description": "A floating point interval.", + "id": "GoogleCloudDiscoveryengineV1betaInterval", "properties": { - "createTime": { - "description": "Operation create time.", - "format": "google-datetime", - "type": "string" + "exclusiveMaximum": { + "description": "Exclusive upper bound.", + "format": "double", + "type": "number" }, - "updateTime": { - "description": "Operation last update time. If the operation is done, this is also the finish time.", - "format": "google-datetime", - "type": "string" + "exclusiveMinimum": { + "description": "Exclusive lower bound.", + "format": "double", + "type": "number" + }, + "maximum": { + "description": "Inclusive upper bound.", + "format": "double", + "type": "number" + }, + "minimum": { + "description": "Inclusive lower bound.", + "format": "double", + "type": "number" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1betaCustomTuningModel": { - "description": "Metadata that describes a custom tuned model.", - "id": "GoogleCloudDiscoveryengineV1betaCustomTuningModel", + "GoogleCloudDiscoveryengineV1betaLanguageInfo": { + "description": "Language info for DataStore.", + "id": "GoogleCloudDiscoveryengineV1betaLanguageInfo", "properties": { - "createTime": { - "description": "Timestamp the Model was created at.", - "format": "google-datetime", + "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" }, - "displayName": { - "description": "The display name of the model.", + "languageCode": { + "description": "The language code for the DataStore.", "type": "string" }, - "modelState": { - "description": "The state that the model is in (e.g.`TRAINING` or `TRAINING_FAILED`).", - "enum": [ - "MODEL_STATE_UNSPECIFIED", - "TRAINING_PAUSED", - "TRAINING", - "TRAINING_COMPLETE", - "READY_FOR_SERVING", - "TRAINING_FAILED" - ], - "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." - ], + "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" }, - "modelVersion": { - "description": "The version of the model.", - "format": "int64", + "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" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaListCustomModelsResponse": { + "description": "Response message for SearchTuningService.ListCustomModels method.", + "id": "GoogleCloudDiscoveryengineV1betaListCustomModelsResponse", + "properties": { + "models": { + "description": "List of custom tuning models.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1betaCustomTuningModel" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaProject": { + "description": "Metadata and configurations for a Google Cloud project in the service.", + "id": "GoogleCloudDiscoveryengineV1betaProject", + "properties": { + "createTime": { + "description": "Output only. The timestamp when this project is created.", + "format": "google-datetime", + "readOnly": true, "type": "string" }, "name": { - "description": "Required. The fully qualified resource name of the model. Format: `projects/{project_number}/locations/{location}/collections/{collection}/dataStores/{data_store}/customTuningModels/{custom_tuning_model}` model must be an alpha-numerical string with limit of 40 characters.", + "description": "Output only. Full resource name of the project, for example `projects/{project_number}`. 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" }, - "trainingStartTime": { - "description": "Timestamp the model training was initiated.", + "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.", "format": "google-datetime", + "readOnly": true, "type": "string" + }, + "serviceTermsMap": { + "additionalProperties": { + "$ref": "GoogleCloudDiscoveryengineV1betaProjectServiceTerms" + }, + "description": "Output only. A map of terms of services. The key is the `id` of ServiceTerms.", + "readOnly": true, + "type": "object" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1betaDataStore": { - "description": "DataStore captures global settings and configs at the DataStore level.", - "id": "GoogleCloudDiscoveryengineV1betaDataStore", + "GoogleCloudDiscoveryengineV1betaProjectServiceTerms": { + "description": "Metadata about the terms of service.", + "id": "GoogleCloudDiscoveryengineV1betaProjectServiceTerms", "properties": { - "contentConfig": { - "description": "Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT.", - "enum": [ - "CONTENT_CONFIG_UNSPECIFIED", - "NO_CONTENT", - "CONTENT_REQUIRED", - "PUBLIC_WEBSITE" - ], - "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." - ], - "type": "string" - }, - "createTime": { - "description": "Output only. Timestamp the DataStore was created at.", + "acceptTime": { + "description": "The last time when the project agreed to the terms of service.", "format": "google-datetime", - "readOnly": true, "type": "string" }, - "defaultSchemaId": { - "description": "Output only. The id of the default Schema asscociated to this data store.", - "readOnly": true, + "declineTime": { + "description": "The last time when the project declined or revoked the agreement to terms of service.", + "format": "google-datetime", "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.", + "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" }, - "documentProcessingConfig": { - "$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfig", - "description": "Configuration for Document understanding and enrichment." - }, - "industryVertical": { - "description": "Immutable. The industry vertical that the data store registers.", + "state": { + "description": "Whether the project has accepted/rejected the service terms or it is still pending.", "enum": [ - "INDUSTRY_VERTICAL_UNSPECIFIED", - "GENERIC", - "MEDIA", - "HEALTHCARE_FHIR" + "STATE_UNSPECIFIED", + "TERMS_ACCEPTED", + "TERMS_PENDING", + "TERMS_DECLINED" ], "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." + "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." ], "type": "string" }, - "languageInfo": { - "$ref": "GoogleCloudDiscoveryengineV1betaLanguageInfo", - "description": "Language info for DataStore." - }, - "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" - }, - "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.", - "items": { - "enum": [ - "SOLUTION_TYPE_UNSPECIFIED", - "SOLUTION_TYPE_RECOMMENDATION", - "SOLUTION_TYPE_SEARCH", - "SOLUTION_TYPE_CHAT", - "SOLUTION_TYPE_GENERATIVE_CHAT" - ], - "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." - ], - "type": "string" - }, - "type": "array" - }, - "startingSchema": { - "$ref": "GoogleCloudDiscoveryengineV1betaSchema", - "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)." + "version": { + "description": "The version string of the terms of service. For acceptable values, see the comments for id above.", + "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1betaDeleteDataStoreMetadata": { - "description": "Metadata related to the progress of the DataStoreService.DeleteDataStore operation. This will be returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1betaDeleteDataStoreMetadata", + "GoogleCloudDiscoveryengineV1betaProvisionProjectMetadata": { + "description": "Metadata associated with a project provision operation.", + "id": "GoogleCloudDiscoveryengineV1betaProvisionProjectMetadata", + "properties": {}, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaPurgeDocumentsMetadata": { + "description": "Metadata related to the progress of the PurgeDocuments operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1betaPurgeDocumentsMetadata", "properties": { "createTime": { "description": "Operation create time.", "format": "google-datetime", "type": "string" }, - "updateTime": { - "description": "Operation last update time. If the operation is done, this is also the finish time.", - "format": "google-datetime", + "failureCount": { + "description": "Count of entries that encountered errors while processing.", + "format": "int64", "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1betaDeleteEngineMetadata": { - "description": "Metadata related to the progress of the EngineService.DeleteEngine operation. This will be returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1betaDeleteEngineMetadata", - "properties": { - "createTime": { - "description": "Operation create time.", - "format": "google-datetime", + }, + "ignoredCount": { + "description": "Count of entries that were ignored as entries were not found.", + "format": "int64", + "type": "string" + }, + "successCount": { + "description": "Count of entries that were deleted successfully.", + "format": "int64", "type": "string" }, "updateTime": { @@ -15533,26 +17832,28 @@ }, "type": "object" }, - "GoogleCloudDiscoveryengineV1betaDeleteSchemaMetadata": { - "description": "Metadata for DeleteSchema LRO.", - "id": "GoogleCloudDiscoveryengineV1betaDeleteSchemaMetadata", + "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.", + "id": "GoogleCloudDiscoveryengineV1betaPurgeDocumentsResponse", "properties": { - "createTime": { - "description": "Operation create time.", - "format": "google-datetime", + "purgeCount": { + "description": "The total count of documents purged as a result of the operation.", + "format": "int64", "type": "string" }, - "updateTime": { - "description": "Operation last update time. If the operation is done, this is also the finish time.", - "format": "google-datetime", - "type": "string" + "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.", + "items": { + "type": "string" + }, + "type": "array" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1betaDeleteTargetSiteMetadata": { - "description": "Metadata related to the progress of the SiteSearchEngineService.DeleteTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1betaDeleteTargetSiteMetadata", + "GoogleCloudDiscoveryengineV1betaPurgeSuggestionDenyListEntriesMetadata": { + "description": "Metadata related to the progress of the PurgeSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1betaPurgeSuggestionDenyListEntriesMetadata", "properties": { "createTime": { "description": "Operation create time.", @@ -15567,700 +17868,651 @@ }, "type": "object" }, - "GoogleCloudDiscoveryengineV1betaDisableAdvancedSiteSearchMetadata": { - "description": "Metadata related to the progress of the SiteSearchEngineService.DisableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1betaDisableAdvancedSiteSearchMetadata", + "GoogleCloudDiscoveryengineV1betaPurgeSuggestionDenyListEntriesResponse": { + "description": "Response message for CompletionService.PurgeSuggestionDenyListEntries method.", + "id": "GoogleCloudDiscoveryengineV1betaPurgeSuggestionDenyListEntriesResponse", "properties": { - "createTime": { - "description": "Operation create time.", - "format": "google-datetime", - "type": "string" + "errorSamples": { + "description": "A sample of errors encountered while processing the request.", + "items": { + "$ref": "GoogleRpcStatus" + }, + "type": "array" }, - "updateTime": { - "description": "Operation last update time. If the operation is done, this is also the finish time.", - "format": "google-datetime", + "purgeCount": { + "description": "Number of suggestion deny list entries purged.", + "format": "int64", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1betaDisableAdvancedSiteSearchResponse": { - "description": "Response message for SiteSearchEngineService.DisableAdvancedSiteSearch method.", - "id": "GoogleCloudDiscoveryengineV1betaDisableAdvancedSiteSearchResponse", - "properties": {}, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfig": { - "description": "A singleton resource of DataStore. It's empty when DataStore is created, which defaults to digital parser. The first call to DataStoreService.UpdateDocumentProcessingConfig method will initialize the config.", - "id": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfig", + "GoogleCloudDiscoveryengineV1betaQualityMetrics": { + "description": "Describes the metrics produced by the evaluation.", + "id": "GoogleCloudDiscoveryengineV1betaQualityMetrics", "properties": { - "chunkingConfig": { - "$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfig", - "description": "Whether chunking mode is enabled." + "docNdcg": { + "$ref": "GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics", + "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" }, - "defaultParsingConfig": { - "$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig", - "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." + "docPrecision": { + "$ref": "GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics", + "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" }, - "name": { - "description": "The full resource name of the Document Processing Config. Format: `projects/*/locations/*/collections/*/dataStores/*/documentProcessingConfig`.", - "type": "string" + "docRecall": { + "$ref": "GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics", + "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" }, - "parsingConfigOverrides": { - "additionalProperties": { - "$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig" - }, - "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 or layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and or layout parsing are supported.", - "type": "object" - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfig": { - "description": "Configuration for chunking config.", - "id": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfig", - "properties": { - "layoutBasedChunkingConfig": { - "$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig", - "description": "Configuration for the layout based chunking." - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig": { - "description": "Configuration for the layout based chunking.", - "id": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig", - "properties": { - "chunkSize": { - "description": "The token size limit for each chunk. Supported values: 100-500 (inclusive). Default value: 500.", - "format": "int32", - "type": "integer" + "pageNdcg": { + "$ref": "GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics", + "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" }, - "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" + "pageRecall": { + "$ref": "GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics", + "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" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig": { - "description": "Related configurations applied to a specific type of document parser.", - "id": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig", + "GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics": { + "description": "Stores the metric values at specific top-k levels.", + "id": "GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics", "properties": { - "digitalParsingConfig": { - "$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigDigitalParsingConfig", - "description": "Configurations applied to digital parser." + "top1": { + "description": "The top-1 value.", + "format": "double", + "type": "number" }, - "layoutParsingConfig": { - "$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigLayoutParsingConfig", - "description": "Configurations applied to layout parser." + "top10": { + "description": "The top-10 value.", + "format": "double", + "type": "number" }, - "ocrParsingConfig": { - "$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsingConfig", - "description": "Configurations applied to OCR parser. Currently it only applies to PDFs." - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigDigitalParsingConfig": { - "description": "The digital parsing configurations for documents.", - "id": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigDigitalParsingConfig", - "properties": {}, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigLayoutParsingConfig": { - "description": "The layout parsing configurations for documents.", - "id": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigLayoutParsingConfig", - "properties": {}, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsingConfig": { - "description": "The OCR parsing configurations for documents.", - "id": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsingConfig", - "properties": { - "enhancedDocumentElements": { - "deprecated": true, - "description": "[DEPRECATED] This field is deprecated. To use the additional enhanced document elements processing, please switch to `layout_parsing_config`.", - "items": { - "type": "string" - }, - "type": "array" + "top3": { + "description": "The top-3 value.", + "format": "double", + "type": "number" }, - "useNativeText": { - "description": "If true, will use native text instead of OCR text on pages containing native text.", - "type": "boolean" + "top5": { + "description": "The top-5 value.", + "format": "double", + "type": "number" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1betaEnableAdvancedSiteSearchMetadata": { - "description": "Metadata related to the progress of the SiteSearchEngineService.EnableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1betaEnableAdvancedSiteSearchMetadata", + "GoogleCloudDiscoveryengineV1betaSchema": { + "description": "Defines the structure and layout of a type of document data.", + "id": "GoogleCloudDiscoveryengineV1betaSchema", "properties": { - "createTime": { - "description": "Operation create time.", - "format": "google-datetime", + "jsonSchema": { + "description": "The JSON representation of the schema.", "type": "string" }, - "updateTime": { - "description": "Operation last update time. If the operation is done, this is also the finish time.", - "format": "google-datetime", + "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" + }, + "structSchema": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "The structured representation of the schema.", + "type": "object" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1betaEnableAdvancedSiteSearchResponse": { - "description": "Response message for SiteSearchEngineService.EnableAdvancedSiteSearch method.", - "id": "GoogleCloudDiscoveryengineV1betaEnableAdvancedSiteSearchResponse", - "properties": {}, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1betaEngine": { - "description": "Metadata that describes the training and serving parameters of an Engine.", - "id": "GoogleCloudDiscoveryengineV1betaEngine", + "GoogleCloudDiscoveryengineV1betaSearchRequest": { + "description": "Request message for SearchService.Search method.", + "id": "GoogleCloudDiscoveryengineV1betaSearchRequest", "properties": { - "chatEngineConfig": { - "$ref": "GoogleCloudDiscoveryengineV1betaEngineChatEngineConfig", - "description": "Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT." - }, - "chatEngineMetadata": { - "$ref": "GoogleCloudDiscoveryengineV1betaEngineChatEngineMetadata", - "description": "Output only. Additional information of the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.", - "readOnly": true + "boostSpec": { + "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpec", + "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)" }, - "commonConfig": { - "$ref": "GoogleCloudDiscoveryengineV1betaEngineCommonConfig", - "description": "Common config spec that specifies the metadata of the engine." + "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" }, - "createTime": { - "description": "Output only. Timestamp the Recommendation Engine was created at.", - "format": "google-datetime", - "readOnly": true, + "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" }, - "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.", + "contentSearchSpec": { + "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpec", + "description": "A specification for configuring the behavior of content search." + }, + "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.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec" + }, + "type": "array" + }, + "embeddingSpec": { + "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpec", + "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." + }, + "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.", "items": { - "type": "string" + "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestFacetSpec" }, "type": "array" }, - "displayName": { - "description": "Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters.", + "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" }, - "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.", - "enum": [ - "INDUSTRY_VERTICAL_UNSPECIFIED", - "GENERIC", - "MEDIA", - "HEALTHCARE_FHIR" - ], - "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." - ], + "imageQuery": { + "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestImageQuery", + "description": "Raw image query." + }, + "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" }, - "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_number}/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.", + "naturalLanguageQueryUnderstandingSpec": { + "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestNaturalLanguageQueryUnderstandingSpec", + "description": "If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done." + }, + "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.", + "format": "int32", + "type": "integer" + }, + "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 for retail search, see [Ordering](https://cloud.google.com/retail/docs/filter-and-order#order) If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.", "type": "string" }, - "searchEngineConfig": { - "$ref": "GoogleCloudDiscoveryengineV1betaEngineSearchEngineConfig", - "description": "Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH." + "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.", + "format": "int32", + "type": "integer" }, - "solutionType": { - "description": "Required. The solutions of the engine.", - "enum": [ - "SOLUTION_TYPE_UNSPECIFIED", - "SOLUTION_TYPE_RECOMMENDATION", - "SOLUTION_TYPE_SEARCH", - "SOLUTION_TYPE_CHAT", - "SOLUTION_TYPE_GENERATIVE_CHAT" - ], - "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." - ], + "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" }, - "updateTime": { - "description": "Output only. Timestamp the Recommendation Engine was last updated.", - "format": "google-datetime", - "readOnly": true, + "params": { + "additionalProperties": { + "type": "any" + }, + "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" + }, + "query": { + "description": "Raw search query.", "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1betaEngineChatEngineConfig": { - "description": "Configurations for a Chat Engine.", - "id": "GoogleCloudDiscoveryengineV1betaEngineChatEngineConfig", - "properties": { - "agentCreationConfig": { - "$ref": "GoogleCloudDiscoveryengineV1betaEngineChatEngineConfigAgentCreationConfig", - "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." }, - "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.", + "queryExpansionSpec": { + "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestQueryExpansionSpec", + "description": "The query expansion specification that specifies the conditions under which query expansion occurs." + }, + "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)`.", "type": "string" - } - }, - "type": "object" - }, - "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.", - "id": "GoogleCloudDiscoveryengineV1betaEngineChatEngineConfigAgentCreationConfig", - "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.", + }, + "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" }, - "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.", + "safeSearch": { + "description": "Whether to turn on safe search. This is only supported for website search.", + "type": "boolean" + }, + "searchAsYouTypeSpec": { + "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestSearchAsYouTypeSpec", + "description": "Search as you type configuration. Only supported for the IndustryVertical.MEDIA vertical." + }, + "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" }, - "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.", + "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 /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" }, - "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.", + "sessionSpec": { + "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestSessionSpec", + "description": "Session specification. Can be used only when `session` is set." + }, + "spellCorrectionSpec": { + "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestSpellCorrectionSpec", + "description": "The spell correction specification that specifies the mode under which spell correction takes effect." + }, + "userInfo": { + "$ref": "GoogleCloudDiscoveryengineV1betaUserInfo", + "description": "Information about the end user. Highly recommended for analytics. UserInfo.user_agent is used to deduce `device_type` for analytics." + }, + "userLabels": { + "additionalProperties": { + "type": "string" + }, + "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" + }, + "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" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1betaEngineChatEngineMetadata": { - "description": "Additional information of a Chat Engine. Fields in this message are output only.", - "id": "GoogleCloudDiscoveryengineV1betaEngineChatEngineMetadata", + "GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpec": { + "description": "Boost specification to boost certain documents.", + "id": "GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpec", "properties": { - "dialogflowAgent": { - "description": "The resource name of a Dialogflow agent, that this Chat Engine refers to. Format: `projects//locations//agents/`.", - "type": "string" + "conditionBoostSpecs": { + "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.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpec" + }, + "type": "array" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1betaEngineCommonConfig": { - "description": "Common configurations for an Engine.", - "id": "GoogleCloudDiscoveryengineV1betaEngineCommonConfig", + "GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpec": { + "description": "Boost applies to documents which match a condition.", + "id": "GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpec", "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.", + "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.", + "format": "float", + "type": "number" + }, + "boostControlSpec": { + "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpecBoostControlSpec", + "description": "Complex specification for custom ranking based on customer defined attribute value." + }, + "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" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1betaEngineSearchEngineConfig": { - "description": "Configurations for a Search Engine.", - "id": "GoogleCloudDiscoveryengineV1betaEngineSearchEngineConfig", + "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.", + "id": "GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpecBoostControlSpec", "properties": { - "searchAddOns": { - "description": "The add-on that this search engine enables.", + "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).", + "enum": [ + "ATTRIBUTE_TYPE_UNSPECIFIED", + "NUMERICAL", + "FRESHNESS" + ], + "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`." + ], + "type": "string" + }, + "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.", "items": { - "enum": [ - "SEARCH_ADD_ON_UNSPECIFIED", - "SEARCH_ADD_ON_LLM" - ], - "enumDescriptions": [ - "Default value when the enum is unspecified. This is invalid to use.", - "Large language model add-on." - ], - "type": "string" + "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpecBoostControlSpecControlPoint" }, "type": "array" }, - "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.", + "fieldName": { + "description": "The name of the field whose value will be used to determine the boost amount.", + "type": "string" + }, + "interpolationType": { + "description": "The interpolation type to be applied to connect the control points listed below.", "enum": [ - "SEARCH_TIER_UNSPECIFIED", - "SEARCH_TIER_STANDARD", - "SEARCH_TIER_ENTERPRISE" + "INTERPOLATION_TYPE_UNSPECIFIED", + "LINEAR" ], "enumDescriptions": [ - "Default value when the enum is unspecified. This is invalid to use.", - "Standard tier.", - "Enterprise tier." + "Interpolation type is unspecified. In this case, it defaults to Linear.", + "Piecewise linear interpolation will be applied." ], "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1betaImportCompletionSuggestionsMetadata": { - "description": "Metadata related to the progress of the ImportCompletionSuggestions operation. This will be returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1betaImportCompletionSuggestionsMetadata", + "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).", + "id": "GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpecBoostControlSpecControlPoint", "properties": { - "createTime": { - "description": "Operation create time.", - "format": "google-datetime", + "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" }, - "failureCount": { - "description": "Count of CompletionSuggestions that failed to be imported.", - "format": "int64", + "boostAmount": { + "description": "The value between -1 to 1 by which to boost the score if the attribute_value evaluates to the value specified above.", + "format": "float", + "type": "number" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpec": { + "description": "A specification for configuring the behavior of content search.", + "id": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpec", + "properties": { + "chunkSpec": { + "$ref": "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" + }, + "extractiveContentSpec": { + "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecExtractiveContentSpec", + "description": "If there is no extractive_content_spec provided, there will be no extractive answer in the search response." + }, + "searchResultMode": { + "description": "Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`.", + "enum": [ + "SEARCH_RESULT_MODE_UNSPECIFIED", + "DOCUMENTS", + "CHUNKS" + ], + "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." + ], "type": "string" }, - "successCount": { - "description": "Count of CompletionSuggestions successfully imported.", - "format": "int64", - "type": "string" + "snippetSpec": { + "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSnippetSpec", + "description": "If `snippetSpec` is not specified, snippets are not included in the search response." }, - "updateTime": { - "description": "Operation last update time. If the operation is done, this is also the finish time.", - "format": "google-datetime", - "type": "string" + "summarySpec": { + "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpec", + "description": "If `summarySpec` is not specified, summaries are not included in the search response." } }, "type": "object" }, - "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.", - "id": "GoogleCloudDiscoveryengineV1betaImportCompletionSuggestionsResponse", + "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", + "id": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecChunkSpec", "properties": { - "errorConfig": { - "$ref": "GoogleCloudDiscoveryengineV1betaImportErrorConfig", - "description": "The desired location of errors incurred during the Import." + "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.", + "format": "int32", + "type": "integer" }, - "errorSamples": { - "description": "A sample of errors encountered while processing the request.", - "items": { - "$ref": "GoogleRpcStatus" - }, - "type": "array" + "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.", + "format": "int32", + "type": "integer" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1betaImportDocumentsMetadata": { - "description": "Metadata related to the progress of the ImportDocuments operation. This is returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1betaImportDocumentsMetadata", + "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecExtractiveContentSpec": { + "description": "A specification for configuring the extractive content in a search response.", + "id": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecExtractiveContentSpec", "properties": { - "createTime": { - "description": "Operation create time.", - "format": "google-datetime", - "type": "string" + "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.", + "format": "int32", + "type": "integer" }, - "failureCount": { - "description": "Count of entries that encountered errors while processing.", - "format": "int64", - "type": "string" + "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`.", + "format": "int32", + "type": "integer" }, - "successCount": { - "description": "Count of entries that were processed successfully.", - "format": "int64", - "type": "string" + "numNextSegments": { + "description": "Return at most `num_next_segments` segments after each selected segments.", + "format": "int32", + "type": "integer" }, - "totalCount": { - "description": "Total count of entries that were processed.", - "format": "int64", - "type": "string" + "numPreviousSegments": { + "description": "Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments.", + "format": "int32", + "type": "integer" }, - "updateTime": { - "description": "Operation last update time. If the operation is done, this is also the finish time.", - "format": "google-datetime", - "type": "string" + "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" } }, "type": "object" }, - "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.", - "id": "GoogleCloudDiscoveryengineV1betaImportDocumentsResponse", + "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSnippetSpec": { + "description": "A specification for configuring snippets in a search response.", + "id": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSnippetSpec", "properties": { - "errorConfig": { - "$ref": "GoogleCloudDiscoveryengineV1betaImportErrorConfig", - "description": "Echoes the destination for the complete errors in the request if set." + "maxSnippetCount": { + "deprecated": true, + "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.", + "format": "int32", + "type": "integer" }, - "errorSamples": { - "description": "A sample of errors encountered while processing the request.", - "items": { - "$ref": "GoogleRpcStatus" - }, - "type": "array" + "referenceOnly": { + "deprecated": true, + "description": "[DEPRECATED] This field is deprecated and will have no affect on the snippet.", + "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" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1betaImportErrorConfig": { - "description": "Configuration of destination for Import related errors.", - "id": "GoogleCloudDiscoveryengineV1betaImportErrorConfig", + "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpec": { + "description": "A specification for configuring a summary returned in a search response.", + "id": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpec", "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.", + "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" + }, + "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" + }, + "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" + }, + "modelPromptSpec": { + "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelPromptSpec", + "description": "If specified, the spec will be used to modify the prompt provided to the LLM." + }, + "modelSpec": { + "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelSpec", + "description": "If specified, the spec will be used to modify the model specification provided to the LLM." + }, + "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.", + "format": "int32", + "type": "integer" + }, + "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" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1betaImportSuggestionDenyListEntriesMetadata": { - "description": "Metadata related to the progress of the ImportSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1betaImportSuggestionDenyListEntriesMetadata", + "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelPromptSpec": { + "description": "Specification of the prompt to use with the model.", + "id": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelPromptSpec", "properties": { - "createTime": { - "description": "Operation create time.", - "format": "google-datetime", - "type": "string" - }, - "updateTime": { - "description": "Operation last update time. If the operation is done, this is also the finish time.", - "format": "google-datetime", + "preamble": { + "description": "Text at the beginning of the prompt that instructs the assistant. Examples are available in the user guide.", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1betaImportSuggestionDenyListEntriesResponse": { - "description": "Response message for CompletionService.ImportSuggestionDenyListEntries method.", - "id": "GoogleCloudDiscoveryengineV1betaImportSuggestionDenyListEntriesResponse", + "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelSpec": { + "description": "Specification of the model.", + "id": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelSpec", "properties": { - "errorSamples": { - "description": "A sample of errors encountered while processing the request.", - "items": { - "$ref": "GoogleRpcStatus" - }, - "type": "array" - }, - "failedEntriesCount": { - "description": "Count of deny list entries that failed to be imported.", - "format": "int64", - "type": "string" - }, - "importedEntriesCount": { - "description": "Count of deny list entries successfully imported.", - "format": "int64", + "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" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1betaImportUserEventsMetadata": { - "description": "Metadata related to the progress of the Import operation. This is returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1betaImportUserEventsMetadata", + "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.", + "id": "GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec", "properties": { - "createTime": { - "description": "Operation create time.", - "format": "google-datetime", - "type": "string" - }, - "failureCount": { - "description": "Count of entries that encountered errors while processing.", - "format": "int64", - "type": "string" - }, - "successCount": { - "description": "Count of entries that were processed successfully.", - "format": "int64", - "type": "string" - }, - "updateTime": { - "description": "Operation last update time. If the operation is done, this is also the finish time.", - "format": "google-datetime", + "dataStore": { + "description": "Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`.", "type": "string" } }, "type": "object" }, - "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.", - "id": "GoogleCloudDiscoveryengineV1betaImportUserEventsResponse", + "GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpec": { + "description": "The specification that uses customized query embedding vector to do semantic document retrieval.", + "id": "GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpec", "properties": { - "errorConfig": { - "$ref": "GoogleCloudDiscoveryengineV1betaImportErrorConfig", - "description": "Echoes the destination for the complete errors if this field was set in the request." - }, - "errorSamples": { - "description": "A sample of errors encountered while processing the request.", + "embeddingVectors": { + "description": "The embedding vector used for retrieval. Limit to 1.", "items": { - "$ref": "GoogleRpcStatus" + "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpecEmbeddingVector" }, "type": "array" - }, - "joinedEventsCount": { - "description": "Count of user events imported with complete existing Documents.", - "format": "int64", - "type": "string" - }, - "unjoinedEventsCount": { - "description": "Count of user events imported, but with Document information not found in the existing Branch.", - "format": "int64", - "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1betaLanguageInfo": { - "description": "Language info for DataStore.", - "id": "GoogleCloudDiscoveryengineV1betaLanguageInfo", + "GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpecEmbeddingVector": { + "description": "Embedding vector.", + "id": "GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpecEmbeddingVector", "properties": { - "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" - }, - "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, + "fieldPath": { + "description": "Embedding field path in schema.", "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" - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1betaListCustomModelsResponse": { - "description": "Response message for SearchTuningService.ListCustomModels method.", - "id": "GoogleCloudDiscoveryengineV1betaListCustomModelsResponse", - "properties": { - "models": { - "description": "List of custom tuning models.", + "vector": { + "description": "Query embedding vector.", "items": { - "$ref": "GoogleCloudDiscoveryengineV1betaCustomTuningModel" + "format": "float", + "type": "number" }, "type": "array" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1betaProject": { - "description": "Metadata and configurations for a Google Cloud project in the service.", - "id": "GoogleCloudDiscoveryengineV1betaProject", + "GoogleCloudDiscoveryengineV1betaSearchRequestFacetSpec": { + "description": "A facet specification to perform faceted search.", + "id": "GoogleCloudDiscoveryengineV1betaSearchRequestFacetSpec", "properties": { - "createTime": { - "description": "Output only. The timestamp when this project is created.", - "format": "google-datetime", - "readOnly": true, - "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" }, - "name": { - "description": "Output only. Full resource name of the project, for example `projects/{project_number}`. 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" + "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.", + "items": { + "type": "string" + }, + "type": "array" }, - "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.", - "format": "google-datetime", - "readOnly": true, - "type": "string" + "facetKey": { + "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestFacetSpecFacetKey", + "description": "Required. The facet key specification." }, - "serviceTermsMap": { - "additionalProperties": { - "$ref": "GoogleCloudDiscoveryengineV1betaProjectServiceTerms" - }, - "description": "Output only. A map of terms of services. The key is the `id` of ServiceTerms.", - "readOnly": true, - "type": "object" + "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.", + "format": "int32", + "type": "integer" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1betaProjectServiceTerms": { - "description": "Metadata about the terms of service.", - "id": "GoogleCloudDiscoveryengineV1betaProjectServiceTerms", + "GoogleCloudDiscoveryengineV1betaSearchRequestFacetSpecFacetKey": { + "description": "Specifies how a facet is computed.", + "id": "GoogleCloudDiscoveryengineV1betaSearchRequestFacetSpecFacetKey", "properties": { - "acceptTime": { - "description": "The last time when the project agreed to the terms of service.", - "format": "google-datetime", - "type": "string" + "caseInsensitive": { + "description": "True to make facet keys case insensitive when getting faceting values with prefixes or contains; false otherwise.", + "type": "boolean" }, - "declineTime": { - "description": "The last time when the project declined or revoked the agreement to terms of service.", - "format": "google-datetime", - "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.", + "items": { + "type": "string" + }, + "type": "array" }, - "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" + "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.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1betaInterval" + }, + "type": "array" }, - "state": { - "description": "Whether the project has accepted/rejected the service terms or it is still pending.", - "enum": [ - "STATE_UNSPECIFIED", - "TERMS_ACCEPTED", - "TERMS_PENDING", - "TERMS_DECLINED" - ], - "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." - ], + "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" }, - "version": { - "description": "The version string of the terms of service. For acceptable values, see the comments for id above.", + "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" + }, + "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.", + "items": { + "type": "string" + }, + "type": "array" + }, + "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.", + "items": { + "type": "string" + }, + "type": "array" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1betaProvisionProjectMetadata": { - "description": "Metadata associated with a project provision operation.", - "id": "GoogleCloudDiscoveryengineV1betaProvisionProjectMetadata", - "properties": {}, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1betaPurgeDocumentsMetadata": { - "description": "Metadata related to the progress of the PurgeDocuments operation. This will be returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1betaPurgeDocumentsMetadata", + "GoogleCloudDiscoveryengineV1betaSearchRequestImageQuery": { + "description": "Specifies the image query input.", + "id": "GoogleCloudDiscoveryengineV1betaSearchRequestImageQuery", "properties": { - "createTime": { - "description": "Operation create time.", - "format": "google-datetime", - "type": "string" - }, - "failureCount": { - "description": "Count of entries that encountered errors while processing.", - "format": "int64", - "type": "string" - }, - "ignoredCount": { - "description": "Count of entries that were ignored as entries were not found.", - "format": "int64", - "type": "string" - }, - "successCount": { - "description": "Count of entries that were deleted successfully.", - "format": "int64", - "type": "string" - }, - "updateTime": { - "description": "Operation last update time. If the operation is done, this is also the finish time.", - "format": "google-datetime", + "imageBytes": { + "description": "Base64 encoded image bytes. Supported image formats: JPEG, PNG, and BMP.", "type": "string" } }, "type": "object" }, - "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.", - "id": "GoogleCloudDiscoveryengineV1betaPurgeDocumentsResponse", + "GoogleCloudDiscoveryengineV1betaSearchRequestNaturalLanguageQueryUnderstandingSpec": { + "description": "Specification to enable natural language understanding capabilities for search requests.", + "id": "GoogleCloudDiscoveryengineV1betaSearchRequestNaturalLanguageQueryUnderstandingSpec", "properties": { - "purgeCount": { - "description": "The total count of documents purged as a result of the operation.", - "format": "int64", + "filterExtractionCondition": { + "description": "The condition under which filter extraction should occur. Default to Condition.DISABLED.", + "enum": [ + "CONDITION_UNSPECIFIED", + "DISABLED", + "ENABLED" + ], + "enumDescriptions": [ + "Server behavior defaults to Condition.DISABLED.", + "Disables NL filter extraction.", + "Enables NL filter extraction." + ], "type": "string" }, - "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.", + "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.", "items": { "type": "string" }, @@ -16269,61 +18521,85 @@ }, "type": "object" }, - "GoogleCloudDiscoveryengineV1betaPurgeSuggestionDenyListEntriesMetadata": { - "description": "Metadata related to the progress of the PurgeSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1betaPurgeSuggestionDenyListEntriesMetadata", + "GoogleCloudDiscoveryengineV1betaSearchRequestQueryExpansionSpec": { + "description": "Specification to determine under which conditions query expansion should occur.", + "id": "GoogleCloudDiscoveryengineV1betaSearchRequestQueryExpansionSpec", "properties": { - "createTime": { - "description": "Operation create time.", - "format": "google-datetime", + "condition": { + "description": "The condition under which query expansion should occur. Default to Condition.DISABLED.", + "enum": [ + "CONDITION_UNSPECIFIED", + "DISABLED", + "AUTO" + ], + "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." + ], "type": "string" }, - "updateTime": { - "description": "Operation last update time. If the operation is done, this is also the finish time.", - "format": "google-datetime", - "type": "string" + "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" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1betaPurgeSuggestionDenyListEntriesResponse": { - "description": "Response message for CompletionService.PurgeSuggestionDenyListEntries method.", - "id": "GoogleCloudDiscoveryengineV1betaPurgeSuggestionDenyListEntriesResponse", + "GoogleCloudDiscoveryengineV1betaSearchRequestSearchAsYouTypeSpec": { + "description": "Specification for search as you type in search requests.", + "id": "GoogleCloudDiscoveryengineV1betaSearchRequestSearchAsYouTypeSpec", "properties": { - "errorSamples": { - "description": "A sample of errors encountered while processing the request.", - "items": { - "$ref": "GoogleRpcStatus" - }, - "type": "array" - }, - "purgeCount": { - "description": "Number of suggestion deny list entries purged.", - "format": "int64", + "condition": { + "description": "The condition under which search as you type should occur. Default to Condition.DISABLED.", + "enum": [ + "CONDITION_UNSPECIFIED", + "DISABLED", + "ENABLED" + ], + "enumDescriptions": [ + "Server behavior defaults to Condition.DISABLED.", + "Disables Search As You Type.", + "Enables Search As You Type." + ], "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1betaSchema": { - "description": "Defines the structure and layout of a type of document data.", - "id": "GoogleCloudDiscoveryengineV1betaSchema", + "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.", + "id": "GoogleCloudDiscoveryengineV1betaSearchRequestSessionSpec", "properties": { - "jsonSchema": { - "description": "The JSON representation of the schema.", + "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" }, - "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.", + "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.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaSearchRequestSpellCorrectionSpec": { + "description": "The specification for query spell correction.", + "id": "GoogleCloudDiscoveryengineV1betaSearchRequestSpellCorrectionSpec", + "properties": { + "mode": { + "description": "The mode under which spell correction replaces the original search query. Defaults to Mode.AUTO.", + "enum": [ + "MODE_UNSPECIFIED", + "SUGGESTION_ONLY", + "AUTO" + ], + "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." + ], "type": "string" - }, - "structSchema": { - "additionalProperties": { - "description": "Properties of the object.", - "type": "any" - }, - "description": "The structured representation of the schema.", - "type": "object" } }, "type": "object" @@ -16560,6 +18836,21 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1betaUserInfo": { + "description": "Information of an end user.", + "id": "GoogleCloudDiscoveryengineV1betaUserInfo", + "properties": { + "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" + }, + "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" + } + }, + "type": "object" + }, "GoogleLongrunningCancelOperationRequest": { "description": "The request message for Operations.CancelOperation.", "id": "GoogleLongrunningCancelOperationRequest", diff --git a/discovery/discoveryengine-v1beta.json b/discovery/discoveryengine-v1beta.json index 1da8493f4d..cd01c2f328 100644 --- a/discovery/discoveryengine-v1beta.json +++ b/discovery/discoveryengine-v1beta.json @@ -5822,6 +5822,166 @@ } } }, + "evaluations": { + "methods": { + "create": { + "description": "Creates a Evaluation. Upon creation, the evaluation will be automatically triggered and begin execution.", + "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/evaluations", + "httpMethod": "POST", + "id": "discoveryengine.projects.locations.evaluations.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The parent resource name, such as `projects/{project}/locations/{location}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta/{+parent}/evaluations", + "request": { + "$ref": "GoogleCloudDiscoveryengineV1betaEvaluation" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets a Evaluation.", + "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/evaluations/{evaluationsId}", + "httpMethod": "GET", + "id": "discoveryengine.projects.locations.evaluations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Full resource name of Evaluation, such as `projects/{project}/locations/{location}/evaluations/{evaluation}`. If the caller does not have permission to access the Evaluation, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested Evaluation does not exist, a NOT_FOUND error is returned.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/evaluations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta/{+name}", + "response": { + "$ref": "GoogleCloudDiscoveryengineV1betaEvaluation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Gets a list of Evaluations.", + "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/evaluations", + "httpMethod": "GET", + "id": "discoveryengine.projects.locations.evaluations.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "Maximum number of Evaluations to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A page token ListEvaluationsResponse.next_page_token, received from a previous EvaluationService.ListEvaluations call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to EvaluationService.ListEvaluations must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent location resource name, such as `projects/{project}/locations/{location}`. If the caller does not have permission to list Evaluations under this location, regardless of whether or not this location exists, a `PERMISSION_DENIED` error is returned.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta/{+parent}/evaluations", + "response": { + "$ref": "GoogleCloudDiscoveryengineV1betaListEvaluationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "listResults": { + "description": "Gets a list of results for a given a Evaluation.", + "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/evaluations/{evaluationsId}:listResults", + "httpMethod": "GET", + "id": "discoveryengine.projects.locations.evaluations.listResults", + "parameterOrder": [ + "evaluation" + ], + "parameters": { + "evaluation": { + "description": "Required. The evaluation resource name, such as `projects/{project}/locations/{location}/evaluations/{evaluation}`. If the caller does not have permission to list EvaluationResult under this evaluation, regardless of whether or not this evaluation set exists, a `PERMISSION_DENIED` error is returned.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/evaluations/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "Maximum number of EvaluationResult to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A page token ListEvaluationResultsResponse.next_page_token, received from a previous EvaluationService.ListEvaluationResults call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to EvaluationService.ListEvaluationResults must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned.", + "location": "query", + "type": "string" + } + }, + "path": "v1beta/{+evaluation}:listResults", + "response": { + "$ref": "GoogleCloudDiscoveryengineV1betaListEvaluationResultsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "operations": { + "methods": { + "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.", + "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/evaluations/{evaluationsId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "discoveryengine.projects.locations.evaluations.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/evaluations/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, "groundingConfigs": { "methods": { "check": { @@ -5956,433 +6116,1338 @@ } } }, - "userEvents": { + "sampleQuerySets": { "methods": { - "collect": { - "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.", - "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/userEvents:collect", - "httpMethod": "GET", - "id": "discoveryengine.projects.locations.userEvents.collect", + "create": { + "description": "Creates a SampleQuerySet", + "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/sampleQuerySets", + "httpMethod": "POST", + "id": "discoveryengine.projects.locations.sampleQuerySets.create", "parameterOrder": [ "parent" ], "parameters": { - "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.", - "format": "int64", - "location": "query", - "type": "string" - }, "parent": { - "description": "Required. The parent DataStore resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`.", + "description": "Required. The parent resource name, such as `projects/{project}/locations/{location}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "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 third-party requests.", + "sampleQuerySetId": { + "description": "Required. The ID to use for the SampleQuerySet, which will become the final component of the SampleQuerySet.name. If the caller does not have permission to create the SampleQuerySet, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. This field must be unique among all SampleQuerySets with the same parent. Otherwise, an `ALREADY_EXISTS` error is returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.", "location": "query", "type": "string" - }, - "userEvent": { - "description": "Required. URL encoded UserEvent proto with a length limit of 2,000,000 characters.", - "location": "query", + } + }, + "path": "v1beta/{+parent}/sampleQuerySets", + "request": { + "$ref": "GoogleCloudDiscoveryengineV1betaSampleQuerySet" + }, + "response": { + "$ref": "GoogleCloudDiscoveryengineV1betaSampleQuerySet" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a SampleQuerySet.", + "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/sampleQuerySets/{sampleQuerySetsId}", + "httpMethod": "DELETE", + "id": "discoveryengine.projects.locations.sampleQuerySets.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Full resource name of SampleQuerySet, such as `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`. If the caller does not have permission to delete the SampleQuerySet, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the SampleQuerySet to delete does not exist, a `NOT_FOUND` error is returned.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/sampleQuerySets/[^/]+$", + "required": true, "type": "string" } }, - "path": "v1beta/{+parent}/userEvents:collect", + "path": "v1beta/{+name}", "response": { - "$ref": "GoogleApiHttpBody" + "$ref": "GoogleProtobufEmpty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, - "write": { - "description": "Writes a single user event.", - "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/userEvents:write", - "httpMethod": "POST", - "id": "discoveryengine.projects.locations.userEvents.write", + "get": { + "description": "Gets a SampleQuerySet.", + "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/sampleQuerySets/{sampleQuerySetsId}", + "httpMethod": "GET", + "id": "discoveryengine.projects.locations.sampleQuerySets.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Full resource name of SampleQuerySet, such as `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`. If the caller does not have permission to access the SampleQuerySet, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested SampleQuerySet does not exist, a NOT_FOUND error is returned.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/sampleQuerySets/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta/{+name}", + "response": { + "$ref": "GoogleCloudDiscoveryengineV1betaSampleQuerySet" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Gets a list of SampleQuerySets.", + "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/sampleQuerySets", + "httpMethod": "GET", + "id": "discoveryengine.projects.locations.sampleQuerySets.list", "parameterOrder": [ "parent" ], "parameters": { + "pageSize": { + "description": "Maximum number of SampleQuerySets to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A page token ListSampleQuerySetsResponse.next_page_token, received from a previous SampleQuerySetService.ListSampleQuerySets call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SampleQuerySetService.ListSampleQuerySets must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned.", + "location": "query", + "type": "string" + }, "parent": { - "description": "Required. The parent resource name. If the write user event action is applied in DataStore level, the format is: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`. If the write user event action is applied in Location level, for example, the event with Document across multiple DataStore, the format is: `projects/{project}/locations/{location}`.", + "description": "Required. The parent location resource name, such as `projects/{project}/locations/{location}`. If the caller does not have permission to list SampleQuerySets under this location, regardless of whether or not this location exists, a `PERMISSION_DENIED` error is returned.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" + } + }, + "path": "v1beta/{+parent}/sampleQuerySets", + "response": { + "$ref": "GoogleCloudDiscoveryengineV1betaListSampleQuerySetsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates a SampleQuerySet.", + "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/sampleQuerySets/{sampleQuerySetsId}", + "httpMethod": "PATCH", + "id": "discoveryengine.projects.locations.sampleQuerySets.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Immutable. The full resource name of the SampleQuerySet, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/sampleQuerySets/[^/]+$", + "required": true, + "type": "string" }, - "writeAsync": { - "description": "If set to true, the user event is written asynchronously after validation, and the API responds without waiting for the write.", + "updateMask": { + "description": "Indicates which fields in the provided imported 'sample query set' to update. If not set, will by default update all fields.", + "format": "google-fieldmask", "location": "query", - "type": "boolean" + "type": "string" } }, - "path": "v1beta/{+parent}/userEvents:write", + "path": "v1beta/{+name}", "request": { - "$ref": "GoogleCloudDiscoveryengineV1betaUserEvent" + "$ref": "GoogleCloudDiscoveryengineV1betaSampleQuerySet" }, "response": { - "$ref": "GoogleCloudDiscoveryengineV1betaUserEvent" + "$ref": "GoogleCloudDiscoveryengineV1betaSampleQuerySet" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] } - } - } - } - }, - "operations": { - "methods": { - "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.", - "flatPath": "v1beta/projects/{projectsId}/operations/{operationsId}", - "httpMethod": "GET", - "id": "discoveryengine.projects.operations.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource.", - "location": "path", - "pattern": "^projects/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } }, - "path": "v1beta/{+name}", - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "list": { - "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", - "flatPath": "v1beta/projects/{projectsId}/operations", - "httpMethod": "GET", - "id": "discoveryengine.projects.operations.list", - "parameterOrder": [ - "name" - ], - "parameters": { - "filter": { - "description": "The standard list filter.", - "location": "query", - "type": "string" - }, - "name": { - "description": "The name of the operation's parent resource.", - "location": "path", - "pattern": "^projects/[^/]+$", - "required": true, - "type": "string" - }, - "pageSize": { - "description": "The standard list page size.", - "format": "int32", - "location": "query", - "type": "integer" + "resources": { + "operations": { + "methods": { + "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.", + "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/sampleQuerySets/{sampleQuerySetsId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "discoveryengine.projects.locations.sampleQuerySets.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/sampleQuerySets/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } }, - "pageToken": { - "description": "The standard list page token.", - "location": "query", - "type": "string" + "sampleQueries": { + "methods": { + "create": { + "description": "Creates a SampleQuery", + "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/sampleQuerySets/{sampleQuerySetsId}/sampleQueries", + "httpMethod": "POST", + "id": "discoveryengine.projects.locations.sampleQuerySets.sampleQueries.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The parent resource name, such as `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/sampleQuerySets/[^/]+$", + "required": true, + "type": "string" + }, + "sampleQueryId": { + "description": "Required. The ID to use for the SampleQuery, which will become the final component of the SampleQuery.name. If the caller does not have permission to create the SampleQuery, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. This field must be unique among all SampleQuerys with the same parent. Otherwise, an `ALREADY_EXISTS` error is returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.", + "location": "query", + "type": "string" + } + }, + "path": "v1beta/{+parent}/sampleQueries", + "request": { + "$ref": "GoogleCloudDiscoveryengineV1betaSampleQuery" + }, + "response": { + "$ref": "GoogleCloudDiscoveryengineV1betaSampleQuery" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a SampleQuery.", + "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/sampleQuerySets/{sampleQuerySetsId}/sampleQueries/{sampleQueriesId}", + "httpMethod": "DELETE", + "id": "discoveryengine.projects.locations.sampleQuerySets.sampleQueries.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Full resource name of SampleQuery, such as `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}/sampleQueries/{sampleQuery}`. If the caller does not have permission to delete the SampleQuery, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the SampleQuery to delete does not exist, a `NOT_FOUND` error is returned.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/sampleQuerySets/[^/]+/sampleQueries/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets a SampleQuery.", + "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/sampleQuerySets/{sampleQuerySetsId}/sampleQueries/{sampleQueriesId}", + "httpMethod": "GET", + "id": "discoveryengine.projects.locations.sampleQuerySets.sampleQueries.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Full resource name of SampleQuery, such as `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}/sampleQueries/{sampleQuery}`. If the caller does not have permission to access the SampleQuery, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested SampleQuery does not exist, a NOT_FOUND error is returned.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/sampleQuerySets/[^/]+/sampleQueries/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta/{+name}", + "response": { + "$ref": "GoogleCloudDiscoveryengineV1betaSampleQuery" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "import": { + "description": "Bulk import of multiple SampleQuerys. Sample queries that already exist may be deleted. Note: It is possible for a subset of the SampleQuerys to be successfully imported.", + "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/sampleQuerySets/{sampleQuerySetsId}/sampleQueries:import", + "httpMethod": "POST", + "id": "discoveryengine.projects.locations.sampleQuerySets.sampleQueries.import", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The parent sample query set resource name, such as `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`. If the caller does not have permission to list SampleQuerys under this sample query set, regardless of whether or not this sample query set exists, a `PERMISSION_DENIED` error is returned.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/sampleQuerySets/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta/{+parent}/sampleQueries:import", + "request": { + "$ref": "GoogleCloudDiscoveryengineV1betaImportSampleQueriesRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Gets a list of SampleQuerys.", + "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/sampleQuerySets/{sampleQuerySetsId}/sampleQueries", + "httpMethod": "GET", + "id": "discoveryengine.projects.locations.sampleQuerySets.sampleQueries.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "Maximum number of SampleQuerys to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A page token ListSampleQueriesResponse.next_page_token, received from a previous SampleQueryService.ListSampleQueries call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SampleQueryService.ListSampleQueries must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent sample query set resource name, such as `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`. If the caller does not have permission to list SampleQuerys under this sample query set, regardless of whether or not this sample query set exists, a `PERMISSION_DENIED` error is returned.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/sampleQuerySets/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta/{+parent}/sampleQueries", + "response": { + "$ref": "GoogleCloudDiscoveryengineV1betaListSampleQueriesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates a SampleQuery.", + "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/sampleQuerySets/{sampleQuerySetsId}/sampleQueries/{sampleQueriesId}", + "httpMethod": "PATCH", + "id": "discoveryengine.projects.locations.sampleQuerySets.sampleQueries.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Immutable. The full resource name of the sample query, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}/sampleQueries/{sampleQuery}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/sampleQuerySets/[^/]+/sampleQueries/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Indicates which fields in the provided imported 'simple query' to update. If not set, will by default update all fields.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1beta/{+name}", + "request": { + "$ref": "GoogleCloudDiscoveryengineV1betaSampleQuery" + }, + "response": { + "$ref": "GoogleCloudDiscoveryengineV1betaSampleQuery" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } } - }, - "path": "v1beta/{+name}/operations", - "response": { - "$ref": "GoogleLongrunningListOperationsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - } + } + }, + "userEvents": { + "methods": { + "collect": { + "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.", + "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/userEvents:collect", + "httpMethod": "GET", + "id": "discoveryengine.projects.locations.userEvents.collect", + "parameterOrder": [ + "parent" + ], + "parameters": { + "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.", + "format": "int64", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent DataStore resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "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 third-party requests.", + "location": "query", + "type": "string" + }, + "userEvent": { + "description": "Required. URL encoded UserEvent proto with a length limit of 2,000,000 characters.", + "location": "query", + "type": "string" + } + }, + "path": "v1beta/{+parent}/userEvents:collect", + "response": { + "$ref": "GoogleApiHttpBody" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "write": { + "description": "Writes a single user event.", + "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/userEvents:write", + "httpMethod": "POST", + "id": "discoveryengine.projects.locations.userEvents.write", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The parent resource name. If the write user event action is applied in DataStore level, the format is: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`. If the write user event action is applied in Location level, for example, the event with Document across multiple DataStore, the format is: `projects/{project}/locations/{location}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + }, + "writeAsync": { + "description": "If set to true, the user event is written asynchronously after validation, and the API responds without waiting for the write.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1beta/{+parent}/userEvents:write", + "request": { + "$ref": "GoogleCloudDiscoveryengineV1betaUserEvent" + }, + "response": { + "$ref": "GoogleCloudDiscoveryengineV1betaUserEvent" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, + "operations": { + "methods": { + "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.", + "flatPath": "v1beta/projects/{projectsId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "discoveryengine.projects.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^projects/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1beta/projects/{projectsId}/operations", + "httpMethod": "GET", + "id": "discoveryengine.projects.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^projects/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + } + }, + "path": "v1beta/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + } + }, + "revision": "20240715", + "rootUrl": "https://discoveryengine.googleapis.com/", + "schemas": { + "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.", + "id": "GoogleApiHttpBody", + "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" + }, + "extensions": { + "description": "Application specific response metadata. Must be set in the first response for streaming APIs.", + "items": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineLoggingErrorContext": { + "description": "A description of the context in which an error occurred.", + "id": "GoogleCloudDiscoveryengineLoggingErrorContext", + "properties": { + "httpRequest": { + "$ref": "GoogleCloudDiscoveryengineLoggingHttpRequestContext", + "description": "The HTTP request which was processed when the error was triggered." + }, + "reportLocation": { + "$ref": "GoogleCloudDiscoveryengineLoggingSourceLocation", + "description": "The location in the source code where the decision was made to report the error, usually the place where it was logged." + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineLoggingErrorLog": { + "description": "An error log which is reported to the Error Reporting system.", + "id": "GoogleCloudDiscoveryengineLoggingErrorLog", + "properties": { + "context": { + "$ref": "GoogleCloudDiscoveryengineLoggingErrorContext", + "description": "A description of the context in which the error occurred." + }, + "importPayload": { + "$ref": "GoogleCloudDiscoveryengineLoggingImportErrorContext", + "description": "The error payload that is populated on LRO import APIs." + }, + "message": { + "description": "A message describing the error.", + "type": "string" + }, + "requestPayload": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "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" + }, + "responsePayload": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "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" + }, + "serviceContext": { + "$ref": "GoogleCloudDiscoveryengineLoggingServiceContext", + "description": "The service context in which this error has occurred." + }, + "status": { + "$ref": "GoogleRpcStatus", + "description": "The RPC status associated with the error log." + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineLoggingHttpRequestContext": { + "description": "HTTP request data that is related to a reported error.", + "id": "GoogleCloudDiscoveryengineLoggingHttpRequestContext", + "properties": { + "responseStatusCode": { + "description": "The HTTP response status code for the request.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "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`", + "id": "GoogleCloudDiscoveryengineLoggingImportErrorContext", + "properties": { + "document": { + "description": "The detailed content which caused the error on importing a document.", + "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" + }, + "operation": { + "description": "The operation resource name of the LRO.", + "type": "string" + }, + "userEvent": { + "description": "The detailed content which caused the error on importing a user event.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineLoggingServiceContext": { + "description": "Describes a running service that sends errors.", + "id": "GoogleCloudDiscoveryengineLoggingServiceContext", + "properties": { + "service": { + "description": "An identifier of the service—for example, `discoveryengine.googleapis.com`.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineLoggingSourceLocation": { + "description": "Indicates a location in the source code of the service for which errors are reported.", + "id": "GoogleCloudDiscoveryengineLoggingSourceLocation", + "properties": { + "functionName": { + "description": "Human-readable name of a function or method—for example, `google.cloud.discoveryengine.v1alpha.RecommendationService.Recommend`.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1BatchCreateTargetSiteMetadata": { + "description": "Metadata related to the progress of the SiteSearchEngineService.BatchCreateTargetSites operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1BatchCreateTargetSiteMetadata", + "properties": { + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", + "type": "string" + }, + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1BatchCreateTargetSitesResponse": { + "description": "Response message for SiteSearchEngineService.BatchCreateTargetSites method.", + "id": "GoogleCloudDiscoveryengineV1BatchCreateTargetSitesResponse", + "properties": { + "targetSites": { + "description": "TargetSites created.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1TargetSite" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1Condition": { + "description": "Defines circumstances to be checked before allowing a behavior", + "id": "GoogleCloudDiscoveryengineV1Condition", + "properties": { + "activeTimeRange": { + "description": "Range of time(s) specifying when condition is active. Maximum of 10 time ranges.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1ConditionTimeRange" + }, + "type": "array" + }, + "queryTerms": { + "description": "Search only A list of terms to match the query on. Maximum of 10 query terms.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1ConditionQueryTerm" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1ConditionQueryTerm": { + "description": "Matcher for search request query", + "id": "GoogleCloudDiscoveryengineV1ConditionQueryTerm", + "properties": { + "fullMatch": { + "description": "Whether the search query needs to exactly match the query term.", + "type": "boolean" + }, + "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" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1ConditionTimeRange": { + "description": "Used for time-dependent conditions.", + "id": "GoogleCloudDiscoveryengineV1ConditionTimeRange", + "properties": { + "endTime": { + "description": "End of time range. Range is inclusive. Must be in the future.", + "format": "google-datetime", + "type": "string" + }, + "startTime": { + "description": "Start of time range. Range is inclusive.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "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`.", + "id": "GoogleCloudDiscoveryengineV1Control", + "properties": { + "associatedServingConfigIds": { + "description": "Output only. List of all ServingConfig ids this control is attached to. May take up to 10 minutes to update after changes.", + "items": { + "type": "string" + }, + "readOnly": true, + "type": "array" + }, + "boostAction": { + "$ref": "GoogleCloudDiscoveryengineV1ControlBoostAction", + "description": "Defines a boost-type control" + }, + "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.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1Condition" + }, + "type": "array" + }, + "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" + }, + "filterAction": { + "$ref": "GoogleCloudDiscoveryengineV1ControlFilterAction", + "description": "Defines a filter-type control Currently not supported by Recommendation" + }, + "name": { + "description": "Immutable. Fully qualified name `projects/*/locations/global/dataStore/*/controls/*`", + "type": "string" + }, + "redirectAction": { + "$ref": "GoogleCloudDiscoveryengineV1ControlRedirectAction", + "description": "Defines a redirect-type control." + }, + "solutionType": { + "description": "Required. Immutable. What solution the control belongs to. Must be compatible with vertical of resource. Otherwise an INVALID ARGUMENT error is thrown.", + "enum": [ + "SOLUTION_TYPE_UNSPECIFIED", + "SOLUTION_TYPE_RECOMMENDATION", + "SOLUTION_TYPE_SEARCH", + "SOLUTION_TYPE_CHAT", + "SOLUTION_TYPE_GENERATIVE_CHAT" + ], + "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." + ], + "type": "string" + }, + "synonymsAction": { + "$ref": "GoogleCloudDiscoveryengineV1ControlSynonymsAction", + "description": "Treats a group of terms as synonyms of one another." + }, + "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.", + "items": { + "enum": [ + "SEARCH_USE_CASE_UNSPECIFIED", + "SEARCH_USE_CASE_SEARCH", + "SEARCH_USE_CASE_BROWSE" + ], + "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." + ], + "type": "string" + }, + "type": "array" } - } - } - }, - "revision": "20240621", - "rootUrl": "https://discoveryengine.googleapis.com/", - "schemas": { - "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.", - "id": "GoogleApiHttpBody", + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1ControlBoostAction": { + "description": "Adjusts order of products in returned list.", + "id": "GoogleCloudDiscoveryengineV1ControlBoostAction", "properties": { - "contentType": { - "description": "The HTTP Content-Type header value specifying the content type of the body.", + "boost": { + "description": "Required. Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0 (No-op).", + "format": "float", + "type": "number" + }, + "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" }, - "data": { - "description": "The HTTP request/response body as raw binary.", - "format": "byte", + "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" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1ControlFilterAction": { + "description": "Specified which products may be included in results. Uses same filter as boost.", + "id": "GoogleCloudDiscoveryengineV1ControlFilterAction", + "properties": { + "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" }, - "extensions": { - "description": "Application specific response metadata. Must be set in the first response for streaming APIs.", + "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" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1ControlRedirectAction": { + "description": "Redirects a shopper to the provided URI.", + "id": "GoogleCloudDiscoveryengineV1ControlRedirectAction", + "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" + } + }, + "type": "object" + }, + "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\".", + "id": "GoogleCloudDiscoveryengineV1ControlSynonymsAction", + "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.", "items": { - "additionalProperties": { - "description": "Properties of the object. Contains field @type with type URL.", - "type": "any" - }, - "type": "object" + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1CreateDataStoreMetadata": { + "description": "Metadata related to the progress of the DataStoreService.CreateDataStore operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1CreateDataStoreMetadata", + "properties": { + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", + "type": "string" + }, + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1CreateEngineMetadata": { + "description": "Metadata related to the progress of the EngineService.CreateEngine operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1CreateEngineMetadata", + "properties": { + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", + "type": "string" + }, + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1CreateSchemaMetadata": { + "description": "Metadata for Create Schema LRO.", + "id": "GoogleCloudDiscoveryengineV1CreateSchemaMetadata", + "properties": { + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", + "type": "string" + }, + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1CreateTargetSiteMetadata": { + "description": "Metadata related to the progress of the SiteSearchEngineService.CreateTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1CreateTargetSiteMetadata", + "properties": { + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", + "type": "string" + }, + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1DataStore": { + "description": "DataStore captures global settings and configs at the DataStore level.", + "id": "GoogleCloudDiscoveryengineV1DataStore", + "properties": { + "contentConfig": { + "description": "Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT.", + "enum": [ + "CONTENT_CONFIG_UNSPECIFIED", + "NO_CONTENT", + "CONTENT_REQUIRED", + "PUBLIC_WEBSITE" + ], + "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." + ], + "type": "string" + }, + "createTime": { + "description": "Output only. Timestamp the DataStore was created at.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "defaultSchemaId": { + "description": "Output only. The id of the default Schema asscociated to this data store.", + "readOnly": true, + "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" + }, + "documentProcessingConfig": { + "$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfig", + "description": "Configuration for Document understanding and enrichment." + }, + "industryVertical": { + "description": "Immutable. The industry vertical that the data store registers.", + "enum": [ + "INDUSTRY_VERTICAL_UNSPECIFIED", + "GENERIC", + "MEDIA", + "HEALTHCARE_FHIR" + ], + "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." + ], + "type": "string" + }, + "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" + }, + "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.", + "items": { + "enum": [ + "SOLUTION_TYPE_UNSPECIFIED", + "SOLUTION_TYPE_RECOMMENDATION", + "SOLUTION_TYPE_SEARCH", + "SOLUTION_TYPE_CHAT", + "SOLUTION_TYPE_GENERATIVE_CHAT" + ], + "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." + ], + "type": "string" }, "type": "array" + }, + "startingSchema": { + "$ref": "GoogleCloudDiscoveryengineV1Schema", + "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)." } }, "type": "object" }, - "GoogleCloudDiscoveryengineLoggingErrorContext": { - "description": "A description of the context in which an error occurred.", - "id": "GoogleCloudDiscoveryengineLoggingErrorContext", + "GoogleCloudDiscoveryengineV1DeleteDataStoreMetadata": { + "description": "Metadata related to the progress of the DataStoreService.DeleteDataStore operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1DeleteDataStoreMetadata", "properties": { - "httpRequest": { - "$ref": "GoogleCloudDiscoveryengineLoggingHttpRequestContext", - "description": "The HTTP request which was processed when the error was triggered." + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", + "type": "string" }, - "reportLocation": { - "$ref": "GoogleCloudDiscoveryengineLoggingSourceLocation", - "description": "The location in the source code where the decision was made to report the error, usually the place where it was logged." + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", + "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineLoggingErrorLog": { - "description": "An error log which is reported to the Error Reporting system.", - "id": "GoogleCloudDiscoveryengineLoggingErrorLog", + "GoogleCloudDiscoveryengineV1DeleteEngineMetadata": { + "description": "Metadata related to the progress of the EngineService.DeleteEngine operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1DeleteEngineMetadata", "properties": { - "context": { - "$ref": "GoogleCloudDiscoveryengineLoggingErrorContext", - "description": "A description of the context in which the error occurred." - }, - "importPayload": { - "$ref": "GoogleCloudDiscoveryengineLoggingImportErrorContext", - "description": "The error payload that is populated on LRO import APIs." - }, - "message": { - "description": "A message describing the error.", + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", "type": "string" }, - "requestPayload": { - "additionalProperties": { - "description": "Properties of the object.", - "type": "any" - }, - "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" - }, - "responsePayload": { - "additionalProperties": { - "description": "Properties of the object.", - "type": "any" - }, - "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" - }, - "serviceContext": { - "$ref": "GoogleCloudDiscoveryengineLoggingServiceContext", - "description": "The service context in which this error has occurred." - }, - "status": { - "$ref": "GoogleRpcStatus", - "description": "The RPC status associated with the error log." + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", + "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineLoggingHttpRequestContext": { - "description": "HTTP request data that is related to a reported error.", - "id": "GoogleCloudDiscoveryengineLoggingHttpRequestContext", + "GoogleCloudDiscoveryengineV1DeleteSchemaMetadata": { + "description": "Metadata for DeleteSchema LRO.", + "id": "GoogleCloudDiscoveryengineV1DeleteSchemaMetadata", "properties": { - "responseStatusCode": { - "description": "The HTTP response status code for the request.", - "format": "int32", - "type": "integer" + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", + "type": "string" + }, + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", + "type": "string" } }, "type": "object" }, - "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`", - "id": "GoogleCloudDiscoveryengineLoggingImportErrorContext", + "GoogleCloudDiscoveryengineV1DeleteTargetSiteMetadata": { + "description": "Metadata related to the progress of the SiteSearchEngineService.DeleteTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1DeleteTargetSiteMetadata", "properties": { - "document": { - "description": "The detailed content which caused the error on importing a document.", - "type": "string" - }, - "gcsPath": { - "description": "Google Cloud Storage file path of the import source. Can be set for batch operation error.", + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", "type": "string" }, - "lineNumber": { - "description": "Line number of the content in file. Should be empty for permission or batch operation error.", + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", "type": "string" - }, - "operation": { - "description": "The operation resource name of the LRO.", + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1DisableAdvancedSiteSearchMetadata": { + "description": "Metadata related to the progress of the SiteSearchEngineService.DisableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1DisableAdvancedSiteSearchMetadata", + "properties": { + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", "type": "string" }, - "userEvent": { - "description": "The detailed content which caused the error on importing a user event.", + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineLoggingServiceContext": { - "description": "Describes a running service that sends errors.", - "id": "GoogleCloudDiscoveryengineLoggingServiceContext", + "GoogleCloudDiscoveryengineV1DisableAdvancedSiteSearchResponse": { + "description": "Response message for SiteSearchEngineService.DisableAdvancedSiteSearch method.", + "id": "GoogleCloudDiscoveryengineV1DisableAdvancedSiteSearchResponse", + "properties": {}, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1DocumentProcessingConfig": { + "description": "A singleton resource of DataStore. It's empty when DataStore is created, which defaults to digital parser. The first call to DataStoreService.UpdateDocumentProcessingConfig method will initialize the config.", + "id": "GoogleCloudDiscoveryengineV1DocumentProcessingConfig", "properties": { - "service": { - "description": "An identifier of the service—for example, `discoveryengine.googleapis.com`.", + "chunkingConfig": { + "$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfig", + "description": "Whether chunking mode is enabled." + }, + "defaultParsingConfig": { + "$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig", + "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." + }, + "name": { + "description": "The full resource name of the Document Processing Config. Format: `projects/*/locations/*/collections/*/dataStores/*/documentProcessingConfig`.", "type": "string" + }, + "parsingConfigOverrides": { + "additionalProperties": { + "$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig" + }, + "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.", + "type": "object" } }, "type": "object" }, - "GoogleCloudDiscoveryengineLoggingSourceLocation": { - "description": "Indicates a location in the source code of the service for which errors are reported.", - "id": "GoogleCloudDiscoveryengineLoggingSourceLocation", + "GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfig": { + "description": "Configuration for chunking config.", + "id": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfig", "properties": { - "functionName": { - "description": "Human-readable name of a function or method—for example, `google.cloud.discoveryengine.v1alpha.RecommendationService.Recommend`.", - "type": "string" + "layoutBasedChunkingConfig": { + "$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig", + "description": "Configuration for the layout based chunking." } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1BatchCreateTargetSiteMetadata": { - "description": "Metadata related to the progress of the SiteSearchEngineService.BatchCreateTargetSites operation. This will be returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1BatchCreateTargetSiteMetadata", + "GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig": { + "description": "Configuration for the layout based chunking.", + "id": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig", "properties": { - "createTime": { - "description": "Operation create time.", - "format": "google-datetime", - "type": "string" + "chunkSize": { + "description": "The token size limit for each chunk. Supported values: 100-500 (inclusive). Default value: 500.", + "format": "int32", + "type": "integer" }, - "updateTime": { - "description": "Operation last update time. If the operation is done, this is also the finish time.", - "format": "google-datetime", - "type": "string" + "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" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1BatchCreateTargetSitesResponse": { - "description": "Response message for SiteSearchEngineService.BatchCreateTargetSites method.", - "id": "GoogleCloudDiscoveryengineV1BatchCreateTargetSitesResponse", + "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig": { + "description": "Related configurations applied to a specific type of document parser.", + "id": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig", "properties": { - "targetSites": { - "description": "TargetSites created.", - "items": { - "$ref": "GoogleCloudDiscoveryengineV1TargetSite" - }, - "type": "array" + "digitalParsingConfig": { + "$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigDigitalParsingConfig", + "description": "Configurations applied to digital parser." + }, + "layoutParsingConfig": { + "$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigLayoutParsingConfig", + "description": "Configurations applied to layout parser." + }, + "ocrParsingConfig": { + "$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigOcrParsingConfig", + "description": "Configurations applied to OCR parser. Currently it only applies to PDFs." } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1Condition": { - "description": "Defines circumstances to be checked before allowing a behavior", - "id": "GoogleCloudDiscoveryengineV1Condition", + "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigDigitalParsingConfig": { + "description": "The digital parsing configurations for documents.", + "id": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigDigitalParsingConfig", + "properties": {}, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigLayoutParsingConfig": { + "description": "The layout parsing configurations for documents.", + "id": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigLayoutParsingConfig", + "properties": {}, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigOcrParsingConfig": { + "description": "The OCR parsing configurations for documents.", + "id": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigOcrParsingConfig", "properties": { - "activeTimeRange": { - "description": "Range of time(s) specifying when condition is active. Maximum of 10 time ranges.", - "items": { - "$ref": "GoogleCloudDiscoveryengineV1ConditionTimeRange" - }, - "type": "array" - }, - "queryTerms": { - "description": "Search only A list of terms to match the query on. Maximum of 10 query terms.", + "enhancedDocumentElements": { + "deprecated": true, + "description": "[DEPRECATED] This field is deprecated. To use the additional enhanced document elements processing, please switch to `layout_parsing_config`.", "items": { - "$ref": "GoogleCloudDiscoveryengineV1ConditionQueryTerm" + "type": "string" }, "type": "array" - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1ConditionQueryTerm": { - "description": "Matcher for search request query", - "id": "GoogleCloudDiscoveryengineV1ConditionQueryTerm", - "properties": { - "fullMatch": { - "description": "Whether the search query needs to exactly match the query term.", - "type": "boolean" }, - "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" + "useNativeText": { + "description": "If true, will use native text instead of OCR text on pages containing native text.", + "type": "boolean" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1ConditionTimeRange": { - "description": "Used for time-dependent conditions.", - "id": "GoogleCloudDiscoveryengineV1ConditionTimeRange", + "GoogleCloudDiscoveryengineV1EnableAdvancedSiteSearchMetadata": { + "description": "Metadata related to the progress of the SiteSearchEngineService.EnableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1EnableAdvancedSiteSearchMetadata", "properties": { - "endTime": { - "description": "End of time range. Range is inclusive. Must be in the future.", + "createTime": { + "description": "Operation create time.", "format": "google-datetime", "type": "string" }, - "startTime": { - "description": "Start of time range. Range is inclusive.", + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", "format": "google-datetime", "type": "string" } }, "type": "object" }, - "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`.", - "id": "GoogleCloudDiscoveryengineV1Control", + "GoogleCloudDiscoveryengineV1EnableAdvancedSiteSearchResponse": { + "description": "Response message for SiteSearchEngineService.EnableAdvancedSiteSearch method.", + "id": "GoogleCloudDiscoveryengineV1EnableAdvancedSiteSearchResponse", + "properties": {}, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1Engine": { + "description": "Metadata that describes the training and serving parameters of an Engine.", + "id": "GoogleCloudDiscoveryengineV1Engine", "properties": { - "associatedServingConfigIds": { - "description": "Output only. List of all ServingConfig ids this control is attached to. May take up to 10 minutes to update after changes.", - "items": { - "type": "string" - }, - "readOnly": true, - "type": "array" + "chatEngineConfig": { + "$ref": "GoogleCloudDiscoveryengineV1EngineChatEngineConfig", + "description": "Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT." }, - "boostAction": { - "$ref": "GoogleCloudDiscoveryengineV1ControlBoostAction", - "description": "Defines a boost-type control" + "chatEngineMetadata": { + "$ref": "GoogleCloudDiscoveryengineV1EngineChatEngineMetadata", + "description": "Output only. Additional information of the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.", + "readOnly": true }, - "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.", + "commonConfig": { + "$ref": "GoogleCloudDiscoveryengineV1EngineCommonConfig", + "description": "Common config spec that specifies the metadata of the engine." + }, + "createTime": { + "description": "Output only. Timestamp the Recommendation Engine was created at.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "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.", "items": { - "$ref": "GoogleCloudDiscoveryengineV1Condition" + "type": "string" }, "type": "array" }, "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.", + "description": "Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters.", "type": "string" }, - "filterAction": { - "$ref": "GoogleCloudDiscoveryengineV1ControlFilterAction", - "description": "Defines a filter-type control Currently not supported by Recommendation" + "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.", + "enum": [ + "INDUSTRY_VERTICAL_UNSPECIFIED", + "GENERIC", + "MEDIA", + "HEALTHCARE_FHIR" + ], + "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." + ], + "type": "string" }, "name": { - "description": "Immutable. Fully qualified name `projects/*/locations/global/dataStore/*/controls/*`", + "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_number}/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" }, - "redirectAction": { - "$ref": "GoogleCloudDiscoveryengineV1ControlRedirectAction", - "description": "Defines a redirect-type control." + "searchEngineConfig": { + "$ref": "GoogleCloudDiscoveryengineV1EngineSearchEngineConfig", + "description": "Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH." }, "solutionType": { - "description": "Required. Immutable. What solution the control belongs to. Must be compatible with vertical of resource. Otherwise an INVALID ARGUMENT error is thrown.", + "description": "Required. The solutions of the engine.", "enum": [ "SOLUTION_TYPE_UNSPECIFIED", "SOLUTION_TYPE_RECOMMENDATION", @@ -6399,93 +7464,220 @@ ], "type": "string" }, - "synonymsAction": { - "$ref": "GoogleCloudDiscoveryengineV1ControlSynonymsAction", - "description": "Treats a group of terms as synonyms of one another." + "updateTime": { + "description": "Output only. Timestamp the Recommendation Engine was last updated.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1EngineChatEngineConfig": { + "description": "Configurations for a Chat Engine.", + "id": "GoogleCloudDiscoveryengineV1EngineChatEngineConfig", + "properties": { + "agentCreationConfig": { + "$ref": "GoogleCloudDiscoveryengineV1EngineChatEngineConfigAgentCreationConfig", + "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." }, - "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.", + "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" + } + }, + "type": "object" + }, + "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.", + "id": "GoogleCloudDiscoveryengineV1EngineChatEngineConfigAgentCreationConfig", + "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" + }, + "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" + }, + "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" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1EngineChatEngineMetadata": { + "description": "Additional information of a Chat Engine. Fields in this message are output only.", + "id": "GoogleCloudDiscoveryengineV1EngineChatEngineMetadata", + "properties": { + "dialogflowAgent": { + "description": "The resource name of a Dialogflow agent, that this Chat Engine refers to. Format: `projects//locations//agents/`.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1EngineCommonConfig": { + "description": "Common configurations for an Engine.", + "id": "GoogleCloudDiscoveryengineV1EngineCommonConfig", + "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" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1EngineSearchEngineConfig": { + "description": "Configurations for a Search Engine.", + "id": "GoogleCloudDiscoveryengineV1EngineSearchEngineConfig", + "properties": { + "searchAddOns": { + "description": "The add-on that this search engine enables.", "items": { "enum": [ - "SEARCH_USE_CASE_UNSPECIFIED", - "SEARCH_USE_CASE_SEARCH", - "SEARCH_USE_CASE_BROWSE" + "SEARCH_ADD_ON_UNSPECIFIED", + "SEARCH_ADD_ON_LLM" ], "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." + "Default value when the enum is unspecified. This is invalid to use.", + "Large language model add-on." ], "type": "string" }, "type": "array" + }, + "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.", + "enum": [ + "SEARCH_TIER_UNSPECIFIED", + "SEARCH_TIER_STANDARD", + "SEARCH_TIER_ENTERPRISE" + ], + "enumDescriptions": [ + "Default value when the enum is unspecified. This is invalid to use.", + "Standard tier.", + "Enterprise tier." + ], + "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1ControlBoostAction": { - "description": "Adjusts order of products in returned list.", - "id": "GoogleCloudDiscoveryengineV1ControlBoostAction", + "GoogleCloudDiscoveryengineV1ImportCompletionSuggestionsMetadata": { + "description": "Metadata related to the progress of the ImportCompletionSuggestions operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1ImportCompletionSuggestionsMetadata", "properties": { - "boost": { - "description": "Required. Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0 (No-op).", - "format": "float", - "type": "number" + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", + "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", + "failureCount": { + "description": "Count of CompletionSuggestions that failed to be imported.", + "format": "int64", "type": "string" }, - "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.", + "successCount": { + "description": "Count of CompletionSuggestions successfully imported.", + "format": "int64", + "type": "string" + }, + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1ControlFilterAction": { - "description": "Specified which products may be included in results. Uses same filter as boost.", - "id": "GoogleCloudDiscoveryengineV1ControlFilterAction", + "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.", + "id": "GoogleCloudDiscoveryengineV1ImportCompletionSuggestionsResponse", + "properties": { + "errorConfig": { + "$ref": "GoogleCloudDiscoveryengineV1ImportErrorConfig", + "description": "The desired location of errors incurred during the Import." + }, + "errorSamples": { + "description": "A sample of errors encountered while processing the request.", + "items": { + "$ref": "GoogleRpcStatus" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1ImportDocumentsMetadata": { + "description": "Metadata related to the progress of the ImportDocuments operation. This is returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1ImportDocumentsMetadata", "properties": { - "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", + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", "type": "string" }, - "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.", + "failureCount": { + "description": "Count of entries that encountered errors while processing.", + "format": "int64", + "type": "string" + }, + "successCount": { + "description": "Count of entries that were processed successfully.", + "format": "int64", + "type": "string" + }, + "totalCount": { + "description": "Total count of entries that were processed.", + "format": "int64", + "type": "string" + }, + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1ControlRedirectAction": { - "description": "Redirects a shopper to the provided URI.", - "id": "GoogleCloudDiscoveryengineV1ControlRedirectAction", + "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.", + "id": "GoogleCloudDiscoveryengineV1ImportDocumentsResponse", "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" + "errorConfig": { + "$ref": "GoogleCloudDiscoveryengineV1ImportErrorConfig", + "description": "Echoes the destination for the complete errors in the request if set." + }, + "errorSamples": { + "description": "A sample of errors encountered while processing the request.", + "items": { + "$ref": "GoogleRpcStatus" + }, + "type": "array" } }, "type": "object" }, - "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\".", - "id": "GoogleCloudDiscoveryengineV1ControlSynonymsAction", + "GoogleCloudDiscoveryengineV1ImportErrorConfig": { + "description": "Configuration of destination for Import related errors.", + "id": "GoogleCloudDiscoveryengineV1ImportErrorConfig", "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.", - "items": { - "type": "string" - }, - "type": "array" + "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" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1CreateDataStoreMetadata": { - "description": "Metadata related to the progress of the DataStoreService.CreateDataStore operation. This will be returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1CreateDataStoreMetadata", + "GoogleCloudDiscoveryengineV1ImportSuggestionDenyListEntriesMetadata": { + "description": "Metadata related to the progress of the ImportSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1ImportSuggestionDenyListEntriesMetadata", "properties": { "createTime": { "description": "Operation create time.", @@ -6500,32 +7692,49 @@ }, "type": "object" }, - "GoogleCloudDiscoveryengineV1CreateEngineMetadata": { - "description": "Metadata related to the progress of the EngineService.CreateEngine operation. This will be returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1CreateEngineMetadata", + "GoogleCloudDiscoveryengineV1ImportSuggestionDenyListEntriesResponse": { + "description": "Response message for CompletionService.ImportSuggestionDenyListEntries method.", + "id": "GoogleCloudDiscoveryengineV1ImportSuggestionDenyListEntriesResponse", "properties": { - "createTime": { - "description": "Operation create time.", - "format": "google-datetime", + "errorSamples": { + "description": "A sample of errors encountered while processing the request.", + "items": { + "$ref": "GoogleRpcStatus" + }, + "type": "array" + }, + "failedEntriesCount": { + "description": "Count of deny list entries that failed to be imported.", + "format": "int64", "type": "string" }, - "updateTime": { - "description": "Operation last update time. If the operation is done, this is also the finish time.", - "format": "google-datetime", + "importedEntriesCount": { + "description": "Count of deny list entries successfully imported.", + "format": "int64", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1CreateSchemaMetadata": { - "description": "Metadata for Create Schema LRO.", - "id": "GoogleCloudDiscoveryengineV1CreateSchemaMetadata", + "GoogleCloudDiscoveryengineV1ImportUserEventsMetadata": { + "description": "Metadata related to the progress of the Import operation. This is returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1ImportUserEventsMetadata", "properties": { "createTime": { "description": "Operation create time.", "format": "google-datetime", "type": "string" }, + "failureCount": { + "description": "Count of entries that encountered errors while processing.", + "format": "int64", + "type": "string" + }, + "successCount": { + "description": "Count of entries that were processed successfully.", + "format": "int64", + "type": "string" + }, "updateTime": { "description": "Operation last update time. If the operation is done, this is also the finish time.", "format": "google-datetime", @@ -6534,113 +7743,116 @@ }, "type": "object" }, - "GoogleCloudDiscoveryengineV1CreateTargetSiteMetadata": { - "description": "Metadata related to the progress of the SiteSearchEngineService.CreateTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1CreateTargetSiteMetadata", + "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.", + "id": "GoogleCloudDiscoveryengineV1ImportUserEventsResponse", "properties": { - "createTime": { - "description": "Operation create time.", - "format": "google-datetime", + "errorConfig": { + "$ref": "GoogleCloudDiscoveryengineV1ImportErrorConfig", + "description": "Echoes the destination for the complete errors if this field was set in the request." + }, + "errorSamples": { + "description": "A sample of errors encountered while processing the request.", + "items": { + "$ref": "GoogleRpcStatus" + }, + "type": "array" + }, + "joinedEventsCount": { + "description": "Count of user events imported with complete existing Documents.", + "format": "int64", "type": "string" }, - "updateTime": { - "description": "Operation last update time. If the operation is done, this is also the finish time.", - "format": "google-datetime", + "unjoinedEventsCount": { + "description": "Count of user events imported, but with Document information not found in the existing Branch.", + "format": "int64", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1DataStore": { - "description": "DataStore captures global settings and configs at the DataStore level.", - "id": "GoogleCloudDiscoveryengineV1DataStore", + "GoogleCloudDiscoveryengineV1Project": { + "description": "Metadata and configurations for a Google Cloud project in the service.", + "id": "GoogleCloudDiscoveryengineV1Project", "properties": { - "contentConfig": { - "description": "Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT.", - "enum": [ - "CONTENT_CONFIG_UNSPECIFIED", - "NO_CONTENT", - "CONTENT_REQUIRED", - "PUBLIC_WEBSITE" - ], - "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." - ], + "createTime": { + "description": "Output only. The timestamp when this project is created.", + "format": "google-datetime", + "readOnly": true, "type": "string" }, - "createTime": { - "description": "Output only. Timestamp the DataStore was created at.", + "name": { + "description": "Output only. Full resource name of the project, for example `projects/{project_number}`. 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" + }, + "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.", "format": "google-datetime", "readOnly": true, "type": "string" }, - "defaultSchemaId": { - "description": "Output only. The id of the default Schema asscociated to this data store.", + "serviceTermsMap": { + "additionalProperties": { + "$ref": "GoogleCloudDiscoveryengineV1ProjectServiceTerms" + }, + "description": "Output only. A map of terms of services. The key is the `id` of ServiceTerms.", "readOnly": true, + "type": "object" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1ProjectServiceTerms": { + "description": "Metadata about the terms of service.", + "id": "GoogleCloudDiscoveryengineV1ProjectServiceTerms", + "properties": { + "acceptTime": { + "description": "The last time when the project agreed to the terms of service.", + "format": "google-datetime", "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.", + "declineTime": { + "description": "The last time when the project declined or revoked the agreement to terms of service.", + "format": "google-datetime", "type": "string" }, - "documentProcessingConfig": { - "$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfig", - "description": "Configuration for Document understanding and enrichment." + "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" }, - "industryVertical": { - "description": "Immutable. The industry vertical that the data store registers.", + "state": { + "description": "Whether the project has accepted/rejected the service terms or it is still pending.", "enum": [ - "INDUSTRY_VERTICAL_UNSPECIFIED", - "GENERIC", - "MEDIA", - "HEALTHCARE_FHIR" + "STATE_UNSPECIFIED", + "TERMS_ACCEPTED", + "TERMS_PENDING", + "TERMS_DECLINED" ], "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." + "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." ], "type": "string" }, - "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.", + "version": { + "description": "The version string of the terms of service. For acceptable values, see the comments for id above.", "type": "string" - }, - "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.", - "items": { - "enum": [ - "SOLUTION_TYPE_UNSPECIFIED", - "SOLUTION_TYPE_RECOMMENDATION", - "SOLUTION_TYPE_SEARCH", - "SOLUTION_TYPE_CHAT", - "SOLUTION_TYPE_GENERATIVE_CHAT" - ], - "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." - ], - "type": "string" - }, - "type": "array" - }, - "startingSchema": { - "$ref": "GoogleCloudDiscoveryengineV1Schema", - "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)." } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1DeleteDataStoreMetadata": { - "description": "Metadata related to the progress of the DataStoreService.DeleteDataStore operation. This will be returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1DeleteDataStoreMetadata", + "GoogleCloudDiscoveryengineV1ProvisionProjectMetadata": { + "description": "Metadata associated with a project provision operation.", + "id": "GoogleCloudDiscoveryengineV1ProvisionProjectMetadata", + "properties": {}, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1PurgeCompletionSuggestionsMetadata": { + "description": "Metadata related to the progress of the PurgeCompletionSuggestions operation. This is returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1PurgeCompletionSuggestionsMetadata", "properties": { "createTime": { "description": "Operation create time.", @@ -6655,32 +7867,48 @@ }, "type": "object" }, - "GoogleCloudDiscoveryengineV1DeleteEngineMetadata": { - "description": "Metadata related to the progress of the EngineService.DeleteEngine operation. This will be returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1DeleteEngineMetadata", + "GoogleCloudDiscoveryengineV1PurgeCompletionSuggestionsResponse": { + "description": "Response message for CompletionService.PurgeCompletionSuggestions method.", + "id": "GoogleCloudDiscoveryengineV1PurgeCompletionSuggestionsResponse", "properties": { - "createTime": { - "description": "Operation create time.", - "format": "google-datetime", - "type": "string" + "errorSamples": { + "description": "A sample of errors encountered while processing the request.", + "items": { + "$ref": "GoogleRpcStatus" + }, + "type": "array" }, - "updateTime": { - "description": "Operation last update time. If the operation is done, this is also the finish time.", - "format": "google-datetime", - "type": "string" + "purgeSucceeded": { + "description": "Whether the completion suggestions were successfully purged.", + "type": "boolean" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1DeleteSchemaMetadata": { - "description": "Metadata for DeleteSchema LRO.", - "id": "GoogleCloudDiscoveryengineV1DeleteSchemaMetadata", + "GoogleCloudDiscoveryengineV1PurgeDocumentsMetadata": { + "description": "Metadata related to the progress of the PurgeDocuments operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1PurgeDocumentsMetadata", "properties": { "createTime": { "description": "Operation create time.", "format": "google-datetime", "type": "string" }, + "failureCount": { + "description": "Count of entries that encountered errors while processing.", + "format": "int64", + "type": "string" + }, + "ignoredCount": { + "description": "Count of entries that were ignored as entries were not found.", + "format": "int64", + "type": "string" + }, + "successCount": { + "description": "Count of entries that were deleted successfully.", + "format": "int64", + "type": "string" + }, "updateTime": { "description": "Operation last update time. If the operation is done, this is also the finish time.", "format": "google-datetime", @@ -6689,26 +7917,28 @@ }, "type": "object" }, - "GoogleCloudDiscoveryengineV1DeleteTargetSiteMetadata": { - "description": "Metadata related to the progress of the SiteSearchEngineService.DeleteTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1DeleteTargetSiteMetadata", + "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.", + "id": "GoogleCloudDiscoveryengineV1PurgeDocumentsResponse", "properties": { - "createTime": { - "description": "Operation create time.", - "format": "google-datetime", + "purgeCount": { + "description": "The total count of documents purged as a result of the operation.", + "format": "int64", "type": "string" }, - "updateTime": { - "description": "Operation last update time. If the operation is done, this is also the finish time.", - "format": "google-datetime", - "type": "string" + "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.", + "items": { + "type": "string" + }, + "type": "array" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1DisableAdvancedSiteSearchMetadata": { - "description": "Metadata related to the progress of the SiteSearchEngineService.DisableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1DisableAdvancedSiteSearchMetadata", + "GoogleCloudDiscoveryengineV1PurgeSuggestionDenyListEntriesMetadata": { + "description": "Metadata related to the progress of the PurgeSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1PurgeSuggestionDenyListEntriesMetadata", "properties": { "createTime": { "description": "Operation create time.", @@ -6723,118 +7953,198 @@ }, "type": "object" }, - "GoogleCloudDiscoveryengineV1DisableAdvancedSiteSearchResponse": { - "description": "Response message for SiteSearchEngineService.DisableAdvancedSiteSearch method.", - "id": "GoogleCloudDiscoveryengineV1DisableAdvancedSiteSearchResponse", - "properties": {}, + "GoogleCloudDiscoveryengineV1PurgeSuggestionDenyListEntriesResponse": { + "description": "Response message for CompletionService.PurgeSuggestionDenyListEntries method.", + "id": "GoogleCloudDiscoveryengineV1PurgeSuggestionDenyListEntriesResponse", + "properties": { + "errorSamples": { + "description": "A sample of errors encountered while processing the request.", + "items": { + "$ref": "GoogleRpcStatus" + }, + "type": "array" + }, + "purgeCount": { + "description": "Number of suggestion deny list entries purged.", + "format": "int64", + "type": "string" + } + }, "type": "object" }, - "GoogleCloudDiscoveryengineV1DocumentProcessingConfig": { - "description": "A singleton resource of DataStore. It's empty when DataStore is created, which defaults to digital parser. The first call to DataStoreService.UpdateDocumentProcessingConfig method will initialize the config.", - "id": "GoogleCloudDiscoveryengineV1DocumentProcessingConfig", + "GoogleCloudDiscoveryengineV1Schema": { + "description": "Defines the structure and layout of a type of document data.", + "id": "GoogleCloudDiscoveryengineV1Schema", "properties": { - "chunkingConfig": { - "$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfig", - "description": "Whether chunking mode is enabled." - }, - "defaultParsingConfig": { - "$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig", - "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." + "jsonSchema": { + "description": "The JSON representation of the schema.", + "type": "string" }, "name": { - "description": "The full resource name of the Document Processing Config. Format: `projects/*/locations/*/collections/*/dataStores/*/documentProcessingConfig`.", + "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" }, - "parsingConfigOverrides": { + "structSchema": { "additionalProperties": { - "$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig" + "description": "Properties of the object.", + "type": "any" }, - "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 or layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and or layout parsing are supported.", + "description": "The structured representation of the schema.", "type": "object" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfig": { - "description": "Configuration for chunking config.", - "id": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfig", - "properties": { - "layoutBasedChunkingConfig": { - "$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig", - "description": "Configuration for the layout based chunking." - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig": { - "description": "Configuration for the layout based chunking.", - "id": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig", + "GoogleCloudDiscoveryengineV1SiteVerificationInfo": { + "description": "Verification information for target sites in advanced site search.", + "id": "GoogleCloudDiscoveryengineV1SiteVerificationInfo", "properties": { - "chunkSize": { - "description": "The token size limit for each chunk. Supported values: 100-500 (inclusive). Default value: 500.", - "format": "int32", - "type": "integer" + "siteVerificationState": { + "description": "Site verification state indicating the ownership and validity.", + "enum": [ + "SITE_VERIFICATION_STATE_UNSPECIFIED", + "VERIFIED", + "UNVERIFIED", + "EXEMPTED" + ], + "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." + ], + "type": "string" }, - "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" + "verifyTime": { + "description": "Latest site verification time.", + "format": "google-datetime", + "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig": { - "description": "Related configurations applied to a specific type of document parser.", - "id": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig", + "GoogleCloudDiscoveryengineV1TargetSite": { + "description": "A target site for the SiteSearchEngine.", + "id": "GoogleCloudDiscoveryengineV1TargetSite", "properties": { - "digitalParsingConfig": { - "$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigDigitalParsingConfig", - "description": "Configurations applied to digital parser." + "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" }, - "layoutParsingConfig": { - "$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigLayoutParsingConfig", - "description": "Configurations applied to layout parser." + "failureReason": { + "$ref": "GoogleCloudDiscoveryengineV1TargetSiteFailureReason", + "description": "Output only. Failure reason.", + "readOnly": true }, - "ocrParsingConfig": { - "$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigOcrParsingConfig", - "description": "Configurations applied to OCR parser. Currently it only applies to PDFs." + "generatedUriPattern": { + "description": "Output only. This is system-generated based on the provided_uri_pattern.", + "readOnly": true, + "type": "string" + }, + "indexingStatus": { + "description": "Output only. Indexing status.", + "enum": [ + "INDEXING_STATUS_UNSPECIFIED", + "PENDING", + "FAILED", + "SUCCEEDED", + "DELETING" + ], + "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." + ], + "readOnly": true, + "type": "string" + }, + "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" + }, + "rootDomainUri": { + "description": "Output only. Root domain of the provided_uri_pattern.", + "readOnly": true, + "type": "string" + }, + "siteVerificationInfo": { + "$ref": "GoogleCloudDiscoveryengineV1SiteVerificationInfo", + "description": "Output only. Site ownership and validity verification status.", + "readOnly": true + }, + "type": { + "description": "The type of the target site, e.g., whether the site is to be included or excluded.", + "enum": [ + "TYPE_UNSPECIFIED", + "INCLUDE", + "EXCLUDE" + ], + "enumDescriptions": [ + "This value is unused. In this case, server behavior defaults to Type.INCLUDE.", + "Include the target site.", + "Exclude the target site." + ], + "type": "string" + }, + "updateTime": { + "description": "Output only. The target site's last updated time.", + "format": "google-datetime", + "readOnly": true, + "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigDigitalParsingConfig": { - "description": "The digital parsing configurations for documents.", - "id": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigDigitalParsingConfig", - "properties": {}, + "GoogleCloudDiscoveryengineV1TargetSiteFailureReason": { + "description": "Site search indexing failure reasons.", + "id": "GoogleCloudDiscoveryengineV1TargetSiteFailureReason", + "properties": { + "quotaFailure": { + "$ref": "GoogleCloudDiscoveryengineV1TargetSiteFailureReasonQuotaFailure", + "description": "Failed due to insufficient quota." + } + }, "type": "object" }, - "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigLayoutParsingConfig": { - "description": "The layout parsing configurations for documents.", - "id": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigLayoutParsingConfig", - "properties": {}, + "GoogleCloudDiscoveryengineV1TargetSiteFailureReasonQuotaFailure": { + "description": "Failed due to insufficient quota.", + "id": "GoogleCloudDiscoveryengineV1TargetSiteFailureReasonQuotaFailure", + "properties": { + "totalRequiredQuota": { + "description": "This number is an estimation on how much total quota this project needs to successfully complete indexing.", + "format": "int64", + "type": "string" + } + }, "type": "object" }, - "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigOcrParsingConfig": { - "description": "The OCR parsing configurations for documents.", - "id": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigOcrParsingConfig", + "GoogleCloudDiscoveryengineV1UpdateSchemaMetadata": { + "description": "Metadata for UpdateSchema LRO.", + "id": "GoogleCloudDiscoveryengineV1UpdateSchemaMetadata", "properties": { - "enhancedDocumentElements": { - "deprecated": true, - "description": "[DEPRECATED] This field is deprecated. To use the additional enhanced document elements processing, please switch to `layout_parsing_config`.", - "items": { - "type": "string" - }, - "type": "array" + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", + "type": "string" }, - "useNativeText": { - "description": "If true, will use native text instead of OCR text on pages containing native text.", - "type": "boolean" + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", + "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1EnableAdvancedSiteSearchMetadata": { - "description": "Metadata related to the progress of the SiteSearchEngineService.EnableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1EnableAdvancedSiteSearchMetadata", + "GoogleCloudDiscoveryengineV1UpdateTargetSiteMetadata": { + "description": "Metadata related to the progress of the SiteSearchEngineService.UpdateTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1UpdateTargetSiteMetadata", "properties": { "createTime": { "description": "Operation create time.", @@ -6849,477 +8159,468 @@ }, "type": "object" }, - "GoogleCloudDiscoveryengineV1EnableAdvancedSiteSearchResponse": { - "description": "Response message for SiteSearchEngineService.EnableAdvancedSiteSearch method.", - "id": "GoogleCloudDiscoveryengineV1EnableAdvancedSiteSearchResponse", - "properties": {}, + "GoogleCloudDiscoveryengineV1alphaAclConfig": { + "description": "Access Control Configuration.", + "id": "GoogleCloudDiscoveryengineV1alphaAclConfig", + "properties": { + "idpConfig": { + "$ref": "GoogleCloudDiscoveryengineV1alphaIdpConfig", + "description": "Identity provider config." + }, + "name": { + "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" + } + }, "type": "object" }, - "GoogleCloudDiscoveryengineV1Engine": { - "description": "Metadata that describes the training and serving parameters of an Engine.", - "id": "GoogleCloudDiscoveryengineV1Engine", + "GoogleCloudDiscoveryengineV1alphaAnswer": { + "description": "Defines an answer.", + "id": "GoogleCloudDiscoveryengineV1alphaAnswer", "properties": { - "chatEngineConfig": { - "$ref": "GoogleCloudDiscoveryengineV1EngineChatEngineConfig", - "description": "Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT." - }, - "chatEngineMetadata": { - "$ref": "GoogleCloudDiscoveryengineV1EngineChatEngineMetadata", - "description": "Output only. Additional information of the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.", - "readOnly": true - }, - "commonConfig": { - "$ref": "GoogleCloudDiscoveryengineV1EngineCommonConfig", - "description": "Common config spec that specifies the metadata of the engine." + "answerSkippedReasons": { + "description": "Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set.", + "items": { + "enum": [ + "ANSWER_SKIPPED_REASON_UNSPECIFIED", + "ADVERSARIAL_QUERY_IGNORED", + "NON_ANSWER_SEEKING_QUERY_IGNORED", + "OUT_OF_DOMAIN_QUERY_IGNORED", + "POTENTIAL_POLICY_VIOLATION", + "NO_RELEVANT_CONTENT" + ], + "enumDescriptions": [ + "Default value. The answer skipped reason is not specified.", + "The adversarial query ignored case.", + "The non-answer seeking query ignored case.", + "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." + ], + "type": "string" + }, + "type": "array" }, - "createTime": { - "description": "Output only. Timestamp the Recommendation Engine was created at.", - "format": "google-datetime", - "readOnly": true, + "answerText": { + "description": "The textual answer.", "type": "string" }, - "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.", + "citations": { + "description": "Citations.", "items": { - "type": "string" + "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerCitation" }, "type": "array" }, - "displayName": { - "description": "Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters.", + "completeTime": { + "description": "Output only. Answer completed timestamp.", + "format": "google-datetime", + "readOnly": true, "type": "string" }, - "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.", - "enum": [ - "INDUSTRY_VERTICAL_UNSPECIFIED", - "GENERIC", - "MEDIA", - "HEALTHCARE_FHIR" - ], - "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." - ], + "createTime": { + "description": "Output only. Answer creation timestamp.", + "format": "google-datetime", + "readOnly": true, "type": "string" }, "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_number}/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.", + "description": "Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*/answers/*`", "type": "string" }, - "searchEngineConfig": { - "$ref": "GoogleCloudDiscoveryengineV1EngineSearchEngineConfig", - "description": "Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH." + "queryUnderstandingInfo": { + "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfo", + "description": "Query understanding information." }, - "solutionType": { - "description": "Required. The solutions of the engine.", + "references": { + "description": "References.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerReference" + }, + "type": "array" + }, + "relatedQuestions": { + "description": "Suggested related questions.", + "items": { + "type": "string" + }, + "type": "array" + }, + "state": { + "description": "The state of the answer generation.", "enum": [ - "SOLUTION_TYPE_UNSPECIFIED", - "SOLUTION_TYPE_RECOMMENDATION", - "SOLUTION_TYPE_SEARCH", - "SOLUTION_TYPE_CHAT", - "SOLUTION_TYPE_GENERATIVE_CHAT" + "STATE_UNSPECIFIED", + "IN_PROGRESS", + "FAILED", + "SUCCEEDED" ], "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." + "Unknown.", + "Answer generation is currently in progress.", + "Answer generation currently failed.", + "Answer generation has succeeded." ], "type": "string" }, - "updateTime": { - "description": "Output only. Timestamp the Recommendation Engine was last updated.", - "format": "google-datetime", - "readOnly": true, - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1EngineChatEngineConfig": { - "description": "Configurations for a Chat Engine.", - "id": "GoogleCloudDiscoveryengineV1EngineChatEngineConfig", - "properties": { - "agentCreationConfig": { - "$ref": "GoogleCloudDiscoveryengineV1EngineChatEngineConfigAgentCreationConfig", - "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." - }, - "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" + "steps": { + "description": "Answer generation steps.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerStep" + }, + "type": "array" } }, "type": "object" }, - "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.", - "id": "GoogleCloudDiscoveryengineV1EngineChatEngineConfigAgentCreationConfig", + "GoogleCloudDiscoveryengineV1alphaAnswerCitation": { + "description": "Citation info for a segment.", + "id": "GoogleCloudDiscoveryengineV1alphaAnswerCitation", "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" - }, - "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.", + "endIndex": { + "description": "End of the attributed segment, exclusive.", + "format": "int64", "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" - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1EngineChatEngineMetadata": { - "description": "Additional information of a Chat Engine. Fields in this message are output only.", - "id": "GoogleCloudDiscoveryengineV1EngineChatEngineMetadata", - "properties": { - "dialogflowAgent": { - "description": "The resource name of a Dialogflow agent, that this Chat Engine refers to. Format: `projects//locations//agents/`.", + "sources": { + "description": "Citation sources for the attributed segment.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerCitationSource" + }, + "type": "array" + }, + "startIndex": { + "description": "Index indicates the start of the segment, measured in bytes (UTF-8 unicode).", + "format": "int64", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1EngineCommonConfig": { - "description": "Common configurations for an Engine.", - "id": "GoogleCloudDiscoveryengineV1EngineCommonConfig", + "GoogleCloudDiscoveryengineV1alphaAnswerCitationSource": { + "description": "Citation source.", + "id": "GoogleCloudDiscoveryengineV1alphaAnswerCitationSource", "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.", + "referenceId": { + "description": "ID of the citation source.", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1EngineSearchEngineConfig": { - "description": "Configurations for a Search Engine.", - "id": "GoogleCloudDiscoveryengineV1EngineSearchEngineConfig", + "GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfo": { + "description": "Query understanding information.", + "id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfo", "properties": { - "searchAddOns": { - "description": "The add-on that this search engine enables.", + "queryClassificationInfo": { + "description": "Query classification information.", "items": { - "enum": [ - "SEARCH_ADD_ON_UNSPECIFIED", - "SEARCH_ADD_ON_LLM" - ], - "enumDescriptions": [ - "Default value when the enum is unspecified. This is invalid to use.", - "Large language model add-on." - ], - "type": "string" + "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfoQueryClassificationInfo" }, "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfoQueryClassificationInfo": { + "description": "Query classification information.", + "id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfoQueryClassificationInfo", + "properties": { + "positive": { + "description": "Classification output.", + "type": "boolean" }, - "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": { + "description": "Query classification type.", "enum": [ - "SEARCH_TIER_UNSPECIFIED", - "SEARCH_TIER_STANDARD", - "SEARCH_TIER_ENTERPRISE" + "TYPE_UNSPECIFIED", + "ADVERSARIAL_QUERY", + "NON_ANSWER_SEEKING_QUERY" ], "enumDescriptions": [ - "Default value when the enum is unspecified. This is invalid to use.", - "Standard tier.", - "Enterprise tier." + "Unspecified query classification type.", + "Adversarial query classification type.", + "Non-answer-seeking query classification type." ], "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1ImportCompletionSuggestionsMetadata": { - "description": "Metadata related to the progress of the ImportCompletionSuggestions operation. This will be returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1ImportCompletionSuggestionsMetadata", + "GoogleCloudDiscoveryengineV1alphaAnswerReference": { + "description": "Reference.", + "id": "GoogleCloudDiscoveryengineV1alphaAnswerReference", "properties": { - "createTime": { - "description": "Operation create time.", - "format": "google-datetime", - "type": "string" - }, - "failureCount": { - "description": "Count of CompletionSuggestions that failed to be imported.", - "format": "int64", - "type": "string" - }, - "successCount": { - "description": "Count of CompletionSuggestions successfully imported.", - "format": "int64", - "type": "string" + "chunkInfo": { + "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfo", + "description": "Chunk information." }, - "updateTime": { - "description": "Operation last update time. If the operation is done, this is also the finish time.", - "format": "google-datetime", - "type": "string" + "unstructuredDocumentInfo": { + "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfo", + "description": "Unstructured document information." } }, "type": "object" }, - "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.", - "id": "GoogleCloudDiscoveryengineV1ImportCompletionSuggestionsResponse", + "GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfo": { + "description": "Chunk information.", + "id": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfo", "properties": { - "errorConfig": { - "$ref": "GoogleCloudDiscoveryengineV1ImportErrorConfig", - "description": "The desired location of errors incurred during the Import." + "chunk": { + "description": "Chunk resource name.", + "type": "string" }, - "errorSamples": { - "description": "A sample of errors encountered while processing the request.", - "items": { - "$ref": "GoogleRpcStatus" - }, - "type": "array" + "content": { + "description": "Chunk textual content.", + "type": "string" + }, + "documentMetadata": { + "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfoDocumentMetadata", + "description": "Document metadata." + }, + "relevanceScore": { + "description": "Relevance score.", + "format": "float", + "type": "number" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1ImportDocumentsMetadata": { - "description": "Metadata related to the progress of the ImportDocuments operation. This is returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1ImportDocumentsMetadata", + "GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfoDocumentMetadata": { + "description": "Document metadata.", + "id": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfoDocumentMetadata", "properties": { - "createTime": { - "description": "Operation create time.", - "format": "google-datetime", + "document": { + "description": "Document resource name.", "type": "string" }, - "failureCount": { - "description": "Count of entries that encountered errors while processing.", - "format": "int64", + "pageIdentifier": { + "description": "Page identifier.", "type": "string" }, - "successCount": { - "description": "Count of entries that were processed successfully.", - "format": "int64", - "type": "string" + "structData": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "The structured JSON metadata for the document. It is populated from the struct data from the Chunk in search result.", + "type": "object" }, - "totalCount": { - "description": "Total count of entries that were processed.", - "format": "int64", + "title": { + "description": "Title.", "type": "string" }, - "updateTime": { - "description": "Operation last update time. If the operation is done, this is also the finish time.", - "format": "google-datetime", + "uri": { + "description": "URI for the document.", "type": "string" } }, "type": "object" }, - "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.", - "id": "GoogleCloudDiscoveryengineV1ImportDocumentsResponse", + "GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfo": { + "description": "Unstructured document information.", + "id": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfo", "properties": { - "errorConfig": { - "$ref": "GoogleCloudDiscoveryengineV1ImportErrorConfig", - "description": "Echoes the destination for the complete errors in the request if set." - }, - "errorSamples": { - "description": "A sample of errors encountered while processing the request.", + "chunkContents": { + "description": "List of cited chunk contents derived from document content.", "items": { - "$ref": "GoogleRpcStatus" + "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfoChunkContent" }, "type": "array" - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1ImportErrorConfig": { - "description": "Configuration of destination for Import related errors.", - "id": "GoogleCloudDiscoveryengineV1ImportErrorConfig", - "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.", + }, + "document": { + "description": "Document resource name.", + "type": "string" + }, + "structData": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "The structured JSON metadata for the document. It is populated from the struct data from the Chunk in search result.", + "type": "object" + }, + "title": { + "description": "Title.", + "type": "string" + }, + "uri": { + "description": "URI for the document.", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1ImportSuggestionDenyListEntriesMetadata": { - "description": "Metadata related to the progress of the ImportSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1ImportSuggestionDenyListEntriesMetadata", + "GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfoChunkContent": { + "description": "Chunk content.", + "id": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfoChunkContent", "properties": { - "createTime": { - "description": "Operation create time.", - "format": "google-datetime", + "content": { + "description": "Chunk textual content.", "type": "string" }, - "updateTime": { - "description": "Operation last update time. If the operation is done, this is also the finish time.", - "format": "google-datetime", + "pageIdentifier": { + "description": "Page identifier.", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1ImportSuggestionDenyListEntriesResponse": { - "description": "Response message for CompletionService.ImportSuggestionDenyListEntries method.", - "id": "GoogleCloudDiscoveryengineV1ImportSuggestionDenyListEntriesResponse", + "GoogleCloudDiscoveryengineV1alphaAnswerStep": { + "description": "Step information.", + "id": "GoogleCloudDiscoveryengineV1alphaAnswerStep", "properties": { - "errorSamples": { - "description": "A sample of errors encountered while processing the request.", + "actions": { + "description": "Actions.", "items": { - "$ref": "GoogleRpcStatus" + "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerStepAction" }, "type": "array" }, - "failedEntriesCount": { - "description": "Count of deny list entries that failed to be imported.", - "format": "int64", + "description": { + "description": "The description of the step.", "type": "string" }, - "importedEntriesCount": { - "description": "Count of deny list entries successfully imported.", - "format": "int64", + "state": { + "description": "The state of the step.", + "enum": [ + "STATE_UNSPECIFIED", + "IN_PROGRESS", + "FAILED", + "SUCCEEDED" + ], + "enumDescriptions": [ + "Unknown.", + "Step is currently in progress.", + "Step currently failed.", + "Step has succeeded." + ], + "type": "string" + }, + "thought": { + "description": "The thought of the step.", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1ImportUserEventsMetadata": { - "description": "Metadata related to the progress of the Import operation. This is returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1ImportUserEventsMetadata", + "GoogleCloudDiscoveryengineV1alphaAnswerStepAction": { + "description": "Action.", + "id": "GoogleCloudDiscoveryengineV1alphaAnswerStepAction", "properties": { - "createTime": { - "description": "Operation create time.", - "format": "google-datetime", - "type": "string" - }, - "failureCount": { - "description": "Count of entries that encountered errors while processing.", - "format": "int64", - "type": "string" - }, - "successCount": { - "description": "Count of entries that were processed successfully.", - "format": "int64", - "type": "string" + "observation": { + "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservation", + "description": "Observation." }, - "updateTime": { - "description": "Operation last update time. If the operation is done, this is also the finish time.", - "format": "google-datetime", - "type": "string" + "searchAction": { + "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionSearchAction", + "description": "Search action." } }, "type": "object" }, - "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.", - "id": "GoogleCloudDiscoveryengineV1ImportUserEventsResponse", + "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservation": { + "description": "Observation.", + "id": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservation", "properties": { - "errorConfig": { - "$ref": "GoogleCloudDiscoveryengineV1ImportErrorConfig", - "description": "Echoes the destination for the complete errors if this field was set in the request." - }, - "errorSamples": { - "description": "A sample of errors encountered while processing the request.", + "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.", "items": { - "$ref": "GoogleRpcStatus" + "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResult" }, "type": "array" - }, - "joinedEventsCount": { - "description": "Count of user events imported with complete existing Documents.", - "format": "int64", - "type": "string" - }, - "unjoinedEventsCount": { - "description": "Count of user events imported, but with Document information not found in the existing Branch.", - "format": "int64", - "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1Project": { - "description": "Metadata and configurations for a Google Cloud project in the service.", - "id": "GoogleCloudDiscoveryengineV1Project", + "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResult": { + "id": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResult", "properties": { - "createTime": { - "description": "Output only. The timestamp when this project is created.", - "format": "google-datetime", - "readOnly": true, - "type": "string" + "chunkInfo": { + "description": "If citation_type is CHUNK_LEVEL_CITATION and chunk mode is on, populate chunk info.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultChunkInfo" + }, + "type": "array" }, - "name": { - "description": "Output only. Full resource name of the project, for example `projects/{project_number}`. Note that when making requests, project number and project id are both acceptable, but the server will always respond in project number.", - "readOnly": true, + "document": { + "description": "Document resource name.", "type": "string" }, - "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.", - "format": "google-datetime", - "readOnly": true, - "type": "string" + "snippetInfo": { + "description": "If citation_type is DOCUMENT_LEVEL_CITATION, populate document level snippets.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultSnippetInfo" + }, + "type": "array" }, - "serviceTermsMap": { + "structData": { "additionalProperties": { - "$ref": "GoogleCloudDiscoveryengineV1ProjectServiceTerms" + "description": "Properties of the object.", + "type": "any" }, - "description": "Output only. A map of terms of services. The key is the `id` of ServiceTerms.", - "readOnly": true, + "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" + }, + "title": { + "description": "Title.", + "type": "string" + }, + "uri": { + "description": "URI for the document.", + "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1ProjectServiceTerms": { - "description": "Metadata about the terms of service.", - "id": "GoogleCloudDiscoveryengineV1ProjectServiceTerms", + "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultChunkInfo": { + "description": "Chunk information.", + "id": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultChunkInfo", "properties": { - "acceptTime": { - "description": "The last time when the project agreed to the terms of service.", - "format": "google-datetime", - "type": "string" - }, - "declineTime": { - "description": "The last time when the project declined or revoked the agreement to terms of service.", - "format": "google-datetime", + "chunk": { + "description": "Chunk resource name.", "type": "string" }, - "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`.", + "content": { + "description": "Chunk textual content.", "type": "string" }, - "state": { - "description": "Whether the project has accepted/rejected the service terms or it is still pending.", - "enum": [ - "STATE_UNSPECIFIED", - "TERMS_ACCEPTED", - "TERMS_PENDING", - "TERMS_DECLINED" - ], - "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." - ], + "relevanceScore": { + "description": "Relevance score.", + "format": "float", + "type": "number" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultSnippetInfo": { + "description": "Snippet information.", + "id": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultSnippetInfo", + "properties": { + "snippet": { + "description": "Snippet content.", "type": "string" }, - "version": { - "description": "The version string of the terms of service. For acceptable values, see the comments for id above.", + "snippetStatus": { + "description": "Status of the snippet defined by the search team.", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1ProvisionProjectMetadata": { - "description": "Metadata associated with a project provision operation.", - "id": "GoogleCloudDiscoveryengineV1ProvisionProjectMetadata", - "properties": {}, + "GoogleCloudDiscoveryengineV1alphaAnswerStepActionSearchAction": { + "description": "Search action.", + "id": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionSearchAction", + "properties": { + "query": { + "description": "The query to search.", + "type": "string" + } + }, "type": "object" }, - "GoogleCloudDiscoveryengineV1PurgeCompletionSuggestionsMetadata": { - "description": "Metadata related to the progress of the PurgeCompletionSuggestions operation. This is returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1PurgeCompletionSuggestionsMetadata", + "GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSiteMetadata": { + "description": "Metadata related to the progress of the SiteSearchEngineService.BatchCreateTargetSites operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSiteMetadata", "properties": { "createTime": { "description": "Operation create time.", @@ -7334,267 +8635,257 @@ }, "type": "object" }, - "GoogleCloudDiscoveryengineV1PurgeCompletionSuggestionsResponse": { - "description": "Response message for CompletionService.PurgeCompletionSuggestions method.", - "id": "GoogleCloudDiscoveryengineV1PurgeCompletionSuggestionsResponse", + "GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSitesResponse": { + "description": "Response message for SiteSearchEngineService.BatchCreateTargetSites method.", + "id": "GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSitesResponse", "properties": { - "errorSamples": { - "description": "A sample of errors encountered while processing the request.", + "targetSites": { + "description": "TargetSites created.", "items": { - "$ref": "GoogleRpcStatus" + "$ref": "GoogleCloudDiscoveryengineV1alphaTargetSite" }, "type": "array" - }, - "purgeSucceeded": { - "description": "Whether the completion suggestions were successfully purged.", - "type": "boolean" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1PurgeDocumentsMetadata": { - "description": "Metadata related to the progress of the PurgeDocuments operation. This will be returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1PurgeDocumentsMetadata", + "GoogleCloudDiscoveryengineV1alphaCondition": { + "description": "Defines circumstances to be checked before allowing a behavior", + "id": "GoogleCloudDiscoveryengineV1alphaCondition", "properties": { - "createTime": { - "description": "Operation create time.", - "format": "google-datetime", - "type": "string" - }, - "failureCount": { - "description": "Count of entries that encountered errors while processing.", - "format": "int64", - "type": "string" - }, - "ignoredCount": { - "description": "Count of entries that were ignored as entries were not found.", - "format": "int64", - "type": "string" - }, - "successCount": { - "description": "Count of entries that were deleted successfully.", - "format": "int64", - "type": "string" + "activeTimeRange": { + "description": "Range of time(s) specifying when condition is active. Maximum of 10 time ranges.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaConditionTimeRange" + }, + "type": "array" }, - "updateTime": { - "description": "Operation last update time. If the operation is done, this is also the finish time.", - "format": "google-datetime", - "type": "string" + "queryTerms": { + "description": "Search only A list of terms to match the query on. Maximum of 10 query terms.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaConditionQueryTerm" + }, + "type": "array" } }, "type": "object" }, - "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.", - "id": "GoogleCloudDiscoveryengineV1PurgeDocumentsResponse", + "GoogleCloudDiscoveryengineV1alphaConditionQueryTerm": { + "description": "Matcher for search request query", + "id": "GoogleCloudDiscoveryengineV1alphaConditionQueryTerm", "properties": { - "purgeCount": { - "description": "The total count of documents purged as a result of the operation.", - "format": "int64", - "type": "string" + "fullMatch": { + "description": "Whether the search query needs to exactly match the query term.", + "type": "boolean" }, - "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.", - "items": { - "type": "string" - }, - "type": "array" + "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" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1PurgeSuggestionDenyListEntriesMetadata": { - "description": "Metadata related to the progress of the PurgeSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1PurgeSuggestionDenyListEntriesMetadata", + "GoogleCloudDiscoveryengineV1alphaConditionTimeRange": { + "description": "Used for time-dependent conditions.", + "id": "GoogleCloudDiscoveryengineV1alphaConditionTimeRange", "properties": { - "createTime": { - "description": "Operation create time.", + "endTime": { + "description": "End of time range. Range is inclusive. Must be in the future.", "format": "google-datetime", "type": "string" }, - "updateTime": { - "description": "Operation last update time. If the operation is done, this is also the finish time.", + "startTime": { + "description": "Start of time range. Range is inclusive.", "format": "google-datetime", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1PurgeSuggestionDenyListEntriesResponse": { - "description": "Response message for CompletionService.PurgeSuggestionDenyListEntries method.", - "id": "GoogleCloudDiscoveryengineV1PurgeSuggestionDenyListEntriesResponse", + "GoogleCloudDiscoveryengineV1alphaControl": { + "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`.", + "id": "GoogleCloudDiscoveryengineV1alphaControl", "properties": { - "errorSamples": { - "description": "A sample of errors encountered while processing the request.", + "associatedServingConfigIds": { + "description": "Output only. List of all ServingConfig ids this control is attached to. May take up to 10 minutes to update after changes.", "items": { - "$ref": "GoogleRpcStatus" + "type": "string" }, + "readOnly": true, "type": "array" }, - "purgeCount": { - "description": "Number of suggestion deny list entries purged.", - "format": "int64", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1Schema": { - "description": "Defines the structure and layout of a type of document data.", - "id": "GoogleCloudDiscoveryengineV1Schema", - "properties": { - "jsonSchema": { - "description": "The JSON representation of the schema.", + "boostAction": { + "$ref": "GoogleCloudDiscoveryengineV1alphaControlBoostAction", + "description": "Defines a boost-type control" + }, + "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.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaCondition" + }, + "type": "array" + }, + "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" }, + "filterAction": { + "$ref": "GoogleCloudDiscoveryengineV1alphaControlFilterAction", + "description": "Defines a filter-type control Currently not supported by Recommendation" + }, "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.", + "description": "Immutable. Fully qualified name `projects/*/locations/global/dataStore/*/controls/*`", "type": "string" }, - "structSchema": { - "additionalProperties": { - "description": "Properties of the object.", - "type": "any" - }, - "description": "The structured representation of the schema.", - "type": "object" - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1SiteVerificationInfo": { - "description": "Verification information for target sites in advanced site search.", - "id": "GoogleCloudDiscoveryengineV1SiteVerificationInfo", - "properties": { - "siteVerificationState": { - "description": "Site verification state indicating the ownership and validity.", + "redirectAction": { + "$ref": "GoogleCloudDiscoveryengineV1alphaControlRedirectAction", + "description": "Defines a redirect-type control." + }, + "solutionType": { + "description": "Required. Immutable. What solution the control belongs to. Must be compatible with vertical of resource. Otherwise an INVALID ARGUMENT error is thrown.", "enum": [ - "SITE_VERIFICATION_STATE_UNSPECIFIED", - "VERIFIED", - "UNVERIFIED", - "EXEMPTED" + "SOLUTION_TYPE_UNSPECIFIED", + "SOLUTION_TYPE_RECOMMENDATION", + "SOLUTION_TYPE_SEARCH", + "SOLUTION_TYPE_CHAT", + "SOLUTION_TYPE_GENERATIVE_CHAT" ], "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." + "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." ], "type": "string" }, - "verifyTime": { - "description": "Latest site verification time.", - "format": "google-datetime", - "type": "string" + "synonymsAction": { + "$ref": "GoogleCloudDiscoveryengineV1alphaControlSynonymsAction", + "description": "Treats a group of terms as synonyms of one another." + }, + "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.", + "items": { + "enum": [ + "SEARCH_USE_CASE_UNSPECIFIED", + "SEARCH_USE_CASE_SEARCH", + "SEARCH_USE_CASE_BROWSE" + ], + "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." + ], + "type": "string" + }, + "type": "array" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1TargetSite": { - "description": "A target site for the SiteSearchEngine.", - "id": "GoogleCloudDiscoveryengineV1TargetSite", + "GoogleCloudDiscoveryengineV1alphaControlBoostAction": { + "description": "Adjusts order of products in returned list.", + "id": "GoogleCloudDiscoveryengineV1alphaControlBoostAction", "properties": { - "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" - }, - "failureReason": { - "$ref": "GoogleCloudDiscoveryengineV1TargetSiteFailureReason", - "description": "Output only. Failure reason.", - "readOnly": true - }, - "generatedUriPattern": { - "description": "Output only. This is system-generated based on the provided_uri_pattern.", - "readOnly": true, - "type": "string" - }, - "indexingStatus": { - "description": "Output only. Indexing status.", - "enum": [ - "INDEXING_STATUS_UNSPECIFIED", - "PENDING", - "FAILED", - "SUCCEEDED", - "DELETING" - ], - "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." - ], - "readOnly": true, - "type": "string" + "boost": { + "description": "Required. Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0 (No-op).", + "format": "float", + "type": "number" }, - "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, + "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" }, - "providedUriPattern": { - "description": "Required. Input only. The user provided URI pattern from which the `generated_uri_pattern` is generated.", + "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" - }, - "rootDomainUri": { - "description": "Output only. Root domain of the provided_uri_pattern.", - "readOnly": true, + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaControlFilterAction": { + "description": "Specified which products may be included in results. Uses same filter as boost.", + "id": "GoogleCloudDiscoveryengineV1alphaControlFilterAction", + "properties": { + "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" }, - "siteVerificationInfo": { - "$ref": "GoogleCloudDiscoveryengineV1SiteVerificationInfo", - "description": "Output only. Site ownership and validity verification status.", - "readOnly": true - }, - "type": { - "description": "The type of the target site, e.g., whether the site is to be included or excluded.", - "enum": [ - "TYPE_UNSPECIFIED", - "INCLUDE", - "EXCLUDE" - ], - "enumDescriptions": [ - "This value is unused. In this case, server behavior defaults to Type.INCLUDE.", - "Include the target site.", - "Exclude the target site." - ], + "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" - }, - "updateTime": { - "description": "Output only. The target site's last updated time.", - "format": "google-datetime", - "readOnly": true, + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaControlRedirectAction": { + "description": "Redirects a shopper to the provided URI.", + "id": "GoogleCloudDiscoveryengineV1alphaControlRedirectAction", + "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" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1TargetSiteFailureReason": { - "description": "Site search indexing failure reasons.", - "id": "GoogleCloudDiscoveryengineV1TargetSiteFailureReason", + "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\".", + "id": "GoogleCloudDiscoveryengineV1alphaControlSynonymsAction", "properties": { - "quotaFailure": { - "$ref": "GoogleCloudDiscoveryengineV1TargetSiteFailureReasonQuotaFailure", - "description": "Failed due to insufficient quota." + "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.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaCreateDataStoreMetadata": { + "description": "Metadata related to the progress of the DataStoreService.CreateDataStore operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1alphaCreateDataStoreMetadata", + "properties": { + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", + "type": "string" + }, + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", + "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1TargetSiteFailureReasonQuotaFailure": { - "description": "Failed due to insufficient quota.", - "id": "GoogleCloudDiscoveryengineV1TargetSiteFailureReasonQuotaFailure", + "GoogleCloudDiscoveryengineV1alphaCreateEngineMetadata": { + "description": "Metadata related to the progress of the EngineService.CreateEngine operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1alphaCreateEngineMetadata", "properties": { - "totalRequiredQuota": { - "description": "This number is an estimation on how much total quota this project needs to successfully complete indexing.", - "format": "int64", + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", + "type": "string" + }, + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1UpdateSchemaMetadata": { - "description": "Metadata for UpdateSchema LRO.", - "id": "GoogleCloudDiscoveryengineV1UpdateSchemaMetadata", + "GoogleCloudDiscoveryengineV1alphaCreateEvaluationMetadata": { + "description": "Metadata for EvaluationService.CreateEvaluation method.", + "id": "GoogleCloudDiscoveryengineV1alphaCreateEvaluationMetadata", + "properties": {}, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaCreateSchemaMetadata": { + "description": "Metadata for Create Schema LRO.", + "id": "GoogleCloudDiscoveryengineV1alphaCreateSchemaMetadata", "properties": { "createTime": { "description": "Operation create time.", @@ -7609,9 +8900,9 @@ }, "type": "object" }, - "GoogleCloudDiscoveryengineV1UpdateTargetSiteMetadata": { - "description": "Metadata related to the progress of the SiteSearchEngineService.UpdateTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1UpdateTargetSiteMetadata", + "GoogleCloudDiscoveryengineV1alphaCreateTargetSiteMetadata": { + "description": "Metadata related to the progress of the SiteSearchEngineService.CreateTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1alphaCreateTargetSiteMetadata", "properties": { "createTime": { "description": "Operation create time.", @@ -7626,719 +8917,816 @@ }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaAclConfig": { - "description": "Access Control Configuration.", - "id": "GoogleCloudDiscoveryengineV1alphaAclConfig", + "GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec": { + "description": "Defines custom fine tuning spec.", + "id": "GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec", "properties": { - "idpConfig": { - "$ref": "GoogleCloudDiscoveryengineV1alphaIdpConfig", - "description": "Identity provider config." - }, - "name": { - "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" + "enableSearchAdaptor": { + "description": "Whether or not to enable and include custom fine tuned search adaptor model.", + "type": "boolean" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaAnswer": { - "description": "Defines an answer.", - "id": "GoogleCloudDiscoveryengineV1alphaAnswer", + "GoogleCloudDiscoveryengineV1alphaCustomTuningModel": { + "description": "Metadata that describes a custom tuned model.", + "id": "GoogleCloudDiscoveryengineV1alphaCustomTuningModel", "properties": { - "answerSkippedReasons": { - "description": "Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set.", - "items": { - "enum": [ - "ANSWER_SKIPPED_REASON_UNSPECIFIED", - "ADVERSARIAL_QUERY_IGNORED", - "NON_ANSWER_SEEKING_QUERY_IGNORED", - "OUT_OF_DOMAIN_QUERY_IGNORED", - "POTENTIAL_POLICY_VIOLATION", - "NO_RELEVANT_CONTENT" - ], - "enumDescriptions": [ - "Default value. The answer skipped reason is not specified.", - "The adversarial query ignored case.", - "The non-answer seeking query ignored case.", - "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." - ], - "type": "string" - }, - "type": "array" - }, - "answerText": { - "description": "The textual answer.", - "type": "string" - }, - "citations": { - "description": "Citations.", - "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerCitation" - }, - "type": "array" - }, - "completeTime": { - "description": "Output only. Answer completed timestamp.", - "format": "google-datetime", - "readOnly": true, - "type": "string" - }, "createTime": { - "description": "Output only. Answer creation timestamp.", + "deprecated": true, + "description": "Timestamp the Model was created at.", "format": "google-datetime", - "readOnly": true, "type": "string" }, - "name": { - "description": "Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*/answers/*`", + "displayName": { + "description": "The display name of the model.", "type": "string" }, - "queryUnderstandingInfo": { - "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfo", - "description": "Query understanding information." - }, - "references": { - "description": "References.", - "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerReference" - }, - "type": "array" - }, - "relatedQuestions": { - "description": "Suggested related questions.", - "items": { - "type": "string" + "metrics": { + "additionalProperties": { + "format": "double", + "type": "number" }, - "type": "array" + "description": "The metrics of the trained model.", + "type": "object" }, - "state": { - "description": "The state of the answer generation.", + "modelState": { + "description": "The state that the model is in (e.g.`TRAINING` or `TRAINING_FAILED`).", "enum": [ - "STATE_UNSPECIFIED", - "IN_PROGRESS", - "FAILED", - "SUCCEEDED" + "MODEL_STATE_UNSPECIFIED", + "TRAINING_PAUSED", + "TRAINING", + "TRAINING_COMPLETE", + "READY_FOR_SERVING", + "TRAINING_FAILED", + "NO_IMPROVEMENT" ], "enumDescriptions": [ - "Unknown.", - "Answer generation is currently in progress.", - "Answer generation currently failed.", - "Answer generation has succeeded." + "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." ], "type": "string" }, - "steps": { - "description": "Answer generation steps.", - "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerStep" - }, - "type": "array" - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1alphaAnswerCitation": { - "description": "Citation info for a segment.", - "id": "GoogleCloudDiscoveryengineV1alphaAnswerCitation", - "properties": { - "endIndex": { - "description": "End of the attributed segment, exclusive.", + "modelVersion": { + "description": "The version of the model.", "format": "int64", "type": "string" }, - "sources": { - "description": "Citation sources for the attributed segment.", - "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerCitationSource" - }, - "type": "array" + "name": { + "description": "Required. The fully qualified resource name of the model. Format: `projects/{project_number}/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" }, - "startIndex": { - "description": "Index indicates the start of the segment, measured in bytes (UTF-8 unicode).", - "format": "int64", + "trainingStartTime": { + "description": "Timestamp the model training was initiated.", + "format": "google-datetime", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaAnswerCitationSource": { - "description": "Citation source.", - "id": "GoogleCloudDiscoveryengineV1alphaAnswerCitationSource", + "GoogleCloudDiscoveryengineV1alphaDataStore": { + "description": "DataStore captures global settings and configs at the DataStore level.", + "id": "GoogleCloudDiscoveryengineV1alphaDataStore", "properties": { - "referenceId": { - "description": "ID of the citation source.", + "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" + }, + "contentConfig": { + "description": "Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT.", + "enum": [ + "CONTENT_CONFIG_UNSPECIFIED", + "NO_CONTENT", + "CONTENT_REQUIRED", + "PUBLIC_WEBSITE" + ], + "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." + ], "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfo": { - "description": "Query understanding information.", - "id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfo", - "properties": { - "queryClassificationInfo": { - "description": "Query classification information.", + }, + "createTime": { + "description": "Output only. Timestamp the DataStore was created at.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "defaultSchemaId": { + "description": "Output only. The id of the default Schema asscociated to this data store.", + "readOnly": true, + "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" + }, + "documentProcessingConfig": { + "$ref": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig", + "description": "Configuration for Document understanding and enrichment." + }, + "idpConfig": { + "$ref": "GoogleCloudDiscoveryengineV1alphaIdpConfig", + "description": "Output only. Data store level identity provider config.", + "readOnly": true + }, + "industryVertical": { + "description": "Immutable. The industry vertical that the data store registers.", + "enum": [ + "INDUSTRY_VERTICAL_UNSPECIFIED", + "GENERIC", + "MEDIA", + "HEALTHCARE_FHIR" + ], + "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." + ], + "type": "string" + }, + "languageInfo": { + "$ref": "GoogleCloudDiscoveryengineV1alphaLanguageInfo", + "description": "Language info for DataStore." + }, + "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" + }, + "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.", "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfoQueryClassificationInfo" + "enum": [ + "SOLUTION_TYPE_UNSPECIFIED", + "SOLUTION_TYPE_RECOMMENDATION", + "SOLUTION_TYPE_SEARCH", + "SOLUTION_TYPE_CHAT", + "SOLUTION_TYPE_GENERATIVE_CHAT" + ], + "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." + ], + "type": "string" }, "type": "array" + }, + "startingSchema": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSchema", + "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)." } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfoQueryClassificationInfo": { - "description": "Query classification information.", - "id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfoQueryClassificationInfo", + "GoogleCloudDiscoveryengineV1alphaDeleteDataStoreMetadata": { + "description": "Metadata related to the progress of the DataStoreService.DeleteDataStore operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1alphaDeleteDataStoreMetadata", "properties": { - "positive": { - "description": "Classification output.", - "type": "boolean" + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", + "type": "string" }, - "type": { - "description": "Query classification type.", - "enum": [ - "TYPE_UNSPECIFIED", - "ADVERSARIAL_QUERY", - "NON_ANSWER_SEEKING_QUERY" - ], - "enumDescriptions": [ - "Unspecified query classification type.", - "Adversarial query classification type.", - "Non-answer-seeking query classification type." - ], + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaAnswerReference": { - "description": "Reference.", - "id": "GoogleCloudDiscoveryengineV1alphaAnswerReference", + "GoogleCloudDiscoveryengineV1alphaDeleteEngineMetadata": { + "description": "Metadata related to the progress of the EngineService.DeleteEngine operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1alphaDeleteEngineMetadata", "properties": { - "chunkInfo": { - "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfo", - "description": "Chunk information." + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", + "type": "string" }, - "unstructuredDocumentInfo": { - "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfo", - "description": "Unstructured document information." + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", + "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfo": { - "description": "Chunk information.", - "id": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfo", + "GoogleCloudDiscoveryengineV1alphaDeleteSchemaMetadata": { + "description": "Metadata for DeleteSchema LRO.", + "id": "GoogleCloudDiscoveryengineV1alphaDeleteSchemaMetadata", "properties": { - "chunk": { - "description": "Chunk resource name.", + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", "type": "string" }, - "content": { - "description": "Chunk textual content.", + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", "type": "string" - }, - "documentMetadata": { - "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfoDocumentMetadata", - "description": "Document metadata." - }, - "relevanceScore": { - "description": "Relevance score.", - "format": "float", - "type": "number" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfoDocumentMetadata": { - "description": "Document metadata.", - "id": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfoDocumentMetadata", + "GoogleCloudDiscoveryengineV1alphaDeleteTargetSiteMetadata": { + "description": "Metadata related to the progress of the SiteSearchEngineService.DeleteTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1alphaDeleteTargetSiteMetadata", "properties": { - "document": { - "description": "Document resource name.", + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", "type": "string" }, - "pageIdentifier": { - "description": "Page identifier.", + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", "type": "string" - }, - "structData": { - "additionalProperties": { - "description": "Properties of the object.", - "type": "any" - }, - "description": "The structured JSON metadata for the document. It is populated from the struct data from the Chunk in search result.", - "type": "object" - }, - "title": { - "description": "Title.", + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaDisableAdvancedSiteSearchMetadata": { + "description": "Metadata related to the progress of the SiteSearchEngineService.DisableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1alphaDisableAdvancedSiteSearchMetadata", + "properties": { + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", "type": "string" }, - "uri": { - "description": "URI for the document.", + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfo": { - "description": "Unstructured document information.", - "id": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfo", + "GoogleCloudDiscoveryengineV1alphaDisableAdvancedSiteSearchResponse": { + "description": "Response message for SiteSearchEngineService.DisableAdvancedSiteSearch method.", + "id": "GoogleCloudDiscoveryengineV1alphaDisableAdvancedSiteSearchResponse", + "properties": {}, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig": { + "description": "A singleton resource of DataStore. It's empty when DataStore is created, which defaults to digital parser. The first call to DataStoreService.UpdateDocumentProcessingConfig method will initialize the config.", + "id": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig", "properties": { - "chunkContents": { - "description": "List of cited chunk contents derived from document content.", - "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfoChunkContent" - }, - "type": "array" + "chunkingConfig": { + "$ref": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfig", + "description": "Whether chunking mode is enabled." }, - "document": { - "description": "Document resource name.", + "defaultParsingConfig": { + "$ref": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfig", + "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." + }, + "name": { + "description": "The full resource name of the Document Processing Config. Format: `projects/*/locations/*/collections/*/dataStores/*/documentProcessingConfig`.", "type": "string" }, - "structData": { + "parsingConfigOverrides": { "additionalProperties": { - "description": "Properties of the object.", - "type": "any" + "$ref": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfig" }, - "description": "The structured JSON metadata for the document. It is populated from the struct data from the Chunk in search result.", + "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.", "type": "object" - }, - "title": { - "description": "Title.", - "type": "string" - }, - "uri": { - "description": "URI for the document.", - "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfoChunkContent": { - "description": "Chunk content.", - "id": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfoChunkContent", + "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfig": { + "description": "Configuration for chunking config.", + "id": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfig", "properties": { - "content": { - "description": "Chunk textual content.", - "type": "string" - }, - "pageIdentifier": { - "description": "Page identifier.", - "type": "string" + "layoutBasedChunkingConfig": { + "$ref": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig", + "description": "Configuration for the layout based chunking." } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaAnswerStep": { - "description": "Step information.", - "id": "GoogleCloudDiscoveryengineV1alphaAnswerStep", + "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig": { + "description": "Configuration for the layout based chunking.", + "id": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig", "properties": { - "actions": { - "description": "Actions.", - "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerStepAction" - }, - "type": "array" - }, - "description": { - "description": "The description of the step.", - "type": "string" - }, - "state": { - "description": "The state of the step.", - "enum": [ - "STATE_UNSPECIFIED", - "IN_PROGRESS", - "FAILED", - "SUCCEEDED" - ], - "enumDescriptions": [ - "Unknown.", - "Step is currently in progress.", - "Step currently failed.", - "Step has succeeded." - ], - "type": "string" + "chunkSize": { + "description": "The token size limit for each chunk. Supported values: 100-500 (inclusive). Default value: 500.", + "format": "int32", + "type": "integer" }, - "thought": { - "description": "The thought of the step.", - "type": "string" + "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" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaAnswerStepAction": { - "description": "Action.", - "id": "GoogleCloudDiscoveryengineV1alphaAnswerStepAction", + "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfig": { + "description": "Related configurations applied to a specific type of document parser.", + "id": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfig", "properties": { - "observation": { - "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservation", - "description": "Observation." + "digitalParsingConfig": { + "$ref": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigDigitalParsingConfig", + "description": "Configurations applied to digital parser." + }, + "layoutParsingConfig": { + "$ref": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigLayoutParsingConfig", + "description": "Configurations applied to layout parser." }, - "searchAction": { - "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionSearchAction", - "description": "Search action." + "ocrParsingConfig": { + "$ref": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigOcrParsingConfig", + "description": "Configurations applied to OCR parser. Currently it only applies to PDFs." } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservation": { - "description": "Observation.", - "id": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservation", + "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigDigitalParsingConfig": { + "description": "The digital parsing configurations for documents.", + "id": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigDigitalParsingConfig", + "properties": {}, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigLayoutParsingConfig": { + "description": "The layout parsing configurations for documents.", + "id": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigLayoutParsingConfig", + "properties": {}, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigOcrParsingConfig": { + "description": "The OCR parsing configurations for documents.", + "id": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigOcrParsingConfig", "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.", + "enhancedDocumentElements": { + "deprecated": true, + "description": "[DEPRECATED] This field is deprecated. To use the additional enhanced document elements processing, please switch to `layout_parsing_config`.", "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResult" + "type": "string" }, "type": "array" + }, + "useNativeText": { + "description": "If true, will use native text instead of OCR text on pages containing native text.", + "type": "boolean" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResult": { - "id": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResult", + "GoogleCloudDiscoveryengineV1alphaEnableAdvancedSiteSearchMetadata": { + "description": "Metadata related to the progress of the SiteSearchEngineService.EnableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1alphaEnableAdvancedSiteSearchMetadata", "properties": { - "chunkInfo": { - "description": "If citation_type is CHUNK_LEVEL_CITATION and chunk mode is on, populate chunk info.", - "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultChunkInfo" - }, - "type": "array" + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", + "type": "string" }, - "document": { - "description": "Document resource name.", + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaEnableAdvancedSiteSearchResponse": { + "description": "Response message for SiteSearchEngineService.EnableAdvancedSiteSearch method.", + "id": "GoogleCloudDiscoveryengineV1alphaEnableAdvancedSiteSearchResponse", + "properties": {}, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaEngine": { + "description": "Metadata that describes the training and serving parameters of an Engine.", + "id": "GoogleCloudDiscoveryengineV1alphaEngine", + "properties": { + "chatEngineConfig": { + "$ref": "GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfig", + "description": "Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT." + }, + "chatEngineMetadata": { + "$ref": "GoogleCloudDiscoveryengineV1alphaEngineChatEngineMetadata", + "description": "Output only. Additional information of the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.", + "readOnly": true + }, + "commonConfig": { + "$ref": "GoogleCloudDiscoveryengineV1alphaEngineCommonConfig", + "description": "Common config spec that specifies the metadata of the engine." + }, + "createTime": { + "description": "Output only. Timestamp the Recommendation Engine was created at.", + "format": "google-datetime", + "readOnly": true, "type": "string" }, - "snippetInfo": { - "description": "If citation_type is DOCUMENT_LEVEL_CITATION, populate document level snippets.", + "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.", "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultSnippetInfo" + "type": "string" }, "type": "array" }, - "title": { - "description": "Title.", + "displayName": { + "description": "Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters.", "type": "string" }, - "uri": { - "description": "URI for the document.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultChunkInfo": { - "description": "Chunk information.", - "id": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultChunkInfo", - "properties": { - "chunk": { - "description": "Chunk resource name.", + "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.", + "enum": [ + "INDUSTRY_VERTICAL_UNSPECIFIED", + "GENERIC", + "MEDIA", + "HEALTHCARE_FHIR" + ], + "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." + ], "type": "string" }, - "content": { - "description": "Chunk textual content.", + "mediaRecommendationEngineConfig": { + "$ref": "GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfig", + "description": "Configurations for the Media Engine. Only applicable on the data stores with solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical." + }, + "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_number}/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" }, - "relevanceScore": { - "description": "Relevance score.", - "format": "float", - "type": "number" - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultSnippetInfo": { - "description": "Snippet information.", - "id": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultSnippetInfo", - "properties": { - "snippet": { - "description": "Snippet content.", + "recommendationMetadata": { + "$ref": "GoogleCloudDiscoveryengineV1alphaEngineRecommendationMetadata", + "description": "Output only. Additional information of a recommendation engine. Only applicable if solution_type is SOLUTION_TYPE_RECOMMENDATION.", + "readOnly": true + }, + "searchEngineConfig": { + "$ref": "GoogleCloudDiscoveryengineV1alphaEngineSearchEngineConfig", + "description": "Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH." + }, + "similarDocumentsConfig": { + "$ref": "GoogleCloudDiscoveryengineV1alphaEngineSimilarDocumentsEngineConfig", + "description": "Additional config specs for a `similar-items` engine." + }, + "solutionType": { + "description": "Required. The solutions of the engine.", + "enum": [ + "SOLUTION_TYPE_UNSPECIFIED", + "SOLUTION_TYPE_RECOMMENDATION", + "SOLUTION_TYPE_SEARCH", + "SOLUTION_TYPE_CHAT", + "SOLUTION_TYPE_GENERATIVE_CHAT" + ], + "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." + ], "type": "string" }, - "snippetStatus": { - "description": "Status of the snippet defined by the search team.", + "updateTime": { + "description": "Output only. Timestamp the Recommendation Engine was last updated.", + "format": "google-datetime", + "readOnly": true, "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaAnswerStepActionSearchAction": { - "description": "Search action.", - "id": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionSearchAction", + "GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfig": { + "description": "Configurations for a Chat Engine.", + "id": "GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfig", "properties": { - "query": { - "description": "The query to search.", + "agentCreationConfig": { + "$ref": "GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfigAgentCreationConfig", + "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." + }, + "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" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSiteMetadata": { - "description": "Metadata related to the progress of the SiteSearchEngineService.BatchCreateTargetSites operation. This will be returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSiteMetadata", + "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.", + "id": "GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfigAgentCreationConfig", "properties": { - "createTime": { - "description": "Operation create time.", - "format": "google-datetime", + "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" }, - "updateTime": { - "description": "Operation last update time. If the operation is done, this is also the finish time.", - "format": "google-datetime", + "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" + }, + "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" + }, + "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" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSitesResponse": { - "description": "Response message for SiteSearchEngineService.BatchCreateTargetSites method.", - "id": "GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSitesResponse", + "GoogleCloudDiscoveryengineV1alphaEngineChatEngineMetadata": { + "description": "Additional information of a Chat Engine. Fields in this message are output only.", + "id": "GoogleCloudDiscoveryengineV1alphaEngineChatEngineMetadata", "properties": { - "targetSites": { - "description": "TargetSites created.", - "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaTargetSite" - }, - "type": "array" + "dialogflowAgent": { + "description": "The resource name of a Dialogflow agent, that this Chat Engine refers to. Format: `projects//locations//agents/`.", + "type": "string" } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1alphaCondition": { - "description": "Defines circumstances to be checked before allowing a behavior", - "id": "GoogleCloudDiscoveryengineV1alphaCondition", - "properties": { - "activeTimeRange": { - "description": "Range of time(s) specifying when condition is active. Maximum of 10 time ranges.", - "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaConditionTimeRange" - }, - "type": "array" - }, - "queryTerms": { - "description": "Search only A list of terms to match the query on. Maximum of 10 query terms.", - "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaConditionQueryTerm" - }, - "type": "array" + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaEngineCommonConfig": { + "description": "Common configurations for an Engine.", + "id": "GoogleCloudDiscoveryengineV1alphaEngineCommonConfig", + "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" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaConditionQueryTerm": { - "description": "Matcher for search request query", - "id": "GoogleCloudDiscoveryengineV1alphaConditionQueryTerm", + "GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfig": { + "description": "Additional config specs for a Media Recommendation engine.", + "id": "GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfig", "properties": { - "fullMatch": { - "description": "Whether the search query needs to exactly match the query term.", - "type": "boolean" + "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" }, - "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.", + "optimizationObjectiveConfig": { + "$ref": "GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigOptimizationObjectiveConfig", + "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)." + }, + "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.", + "enum": [ + "TRAINING_STATE_UNSPECIFIED", + "PAUSED", + "TRAINING" + ], + "enumDescriptions": [ + "Unspecified training state.", + "The engine training is paused.", + "The engine is training." + ], + "type": "string" + }, + "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" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaConditionTimeRange": { - "description": "Used for time-dependent conditions.", - "id": "GoogleCloudDiscoveryengineV1alphaConditionTimeRange", + "GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigOptimizationObjectiveConfig": { + "description": "Custom threshold for `cvr` optimization_objective.", + "id": "GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigOptimizationObjectiveConfig", "properties": { - "endTime": { - "description": "End of time range. Range is inclusive. Must be in the future.", - "format": "google-datetime", + "targetField": { + "description": "Required. The name of the field to target. Currently supported values: `watch-percentage`, `watch-time`.", "type": "string" }, - "startTime": { - "description": "Start of time range. Range is inclusive.", - "format": "google-datetime", - "type": "string" + "targetFieldValueFloat": { + "description": "Required. The threshold to be applied to the target (e.g., 0.5).", + "format": "float", + "type": "number" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaControl": { - "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`.", - "id": "GoogleCloudDiscoveryengineV1alphaControl", + "GoogleCloudDiscoveryengineV1alphaEngineRecommendationMetadata": { + "description": "Additional information of a recommendation engine.", + "id": "GoogleCloudDiscoveryengineV1alphaEngineRecommendationMetadata", "properties": { - "associatedServingConfigIds": { - "description": "Output only. List of all ServingConfig ids this control is attached to. May take up to 10 minutes to update after changes.", - "items": { - "type": "string" - }, + "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.", + "enum": [ + "DATA_STATE_UNSPECIFIED", + "DATA_OK", + "DATA_ERROR" + ], + "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." + ], "readOnly": true, - "type": "array" - }, - "boostAction": { - "$ref": "GoogleCloudDiscoveryengineV1alphaControlBoostAction", - "description": "Defines a boost-type control" - }, - "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.", - "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaCondition" - }, - "type": "array" - }, - "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" }, - "filterAction": { - "$ref": "GoogleCloudDiscoveryengineV1alphaControlFilterAction", - "description": "Defines a filter-type control Currently not supported by Recommendation" - }, - "name": { - "description": "Immutable. Fully qualified name `projects/*/locations/global/dataStore/*/controls/*`", + "lastTuneTime": { + "description": "Output only. The timestamp when the latest successful tune finished. Only applicable on Media Recommendation engines.", + "format": "google-datetime", + "readOnly": true, "type": "string" }, - "redirectAction": { - "$ref": "GoogleCloudDiscoveryengineV1alphaControlRedirectAction", - "description": "Defines a redirect-type control." - }, - "solutionType": { - "description": "Required. Immutable. What solution the control belongs to. Must be compatible with vertical of resource. Otherwise an INVALID ARGUMENT error is thrown.", + "servingState": { + "description": "Output only. The serving state of the engine: `ACTIVE`, `NOT_ACTIVE`.", "enum": [ - "SOLUTION_TYPE_UNSPECIFIED", - "SOLUTION_TYPE_RECOMMENDATION", - "SOLUTION_TYPE_SEARCH", - "SOLUTION_TYPE_CHAT", - "SOLUTION_TYPE_GENERATIVE_CHAT" + "SERVING_STATE_UNSPECIFIED", + "INACTIVE", + "ACTIVE", + "TUNED" ], "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." + "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." ], + "readOnly": true, "type": "string" }, - "synonymsAction": { - "$ref": "GoogleCloudDiscoveryengineV1alphaControlSynonymsAction", - "description": "Treats a group of terms as synonyms of one another." - }, - "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.", + "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" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaEngineSearchEngineConfig": { + "description": "Configurations for a Search Engine.", + "id": "GoogleCloudDiscoveryengineV1alphaEngineSearchEngineConfig", + "properties": { + "searchAddOns": { + "description": "The add-on that this search engine enables.", "items": { "enum": [ - "SEARCH_USE_CASE_UNSPECIFIED", - "SEARCH_USE_CASE_SEARCH", - "SEARCH_USE_CASE_BROWSE" + "SEARCH_ADD_ON_UNSPECIFIED", + "SEARCH_ADD_ON_LLM" ], "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." + "Default value when the enum is unspecified. This is invalid to use.", + "Large language model add-on." ], "type": "string" }, "type": "array" + }, + "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.", + "enum": [ + "SEARCH_TIER_UNSPECIFIED", + "SEARCH_TIER_STANDARD", + "SEARCH_TIER_ENTERPRISE" + ], + "enumDescriptions": [ + "Default value when the enum is unspecified. This is invalid to use.", + "Standard tier.", + "Enterprise tier." + ], + "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaControlBoostAction": { - "description": "Adjusts order of products in returned list.", - "id": "GoogleCloudDiscoveryengineV1alphaControlBoostAction", + "GoogleCloudDiscoveryengineV1alphaEngineSimilarDocumentsEngineConfig": { + "description": "Additional config specs for a `similar-items` engine.", + "id": "GoogleCloudDiscoveryengineV1alphaEngineSimilarDocumentsEngineConfig", + "properties": {}, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaEstimateDataSizeMetadata": { + "description": "Metadata related to the progress of the EstimateDataSize operation. This is returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1alphaEstimateDataSizeMetadata", "properties": { - "boost": { - "description": "Required. Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0 (No-op).", - "format": "float", - "type": "number" - }, - "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" - }, - "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.", + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaControlFilterAction": { - "description": "Specified which products may be included in results. Uses same filter as boost.", - "id": "GoogleCloudDiscoveryengineV1alphaControlFilterAction", + "GoogleCloudDiscoveryengineV1alphaEstimateDataSizeResponse": { + "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.", + "id": "GoogleCloudDiscoveryengineV1alphaEstimateDataSizeResponse", "properties": { - "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", + "dataSizeBytes": { + "description": "Data size in terms of bytes.", + "format": "int64", "type": "string" }, - "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.", + "documentCount": { + "description": "Total number of documents.", + "format": "int64", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaControlRedirectAction": { - "description": "Redirects a shopper to the provided URI.", - "id": "GoogleCloudDiscoveryengineV1alphaControlRedirectAction", + "GoogleCloudDiscoveryengineV1alphaEvaluation": { + "description": "An evaluation is a single execution (or run) of an evaluation process. It encapsulates the state of the evaluation and the resulting data.", + "id": "GoogleCloudDiscoveryengineV1alphaEvaluation", "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.", + "createTime": { + "description": "Output only. Timestamp the Evaluation was created at.", + "format": "google-datetime", + "readOnly": true, "type": "string" - } - }, - "type": "object" - }, - "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\".", - "id": "GoogleCloudDiscoveryengineV1alphaControlSynonymsAction", - "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.", + }, + "endTime": { + "description": "Output only. Timestamp the Evaluation was completed at.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "error": { + "$ref": "GoogleRpcStatus", + "description": "Output only. The error that occurred during evaluation. Only populated when the evaluation's state is FAILED.", + "readOnly": true + }, + "errorSamples": { + "description": "Output only. A sample of errors encountered while processing the request.", "items": { - "type": "string" + "$ref": "GoogleRpcStatus" }, + "readOnly": true, "type": "array" + }, + "evaluationSpec": { + "$ref": "GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpec", + "description": "Required. The specification of the evaluation." + }, + "name": { + "description": "Immutable. 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" + }, + "qualityMetrics": { + "$ref": "GoogleCloudDiscoveryengineV1alphaQualityMetrics", + "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 + }, + "state": { + "description": "Output only. The state of the evaluation.", + "enum": [ + "STATE_UNSPECIFIED", + "PENDING", + "RUNNING", + "SUCCEEDED", + "FAILED" + ], + "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." + ], + "readOnly": true, + "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaCreateDataStoreMetadata": { - "description": "Metadata related to the progress of the DataStoreService.CreateDataStore operation. This will be returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1alphaCreateDataStoreMetadata", + "GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpec": { + "description": "Describes the specification of the evaluation.", + "id": "GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpec", "properties": { - "createTime": { - "description": "Operation create time.", - "format": "google-datetime", - "type": "string" + "querySetSpec": { + "$ref": "GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpecQuerySetSpec", + "description": "Required. The specification of the query set." }, - "updateTime": { - "description": "Operation last update time. If the operation is done, this is also the finish time.", - "format": "google-datetime", - "type": "string" + "searchRequest": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequest", + "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" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaCreateEngineMetadata": { - "description": "Metadata related to the progress of the EngineService.CreateEngine operation. This will be returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1alphaCreateEngineMetadata", + "GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpecQuerySetSpec": { + "description": "Describes the specification of the query set.", + "id": "GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpecQuerySetSpec", "properties": { - "createTime": { - "description": "Operation create time.", - "format": "google-datetime", - "type": "string" - }, - "updateTime": { - "description": "Operation last update time. If the operation is done, this is also the finish time.", - "format": "google-datetime", + "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" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaCreateSchemaMetadata": { - "description": "Metadata for Create Schema LRO.", - "id": "GoogleCloudDiscoveryengineV1alphaCreateSchemaMetadata", + "GoogleCloudDiscoveryengineV1alphaExportUserEventsMetadata": { + "description": "Metadata related to the progress of the Export operation. This is returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1alphaExportUserEventsMetadata", "properties": { "createTime": { "description": "Operation create time.", @@ -8353,248 +9741,243 @@ }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaCreateTargetSiteMetadata": { - "description": "Metadata related to the progress of the SiteSearchEngineService.CreateTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1alphaCreateTargetSiteMetadata", + "GoogleCloudDiscoveryengineV1alphaExportUserEventsResponse": { + "description": "Response of the ExportUserEventsRequest. If the long running operation was successful, then this message is returned by the google.longrunning.Operations.response field.", + "id": "GoogleCloudDiscoveryengineV1alphaExportUserEventsResponse", "properties": { - "createTime": { - "description": "Operation create time.", - "format": "google-datetime", - "type": "string" + "outputResult": { + "$ref": "GoogleCloudDiscoveryengineV1alphaOutputResult", + "description": "Output result indicating where the data were exported to." }, - "updateTime": { - "description": "Operation last update time. If the operation is done, this is also the finish time.", - "format": "google-datetime", - "type": "string" + "status": { + "$ref": "GoogleRpcStatus", + "description": "The status of the export operation." } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaCustomTuningModel": { - "description": "Metadata that describes a custom tuned model.", - "id": "GoogleCloudDiscoveryengineV1alphaCustomTuningModel", + "GoogleCloudDiscoveryengineV1alphaFieldConfig": { + "description": "Configurations for fields of a schema. For example, configuring a field is indexable, or searchable.", + "id": "GoogleCloudDiscoveryengineV1alphaFieldConfig", "properties": { - "createTime": { - "description": "Timestamp the Model was created at.", - "format": "google-datetime", - "type": "string" - }, - "displayName": { - "description": "The display name of the model.", - "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 ``.", + "items": { + "enum": [ + "ADVANCED_SITE_SEARCH_DATA_SOURCE_UNSPECIFIED", + "METATAGS", + "PAGEMAP", + "SCHEMA_ORG" + ], + "enumDescriptions": [ + "Value used when unset.", + "Retrieve value from meta tag.", + "Retrieve value from page map.", + "Retrieve value from schema.org data." + ], + "type": "string" + }, + "type": "array" }, - "modelState": { - "description": "The state that the model is in (e.g.`TRAINING` or `TRAINING_FAILED`).", + "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.", "enum": [ - "MODEL_STATE_UNSPECIFIED", - "TRAINING_PAUSED", - "TRAINING", - "TRAINING_COMPLETE", - "READY_FOR_SERVING", - "TRAINING_FAILED" + "COMPLETABLE_OPTION_UNSPECIFIED", + "COMPLETABLE_ENABLED", + "COMPLETABLE_DISABLED" ], "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." + "Value used when unset.", + "Completable option enabled for a schema field.", + "Completable option disabled for a schema field." ], "type": "string" }, - "modelVersion": { - "description": "The version of the model.", - "format": "int64", - "type": "string" - }, - "name": { - "description": "Required. The fully qualified resource name of the model. Format: `projects/{project_number}/locations/{location}/collections/{collection}/dataStores/{data_store}/customTuningModels/{custom_tuning_model}` model must be an alpha-numerical string with limit of 40 characters.", + "dynamicFacetableOption": { + "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.", + "enum": [ + "DYNAMIC_FACETABLE_OPTION_UNSPECIFIED", + "DYNAMIC_FACETABLE_ENABLED", + "DYNAMIC_FACETABLE_DISABLED" + ], + "enumDescriptions": [ + "Value used when unset.", + "Dynamic facetable option enabled for a schema field.", + "Dynamic facetable option disabled for a schema field." + ], "type": "string" }, - "trainingStartTime": { - "description": "Timestamp the model training was initiated.", - "format": "google-datetime", + "fieldPath": { + "description": "Required. Field path of the schema field. For example: `title`, `description`, `release_info.release_year`.", "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1alphaDataStore": { - "description": "DataStore captures global settings and configs at the DataStore level.", - "id": "GoogleCloudDiscoveryengineV1alphaDataStore", - "properties": { - "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" }, - "contentConfig": { - "description": "Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT.", + "fieldType": { + "description": "Output only. Raw type of the field.", "enum": [ - "CONTENT_CONFIG_UNSPECIFIED", - "NO_CONTENT", - "CONTENT_REQUIRED", - "PUBLIC_WEBSITE" + "FIELD_TYPE_UNSPECIFIED", + "OBJECT", + "STRING", + "NUMBER", + "INTEGER", + "BOOLEAN", + "GEOLOCATION", + "DATETIME" ], "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." + "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\"`" ], - "type": "string" - }, - "createTime": { - "description": "Output only. Timestamp the DataStore was created at.", - "format": "google-datetime", "readOnly": true, "type": "string" }, - "defaultSchemaId": { - "description": "Output only. The id of the default Schema asscociated to this data store.", - "readOnly": true, + "indexableOption": { + "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.", + "enum": [ + "INDEXABLE_OPTION_UNSPECIFIED", + "INDEXABLE_ENABLED", + "INDEXABLE_DISABLED" + ], + "enumDescriptions": [ + "Value used when unset.", + "Indexable option enabled for a schema field.", + "Indexable option disabled for a schema field." + ], "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.", + "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" }, - "documentProcessingConfig": { - "$ref": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig", - "description": "Configuration for Document understanding and enrichment." - }, - "idpConfig": { - "$ref": "GoogleCloudDiscoveryengineV1alphaIdpConfig", - "description": "Output only. Data store level identity provider config.", - "readOnly": true - }, - "industryVertical": { - "description": "Immutable. The industry vertical that the data store registers.", + "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.", "enum": [ - "INDUSTRY_VERTICAL_UNSPECIFIED", - "GENERIC", - "MEDIA", - "HEALTHCARE_FHIR" + "FILTERABLE_OPTION_UNSPECIFIED", + "FILTERABLE_ENABLED", + "FILTERABLE_DISABLED" ], "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." + "Filterable option enabled for a schema field.", + "Filterable option disabled for a schema field." ], "type": "string" }, - "languageInfo": { - "$ref": "GoogleCloudDiscoveryengineV1alphaLanguageInfo", - "description": "Language info for DataStore." - }, - "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.", + "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.", + "enum": [ + "RETRIEVABLE_OPTION_UNSPECIFIED", + "RETRIEVABLE_ENABLED", + "RETRIEVABLE_DISABLED" + ], + "enumDescriptions": [ + "Value used when unset.", + "Retrievable option enabled for a schema field.", + "Retrievable option disabled for a schema field." + ], "type": "string" - }, - "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.", - "items": { - "enum": [ - "SOLUTION_TYPE_UNSPECIFIED", - "SOLUTION_TYPE_RECOMMENDATION", - "SOLUTION_TYPE_SEARCH", - "SOLUTION_TYPE_CHAT", - "SOLUTION_TYPE_GENERATIVE_CHAT" - ], - "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." - ], + }, + "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", + "items": { "type": "string" }, "type": "array" }, - "startingSchema": { - "$ref": "GoogleCloudDiscoveryengineV1alphaSchema", - "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)." + "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.", + "enum": [ + "SEARCHABLE_OPTION_UNSPECIFIED", + "SEARCHABLE_ENABLED", + "SEARCHABLE_DISABLED" + ], + "enumDescriptions": [ + "Value used when unset.", + "Searchable option enabled for a schema field.", + "Searchable option disabled for a schema field." + ], + "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaDeleteDataStoreMetadata": { - "description": "Metadata related to the progress of the DataStoreService.DeleteDataStore operation. This will be returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1alphaDeleteDataStoreMetadata", + "GoogleCloudDiscoveryengineV1alphaGetUriPatternDocumentDataResponse": { + "description": "Response message for SiteSearchEngineService.GetUriPatternDocumentData method.", + "id": "GoogleCloudDiscoveryengineV1alphaGetUriPatternDocumentDataResponse", "properties": { - "createTime": { - "description": "Operation create time.", - "format": "google-datetime", - "type": "string" - }, - "updateTime": { - "description": "Operation last update time. If the operation is done, this is also the finish time.", - "format": "google-datetime", - "type": "string" + "documentDataMap": { + "additionalProperties": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "type": "object" + }, + "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" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaDeleteEngineMetadata": { - "description": "Metadata related to the progress of the EngineService.DeleteEngine operation. This will be returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1alphaDeleteEngineMetadata", + "GoogleCloudDiscoveryengineV1alphaIdpConfig": { + "description": "Identity Provider Config.", + "id": "GoogleCloudDiscoveryengineV1alphaIdpConfig", "properties": { - "createTime": { - "description": "Operation create time.", - "format": "google-datetime", - "type": "string" + "externalIdpConfig": { + "$ref": "GoogleCloudDiscoveryengineV1alphaIdpConfigExternalIdpConfig", + "description": "External Identity provider config." }, - "updateTime": { - "description": "Operation last update time. If the operation is done, this is also the finish time.", - "format": "google-datetime", + "idpType": { + "description": "Identity provider type configured.", + "enum": [ + "IDP_TYPE_UNSPECIFIED", + "GSUITE", + "THIRD_PARTY" + ], + "enumDescriptions": [ + "Default value. ACL search not enabled.", + "Google 1P provider.", + "Third party provider." + ], "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaDeleteSchemaMetadata": { - "description": "Metadata for DeleteSchema LRO.", - "id": "GoogleCloudDiscoveryengineV1alphaDeleteSchemaMetadata", + "GoogleCloudDiscoveryengineV1alphaIdpConfigExternalIdpConfig": { + "description": "Third party IDP Config.", + "id": "GoogleCloudDiscoveryengineV1alphaIdpConfigExternalIdpConfig", "properties": { - "createTime": { - "description": "Operation create time.", - "format": "google-datetime", - "type": "string" - }, - "updateTime": { - "description": "Operation last update time. If the operation is done, this is also the finish time.", - "format": "google-datetime", + "workforcePoolName": { + "description": "Workforce pool name. Example: \"locations/global/workforcePools/pool_id\"", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaDeleteTargetSiteMetadata": { - "description": "Metadata related to the progress of the SiteSearchEngineService.DeleteTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1alphaDeleteTargetSiteMetadata", + "GoogleCloudDiscoveryengineV1alphaImportCompletionSuggestionsMetadata": { + "description": "Metadata related to the progress of the ImportCompletionSuggestions operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1alphaImportCompletionSuggestionsMetadata", "properties": { "createTime": { "description": "Operation create time.", "format": "google-datetime", "type": "string" }, - "updateTime": { - "description": "Operation last update time. If the operation is done, this is also the finish time.", - "format": "google-datetime", + "failureCount": { + "description": "Count of CompletionSuggestions that failed to be imported.", + "format": "int64", "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1alphaDisableAdvancedSiteSearchMetadata": { - "description": "Metadata related to the progress of the SiteSearchEngineService.DisableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1alphaDisableAdvancedSiteSearchMetadata", - "properties": { - "createTime": { - "description": "Operation create time.", - "format": "google-datetime", + }, + "successCount": { + "description": "Count of CompletionSuggestions successfully imported.", + "format": "int64", "type": "string" }, "updateTime": { @@ -8605,656 +9988,441 @@ }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaDisableAdvancedSiteSearchResponse": { - "description": "Response message for SiteSearchEngineService.DisableAdvancedSiteSearch method.", - "id": "GoogleCloudDiscoveryengineV1alphaDisableAdvancedSiteSearchResponse", - "properties": {}, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig": { - "description": "A singleton resource of DataStore. It's empty when DataStore is created, which defaults to digital parser. The first call to DataStoreService.UpdateDocumentProcessingConfig method will initialize the config.", - "id": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig", + "GoogleCloudDiscoveryengineV1alphaImportCompletionSuggestionsResponse": { + "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.", + "id": "GoogleCloudDiscoveryengineV1alphaImportCompletionSuggestionsResponse", "properties": { - "chunkingConfig": { - "$ref": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfig", - "description": "Whether chunking mode is enabled." - }, - "defaultParsingConfig": { - "$ref": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfig", - "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." - }, - "name": { - "description": "The full resource name of the Document Processing Config. Format: `projects/*/locations/*/collections/*/dataStores/*/documentProcessingConfig`.", - "type": "string" + "errorConfig": { + "$ref": "GoogleCloudDiscoveryengineV1alphaImportErrorConfig", + "description": "The desired location of errors incurred during the Import." }, - "parsingConfigOverrides": { - "additionalProperties": { - "$ref": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfig" + "errorSamples": { + "description": "A sample of errors encountered while processing the request.", + "items": { + "$ref": "GoogleRpcStatus" }, - "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 or layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and or layout parsing are supported.", - "type": "object" - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfig": { - "description": "Configuration for chunking config.", - "id": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfig", - "properties": { - "layoutBasedChunkingConfig": { - "$ref": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig", - "description": "Configuration for the layout based chunking." + "type": "array" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig": { - "description": "Configuration for the layout based chunking.", - "id": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig", + "GoogleCloudDiscoveryengineV1alphaImportDocumentsMetadata": { + "description": "Metadata related to the progress of the ImportDocuments operation. This is returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1alphaImportDocumentsMetadata", "properties": { - "chunkSize": { - "description": "The token size limit for each chunk. Supported values: 100-500 (inclusive). Default value: 500.", - "format": "int32", - "type": "integer" + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", + "type": "string" }, - "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" - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfig": { - "description": "Related configurations applied to a specific type of document parser.", - "id": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfig", - "properties": { - "digitalParsingConfig": { - "$ref": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigDigitalParsingConfig", - "description": "Configurations applied to digital parser." + "failureCount": { + "description": "Count of entries that encountered errors while processing.", + "format": "int64", + "type": "string" }, - "layoutParsingConfig": { - "$ref": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigLayoutParsingConfig", - "description": "Configurations applied to layout parser." + "successCount": { + "description": "Count of entries that were processed successfully.", + "format": "int64", + "type": "string" }, - "ocrParsingConfig": { - "$ref": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigOcrParsingConfig", - "description": "Configurations applied to OCR parser. Currently it only applies to PDFs." + "totalCount": { + "description": "Total count of entries that were processed.", + "format": "int64", + "type": "string" + }, + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", + "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigDigitalParsingConfig": { - "description": "The digital parsing configurations for documents.", - "id": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigDigitalParsingConfig", - "properties": {}, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigLayoutParsingConfig": { - "description": "The layout parsing configurations for documents.", - "id": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigLayoutParsingConfig", - "properties": {}, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigOcrParsingConfig": { - "description": "The OCR parsing configurations for documents.", - "id": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigOcrParsingConfig", + "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.", + "id": "GoogleCloudDiscoveryengineV1alphaImportDocumentsResponse", "properties": { - "enhancedDocumentElements": { - "deprecated": true, - "description": "[DEPRECATED] This field is deprecated. To use the additional enhanced document elements processing, please switch to `layout_parsing_config`.", + "errorConfig": { + "$ref": "GoogleCloudDiscoveryengineV1alphaImportErrorConfig", + "description": "Echoes the destination for the complete errors in the request if set." + }, + "errorSamples": { + "description": "A sample of errors encountered while processing the request.", "items": { - "type": "string" + "$ref": "GoogleRpcStatus" }, "type": "array" - }, - "useNativeText": { - "description": "If true, will use native text instead of OCR text on pages containing native text.", - "type": "boolean" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaEnableAdvancedSiteSearchMetadata": { - "description": "Metadata related to the progress of the SiteSearchEngineService.EnableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1alphaEnableAdvancedSiteSearchMetadata", + "GoogleCloudDiscoveryengineV1alphaImportErrorConfig": { + "description": "Configuration of destination for Import related errors.", + "id": "GoogleCloudDiscoveryengineV1alphaImportErrorConfig", "properties": { - "createTime": { - "description": "Operation create time.", - "format": "google-datetime", - "type": "string" - }, - "updateTime": { - "description": "Operation last update time. If the operation is done, this is also the finish time.", - "format": "google-datetime", + "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" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaEnableAdvancedSiteSearchResponse": { - "description": "Response message for SiteSearchEngineService.EnableAdvancedSiteSearch method.", - "id": "GoogleCloudDiscoveryengineV1alphaEnableAdvancedSiteSearchResponse", - "properties": {}, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1alphaEngine": { - "description": "Metadata that describes the training and serving parameters of an Engine.", - "id": "GoogleCloudDiscoveryengineV1alphaEngine", + "GoogleCloudDiscoveryengineV1alphaImportSampleQueriesMetadata": { + "description": "Metadata related to the progress of the ImportSampleQueries operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1alphaImportSampleQueriesMetadata", "properties": { - "chatEngineConfig": { - "$ref": "GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfig", - "description": "Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT." - }, - "chatEngineMetadata": { - "$ref": "GoogleCloudDiscoveryengineV1alphaEngineChatEngineMetadata", - "description": "Output only. Additional information of the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.", - "readOnly": true - }, - "commonConfig": { - "$ref": "GoogleCloudDiscoveryengineV1alphaEngineCommonConfig", - "description": "Common config spec that specifies the metadata of the engine." - }, "createTime": { - "description": "Output only. Timestamp the Recommendation Engine was created at.", + "description": "ImportSampleQueries operation create time.", "format": "google-datetime", - "readOnly": true, - "type": "string" - }, - "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.", - "items": { - "type": "string" - }, - "type": "array" - }, - "displayName": { - "description": "Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters.", "type": "string" }, - "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.", - "enum": [ - "INDUSTRY_VERTICAL_UNSPECIFIED", - "GENERIC", - "MEDIA", - "HEALTHCARE_FHIR" - ], - "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." - ], + "failureCount": { + "description": "Count of SampleQuerys that failed to be imported.", + "format": "int64", "type": "string" }, - "mediaRecommendationEngineConfig": { - "$ref": "GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfig", - "description": "Configurations for the Media Engine. Only applicable on the data stores with solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical." - }, - "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_number}/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.", + "successCount": { + "description": "Count of SampleQuerys successfully imported.", + "format": "int64", "type": "string" }, - "recommendationMetadata": { - "$ref": "GoogleCloudDiscoveryengineV1alphaEngineRecommendationMetadata", - "description": "Output only. Additional information of a recommendation engine. Only applicable if solution_type is SOLUTION_TYPE_RECOMMENDATION.", - "readOnly": true - }, - "searchEngineConfig": { - "$ref": "GoogleCloudDiscoveryengineV1alphaEngineSearchEngineConfig", - "description": "Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH." - }, - "similarDocumentsConfig": { - "$ref": "GoogleCloudDiscoveryengineV1alphaEngineSimilarDocumentsEngineConfig", - "description": "Additional config specs for a `similar-items` engine." - }, - "solutionType": { - "description": "Required. The solutions of the engine.", - "enum": [ - "SOLUTION_TYPE_UNSPECIFIED", - "SOLUTION_TYPE_RECOMMENDATION", - "SOLUTION_TYPE_SEARCH", - "SOLUTION_TYPE_CHAT", - "SOLUTION_TYPE_GENERATIVE_CHAT" - ], - "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." - ], + "totalCount": { + "description": "Total count of SampleQuerys that were processed.", + "format": "int64", "type": "string" }, "updateTime": { - "description": "Output only. Timestamp the Recommendation Engine was last updated.", + "description": "ImportSampleQueries operation last update time. If the operation is done, this is also the finish time.", "format": "google-datetime", - "readOnly": true, "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfig": { - "description": "Configurations for a Chat Engine.", - "id": "GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfig", + "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.", + "id": "GoogleCloudDiscoveryengineV1alphaImportSampleQueriesResponse", "properties": { - "agentCreationConfig": { - "$ref": "GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfigAgentCreationConfig", - "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." + "errorConfig": { + "$ref": "GoogleCloudDiscoveryengineV1alphaImportErrorConfig", + "description": "The desired location of errors incurred during the Import." }, - "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" + "errorSamples": { + "description": "A sample of errors encountered while processing the request.", + "items": { + "$ref": "GoogleRpcStatus" + }, + "type": "array" } }, "type": "object" }, - "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.", - "id": "GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfigAgentCreationConfig", + "GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesMetadata": { + "description": "Metadata related to the progress of the ImportSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesMetadata", "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" - }, - "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.", + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", "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.", + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaEngineChatEngineMetadata": { - "description": "Additional information of a Chat Engine. Fields in this message are output only.", - "id": "GoogleCloudDiscoveryengineV1alphaEngineChatEngineMetadata", + "GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesResponse": { + "description": "Response message for CompletionService.ImportSuggestionDenyListEntries method.", + "id": "GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesResponse", "properties": { - "dialogflowAgent": { - "description": "The resource name of a Dialogflow agent, that this Chat Engine refers to. Format: `projects//locations//agents/`.", + "errorSamples": { + "description": "A sample of errors encountered while processing the request.", + "items": { + "$ref": "GoogleRpcStatus" + }, + "type": "array" + }, + "failedEntriesCount": { + "description": "Count of deny list entries that failed to be imported.", + "format": "int64", + "type": "string" + }, + "importedEntriesCount": { + "description": "Count of deny list entries successfully imported.", + "format": "int64", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaEngineCommonConfig": { - "description": "Common configurations for an Engine.", - "id": "GoogleCloudDiscoveryengineV1alphaEngineCommonConfig", + "GoogleCloudDiscoveryengineV1alphaImportUserEventsMetadata": { + "description": "Metadata related to the progress of the Import operation. This is returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1alphaImportUserEventsMetadata", "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.", + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", + "type": "string" + }, + "failureCount": { + "description": "Count of entries that encountered errors while processing.", + "format": "int64", + "type": "string" + }, + "successCount": { + "description": "Count of entries that were processed successfully.", + "format": "int64", + "type": "string" + }, + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfig": { - "description": "Additional config specs for a Media Recommendation engine.", - "id": "GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfig", + "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.", + "id": "GoogleCloudDiscoveryengineV1alphaImportUserEventsResponse", "properties": { - "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" + "errorConfig": { + "$ref": "GoogleCloudDiscoveryengineV1alphaImportErrorConfig", + "description": "Echoes the destination for the complete errors if this field was set in the request." }, - "optimizationObjectiveConfig": { - "$ref": "GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigOptimizationObjectiveConfig", - "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)." + "errorSamples": { + "description": "A sample of errors encountered while processing the request.", + "items": { + "$ref": "GoogleRpcStatus" + }, + "type": "array" }, - "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.", - "enum": [ - "TRAINING_STATE_UNSPECIFIED", - "PAUSED", - "TRAINING" - ], - "enumDescriptions": [ - "Unspecified training state.", - "The engine training is paused.", - "The engine is training." - ], + "joinedEventsCount": { + "description": "Count of user events imported with complete existing Documents.", + "format": "int64", "type": "string" }, - "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`.", + "unjoinedEventsCount": { + "description": "Count of user events imported, but with Document information not found in the existing Branch.", + "format": "int64", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigOptimizationObjectiveConfig": { - "description": "Custom threshold for `cvr` optimization_objective.", - "id": "GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigOptimizationObjectiveConfig", + "GoogleCloudDiscoveryengineV1alphaInterval": { + "description": "A floating point interval.", + "id": "GoogleCloudDiscoveryengineV1alphaInterval", "properties": { - "targetField": { - "description": "Required. The name of the field to target. Currently supported values: `watch-percentage`, `watch-time`.", - "type": "string" + "exclusiveMaximum": { + "description": "Exclusive upper bound.", + "format": "double", + "type": "number" }, - "targetFieldValueFloat": { - "description": "Required. The threshold to be applied to the target (e.g., 0.5).", - "format": "float", + "exclusiveMinimum": { + "description": "Exclusive lower bound.", + "format": "double", + "type": "number" + }, + "maximum": { + "description": "Inclusive upper bound.", + "format": "double", + "type": "number" + }, + "minimum": { + "description": "Inclusive lower bound.", + "format": "double", "type": "number" } }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1alphaEngineRecommendationMetadata": { - "description": "Additional information of a recommendation engine.", - "id": "GoogleCloudDiscoveryengineV1alphaEngineRecommendationMetadata", + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaLanguageInfo": { + "description": "Language info for DataStore.", + "id": "GoogleCloudDiscoveryengineV1alphaLanguageInfo", "properties": { - "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.", - "enum": [ - "DATA_STATE_UNSPECIFIED", - "DATA_OK", - "DATA_ERROR" - ], - "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." - ], + "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" }, - "lastTuneTime": { - "description": "Output only. The timestamp when the latest successful tune finished. Only applicable on Media Recommendation engines.", - "format": "google-datetime", - "readOnly": true, + "languageCode": { + "description": "The language code for the DataStore.", "type": "string" }, - "servingState": { - "description": "Output only. The serving state of the engine: `ACTIVE`, `NOT_ACTIVE`.", - "enum": [ - "SERVING_STATE_UNSPECIFIED", - "INACTIVE", - "ACTIVE", - "TUNED" - ], - "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." - ], + "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" }, - "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.", + "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" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaEngineSearchEngineConfig": { - "description": "Configurations for a Search Engine.", - "id": "GoogleCloudDiscoveryengineV1alphaEngineSearchEngineConfig", + "GoogleCloudDiscoveryengineV1alphaListCustomModelsResponse": { + "description": "Response message for SearchTuningService.ListCustomModels method.", + "id": "GoogleCloudDiscoveryengineV1alphaListCustomModelsResponse", "properties": { - "searchAddOns": { - "description": "The add-on that this search engine enables.", + "models": { + "description": "List of custom tuning models.", "items": { - "enum": [ - "SEARCH_ADD_ON_UNSPECIFIED", - "SEARCH_ADD_ON_LLM" - ], - "enumDescriptions": [ - "Default value when the enum is unspecified. This is invalid to use.", - "Large language model add-on." - ], - "type": "string" + "$ref": "GoogleCloudDiscoveryengineV1alphaCustomTuningModel" }, "type": "array" - }, - "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.", - "enum": [ - "SEARCH_TIER_UNSPECIFIED", - "SEARCH_TIER_STANDARD", - "SEARCH_TIER_ENTERPRISE" - ], - "enumDescriptions": [ - "Default value when the enum is unspecified. This is invalid to use.", - "Standard tier.", - "Enterprise tier." - ], - "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaEngineSimilarDocumentsEngineConfig": { - "description": "Additional config specs for a `similar-items` engine.", - "id": "GoogleCloudDiscoveryengineV1alphaEngineSimilarDocumentsEngineConfig", - "properties": {}, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1alphaEstimateDataSizeMetadata": { - "description": "Metadata related to the progress of the EstimateDataSize operation. This is returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1alphaEstimateDataSizeMetadata", + "GoogleCloudDiscoveryengineV1alphaOutputResult": { + "description": "Output result that stores the information about where the exported data is stored.", + "id": "GoogleCloudDiscoveryengineV1alphaOutputResult", "properties": { - "createTime": { - "description": "Operation create time.", - "format": "google-datetime", - "type": "string" + "bigqueryResult": { + "$ref": "GoogleCloudDiscoveryengineV1alphaOutputResultBigQueryOutputResult", + "description": "The BigQuery location where the result is stored." } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaEstimateDataSizeResponse": { - "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.", - "id": "GoogleCloudDiscoveryengineV1alphaEstimateDataSizeResponse", + "GoogleCloudDiscoveryengineV1alphaOutputResultBigQueryOutputResult": { + "description": "A BigQuery output result.", + "id": "GoogleCloudDiscoveryengineV1alphaOutputResultBigQueryOutputResult", "properties": { - "dataSizeBytes": { - "description": "Data size in terms of bytes.", - "format": "int64", + "datasetId": { + "description": "The ID of a BigQuery Dataset.", "type": "string" }, - "documentCount": { - "description": "Total number of documents.", - "format": "int64", + "tableId": { + "description": "The ID of a BigQuery Table.", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaFieldConfig": { - "description": "Configurations for fields of a schema. For example, configuring a field is indexable, or searchable.", - "id": "GoogleCloudDiscoveryengineV1alphaFieldConfig", + "GoogleCloudDiscoveryengineV1alphaProject": { + "description": "Metadata and configurations for a Google Cloud project in the service.", + "id": "GoogleCloudDiscoveryengineV1alphaProject", "properties": { - "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 ``.", - "items": { - "enum": [ - "ADVANCED_SITE_SEARCH_DATA_SOURCE_UNSPECIFIED", - "METATAGS", - "PAGEMAP", - "SCHEMA_ORG" - ], - "enumDescriptions": [ - "Value used when unset.", - "Retrieve value from meta tag.", - "Retrieve value from page map.", - "Retrieve value from schema.org data." - ], - "type": "string" - }, - "type": "array" - }, - "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.", - "enum": [ - "COMPLETABLE_OPTION_UNSPECIFIED", - "COMPLETABLE_ENABLED", - "COMPLETABLE_DISABLED" - ], - "enumDescriptions": [ - "Value used when unset.", - "Completable option enabled for a schema field.", - "Completable option disabled for a schema field." - ], - "type": "string" - }, - "dynamicFacetableOption": { - "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.", - "enum": [ - "DYNAMIC_FACETABLE_OPTION_UNSPECIFIED", - "DYNAMIC_FACETABLE_ENABLED", - "DYNAMIC_FACETABLE_DISABLED" - ], - "enumDescriptions": [ - "Value used when unset.", - "Dynamic facetable option enabled for a schema field.", - "Dynamic facetable option disabled for a schema field." - ], - "type": "string" - }, - "fieldPath": { - "description": "Required. Field path of the schema field. For example: `title`, `description`, `release_info.release_year`.", - "type": "string" - }, - "fieldType": { - "description": "Output only. Raw type of the field.", - "enum": [ - "FIELD_TYPE_UNSPECIFIED", - "OBJECT", - "STRING", - "NUMBER", - "INTEGER", - "BOOLEAN", - "GEOLOCATION", - "DATETIME" - ], - "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\"`" - ], + "createTime": { + "description": "Output only. The timestamp when this project is created.", + "format": "google-datetime", "readOnly": true, "type": "string" }, - "indexableOption": { - "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.", - "enum": [ - "INDEXABLE_OPTION_UNSPECIFIED", - "INDEXABLE_ENABLED", - "INDEXABLE_DISABLED" - ], - "enumDescriptions": [ - "Value used when unset.", - "Indexable option enabled for a schema field.", - "Indexable option disabled for a schema field." - ], + "name": { + "description": "Output only. Full resource name of the project, for example `projects/{project_number}`. 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" }, - "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.", + "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.", + "format": "google-datetime", "readOnly": true, "type": "string" }, - "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.", - "enum": [ - "FILTERABLE_OPTION_UNSPECIFIED", - "FILTERABLE_ENABLED", - "FILTERABLE_DISABLED" - ], - "enumDescriptions": [ - "Value used when unset.", - "Filterable option enabled for a schema field.", - "Filterable option disabled for a schema field." - ], + "serviceTermsMap": { + "additionalProperties": { + "$ref": "GoogleCloudDiscoveryengineV1alphaProjectServiceTerms" + }, + "description": "Output only. A map of terms of services. The key is the `id` of ServiceTerms.", + "readOnly": true, + "type": "object" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaProjectServiceTerms": { + "description": "Metadata about the terms of service.", + "id": "GoogleCloudDiscoveryengineV1alphaProjectServiceTerms", + "properties": { + "acceptTime": { + "description": "The last time when the project agreed to the terms of service.", + "format": "google-datetime", "type": "string" }, - "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.", - "enum": [ - "RETRIEVABLE_OPTION_UNSPECIFIED", - "RETRIEVABLE_ENABLED", - "RETRIEVABLE_DISABLED" - ], - "enumDescriptions": [ - "Value used when unset.", - "Retrievable option enabled for a schema field.", - "Retrievable option disabled for a schema field." - ], + "declineTime": { + "description": "The last time when the project declined or revoked the agreement to terms of service.", + "format": "google-datetime", "type": "string" }, - "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", - "items": { - "type": "string" - }, - "type": "array" + "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" }, - "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.", + "state": { + "description": "Whether the project has accepted/rejected the service terms or it is still pending.", "enum": [ - "SEARCHABLE_OPTION_UNSPECIFIED", - "SEARCHABLE_ENABLED", - "SEARCHABLE_DISABLED" + "STATE_UNSPECIFIED", + "TERMS_ACCEPTED", + "TERMS_PENDING", + "TERMS_DECLINED" ], "enumDescriptions": [ - "Value used when unset.", - "Searchable option enabled for a schema field.", - "Searchable option disabled for a schema field." + "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." ], "type": "string" + }, + "version": { + "description": "The version string of the terms of service. For acceptable values, see the comments for id above.", + "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaIdpConfig": { - "description": "Identity Provider Config.", - "id": "GoogleCloudDiscoveryengineV1alphaIdpConfig", + "GoogleCloudDiscoveryengineV1alphaProvisionProjectMetadata": { + "description": "Metadata associated with a project provision operation.", + "id": "GoogleCloudDiscoveryengineV1alphaProvisionProjectMetadata", + "properties": {}, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaPurgeCompletionSuggestionsMetadata": { + "description": "Metadata related to the progress of the PurgeCompletionSuggestions operation. This is returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1alphaPurgeCompletionSuggestionsMetadata", "properties": { - "externalIdpConfig": { - "$ref": "GoogleCloudDiscoveryengineV1alphaIdpConfigExternalIdpConfig", - "description": "External Identity provider config." + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", + "type": "string" }, - "idpType": { - "description": "Identity provider type configured.", - "enum": [ - "IDP_TYPE_UNSPECIFIED", - "GSUITE", - "THIRD_PARTY" - ], - "enumDescriptions": [ - "Default value. ACL search not enabled.", - "Google 1P provider.", - "Third party provider." - ], + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaIdpConfigExternalIdpConfig": { - "description": "Third party IDP Config.", - "id": "GoogleCloudDiscoveryengineV1alphaIdpConfigExternalIdpConfig", + "GoogleCloudDiscoveryengineV1alphaPurgeCompletionSuggestionsResponse": { + "description": "Response message for CompletionService.PurgeCompletionSuggestions method.", + "id": "GoogleCloudDiscoveryengineV1alphaPurgeCompletionSuggestionsResponse", "properties": { - "workforcePoolName": { - "description": "Workforce pool name. Example: \"locations/global/workforcePools/pool_id\"", - "type": "string" + "errorSamples": { + "description": "A sample of errors encountered while processing the request.", + "items": { + "$ref": "GoogleRpcStatus" + }, + "type": "array" + }, + "purgeSucceeded": { + "description": "Whether the completion suggestions were successfully purged.", + "type": "boolean" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaImportCompletionSuggestionsMetadata": { - "description": "Metadata related to the progress of the ImportCompletionSuggestions operation. This will be returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1alphaImportCompletionSuggestionsMetadata", + "GoogleCloudDiscoveryengineV1alphaPurgeDocumentsMetadata": { + "description": "Metadata related to the progress of the PurgeDocuments operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1alphaPurgeDocumentsMetadata", "properties": { "createTime": { "description": "Operation create time.", @@ -9262,12 +10430,17 @@ "type": "string" }, "failureCount": { - "description": "Count of CompletionSuggestions that failed to be imported.", + "description": "Count of entries that encountered errors while processing.", + "format": "int64", + "type": "string" + }, + "ignoredCount": { + "description": "Count of entries that were ignored as entries were not found.", "format": "int64", "type": "string" }, "successCount": { - "description": "Count of CompletionSuggestions successfully imported.", + "description": "Count of entries that were deleted successfully.", "format": "int64", "type": "string" }, @@ -9279,27 +10452,64 @@ }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaImportCompletionSuggestionsResponse": { - "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.", - "id": "GoogleCloudDiscoveryengineV1alphaImportCompletionSuggestionsResponse", + "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.", + "id": "GoogleCloudDiscoveryengineV1alphaPurgeDocumentsResponse", "properties": { - "errorConfig": { - "$ref": "GoogleCloudDiscoveryengineV1alphaImportErrorConfig", - "description": "The desired location of errors incurred during the Import." + "purgeCount": { + "description": "The total count of documents purged as a result of the operation.", + "format": "int64", + "type": "string" + }, + "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.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaPurgeSuggestionDenyListEntriesMetadata": { + "description": "Metadata related to the progress of the PurgeSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1alphaPurgeSuggestionDenyListEntriesMetadata", + "properties": { + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", + "type": "string" }, + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaPurgeSuggestionDenyListEntriesResponse": { + "description": "Response message for CompletionService.PurgeSuggestionDenyListEntries method.", + "id": "GoogleCloudDiscoveryengineV1alphaPurgeSuggestionDenyListEntriesResponse", + "properties": { "errorSamples": { "description": "A sample of errors encountered while processing the request.", "items": { "$ref": "GoogleRpcStatus" }, "type": "array" + }, + "purgeCount": { + "description": "Number of suggestion deny list entries purged.", + "format": "int64", + "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaImportDocumentsMetadata": { - "description": "Metadata related to the progress of the ImportDocuments operation. This is returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1alphaImportDocumentsMetadata", + "GoogleCloudDiscoveryengineV1alphaPurgeUserEventsMetadata": { + "description": "Metadata related to the progress of the PurgeUserEvents operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1alphaPurgeUserEventsMetadata", "properties": { "createTime": { "description": "Operation create time.", @@ -9312,578 +10522,896 @@ "type": "string" }, "successCount": { - "description": "Count of entries that were processed successfully.", + "description": "Count of entries that were deleted successfully.", "format": "int64", "type": "string" }, - "totalCount": { - "description": "Total count of entries that were processed.", + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "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.", + "id": "GoogleCloudDiscoveryengineV1alphaPurgeUserEventsResponse", + "properties": { + "purgeCount": { + "description": "The total count of events purged as a result of the operation.", "format": "int64", "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaQualityMetrics": { + "description": "Describes the metrics produced by the evaluation.", + "id": "GoogleCloudDiscoveryengineV1alphaQualityMetrics", + "properties": { + "docNdcg": { + "$ref": "GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics", + "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" + }, + "docPrecision": { + "$ref": "GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics", + "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" + }, + "docRecall": { + "$ref": "GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics", + "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" + }, + "pageNdcg": { + "$ref": "GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics", + "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" + }, + "pageRecall": { + "$ref": "GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics", + "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" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics": { + "description": "Stores the metric values at specific top-k levels.", + "id": "GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics", + "properties": { + "top1": { + "description": "The top-1 value.", + "format": "double", + "type": "number" + }, + "top10": { + "description": "The top-10 value.", + "format": "double", + "type": "number" + }, + "top3": { + "description": "The top-3 value.", + "format": "double", + "type": "number" + }, + "top5": { + "description": "The top-5 value.", + "format": "double", + "type": "number" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaQuery": { + "description": "Defines a user inputed query.", + "id": "GoogleCloudDiscoveryengineV1alphaQuery", + "properties": { + "queryId": { + "description": "Unique Id for the query.", + "type": "string" + }, + "text": { + "description": "Plain text.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaRecrawlUrisMetadata": { + "description": "Metadata related to the progress of the SiteSearchEngineService.RecrawlUris operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1alphaRecrawlUrisMetadata", + "properties": { + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", + "type": "string" + }, + "invalidUris": { + "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.", + "items": { + "type": "string" + }, + "type": "array" + }, + "pendingCount": { + "description": "Total number of URIs that have yet to be crawled.", + "format": "int32", + "type": "integer" + }, + "quotaExceededCount": { + "description": "Total number of URIs that were rejected due to insufficient indexing resources.", + "format": "int32", + "type": "integer" + }, + "successCount": { + "description": "Total number of URIs that have been crawled so far.", + "format": "int32", + "type": "integer" }, "updateTime": { "description": "Operation last update time. If the operation is done, this is also the finish time.", "format": "google-datetime", "type": "string" + }, + "validUrisCount": { + "description": "Total number of unique URIs in the request that are not in invalid_uris.", + "format": "int32", + "type": "integer" } }, "type": "object" }, - "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.", - "id": "GoogleCloudDiscoveryengineV1alphaImportDocumentsResponse", + "GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponse": { + "description": "Response message for SiteSearchEngineService.RecrawlUris method.", + "id": "GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponse", "properties": { - "errorConfig": { - "$ref": "GoogleCloudDiscoveryengineV1alphaImportErrorConfig", - "description": "Echoes the destination for the complete errors in the request if set." + "failedUris": { + "description": "URIs that were not crawled before the LRO terminated.", + "items": { + "type": "string" + }, + "type": "array" }, - "errorSamples": { - "description": "A sample of errors encountered while processing the request.", + "failureSamples": { + "description": "Details for a sample of up to 10 `failed_uris`.", "items": { - "$ref": "GoogleRpcStatus" + "$ref": "GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfo" }, "type": "array" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaImportErrorConfig": { - "description": "Configuration of destination for Import related errors.", - "id": "GoogleCloudDiscoveryengineV1alphaImportErrorConfig", + "GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfo": { + "description": "Details about why a particular URI failed to be crawled. Each FailureInfo contains one FailureReason per CorpusType.", + "id": "GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfo", "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.", + "failureReasons": { + "description": "List of failure reasons by corpus type (e.g. desktop, mobile).", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfoFailureReason" + }, + "type": "array" + }, + "uri": { + "description": "URI that failed to be crawled.", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesMetadata": { - "description": "Metadata related to the progress of the ImportSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesMetadata", + "GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfoFailureReason": { + "description": "Details about why crawling failed for a particular CorpusType, e.g., DESKTOP and MOBILE crawling may fail for different reasons.", + "id": "GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfoFailureReason", "properties": { - "createTime": { - "description": "Operation create time.", - "format": "google-datetime", + "corpusType": { + "description": "DESKTOP, MOBILE, or CORPUS_TYPE_UNSPECIFIED.", + "enum": [ + "CORPUS_TYPE_UNSPECIFIED", + "DESKTOP", + "MOBILE" + ], + "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." + ], "type": "string" }, - "updateTime": { - "description": "Operation last update time. If the operation is done, this is also the finish time.", - "format": "google-datetime", + "errorMessage": { + "description": "Reason why the URI was not crawled.", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesResponse": { - "description": "Response message for CompletionService.ImportSuggestionDenyListEntries method.", - "id": "GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesResponse", + "GoogleCloudDiscoveryengineV1alphaSchema": { + "description": "Defines the structure and layout of a type of document data.", + "id": "GoogleCloudDiscoveryengineV1alphaSchema", "properties": { - "errorSamples": { - "description": "A sample of errors encountered while processing the request.", + "fieldConfigs": { + "description": "Output only. Configurations for fields of the schema.", "items": { - "$ref": "GoogleRpcStatus" + "$ref": "GoogleCloudDiscoveryengineV1alphaFieldConfig" }, + "readOnly": true, "type": "array" }, - "failedEntriesCount": { - "description": "Count of deny list entries that failed to be imported.", - "format": "int64", + "jsonSchema": { + "description": "The JSON representation of the schema.", "type": "string" }, - "importedEntriesCount": { - "description": "Count of deny list entries successfully imported.", - "format": "int64", + "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" + }, + "structSchema": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "The structured representation of the schema.", + "type": "object" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaImportUserEventsMetadata": { - "description": "Metadata related to the progress of the Import operation. This is returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1alphaImportUserEventsMetadata", + "GoogleCloudDiscoveryengineV1alphaSearchRequest": { + "description": "Request message for SearchService.Search method.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchRequest", "properties": { - "createTime": { - "description": "Operation create time.", - "format": "google-datetime", + "boostSpec": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpec", + "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)" + }, + "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" }, - "failureCount": { - "description": "Count of entries that encountered errors while processing.", - "format": "int64", + "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" }, - "successCount": { - "description": "Count of entries that were processed successfully.", - "format": "int64", + "contentSearchSpec": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpec", + "description": "A specification for configuring the behavior of content search." + }, + "customFineTuningSpec": { + "$ref": "GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec", + "description": "Custom fine tuning configs. If set, it has higher priority than the configs set in ServingConfig.custom_fine_tuning_spec." + }, + "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.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec" + }, + "type": "array" + }, + "embeddingSpec": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpec", + "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." + }, + "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.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpec" + }, + "type": "array" + }, + "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" }, - "updateTime": { - "description": "Operation last update time. If the operation is done, this is also the finish time.", - "format": "google-datetime", + "imageQuery": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestImageQuery", + "description": "Raw image query." + }, + "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" + }, + "naturalLanguageQueryUnderstandingSpec": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestNaturalLanguageQueryUnderstandingSpec", + "description": "If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done." + }, + "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.", + "format": "int32", + "type": "integer" + }, + "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 for retail search, see [Ordering](https://cloud.google.com/retail/docs/filter-and-order#order) If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.", + "type": "string" + }, + "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.", + "format": "int32", + "type": "integer" + }, + "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" + }, + "params": { + "additionalProperties": { + "type": "any" + }, + "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" + }, + "query": { + "description": "Raw search query.", + "type": "string" + }, + "queryExpansionSpec": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestQueryExpansionSpec", + "description": "The query expansion specification that specifies the conditions under which query expansion occurs." + }, + "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)`.", + "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" + }, + "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.", + "enum": [ + "RELEVANCE_THRESHOLD_UNSPECIFIED", + "LOWEST", + "LOW", + "MEDIUM", + "HIGH" + ], + "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." + ], + "type": "string" + }, + "safeSearch": { + "description": "Whether to turn on safe search. This is only supported for website search.", + "type": "boolean" + }, + "searchAsYouTypeSpec": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAsYouTypeSpec", + "description": "Search as you type configuration. Only supported for the IndustryVertical.MEDIA vertical." + }, + "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" + }, + "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 /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": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestSessionSpec", + "description": "Session specification. Can be used only when `session` is set." + }, + "spellCorrectionSpec": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestSpellCorrectionSpec", + "description": "The spell correction specification that specifies the mode under which spell correction takes effect." + }, + "userInfo": { + "$ref": "GoogleCloudDiscoveryengineV1alphaUserInfo", + "description": "Information about the end user. Highly recommended for analytics. UserInfo.user_agent is used to deduce `device_type` for analytics." + }, + "userLabels": { + "additionalProperties": { + "type": "string" + }, + "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" + }, + "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" } }, "type": "object" }, - "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.", - "id": "GoogleCloudDiscoveryengineV1alphaImportUserEventsResponse", + "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpec": { + "description": "Boost specification to boost certain documents.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpec", "properties": { - "errorConfig": { - "$ref": "GoogleCloudDiscoveryengineV1alphaImportErrorConfig", - "description": "Echoes the destination for the complete errors if this field was set in the request." - }, - "errorSamples": { - "description": "A sample of errors encountered while processing the request.", + "conditionBoostSpecs": { + "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.", "items": { - "$ref": "GoogleRpcStatus" + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpec" }, "type": "array" - }, - "joinedEventsCount": { - "description": "Count of user events imported with complete existing Documents.", - "format": "int64", - "type": "string" - }, - "unjoinedEventsCount": { - "description": "Count of user events imported, but with Document information not found in the existing Branch.", - "format": "int64", - "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaLanguageInfo": { - "description": "Language info for DataStore.", - "id": "GoogleCloudDiscoveryengineV1alphaLanguageInfo", + "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpec": { + "description": "Boost applies to documents which match a condition.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpec", "properties": { - "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" - }, - "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" + "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.", + "format": "float", + "type": "number" }, - "region": { - "description": "Output only. Region part of normalized_language_code, if present. E.g.: `en-US` -> `US`, `zh-Hans-HK` -> `HK`, `en` -> ``.", - "readOnly": true, + "boostControlSpec": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpecBoostControlSpec", + "description": "Complex specification for custom ranking based on customer defined attribute value." + }, + "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" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaListCustomModelsResponse": { - "description": "Response message for SearchTuningService.ListCustomModels method.", - "id": "GoogleCloudDiscoveryengineV1alphaListCustomModelsResponse", + "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.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpecBoostControlSpec", "properties": { - "models": { - "description": "List of custom tuning models.", + "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).", + "enum": [ + "ATTRIBUTE_TYPE_UNSPECIFIED", + "NUMERICAL", + "FRESHNESS" + ], + "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`." + ], + "type": "string" + }, + "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.", "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaCustomTuningModel" + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpecBoostControlSpecControlPoint" }, "type": "array" + }, + "fieldName": { + "description": "The name of the field whose value will be used to determine the boost amount.", + "type": "string" + }, + "interpolationType": { + "description": "The interpolation type to be applied to connect the control points listed below.", + "enum": [ + "INTERPOLATION_TYPE_UNSPECIFIED", + "LINEAR" + ], + "enumDescriptions": [ + "Interpolation type is unspecified. In this case, it defaults to Linear.", + "Piecewise linear interpolation will be applied." + ], + "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaProject": { - "description": "Metadata and configurations for a Google Cloud project in the service.", - "id": "GoogleCloudDiscoveryengineV1alphaProject", + "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).", + "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpecBoostControlSpecControlPoint", "properties": { - "createTime": { - "description": "Output only. The timestamp when this project is created.", - "format": "google-datetime", - "readOnly": true, - "type": "string" - }, - "name": { - "description": "Output only. Full resource name of the project, for example `projects/{project_number}`. 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" - }, - "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.", - "format": "google-datetime", - "readOnly": true, + "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" }, - "serviceTermsMap": { - "additionalProperties": { - "$ref": "GoogleCloudDiscoveryengineV1alphaProjectServiceTerms" - }, - "description": "Output only. A map of terms of services. The key is the `id` of ServiceTerms.", - "readOnly": true, - "type": "object" + "boostAmount": { + "description": "The value between -1 to 1 by which to boost the score if the attribute_value evaluates to the value specified above.", + "format": "float", + "type": "number" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaProjectServiceTerms": { - "description": "Metadata about the terms of service.", - "id": "GoogleCloudDiscoveryengineV1alphaProjectServiceTerms", + "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpec": { + "description": "A specification for configuring the behavior of content search.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpec", "properties": { - "acceptTime": { - "description": "The last time when the project agreed to the terms of service.", - "format": "google-datetime", - "type": "string" - }, - "declineTime": { - "description": "The last time when the project declined or revoked the agreement to terms of service.", - "format": "google-datetime", - "type": "string" + "chunkSpec": { + "$ref": "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" }, - "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" + "extractiveContentSpec": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecExtractiveContentSpec", + "description": "If there is no extractive_content_spec provided, there will be no extractive answer in the search response." }, - "state": { - "description": "Whether the project has accepted/rejected the service terms or it is still pending.", + "searchResultMode": { + "description": "Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`.", "enum": [ - "STATE_UNSPECIFIED", - "TERMS_ACCEPTED", - "TERMS_PENDING", - "TERMS_DECLINED" + "SEARCH_RESULT_MODE_UNSPECIFIED", + "DOCUMENTS", + "CHUNKS" ], "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." + "Default value.", + "Returns documents in the search result.", + "Returns chunks in the search result. Only available if the DataStore.DocumentProcessingConfig.chunking_config is specified." ], "type": "string" }, - "version": { - "description": "The version string of the terms of service. For acceptable values, see the comments for id above.", - "type": "string" + "snippetSpec": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSnippetSpec", + "description": "If `snippetSpec` is not specified, snippets are not included in the search response." + }, + "summarySpec": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpec", + "description": "If `summarySpec` is not specified, summaries are not included in the search response." } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaProvisionProjectMetadata": { - "description": "Metadata associated with a project provision operation.", - "id": "GoogleCloudDiscoveryengineV1alphaProvisionProjectMetadata", - "properties": {}, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1alphaPurgeCompletionSuggestionsMetadata": { - "description": "Metadata related to the progress of the PurgeCompletionSuggestions operation. This is returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1alphaPurgeCompletionSuggestionsMetadata", + "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", + "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecChunkSpec", "properties": { - "createTime": { - "description": "Operation create time.", - "format": "google-datetime", - "type": "string" + "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.", + "format": "int32", + "type": "integer" }, - "updateTime": { - "description": "Operation last update time. If the operation is done, this is also the finish time.", - "format": "google-datetime", - "type": "string" + "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.", + "format": "int32", + "type": "integer" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaPurgeCompletionSuggestionsResponse": { - "description": "Response message for CompletionService.PurgeCompletionSuggestions method.", - "id": "GoogleCloudDiscoveryengineV1alphaPurgeCompletionSuggestionsResponse", + "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecExtractiveContentSpec": { + "description": "A specification for configuring the extractive content in a search response.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecExtractiveContentSpec", "properties": { - "errorSamples": { - "description": "A sample of errors encountered while processing the request.", - "items": { - "$ref": "GoogleRpcStatus" - }, - "type": "array" + "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.", + "format": "int32", + "type": "integer" }, - "purgeSucceeded": { - "description": "Whether the completion suggestions were successfully purged.", + "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`.", + "format": "int32", + "type": "integer" + }, + "numNextSegments": { + "description": "Return at most `num_next_segments` segments after each selected segments.", + "format": "int32", + "type": "integer" + }, + "numPreviousSegments": { + "description": "Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments.", + "format": "int32", + "type": "integer" + }, + "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" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaPurgeDocumentsMetadata": { - "description": "Metadata related to the progress of the PurgeDocuments operation. This will be returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1alphaPurgeDocumentsMetadata", + "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSnippetSpec": { + "description": "A specification for configuring snippets in a search response.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSnippetSpec", "properties": { - "createTime": { - "description": "Operation create time.", - "format": "google-datetime", - "type": "string" - }, - "failureCount": { - "description": "Count of entries that encountered errors while processing.", - "format": "int64", - "type": "string" - }, - "ignoredCount": { - "description": "Count of entries that were ignored as entries were not found.", - "format": "int64", - "type": "string" + "maxSnippetCount": { + "deprecated": true, + "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.", + "format": "int32", + "type": "integer" }, - "successCount": { - "description": "Count of entries that were deleted successfully.", - "format": "int64", - "type": "string" + "referenceOnly": { + "deprecated": true, + "description": "[DEPRECATED] This field is deprecated and will have no affect on the snippet.", + "type": "boolean" }, - "updateTime": { - "description": "Operation last update time. If the operation is done, this is also the finish time.", - "format": "google-datetime", - "type": "string" + "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" } }, "type": "object" }, - "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.", - "id": "GoogleCloudDiscoveryengineV1alphaPurgeDocumentsResponse", + "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpec": { + "description": "A specification for configuring a summary returned in a search response.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpec", "properties": { - "purgeCount": { - "description": "The total count of documents purged as a result of the operation.", - "format": "int64", + "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" + }, + "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" + }, + "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" }, - "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.", - "items": { - "type": "string" - }, - "type": "array" + "modelPromptSpec": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelPromptSpec", + "description": "If specified, the spec will be used to modify the prompt provided to the LLM." + }, + "modelSpec": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelSpec", + "description": "If specified, the spec will be used to modify the model specification provided to the LLM." + }, + "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.", + "format": "int32", + "type": "integer" + }, + "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" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaPurgeSuggestionDenyListEntriesMetadata": { - "description": "Metadata related to the progress of the PurgeSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1alphaPurgeSuggestionDenyListEntriesMetadata", + "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelPromptSpec": { + "description": "Specification of the prompt to use with the model.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelPromptSpec", "properties": { - "createTime": { - "description": "Operation create time.", - "format": "google-datetime", - "type": "string" - }, - "updateTime": { - "description": "Operation last update time. If the operation is done, this is also the finish time.", - "format": "google-datetime", + "preamble": { + "description": "Text at the beginning of the prompt that instructs the assistant. Examples are available in the user guide.", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaPurgeSuggestionDenyListEntriesResponse": { - "description": "Response message for CompletionService.PurgeSuggestionDenyListEntries method.", - "id": "GoogleCloudDiscoveryengineV1alphaPurgeSuggestionDenyListEntriesResponse", + "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelSpec": { + "description": "Specification of the model.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelSpec", "properties": { - "errorSamples": { - "description": "A sample of errors encountered while processing the request.", - "items": { - "$ref": "GoogleRpcStatus" - }, - "type": "array" - }, - "purgeCount": { - "description": "Number of suggestion deny list entries purged.", - "format": "int64", + "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" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaPurgeUserEventsMetadata": { - "description": "Metadata related to the progress of the PurgeUserEvents operation. This will be returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1alphaPurgeUserEventsMetadata", + "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` error is returned.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec", "properties": { - "createTime": { - "description": "Operation create time.", - "format": "google-datetime", - "type": "string" - }, - "failureCount": { - "description": "Count of entries that encountered errors while processing.", - "format": "int64", - "type": "string" - }, - "successCount": { - "description": "Count of entries that were deleted successfully.", - "format": "int64", - "type": "string" - }, - "updateTime": { - "description": "Operation last update time. If the operation is done, this is also the finish time.", - "format": "google-datetime", + "dataStore": { + "description": "Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`.", "type": "string" } }, "type": "object" }, - "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.", - "id": "GoogleCloudDiscoveryengineV1alphaPurgeUserEventsResponse", + "GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpec": { + "description": "The specification that uses customized query embedding vector to do semantic document retrieval.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpec", "properties": { - "purgeCount": { - "description": "The total count of events purged as a result of the operation.", - "format": "int64", - "type": "string" + "embeddingVectors": { + "description": "The embedding vector used for retrieval. Limit to 1.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpecEmbeddingVector" + }, + "type": "array" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaQuery": { - "description": "Defines a user inputed query.", - "id": "GoogleCloudDiscoveryengineV1alphaQuery", + "GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpecEmbeddingVector": { + "description": "Embedding vector.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpecEmbeddingVector", "properties": { - "queryId": { - "description": "Unique Id for the query.", + "fieldPath": { + "description": "Embedding field path in schema.", "type": "string" }, - "text": { - "description": "Plain text.", - "type": "string" + "vector": { + "description": "Query embedding vector.", + "items": { + "format": "float", + "type": "number" + }, + "type": "array" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaRecrawlUrisMetadata": { - "description": "Metadata related to the progress of the SiteSearchEngineService.RecrawlUris operation. This will be returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1alphaRecrawlUrisMetadata", + "GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpec": { + "description": "A facet specification to perform faceted search.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpec", "properties": { - "createTime": { - "description": "Operation create time.", - "format": "google-datetime", - "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" }, - "invalidUris": { - "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.", + "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.", "items": { "type": "string" }, "type": "array" }, - "pendingCount": { - "description": "Total number of URIs that have yet to be crawled.", - "format": "int32", - "type": "integer" - }, - "quotaExceededCount": { - "description": "Total number of URIs that were rejected due to insufficient indexing resources.", - "format": "int32", - "type": "integer" - }, - "successCount": { - "description": "Total number of URIs that have been crawled so far.", - "format": "int32", - "type": "integer" - }, - "updateTime": { - "description": "Operation last update time. If the operation is done, this is also the finish time.", - "format": "google-datetime", - "type": "string" + "facetKey": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpecFacetKey", + "description": "Required. The facet key specification." }, - "validUrisCount": { - "description": "Total number of unique URIs in the request that are not in invalid_uris.", + "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.", "format": "int32", "type": "integer" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponse": { - "description": "Response message for SiteSearchEngineService.RecrawlUris method.", - "id": "GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponse", + "GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpecFacetKey": { + "description": "Specifies how a facet is computed.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpecFacetKey", "properties": { - "failedUris": { - "description": "URIs that were not crawled before the LRO terminated.", + "caseInsensitive": { + "description": "True to make facet keys case insensitive when getting faceting values with prefixes or contains; false otherwise.", + "type": "boolean" + }, + "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.", "items": { "type": "string" }, "type": "array" }, - "failureSamples": { - "description": "Details for a sample of up to 10 `failed_uris`.", + "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.", "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfo" + "$ref": "GoogleCloudDiscoveryengineV1alphaInterval" + }, + "type": "array" + }, + "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" + }, + "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" + }, + "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.", + "items": { + "type": "string" + }, + "type": "array" + }, + "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.", + "items": { + "type": "string" }, "type": "array" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfo": { - "description": "Details about why a particular URI failed to be crawled. Each FailureInfo contains one FailureReason per CorpusType.", - "id": "GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfo", + "GoogleCloudDiscoveryengineV1alphaSearchRequestImageQuery": { + "description": "Specifies the image query input.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestImageQuery", "properties": { - "failureReasons": { - "description": "List of failure reasons by corpus type (e.g. desktop, mobile).", + "imageBytes": { + "description": "Base64 encoded image bytes. Supported image formats: JPEG, PNG, and BMP.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaSearchRequestNaturalLanguageQueryUnderstandingSpec": { + "description": "Specification to enable natural language understanding capabilities for search requests.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestNaturalLanguageQueryUnderstandingSpec", + "properties": { + "filterExtractionCondition": { + "description": "The condition under which filter extraction should occur. Default to Condition.DISABLED.", + "enum": [ + "CONDITION_UNSPECIFIED", + "DISABLED", + "ENABLED" + ], + "enumDescriptions": [ + "Server behavior defaults to Condition.DISABLED.", + "Disables NL filter extraction.", + "Enables NL filter extraction." + ], + "type": "string" + }, + "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.", "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfoFailureReason" + "type": "string" }, "type": "array" - }, - "uri": { - "description": "URI that failed to be crawled.", - "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfoFailureReason": { - "description": "Details about why crawling failed for a particular CorpusType, e.g., DESKTOP and MOBILE crawling may fail for different reasons.", - "id": "GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfoFailureReason", + "GoogleCloudDiscoveryengineV1alphaSearchRequestQueryExpansionSpec": { + "description": "Specification to determine under which conditions query expansion should occur.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestQueryExpansionSpec", "properties": { - "corpusType": { - "description": "DESKTOP, MOBILE, or CORPUS_TYPE_UNSPECIFIED.", + "condition": { + "description": "The condition under which query expansion should occur. Default to Condition.DISABLED.", "enum": [ - "CORPUS_TYPE_UNSPECIFIED", - "DESKTOP", - "MOBILE" + "CONDITION_UNSPECIFIED", + "DISABLED", + "AUTO" ], "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 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." ], "type": "string" }, - "errorMessage": { - "description": "Reason why the URI was not crawled.", + "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" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAsYouTypeSpec": { + "description": "Specification for search as you type in search requests.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAsYouTypeSpec", + "properties": { + "condition": { + "description": "The condition under which search as you type should occur. Default to Condition.DISABLED.", + "enum": [ + "CONDITION_UNSPECIFIED", + "DISABLED", + "ENABLED" + ], + "enumDescriptions": [ + "Server behavior defaults to Condition.DISABLED.", + "Disables Search As You Type.", + "Enables Search As You Type." + ], "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaSchema": { - "description": "Defines the structure and layout of a type of document data.", - "id": "GoogleCloudDiscoveryengineV1alphaSchema", + "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.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestSessionSpec", "properties": { - "fieldConfigs": { - "description": "Output only. Configurations for fields of the schema.", - "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaFieldConfig" - }, - "readOnly": true, - "type": "array" - }, - "jsonSchema": { - "description": "The JSON representation of the schema.", + "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" }, - "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.", + "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.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaSearchRequestSpellCorrectionSpec": { + "description": "The specification for query spell correction.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestSpellCorrectionSpec", + "properties": { + "mode": { + "description": "The mode under which spell correction replaces the original search query. Defaults to Mode.AUTO.", + "enum": [ + "MODE_UNSPECIFIED", + "SUGGESTION_ONLY", + "AUTO" + ], + "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." + ], "type": "string" - }, - "structSchema": { - "additionalProperties": { - "description": "Properties of the object.", - "type": "any" - }, - "description": "The structured representation of the schema.", - "type": "object" } }, "type": "object" @@ -9949,6 +11477,29 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1alphaSetUriPatternDocumentDataMetadata": { + "description": "Metadata related to the progress of the SiteSearchEngineService.SetUriPatternDocumentData operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1alphaSetUriPatternDocumentDataMetadata", + "properties": { + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", + "type": "string" + }, + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaSetUriPatternDocumentDataResponse": { + "description": "Response message for SiteSearchEngineService.SetUriPatternDocumentData method.", + "id": "GoogleCloudDiscoveryengineV1alphaSetUriPatternDocumentDataResponse", + "properties": {}, + "type": "object" + }, "GoogleCloudDiscoveryengineV1alphaSiteVerificationInfo": { "description": "Verification information for target sites in advanced site search.", "id": "GoogleCloudDiscoveryengineV1alphaSiteVerificationInfo", @@ -10181,6 +11732,21 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1alphaUserInfo": { + "description": "Information of an end user.", + "id": "GoogleCloudDiscoveryengineV1alphaUserInfo", + "properties": { + "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" + }, + "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" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1betaAlloyDbSource": { "description": "AlloyDB source import data from.", "id": "GoogleCloudDiscoveryengineV1betaAlloyDbSource", @@ -10573,7 +12139,7 @@ "type": "string" }, "searchResultMode": { - "description": "Specifies the search result mode. If unspecified, the search result mode is based on DataStore.DocumentProcessingConfig.chunking_config: * If DataStore.DocumentProcessingConfig.chunking_config is specified, it defaults to `CHUNKS`. * Otherwise, it defaults to `DOCUMENTS`. See [parse and chunk documents](https://cloud.google.com/generative-ai-app-builder/docs/parse-chunk-documents)", + "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)", "enum": [ "SEARCH_RESULT_MODE_UNSPECIFIED", "DOCUMENTS", @@ -10724,7 +12290,7 @@ "properties": { "answer": { "$ref": "GoogleCloudDiscoveryengineV1betaAnswer", - "description": "Answer resource object. If AnswerQueryRequest.StepSpec.max_step_count is greater than 1, use Answer.name to fetch answer information using ConversationalSearchService.GetAnswer API." + "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." }, "answerQueryToken": { "description": "A global unique ID used for logging.", @@ -10983,6 +12549,14 @@ }, "type": "array" }, + "structData": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "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" + }, "title": { "description": "Title.", "type": "string" @@ -11991,6 +13565,12 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1betaCreateEvaluationMetadata": { + "description": "Metadata for EvaluationService.CreateEvaluation method.", + "id": "GoogleCloudDiscoveryengineV1betaCreateEvaluationMetadata", + "properties": {}, + "type": "object" + }, "GoogleCloudDiscoveryengineV1betaCreateSchemaMetadata": { "description": "Metadata for Create Schema LRO.", "id": "GoogleCloudDiscoveryengineV1betaCreateSchemaMetadata", @@ -12067,6 +13647,7 @@ "id": "GoogleCloudDiscoveryengineV1betaCustomTuningModel", "properties": { "createTime": { + "deprecated": true, "description": "Timestamp the Model was created at.", "format": "google-datetime", "type": "string" @@ -12075,6 +13656,14 @@ "description": "The display name of the model.", "type": "string" }, + "metrics": { + "additionalProperties": { + "format": "double", + "type": "number" + }, + "description": "The metrics of the trained model.", + "type": "object" + }, "modelState": { "description": "The state that the model is in (e.g.`TRAINING` or `TRAINING_FAILED`).", "enum": [ @@ -12083,7 +13672,8 @@ "TRAINING", "TRAINING_COMPLETE", "READY_FOR_SERVING", - "TRAINING_FAILED" + "TRAINING_FAILED", + "NO_IMPROVEMENT" ], "enumDescriptions": [ "Default value.", @@ -12091,7 +13681,8 @@ "The model is currently training.", "The model has successfully completed training.", "The model is ready for serving.", - "The model training failed." + "The model training failed.", + "The model training finished successfully but metrics did not improve." ], "type": "string" }, @@ -12425,7 +14016,7 @@ "additionalProperties": { "$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig" }, - "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 or layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and or layout parsing are supported.", + "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.", "type": "object" } }, @@ -12744,6 +14335,96 @@ }, "type": "object" }, + "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.", + "id": "GoogleCloudDiscoveryengineV1betaEvaluation", + "properties": { + "createTime": { + "description": "Output only. Timestamp the Evaluation was created at.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "endTime": { + "description": "Output only. Timestamp the Evaluation was completed at.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "error": { + "$ref": "GoogleRpcStatus", + "description": "Output only. The error that occurred during evaluation. Only populated when the evaluation's state is FAILED.", + "readOnly": true + }, + "errorSamples": { + "description": "Output only. A sample of errors encountered while processing the request.", + "items": { + "$ref": "GoogleRpcStatus" + }, + "readOnly": true, + "type": "array" + }, + "evaluationSpec": { + "$ref": "GoogleCloudDiscoveryengineV1betaEvaluationEvaluationSpec", + "description": "Required. The specification of the evaluation." + }, + "name": { + "description": "Immutable. 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" + }, + "qualityMetrics": { + "$ref": "GoogleCloudDiscoveryengineV1betaQualityMetrics", + "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 + }, + "state": { + "description": "Output only. The state of the evaluation.", + "enum": [ + "STATE_UNSPECIFIED", + "PENDING", + "RUNNING", + "SUCCEEDED", + "FAILED" + ], + "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." + ], + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaEvaluationEvaluationSpec": { + "description": "Describes the specification of the evaluation.", + "id": "GoogleCloudDiscoveryengineV1betaEvaluationEvaluationSpec", + "properties": { + "querySetSpec": { + "$ref": "GoogleCloudDiscoveryengineV1betaEvaluationEvaluationSpecQuerySetSpec", + "description": "Required. The specification of the query set." + }, + "searchRequest": { + "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequest", + "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" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaEvaluationEvaluationSpecQuerySetSpec": { + "description": "Describes the specification of the query set.", + "id": "GoogleCloudDiscoveryengineV1betaEvaluationEvaluationSpecQuerySetSpec", + "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" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1betaFactChunk": { "description": "Fact Chunk.", "id": "GoogleCloudDiscoveryengineV1betaFactChunk", @@ -13099,6 +14780,93 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1betaImportSampleQueriesMetadata": { + "description": "Metadata related to the progress of the ImportSampleQueries operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1betaImportSampleQueriesMetadata", + "properties": { + "createTime": { + "description": "ImportSampleQueries operation create time.", + "format": "google-datetime", + "type": "string" + }, + "failureCount": { + "description": "Count of SampleQuerys that failed to be imported.", + "format": "int64", + "type": "string" + }, + "successCount": { + "description": "Count of SampleQuerys successfully imported.", + "format": "int64", + "type": "string" + }, + "totalCount": { + "description": "Total count of SampleQuerys that were processed.", + "format": "int64", + "type": "string" + }, + "updateTime": { + "description": "ImportSampleQueries operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaImportSampleQueriesRequest": { + "description": "Request message for SampleQueryService.ImportSampleQueries method.", + "id": "GoogleCloudDiscoveryengineV1betaImportSampleQueriesRequest", + "properties": { + "bigquerySource": { + "$ref": "GoogleCloudDiscoveryengineV1betaBigQuerySource", + "description": "BigQuery input source." + }, + "errorConfig": { + "$ref": "GoogleCloudDiscoveryengineV1betaImportErrorConfig", + "description": "The desired location of errors incurred during the Import." + }, + "gcsSource": { + "$ref": "GoogleCloudDiscoveryengineV1betaGcsSource", + "description": "Cloud Storage location for the input content." + }, + "inlineSource": { + "$ref": "GoogleCloudDiscoveryengineV1betaImportSampleQueriesRequestInlineSource", + "description": "The Inline source for sample query entries." + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaImportSampleQueriesRequestInlineSource": { + "description": "The inline source for SampleQuerys.", + "id": "GoogleCloudDiscoveryengineV1betaImportSampleQueriesRequestInlineSource", + "properties": { + "sampleQueries": { + "description": "Required. A list of SampleQuerys to import. Max of 1000 items.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1betaSampleQuery" + }, + "type": "array" + } + }, + "type": "object" + }, + "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.", + "id": "GoogleCloudDiscoveryengineV1betaImportSampleQueriesResponse", + "properties": { + "errorConfig": { + "$ref": "GoogleCloudDiscoveryengineV1betaImportErrorConfig", + "description": "The desired location of errors incurred during the Import." + }, + "errorSamples": { + "description": "A sample of errors encountered while processing the request.", + "items": { + "$ref": "GoogleRpcStatus" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1betaImportSuggestionDenyListEntriesMetadata": { "description": "Metadata related to the progress of the ImportSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field.", "id": "GoogleCloudDiscoveryengineV1betaImportSuggestionDenyListEntriesMetadata", @@ -13368,52 +15136,141 @@ "description": "Response message for DataStoreService.ListDataStores method.", "id": "GoogleCloudDiscoveryengineV1betaListDataStoresResponse", "properties": { - "dataStores": { - "description": "All the customer's DataStores.", + "dataStores": { + "description": "All the customer's DataStores.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1betaDataStore" + }, + "type": "array" + }, + "nextPageToken": { + "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.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaListDocumentsResponse": { + "description": "Response message for DocumentService.ListDocuments method.", + "id": "GoogleCloudDiscoveryengineV1betaListDocumentsResponse", + "properties": { + "documents": { + "description": "The Documents.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1betaDocument" + }, + "type": "array" + }, + "nextPageToken": { + "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" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaListEnginesResponse": { + "description": "Response message for EngineService.ListEngines method.", + "id": "GoogleCloudDiscoveryengineV1betaListEnginesResponse", + "properties": { + "engines": { + "description": "All the customer's Engines.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1betaEngine" + }, + "type": "array" + }, + "nextPageToken": { + "description": "Not supported.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaListEvaluationResultsResponse": { + "description": "Response message for EvaluationService.ListEvaluationResults method.", + "id": "GoogleCloudDiscoveryengineV1betaListEvaluationResultsResponse", + "properties": { + "evaluationResults": { + "description": "The EvaluationResults.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1betaListEvaluationResultsResponseEvaluationResult" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token that can be sent as ListEvaluationResultsRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaListEvaluationResultsResponseEvaluationResult": { + "description": "Represents the results of an evaluation for a single SampleQuery.", + "id": "GoogleCloudDiscoveryengineV1betaListEvaluationResultsResponseEvaluationResult", + "properties": { + "qualityMetrics": { + "$ref": "GoogleCloudDiscoveryengineV1betaQualityMetrics", + "description": "Output only. The metrics produced by the evaluation, for a given SampleQuery.", + "readOnly": true + }, + "sampleQuery": { + "$ref": "GoogleCloudDiscoveryengineV1betaSampleQuery", + "description": "Output only. The SampleQuery that was evaluated.", + "readOnly": true + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaListEvaluationsResponse": { + "description": "Response message for EvaluationService.ListEvaluations method.", + "id": "GoogleCloudDiscoveryengineV1betaListEvaluationsResponse", + "properties": { + "evaluations": { + "description": "The Evaluations.", "items": { - "$ref": "GoogleCloudDiscoveryengineV1betaDataStore" + "$ref": "GoogleCloudDiscoveryengineV1betaEvaluation" }, "type": "array" }, "nextPageToken": { - "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.", + "description": "A token that can be sent as ListEvaluationsRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1betaListDocumentsResponse": { - "description": "Response message for DocumentService.ListDocuments method.", - "id": "GoogleCloudDiscoveryengineV1betaListDocumentsResponse", + "GoogleCloudDiscoveryengineV1betaListSampleQueriesResponse": { + "description": "Response message for SampleQueryService.ListSampleQueries method.", + "id": "GoogleCloudDiscoveryengineV1betaListSampleQueriesResponse", "properties": { - "documents": { - "description": "The Documents.", + "nextPageToken": { + "description": "A token that can be sent as ListSampleQueriesRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.", + "type": "string" + }, + "sampleQueries": { + "description": "The SampleQuerys.", "items": { - "$ref": "GoogleCloudDiscoveryengineV1betaDocument" + "$ref": "GoogleCloudDiscoveryengineV1betaSampleQuery" }, "type": "array" - }, - "nextPageToken": { - "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" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1betaListEnginesResponse": { - "description": "Response message for EngineService.ListEngines method.", - "id": "GoogleCloudDiscoveryengineV1betaListEnginesResponse", + "GoogleCloudDiscoveryengineV1betaListSampleQuerySetsResponse": { + "description": "Response message for SampleQuerySetService.ListSampleQuerySets method.", + "id": "GoogleCloudDiscoveryengineV1betaListSampleQuerySetsResponse", "properties": { - "engines": { - "description": "All the customer's Engines.", + "nextPageToken": { + "description": "A token that can be sent as ListSampleQuerySetsRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.", + "type": "string" + }, + "sampleQuerySets": { + "description": "The SampleQuerySets.", "items": { - "$ref": "GoogleCloudDiscoveryengineV1betaEngine" + "$ref": "GoogleCloudDiscoveryengineV1betaSampleQuerySet" }, "type": "array" - }, - "nextPageToken": { - "description": "Not supported.", - "type": "string" } }, "type": "object" @@ -13774,6 +15631,60 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1betaQualityMetrics": { + "description": "Describes the metrics produced by the evaluation.", + "id": "GoogleCloudDiscoveryengineV1betaQualityMetrics", + "properties": { + "docNdcg": { + "$ref": "GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics", + "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" + }, + "docPrecision": { + "$ref": "GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics", + "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" + }, + "docRecall": { + "$ref": "GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics", + "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" + }, + "pageNdcg": { + "$ref": "GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics", + "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" + }, + "pageRecall": { + "$ref": "GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics", + "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" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics": { + "description": "Stores the metric values at specific top-k levels.", + "id": "GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics", + "properties": { + "top1": { + "description": "The top-1 value.", + "format": "double", + "type": "number" + }, + "top10": { + "description": "The top-10 value.", + "format": "double", + "type": "number" + }, + "top3": { + "description": "The top-3 value.", + "format": "double", + "type": "number" + }, + "top5": { + "description": "The top-5 value.", + "format": "double", + "type": "number" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1betaQuery": { "description": "Defines a user inputed query.", "id": "GoogleCloudDiscoveryengineV1betaQuery", @@ -14024,6 +15935,94 @@ "properties": {}, "type": "object" }, + "GoogleCloudDiscoveryengineV1betaSampleQuery": { + "description": "Sample Query captures metadata to be used for evaluation.", + "id": "GoogleCloudDiscoveryengineV1betaSampleQuery", + "properties": { + "createTime": { + "description": "Output only. Timestamp the SampleQuery was created at.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "Immutable. The full resource name of the sample query, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}/sampleQueries/{sampleQuery}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", + "type": "string" + }, + "queryEntry": { + "$ref": "GoogleCloudDiscoveryengineV1betaSampleQueryQueryEntry", + "description": "The query entry." + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaSampleQueryQueryEntry": { + "description": "Query Entry captures metadata to be used for search evaluation.", + "id": "GoogleCloudDiscoveryengineV1betaSampleQueryQueryEntry", + "properties": { + "query": { + "description": "Required. The query.", + "type": "string" + }, + "targets": { + "description": "List of targets for the query.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1betaSampleQueryQueryEntryTarget" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaSampleQueryQueryEntryTarget": { + "description": "Defines the parameters of the query's expected outcome.", + "id": "GoogleCloudDiscoveryengineV1betaSampleQueryQueryEntryTarget", + "properties": { + "pageNumbers": { + "description": "Expected page numbers of the target. Each page number must be non negative.", + "items": { + "format": "int32", + "type": "integer" + }, + "type": "array" + }, + "score": { + "description": "Relevance score of the target.", + "format": "double", + "type": "number" + }, + "uri": { + "description": "Expected uri of the target. This field must be a UTF-8 encoded string with a length limit of 2048 characters. Example of valid uris: `https://example.com/abc`, `gcs://example/example.pdf`.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaSampleQuerySet": { + "description": "A SampleQuerySet is the parent resource of SampleQuery, and contains the configurations shared by all SampleQuery under it.", + "id": "GoogleCloudDiscoveryengineV1betaSampleQuerySet", + "properties": { + "createTime": { + "description": "Output only. Timestamp the SampleQuerySet was created at.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "description": { + "description": "The description of the SampleQuerySet.", + "type": "string" + }, + "displayName": { + "description": "Required. The sample query set display name. This field must be a UTF-8 encoded string with a length limit of 128 characters.", + "type": "string" + }, + "name": { + "description": "Immutable. The full resource name of the SampleQuerySet, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1betaSchema": { "description": "Defines the structure and layout of a type of document data.", "id": "GoogleCloudDiscoveryengineV1betaSchema", @@ -14117,6 +16116,10 @@ "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" }, + "naturalLanguageQueryUnderstandingSpec": { + "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestNaturalLanguageQueryUnderstandingSpec", + "description": "If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done." + }, "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.", "format": "int32", @@ -14151,7 +16154,7 @@ "description": "The query expansion specification that specifies the conditions under which query expansion occurs." }, "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 joint 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)`.", + "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)`.", "type": "string" }, "regionCode": { @@ -14162,6 +16165,22 @@ "description": "Whether to turn on safe search. This is only supported for website search.", "type": "boolean" }, + "searchAsYouTypeSpec": { + "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestSearchAsYouTypeSpec", + "description": "Search as you type configuration. Only supported for the IndustryVertical.MEDIA vertical." + }, + "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" + }, + "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 /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": { + "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestSessionSpec", + "description": "Session specification. Can be used only when `session` is set." + }, "spellCorrectionSpec": { "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestSpellCorrectionSpec", "description": "The spell correction specification that specifies the mode under which spell correction takes effect." @@ -14291,7 +16310,7 @@ "description": "If there is no extractive_content_spec provided, there will be no extractive answer in the search response." }, "searchResultMode": { - "description": "Specifies the search result mode. If unspecified, the search result mode is based on DataStore.DocumentProcessingConfig.chunking_config: * If DataStore.DocumentProcessingConfig.chunking_config is specified, it defaults to `CHUNKS`. * Otherwise, it defaults to `DOCUMENTS`.", + "description": "Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`.", "enum": [ "SEARCH_RESULT_MODE_UNSPECIFIED", "DOCUMENTS", @@ -14448,7 +16467,7 @@ "type": "object" }, "GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec": { - "description": "A struct to define data stores to filter on in a search call and configurations for those data stores. A maximum of 1 DataStoreSpec per data_store is allowed. Otherwise, an `INVALID_ARGUMENT` error is returned.", + "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.", "id": "GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec", "properties": { "dataStore": { @@ -14576,6 +16595,34 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1betaSearchRequestNaturalLanguageQueryUnderstandingSpec": { + "description": "Specification to enable natural language understanding capabilities for search requests.", + "id": "GoogleCloudDiscoveryengineV1betaSearchRequestNaturalLanguageQueryUnderstandingSpec", + "properties": { + "filterExtractionCondition": { + "description": "The condition under which filter extraction should occur. Default to Condition.DISABLED.", + "enum": [ + "CONDITION_UNSPECIFIED", + "DISABLED", + "ENABLED" + ], + "enumDescriptions": [ + "Server behavior defaults to Condition.DISABLED.", + "Disables NL filter extraction.", + "Enables NL filter extraction." + ], + "type": "string" + }, + "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.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1betaSearchRequestQueryExpansionSpec": { "description": "Specification to determine under which conditions query expansion should occur.", "id": "GoogleCloudDiscoveryengineV1betaSearchRequestQueryExpansionSpec", @@ -14601,6 +16648,43 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1betaSearchRequestSearchAsYouTypeSpec": { + "description": "Specification for search as you type in search requests.", + "id": "GoogleCloudDiscoveryengineV1betaSearchRequestSearchAsYouTypeSpec", + "properties": { + "condition": { + "description": "The condition under which search as you type should occur. Default to Condition.DISABLED.", + "enum": [ + "CONDITION_UNSPECIFIED", + "DISABLED", + "ENABLED" + ], + "enumDescriptions": [ + "Server behavior defaults to Condition.DISABLED.", + "Disables Search As You Type.", + "Enables Search As You Type." + ], + "type": "string" + } + }, + "type": "object" + }, + "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.", + "id": "GoogleCloudDiscoveryengineV1betaSearchRequestSessionSpec", + "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.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1betaSearchRequestSpellCorrectionSpec": { "description": "The specification for query spell correction.", "id": "GoogleCloudDiscoveryengineV1betaSearchRequestSpellCorrectionSpec", @@ -14658,6 +16742,10 @@ "$ref": "GoogleCloudDiscoveryengineV1betaSearchResponseGuidedSearchResult", "description": "Guided search result." }, + "naturalLanguageQueryUnderstandingInfo": { + "$ref": "GoogleCloudDiscoveryengineV1betaSearchResponseNaturalLanguageQueryUnderstandingInfo", + "description": "Natural language query understanding information for the returned results." + }, "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.", "type": "string" @@ -14677,6 +16765,10 @@ }, "type": "array" }, + "sessionInfo": { + "$ref": "GoogleCloudDiscoveryengineV1betaSearchResponseSessionInfo", + "description": "Session information. Only set if SearchRequest.session is provided. See its description for more details." + }, "summary": { "$ref": "GoogleCloudDiscoveryengineV1betaSearchResponseSummary", "description": "A summary as part of the search results. This field is only returned if SearchRequest.ContentSearchSpec.summary_spec is set." @@ -14782,6 +16874,165 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1betaSearchResponseNaturalLanguageQueryUnderstandingInfo": { + "description": "Information describing what natural language understanding was done on the input query.", + "id": "GoogleCloudDiscoveryengineV1betaSearchResponseNaturalLanguageQueryUnderstandingInfo", + "properties": { + "extractedFilters": { + "description": "The filters that were extracted from the input query.", + "type": "string" + }, + "rewrittenQuery": { + "description": "Rewritten input query minus the extracted filters.", + "type": "string" + }, + "structuredExtractedFilter": { + "$ref": "GoogleCloudDiscoveryengineV1betaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilter", + "description": "The filters that were extracted from the input query represented in a structured form." + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilter": { + "description": "The filters that were extracted from the input query represented in a structured form.", + "id": "GoogleCloudDiscoveryengineV1betaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilter", + "properties": { + "expression": { + "$ref": "GoogleCloudDiscoveryengineV1betaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterExpression", + "description": "The expression denoting the filter that was extracted from the input query in a structured form. It can be a simple expression denoting a single string, numerical or geolocation constraint or a compound expression which is a combination of multiple expressions connected using logical (OR and AND) operators." + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterAndExpression": { + "description": "Logical `And` operator.", + "id": "GoogleCloudDiscoveryengineV1betaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterAndExpression", + "properties": { + "expressions": { + "description": "The expressions that were ANDed together.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1betaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterExpression" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterExpression": { + "description": "The expression denoting the filter that was extracted from the input query.", + "id": "GoogleCloudDiscoveryengineV1betaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterExpression", + "properties": { + "andExpr": { + "$ref": "GoogleCloudDiscoveryengineV1betaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterAndExpression", + "description": "Logical \"And\" compound operator connecting multiple expressions." + }, + "geolocationConstraint": { + "$ref": "GoogleCloudDiscoveryengineV1betaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterGeolocationConstraint", + "description": "Geolocation constraint expression." + }, + "numberConstraint": { + "$ref": "GoogleCloudDiscoveryengineV1betaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterNumberConstraint", + "description": "Numerical constraint expression." + }, + "orExpr": { + "$ref": "GoogleCloudDiscoveryengineV1betaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterOrExpression", + "description": "Logical \"Or\" compound operator connecting multiple expressions." + }, + "stringConstraint": { + "$ref": "GoogleCloudDiscoveryengineV1betaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterStringConstraint", + "description": "String constraint expression." + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterGeolocationConstraint": { + "description": "Constraint of a geolocation field. Name of the geolocation field as defined in the schema.", + "id": "GoogleCloudDiscoveryengineV1betaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterGeolocationConstraint", + "properties": { + "address": { + "description": "The reference address that was inferred from the input query. The proximity of the reference address to the geolocation field will be used to filter the results.", + "type": "string" + }, + "fieldName": { + "description": "The name of the geolocation field as defined in the schema.", + "type": "string" + }, + "radiusInMeters": { + "description": "The radius in meters around the address. The record is returned if the location of the geolocation field is within the radius.", + "format": "float", + "type": "number" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterNumberConstraint": { + "description": "Constraint expression of a number field. Example: price < 100.", + "id": "GoogleCloudDiscoveryengineV1betaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterNumberConstraint", + "properties": { + "comparison": { + "description": "The comparison operation performed between the field value and the value specified in the constraint.", + "enum": [ + "COMPARISON_UNSPECIFIED", + "EQUALS", + "LESS_THAN_EQUALS", + "LESS_THAN", + "GREATER_THAN_EQUALS", + "GREATER_THAN" + ], + "enumDescriptions": [ + "Undefined comparison operator.", + "Denotes equality `=` operator.", + "Denotes less than or equal to `<=` operator.", + "Denotes less than `<` operator.", + "Denotes greater than or equal to `>=` operator.", + "Denotes greater than `>` operator." + ], + "type": "string" + }, + "fieldName": { + "description": "Name of the numerical field as defined in the schema.", + "type": "string" + }, + "value": { + "description": "The value specified in the numerical constraint.", + "format": "double", + "type": "number" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterOrExpression": { + "description": "Logical `Or` operator.", + "id": "GoogleCloudDiscoveryengineV1betaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterOrExpression", + "properties": { + "expressions": { + "description": "The expressions that were ORed together.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1betaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterExpression" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterStringConstraint": { + "description": "Constraint expression of a string field.", + "id": "GoogleCloudDiscoveryengineV1betaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterStringConstraint", + "properties": { + "fieldName": { + "description": "Name of the string field as defined in the schema.", + "type": "string" + }, + "values": { + "description": "Values of the string field. The record will only be returned if the field value matches one of the values specified here.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1betaSearchResponseQueryExpansionInfo": { "description": "Information describing query expansion including whether expansion has occurred.", "id": "GoogleCloudDiscoveryengineV1betaSearchResponseQueryExpansionInfo", @@ -14824,6 +17075,21 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1betaSearchResponseSessionInfo": { + "description": "Information about the session.", + "id": "GoogleCloudDiscoveryengineV1betaSearchResponseSessionInfo", + "properties": { + "name": { + "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.", + "type": "string" + }, + "queryId": { + "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" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1betaSearchResponseSummary": { "description": "Summary of the top N search results specified by the summary spec.", "id": "GoogleCloudDiscoveryengineV1betaSearchResponseSummary", @@ -15075,7 +17341,7 @@ "type": "array" }, "rankingExpression": { - "description": "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).", + "description": "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" }, "redirectControlIds": { diff --git a/discovery/dlp-v2.json b/discovery/dlp-v2.json index 780fc2f5b0..7e75027f24 100644 --- a/discovery/dlp-v2.json +++ b/discovery/dlp-v2.json @@ -17,19 +17,219 @@ "documentationLink": "https://cloud.google.com/sensitive-data-protection/docs/", "endpoints": [ { + "endpointUrl": "https://dlp.africa-south1.rep.googleapis.com/", "location": "africa-south1", + "description": "Regional Endpoint" + }, + { + "endpointUrl": "https://dlp.asia-east1.rep.googleapis.com/", + "location": "asia-east1", + "description": "Regional Endpoint" + }, + { + "endpointUrl": "https://dlp.asia-east2.rep.googleapis.com/", + "description": "Regional Endpoint", + "location": "asia-east2" + }, + { + "endpointUrl": "https://dlp.asia-northeast1.rep.googleapis.com/", + "location": "asia-northeast1", + "description": "Regional Endpoint" + }, + { + "location": "asia-northeast2", + "description": "Regional Endpoint", + "endpointUrl": "https://dlp.asia-northeast2.rep.googleapis.com/" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://dlp.asia-northeast3.rep.googleapis.com/", + "location": "asia-northeast3" + }, + { + "endpointUrl": "https://dlp.asia-south1.rep.googleapis.com/", + "description": "Regional Endpoint", + "location": "asia-south1" + }, + { + "location": "asia-south2", + "endpointUrl": "https://dlp.asia-south2.rep.googleapis.com/", + "description": "Regional Endpoint" + }, + { + "location": "asia-southeast1", + "endpointUrl": "https://dlp.asia-southeast1.rep.googleapis.com/", + "description": "Regional Endpoint" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://dlp.asia-southeast2.rep.googleapis.com/", + "location": "asia-southeast2" + }, + { + "endpointUrl": "https://dlp.australia-southeast1.rep.googleapis.com/", + "description": "Regional Endpoint", + "location": "australia-southeast1" + }, + { + "endpointUrl": "https://dlp.australia-southeast2.rep.googleapis.com/", + "location": "australia-southeast2", + "description": "Regional Endpoint" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://dlp.europe-central2.rep.googleapis.com/", + "location": "europe-central2" + }, + { + "location": "europe-north1", + "endpointUrl": "https://dlp.europe-north1.rep.googleapis.com/", + "description": "Regional Endpoint" + }, + { + "description": "Regional Endpoint", + "location": "europe-north2", + "endpointUrl": "https://dlp.europe-north2.rep.googleapis.com/" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://dlp.europe-southwest1.rep.googleapis.com/", + "location": "europe-southwest1" + }, + { + "location": "europe-west1", + "description": "Regional Endpoint", + "endpointUrl": "https://dlp.europe-west1.rep.googleapis.com/" + }, + { + "location": "europe-west10", + "endpointUrl": "https://dlp.europe-west10.rep.googleapis.com/", + "description": "Regional Endpoint" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://dlp.europe-west12.rep.googleapis.com/", + "location": "europe-west12" + }, + { + "location": "europe-west2", + "description": "Regional Endpoint", + "endpointUrl": "https://dlp.europe-west2.rep.googleapis.com/" + }, + { + "location": "europe-west3", + "endpointUrl": "https://dlp.europe-west3.rep.googleapis.com/", + "description": "Regional Endpoint" + }, + { + "endpointUrl": "https://dlp.europe-west4.rep.googleapis.com/", + "location": "europe-west4", + "description": "Regional Endpoint" + }, + { + "endpointUrl": "https://dlp.europe-west6.rep.googleapis.com/", "description": "Regional Endpoint", - "endpointUrl": "https://dlp.africa-south1.rep.googleapis.com/" + "location": "europe-west6" }, { + "endpointUrl": "https://dlp.europe-west8.rep.googleapis.com/", "description": "Regional Endpoint", - "location": "australia-southeast1", - "endpointUrl": "https://dlp.australia-southeast1.rep.googleapis.com/" + "location": "europe-west8" }, { - "endpointUrl": "https://dlp.europe-west9.rep.googleapis.com/", "location": "europe-west9", + "description": "Regional Endpoint", + "endpointUrl": "https://dlp.europe-west9.rep.googleapis.com/" + }, + { + "location": "me-central1", + "endpointUrl": "https://dlp.me-central1.rep.googleapis.com/", "description": "Regional Endpoint" + }, + { + "location": "me-central2", + "endpointUrl": "https://dlp.me-central2.rep.googleapis.com/", + "description": "Regional Endpoint" + }, + { + "endpointUrl": "https://dlp.me-west1.rep.googleapis.com/", + "description": "Regional Endpoint", + "location": "me-west1" + }, + { + "description": "Regional Endpoint", + "location": "northamerica-northeast1", + "endpointUrl": "https://dlp.northamerica-northeast1.rep.googleapis.com/" + }, + { + "endpointUrl": "https://dlp.northamerica-northeast2.rep.googleapis.com/", + "description": "Regional Endpoint", + "location": "northamerica-northeast2" + }, + { + "endpointUrl": "https://dlp.northamerica-south1.rep.googleapis.com/", + "description": "Regional Endpoint", + "location": "northamerica-south1" + }, + { + "location": "southamerica-east1", + "description": "Regional Endpoint", + "endpointUrl": "https://dlp.southamerica-east1.rep.googleapis.com/" + }, + { + "description": "Regional Endpoint", + "location": "southamerica-west1", + "endpointUrl": "https://dlp.southamerica-west1.rep.googleapis.com/" + }, + { + "endpointUrl": "https://dlp.us-central1.rep.googleapis.com/", + "location": "us-central1", + "description": "Regional Endpoint" + }, + { + "location": "us-east1", + "description": "Regional Endpoint", + "endpointUrl": "https://dlp.us-east1.rep.googleapis.com/" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://dlp.us-east4.rep.googleapis.com/", + "location": "us-east4" + }, + { + "location": "us-east5", + "description": "Regional Endpoint", + "endpointUrl": "https://dlp.us-east5.rep.googleapis.com/" + }, + { + "description": "Regional Endpoint", + "location": "us-south1", + "endpointUrl": "https://dlp.us-south1.rep.googleapis.com/" + }, + { + "endpointUrl": "https://dlp.us-west1.rep.googleapis.com/", + "description": "Regional Endpoint", + "location": "us-west1" + }, + { + "location": "us-west2", + "endpointUrl": "https://dlp.us-west2.rep.googleapis.com/", + "description": "Regional Endpoint" + }, + { + "location": "us-west3", + "description": "Regional Endpoint", + "endpointUrl": "https://dlp.us-west3.rep.googleapis.com/" + }, + { + "endpointUrl": "https://dlp.us-west4.rep.googleapis.com/", + "description": "Regional Endpoint", + "location": "us-west4" + }, + { + "location": "us-west8", + "description": "Regional Endpoint", + "endpointUrl": "https://dlp.us-west8.rep.googleapis.com/" } ], "fullyEncodeReservedExpansion": true, @@ -307,7 +507,7 @@ "type": "string" }, "orderBy": { - "description": "Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to the time the template was created. - `update_time`: corresponds to the time the template was last updated. - `name`: corresponds to the template's name. - `display_name`: corresponds to the template's display name.", + "description": "Comma-separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to the time the template was created. - `update_time`: corresponds to the time the template was last updated. - `name`: corresponds to the template's name. - `display_name`: corresponds to the template's display name.", "location": "query", "type": "string" }, @@ -463,7 +663,7 @@ "type": "string" }, "orderBy": { - "description": "Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to the time the template was created. - `update_time`: corresponds to the time the template was last updated. - `name`: corresponds to the template's name. - `display_name`: corresponds to the template's display name.", + "description": "Comma-separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to the time the template was created. - `update_time`: corresponds to the time the template was last updated. - `name`: corresponds to the template's name. - `display_name`: corresponds to the template's display name.", "location": "query", "type": "string" }, @@ -568,7 +768,7 @@ "type": "string" }, "orderBy": { - "description": "Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Only one order field at a time is allowed. Examples: * `project_id asc` * `table_id` * `sensitivity_level desc` Supported fields are: - `project_id`: The Google Cloud project ID. - `dataset_id`: The ID of a BigQuery dataset. - `table_id`: The ID of a BigQuery table. - `sensitivity_level`: How sensitive the data in a column is, at most. - `data_risk_level`: How much risk is associated with this data. - `profile_last_generated`: When the profile was last updated in epoch seconds.", + "description": "Comma-separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Only one order field at a time is allowed. Examples: * `project_id asc` * `table_id` * `sensitivity_level desc` Supported fields are: - `project_id`: The Google Cloud project ID. - `dataset_id`: The ID of a BigQuery dataset. - `table_id`: The ID of a BigQuery table. - `sensitivity_level`: How sensitive the data in a column is, at most. - `data_risk_level`: How much risk is associated with this data. - `profile_last_generated`: When the profile was last updated in epoch seconds.", "location": "query", "type": "string" }, @@ -847,7 +1047,7 @@ "type": "string" }, "orderBy": { - "description": "Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to the time the template was created. - `update_time`: corresponds to the time the template was last updated. - `name`: corresponds to the template's name. - `display_name`: corresponds to the template's display name.", + "description": "Comma-separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to the time the template was created. - `update_time`: corresponds to the time the template was last updated. - `name`: corresponds to the template's name. - `display_name`: corresponds to the template's display name.", "location": "query", "type": "string" }, @@ -998,7 +1198,7 @@ ], "parameters": { "orderBy": { - "description": "Comma separated list of config fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `last_run_time`: corresponds to the last time the DiscoveryConfig ran. - `name`: corresponds to the DiscoveryConfig's name. - `status`: corresponds to DiscoveryConfig's status.", + "description": "Comma-separated list of config fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `last_run_time`: corresponds to the last time the DiscoveryConfig ran. - `name`: corresponds to the DiscoveryConfig's name. - `status`: corresponds to DiscoveryConfig's status.", "location": "query", "type": "string" }, @@ -1081,7 +1281,7 @@ "type": "string" }, "orderBy": { - "description": "Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc, end_time asc, create_time desc` Supported fields are: - `create_time`: corresponds to the time the job was created. - `end_time`: corresponds to the time the job ended. - `name`: corresponds to the job's name. - `state`: corresponds to `state`", + "description": "Comma-separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc, end_time asc, create_time desc` Supported fields are: - `create_time`: corresponds to the time the job was created. - `end_time`: corresponds to the time the job ended. - `name`: corresponds to the job's name. - `state`: corresponds to `state`", "location": "query", "type": "string" }, @@ -1191,12 +1391,12 @@ ], "parameters": { "filter": { - "description": "Optional. Allows filtering. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * Supported fields/values: - `project_id` - The Google Cloud project ID. - `file_store_path` - The path like \"gs://bucket\". - `sensitivity_level` - HIGH|MODERATE|LOW - `data_risk_level` - HIGH|MODERATE|LOW - `resource_visibility`: PUBLIC|RESTRICTED - `status_code` - an RPC status code as defined in https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto * The operator must be `=` or `!=`. Examples: * `project_id = 12345 AND status_code = 1` * `project_id = 12345 AND sensitivity_level = HIGH` * `project_id = 12345 AND resource_visibility = PUBLIC` . * 'file_store_path = \"gs://mybucket\"` The length of this field should be no more than 500 characters.", + "description": "Optional. Allows filtering. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * Supported fields/values: - `project_id` - The Google Cloud project ID. - `file_store_path` - The path like \"gs://bucket\". - `sensitivity_level` - HIGH|MODERATE|LOW - `data_risk_level` - HIGH|MODERATE|LOW - `resource_visibility`: PUBLIC|RESTRICTED - `status_code` - an RPC status code as defined in https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto * The operator must be `=` or `!=`. Examples: * `project_id = 12345 AND status_code = 1` * `project_id = 12345 AND sensitivity_level = HIGH` * `project_id = 12345 AND resource_visibility = PUBLIC` * `file_store_path = \"gs://mybucket\"` The length of this field should be no more than 500 characters.", "location": "query", "type": "string" }, "orderBy": { - "description": "Optional. Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Only one order field at a time is allowed. Examples: * `project_id asc` * `name` * `sensitivity_level desc` Supported fields are: - `project_id`: The Google Cloud project ID. - `sensitivity_level`: How sensitive the data in a table is, at most. - `data_risk_level`: How much risk is associated with this data. - `profile_last_generated`: When the profile was last updated in epoch seconds. - `last_modified`: The last time the resource was modified. - `resource_visibility`: Visibility restriction for this resource. - `name`: The name of the profile. - `create_time`: The time the file store was first created.", + "description": "Optional. Comma-separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Only one order field at a time is allowed. Examples: * `project_id asc` * `name` * `sensitivity_level desc` Supported fields are: - `project_id`: The Google Cloud project ID. - `sensitivity_level`: How sensitive the data in a table is, at most. - `data_risk_level`: How much risk is associated with this data. - `profile_last_generated`: When the profile was last updated in epoch seconds. - `last_modified`: The last time the resource was modified. - `resource_visibility`: Visibility restriction for this resource. - `name`: The name of the profile. - `create_time`: The time the file store was first created.", "location": "query", "type": "string" }, @@ -1324,7 +1524,7 @@ "type": "string" }, "orderBy": { - "description": "Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to the time the template was created. - `update_time`: corresponds to the time the template was last updated. - `name`: corresponds to the template's name. - `display_name`: corresponds to the template's display name.", + "description": "Comma-separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to the time the template was created. - `update_time`: corresponds to the time the template was last updated. - `name`: corresponds to the template's name. - `display_name`: corresponds to the template's display name.", "location": "query", "type": "string" }, @@ -1485,7 +1685,7 @@ "type": "string" }, "orderBy": { - "description": "Comma separated list of triggeredJob fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to the time the JobTrigger was created. - `update_time`: corresponds to the time the JobTrigger was last updated. - `last_run_time`: corresponds to the last time the JobTrigger ran. - `name`: corresponds to the JobTrigger's name. - `display_name`: corresponds to the JobTrigger's display name. - `status`: corresponds to JobTrigger's status.", + "description": "Comma-separated list of triggeredJob fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to the time the JobTrigger was created. - `update_time`: corresponds to the time the JobTrigger was last updated. - `last_run_time`: corresponds to the last time the JobTrigger ran. - `name`: corresponds to the JobTrigger's name. - `display_name`: corresponds to the JobTrigger's display name. - `status`: corresponds to JobTrigger's status.", "location": "query", "type": "string" }, @@ -1603,7 +1803,7 @@ "type": "string" }, "orderBy": { - "description": "Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Only one order field at a time is allowed. Examples: * `project_id` * `sensitivity_level desc` Supported fields are: - `project_id`: Google Cloud project ID - `sensitivity_level`: How sensitive the data in a project is, at most. - `data_risk_level`: How much risk is associated with this data. - `profile_last_generated`: When the profile was last updated in epoch seconds.", + "description": "Comma-separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Only one order field at a time is allowed. Examples: * `project_id` * `sensitivity_level desc` Supported fields are: - `project_id`: Google Cloud project ID - `sensitivity_level`: How sensitive the data in a project is, at most. - `data_risk_level`: How much risk is associated with this data. - `profile_last_generated`: When the profile was last updated in epoch seconds.", "location": "query", "type": "string" }, @@ -1731,7 +1931,7 @@ "type": "string" }, "orderBy": { - "description": "Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc, display_name, create_time desc` Supported fields are: - `create_time`: corresponds to the time the most recent version of the resource was created. - `state`: corresponds to the state of the resource. - `name`: corresponds to resource name. - `display_name`: corresponds to info type's display name.", + "description": "Comma-separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc, display_name, create_time desc` Supported fields are: - `create_time`: corresponds to the time the most recent version of the resource was created. - `state`: corresponds to the state of the resource. - `name`: corresponds to resource name. - `display_name`: corresponds to info type's display name.", "location": "query", "type": "string" }, @@ -1859,7 +2059,7 @@ "type": "string" }, "orderBy": { - "description": "Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Only one order field at a time is allowed. Examples: * `project_id asc` * `table_id` * `sensitivity_level desc` Supported fields are: - `project_id`: The Google Cloud project ID. - `dataset_id`: The ID of a BigQuery dataset. - `table_id`: The ID of a BigQuery table. - `sensitivity_level`: How sensitive the data in a table is, at most. - `data_risk_level`: How much risk is associated with this data. - `profile_last_generated`: When the profile was last updated in epoch seconds. - `last_modified`: The last time the resource was modified. - `resource_visibility`: Visibility restriction for this resource. - `row_count`: Number of rows in this resource.", + "description": "Comma-separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Only one order field at a time is allowed. Examples: * `project_id asc` * `table_id` * `sensitivity_level desc` Supported fields are: - `project_id`: The Google Cloud project ID. - `dataset_id`: The ID of a BigQuery dataset. - `table_id`: The ID of a BigQuery table. - `sensitivity_level`: How sensitive the data in a table is, at most. - `data_risk_level`: How much risk is associated with this data. - `profile_last_generated`: When the profile was last updated in epoch seconds. - `last_modified`: The last time the resource was modified. - `resource_visibility`: Visibility restriction for this resource. - `row_count`: Number of rows in this resource.", "location": "query", "type": "string" }, @@ -1989,7 +2189,7 @@ "type": "string" }, "orderBy": { - "description": "Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc, display_name, create_time desc` Supported fields are: - `create_time`: corresponds to the time the most recent version of the resource was created. - `state`: corresponds to the state of the resource. - `name`: corresponds to resource name. - `display_name`: corresponds to info type's display name.", + "description": "Comma-separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc, display_name, create_time desc` Supported fields are: - `create_time`: corresponds to the time the most recent version of the resource was created. - `state`: corresponds to the state of the resource. - `name`: corresponds to resource name. - `display_name`: corresponds to info type's display name.", "location": "query", "type": "string" }, @@ -2237,7 +2437,7 @@ "type": "string" }, "orderBy": { - "description": "Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to the time the template was created. - `update_time`: corresponds to the time the template was last updated. - `name`: corresponds to the template's name. - `display_name`: corresponds to the template's display name.", + "description": "Comma-separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to the time the template was created. - `update_time`: corresponds to the time the template was last updated. - `name`: corresponds to the template's name. - `display_name`: corresponds to the template's display name.", "location": "query", "type": "string" }, @@ -2426,7 +2626,7 @@ "type": "string" }, "orderBy": { - "description": "Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc, end_time asc, create_time desc` Supported fields are: - `create_time`: corresponds to the time the job was created. - `end_time`: corresponds to the time the job ended. - `name`: corresponds to the job's name. - `state`: corresponds to `state`", + "description": "Comma-separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc, end_time asc, create_time desc` Supported fields are: - `create_time`: corresponds to the time the job was created. - `end_time`: corresponds to the time the job ended. - `name`: corresponds to the job's name. - `state`: corresponds to `state`", "location": "query", "type": "string" }, @@ -2601,7 +2801,7 @@ "type": "string" }, "orderBy": { - "description": "Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to the time the template was created. - `update_time`: corresponds to the time the template was last updated. - `name`: corresponds to the template's name. - `display_name`: corresponds to the template's display name.", + "description": "Comma-separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to the time the template was created. - `update_time`: corresponds to the time the template was last updated. - `name`: corresponds to the template's name. - `display_name`: corresponds to the template's display name.", "location": "query", "type": "string" }, @@ -2790,7 +2990,7 @@ "type": "string" }, "orderBy": { - "description": "Comma separated list of triggeredJob fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to the time the JobTrigger was created. - `update_time`: corresponds to the time the JobTrigger was last updated. - `last_run_time`: corresponds to the last time the JobTrigger ran. - `name`: corresponds to the JobTrigger's name. - `display_name`: corresponds to the JobTrigger's display name. - `status`: corresponds to JobTrigger's status.", + "description": "Comma-separated list of triggeredJob fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to the time the JobTrigger was created. - `update_time`: corresponds to the time the JobTrigger was last updated. - `last_run_time`: corresponds to the last time the JobTrigger ran. - `name`: corresponds to the JobTrigger's name. - `display_name`: corresponds to the JobTrigger's display name. - `status`: corresponds to JobTrigger's status.", "location": "query", "type": "string" }, @@ -2910,7 +3110,7 @@ "type": "string" }, "orderBy": { - "description": "Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Only one order field at a time is allowed. Examples: * `project_id asc` * `table_id` * `sensitivity_level desc` Supported fields are: - `project_id`: The Google Cloud project ID. - `dataset_id`: The ID of a BigQuery dataset. - `table_id`: The ID of a BigQuery table. - `sensitivity_level`: How sensitive the data in a column is, at most. - `data_risk_level`: How much risk is associated with this data. - `profile_last_generated`: When the profile was last updated in epoch seconds.", + "description": "Comma-separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Only one order field at a time is allowed. Examples: * `project_id asc` * `table_id` * `sensitivity_level desc` Supported fields are: - `project_id`: The Google Cloud project ID. - `dataset_id`: The ID of a BigQuery dataset. - `table_id`: The ID of a BigQuery table. - `sensitivity_level`: How sensitive the data in a column is, at most. - `data_risk_level`: How much risk is associated with this data. - `profile_last_generated`: When the profile was last updated in epoch seconds.", "location": "query", "type": "string" }, @@ -3318,7 +3518,7 @@ "type": "string" }, "orderBy": { - "description": "Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to the time the template was created. - `update_time`: corresponds to the time the template was last updated. - `name`: corresponds to the template's name. - `display_name`: corresponds to the template's display name.", + "description": "Comma-separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to the time the template was created. - `update_time`: corresponds to the time the template was last updated. - `name`: corresponds to the template's name. - `display_name`: corresponds to the template's display name.", "location": "query", "type": "string" }, @@ -3469,7 +3669,7 @@ ], "parameters": { "orderBy": { - "description": "Comma separated list of config fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `last_run_time`: corresponds to the last time the DiscoveryConfig ran. - `name`: corresponds to the DiscoveryConfig's name. - `status`: corresponds to DiscoveryConfig's status.", + "description": "Comma-separated list of config fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `last_run_time`: corresponds to the last time the DiscoveryConfig ran. - `name`: corresponds to the DiscoveryConfig's name. - `status`: corresponds to DiscoveryConfig's status.", "location": "query", "type": "string" }, @@ -3714,7 +3914,7 @@ "type": "string" }, "orderBy": { - "description": "Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc, end_time asc, create_time desc` Supported fields are: - `create_time`: corresponds to the time the job was created. - `end_time`: corresponds to the time the job ended. - `name`: corresponds to the job's name. - `state`: corresponds to `state`", + "description": "Comma-separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc, end_time asc, create_time desc` Supported fields are: - `create_time`: corresponds to the time the job was created. - `end_time`: corresponds to the time the job ended. - `name`: corresponds to the job's name. - `state`: corresponds to `state`", "location": "query", "type": "string" }, @@ -3824,12 +4024,12 @@ ], "parameters": { "filter": { - "description": "Optional. Allows filtering. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * Supported fields/values: - `project_id` - The Google Cloud project ID. - `file_store_path` - The path like \"gs://bucket\". - `sensitivity_level` - HIGH|MODERATE|LOW - `data_risk_level` - HIGH|MODERATE|LOW - `resource_visibility`: PUBLIC|RESTRICTED - `status_code` - an RPC status code as defined in https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto * The operator must be `=` or `!=`. Examples: * `project_id = 12345 AND status_code = 1` * `project_id = 12345 AND sensitivity_level = HIGH` * `project_id = 12345 AND resource_visibility = PUBLIC` . * 'file_store_path = \"gs://mybucket\"` The length of this field should be no more than 500 characters.", + "description": "Optional. Allows filtering. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * Supported fields/values: - `project_id` - The Google Cloud project ID. - `file_store_path` - The path like \"gs://bucket\". - `sensitivity_level` - HIGH|MODERATE|LOW - `data_risk_level` - HIGH|MODERATE|LOW - `resource_visibility`: PUBLIC|RESTRICTED - `status_code` - an RPC status code as defined in https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto * The operator must be `=` or `!=`. Examples: * `project_id = 12345 AND status_code = 1` * `project_id = 12345 AND sensitivity_level = HIGH` * `project_id = 12345 AND resource_visibility = PUBLIC` * `file_store_path = \"gs://mybucket\"` The length of this field should be no more than 500 characters.", "location": "query", "type": "string" }, "orderBy": { - "description": "Optional. Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Only one order field at a time is allowed. Examples: * `project_id asc` * `name` * `sensitivity_level desc` Supported fields are: - `project_id`: The Google Cloud project ID. - `sensitivity_level`: How sensitive the data in a table is, at most. - `data_risk_level`: How much risk is associated with this data. - `profile_last_generated`: When the profile was last updated in epoch seconds. - `last_modified`: The last time the resource was modified. - `resource_visibility`: Visibility restriction for this resource. - `name`: The name of the profile. - `create_time`: The time the file store was first created.", + "description": "Optional. Comma-separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Only one order field at a time is allowed. Examples: * `project_id asc` * `name` * `sensitivity_level desc` Supported fields are: - `project_id`: The Google Cloud project ID. - `sensitivity_level`: How sensitive the data in a table is, at most. - `data_risk_level`: How much risk is associated with this data. - `profile_last_generated`: When the profile was last updated in epoch seconds. - `last_modified`: The last time the resource was modified. - `resource_visibility`: Visibility restriction for this resource. - `name`: The name of the profile. - `create_time`: The time the file store was first created.", "location": "query", "type": "string" }, @@ -3989,7 +4189,7 @@ "type": "string" }, "orderBy": { - "description": "Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to the time the template was created. - `update_time`: corresponds to the time the template was last updated. - `name`: corresponds to the template's name. - `display_name`: corresponds to the template's display name.", + "description": "Comma-separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to the time the template was created. - `update_time`: corresponds to the time the template was last updated. - `name`: corresponds to the template's name. - `display_name`: corresponds to the template's display name.", "location": "query", "type": "string" }, @@ -4206,7 +4406,7 @@ "type": "string" }, "orderBy": { - "description": "Comma separated list of triggeredJob fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to the time the JobTrigger was created. - `update_time`: corresponds to the time the JobTrigger was last updated. - `last_run_time`: corresponds to the last time the JobTrigger ran. - `name`: corresponds to the JobTrigger's name. - `display_name`: corresponds to the JobTrigger's display name. - `status`: corresponds to JobTrigger's status.", + "description": "Comma-separated list of triggeredJob fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to the time the JobTrigger was created. - `update_time`: corresponds to the time the JobTrigger was last updated. - `last_run_time`: corresponds to the last time the JobTrigger ran. - `name`: corresponds to the JobTrigger's name. - `display_name`: corresponds to the JobTrigger's display name. - `status`: corresponds to JobTrigger's status.", "location": "query", "type": "string" }, @@ -4324,7 +4524,7 @@ "type": "string" }, "orderBy": { - "description": "Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Only one order field at a time is allowed. Examples: * `project_id` * `sensitivity_level desc` Supported fields are: - `project_id`: Google Cloud project ID - `sensitivity_level`: How sensitive the data in a project is, at most. - `data_risk_level`: How much risk is associated with this data. - `profile_last_generated`: When the profile was last updated in epoch seconds.", + "description": "Comma-separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Only one order field at a time is allowed. Examples: * `project_id` * `sensitivity_level desc` Supported fields are: - `project_id`: Google Cloud project ID - `sensitivity_level`: How sensitive the data in a project is, at most. - `data_risk_level`: How much risk is associated with this data. - `profile_last_generated`: When the profile was last updated in epoch seconds.", "location": "query", "type": "string" }, @@ -4452,7 +4652,7 @@ "type": "string" }, "orderBy": { - "description": "Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc, display_name, create_time desc` Supported fields are: - `create_time`: corresponds to the time the most recent version of the resource was created. - `state`: corresponds to the state of the resource. - `name`: corresponds to resource name. - `display_name`: corresponds to info type's display name.", + "description": "Comma-separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc, display_name, create_time desc` Supported fields are: - `create_time`: corresponds to the time the most recent version of the resource was created. - `state`: corresponds to the state of the resource. - `name`: corresponds to resource name. - `display_name`: corresponds to info type's display name.", "location": "query", "type": "string" }, @@ -4580,7 +4780,7 @@ "type": "string" }, "orderBy": { - "description": "Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Only one order field at a time is allowed. Examples: * `project_id asc` * `table_id` * `sensitivity_level desc` Supported fields are: - `project_id`: The Google Cloud project ID. - `dataset_id`: The ID of a BigQuery dataset. - `table_id`: The ID of a BigQuery table. - `sensitivity_level`: How sensitive the data in a table is, at most. - `data_risk_level`: How much risk is associated with this data. - `profile_last_generated`: When the profile was last updated in epoch seconds. - `last_modified`: The last time the resource was modified. - `resource_visibility`: Visibility restriction for this resource. - `row_count`: Number of rows in this resource.", + "description": "Comma-separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Only one order field at a time is allowed. Examples: * `project_id asc` * `table_id` * `sensitivity_level desc` Supported fields are: - `project_id`: The Google Cloud project ID. - `dataset_id`: The ID of a BigQuery dataset. - `table_id`: The ID of a BigQuery table. - `sensitivity_level`: How sensitive the data in a table is, at most. - `data_risk_level`: How much risk is associated with this data. - `profile_last_generated`: When the profile was last updated in epoch seconds. - `last_modified`: The last time the resource was modified. - `resource_visibility`: Visibility restriction for this resource. - `row_count`: Number of rows in this resource.", "location": "query", "type": "string" }, @@ -4710,7 +4910,7 @@ "type": "string" }, "orderBy": { - "description": "Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc, display_name, create_time desc` Supported fields are: - `create_time`: corresponds to the time the most recent version of the resource was created. - `state`: corresponds to the state of the resource. - `name`: corresponds to resource name. - `display_name`: corresponds to info type's display name.", + "description": "Comma-separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc, display_name, create_time desc` Supported fields are: - `create_time`: corresponds to the time the most recent version of the resource was created. - `state`: corresponds to the state of the resource. - `name`: corresponds to resource name. - `display_name`: corresponds to info type's display name.", "location": "query", "type": "string" }, @@ -4774,7 +4974,7 @@ } } }, - "revision": "20240624", + "revision": "20240707", "rootUrl": "https://dlp.googleapis.com/", "schemas": { "GooglePrivacyDlpV2Action": { @@ -4847,6 +5047,12 @@ "properties": {}, "type": "object" }, + "GooglePrivacyDlpV2AllOtherResources": { + "description": "Match discovery resources not covered by any other filter.", + "id": "GooglePrivacyDlpV2AllOtherResources", + "properties": {}, + "type": "object" + }, "GooglePrivacyDlpV2AllText": { "description": "Apply to all text.", "id": "GooglePrivacyDlpV2AllText", @@ -5419,6 +5625,29 @@ }, "type": "object" }, + "GooglePrivacyDlpV2CloudStorageDiscoveryTarget": { + "description": "Target used to match against for discovery with Cloud Storage buckets.", + "id": "GooglePrivacyDlpV2CloudStorageDiscoveryTarget", + "properties": { + "conditions": { + "$ref": "GooglePrivacyDlpV2DiscoveryFileStoreConditions", + "description": "Optional. In addition to matching the filter, these conditions must be true before a profile is generated." + }, + "disabled": { + "$ref": "GooglePrivacyDlpV2Disabled", + "description": "Optional. Disable profiling for buckets that match this filter." + }, + "filter": { + "$ref": "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." + }, + "generationCadence": { + "$ref": "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." + } + }, + "type": "object" + }, "GooglePrivacyDlpV2CloudStorageFileSet": { "description": "Message representing a set of files in Cloud Storage.", "id": "GooglePrivacyDlpV2CloudStorageFileSet", @@ -5514,6 +5743,21 @@ }, "type": "object" }, + "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.", + "id": "GooglePrivacyDlpV2CloudStorageRegex", + "properties": { + "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" + }, + "projectIdRegex": { + "description": "Optional. For organizations, if unset, will match all projects.", + "type": "string" + } + }, + "type": "object" + }, "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 `/`", "id": "GooglePrivacyDlpV2CloudStorageRegexFileSet", @@ -5539,6 +5783,21 @@ }, "type": "object" }, + "GooglePrivacyDlpV2CloudStorageResourceReference": { + "description": "Identifies a single Cloud Storage bucket.", + "id": "GooglePrivacyDlpV2CloudStorageResourceReference", + "properties": { + "bucketName": { + "description": "Required. The bucket to scan.", + "type": "string" + }, + "projectId": { + "description": "Required. If within a project-level config, then this must match the config's project id.", + "type": "string" + } + }, + "type": "object" + }, "GooglePrivacyDlpV2Color": { "description": "Represents a color in the RGB color space.", "id": "GooglePrivacyDlpV2Color", @@ -6310,7 +6569,7 @@ "id": "GooglePrivacyDlpV2DataProfileLocation", "properties": { "folderId": { - "description": "The ID of the Folder within an organization to scan.", + "description": "The ID of the folder within an organization to scan.", "format": "int64", "type": "string" }, @@ -6573,11 +6832,11 @@ "id": "GooglePrivacyDlpV2Deidentify", "properties": { "cloudStorageOutput": { - "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", + "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", "type": "string" }, "fileTypesToTransform": { - "description": "List of user-specified file type groups to transform. If specified, only the files with these filetypes 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 filetypes supported are: IMAGES, TEXT_FILES, CSV, TSV.", + "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.", "items": { "enum": [ "FILE_TYPE_UNSPECIFIED", @@ -7028,6 +7287,107 @@ }, "type": "object" }, + "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.", + "id": "GooglePrivacyDlpV2DiscoveryCloudStorageConditions", + "properties": { + "includedBucketAttributes": { + "description": "Required. Only objects with the specified attributes will be scanned. Defaults to [ALL_SUPPORTED_BUCKETS] if unset.", + "items": { + "enum": [ + "CLOUD_STORAGE_BUCKET_ATTRIBUTE_UNSPECIFIED", + "ALL_SUPPORTED_BUCKETS", + "AUTOCLASS_DISABLED", + "AUTOCLASS_ENABLED" + ], + "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." + ], + "type": "string" + }, + "type": "array" + }, + "includedObjectAttributes": { + "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.", + "items": { + "enum": [ + "CLOUD_STORAGE_OBJECT_ATTRIBUTE_UNSPECIFIED", + "ALL_SUPPORTED_OBJECTS", + "STANDARD", + "NEARLINE", + "COLDLINE", + "ARCHIVE", + "REGIONAL", + "MULTI_REGIONAL", + "DURABLE_REDUCED_AVAILABILITY" + ], + "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." + ], + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "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.", + "id": "GooglePrivacyDlpV2DiscoveryCloudStorageFilter", + "properties": { + "cloudStorageResourceReference": { + "$ref": "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": "GooglePrivacyDlpV2FileStoreCollection", + "description": "Optional. A specific set of buckets for this filter to apply to." + }, + "others": { + "$ref": "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." + } + }, + "type": "object" + }, + "GooglePrivacyDlpV2DiscoveryCloudStorageGenerationCadence": { + "description": "How often existing buckets should have their profiles refreshed. New buckets are scanned as quickly as possible depending on system capacity.", + "id": "GooglePrivacyDlpV2DiscoveryCloudStorageGenerationCadence", + "properties": { + "inspectTemplateModifiedCadence": { + "$ref": "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." + }, + "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.", + "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." + ], + "type": "string" + } + }, + "type": "object" + }, "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).", "id": "GooglePrivacyDlpV2DiscoveryConfig", @@ -7108,10 +7468,35 @@ }, "type": "object" }, + "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.", + "id": "GooglePrivacyDlpV2DiscoveryFileStoreConditions", + "properties": { + "cloudStorageConditions": { + "$ref": "GooglePrivacyDlpV2DiscoveryCloudStorageConditions", + "description": "Optional. Cloud Storage conditions." + }, + "createdAfter": { + "description": "Optional. File store must have been created after this date. Used to avoid backfilling.", + "format": "google-datetime", + "type": "string" + }, + "minAge": { + "description": "Optional. Minimum age a file store must have. If set, the value must be 1 hour or greater.", + "format": "google-duration", + "type": "string" + } + }, + "type": "object" + }, "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.", "id": "GooglePrivacyDlpV2DiscoveryGenerationCadence", "properties": { + "inspectTemplateModifiedCadence": { + "$ref": "GooglePrivacyDlpV2DiscoveryInspectTemplateModifiedCadence", + "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." + }, "schemaModifiedCadence": { "$ref": "GooglePrivacyDlpV2DiscoverySchemaModifiedCadence", "description": "Governs when to update data profiles when a schema is modified." @@ -7123,6 +7508,29 @@ }, "type": "object" }, + "GooglePrivacyDlpV2DiscoveryInspectTemplateModifiedCadence": { + "description": "The cadence at which to update data profiles when the inspection rules defined by the `InspectTemplate` change.", + "id": "GooglePrivacyDlpV2DiscoveryInspectTemplateModifiedCadence", + "properties": { + "frequency": { + "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" + ], + "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." + ], + "type": "string" + } + }, + "type": "object" + }, "GooglePrivacyDlpV2DiscoverySchemaModifiedCadence": { "description": "The cadence at which to update data profiles when a schema is modified.", "id": "GooglePrivacyDlpV2DiscoverySchemaModifiedCadence", @@ -7168,7 +7576,7 @@ "id": "GooglePrivacyDlpV2DiscoveryStartingLocation", "properties": { "folderId": { - "description": "The ID of the Folder within an organization to scan.", + "description": "The ID of the folder within an organization to scan.", "format": "int64", "type": "string" }, @@ -7230,6 +7638,10 @@ "$ref": "GooglePrivacyDlpV2CloudSqlDiscoveryTarget", "description": "Cloud SQL target for Discovery. The first target to match a table will be the one applied." }, + "cloudStorageTarget": { + "$ref": "GooglePrivacyDlpV2CloudStorageDiscoveryTarget", + "description": "Cloud Storage target for Discovery. The first target to match a table will be the one applied." + }, "secretsTarget": { "$ref": "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." @@ -7534,7 +7946,7 @@ "description": "The data risk level of this cluster. RISK_LOW if nothing has been scanned." }, "errors": { - "description": "A list of Errors detected while scanning this cluster. The list is truncated to 10 per cluster.", + "description": "A list of errors detected while scanning this cluster. The list is truncated to 10 per cluster.", "items": { "$ref": "GooglePrivacyDlpV2Error" }, @@ -7637,8 +8049,19 @@ }, "type": "object" }, + "GooglePrivacyDlpV2FileStoreCollection": { + "description": "Match file stores (e.g. buckets) using regex filters.", + "id": "GooglePrivacyDlpV2FileStoreCollection", + "properties": { + "includeRegexes": { + "$ref": "GooglePrivacyDlpV2FileStoreRegexes", + "description": "Optional. A collection of regular expressions to match a file store against." + } + }, + "type": "object" + }, "GooglePrivacyDlpV2FileStoreDataProfile": { - "description": "The profile for a file store. * Google Cloud Storage: maps 1:1 with a bucket.", + "description": "The profile for a file store. * Cloud Storage: maps 1:1 with a bucket.", "id": "GooglePrivacyDlpV2FileStoreDataProfile", "properties": { "configSnapshot": { @@ -7659,7 +8082,7 @@ "description": "The resource type that was profiled." }, "dataStorageLocations": { - "description": "For resources that have multiple storage locations, these are those regions. For Google 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.", + "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.", "items": { "type": "string" }, @@ -7684,11 +8107,11 @@ "type": "boolean" }, "fileStoreLocation": { - "description": "The location of the file store. * Google Cloud Storage: https://cloud.google.com/storage/docs/locations#available-locations", + "description": "The location of the file store. * Cloud Storage: https://cloud.google.com/storage/docs/locations#available-locations", "type": "string" }, "fileStorePath": { - "description": "The file store path. * Google Cloud Storage: `gs://{bucket}`", + "description": "The file store path. * Cloud Storage: `gs://{bucket}`", "type": "string" }, "fullResource": { @@ -7718,7 +8141,7 @@ "description": "Success or error status from the most recent profile generation attempt. May be empty if the profile is still being generated." }, "projectDataProfile": { - "description": "The resource name to the project data profile for this file store.", + "description": "The resource name of the project data profile for this file store.", "type": "string" }, "projectId": { @@ -7729,7 +8152,7 @@ "additionalProperties": { "$ref": "GooglePrivacyDlpV2Value" }, - "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.", + "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.", "type": "object" }, "resourceLabels": { @@ -7787,6 +8210,31 @@ }, "type": "object" }, + "GooglePrivacyDlpV2FileStoreRegex": { + "description": "A pattern to match against one or more file stores.", + "id": "GooglePrivacyDlpV2FileStoreRegex", + "properties": { + "cloudStorageRegex": { + "$ref": "GooglePrivacyDlpV2CloudStorageRegex", + "description": "Optional. Regex for Cloud Storage." + } + }, + "type": "object" + }, + "GooglePrivacyDlpV2FileStoreRegexes": { + "description": "A collection of regular expressions to determine what file store to match against.", + "id": "GooglePrivacyDlpV2FileStoreRegexes", + "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.", + "items": { + "$ref": "GooglePrivacyDlpV2FileStoreRegex" + }, + "type": "array" + } + }, + "type": "object" + }, "GooglePrivacyDlpV2Finding": { "description": "Represents a piece of potentially sensitive content.", "id": "GooglePrivacyDlpV2Finding", @@ -10830,7 +11278,7 @@ "description": "Success or error status from the most recent profile generation attempt. May be empty if the profile is still being generated." }, "projectDataProfile": { - "description": "The resource name to the project data profile for this table.", + "description": "The resource name of the project data profile for this table.", "type": "string" }, "resourceLabels": { diff --git a/discovery/documentai-v1.json b/discovery/documentai-v1.json index 9cd1f5c048..6512cfa530 100644 --- a/discovery/documentai-v1.json +++ b/discovery/documentai-v1.json @@ -1042,7 +1042,7 @@ } } }, - "revision": "20240619", + "revision": "20240716", "rootUrl": "https://documentai.googleapis.com/", "schemas": { "GoogleCloudDocumentaiUiv1beta3AutoLabelDocumentsMetadata": { @@ -4686,6 +4686,11 @@ "$ref": "GoogleCloudDocumentaiV1DocumentSchema", "description": "The schema of the processor version. Describes the output." }, + "genAiModelInfo": { + "$ref": "GoogleCloudDocumentaiV1ProcessorVersionGenAiModelInfo", + "description": "Output only. Information about Generative AI model-based processor versions.", + "readOnly": true + }, "googleManaged": { "description": "Output only. Denotes that this `ProcessorVersion` is managed by Google.", "readOnly": true, @@ -4793,6 +4798,62 @@ }, "type": "object" }, + "GoogleCloudDocumentaiV1ProcessorVersionGenAiModelInfo": { + "description": "Information about Generative AI model-based processor versions.", + "id": "GoogleCloudDocumentaiV1ProcessorVersionGenAiModelInfo", + "properties": { + "customGenAiModelInfo": { + "$ref": "GoogleCloudDocumentaiV1ProcessorVersionGenAiModelInfoCustomGenAiModelInfo", + "description": "Information for a custom Generative AI model created by the user." + }, + "foundationGenAiModelInfo": { + "$ref": "GoogleCloudDocumentaiV1ProcessorVersionGenAiModelInfoFoundationGenAiModelInfo", + "description": "Information for a pretrained Google-managed foundation model." + } + }, + "type": "object" + }, + "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.", + "id": "GoogleCloudDocumentaiV1ProcessorVersionGenAiModelInfoCustomGenAiModelInfo", + "properties": { + "baseProcessorVersionId": { + "description": "The base processor version ID for the custom model.", + "type": "string" + }, + "customModelType": { + "description": "The type of custom model created by the user.", + "enum": [ + "CUSTOM_MODEL_TYPE_UNSPECIFIED", + "VERSIONED_FOUNDATION", + "FINE_TUNED" + ], + "enumDescriptions": [ + "The model type is unspecified.", + "The model is a versioned foundation model.", + "The model is a finetuned foundation model." + ], + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiV1ProcessorVersionGenAiModelInfoFoundationGenAiModelInfo": { + "description": "Information for a pretrained Google-managed foundation model.", + "id": "GoogleCloudDocumentaiV1ProcessorVersionGenAiModelInfoFoundationGenAiModelInfo", + "properties": { + "finetuningAllowed": { + "description": "Whether finetuning is allowed for this base processor version.", + "type": "boolean" + }, + "minTrainLabeledDocuments": { + "description": "The minimum number of labeled documents in the training dataset required for finetuning.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, "GoogleCloudDocumentaiV1RawDocument": { "description": "Payload message of raw document content (bytes).", "id": "GoogleCloudDocumentaiV1RawDocument", diff --git a/discovery/documentai-v1beta3.json b/discovery/documentai-v1beta3.json index 840e8a667a..2e031339a5 100644 --- a/discovery/documentai-v1beta3.json +++ b/discovery/documentai-v1beta3.json @@ -1284,7 +1284,7 @@ } } }, - "revision": "20240619", + "revision": "20240716", "rootUrl": "https://documentai.googleapis.com/", "schemas": { "GoogleCloudDocumentaiUiv1beta3AutoLabelDocumentsMetadata": { @@ -9293,6 +9293,11 @@ "$ref": "GoogleCloudDocumentaiV1beta3DocumentSchema", "description": "The schema of the processor version. Describes the output." }, + "genAiModelInfo": { + "$ref": "GoogleCloudDocumentaiV1beta3ProcessorVersionGenAiModelInfo", + "description": "Output only. Information about Generative AI model-based processor versions.", + "readOnly": true + }, "googleManaged": { "description": "Output only. Denotes that this `ProcessorVersion` is managed by Google.", "readOnly": true, @@ -9400,6 +9405,62 @@ }, "type": "object" }, + "GoogleCloudDocumentaiV1beta3ProcessorVersionGenAiModelInfo": { + "description": "Information about Generative AI model-based processor versions.", + "id": "GoogleCloudDocumentaiV1beta3ProcessorVersionGenAiModelInfo", + "properties": { + "customGenAiModelInfo": { + "$ref": "GoogleCloudDocumentaiV1beta3ProcessorVersionGenAiModelInfoCustomGenAiModelInfo", + "description": "Information for a custom Generative AI model created by the user." + }, + "foundationGenAiModelInfo": { + "$ref": "GoogleCloudDocumentaiV1beta3ProcessorVersionGenAiModelInfoFoundationGenAiModelInfo", + "description": "Information for a pretrained Google-managed foundation model." + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiV1beta3ProcessorVersionGenAiModelInfoCustomGenAiModelInfo": { + "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.", + "id": "GoogleCloudDocumentaiV1beta3ProcessorVersionGenAiModelInfoCustomGenAiModelInfo", + "properties": { + "baseProcessorVersionId": { + "description": "The base processor version ID for the custom model.", + "type": "string" + }, + "customModelType": { + "description": "The type of custom model created by the user.", + "enum": [ + "CUSTOM_MODEL_TYPE_UNSPECIFIED", + "VERSIONED_FOUNDATION", + "FINE_TUNED" + ], + "enumDescriptions": [ + "The model type is unspecified.", + "The model is a versioned foundation model.", + "The model is a finetuned foundation model." + ], + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiV1beta3ProcessorVersionGenAiModelInfoFoundationGenAiModelInfo": { + "description": "Information for a pretrained Google-managed foundation model.", + "id": "GoogleCloudDocumentaiV1beta3ProcessorVersionGenAiModelInfoFoundationGenAiModelInfo", + "properties": { + "finetuningAllowed": { + "description": "Whether finetuning is allowed for this base processor version.", + "type": "boolean" + }, + "minTrainLabeledDocuments": { + "description": "The minimum number of labeled documents in the training dataset required for finetuning.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, "GoogleCloudDocumentaiV1beta3PropertyMetadata": { "description": "Metadata about a property.", "id": "GoogleCloudDocumentaiV1beta3PropertyMetadata", diff --git a/discovery/doubleclickbidmanager-v2.json b/discovery/doubleclickbidmanager-v2.json index 847c074268..4897ab5cd5 100644 --- a/discovery/doubleclickbidmanager-v2.json +++ b/discovery/doubleclickbidmanager-v2.json @@ -319,7 +319,7 @@ } } }, - "revision": "20240424", + "revision": "20240703", "rootUrl": "https://doubleclickbidmanager.googleapis.com/", "schemas": { "DataRange": { @@ -506,7 +506,9 @@ "GRP", "YOUTUBE_PROGRAMMATIC_GUARANTEED", "REACH", - "UNIQUE_REACH_AUDIENCE" + "UNIQUE_REACH_AUDIENCE", + "FULL_PATH", + "PATH_ATTRIBUTION" ], "enumDeprecated": [ false, @@ -518,7 +520,9 @@ false, false, false, - false + false, + true, + true ], "enumDescriptions": [ "Default value when report type is not specified or is unknown in this version.", @@ -530,7 +534,9 @@ "GRP report.", "YouTube Programmatic Guaranteed report.", "Reach report.", - "Unique Reach Audience report." + "Unique Reach Audience report.", + "Full Path report.", + "Path Attribution report." ], "type": "string" } diff --git a/discovery/drive-v2.json b/discovery/drive-v2.json index a20c3a4c3c..4f9817c389 100644 --- a/discovery/drive-v2.json +++ b/discovery/drive-v2.json @@ -3869,7 +3869,7 @@ } } }, - "revision": "20240522", + "revision": "20240713", "rootUrl": "https://www.googleapis.com/", "schemas": { "About": { @@ -5614,10 +5614,10 @@ "description": "Output only. User that shared the item with the current user, if available." }, "shortcutDetails": { - "description": "Shortcut file details. Only populated for shortcut files, which have the mimeType field set to `application/vnd.google-apps.shortcut`.", + "description": "Shortcut file details. Only populated for shortcut files, which have the mimeType field set to `application/vnd.google-apps.shortcut`. Can only be set on `files.insert` requests.", "properties": { "targetId": { - "description": "The ID of the file that this shortcut points to.", + "description": "The ID of the file that this shortcut points to. Can only be set on `files.insert` requests.", "type": "string" }, "targetMimeType": { diff --git a/discovery/drive-v3.json b/discovery/drive-v3.json index a225c08a5b..3b6a5a3049 100644 --- a/discovery/drive-v3.json +++ b/discovery/drive-v3.json @@ -2523,7 +2523,7 @@ } } }, - "revision": "20240521", + "revision": "20240713", "rootUrl": "https://www.googleapis.com/", "schemas": { "About": { @@ -3851,10 +3851,10 @@ "description": "Output only. The user who shared the file with the requesting user, if applicable." }, "shortcutDetails": { - "description": "Shortcut file details. Only populated for shortcut files, which have the mimeType field set to `application/vnd.google-apps.shortcut`.", + "description": "Shortcut file details. Only populated for shortcut files, which have the mimeType field set to `application/vnd.google-apps.shortcut`. Can only be set on `files.create` requests.", "properties": { "targetId": { - "description": "The ID of the file that this shortcut points to.", + "description": "The ID of the file that this shortcut points to. Can only be set on `files.create` requests.", "type": "string" }, "targetMimeType": { diff --git a/discovery/essentialcontacts-v1.json b/discovery/essentialcontacts-v1.json index b133e0eeb5..9db8f651f4 100644 --- a/discovery/essentialcontacts-v1.json +++ b/discovery/essentialcontacts-v1.json @@ -850,7 +850,7 @@ } } }, - "revision": "20221220", + "revision": "20240713", "rootUrl": "https://essentialcontacts.googleapis.com/", "schemas": { "GoogleCloudEssentialcontactsV1ComputeContactsResponse": { @@ -923,7 +923,7 @@ "type": "string" }, "validationState": { - "description": "The validity of the contact. A contact is considered valid if it is the correct recipient for notifications for a particular resource.", + "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.", "enum": [ "VALIDATION_STATE_UNSPECIFIED", "VALID", @@ -934,6 +934,7 @@ "The contact is marked as valid. This is usually done manually by the contact admin. All new contacts begin in the valid state.", "The contact is considered invalid. This may become the state if the contact's email is found to be unreachable." ], + "readOnly": true, "type": "string" } }, diff --git a/discovery/file-v1beta1.json b/discovery/file-v1beta1.json index 6c63bca5f3..e8fbbd7fc7 100644 --- a/discovery/file-v1beta1.json +++ b/discovery/file-v1beta1.json @@ -1069,7 +1069,7 @@ } } }, - "revision": "20240619", + "revision": "20240704", "rootUrl": "https://file.googleapis.com/", "schemas": { "Backup": { @@ -1098,6 +1098,21 @@ "readOnly": true, "type": "string" }, + "fileSystemProtocol": { + "description": "Output only. The file system protocol of the source Filestore instance that this backup is created from.", + "enum": [ + "FILE_PROTOCOL_UNSPECIFIED", + "NFS_V3", + "NFS_V4_1" + ], + "enumDescriptions": [ + "FILE_PROTOCOL_UNSPECIFIED serves a \"not set\" default value when a FileProtocol is a separate field in a message.", + "NFS 3.0.", + "NFS 4.1." + ], + "readOnly": true, + "type": "string" + }, "kmsKeyName": { "description": "Immutable. KMS key name used for data encryption.", "type": "string" diff --git a/discovery/firebaseappcheck-v1.json b/discovery/firebaseappcheck-v1.json index 293b915c4e..af417cfe54 100644 --- a/discovery/firebaseappcheck-v1.json +++ b/discovery/firebaseappcheck-v1.json @@ -1458,12 +1458,210 @@ "https://www.googleapis.com/auth/firebase" ] } + }, + "resources": { + "resourcePolicies": { + "methods": { + "batchUpdate": { + "description": "Atomically updates the specified ResourcePolicy configurations.", + "flatPath": "v1/projects/{projectsId}/services/{servicesId}/resourcePolicies:batchUpdate", + "httpMethod": "POST", + "id": "firebaseappcheck.projects.services.resourcePolicies.batchUpdate", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The parent service name, in the format ``` projects/{project_number}/services/{service_id} ``` The parent collection in the `name` field of any resource being updated must match this field, or the entire batch fails.", + "location": "path", + "pattern": "^projects/[^/]+/services/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/resourcePolicies:batchUpdate", + "request": { + "$ref": "GoogleFirebaseAppcheckV1BatchUpdateResourcePoliciesRequest" + }, + "response": { + "$ref": "GoogleFirebaseAppcheckV1BatchUpdateResourcePoliciesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/firebase" + ] + }, + "create": { + "description": "Creates the specified ResourcePolicy configuration.", + "flatPath": "v1/projects/{projectsId}/services/{servicesId}/resourcePolicies", + "httpMethod": "POST", + "id": "firebaseappcheck.projects.services.resourcePolicies.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The relative resource name of the parent Service in which the specified ResourcePolicy will be created, in the format: ``` projects/{project_number}/services/{service_id} ``` Note that the `service_id` element must be a supported service ID. Currently, the following service IDs are supported: * `oauth2.googleapis.com` (Google Identity for iOS)", + "location": "path", + "pattern": "^projects/[^/]+/services/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/resourcePolicies", + "request": { + "$ref": "GoogleFirebaseAppcheckV1ResourcePolicy" + }, + "response": { + "$ref": "GoogleFirebaseAppcheckV1ResourcePolicy" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/firebase" + ] + }, + "delete": { + "description": "Deletes the specified ResourcePolicy configuration.", + "flatPath": "v1/projects/{projectsId}/services/{servicesId}/resourcePolicies/{resourcePoliciesId}", + "httpMethod": "DELETE", + "id": "firebaseappcheck.projects.services.resourcePolicies.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "etag": { + "description": "The checksum to be validated against the current ResourcePolicy, to ensure the client has an up-to-date value before proceeding. This checksum is computed by the server based on the values of fields in the ResourcePolicy object, and can be obtained from the ResourcePolicy object received from the last CreateResourcePolicy, GetResourcePolicy, ListResourcePolicies, UpdateResourcePolicy, or BatchUpdateResourcePolicies call. This etag is strongly validated as defined by RFC 7232.", + "location": "query", + "type": "string" + }, + "name": { + "description": "Required. The relative resource name of the ResourcePolicy to delete, in the format: ``` projects/{project_number}/services/{service_id}/resourcePolicies/{resource_policy_id} ```", + "location": "path", + "pattern": "^projects/[^/]+/services/[^/]+/resourcePolicies/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/firebase" + ] + }, + "get": { + "description": "Gets the requested ResourcePolicy configuration.", + "flatPath": "v1/projects/{projectsId}/services/{servicesId}/resourcePolicies/{resourcePoliciesId}", + "httpMethod": "GET", + "id": "firebaseappcheck.projects.services.resourcePolicies.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The relative resource name of the ResourcePolicy to retrieve, in the format: ``` projects/{project_number}/services/{service_id}/resourcePolicies/{resource_policy_id} ``` Note that the `service_id` element must be a supported service ID. Currently, the following service IDs are supported: * `oauth2.googleapis.com` (Google Identity for iOS)", + "location": "path", + "pattern": "^projects/[^/]+/services/[^/]+/resourcePolicies/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleFirebaseAppcheckV1ResourcePolicy" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/firebase" + ] + }, + "list": { + "description": "Lists all ResourcePolicy configurations for the specified project and service.", + "flatPath": "v1/projects/{projectsId}/services/{servicesId}/resourcePolicies", + "httpMethod": "GET", + "id": "firebaseappcheck.projects.services.resourcePolicies.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. Filters the results by the specified rule. For the exact syntax of this field, please consult the [AIP-160](https://google.aip.dev/160) standard. Currently, since the only fields in the ResourcePolicy resource are the scalar fields `enforcement_mode` and `target_resource`, this method does not support the traversal operator (`.`) or the has operator (`:`). Here are some examples of valid filters: * `enforcement_mode = ENFORCED` * `target_resource = \"//oauth2.googleapis.com/projects/12345/oauthClients/\"` * `enforcement_mode = ENFORCED AND target_resource = \"//oauth2.googleapis.com/projects/12345/oauthClients/\"`", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "The maximum number of ResourcePolicy objects to return in the response. The server may return fewer than this at its own discretion. If no value is specified (or too large a value is specified), the server will impose its own limit.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Token returned from a previous call to ListResourcePolicies indicating where in the set of ResourcePolicy objects to resume listing. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListResourcePolicies must match the call that provided the page token; if they do not match, the result is undefined.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The relative resource name of the parent Service for which to list each associated ResourcePolicy, in the format: ``` projects/{project_number}/services/{service_id} ``` Note that the `service_id` element must be a supported service ID. Currently, the following service IDs are supported: * `oauth2.googleapis.com` (Google Identity for iOS)", + "location": "path", + "pattern": "^projects/[^/]+/services/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/resourcePolicies", + "response": { + "$ref": "GoogleFirebaseAppcheckV1ListResourcePoliciesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/firebase" + ] + }, + "patch": { + "description": "Updates the specified ResourcePolicy configuration.", + "flatPath": "v1/projects/{projectsId}/services/{servicesId}/resourcePolicies/{resourcePoliciesId}", + "httpMethod": "PATCH", + "id": "firebaseappcheck.projects.services.resourcePolicies.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Identifier. The relative name of the resource policy object, in the format: ``` projects/{project_number}/services/{service_id}/resourcePolicies/{resource_policy_id} ``` Note that the `service_id` element must be a supported service ID. Currently, the following service IDs are supported: * `oauth2.googleapis.com` (Google Identity for iOS) `resource_policy_id` is a system-generated UID.", + "location": "path", + "pattern": "^projects/[^/]+/services/[^/]+/resourcePolicies/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Required. A comma-separated list of names of fields in the ResourcePolicy to update. Example: `enforcement_mode`.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}", + "request": { + "$ref": "GoogleFirebaseAppcheckV1ResourcePolicy" + }, + "response": { + "$ref": "GoogleFirebaseAppcheckV1ResourcePolicy" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/firebase" + ] + } + } + } } } } } }, - "revision": "20240528", + "revision": "20240708", "rootUrl": "https://firebaseappcheck.googleapis.com/", "schemas": { "GoogleFirebaseAppcheckV1AppAttestConfig": { @@ -1583,6 +1781,39 @@ }, "type": "object" }, + "GoogleFirebaseAppcheckV1BatchUpdateResourcePoliciesRequest": { + "description": "Request message for the BatchUpdateResourcePolicies method.", + "id": "GoogleFirebaseAppcheckV1BatchUpdateResourcePoliciesRequest", + "properties": { + "requests": { + "description": "Required. The request messages specifying the ResourcePolicy objects to update. A maximum of 100 objects can be updated in a batch.", + "items": { + "$ref": "GoogleFirebaseAppcheckV1UpdateResourcePolicyRequest" + }, + "type": "array" + }, + "updateMask": { + "description": "Optional. A comma-separated list of names of fields in the ResourcePolicy objects to update. Example: `enforcement_mode`. If this field is present, the `update_mask` field in the UpdateResourcePolicyRequest messages must all match this field, or the entire batch fails and no updates will be committed.", + "format": "google-fieldmask", + "type": "string" + } + }, + "type": "object" + }, + "GoogleFirebaseAppcheckV1BatchUpdateResourcePoliciesResponse": { + "description": "Response message for the BatchUpdateResourcePolicies method.", + "id": "GoogleFirebaseAppcheckV1BatchUpdateResourcePoliciesResponse", + "properties": { + "resourcePolicies": { + "description": "ResourcePolicy objects after the updates have been applied.", + "items": { + "$ref": "GoogleFirebaseAppcheckV1ResourcePolicy" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleFirebaseAppcheckV1BatchUpdateServicesRequest": { "description": "Request message for the BatchUpdateServices method.", "id": "GoogleFirebaseAppcheckV1BatchUpdateServicesRequest", @@ -1903,6 +2134,24 @@ }, "type": "object" }, + "GoogleFirebaseAppcheckV1ListResourcePoliciesResponse": { + "description": "Response message for the ListResourcePolicies method.", + "id": "GoogleFirebaseAppcheckV1ListResourcePoliciesResponse", + "properties": { + "nextPageToken": { + "description": "If the result list is too large to fit in a single response, then a token is returned. If the string is empty or omitted, then this response is the last page of results. This token can be used in a subsequent call to ListResourcePolicies to find the next group of ResourcePolicy objects. Page tokens are short-lived and should not be persisted.", + "type": "string" + }, + "resourcePolicies": { + "description": "The ResourcePolicy objects retrieved.", + "items": { + "$ref": "GoogleFirebaseAppcheckV1ResourcePolicy" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleFirebaseAppcheckV1ListServicesResponse": { "description": "Response message for the ListServices method.", "id": "GoogleFirebaseAppcheckV1ListServicesResponse", @@ -2027,6 +2276,45 @@ }, "type": "object" }, + "GoogleFirebaseAppcheckV1ResourcePolicy": { + "description": "App Check enforcement policy for a specific resource of a Firebase service supported by App Check. Note that this policy will override the service-level configuration.", + "id": "GoogleFirebaseAppcheckV1ResourcePolicy", + "properties": { + "enforcementMode": { + "description": "Required. The App Check enforcement mode for this resource. This will override the EnforcementMode setting on the service.", + "enum": [ + "OFF", + "UNENFORCED", + "ENFORCED" + ], + "enumDescriptions": [ + "Firebase App Check is not enforced for the service, nor are App Check metrics collected. Though the service is not protected by App Check in this mode, other applicable protections, such as user authorization, are still enforced. An unconfigured service is in this mode by default.", + "Firebase App Check is not enforced for the service. App Check metrics are collected to help you decide when to turn on enforcement for the service. Though the service is not protected by App Check in this mode, other applicable protections, such as user authorization, are still enforced. Some services require certain conditions to be met before they will work with App Check, such as requiring you to upgrade to a specific service tier. Until those requirements are met for a service, this `UNENFORCED` setting will have no effect and App Check will not work with that service.", + "Firebase App Check is enforced for the service. The service will reject any request that attempts to access your project's resources if it does not have valid App Check token attached, with some exceptions depending on the service; for example, some services will still allow requests bearing the developer's privileged service account credentials without an App Check token. App Check metrics continue to be collected to help you detect issues with your App Check integration and monitor the composition of your callers. While the service is protected by App Check, other applicable protections, such as user authorization, continue to be enforced at the same time. Use caution when choosing to enforce App Check on a Firebase service. If your users have not updated to an App Check capable version of your app, their apps will no longer be able to use your Firebase services that are enforcing App Check. App Check metrics can help you decide whether to enforce App Check on your Firebase services. If your app has not launched yet, you should enable enforcement immediately, since there are no outdated clients in use. Some services require certain conditions to be met before they will work with App Check, such as requiring you to upgrade to a specific service tier. Until those requirements are met for a service, this `ENFORCED` setting will have no effect and App Check will not work with that service." + ], + "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. This etag is strongly validated as defined by RFC 7232.", + "type": "string" + }, + "name": { + "description": "Required. Identifier. The relative name of the resource policy object, in the format: ``` projects/{project_number}/services/{service_id}/resourcePolicies/{resource_policy_id} ``` Note that the `service_id` element must be a supported service ID. Currently, the following service IDs are supported: * `oauth2.googleapis.com` (Google Identity for iOS) `resource_policy_id` is a system-generated UID.", + "type": "string" + }, + "targetResource": { + "description": "Required. Service specific name of the resource object to which this policy applies, in the format: * `//oauth2.googleapis.com/projects/{project_number}/oauthClients/{oauth_client_id}` (Google Identity for iOS) Note that the resource must belong to the service specified in the `name` and be from the same project as this policy, but the resource is allowed to be missing at the time of creation of this policy; in that case, we make a best-effort attempt at respecting this policy, but it may not have any effect until the resource is fully created.", + "type": "string" + }, + "updateTime": { + "description": "Output only. Timestamp when this resource policy configuration object was most recently updated.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, "GoogleFirebaseAppcheckV1SafetyNetConfig": { "deprecated": true, "description": "An app's SafetyNet configuration object. This configuration controls certain properties of the `AppCheckToken` returned by ExchangeSafetyNetToken, such as its ttl. Note that your registered SHA-256 certificate fingerprints are used to validate tokens issued by SafetyNet; please register them via the Firebase Console or programmatically via the [Firebase Management Service](https://firebase.google.com/docs/projects/api/reference/rest/v11/projects.androidApps.sha/create).", @@ -2069,6 +2357,22 @@ }, "type": "object" }, + "GoogleFirebaseAppcheckV1UpdateResourcePolicyRequest": { + "description": "Request message for the UpdateResourcePolicy method as well as an individual update message for the BatchUpdateResourcePolicies method.", + "id": "GoogleFirebaseAppcheckV1UpdateResourcePolicyRequest", + "properties": { + "resourcePolicy": { + "$ref": "GoogleFirebaseAppcheckV1ResourcePolicy", + "description": "Required. The ResourcePolicy to update. The ResourcePolicy's `name` field is used to identify the ResourcePolicy to be updated, in the format: ``` projects/{project_number}/services/{service_id}/resourcePolicies/{resource_policy_id} ``` Note that the `service_id` element must be a supported service ID. Currently, the following service IDs are supported: * `oauth2.googleapis.com` (Google Identity for iOS)" + }, + "updateMask": { + "description": "Required. A comma-separated list of names of fields in the ResourcePolicy to update. Example: `enforcement_mode`.", + "format": "google-fieldmask", + "type": "string" + } + }, + "type": "object" + }, "GoogleFirebaseAppcheckV1UpdateServiceRequest": { "description": "Request message for the UpdateService method as well as an individual update message for the BatchUpdateServices method.", "id": "GoogleFirebaseAppcheckV1UpdateServiceRequest", diff --git a/discovery/firebaseappdistribution-v1alpha.json b/discovery/firebaseappdistribution-v1alpha.json index 49dc142510..d50643ea38 100644 --- a/discovery/firebaseappdistribution-v1alpha.json +++ b/discovery/firebaseappdistribution-v1alpha.json @@ -585,7 +585,7 @@ } } }, - "revision": "20240628", + "revision": "20240717", "rootUrl": "https://firebaseappdistribution.googleapis.com/", "schemas": { "GoogleFirebaseAppdistroV1Release": { @@ -708,16 +708,16 @@ "steps": { "description": "Required. Steps to be accomplished by the AI", "items": { - "$ref": "GoogleFirebaseAppdistroV1alphaAiInstructionsStep" + "$ref": "GoogleFirebaseAppdistroV1alphaAiStep" }, "type": "array" } }, "type": "object" }, - "GoogleFirebaseAppdistroV1alphaAiInstructionsStep": { + "GoogleFirebaseAppdistroV1alphaAiStep": { "description": "A step to be accomplished by the AI", - "id": "GoogleFirebaseAppdistroV1alphaAiInstructionsStep", + "id": "GoogleFirebaseAppdistroV1alphaAiStep", "properties": { "assertion": { "description": "An assertion to be checked by the AI", @@ -730,6 +730,34 @@ }, "type": "object" }, + "GoogleFirebaseAppdistroV1alphaAiStepResult": { + "description": "Captures the results of an AiStep", + "id": "GoogleFirebaseAppdistroV1alphaAiStepResult", + "properties": { + "state": { + "description": "Output only. The current state of the step", + "enum": [ + "STEP_STATE_UNSPECIFIED", + "IN_PROGRESS", + "PASSED", + "FAILED" + ], + "enumDescriptions": [ + "Step state unspecified", + "The step is in progress", + "The step has completed successfully", + "The step has failed" + ], + "readOnly": true, + "type": "string" + }, + "step": { + "$ref": "GoogleFirebaseAppdistroV1alphaAiStep", + "description": "Required. The step performed by the AI" + } + }, + "type": "object" + }, "GoogleFirebaseAppdistroV1alphaApp": { "id": "GoogleFirebaseAppdistroV1alphaApp", "properties": { @@ -818,6 +846,14 @@ "description": "The results of running an automated test on a particular device.", "id": "GoogleFirebaseAppdistroV1alphaDeviceExecution", "properties": { + "aiStepResults": { + "description": "Output only. Results of the AI steps if passed in", + "items": { + "$ref": "GoogleFirebaseAppdistroV1alphaAiStepResult" + }, + "readOnly": true, + "type": "array" + }, "appCrash": { "$ref": "GoogleFirebaseAppdistroV1alphaAppCrash", "description": "Output only. An app crash, if any occurred during the test.", @@ -839,14 +875,16 @@ "CRASHED", "NOT_INSTALLED", "UNABLE_TO_CRAWL", - "DEVICE_OUT_OF_MEMORY" + "DEVICE_OUT_OF_MEMORY", + "FAILED_AI_STEP" ], "enumDescriptions": [ "Reason unspecified.", "The app crashed during the test.", "If an app is not installed and thus no test can be run with the app. This might be caused by trying to run a test on an unsupported platform.", "If the app could not be crawled (possibly because the app did not start).", - "If the device ran out of memory during the test." + "If the device ran out of memory during the test.", + "At least one AI step failed." ], "readOnly": true, "type": "string" diff --git a/discovery/firebaseml-v2beta.json b/discovery/firebaseml-v2beta.json index 7da414ba59..a0abefb408 100644 --- a/discovery/firebaseml-v2beta.json +++ b/discovery/firebaseml-v2beta.json @@ -206,7 +206,7 @@ } } }, - "revision": "20240625", + "revision": "20240711", "rootUrl": "https://firebaseml.googleapis.com/", "schemas": { "Date": { @@ -313,6 +313,12 @@ }, "readOnly": true, "type": "array" + }, + "score": { + "description": "Output only. Confidence score of the candidate.", + "format": "double", + "readOnly": true, + "type": "number" } }, "type": "object" @@ -394,22 +400,33 @@ "id": "GoogleCloudAiplatformV1beta1CountTokensRequest", "properties": { "contents": { - "description": "Required. Input content.", + "description": "Optional. Input content.", "items": { "$ref": "GoogleCloudAiplatformV1beta1Content" }, "type": "array" }, "instances": { - "description": "Required. The instances that are the input to token counting call. Schema is identical to the prediction schema of the underlying model.", + "description": "Optional. The instances that are the input to token counting call. Schema is identical to the prediction schema of the underlying model.", "items": { "type": "any" }, "type": "array" }, "model": { - "description": "Required. The name of the publisher model requested to serve the prediction. Format: `projects/{project}/locations/{location}/publishers/*/models/*`", + "description": "Optional. The name of the publisher model requested to serve the prediction. Format: `projects/{project}/locations/{location}/publishers/*/models/*`", "type": "string" + }, + "systemInstruction": { + "$ref": "GoogleCloudAiplatformV1beta1Content", + "description": "Optional. The user provided system instructions for the model. Note: only text should be used in parts and content in each part will be in a separate paragraph." + }, + "tools": { + "description": "Optional. A list of `Tools` the model may use to generate the next 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.", + "items": { + "$ref": "GoogleCloudAiplatformV1beta1Tool" + }, + "type": "array" } }, "type": "object" @@ -728,66 +745,6 @@ "properties": {}, "type": "object" }, - "GoogleCloudAiplatformV1beta1GroundingAttribution": { - "description": "Grounding attribution.", - "id": "GoogleCloudAiplatformV1beta1GroundingAttribution", - "properties": { - "confidenceScore": { - "description": "Optional. Output only. Confidence score of the attribution. Ranges from 0 to 1. 1 is the most confident.", - "format": "float", - "readOnly": true, - "type": "number" - }, - "retrievedContext": { - "$ref": "GoogleCloudAiplatformV1beta1GroundingAttributionRetrievedContext", - "description": "Optional. Attribution from context retrieved by the retrieval tools." - }, - "segment": { - "$ref": "GoogleCloudAiplatformV1beta1Segment", - "description": "Output only. Segment of the content this attribution belongs to.", - "readOnly": true - }, - "web": { - "$ref": "GoogleCloudAiplatformV1beta1GroundingAttributionWeb", - "description": "Optional. Attribution from the web." - } - }, - "type": "object" - }, - "GoogleCloudAiplatformV1beta1GroundingAttributionRetrievedContext": { - "description": "Attribution from context retrieved by the retrieval tools.", - "id": "GoogleCloudAiplatformV1beta1GroundingAttributionRetrievedContext", - "properties": { - "title": { - "description": "Output only. Title of the attribution.", - "readOnly": true, - "type": "string" - }, - "uri": { - "description": "Output only. URI reference of the attribution.", - "readOnly": true, - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudAiplatformV1beta1GroundingAttributionWeb": { - "description": "Attribution from the web.", - "id": "GoogleCloudAiplatformV1beta1GroundingAttributionWeb", - "properties": { - "title": { - "description": "Output only. Title of the attribution.", - "readOnly": true, - "type": "string" - }, - "uri": { - "description": "Output only. URI reference of the attribution.", - "readOnly": true, - "type": "string" - } - }, - "type": "object" - }, "GoogleCloudAiplatformV1beta1GroundingChunk": { "description": "Grounding chunk.", "id": "GoogleCloudAiplatformV1beta1GroundingChunk", @@ -837,13 +794,6 @@ "description": "Metadata returned to client when grounding is enabled.", "id": "GoogleCloudAiplatformV1beta1GroundingMetadata", "properties": { - "groundingAttributions": { - "description": "Optional. List of grounding attributions.", - "items": { - "$ref": "GoogleCloudAiplatformV1beta1GroundingAttribution" - }, - "type": "array" - }, "groundingChunks": { "description": "List of supporting references retrieved from specified grounding source.", "items": { diff --git a/discovery/firestore-v1.json b/discovery/firestore-v1.json index 6d38cb8f57..3a7d18d722 100644 --- a/discovery/firestore-v1.json +++ b/discovery/firestore-v1.json @@ -1706,7 +1706,7 @@ } } }, - "revision": "20240617", + "revision": "20240630", "rootUrl": "https://firestore.googleapis.com/", "schemas": { "Aggregation": { @@ -2499,7 +2499,7 @@ "type": "string" }, "retention": { - "description": "At what relative time in the future, compared to its creation time, the backup should be deleted, e.g. keep backups for 7 days.", + "description": "At what relative time in the future, compared to its creation time, the backup should be deleted, e.g. keep backups for 7 days. The maximum supported retention is 14 weeks.", "format": "google-duration", "type": "string" }, @@ -3461,7 +3461,7 @@ "id": "GoogleFirestoreAdminV1RestoreDatabaseRequest", "properties": { "backup": { - "description": "Backup to restore from. Must be from the same project as the parent. Format is: `projects/{project_id}/locations/{location}/backups/{backup}`", + "description": "Backup to restore from. Must be from the same project as the parent. The restored database will be created in the same location as the source backup. Format is: `projects/{project_id}/locations/{location}/backups/{backup}`", "type": "string" }, "databaseId": { @@ -3469,7 +3469,7 @@ "type": "string" }, "kmsKeyName": { - "description": "Use Customer Managed Encryption Keys (CMEK) for encryption. Only keys in the same location as this database are allowed to be used for encryption. For Firestore's nam5 multi-region, this corresponds to Cloud KMS multi-region us. For Firestore's eur3 multi-region, this corresponds to Cloud KMS multi-region europe. See https://cloud.google.com/kms/docs/locations. The expected format is `projects/{project_id}/locations/{kms_location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}`.", + "description": "Use Customer Managed Encryption Keys (CMEK) for encryption. Only keys in the same location as the restored database are allowed to be used for encryption. For Firestore's nam5 multi-region, this corresponds to Cloud KMS multi-region us. For Firestore's eur3 multi-region, this corresponds to Cloud KMS multi-region europe. See https://cloud.google.com/kms/docs/locations. The expected format is `projects/{project_id}/locations/{kms_location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}`.", "type": "string" }, "useBackupEncryption": { diff --git a/discovery/games-v1.json b/discovery/games-v1.json index f608466bd3..7962803e27 100644 --- a/discovery/games-v1.json +++ b/discovery/games-v1.json @@ -1469,7 +1469,7 @@ } } }, - "revision": "20240618", + "revision": "20240717", "rootUrl": "https://games.googleapis.com/", "schemas": { "AchievementDefinition": { @@ -2231,12 +2231,9 @@ "description": "The application that this player identifier is for.", "type": "string" }, - "token": { - "description": "Recall token data.", - "items": { - "$ref": "RecallToken" - }, - "type": "array" + "recallToken": { + "$ref": "RecallToken", + "description": "Recall token data." } }, "type": "object" @@ -3314,8 +3311,8 @@ "description": "Recall token data returned from for the RetrieveDeveloperGamesLastPlayerToken RPC", "id": "RetrieveDeveloperGamesLastPlayerTokenResponse", "properties": { - "token": { - "$ref": "RecallToken", + "gamePlayerToken": { + "$ref": "GamePlayerToken", "description": "The recall token associated with the requested PGS Player principal. It can be unset if there is no recall token associated with the requested principal." } }, @@ -3325,7 +3322,7 @@ "description": "A list of recall token data returned from the RetrieveGamesPlayerTokens RPC", "id": "RetrieveGamesPlayerTokensResponse", "properties": { - "applicationRecallTokens": { + "gamePlayerTokens": { "description": "The requested applications along with the recall tokens for the player. If the player does not have recall tokens for an application, that application is not included in the response.", "items": { "$ref": "GamePlayerToken" diff --git a/discovery/gkebackup-v1.json b/discovery/gkebackup-v1.json index 66250d45a3..cf05322150 100644 --- a/discovery/gkebackup-v1.json +++ b/discovery/gkebackup-v1.json @@ -1713,7 +1713,7 @@ } } }, - "revision": "20240518", + "revision": "20240701", "rootUrl": "https://gkebackup.googleapis.com/", "schemas": { "AuditConfig": { @@ -2415,7 +2415,7 @@ "id": "GroupKind", "properties": { "resourceGroup": { - "description": "Optional. API group string of a Kubernetes resource, e.g. \"apiextensions.k8s.io\", \"storage.k8s.io\", etc. Note: use empty string for core API group", + "description": "Optional. API group string of a Kubernetes resource, e.g. \"apiextensions.k8s.io\", \"storage.k8s.io\", etc. Note: use empty string for core API group.", "type": "string" }, "resourceKind": { @@ -2651,11 +2651,11 @@ "type": "object" }, "Namespaces": { - "description": "A list of Kubernetes Namespaces", + "description": "A list of Kubernetes Namespaces.", "id": "Namespaces", "properties": { "namespaces": { - "description": "Optional. A list of Kubernetes Namespaces", + "description": "Optional. A list of Kubernetes Namespaces.", "items": { "type": "string" }, @@ -2826,7 +2826,7 @@ }, "filter": { "$ref": "Filter", - "description": "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 `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 `MERGE_REPLACE_ON_CONFLICT`." + "description": "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 `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 `MERGE_REPLACE_ON_CONFLICT`." }, "labels": { "additionalProperties": { diff --git a/discovery/gkehub-v1.json b/discovery/gkehub-v1.json index b01203ef50..f30069a9c7 100644 --- a/discovery/gkehub-v1.json +++ b/discovery/gkehub-v1.json @@ -1146,6 +1146,122 @@ }, "rbacrolebindings": { "methods": { + "create": { + "description": "Creates a Membership RBACRoleBinding.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/memberships/{membershipsId}/rbacrolebindings", + "httpMethod": "POST", + "id": "gkehub.projects.locations.memberships.rbacrolebindings.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The parent (project and location) where the RBACRoleBinding will be created. Specified in the format `projects/*/locations/*/memberships/*`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/memberships/[^/]+$", + "required": true, + "type": "string" + }, + "rbacrolebindingId": { + "description": "Required. Client chosen ID for the RBACRoleBinding. `rbacrolebinding_id` must be a valid RFC 1123 compliant DNS label: 1. At most 63 characters in length 2. It must consist of lower case alphanumeric characters or `-` 3. It must start and end with an alphanumeric character Which can be expressed as the regex: `[a-z0-9]([-a-z0-9]*[a-z0-9])?`, with a maximum length of 63 characters.", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+parent}/rbacrolebindings", + "request": { + "$ref": "RBACRoleBinding" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a Membership RBACRoleBinding.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/memberships/{membershipsId}/rbacrolebindings/{rbacrolebindingsId}", + "httpMethod": "DELETE", + "id": "gkehub.projects.locations.memberships.rbacrolebindings.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The RBACRoleBinding resource name in the format `projects/*/locations/*/memberships/*/rbacrolebindings/*`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/memberships/[^/]+/rbacrolebindings/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "generateMembershipRBACRoleBindingYAML": { + "description": "Generates a YAML of the RBAC policies for the specified RoleBinding and its associated impersonation resources.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/memberships/{membershipsId}/rbacrolebindings:generateMembershipRBACRoleBindingYAML", + "httpMethod": "POST", + "id": "gkehub.projects.locations.memberships.rbacrolebindings.generateMembershipRBACRoleBindingYAML", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The parent (project and location) where the RBACRoleBinding will be created. Specified in the format `projects/*/locations/*/memberships/*`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/memberships/[^/]+$", + "required": true, + "type": "string" + }, + "rbacrolebindingId": { + "description": "Required. Client chosen ID for the RBACRoleBinding. `rbacrolebinding_id` must be a valid RFC 1123 compliant DNS label: 1. At most 63 characters in length 2. It must consist of lower case alphanumeric characters or `-` 3. It must start and end with an alphanumeric character Which can be expressed as the regex: `[a-z0-9]([-a-z0-9]*[a-z0-9])?`, with a maximum length of 63 characters.", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+parent}/rbacrolebindings:generateMembershipRBACRoleBindingYAML", + "request": { + "$ref": "RBACRoleBinding" + }, + "response": { + "$ref": "GenerateMembershipRBACRoleBindingYAMLResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Returns the details of a Membership RBACRoleBinding.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/memberships/{membershipsId}/rbacrolebindings/{rbacrolebindingsId}", + "httpMethod": "GET", + "id": "gkehub.projects.locations.memberships.rbacrolebindings.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The RBACRoleBinding resource name in the format `projects/*/locations/*/memberships/*/rbacrolebindings/*`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/memberships/[^/]+/rbacrolebindings/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "RBACRoleBinding" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "list": { "description": "Lists all Membership RBACRoleBindings.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/memberships/{membershipsId}/rbacrolebindings", @@ -1181,6 +1297,40 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] + }, + "patch": { + "description": "Updates a Membership RBACRoleBinding.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/memberships/{membershipsId}/rbacrolebindings/{rbacrolebindingsId}", + "httpMethod": "PATCH", + "id": "gkehub.projects.locations.memberships.rbacrolebindings.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The resource name for the rbacrolebinding `projects/{project}/locations/{location}/scopes/{scope}/rbacrolebindings/{rbacrolebinding}` or `projects/{project}/locations/{location}/memberships/{membership}/rbacrolebindings/{rbacrolebinding}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/memberships/[^/]+/rbacrolebindings/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Required. The fields to be updated.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}", + "request": { + "$ref": "RBACRoleBinding" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] } } } @@ -1951,7 +2101,7 @@ } } }, - "revision": "20240623", + "revision": "20240706", "rootUrl": "https://gkehub.googleapis.com/", "schemas": { "AppDevExperienceFeatureSpec": { @@ -2545,6 +2695,24 @@ ], "type": "string" }, + "otelCollector": { + "description": "Deployment state of otel-collector", + "enum": [ + "DEPLOYMENT_STATE_UNSPECIFIED", + "NOT_INSTALLED", + "INSTALLED", + "ERROR", + "PENDING" + ], + "enumDescriptions": [ + "Deployment's state cannot be determined", + "Deployment is not installed", + "Deployment is installed", + "Deployment was attempted to be installed, but has errors", + "Deployment is installing or terminating" + ], + "type": "string" + }, "reconcilerManager": { "description": "Deployment state of reconciler-manager pod", "enum": [ @@ -2563,6 +2731,24 @@ ], "type": "string" }, + "resourceGroupControllerManager": { + "description": "Deployment state of resource-group-controller-manager", + "enum": [ + "DEPLOYMENT_STATE_UNSPECIFIED", + "NOT_INSTALLED", + "INSTALLED", + "ERROR", + "PENDING" + ], + "enumDescriptions": [ + "Deployment's state cannot be determined", + "Deployment is not installed", + "Deployment is installed", + "Deployment was attempted to be installed, but has errors", + "Deployment is installing or terminating" + ], + "type": "string" + }, "rootReconciler": { "description": "Deployment state of root-reconciler", "enum": [ @@ -2698,7 +2884,7 @@ "id": "ConfigManagementConfigSyncVersion", "properties": { "admissionWebhook": { - "description": "Version of the deployed admission_webhook pod", + "description": "Version of the deployed admission-webhook pod", "type": "string" }, "gitSync": { @@ -2713,10 +2899,18 @@ "description": "Version of the deployed monitor pod", "type": "string" }, + "otelCollector": { + "description": "Version of the deployed otel-collector pod", + "type": "string" + }, "reconcilerManager": { "description": "Version of the deployed reconciler-manager pod", "type": "string" }, + "resourceGroupControllerManager": { + "description": "Version of the deployed resource-group-controller-manager pod", + "type": "string" + }, "rootReconciler": { "description": "Version of the deployed reconciler container in root-reconciler pod", "type": "string" @@ -3784,6 +3978,17 @@ }, "type": "object" }, + "GenerateMembershipRBACRoleBindingYAMLResponse": { + "description": "Response for GenerateRBACRoleBindingYAML.", + "id": "GenerateMembershipRBACRoleBindingYAMLResponse", + "properties": { + "roleBindingsYaml": { + "description": "a yaml text blob including the RBAC policies.", + "type": "string" + } + }, + "type": "object" + }, "GkeCluster": { "description": "GkeCluster contains information specific to GKE clusters.", "id": "GkeCluster", @@ -6006,7 +6211,7 @@ "type": "string" }, "management": { - "description": "Enables automatic Service Mesh management.", + "description": "Optional. Enables automatic Service Mesh management.", "enum": [ "MANAGEMENT_UNSPECIFIED", "MANAGEMENT_AUTOMATIC", diff --git a/discovery/gkehub-v1alpha.json b/discovery/gkehub-v1alpha.json index f5b2127bf3..4c15c8cdb2 100644 --- a/discovery/gkehub-v1alpha.json +++ b/discovery/gkehub-v1alpha.json @@ -2175,7 +2175,7 @@ } } }, - "revision": "20240519", + "revision": "20240706", "rootUrl": "https://gkehub.googleapis.com/", "schemas": { "AnthosObservabilityFeatureSpec": { @@ -2970,6 +2970,24 @@ ], "type": "string" }, + "otelCollector": { + "description": "Deployment state of otel-collector", + "enum": [ + "DEPLOYMENT_STATE_UNSPECIFIED", + "NOT_INSTALLED", + "INSTALLED", + "ERROR", + "PENDING" + ], + "enumDescriptions": [ + "Deployment's state cannot be determined", + "Deployment is not installed", + "Deployment is installed", + "Deployment was attempted to be installed, but has errors", + "Deployment is installing or terminating" + ], + "type": "string" + }, "reconcilerManager": { "description": "Deployment state of reconciler-manager pod", "enum": [ @@ -2988,6 +3006,24 @@ ], "type": "string" }, + "resourceGroupControllerManager": { + "description": "Deployment state of resource-group-controller-manager", + "enum": [ + "DEPLOYMENT_STATE_UNSPECIFIED", + "NOT_INSTALLED", + "INSTALLED", + "ERROR", + "PENDING" + ], + "enumDescriptions": [ + "Deployment's state cannot be determined", + "Deployment is not installed", + "Deployment is installed", + "Deployment was attempted to be installed, but has errors", + "Deployment is installing or terminating" + ], + "type": "string" + }, "rootReconciler": { "description": "Deployment state of root-reconciler", "enum": [ @@ -3123,7 +3159,7 @@ "id": "ConfigManagementConfigSyncVersion", "properties": { "admissionWebhook": { - "description": "Version of the deployed admission_webhook pod", + "description": "Version of the deployed admission-webhook pod", "type": "string" }, "gitSync": { @@ -3138,10 +3174,18 @@ "description": "Version of the deployed monitor pod", "type": "string" }, + "otelCollector": { + "description": "Version of the deployed otel-collector pod", + "type": "string" + }, "reconcilerManager": { "description": "Version of the deployed reconciler-manager pod", "type": "string" }, + "resourceGroupControllerManager": { + "description": "Version of the deployed resource-group-controller-manager pod", + "type": "string" + }, "rootReconciler": { "description": "Version of the deployed reconciler container in root-reconciler pod", "type": "string" @@ -6690,6 +6734,20 @@ "description": "**Service Mesh**: Spec for a single Membership for the servicemesh feature", "id": "ServiceMeshMembershipSpec", "properties": { + "configApi": { + "description": "Optional. Specifies the API that will be used for configuring the mesh workloads.", + "enum": [ + "CONFIG_API_UNSPECIFIED", + "CONFIG_API_ISTIO", + "CONFIG_API_GATEWAY" + ], + "enumDescriptions": [ + "Unspecified", + "Use the Istio API for configuration.", + "Use the K8s Gateway API for configuration." + ], + "type": "string" + }, "controlPlane": { "deprecated": true, "description": "Deprecated: use `management` instead Enables automatic control plane management.", @@ -6706,6 +6764,7 @@ "type": "string" }, "defaultChannel": { + "deprecated": true, "description": "Determines which release channel to use for default injection and service mesh APIs.", "enum": [ "CHANNEL_UNSPECIFIED", @@ -6722,7 +6781,7 @@ "type": "string" }, "management": { - "description": "Enables automatic Service Mesh management.", + "description": "Optional. Enables automatic Service Mesh management.", "enum": [ "MANAGEMENT_UNSPECIFIED", "MANAGEMENT_AUTOMATIC", diff --git a/discovery/gkehub-v1beta.json b/discovery/gkehub-v1beta.json index c2bb2acce8..d5773eddef 100644 --- a/discovery/gkehub-v1beta.json +++ b/discovery/gkehub-v1beta.json @@ -2101,7 +2101,7 @@ } } }, - "revision": "20240519", + "revision": "20240706", "rootUrl": "https://gkehub.googleapis.com/", "schemas": { "AnthosObservabilityFeatureSpec": { @@ -2780,6 +2780,24 @@ ], "type": "string" }, + "otelCollector": { + "description": "Deployment state of otel-collector", + "enum": [ + "DEPLOYMENT_STATE_UNSPECIFIED", + "NOT_INSTALLED", + "INSTALLED", + "ERROR", + "PENDING" + ], + "enumDescriptions": [ + "Deployment's state cannot be determined", + "Deployment is not installed", + "Deployment is installed", + "Deployment was attempted to be installed, but has errors", + "Deployment is installing or terminating" + ], + "type": "string" + }, "reconcilerManager": { "description": "Deployment state of reconciler-manager pod", "enum": [ @@ -2798,6 +2816,24 @@ ], "type": "string" }, + "resourceGroupControllerManager": { + "description": "Deployment state of resource-group-controller-manager", + "enum": [ + "DEPLOYMENT_STATE_UNSPECIFIED", + "NOT_INSTALLED", + "INSTALLED", + "ERROR", + "PENDING" + ], + "enumDescriptions": [ + "Deployment's state cannot be determined", + "Deployment is not installed", + "Deployment is installed", + "Deployment was attempted to be installed, but has errors", + "Deployment is installing or terminating" + ], + "type": "string" + }, "rootReconciler": { "description": "Deployment state of root-reconciler", "enum": [ @@ -2933,7 +2969,7 @@ "id": "ConfigManagementConfigSyncVersion", "properties": { "admissionWebhook": { - "description": "Version of the deployed admission_webhook pod", + "description": "Version of the deployed admission-webhook pod", "type": "string" }, "gitSync": { @@ -2948,10 +2984,18 @@ "description": "Version of the deployed monitor pod", "type": "string" }, + "otelCollector": { + "description": "Version of the deployed otel-collector pod", + "type": "string" + }, "reconcilerManager": { "description": "Version of the deployed reconciler-manager pod", "type": "string" }, + "resourceGroupControllerManager": { + "description": "Version of the deployed resource-group-controller-manager pod", + "type": "string" + }, "rootReconciler": { "description": "Version of the deployed reconciler container in root-reconciler pod", "type": "string" @@ -6330,7 +6374,7 @@ "type": "string" }, "management": { - "description": "Enables automatic Service Mesh management.", + "description": "Optional. Enables automatic Service Mesh management.", "enum": [ "MANAGEMENT_UNSPECIFIED", "MANAGEMENT_AUTOMATIC", diff --git a/discovery/healthcare-v1.json b/discovery/healthcare-v1.json index 33c61c42c6..5ae33b94ee 100644 --- a/discovery/healthcare-v1.json +++ b/discovery/healthcare-v1.json @@ -4554,7 +4554,7 @@ } } }, - "revision": "20240619", + "revision": "20240709", "rootUrl": "https://healthcare.googleapis.com/", "schemas": { "ActivateConsentRequest": { @@ -5151,7 +5151,7 @@ "description": "Configures de-identification of text wherever it is found in the source_dataset." }, "useRegionalDataProcessing": { - "description": "Ensures in-flight data remains in the region of origin during de-identification. 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.", + "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 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.", "type": "boolean" } }, @@ -5678,11 +5678,11 @@ "type": "string" }, "sendFullResource": { - "description": "Whether to send full FHIR resource to this Pub/Sub topic.", + "description": "Whether to send full FHIR resource to this Pub/Sub topic. The default value is false.", "type": "boolean" }, "sendPreviousResourceOnDelete": { - "description": "Whether to send full FHIR resource to this Pub/Sub topic for deleting FHIR resource. Note that setting this to true does not guarantee that all previous resources will be sent in the format of full FHIR resource. When a resource change is too large or during heavy traffic, only the resource name will be sent. Clients should always check the \"payloadType\" label from a Pub/Sub message to determine whether it needs to fetch the full previous resource as a separate operation.", + "description": "Whether to send full FHIR resource to this Pub/Sub topic for deleting FHIR resource. The default value is false. Note that setting this to true does not guarantee that all previous resources will be sent in the format of full FHIR resource. When a resource change is too large or during heavy traffic, only the resource name will be sent. Clients should always check the \"payloadType\" label from a Pub/Sub message to determine whether it needs to fetch the full previous resource as a separate operation.", "type": "boolean" } }, @@ -5707,7 +5707,7 @@ "type": "string" }, "defaultSearchHandlingStrict": { - "description": "If true, overrides the default search behavior for this FHIR store to `handling=strict` which returns an error for unrecognized search parameters. If false, uses the FHIR specification default `handling=lenient` which ignores unrecognized search parameters. The handling can always be changed from the default on an individual API call by setting the HTTP header `Prefer: handling=strict` or `Prefer: handling=lenient`.", + "description": "If true, overrides the default search behavior for this FHIR store to `handling=strict` which returns an error for unrecognized search parameters. If false, uses the FHIR specification default `handling=lenient` which ignores unrecognized search parameters. The handling can always be changed from the default on an individual API call by setting the HTTP header `Prefer: handling=strict` or `Prefer: handling=lenient`. Defaults to false.", "type": "boolean" }, "disableReferentialIntegrity": { @@ -5715,11 +5715,11 @@ "type": "boolean" }, "disableResourceVersioning": { - "description": "Immutable. Whether to disable resource versioning for this FHIR store. This field can not be changed after the creation of FHIR store. If set to false, which is the default behavior, all write operations cause historical versions to be recorded automatically. The historical versions can be fetched through the history APIs, but cannot be updated. If set to true, no historical versions are kept. The server sends errors for attempts to read the historical versions.", + "description": "Immutable. Whether to disable resource versioning for this FHIR store. This field can not be changed after the creation of FHIR store. If set to false, all write operations cause historical versions to be recorded automatically. The historical versions can be fetched through the history APIs, but cannot be updated. If set to true, no historical versions are kept. The server sends errors for attempts to read the historical versions. Defaults to false.", "type": "boolean" }, "enableUpdateCreate": { - "description": "Whether this FHIR store has the [updateCreate capability](https://www.hl7.org/fhir/capabilitystatement-definitions.html#CapabilityStatement.rest.resource.updateCreate). This determines if the client can use an Update operation to create a new resource with a client-specified ID. If false, all IDs are server-assigned through the Create operation and attempts to update a non-existent resource return errors. 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.", + "description": "Whether this FHIR store has the [updateCreate capability](https://www.hl7.org/fhir/capabilitystatement-definitions.html#CapabilityStatement.rest.resource.updateCreate). This determines if the client can use an Update operation to create a new resource with a client-specified ID. If false, all IDs are server-assigned through the Create operation and attempts to update a non-existent resource return errors. 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. Defaults to false.", "type": "boolean" }, "labels": { @@ -6045,7 +6045,7 @@ "type": "string" }, "force": { - "description": "If this flag is `TRUE`, all tables are deleted from the dataset before the new exported tables are written. If the flag is not set and the destination dataset contains tables, the export call returns an error. If `write_disposition` is specified, this parameter is ignored. force=false is equivalent to write_disposition=WRITE_EMPTY and force=true is equivalent to write_disposition=WRITE_TRUNCATE.", + "description": "The default value is false. If this flag is `TRUE`, all tables are deleted from the dataset before the new exported tables are written. If the flag is not set and the destination dataset contains tables, the export call returns an error. If `write_disposition` is specified, this parameter is ignored. force=false is equivalent to write_disposition=WRITE_EMPTY and force=true is equivalent to write_disposition=WRITE_TRUNCATE.", "type": "boolean" }, "schemaConfig": { @@ -6743,7 +6743,8 @@ "type": "object" }, "messageType": { - "description": "The message type for this message. MSH-9.1.", + "description": "Output only. The message type for this message. MSH-9.1.", + "readOnly": true, "type": "string" }, "name": { @@ -6757,23 +6758,27 @@ "readOnly": true }, "patientIds": { - "description": "All patient IDs listed in the PID-2, PID-3, and PID-4 segments of this message.", + "description": "Output only. All patient IDs listed in the PID-2, PID-3, and PID-4 segments of this message.", "items": { "$ref": "PatientId" }, + "readOnly": true, "type": "array" }, "schematizedData": { "$ref": "SchematizedData", - "description": "The parsed version of the raw message data schematized according to this store's schemas and type definitions." + "description": "Output only. The parsed version of the raw message data schematized according to this store's schemas and type definitions.", + "readOnly": true }, "sendFacility": { - "description": "The hospital that this message came from. MSH-4.", + "description": "Output only. The hospital that this message came from. MSH-4.", + "readOnly": true, "type": "string" }, "sendTime": { - "description": "The datetime the sending application sent this message. MSH-7.", + "description": "Output only. The datetime the sending application sent this message. MSH-7.", "format": "google-datetime", + "readOnly": true, "type": "string" } }, @@ -7709,19 +7714,19 @@ "id": "ValidationConfig", "properties": { "disableFhirpathValidation": { - "description": "Whether to disable FHIRPath validation for incoming resources. Set this to true to disable checking incoming resources for conformance against FHIRPath requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced.", + "description": "Whether to disable FHIRPath validation for incoming resources. The default value is false. Set this to true to disable checking incoming resources for conformance against FHIRPath requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced.", "type": "boolean" }, "disableProfileValidation": { - "description": "Whether to disable profile validation for this FHIR store. Set this to true to disable checking incoming resources for conformance against structure definitions in this FHIR store.", + "description": "Whether to disable profile validation for this FHIR store. The default value is false. Set this to true to disable checking incoming resources for conformance against structure definitions in this FHIR store.", "type": "boolean" }, "disableReferenceTypeValidation": { - "description": "Whether to disable reference type validation for incoming resources. Set this to true to disable checking incoming resources for conformance against reference type requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced.", + "description": "Whether to disable reference type validation for incoming resources. The default value is false. Set this to true to disable checking incoming resources for conformance against reference type requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced.", "type": "boolean" }, "disableRequiredFieldValidation": { - "description": "Whether to disable required fields validation for incoming resources. Set this to true to disable checking incoming resources for conformance against required fields requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced.", + "description": "Whether to disable required fields validation for incoming resources. The default value is false. Set this to true to disable checking incoming resources for conformance against required fields requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced.", "type": "boolean" }, "enabledImplementationGuides": { diff --git a/discovery/healthcare-v1beta1.json b/discovery/healthcare-v1beta1.json index 2af54bc977..b5ebae307c 100644 --- a/discovery/healthcare-v1beta1.json +++ b/discovery/healthcare-v1beta1.json @@ -5672,7 +5672,7 @@ } } }, - "revision": "20240619", + "revision": "20240709", "rootUrl": "https://healthcare.googleapis.com/", "schemas": { "AccessDeterminationLogConfig": { @@ -5929,6 +5929,25 @@ }, "type": "object" }, + "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.", + "id": "ApplyAdminConsentsErrorDetail", + "properties": { + "consentErrors": { + "description": "The list of Consent resources that are unsupported or cannot be applied and the error associated with each of them.", + "items": { + "$ref": "ConsentErrors" + }, + "type": "array" + }, + "existingOperationId": { + "description": "The currently in progress non-validate-only ApplyAdminConsents operation ID if exist.", + "format": "uint64", + "type": "string" + } + }, + "type": "object" + }, "ApplyAdminConsentsRequest": { "description": "Request to apply the admin Consent resources for the specified FHIR store.", "id": "ApplyAdminConsentsRequest", @@ -6522,7 +6541,7 @@ "description": "Optional. Specifies how the server logs the consent-aware requests. If not specified, the `AccessDeterminationLogConfig.LogLevel.MINIMUM` option is used." }, "accessEnforced": { - "description": "Optional. 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.", + "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": { @@ -6551,6 +6570,21 @@ }, "type": "object" }, + "ConsentErrors": { + "description": "The Consent resource name and error.", + "id": "ConsentErrors", + "properties": { + "error": { + "$ref": "Status", + "description": "The error code and message." + }, + "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" + } + }, + "type": "object" + }, "ConsentEvaluation": { "description": "The detailed evaluation of a particular Consent.", "id": "ConsentEvaluation", @@ -6773,7 +6807,7 @@ "description": "Configures de-identification of text wherever it is found in the source_dataset." }, "useRegionalDataProcessing": { - "description": "Ensures in-flight data remains in the region of origin during de-identification. Using this option results in a significant reduction of throughput, and is not compatible with `LOCATION` or `ORGANIZATION_NAME` infoTypes. If the deprecated DicomConfig or FhirConfig are used, then `LOCATION` must be excluded within TextConfig, and must also be excluded within ImageConfig if image redaction is required.", + "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 compatible with `LOCATION` or `ORGANIZATION_NAME` infoTypes. If the deprecated DicomConfig or FhirConfig are used, then `LOCATION` must be excluded within TextConfig, and must also be excluded within ImageConfig if image redaction is required.", "type": "boolean" } }, @@ -7610,11 +7644,11 @@ "type": "string" }, "sendFullResource": { - "description": "Whether to send full FHIR resource to this Pub/Sub topic for Create and Update operation. Note that setting this to true does not guarantee that all resources will be sent in the format of full FHIR resource. When a resource change is too large or during heavy traffic, only the resource name will be sent. Clients should always check the \"payloadType\" label from a Pub/Sub message to determine whether it needs to fetch the full resource as a separate operation.", + "description": "Whether to send full FHIR resource to this Pub/Sub topic for Create and Update operation. The default value is false. Note that setting this to true does not guarantee that all resources will be sent in the format of full FHIR resource. When a resource change is too large or during heavy traffic, only the resource name will be sent. Clients should always check the \"payloadType\" label from a Pub/Sub message to determine whether it needs to fetch the full resource as a separate operation.", "type": "boolean" }, "sendPreviousResourceOnDelete": { - "description": "Whether to send full FHIR resource to this Pub/Sub topic for deleting FHIR resource. Note that setting this to true does not guarantee that all previous resources will be sent in the format of full FHIR resource. When a resource change is too large or during heavy traffic, only the resource name will be sent. Clients should always check the \"payloadType\" label from a Pub/Sub message to determine whether it needs to fetch the full previous resource as a separate operation.", + "description": "Whether to send full FHIR resource to this Pub/Sub topic for deleting FHIR resource. The default value is false. Note that setting this to true does not guarantee that all previous resources will be sent in the format of full FHIR resource. When a resource change is too large or during heavy traffic, only the resource name will be sent. Clients should always check the \"payloadType\" label from a Pub/Sub message to determine whether it needs to fetch the full previous resource as a separate operation.", "type": "boolean" } }, @@ -7654,7 +7688,7 @@ "description": "Optional. Specifies whether this store has consent enforcement. Not available for DSTU2 FHIR version due to absence of Consent resources." }, "defaultSearchHandlingStrict": { - "description": "If true, overrides the default search behavior for this FHIR store to `handling=strict` which returns an error for unrecognized search parameters. If false, uses the FHIR specification default `handling=lenient` which ignores unrecognized search parameters. The handling can always be changed from the default on an individual API call by setting the HTTP header `Prefer: handling=strict` or `Prefer: handling=lenient`.", + "description": "If true, overrides the default search behavior for this FHIR store to `handling=strict` which returns an error for unrecognized search parameters. If false, uses the FHIR specification default `handling=lenient` which ignores unrecognized search parameters. The handling can always be changed from the default on an individual API call by setting the HTTP header `Prefer: handling=strict` or `Prefer: handling=lenient`. Defaults to false.", "type": "boolean" }, "disableReferentialIntegrity": { @@ -7662,15 +7696,15 @@ "type": "boolean" }, "disableResourceVersioning": { - "description": "Immutable. Whether to disable resource versioning for this FHIR store. This field can not be changed after the creation of FHIR store. If set to false, which is the default behavior, all write operations cause historical versions to be recorded automatically. The historical versions can be fetched through the history APIs, but cannot be updated. If set to true, no historical versions are kept. The server sends errors for attempts to read the historical versions.", + "description": "Immutable. Whether to disable resource versioning for this FHIR store. This field can not be changed after the creation of FHIR store. If set to false, all write operations cause historical versions to be recorded automatically. The historical versions can be fetched through the history APIs, but cannot be updated. If set to true, no historical versions are kept. The server sends errors for attempts to read the historical versions. Defaults to false.", "type": "boolean" }, "enableHistoryModifications": { - "description": "Optional. Whether to allow ExecuteBundle to accept history bundles, and directly insert and overwrite historical resource versions into the FHIR store. If set to false, using history bundles fails with an error.", + "description": "Optional. Whether to allow ExecuteBundle to accept history bundles, and directly insert and overwrite historical resource versions into the FHIR store. If set to false, using history bundles fails with an error. Defaults to false.", "type": "boolean" }, "enableUpdateCreate": { - "description": "Whether this FHIR store has the [updateCreate capability](https://www.hl7.org/fhir/capabilitystatement-definitions.html#CapabilityStatement.rest.resource.updateCreate). This determines if the client can use an Update operation to create a new resource with a client-specified ID. If false, all IDs are server-assigned through the Create operation and attempts to update a non-existent resource return errors. 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.", + "description": "Whether this FHIR store has the [updateCreate capability](https://www.hl7.org/fhir/capabilitystatement-definitions.html#CapabilityStatement.rest.resource.updateCreate). This determines if the client can use an Update operation to create a new resource with a client-specified ID. If false, all IDs are server-assigned through the Create operation and attempts to update a non-existent resource return errors. 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. Defaults to false.", "type": "boolean" }, "labels": { @@ -10227,19 +10261,19 @@ "id": "ValidationConfig", "properties": { "disableFhirpathValidation": { - "description": "Whether to disable FHIRPath validation for incoming resources. Set this to true to disable checking incoming resources for conformance against FHIRPath requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced.", + "description": "Whether to disable FHIRPath validation for incoming resources. The default value is false. Set this to true to disable checking incoming resources for conformance against FHIRPath requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced.", "type": "boolean" }, "disableProfileValidation": { - "description": "Whether to disable profile validation for this FHIR store. Set this to true to disable checking incoming resources for conformance against StructureDefinitions in this FHIR store.", + "description": "Whether to disable profile validation for this FHIR store. The default value is false. Set this to true to disable checking incoming resources for conformance against StructureDefinitions in this FHIR store.", "type": "boolean" }, "disableReferenceTypeValidation": { - "description": "Whether to disable reference type validation for incoming resources. Set this to true to disable checking incoming resources for conformance against reference type requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced.", + "description": "Whether to disable reference type validation for incoming resources. The default value is false. Set this to true to disable checking incoming resources for conformance against reference type requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced.", "type": "boolean" }, "disableRequiredFieldValidation": { - "description": "Whether to disable required fields validation for incoming resources. Set this to true to disable checking incoming resources for conformance against required fields requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced.", + "description": "Whether to disable required fields validation for incoming resources. The default value is false. Set this to true to disable checking incoming resources for conformance against required fields requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced.", "type": "boolean" }, "enabledImplementationGuides": { diff --git a/discovery/index.json b/discovery/index.json index 1e9be76212..d258af3d66 100644 --- a/discovery/index.json +++ b/discovery/index.json @@ -1,6851 +1,6881 @@ { - "kind": "discovery#directoryList", "discoveryVersion": "v1", "items": [ { - "kind": "discovery#directoryItem", - "id": "abusiveexperiencereport:v1", - "name": "abusiveexperiencereport", - "version": "v1", - "title": "Abusive Experience Report API", "description": "Views Abusive Experience Report data, and gets a list of sites that have a significant number of abusive experiences.", "discoveryRestUrl": "https://abusiveexperiencereport.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://developers.google.com/abusive-experience-report/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://developers.google.com/abusive-experience-report/", - "preferred": true + "id": "abusiveexperiencereport:v1", + "kind": "discovery#directoryItem", + "name": "abusiveexperiencereport", + "preferred": true, + "title": "Abusive Experience Report API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "acceleratedmobilepageurl:v1", - "name": "acceleratedmobilepageurl", - "version": "v1", - "title": "Accelerated Mobile Pages (AMP) URL API", "description": "Retrieves the list of AMP URLs (and equivalent AMP Cache URLs) for a given list of public URL(s).", "discoveryRestUrl": "https://acceleratedmobilepageurl.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://developers.google.com/amp/cache/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://developers.google.com/amp/cache/", - "preferred": true + "id": "acceleratedmobilepageurl:v1", + "kind": "discovery#directoryItem", + "name": "acceleratedmobilepageurl", + "preferred": true, + "title": "Accelerated Mobile Pages (AMP) URL API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "accessapproval:v1", - "name": "accessapproval", - "version": "v1", - "title": "Access Approval API", "description": "An API for controlling access to data by Google personnel.", "discoveryRestUrl": "https://accessapproval.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/assured-workloads/access-approval/docs", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/assured-workloads/access-approval/docs", - "preferred": true + "id": "accessapproval:v1", + "kind": "discovery#directoryItem", + "name": "accessapproval", + "preferred": true, + "title": "Access Approval API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "accesscontextmanager:v1", - "name": "accesscontextmanager", - "version": "v1", - "title": "Access Context Manager API", "description": "An API for setting attribute based access control to requests to Google Cloud services. *Warning:* Do not mix *v1alpha* and *v1* API usage in the same access policy. The v1alpha API supports new Access Context Manager features, which may have different attributes or behaviors that are not supported by v1. The practice of mixed API usage within a policy may result in the inability to update that policy, including any access levels or service perimeters belonging to it. It is not recommended to use both v1 and v1alpha for modifying policies with critical service perimeters. Modifications using v1alpha should be limited to policies with non-production/non-critical service perimeters.", "discoveryRestUrl": "https://accesscontextmanager.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/access-context-manager/docs/reference/rest/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/access-context-manager/docs/reference/rest/", - "preferred": true + "id": "accesscontextmanager:v1", + "kind": "discovery#directoryItem", + "name": "accesscontextmanager", + "preferred": true, + "title": "Access Context Manager API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "acmedns:v1", - "name": "acmedns", - "version": "v1", - "title": "ACME DNS API", "description": "Google Domains ACME DNS API that allows users to complete ACME DNS-01 challenges for a domain.", "discoveryRestUrl": "https://acmedns.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://developers.google.com/domains/acme-dns/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://developers.google.com/domains/acme-dns/", - "preferred": true + "id": "acmedns:v1", + "kind": "discovery#directoryItem", + "name": "acmedns", + "preferred": true, + "title": "ACME DNS API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "addressvalidation:v1", - "name": "addressvalidation", - "version": "v1", - "title": "Address Validation API", "description": "The Address Validation API allows developers to verify the accuracy of addresses. Given an address, it returns information about the correctness of the components of the parsed address, a geocode, and a verdict on the deliverability of the parsed address.", "discoveryRestUrl": "https://addressvalidation.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://developers.google.com/maps/documentation/addressvalidation", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://developers.google.com/maps/documentation/addressvalidation", - "preferred": true + "id": "addressvalidation:v1", + "kind": "discovery#directoryItem", + "name": "addressvalidation", + "preferred": true, + "title": "Address Validation API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "adexchangebuyer2:v2beta1", - "name": "adexchangebuyer2", - "version": "v2beta1", - "title": "Ad Exchange Buyer API II", "description": "Accesses the latest features for managing Authorized Buyers accounts, Real-Time Bidding configurations and auction metrics, and Marketplace programmatic deals.", "discoveryRestUrl": "https://adexchangebuyer.googleapis.com/$discovery/rest?version=v2beta1", + "documentationLink": "https://developers.google.com/authorized-buyers/apis/reference/rest/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://developers.google.com/authorized-buyers/apis/reference/rest/", - "preferred": true + "id": "adexchangebuyer2:v2beta1", + "kind": "discovery#directoryItem", + "name": "adexchangebuyer2", + "preferred": true, + "title": "Ad Exchange Buyer API II", + "version": "v2beta1" }, { - "kind": "discovery#directoryItem", - "id": "adexperiencereport:v1", - "name": "adexperiencereport", - "version": "v1", - "title": "Ad Experience Report API", "description": "Views Ad Experience Report data, and gets a list of sites that have a significant number of annoying ads.", "discoveryRestUrl": "https://adexperiencereport.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://developers.google.com/ad-experience-report/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://developers.google.com/ad-experience-report/", - "preferred": true + "id": "adexperiencereport:v1", + "kind": "discovery#directoryItem", + "name": "adexperiencereport", + "preferred": true, + "title": "Ad Experience Report API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "admin:datatransfer_v1", - "name": "admin", - "version": "datatransfer_v1", - "title": "Admin SDK API", "description": "Admin SDK lets administrators of enterprise domains to view and manage resources like user, groups etc. It also provides audit and usage reports of domain.", "discoveryRestUrl": "https://admin.googleapis.com/$discovery/rest?version=datatransfer_v1", + "documentationLink": "https://developers.google.com/admin-sdk/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://developers.google.com/admin-sdk/", - "preferred": false - }, - { + "id": "admin:datatransfer_v1", "kind": "discovery#directoryItem", - "id": "admin:directory_v1", "name": "admin", - "version": "directory_v1", + "preferred": false, "title": "Admin SDK API", + "version": "datatransfer_v1" + }, + { "description": "Admin SDK lets administrators of enterprise domains to view and manage resources like user, groups etc. It also provides audit and usage reports of domain.", "discoveryRestUrl": "https://admin.googleapis.com/$discovery/rest?version=directory_v1", + "documentationLink": "https://developers.google.com/admin-sdk/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://developers.google.com/admin-sdk/", - "preferred": false - }, - { + "id": "admin:directory_v1", "kind": "discovery#directoryItem", - "id": "admin:reports_v1", "name": "admin", - "version": "reports_v1", + "preferred": false, "title": "Admin SDK API", + "version": "directory_v1" + }, + { "description": "Admin SDK lets administrators of enterprise domains to view and manage resources like user, groups etc. It also provides audit and usage reports of domain.", "discoveryRestUrl": "https://admin.googleapis.com/$discovery/rest?version=reports_v1", + "documentationLink": "https://developers.google.com/admin-sdk/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://developers.google.com/admin-sdk/", - "preferred": true + "id": "admin:reports_v1", + "kind": "discovery#directoryItem", + "name": "admin", + "preferred": true, + "title": "Admin SDK API", + "version": "reports_v1" }, { - "kind": "discovery#directoryItem", - "id": "admob:v1beta", - "name": "admob", - "version": "v1beta", - "title": "AdMob API", "description": "The AdMob API allows publishers to programmatically get information about their AdMob account.", "discoveryRestUrl": "https://admob.googleapis.com/$discovery/rest?version=v1beta", + "documentationLink": "https://developers.google.com/admob/api/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://developers.google.com/admob/api/", - "preferred": false - }, - { + "id": "admob:v1beta", "kind": "discovery#directoryItem", - "id": "admob:v1", "name": "admob", - "version": "v1", + "preferred": false, "title": "AdMob API", + "version": "v1beta" + }, + { "description": "The AdMob API allows publishers to programmatically get information about their AdMob account.", "discoveryRestUrl": "https://admob.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://developers.google.com/admob/api/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://developers.google.com/admob/api/", - "preferred": true + "id": "admob:v1", + "kind": "discovery#directoryItem", + "name": "admob", + "preferred": true, + "title": "AdMob API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "adsense:v2", - "name": "adsense", - "version": "v2", - "title": "AdSense Management API", "description": "The AdSense Management API allows publishers to access their inventory and run earnings and performance reports.", "discoveryRestUrl": "https://adsense.googleapis.com/$discovery/rest?version=v2", + "documentationLink": "https://developers.google.com/adsense/management/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://developers.google.com/adsense/management/", - "preferred": true + "id": "adsense:v2", + "kind": "discovery#directoryItem", + "name": "adsense", + "preferred": true, + "title": "AdSense Management API", + "version": "v2" }, { - "kind": "discovery#directoryItem", - "id": "adsensehost:v4.1", - "name": "adsensehost", - "version": "v4.1", - "title": "AdSense Host API", "description": "The AdSense Host API gives AdSense Hosts access to report generation, ad code generation, and publisher management capabilities.", "discoveryRestUrl": "https://adsensehost.googleapis.com/$discovery/rest?version=v4.1", + "documentationLink": "https://developers.google.com/adsense/host/index", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://developers.google.com/adsense/host/index", - "preferred": true + "id": "adsensehost:v4.1", + "kind": "discovery#directoryItem", + "name": "adsensehost", + "preferred": true, + "title": "AdSense Host API", + "version": "v4.1" }, { + "description": "", + "discoveryRestUrl": "https://adsenseplatform.googleapis.com/$discovery/rest?version=v1alpha", + "documentationLink": "https://developers.google.com/adsense/platforms/", + "icons": { + "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", + "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" + }, + "id": "adsenseplatform:v1alpha", "kind": "discovery#directoryItem", - "id": "advisorynotifications:v1", - "name": "advisorynotifications", - "version": "v1", - "title": "Advisory Notifications API", + "name": "adsenseplatform", + "preferred": true, + "title": "AdSense Platform API", + "version": "v1alpha" + }, + { "description": "An API for accessing Advisory Notifications in Google Cloud", "discoveryRestUrl": "https://advisorynotifications.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/advisory-notifications", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/advisory-notifications", - "preferred": true + "id": "advisorynotifications:v1", + "kind": "discovery#directoryItem", + "name": "advisorynotifications", + "preferred": true, + "title": "Advisory Notifications API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "aiplatform:v1beta1", - "name": "aiplatform", - "version": "v1beta1", - "title": "Vertex AI API", "description": "Train high-quality custom machine learning models with minimal machine learning expertise and effort.", "discoveryRestUrl": "https://aiplatform.googleapis.com/$discovery/rest?version=v1beta1", + "documentationLink": "https://cloud.google.com/vertex-ai/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/vertex-ai/", - "preferred": false - }, - { + "id": "aiplatform:v1beta1", "kind": "discovery#directoryItem", - "id": "aiplatform:v1", "name": "aiplatform", - "version": "v1", + "preferred": false, "title": "Vertex AI API", + "version": "v1beta1" + }, + { "description": "Train high-quality custom machine learning models with minimal machine learning expertise and effort.", "discoveryRestUrl": "https://aiplatform.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/vertex-ai/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/vertex-ai/", - "preferred": true + "id": "aiplatform:v1", + "kind": "discovery#directoryItem", + "name": "aiplatform", + "preferred": true, + "title": "Vertex AI API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "airquality:v1", - "name": "airquality", - "version": "v1", - "title": "Air Quality API", "description": "The Air Quality API.", "discoveryRestUrl": "https://airquality.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://developers.google.com/maps/documentation/air-quality", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://developers.google.com/maps/documentation/air-quality", - "preferred": true + "id": "airquality:v1", + "kind": "discovery#directoryItem", + "name": "airquality", + "preferred": true, + "title": "Air Quality API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "alertcenter:v1beta1", - "name": "alertcenter", - "version": "v1beta1", - "title": "Google Workspace Alert Center API", "description": "Manages alerts on issues affecting your domain. Note: The current version of this API (v1beta1) is available to all Google Workspace customers.", "discoveryRestUrl": "https://alertcenter.googleapis.com/$discovery/rest?version=v1beta1", + "documentationLink": "https://developers.google.com/admin-sdk/alertcenter/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://developers.google.com/admin-sdk/alertcenter/", - "preferred": true + "id": "alertcenter:v1beta1", + "kind": "discovery#directoryItem", + "name": "alertcenter", + "preferred": true, + "title": "Google Workspace Alert Center API", + "version": "v1beta1" }, { - "kind": "discovery#directoryItem", - "id": "alloydb:v1alpha", - "name": "alloydb", - "version": "v1alpha", - "title": "AlloyDB API", "description": "AlloyDB for PostgreSQL is an open source-compatible database service that provides a powerful option for migrating, modernizing, or building commercial-grade applications. It offers full compatibility with standard PostgreSQL, and is more than 4x faster for transactional workloads and up to 100x faster for analytical queries than standard PostgreSQL in our performance tests. AlloyDB for PostgreSQL offers a 99.99 percent availability SLA inclusive of maintenance. AlloyDB is optimized for the most demanding use cases, allowing you to build new applications that require high transaction throughput, large database sizes, or multiple read resources; scale existing PostgreSQL workloads with no application changes; and modernize legacy proprietary databases.", "discoveryRestUrl": "https://alloydb.googleapis.com/$discovery/rest?version=v1alpha", + "documentationLink": "https://cloud.google.com/alloydb/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/alloydb/", - "preferred": false - }, - { + "id": "alloydb:v1alpha", "kind": "discovery#directoryItem", - "id": "alloydb:v1beta", "name": "alloydb", - "version": "v1beta", + "preferred": false, "title": "AlloyDB API", + "version": "v1alpha" + }, + { "description": "AlloyDB for PostgreSQL is an open source-compatible database service that provides a powerful option for migrating, modernizing, or building commercial-grade applications. It offers full compatibility with standard PostgreSQL, and is more than 4x faster for transactional workloads and up to 100x faster for analytical queries than standard PostgreSQL in our performance tests. AlloyDB for PostgreSQL offers a 99.99 percent availability SLA inclusive of maintenance. AlloyDB is optimized for the most demanding use cases, allowing you to build new applications that require high transaction throughput, large database sizes, or multiple read resources; scale existing PostgreSQL workloads with no application changes; and modernize legacy proprietary databases.", "discoveryRestUrl": "https://alloydb.googleapis.com/$discovery/rest?version=v1beta", + "documentationLink": "https://cloud.google.com/alloydb/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/alloydb/", - "preferred": false - }, - { + "id": "alloydb:v1beta", "kind": "discovery#directoryItem", - "id": "alloydb:v1", "name": "alloydb", - "version": "v1", + "preferred": false, "title": "AlloyDB API", + "version": "v1beta" + }, + { "description": "AlloyDB for PostgreSQL is an open source-compatible database service that provides a powerful option for migrating, modernizing, or building commercial-grade applications. It offers full compatibility with standard PostgreSQL, and is more than 4x faster for transactional workloads and up to 100x faster for analytical queries than standard PostgreSQL in our performance tests. AlloyDB for PostgreSQL offers a 99.99 percent availability SLA inclusive of maintenance. AlloyDB is optimized for the most demanding use cases, allowing you to build new applications that require high transaction throughput, large database sizes, or multiple read resources; scale existing PostgreSQL workloads with no application changes; and modernize legacy proprietary databases.", "discoveryRestUrl": "https://alloydb.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/alloydb/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/alloydb/", - "preferred": true + "id": "alloydb:v1", + "kind": "discovery#directoryItem", + "name": "alloydb", + "preferred": true, + "title": "AlloyDB API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "analytics:v3", - "name": "analytics", - "version": "v3", - "title": "Google Analytics API", "description": "The Analytics API provides access to Analytics configuration and report data.", "discoveryRestUrl": "https://analytics.googleapis.com/$discovery/rest?version=v3", + "documentationLink": "http://code.google.com/apis/analytics/docs/mgmt/home.html", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "http://code.google.com/apis/analytics/docs/mgmt/home.html", - "preferred": true + "id": "analytics:v3", + "kind": "discovery#directoryItem", + "name": "analytics", + "preferred": true, + "title": "Google Analytics API", + "version": "v3" }, { - "kind": "discovery#directoryItem", - "id": "analyticsadmin:v1alpha", - "name": "analyticsadmin", - "version": "v1alpha", - "title": "Google Analytics Admin API", "description": "Manage properties in Google Analytics. Warning: Creating multiple Customer Applications, Accounts, or Projects to simulate or act as a single Customer Application, Account, or Project (respectively) or to circumvent Service-specific usage limits or quotas is a direct violation of Google Cloud Platform Terms of Service as well as Google APIs Terms of Service. These actions can result in immediate termination of your GCP project(s) without any warning.", "discoveryRestUrl": "https://analyticsadmin.googleapis.com/$discovery/rest?version=v1alpha", + "documentationLink": "http://code.google.com/apis/analytics/docs/mgmt/home.html", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "http://code.google.com/apis/analytics/docs/mgmt/home.html", - "preferred": false - }, - { + "id": "analyticsadmin:v1alpha", "kind": "discovery#directoryItem", - "id": "analyticsadmin:v1beta", "name": "analyticsadmin", - "version": "v1beta", + "preferred": false, "title": "Google Analytics Admin API", + "version": "v1alpha" + }, + { "description": "Manage properties in Google Analytics. Warning: Creating multiple Customer Applications, Accounts, or Projects to simulate or act as a single Customer Application, Account, or Project (respectively) or to circumvent Service-specific usage limits or quotas is a direct violation of Google Cloud Platform Terms of Service as well as Google APIs Terms of Service. These actions can result in immediate termination of your GCP project(s) without any warning.", "discoveryRestUrl": "https://analyticsadmin.googleapis.com/$discovery/rest?version=v1beta", + "documentationLink": "http://code.google.com/apis/analytics/docs/mgmt/home.html", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "http://code.google.com/apis/analytics/docs/mgmt/home.html", - "preferred": true + "id": "analyticsadmin:v1beta", + "kind": "discovery#directoryItem", + "name": "analyticsadmin", + "preferred": true, + "title": "Google Analytics Admin API", + "version": "v1beta" }, { - "kind": "discovery#directoryItem", - "id": "analyticsdata:v1beta", - "name": "analyticsdata", - "version": "v1beta", - "title": "Google Analytics Data API", "description": "Accesses report data in Google Analytics. Warning: Creating multiple Customer Applications, Accounts, or Projects to simulate or act as a single Customer Application, Account, or Project (respectively) or to circumvent Service-specific usage limits or quotas is a direct violation of Google Cloud Platform Terms of Service as well as Google APIs Terms of Service. These actions can result in immediate termination of your GCP project(s) without any warning.", "discoveryRestUrl": "https://analyticsdata.googleapis.com/$discovery/rest?version=v1beta", + "documentationLink": "https://developers.google.com/analytics/devguides/reporting/data/v1/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://developers.google.com/analytics/devguides/reporting/data/v1/", - "preferred": true + "id": "analyticsdata:v1beta", + "kind": "discovery#directoryItem", + "name": "analyticsdata", + "preferred": true, + "title": "Google Analytics Data API", + "version": "v1beta" }, { - "kind": "discovery#directoryItem", - "id": "analyticshub:v1beta1", - "name": "analyticshub", - "version": "v1beta1", - "title": "Analytics Hub API", "description": "Exchange data and analytics assets securely and efficiently.", "discoveryRestUrl": "https://analyticshub.googleapis.com/$discovery/rest?version=v1beta1", + "documentationLink": "https://cloud.google.com/bigquery/docs/analytics-hub-introduction", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/bigquery/docs/analytics-hub-introduction", - "preferred": false - }, - { + "id": "analyticshub:v1beta1", "kind": "discovery#directoryItem", - "id": "analyticshub:v1", "name": "analyticshub", - "version": "v1", + "preferred": false, "title": "Analytics Hub API", + "version": "v1beta1" + }, + { "description": "Exchange data and analytics assets securely and efficiently.", "discoveryRestUrl": "https://analyticshub.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/bigquery/docs/analytics-hub-introduction", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/bigquery/docs/analytics-hub-introduction", - "preferred": true + "id": "analyticshub:v1", + "kind": "discovery#directoryItem", + "name": "analyticshub", + "preferred": true, + "title": "Analytics Hub API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "analyticsreporting:v4", - "name": "analyticsreporting", - "version": "v4", - "title": "Analytics Reporting API", "description": "Accesses Analytics report data.", "discoveryRestUrl": "https://analyticsreporting.googleapis.com/$discovery/rest?version=v4", + "documentationLink": "https://developers.google.com/analytics/devguides/reporting/core/v4/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://developers.google.com/analytics/devguides/reporting/core/v4/", - "preferred": true + "id": "analyticsreporting:v4", + "kind": "discovery#directoryItem", + "name": "analyticsreporting", + "preferred": true, + "title": "Analytics Reporting API", + "version": "v4" }, { - "kind": "discovery#directoryItem", - "id": "androiddeviceprovisioning:v1", - "name": "androiddeviceprovisioning", - "version": "v1", - "title": "Android Device Provisioning Partner API", "description": "Automates Android zero-touch enrollment for device resellers, customers, and EMMs.", "discoveryRestUrl": "https://androiddeviceprovisioning.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://developers.google.com/zero-touch/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://developers.google.com/zero-touch/", - "preferred": true + "id": "androiddeviceprovisioning:v1", + "kind": "discovery#directoryItem", + "name": "androiddeviceprovisioning", + "preferred": true, + "title": "Android Device Provisioning Partner API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "androidenterprise:v1", - "name": "androidenterprise", - "version": "v1", - "title": "Google Play EMM API", "description": "Manages the deployment of apps to Android Enterprise devices.", "discoveryRestUrl": "https://androidenterprise.googleapis.com/$discovery/rest?version=v1", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "preferred": true + "id": "androidenterprise:v1", + "kind": "discovery#directoryItem", + "name": "androidenterprise", + "preferred": true, + "title": "Google Play EMM API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "androidmanagement:v1", - "name": "androidmanagement", - "version": "v1", - "title": "Android Management API", "description": "The Android Management API provides remote enterprise management of Android devices and apps.", "discoveryRestUrl": "https://androidmanagement.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://developers.google.com/android/management", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://developers.google.com/android/management", - "preferred": true + "id": "androidmanagement:v1", + "kind": "discovery#directoryItem", + "name": "androidmanagement", + "preferred": true, + "title": "Android Management API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "androidpublisher:v3", - "name": "androidpublisher", - "version": "v3", - "title": "Google Play Android Developer API", "description": "Lets Android application developers access their Google Play accounts. At a high level, the expected workflow is to \"insert\" an Edit, make changes as necessary, and then \"commit\" it.", "discoveryRestUrl": "https://androidpublisher.googleapis.com/$discovery/rest?version=v3", + "documentationLink": "https://developers.google.com/android-publisher", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://developers.google.com/android-publisher", - "preferred": true + "id": "androidpublisher:v3", + "kind": "discovery#directoryItem", + "name": "androidpublisher", + "preferred": true, + "title": "Google Play Android Developer API", + "version": "v3" }, { - "kind": "discovery#directoryItem", - "id": "apigateway:v1beta", - "name": "apigateway", - "version": "v1beta", - "title": "API Gateway API", "description": "", "discoveryRestUrl": "https://apigateway.googleapis.com/$discovery/rest?version=v1beta", + "documentationLink": "https://cloud.google.com/api-gateway/docs", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/api-gateway/docs", - "preferred": false - }, - { + "id": "apigateway:v1beta", "kind": "discovery#directoryItem", - "id": "apigateway:v1", "name": "apigateway", - "version": "v1", + "preferred": false, "title": "API Gateway API", + "version": "v1beta" + }, + { "description": "", "discoveryRestUrl": "https://apigateway.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/api-gateway/docs", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/api-gateway/docs", - "preferred": true + "id": "apigateway:v1", + "kind": "discovery#directoryItem", + "name": "apigateway", + "preferred": true, + "title": "API Gateway API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "apigee:v1", - "name": "apigee", - "version": "v1", - "title": "Apigee API", "description": "Use the Apigee API to programmatically develop and manage APIs with a set of RESTful operations. Develop and secure API proxies, deploy and undeploy API proxy revisions, monitor APIs, configure environments, manage users, and more. Note: This product is available as a free trial for a time period of 60 days.", "discoveryRestUrl": "https://apigee.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/apigee-api-management/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/apigee-api-management/", - "preferred": true + "id": "apigee:v1", + "kind": "discovery#directoryItem", + "name": "apigee", + "preferred": true, + "title": "Apigee API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "apigeeregistry:v1", - "name": "apigeeregistry", - "version": "v1", - "title": "Apigee Registry API", "description": "", "discoveryRestUrl": "https://apigeeregistry.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/apigee/docs/api-hub/what-is-api-hub", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/apigee/docs/api-hub/what-is-api-hub", - "preferred": true + "id": "apigeeregistry:v1", + "kind": "discovery#directoryItem", + "name": "apigeeregistry", + "preferred": true, + "title": "Apigee Registry API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "apikeys:v2", - "name": "apikeys", - "version": "v2", - "title": "API Keys API", "description": "Manages the API keys associated with developer projects.", "discoveryRestUrl": "https://apikeys.googleapis.com/$discovery/rest?version=v2", + "documentationLink": "https://cloud.google.com/api-keys/docs", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/api-keys/docs", - "preferred": true + "id": "apikeys:v2", + "kind": "discovery#directoryItem", + "name": "apikeys", + "preferred": true, + "title": "API Keys API", + "version": "v2" }, { - "kind": "discovery#directoryItem", - "id": "apim:v1alpha", - "name": "apim", - "version": "v1alpha", - "title": "API Management API", "description": "Enables users to discover shadow APIs in existing Google Cloud infrastructure.", "discoveryRestUrl": "https://apim.googleapis.com/$discovery/rest?version=v1alpha", + "documentationLink": "https://cloud.google.com/apigee/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/apigee/", - "preferred": true + "id": "apim:v1alpha", + "kind": "discovery#directoryItem", + "name": "apim", + "preferred": true, + "title": "API Management API", + "version": "v1alpha" }, { - "kind": "discovery#directoryItem", - "id": "appengine:v1alpha", - "name": "appengine", - "version": "v1alpha", - "title": "App Engine Admin API", "description": "Provisions and manages developers' App Engine applications.", "discoveryRestUrl": "https://appengine.googleapis.com/$discovery/rest?version=v1alpha", + "documentationLink": "https://cloud.google.com/appengine/docs/admin-api/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/appengine/docs/admin-api/", - "preferred": false - }, - { + "id": "appengine:v1alpha", "kind": "discovery#directoryItem", - "id": "appengine:v1beta", "name": "appengine", - "version": "v1beta", + "preferred": false, "title": "App Engine Admin API", + "version": "v1alpha" + }, + { "description": "Provisions and manages developers' App Engine applications.", "discoveryRestUrl": "https://appengine.googleapis.com/$discovery/rest?version=v1beta", + "documentationLink": "https://cloud.google.com/appengine/docs/admin-api/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/appengine/docs/admin-api/", - "preferred": false - }, - { + "id": "appengine:v1beta", "kind": "discovery#directoryItem", - "id": "appengine:v1", "name": "appengine", - "version": "v1", + "preferred": false, "title": "App Engine Admin API", + "version": "v1beta" + }, + { "description": "Provisions and manages developers' App Engine applications.", "discoveryRestUrl": "https://appengine.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/appengine/docs/admin-api/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/appengine/docs/admin-api/", - "preferred": true + "id": "appengine:v1", + "kind": "discovery#directoryItem", + "name": "appengine", + "preferred": true, + "title": "App Engine Admin API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "apphub:v1alpha", - "name": "apphub", - "version": "v1alpha", - "title": "App Hub API", "description": "", "discoveryRestUrl": "https://apphub.googleapis.com/$discovery/rest?version=v1alpha", + "documentationLink": "https://cloud.google.com/app-hub/docs/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/app-hub/docs/", - "preferred": false - }, - { + "id": "apphub:v1alpha", "kind": "discovery#directoryItem", - "id": "apphub:v1", "name": "apphub", - "version": "v1", + "preferred": false, "title": "App Hub API", + "version": "v1alpha" + }, + { "description": "", "discoveryRestUrl": "https://apphub.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/app-hub/docs/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/app-hub/docs/", - "preferred": true + "id": "apphub:v1", + "kind": "discovery#directoryItem", + "name": "apphub", + "preferred": true, + "title": "App Hub API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "area120tables:v1alpha1", - "name": "area120tables", - "version": "v1alpha1", - "title": "Area120 Tables API", "description": "", "discoveryRestUrl": "https://area120tables.googleapis.com/$discovery/rest?version=v1alpha1", + "documentationLink": "https://support.google.com/area120-tables/answer/10011390", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://support.google.com/area120-tables/answer/10011390", - "preferred": true + "id": "area120tables:v1alpha1", + "kind": "discovery#directoryItem", + "name": "area120tables", + "preferred": true, + "title": "Area120 Tables API", + "version": "v1alpha1" }, { - "kind": "discovery#directoryItem", - "id": "artifactregistry:v1beta1", - "name": "artifactregistry", - "version": "v1beta1", - "title": "Artifact Registry API", "description": "Store and manage build artifacts in a scalable and integrated service built on Google infrastructure.", "discoveryRestUrl": "https://artifactregistry.googleapis.com/$discovery/rest?version=v1beta1", + "documentationLink": "https://cloud.google.com/artifacts/docs/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/artifacts/docs/", - "preferred": false - }, - { + "id": "artifactregistry:v1beta1", "kind": "discovery#directoryItem", - "id": "artifactregistry:v1beta2", "name": "artifactregistry", - "version": "v1beta2", + "preferred": false, "title": "Artifact Registry API", + "version": "v1beta1" + }, + { "description": "Store and manage build artifacts in a scalable and integrated service built on Google infrastructure.", "discoveryRestUrl": "https://artifactregistry.googleapis.com/$discovery/rest?version=v1beta2", + "documentationLink": "https://cloud.google.com/artifacts/docs/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/artifacts/docs/", - "preferred": false - }, - { + "id": "artifactregistry:v1beta2", "kind": "discovery#directoryItem", - "id": "artifactregistry:v1", "name": "artifactregistry", - "version": "v1", + "preferred": false, "title": "Artifact Registry API", + "version": "v1beta2" + }, + { "description": "Store and manage build artifacts in a scalable and integrated service built on Google infrastructure.", "discoveryRestUrl": "https://artifactregistry.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/artifacts/docs/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/artifacts/docs/", - "preferred": true + "id": "artifactregistry:v1", + "kind": "discovery#directoryItem", + "name": "artifactregistry", + "preferred": true, + "title": "Artifact Registry API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "assuredworkloads:v1beta1", - "name": "assuredworkloads", - "version": "v1beta1", - "title": "Assured Workloads API", "description": "", "discoveryRestUrl": "https://assuredworkloads.googleapis.com/$discovery/rest?version=v1beta1", + "documentationLink": "https://cloud.google.com/learnmoreurl", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/learnmoreurl", - "preferred": false - }, - { + "id": "assuredworkloads:v1beta1", "kind": "discovery#directoryItem", - "id": "assuredworkloads:v1", "name": "assuredworkloads", - "version": "v1", + "preferred": false, "title": "Assured Workloads API", + "version": "v1beta1" + }, + { "description": "", "discoveryRestUrl": "https://assuredworkloads.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/learnmoreurl", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/learnmoreurl", - "preferred": true + "id": "assuredworkloads:v1", + "kind": "discovery#directoryItem", + "name": "assuredworkloads", + "preferred": true, + "title": "Assured Workloads API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "authorizedbuyersmarketplace:v1", - "name": "authorizedbuyersmarketplace", - "version": "v1", - "title": "Authorized Buyers Marketplace API", "description": "The Authorized Buyers Marketplace API lets buyers programmatically discover inventory; propose, retrieve and negotiate deals with publishers.", "discoveryRestUrl": "https://authorizedbuyersmarketplace.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://developers.google.com/authorized-buyers/apis/marketplace/reference/rest/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://developers.google.com/authorized-buyers/apis/marketplace/reference/rest/", - "preferred": true + "id": "authorizedbuyersmarketplace:v1", + "kind": "discovery#directoryItem", + "name": "authorizedbuyersmarketplace", + "preferred": true, + "title": "Authorized Buyers Marketplace API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "backupdr:v1", - "name": "backupdr", - "version": "v1", - "title": "Backup and DR Service API", "description": "", "discoveryRestUrl": "https://backupdr.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/backup-disaster-recovery", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/backup-disaster-recovery", - "preferred": true + "id": "backupdr:v1", + "kind": "discovery#directoryItem", + "name": "backupdr", + "preferred": true, + "title": "Backup and DR Service API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "baremetalsolution:v2", - "name": "baremetalsolution", - "version": "v2", - "title": "Bare Metal Solution API", "description": "Provides ways to manage Bare Metal Solution hardware installed in a regional extension located near a Google Cloud data center.", "discoveryRestUrl": "https://baremetalsolution.googleapis.com/$discovery/rest?version=v2", + "documentationLink": "https://cloud.google.com/bare-metal", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/bare-metal", - "preferred": true + "id": "baremetalsolution:v2", + "kind": "discovery#directoryItem", + "name": "baremetalsolution", + "preferred": true, + "title": "Bare Metal Solution API", + "version": "v2" }, { - "kind": "discovery#directoryItem", - "id": "batch:v1", - "name": "batch", - "version": "v1", - "title": "Batch API", "description": "An API to manage the running of Batch resources on Google Cloud Platform.", "discoveryRestUrl": "https://batch.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/batch/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/batch/", - "preferred": true + "id": "batch:v1", + "kind": "discovery#directoryItem", + "name": "batch", + "preferred": true, + "title": "Batch API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "beyondcorp:v1alpha", - "name": "beyondcorp", - "version": "v1alpha", - "title": "BeyondCorp API", "description": "Beyondcorp Enterprise provides identity and context aware access controls for enterprise resources and enables zero-trust access. Using the Beyondcorp Enterprise APIs, enterprises can set up multi-cloud and on-prem connectivity solutions.", "discoveryRestUrl": "https://beyondcorp.googleapis.com/$discovery/rest?version=v1alpha", + "documentationLink": "https://cloud.google.com/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/", - "preferred": false - }, - { + "id": "beyondcorp:v1alpha", "kind": "discovery#directoryItem", - "id": "beyondcorp:v1", "name": "beyondcorp", - "version": "v1", + "preferred": false, "title": "BeyondCorp API", + "version": "v1alpha" + }, + { "description": "Beyondcorp Enterprise provides identity and context aware access controls for enterprise resources and enables zero-trust access. Using the Beyondcorp Enterprise APIs, enterprises can set up multi-cloud and on-prem connectivity solutions.", "discoveryRestUrl": "https://beyondcorp.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/", - "preferred": true + "id": "beyondcorp:v1", + "kind": "discovery#directoryItem", + "name": "beyondcorp", + "preferred": true, + "title": "BeyondCorp API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "biglake:v1", - "name": "biglake", - "version": "v1", - "title": "BigLake API", "description": "The BigLake API provides access to BigLake Metastore, a serverless, fully managed, and highly available metastore for open-source data that can be used for querying Apache Iceberg tables in BigQuery.", "discoveryRestUrl": "https://biglake.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/bigquery/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/bigquery/", - "preferred": true + "id": "biglake:v1", + "kind": "discovery#directoryItem", + "name": "biglake", + "preferred": true, + "title": "BigLake API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "bigquery:v2", - "name": "bigquery", - "version": "v2", - "title": "BigQuery API", "description": "A data platform for customers to create, manage, share and query data.", "discoveryRestUrl": "https://bigquery.googleapis.com/$discovery/rest?version=v2", + "documentationLink": "https://cloud.google.com/bigquery/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/bigquery/", - "preferred": true + "id": "bigquery:v2", + "kind": "discovery#directoryItem", + "name": "bigquery", + "preferred": true, + "title": "BigQuery API", + "version": "v2" }, { - "kind": "discovery#directoryItem", - "id": "bigqueryconnection:v1beta1", - "name": "bigqueryconnection", - "version": "v1beta1", - "title": "BigQuery Connection API", "description": "Allows users to manage BigQuery connections to external data sources.", "discoveryRestUrl": "https://bigqueryconnection.googleapis.com/$discovery/rest?version=v1beta1", + "documentationLink": "https://cloud.google.com/bigquery/docs/connections-api-intro", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/bigquery/docs/connections-api-intro", - "preferred": false - }, - { + "id": "bigqueryconnection:v1beta1", "kind": "discovery#directoryItem", - "id": "bigqueryconnection:v1", "name": "bigqueryconnection", - "version": "v1", + "preferred": false, "title": "BigQuery Connection API", + "version": "v1beta1" + }, + { "description": "Allows users to manage BigQuery connections to external data sources.", "discoveryRestUrl": "https://bigqueryconnection.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/bigquery/docs/connections-api-intro", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/bigquery/docs/connections-api-intro", - "preferred": true + "id": "bigqueryconnection:v1", + "kind": "discovery#directoryItem", + "name": "bigqueryconnection", + "preferred": true, + "title": "BigQuery Connection API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "bigquerydatapolicy:v1", - "name": "bigquerydatapolicy", - "version": "v1", - "title": "BigQuery Data Policy API", "description": "Allows users to manage BigQuery data policies.", "discoveryRestUrl": "https://bigquerydatapolicy.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/bigquery/docs/column-data-masking", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/bigquery/docs/column-data-masking", - "preferred": true + "id": "bigquerydatapolicy:v1", + "kind": "discovery#directoryItem", + "name": "bigquerydatapolicy", + "preferred": true, + "title": "BigQuery Data Policy API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "bigquerydatatransfer:v1", - "name": "bigquerydatatransfer", - "version": "v1", - "title": "BigQuery Data Transfer API", "description": "Schedule queries or transfer external data from SaaS applications to Google BigQuery on a regular basis.", "discoveryRestUrl": "https://bigquerydatatransfer.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/bigquery-transfer/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/bigquery-transfer/", - "preferred": true + "id": "bigquerydatatransfer:v1", + "kind": "discovery#directoryItem", + "name": "bigquerydatatransfer", + "preferred": true, + "title": "BigQuery Data Transfer API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "bigqueryreservation:v1", - "name": "bigqueryreservation", - "version": "v1", - "title": "BigQuery Reservation API", "description": "A service to modify your BigQuery flat-rate reservations.", "discoveryRestUrl": "https://bigqueryreservation.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/bigquery/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/bigquery/", - "preferred": true + "id": "bigqueryreservation:v1", + "kind": "discovery#directoryItem", + "name": "bigqueryreservation", + "preferred": true, + "title": "BigQuery Reservation API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "bigtableadmin:v2", - "name": "bigtableadmin", - "version": "v2", - "title": "Cloud Bigtable Admin API", "description": "Administer your Cloud Bigtable tables and instances.", "discoveryRestUrl": "https://bigtableadmin.googleapis.com/$discovery/rest?version=v2", + "documentationLink": "https://cloud.google.com/bigtable/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/bigtable/", - "preferred": true + "id": "bigtableadmin:v2", + "kind": "discovery#directoryItem", + "name": "bigtableadmin", + "preferred": true, + "title": "Cloud Bigtable Admin API", + "version": "v2" }, { - "kind": "discovery#directoryItem", - "id": "billingbudgets:v1beta1", - "name": "billingbudgets", - "version": "v1beta1", - "title": "Cloud Billing Budget API", "description": "The Cloud Billing Budget API stores Cloud Billing budgets, which define a budget plan and the rules to execute as spend is tracked against that plan.", "discoveryRestUrl": "https://billingbudgets.googleapis.com/$discovery/rest?version=v1beta1", + "documentationLink": "https://cloud.google.com/billing/docs/how-to/budget-api-overview", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/billing/docs/how-to/budget-api-overview", - "preferred": false - }, - { + "id": "billingbudgets:v1beta1", "kind": "discovery#directoryItem", - "id": "billingbudgets:v1", "name": "billingbudgets", - "version": "v1", + "preferred": false, "title": "Cloud Billing Budget API", + "version": "v1beta1" + }, + { "description": "The Cloud Billing Budget API stores Cloud Billing budgets, which define a budget plan and the rules to execute as spend is tracked against that plan.", "discoveryRestUrl": "https://billingbudgets.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/billing/docs/how-to/budget-api-overview", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/billing/docs/how-to/budget-api-overview", - "preferred": true + "id": "billingbudgets:v1", + "kind": "discovery#directoryItem", + "name": "billingbudgets", + "preferred": true, + "title": "Cloud Billing Budget API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "binaryauthorization:v1beta1", - "name": "binaryauthorization", - "version": "v1beta1", - "title": "Binary Authorization API", "description": "The management interface for Binary Authorization, a service that provides policy-based deployment validation and control for images deployed to Google Kubernetes Engine (GKE), Anthos Service Mesh, Anthos Clusters, and Cloud Run.", "discoveryRestUrl": "https://binaryauthorization.googleapis.com/$discovery/rest?version=v1beta1", + "documentationLink": "https://cloud.google.com/binary-authorization/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/binary-authorization/", - "preferred": false - }, - { + "id": "binaryauthorization:v1beta1", "kind": "discovery#directoryItem", - "id": "binaryauthorization:v1", "name": "binaryauthorization", - "version": "v1", + "preferred": false, "title": "Binary Authorization API", + "version": "v1beta1" + }, + { "description": "The management interface for Binary Authorization, a service that provides policy-based deployment validation and control for images deployed to Google Kubernetes Engine (GKE), Anthos Service Mesh, Anthos Clusters, and Cloud Run.", "discoveryRestUrl": "https://binaryauthorization.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/binary-authorization/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/binary-authorization/", - "preferred": true - }, - { + "id": "binaryauthorization:v1", "kind": "discovery#directoryItem", - "id": "blockchainnodeengine:v1", - "name": "blockchainnodeengine", - "version": "v1", - "title": "Blockchain Node Engine API", + "name": "binaryauthorization", + "preferred": true, + "title": "Binary Authorization API", + "version": "v1" + }, + { "description": "", "discoveryRestUrl": "https://blockchainnodeengine.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/blockchain-node-engine", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/blockchain-node-engine", - "preferred": true + "id": "blockchainnodeengine:v1", + "kind": "discovery#directoryItem", + "name": "blockchainnodeengine", + "preferred": true, + "title": "Blockchain Node Engine API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "blogger:v2", - "name": "blogger", - "version": "v2", - "title": "Blogger API", "description": "The Blogger API provides access to posts, comments and pages of a Blogger blog.", "discoveryRestUrl": "https://blogger.googleapis.com/$discovery/rest?version=v2", + "documentationLink": "https://developers.google.com/blogger/docs/3.0/getting_started", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://developers.google.com/blogger/docs/3.0/getting_started", - "preferred": false - }, - { + "id": "blogger:v2", "kind": "discovery#directoryItem", - "id": "blogger:v3", "name": "blogger", - "version": "v3", + "preferred": false, "title": "Blogger API", + "version": "v2" + }, + { "description": "The Blogger API provides access to posts, comments and pages of a Blogger blog.", "discoveryRestUrl": "https://blogger.googleapis.com/$discovery/rest?version=v3", + "documentationLink": "https://developers.google.com/blogger/docs/3.0/getting_started", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://developers.google.com/blogger/docs/3.0/getting_started", - "preferred": true + "id": "blogger:v3", + "kind": "discovery#directoryItem", + "name": "blogger", + "preferred": true, + "title": "Blogger API", + "version": "v3" }, { - "kind": "discovery#directoryItem", - "id": "books:v1", - "name": "books", - "version": "v1", - "title": "Books API", "description": "The Google Books API allows clients to access the Google Books repository.", "discoveryRestUrl": "https://books.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://code.google.com/apis/books/docs/v1/getting_started.html", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://code.google.com/apis/books/docs/v1/getting_started.html", - "preferred": true + "id": "books:v1", + "kind": "discovery#directoryItem", + "name": "books", + "preferred": true, + "title": "Books API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "businessprofileperformance:v1", - "name": "businessprofileperformance", - "version": "v1", - "title": "Business Profile Performance API", "description": "The Business Profile Performance API allows merchants to fetch performance reports about their business profile on Google. Note - If you have a quota of 0 after enabling the API, please request for GBP API access.", "discoveryRestUrl": "https://businessprofileperformance.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://developers.google.com/my-business/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://developers.google.com/my-business/", - "preferred": true + "id": "businessprofileperformance:v1", + "kind": "discovery#directoryItem", + "name": "businessprofileperformance", + "preferred": true, + "title": "Business Profile Performance API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "calendar:v3", - "name": "calendar", - "version": "v3", - "title": "Google Calendar API", "description": "The Google Calendar API lets you manage your calendars and events.", "discoveryRestUrl": "https://calendar-json.googleapis.com/$discovery/rest?version=v3", + "documentationLink": "http://code.google.com/apis/calendar/v3/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "http://code.google.com/apis/calendar/v3/", - "preferred": true + "id": "calendar:v3", + "kind": "discovery#directoryItem", + "name": "calendar", + "preferred": true, + "title": "Google Calendar API", + "version": "v3" }, { - "kind": "discovery#directoryItem", - "id": "certificatemanager:v1", - "name": "certificatemanager", - "version": "v1", - "title": "Certificate Manager API", "description": "", "discoveryRestUrl": "https://certificatemanager.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/certificate-manager", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/certificate-manager", - "preferred": true + "id": "certificatemanager:v1", + "kind": "discovery#directoryItem", + "name": "certificatemanager", + "preferred": true, + "title": "Certificate Manager API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "chat:v1", - "name": "chat", - "version": "v1", - "title": "Google Chat API", "description": "The Google Chat API lets you build Chat apps to integrate your services with Google Chat and manage Chat resources such as spaces, members, and messages.", "discoveryRestUrl": "https://chat.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://developers.google.com/hangouts/chat", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://developers.google.com/hangouts/chat", - "preferred": true + "id": "chat:v1", + "kind": "discovery#directoryItem", + "name": "chat", + "preferred": true, + "title": "Google Chat API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "checks:v1alpha", - "name": "checks", - "version": "v1alpha", - "title": "Checks API", "description": "The Checks API contains powerful and easy-to-use privacy and compliance APIs that interact with the Checks product and its underlying technology.", "discoveryRestUrl": "https://checks.googleapis.com/$discovery/rest?version=v1alpha", + "documentationLink": "https://developers.google.com/checks", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://developers.google.com/checks", - "preferred": true + "id": "checks:v1alpha", + "kind": "discovery#directoryItem", + "name": "checks", + "preferred": true, + "title": "Checks API", + "version": "v1alpha" }, { - "kind": "discovery#directoryItem", - "id": "chromemanagement:v1", - "name": "chromemanagement", - "version": "v1", - "title": "Chrome Management API", "description": "The Chrome Management API is a suite of services that allows Chrome administrators to view, manage and gain insights on their Chrome OS and Chrome Browser devices.", "discoveryRestUrl": "https://chromemanagement.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "http://developers.google.com/chrome/management/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "http://developers.google.com/chrome/management/", - "preferred": true + "id": "chromemanagement:v1", + "kind": "discovery#directoryItem", + "name": "chromemanagement", + "preferred": true, + "title": "Chrome Management API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "chromepolicy:v1", - "name": "chromepolicy", - "version": "v1", - "title": "Chrome Policy API", "description": "The Chrome Policy API is a suite of services that allows Chrome administrators to control the policies applied to their managed Chrome OS devices and Chrome browsers.", "discoveryRestUrl": "https://chromepolicy.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "http://developers.google.com/chrome/policy", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "http://developers.google.com/chrome/policy", - "preferred": true + "id": "chromepolicy:v1", + "kind": "discovery#directoryItem", + "name": "chromepolicy", + "preferred": true, + "title": "Chrome Policy API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "chromeuxreport:v1", - "name": "chromeuxreport", - "version": "v1", - "title": "Chrome UX Report API", "description": "The Chrome UX Report API lets you view real user experience data for millions of websites.", "discoveryRestUrl": "https://chromeuxreport.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://developers.google.com/web/tools/chrome-user-experience-report/api/reference", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://developers.google.com/web/tools/chrome-user-experience-report/api/reference", - "preferred": true + "id": "chromeuxreport:v1", + "kind": "discovery#directoryItem", + "name": "chromeuxreport", + "preferred": true, + "title": "Chrome UX Report API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "civicinfo:v2", - "name": "civicinfo", - "version": "v2", - "title": "Google Civic Information API", "description": "Provides polling places, early vote locations, contest data, election officials, and government representatives for U.S. residential addresses.", "discoveryRestUrl": "https://civicinfo.googleapis.com/$discovery/rest?version=v2", + "documentationLink": "https://developers.google.com/civic-information/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://developers.google.com/civic-information/", - "preferred": true + "id": "civicinfo:v2", + "kind": "discovery#directoryItem", + "name": "civicinfo", + "preferred": true, + "title": "Google Civic Information API", + "version": "v2" }, { - "kind": "discovery#directoryItem", - "id": "classroom:v1", - "name": "classroom", - "version": "v1", - "title": "Google Classroom API", "description": "Manages classes, rosters, and invitations in Google Classroom.", "discoveryRestUrl": "https://classroom.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://developers.google.com/classroom", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://developers.google.com/classroom", - "preferred": true + "id": "classroom:v1", + "kind": "discovery#directoryItem", + "name": "classroom", + "preferred": true, + "title": "Google Classroom API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "cloudasset:v1p1beta1", - "name": "cloudasset", - "version": "v1p1beta1", - "title": "Cloud Asset API", "description": "The Cloud Asset API manages the history and inventory of Google Cloud resources.", "discoveryRestUrl": "https://cloudasset.googleapis.com/$discovery/rest?version=v1p1beta1", + "documentationLink": "https://cloud.google.com/asset-inventory/docs/quickstart", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/asset-inventory/docs/quickstart", - "preferred": false - }, - { + "id": "cloudasset:v1p1beta1", "kind": "discovery#directoryItem", - "id": "cloudasset:v1p5beta1", "name": "cloudasset", - "version": "v1p5beta1", + "preferred": false, "title": "Cloud Asset API", + "version": "v1p1beta1" + }, + { "description": "The Cloud Asset API manages the history and inventory of Google Cloud resources.", "discoveryRestUrl": "https://cloudasset.googleapis.com/$discovery/rest?version=v1p5beta1", + "documentationLink": "https://cloud.google.com/asset-inventory/docs/quickstart", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/asset-inventory/docs/quickstart", - "preferred": false - }, - { + "id": "cloudasset:v1p5beta1", "kind": "discovery#directoryItem", - "id": "cloudasset:v1p7beta1", "name": "cloudasset", - "version": "v1p7beta1", + "preferred": false, "title": "Cloud Asset API", + "version": "v1p5beta1" + }, + { "description": "The Cloud Asset API manages the history and inventory of Google Cloud resources.", "discoveryRestUrl": "https://cloudasset.googleapis.com/$discovery/rest?version=v1p7beta1", + "documentationLink": "https://cloud.google.com/asset-inventory/docs/quickstart", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/asset-inventory/docs/quickstart", - "preferred": false - }, - { + "id": "cloudasset:v1p7beta1", "kind": "discovery#directoryItem", - "id": "cloudasset:v1beta1", "name": "cloudasset", - "version": "v1beta1", + "preferred": false, "title": "Cloud Asset API", + "version": "v1p7beta1" + }, + { "description": "The Cloud Asset API manages the history and inventory of Google Cloud resources.", "discoveryRestUrl": "https://cloudasset.googleapis.com/$discovery/rest?version=v1beta1", + "documentationLink": "https://cloud.google.com/asset-inventory/docs/quickstart", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/asset-inventory/docs/quickstart", - "preferred": false - }, - { + "id": "cloudasset:v1beta1", "kind": "discovery#directoryItem", - "id": "cloudasset:v1", "name": "cloudasset", - "version": "v1", + "preferred": false, "title": "Cloud Asset API", + "version": "v1beta1" + }, + { "description": "The Cloud Asset API manages the history and inventory of Google Cloud resources.", "discoveryRestUrl": "https://cloudasset.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/asset-inventory/docs/quickstart", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/asset-inventory/docs/quickstart", - "preferred": true + "id": "cloudasset:v1", + "kind": "discovery#directoryItem", + "name": "cloudasset", + "preferred": true, + "title": "Cloud Asset API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "cloudbilling:v1beta", - "name": "cloudbilling", - "version": "v1beta", - "title": "Cloud Billing API", "description": "Allows developers to manage billing for their Google Cloud Platform projects programmatically.", "discoveryRestUrl": "https://cloudbilling.googleapis.com/$discovery/rest?version=v1beta", + "documentationLink": "https://cloud.google.com/billing/docs/apis", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/billing/docs/apis", - "preferred": false - }, - { + "id": "cloudbilling:v1beta", "kind": "discovery#directoryItem", - "id": "cloudbilling:v1", "name": "cloudbilling", - "version": "v1", + "preferred": false, "title": "Cloud Billing API", + "version": "v1beta" + }, + { "description": "Allows developers to manage billing for their Google Cloud Platform projects programmatically.", "discoveryRestUrl": "https://cloudbilling.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/billing/docs/apis", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/billing/docs/apis", - "preferred": true + "id": "cloudbilling:v1", + "kind": "discovery#directoryItem", + "name": "cloudbilling", + "preferred": true, + "title": "Cloud Billing API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "cloudbuild:v1", - "name": "cloudbuild", - "version": "v1", - "title": "Cloud Build API", "description": "Creates and manages builds on Google Cloud Platform.", "discoveryRestUrl": "https://cloudbuild.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/cloud-build/docs/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/cloud-build/docs/", - "preferred": false - }, - { + "id": "cloudbuild:v1", "kind": "discovery#directoryItem", - "id": "cloudbuild:v2", "name": "cloudbuild", - "version": "v2", + "preferred": false, "title": "Cloud Build API", + "version": "v1" + }, + { "description": "Creates and manages builds on Google Cloud Platform.", "discoveryRestUrl": "https://cloudbuild.googleapis.com/$discovery/rest?version=v2", + "documentationLink": "https://cloud.google.com/cloud-build/docs/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/cloud-build/docs/", - "preferred": true + "id": "cloudbuild:v2", + "kind": "discovery#directoryItem", + "name": "cloudbuild", + "preferred": true, + "title": "Cloud Build API", + "version": "v2" }, { - "kind": "discovery#directoryItem", - "id": "cloudchannel:v1", - "name": "cloudchannel", - "version": "v1", - "title": "Cloud Channel API", "description": "The Cloud Channel API enables Google Cloud partners to have a single unified resale platform and APIs across all of Google Cloud including GCP, Workspace, Maps and Chrome.", "discoveryRestUrl": "https://cloudchannel.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/channel", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/channel", - "preferred": true + "id": "cloudchannel:v1", + "kind": "discovery#directoryItem", + "name": "cloudchannel", + "preferred": true, + "title": "Cloud Channel API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "cloudcontrolspartner:v1beta", - "name": "cloudcontrolspartner", - "version": "v1beta", - "title": "Cloud Controls Partner API", "description": "Provides insights about your customers and their Assured Workloads based on your Sovereign Controls by Partners offering.", "discoveryRestUrl": "https://cloudcontrolspartner.googleapis.com/$discovery/rest?version=v1beta", + "documentationLink": "https://cloud.google.com/sovereign-controls-by-partners/docs/sovereign-partners/reference/rest", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/sovereign-controls-by-partners/docs/sovereign-partners/reference/rest", - "preferred": false - }, - { + "id": "cloudcontrolspartner:v1beta", "kind": "discovery#directoryItem", - "id": "cloudcontrolspartner:v1", "name": "cloudcontrolspartner", - "version": "v1", + "preferred": false, "title": "Cloud Controls Partner API", + "version": "v1beta" + }, + { "description": "Provides insights about your customers and their Assured Workloads based on your Sovereign Controls by Partners offering.", "discoveryRestUrl": "https://cloudcontrolspartner.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/sovereign-controls-by-partners/docs/sovereign-partners/reference/rest", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/sovereign-controls-by-partners/docs/sovereign-partners/reference/rest", - "preferred": true + "id": "cloudcontrolspartner:v1", + "kind": "discovery#directoryItem", + "name": "cloudcontrolspartner", + "preferred": true, + "title": "Cloud Controls Partner API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "clouddeploy:v1", - "name": "clouddeploy", - "version": "v1", - "title": "Cloud Deploy API", "description": "", "discoveryRestUrl": "https://clouddeploy.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/deploy/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/deploy/", - "preferred": true + "id": "clouddeploy:v1", + "kind": "discovery#directoryItem", + "name": "clouddeploy", + "preferred": true, + "title": "Cloud Deploy API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "clouderrorreporting:v1beta1", - "name": "clouderrorreporting", - "version": "v1beta1", - "title": "Error Reporting API", "description": "Groups and counts similar errors from cloud services and applications, reports new errors, and provides access to error groups and their associated errors.", "discoveryRestUrl": "https://clouderrorreporting.googleapis.com/$discovery/rest?version=v1beta1", + "documentationLink": "https://cloud.google.com/error-reporting/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/error-reporting/", - "preferred": true + "id": "clouderrorreporting:v1beta1", + "kind": "discovery#directoryItem", + "name": "clouderrorreporting", + "preferred": true, + "title": "Error Reporting API", + "version": "v1beta1" }, { - "kind": "discovery#directoryItem", - "id": "cloudfunctions:v2alpha", - "name": "cloudfunctions", - "version": "v2alpha", - "title": "Cloud Functions API", "description": "Manages lightweight user-provided functions executed in response to events.", "discoveryRestUrl": "https://cloudfunctions.googleapis.com/$discovery/rest?version=v2alpha", + "documentationLink": "https://cloud.google.com/functions", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/functions", - "preferred": false - }, - { + "id": "cloudfunctions:v2alpha", "kind": "discovery#directoryItem", - "id": "cloudfunctions:v2beta", "name": "cloudfunctions", - "version": "v2beta", + "preferred": false, "title": "Cloud Functions API", + "version": "v2alpha" + }, + { "description": "Manages lightweight user-provided functions executed in response to events.", "discoveryRestUrl": "https://cloudfunctions.googleapis.com/$discovery/rest?version=v2beta", + "documentationLink": "https://cloud.google.com/functions", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/functions", - "preferred": false - }, - { + "id": "cloudfunctions:v2beta", "kind": "discovery#directoryItem", - "id": "cloudfunctions:v1", "name": "cloudfunctions", - "version": "v1", + "preferred": false, "title": "Cloud Functions API", + "version": "v2beta" + }, + { "description": "Manages lightweight user-provided functions executed in response to events.", "discoveryRestUrl": "https://cloudfunctions.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/functions", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/functions", - "preferred": false - }, - { + "id": "cloudfunctions:v1", "kind": "discovery#directoryItem", - "id": "cloudfunctions:v2", "name": "cloudfunctions", - "version": "v2", + "preferred": false, "title": "Cloud Functions API", + "version": "v1" + }, + { "description": "Manages lightweight user-provided functions executed in response to events.", "discoveryRestUrl": "https://cloudfunctions.googleapis.com/$discovery/rest?version=v2", + "documentationLink": "https://cloud.google.com/functions", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/functions", - "preferred": true + "id": "cloudfunctions:v2", + "kind": "discovery#directoryItem", + "name": "cloudfunctions", + "preferred": true, + "title": "Cloud Functions API", + "version": "v2" }, { - "kind": "discovery#directoryItem", - "id": "cloudidentity:v1beta1", - "name": "cloudidentity", - "version": "v1beta1", - "title": "Cloud Identity API", "description": "API for provisioning and managing identity resources.", "discoveryRestUrl": "https://cloudidentity.googleapis.com/$discovery/rest?version=v1beta1", + "documentationLink": "https://cloud.google.com/identity/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/identity/", - "preferred": false - }, - { + "id": "cloudidentity:v1beta1", "kind": "discovery#directoryItem", - "id": "cloudidentity:v1", "name": "cloudidentity", - "version": "v1", + "preferred": false, "title": "Cloud Identity API", + "version": "v1beta1" + }, + { "description": "API for provisioning and managing identity resources.", "discoveryRestUrl": "https://cloudidentity.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/identity/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/identity/", - "preferred": true + "id": "cloudidentity:v1", + "kind": "discovery#directoryItem", + "name": "cloudidentity", + "preferred": true, + "title": "Cloud Identity API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "cloudkms:v1", - "name": "cloudkms", - "version": "v1", - "title": "Cloud Key Management Service (KMS) API", "description": "Manages keys and performs cryptographic operations in a central cloud service, for direct use by other cloud resources and applications.", "discoveryRestUrl": "https://cloudkms.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/kms/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/kms/", - "preferred": true + "id": "cloudkms:v1", + "kind": "discovery#directoryItem", + "name": "cloudkms", + "preferred": true, + "title": "Cloud Key Management Service (KMS) API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "cloudprofiler:v2", - "name": "cloudprofiler", - "version": "v2", - "title": "Cloud Profiler API", "description": "Manages continuous profiling information.", "discoveryRestUrl": "https://cloudprofiler.googleapis.com/$discovery/rest?version=v2", + "documentationLink": "https://cloud.google.com/profiler/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/profiler/", - "preferred": true + "id": "cloudprofiler:v2", + "kind": "discovery#directoryItem", + "name": "cloudprofiler", + "preferred": true, + "title": "Cloud Profiler API", + "version": "v2" }, { - "kind": "discovery#directoryItem", - "id": "cloudresourcemanager:v1beta1", - "name": "cloudresourcemanager", - "version": "v1beta1", - "title": "Cloud Resource Manager API", "description": "Creates, reads, and updates metadata for Google Cloud Platform resource containers.", "discoveryRestUrl": "https://cloudresourcemanager.googleapis.com/$discovery/rest?version=v1beta1", + "documentationLink": "https://cloud.google.com/resource-manager", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/resource-manager", - "preferred": false - }, - { + "id": "cloudresourcemanager:v1beta1", "kind": "discovery#directoryItem", - "id": "cloudresourcemanager:v2beta1", "name": "cloudresourcemanager", - "version": "v2beta1", + "preferred": false, "title": "Cloud Resource Manager API", + "version": "v1beta1" + }, + { "description": "Creates, reads, and updates metadata for Google Cloud Platform resource containers.", "discoveryRestUrl": "https://cloudresourcemanager.googleapis.com/$discovery/rest?version=v2beta1", + "documentationLink": "https://cloud.google.com/resource-manager", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/resource-manager", - "preferred": false - }, - { + "id": "cloudresourcemanager:v2beta1", "kind": "discovery#directoryItem", - "id": "cloudresourcemanager:v1", "name": "cloudresourcemanager", - "version": "v1", + "preferred": false, "title": "Cloud Resource Manager API", + "version": "v2beta1" + }, + { "description": "Creates, reads, and updates metadata for Google Cloud Platform resource containers.", "discoveryRestUrl": "https://cloudresourcemanager.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/resource-manager", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/resource-manager", - "preferred": false - }, - { + "id": "cloudresourcemanager:v1", "kind": "discovery#directoryItem", - "id": "cloudresourcemanager:v2", "name": "cloudresourcemanager", - "version": "v2", + "preferred": false, "title": "Cloud Resource Manager API", + "version": "v1" + }, + { "description": "Creates, reads, and updates metadata for Google Cloud Platform resource containers.", "discoveryRestUrl": "https://cloudresourcemanager.googleapis.com/$discovery/rest?version=v2", + "documentationLink": "https://cloud.google.com/resource-manager", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/resource-manager", - "preferred": false - }, - { + "id": "cloudresourcemanager:v2", "kind": "discovery#directoryItem", - "id": "cloudresourcemanager:v3", "name": "cloudresourcemanager", - "version": "v3", + "preferred": false, "title": "Cloud Resource Manager API", + "version": "v2" + }, + { "description": "Creates, reads, and updates metadata for Google Cloud Platform resource containers.", "discoveryRestUrl": "https://cloudresourcemanager.googleapis.com/$discovery/rest?version=v3", + "documentationLink": "https://cloud.google.com/resource-manager", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/resource-manager", - "preferred": true + "id": "cloudresourcemanager:v3", + "kind": "discovery#directoryItem", + "name": "cloudresourcemanager", + "preferred": true, + "title": "Cloud Resource Manager API", + "version": "v3" }, { - "kind": "discovery#directoryItem", - "id": "cloudscheduler:v1beta1", - "name": "cloudscheduler", - "version": "v1beta1", - "title": "Cloud Scheduler API", "description": "Creates and manages jobs run on a regular recurring schedule.", "discoveryRestUrl": "https://cloudscheduler.googleapis.com/$discovery/rest?version=v1beta1", + "documentationLink": "https://cloud.google.com/scheduler/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/scheduler/", - "preferred": false - }, - { + "id": "cloudscheduler:v1beta1", "kind": "discovery#directoryItem", - "id": "cloudscheduler:v1", "name": "cloudscheduler", - "version": "v1", + "preferred": false, "title": "Cloud Scheduler API", + "version": "v1beta1" + }, + { "description": "Creates and manages jobs run on a regular recurring schedule.", "discoveryRestUrl": "https://cloudscheduler.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/scheduler/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/scheduler/", - "preferred": true + "id": "cloudscheduler:v1", + "kind": "discovery#directoryItem", + "name": "cloudscheduler", + "preferred": true, + "title": "Cloud Scheduler API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "cloudsearch:v1", - "name": "cloudsearch", - "version": "v1", - "title": "Cloud Search API", "description": "Cloud Search provides cloud-based search capabilities over Google Workspace data. The Cloud Search API allows indexing of non-Google Workspace data into Cloud Search.", "discoveryRestUrl": "https://cloudsearch.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://developers.google.com/cloud-search/docs/guides/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://developers.google.com/cloud-search/docs/guides/", - "preferred": true + "id": "cloudsearch:v1", + "kind": "discovery#directoryItem", + "name": "cloudsearch", + "preferred": true, + "title": "Cloud Search API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "cloudshell:v1", - "name": "cloudshell", - "version": "v1", - "title": "Cloud Shell API", "description": "Allows users to start, configure, and connect to interactive shell sessions running in the cloud.", "discoveryRestUrl": "https://cloudshell.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/shell/docs/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/shell/docs/", - "preferred": true + "id": "cloudshell:v1", + "kind": "discovery#directoryItem", + "name": "cloudshell", + "preferred": true, + "title": "Cloud Shell API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "cloudsupport:v2beta", - "name": "cloudsupport", - "version": "v2beta", - "title": "Google Cloud Support API", "description": "Manages Google Cloud technical support cases for Customer Care support offerings.", "discoveryRestUrl": "https://cloudsupport.googleapis.com/$discovery/rest?version=v2beta", + "documentationLink": "https://cloud.google.com/support/docs/apis", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/support/docs/apis", - "preferred": false - }, - { + "id": "cloudsupport:v2beta", "kind": "discovery#directoryItem", - "id": "cloudsupport:v2", "name": "cloudsupport", - "version": "v2", + "preferred": false, "title": "Google Cloud Support API", + "version": "v2beta" + }, + { "description": "Manages Google Cloud technical support cases for Customer Care support offerings.", "discoveryRestUrl": "https://cloudsupport.googleapis.com/$discovery/rest?version=v2", + "documentationLink": "https://cloud.google.com/support/docs/apis", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/support/docs/apis", - "preferred": true + "id": "cloudsupport:v2", + "kind": "discovery#directoryItem", + "name": "cloudsupport", + "preferred": true, + "title": "Google Cloud Support API", + "version": "v2" }, { - "kind": "discovery#directoryItem", - "id": "cloudtasks:v2beta2", - "name": "cloudtasks", - "version": "v2beta2", - "title": "Cloud Tasks API", "description": "Manages the execution of large numbers of distributed requests.", "discoveryRestUrl": "https://cloudtasks.googleapis.com/$discovery/rest?version=v2beta2", + "documentationLink": "https://cloud.google.com/tasks/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/tasks/", - "preferred": false - }, - { + "id": "cloudtasks:v2beta2", "kind": "discovery#directoryItem", - "id": "cloudtasks:v2beta3", "name": "cloudtasks", - "version": "v2beta3", + "preferred": false, "title": "Cloud Tasks API", + "version": "v2beta2" + }, + { "description": "Manages the execution of large numbers of distributed requests.", "discoveryRestUrl": "https://cloudtasks.googleapis.com/$discovery/rest?version=v2beta3", + "documentationLink": "https://cloud.google.com/tasks/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/tasks/", - "preferred": false - }, - { + "id": "cloudtasks:v2beta3", "kind": "discovery#directoryItem", - "id": "cloudtasks:v2", "name": "cloudtasks", - "version": "v2", + "preferred": false, "title": "Cloud Tasks API", + "version": "v2beta3" + }, + { "description": "Manages the execution of large numbers of distributed requests.", "discoveryRestUrl": "https://cloudtasks.googleapis.com/$discovery/rest?version=v2", + "documentationLink": "https://cloud.google.com/tasks/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/tasks/", - "preferred": true + "id": "cloudtasks:v2", + "kind": "discovery#directoryItem", + "name": "cloudtasks", + "preferred": true, + "title": "Cloud Tasks API", + "version": "v2" }, { - "kind": "discovery#directoryItem", - "id": "cloudtrace:v2beta1", - "name": "cloudtrace", - "version": "v2beta1", - "title": "Cloud Trace API", "description": "Sends application trace data to Cloud Trace for viewing. Trace data is collected for all App Engine applications by default. Trace data from other applications can be provided using this API. This library is used to interact with the Cloud Trace API directly. If you are looking to instrument your application for Cloud Trace, we recommend using OpenTelemetry.", "discoveryRestUrl": "https://cloudtrace.googleapis.com/$discovery/rest?version=v2beta1", + "documentationLink": "https://cloud.google.com/trace", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/trace", - "preferred": false - }, - { + "id": "cloudtrace:v2beta1", "kind": "discovery#directoryItem", - "id": "cloudtrace:v1", "name": "cloudtrace", - "version": "v1", + "preferred": false, "title": "Cloud Trace API", + "version": "v2beta1" + }, + { "description": "Sends application trace data to Cloud Trace for viewing. Trace data is collected for all App Engine applications by default. Trace data from other applications can be provided using this API. This library is used to interact with the Cloud Trace API directly. If you are looking to instrument your application for Cloud Trace, we recommend using OpenTelemetry.", "discoveryRestUrl": "https://cloudtrace.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/trace", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/trace", - "preferred": false - }, - { + "id": "cloudtrace:v1", "kind": "discovery#directoryItem", - "id": "cloudtrace:v2", "name": "cloudtrace", - "version": "v2", + "preferred": false, "title": "Cloud Trace API", + "version": "v1" + }, + { "description": "Sends application trace data to Cloud Trace for viewing. Trace data is collected for all App Engine applications by default. Trace data from other applications can be provided using this API. This library is used to interact with the Cloud Trace API directly. If you are looking to instrument your application for Cloud Trace, we recommend using OpenTelemetry.", "discoveryRestUrl": "https://cloudtrace.googleapis.com/$discovery/rest?version=v2", + "documentationLink": "https://cloud.google.com/trace", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/trace", - "preferred": true + "id": "cloudtrace:v2", + "kind": "discovery#directoryItem", + "name": "cloudtrace", + "preferred": true, + "title": "Cloud Trace API", + "version": "v2" }, { - "kind": "discovery#directoryItem", - "id": "composer:v1beta1", - "name": "composer", - "version": "v1beta1", - "title": "Cloud Composer API", "description": "Manages Apache Airflow environments on Google Cloud Platform.", "discoveryRestUrl": "https://composer.googleapis.com/$discovery/rest?version=v1beta1", + "documentationLink": "https://cloud.google.com/composer/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/composer/", - "preferred": false - }, - { + "id": "composer:v1beta1", "kind": "discovery#directoryItem", - "id": "composer:v1", "name": "composer", - "version": "v1", + "preferred": false, "title": "Cloud Composer API", + "version": "v1beta1" + }, + { "description": "Manages Apache Airflow environments on Google Cloud Platform.", "discoveryRestUrl": "https://composer.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/composer/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/composer/", - "preferred": true + "id": "composer:v1", + "kind": "discovery#directoryItem", + "name": "composer", + "preferred": true, + "title": "Cloud Composer API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "compute:alpha", - "name": "compute", - "version": "alpha", - "title": "Compute Engine API", "description": "Creates and runs virtual machines on Google Cloud Platform.", - "discoveryRestUrl": "https://www.googleapis.com/discovery/v1/apis/compute/alpha/rest", "discoveryLink": "./apis/compute/alpha/rest", + "discoveryRestUrl": "https://www.googleapis.com/discovery/v1/apis/compute/alpha/rest", + "documentationLink": "https://developers.google.com/compute/docs/reference/latest/", "icons": { "x16": "https://www.google.com/images/icons/product/compute_engine-16.png", "x32": "https://www.google.com/images/icons/product/compute_engine-32.png" }, - "documentationLink": "https://developers.google.com/compute/docs/reference/latest/", - "preferred": false - }, - { + "id": "compute:alpha", "kind": "discovery#directoryItem", - "id": "compute:beta", "name": "compute", - "version": "beta", + "preferred": false, "title": "Compute Engine API", + "version": "alpha" + }, + { "description": "Creates and runs virtual machines on Google Cloud Platform.", - "discoveryRestUrl": "https://www.googleapis.com/discovery/v1/apis/compute/beta/rest", "discoveryLink": "./apis/compute/beta/rest", + "discoveryRestUrl": "https://www.googleapis.com/discovery/v1/apis/compute/beta/rest", + "documentationLink": "https://developers.google.com/compute/docs/reference/latest/", "icons": { "x16": "https://www.google.com/images/icons/product/compute_engine-16.png", "x32": "https://www.google.com/images/icons/product/compute_engine-32.png" }, - "documentationLink": "https://developers.google.com/compute/docs/reference/latest/", - "preferred": false - }, - { + "id": "compute:beta", "kind": "discovery#directoryItem", - "id": "compute:v1", "name": "compute", - "version": "v1", + "preferred": false, "title": "Compute Engine API", + "version": "beta" + }, + { "description": "Creates and runs virtual machines on Google Cloud Platform.", - "discoveryRestUrl": "https://www.googleapis.com/discovery/v1/apis/compute/v1/rest", "discoveryLink": "./apis/compute/v1/rest", + "discoveryRestUrl": "https://www.googleapis.com/discovery/v1/apis/compute/v1/rest", + "documentationLink": "https://developers.google.com/compute/docs/reference/latest/", "icons": { "x16": "https://www.google.com/images/icons/product/compute_engine-16.png", "x32": "https://www.google.com/images/icons/product/compute_engine-32.png" }, - "documentationLink": "https://developers.google.com/compute/docs/reference/latest/", - "preferred": true + "id": "compute:v1", + "kind": "discovery#directoryItem", + "name": "compute", + "preferred": true, + "title": "Compute Engine API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "config:v1", - "name": "config", - "version": "v1", - "title": "Infrastructure Manager API", "description": "Creates and manages Google Cloud Platform resources and infrastructure.", "discoveryRestUrl": "https://config.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/infrastructure-manager/docs", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/infrastructure-manager/docs", - "preferred": true + "id": "config:v1", + "kind": "discovery#directoryItem", + "name": "config", + "preferred": true, + "title": "Infrastructure Manager API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "connectors:v1", - "name": "connectors", - "version": "v1", - "title": "Connectors API", "description": "Enables users to create and manage connections to Google Cloud services and third-party business applications using the Connectors interface.", "discoveryRestUrl": "https://connectors.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/apigee/docs/api-platform/connectors/about-connectors", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/apigee/docs/api-platform/connectors/about-connectors", - "preferred": false - }, - { + "id": "connectors:v1", "kind": "discovery#directoryItem", - "id": "connectors:v2", "name": "connectors", - "version": "v2", + "preferred": false, "title": "Connectors API", + "version": "v1" + }, + { "description": "Enables users to create and manage connections to Google Cloud services and third-party business applications using the Connectors interface.", "discoveryRestUrl": "https://connectors.googleapis.com/$discovery/rest?version=v2", + "documentationLink": "https://cloud.google.com/apigee/docs/api-platform/connectors/about-connectors", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/apigee/docs/api-platform/connectors/about-connectors", - "preferred": true + "id": "connectors:v2", + "kind": "discovery#directoryItem", + "name": "connectors", + "preferred": true, + "title": "Connectors API", + "version": "v2" }, { - "kind": "discovery#directoryItem", - "id": "contactcenteraiplatform:v1alpha1", - "name": "contactcenteraiplatform", - "version": "v1alpha1", - "title": "Contact Center AI Platform API", "description": "", "discoveryRestUrl": "https://contactcenteraiplatform.googleapis.com/$discovery/rest?version=v1alpha1", + "documentationLink": "https://cloud.google.com/solutions/contact-center-ai-platform", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/solutions/contact-center-ai-platform", - "preferred": true + "id": "contactcenteraiplatform:v1alpha1", + "kind": "discovery#directoryItem", + "name": "contactcenteraiplatform", + "preferred": true, + "title": "Contact Center AI Platform API", + "version": "v1alpha1" }, { - "kind": "discovery#directoryItem", - "id": "contactcenterinsights:v1", - "name": "contactcenterinsights", - "version": "v1", - "title": "Contact Center AI Insights API", "description": "", "discoveryRestUrl": "https://contactcenterinsights.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/contact-center/insights/docs", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/contact-center/insights/docs", - "preferred": true + "id": "contactcenterinsights:v1", + "kind": "discovery#directoryItem", + "name": "contactcenterinsights", + "preferred": true, + "title": "Contact Center AI Insights API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "container:v1beta1", - "name": "container", - "version": "v1beta1", - "title": "Kubernetes Engine API", "description": "Builds and manages container-based applications, powered by the open source Kubernetes technology.", "discoveryRestUrl": "https://container.googleapis.com/$discovery/rest?version=v1beta1", + "documentationLink": "https://cloud.google.com/container-engine/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/container-engine/", - "preferred": false - }, - { + "id": "container:v1beta1", "kind": "discovery#directoryItem", - "id": "container:v1", "name": "container", - "version": "v1", + "preferred": false, "title": "Kubernetes Engine API", + "version": "v1beta1" + }, + { "description": "Builds and manages container-based applications, powered by the open source Kubernetes technology.", "discoveryRestUrl": "https://container.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/container-engine/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/container-engine/", - "preferred": true + "id": "container:v1", + "kind": "discovery#directoryItem", + "name": "container", + "preferred": true, + "title": "Kubernetes Engine API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "containeranalysis:v1alpha1", - "name": "containeranalysis", - "version": "v1alpha1", - "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 is an implementation of the Grafeas API, which enables storing, querying, and retrieval of critical metadata about all of your software artifacts.", "discoveryRestUrl": "https://containeranalysis.googleapis.com/$discovery/rest?version=v1alpha1", + "documentationLink": "https://cloud.google.com/container-analysis/api/reference/rest/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/container-analysis/api/reference/rest/", - "preferred": false - }, - { + "id": "containeranalysis:v1alpha1", "kind": "discovery#directoryItem", - "id": "containeranalysis:v1beta1", "name": "containeranalysis", - "version": "v1beta1", + "preferred": false, "title": "Container Analysis API", + "version": "v1alpha1" + }, + { "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.", "discoveryRestUrl": "https://containeranalysis.googleapis.com/$discovery/rest?version=v1beta1", + "documentationLink": "https://cloud.google.com/container-analysis/api/reference/rest/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/container-analysis/api/reference/rest/", - "preferred": false - }, - { + "id": "containeranalysis:v1beta1", "kind": "discovery#directoryItem", - "id": "containeranalysis:v1", "name": "containeranalysis", - "version": "v1", + "preferred": false, "title": "Container Analysis API", + "version": "v1beta1" + }, + { "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.", "discoveryRestUrl": "https://containeranalysis.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/container-analysis/api/reference/rest/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/container-analysis/api/reference/rest/", - "preferred": true + "id": "containeranalysis:v1", + "kind": "discovery#directoryItem", + "name": "containeranalysis", + "preferred": true, + "title": "Container Analysis API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "content:v2.1", - "name": "content", - "version": "v2.1", - "title": "Content API for Shopping", "description": "Manage your product listings and accounts for Google Shopping", "discoveryRestUrl": "https://shoppingcontent.googleapis.com/$discovery/rest?version=v2.1", + "documentationLink": "https://developers.google.com/shopping-content/v2/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://developers.google.com/shopping-content/v2/", - "preferred": true + "id": "content:v2.1", + "kind": "discovery#directoryItem", + "name": "content", + "preferred": true, + "title": "Content API for Shopping", + "version": "v2.1" }, { - "kind": "discovery#directoryItem", - "id": "contentwarehouse:v1", - "name": "contentwarehouse", - "version": "v1", - "title": "Document AI Warehouse API", "description": "", "discoveryRestUrl": "https://contentwarehouse.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/document-warehouse", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/document-warehouse", - "preferred": true + "id": "contentwarehouse:v1", + "kind": "discovery#directoryItem", + "name": "contentwarehouse", + "preferred": true, + "title": "Document AI Warehouse API", + "version": "v1" }, { + "description": "Programmatically manage your Comparison Shopping Service (CSS) account data at scale.", + "discoveryRestUrl": "https://css.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://developers.google.com/comparison-shopping-services/api/overview", + "icons": { + "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", + "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" + }, + "id": "css:v1", "kind": "discovery#directoryItem", - "id": "customsearch:v1", - "name": "customsearch", - "version": "v1", - "title": "Custom Search API", + "name": "css", + "preferred": true, + "title": "CSS API", + "version": "v1" + }, + { "description": "Searches over a website or collection of websites", "discoveryRestUrl": "https://customsearch.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://developers.google.com/custom-search/v1/introduction", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://developers.google.com/custom-search/v1/introduction", - "preferred": true + "id": "customsearch:v1", + "kind": "discovery#directoryItem", + "name": "customsearch", + "preferred": true, + "title": "Custom Search API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "datacatalog:v1beta1", - "name": "datacatalog", - "version": "v1beta1", - "title": "Google Cloud Data Catalog API", "description": "A fully managed and highly scalable data discovery and metadata management service.", "discoveryRestUrl": "https://datacatalog.googleapis.com/$discovery/rest?version=v1beta1", + "documentationLink": "https://cloud.google.com/data-catalog/docs/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/data-catalog/docs/", - "preferred": false - }, - { + "id": "datacatalog:v1beta1", "kind": "discovery#directoryItem", - "id": "datacatalog:v1", "name": "datacatalog", - "version": "v1", + "preferred": false, "title": "Google Cloud Data Catalog API", + "version": "v1beta1" + }, + { "description": "A fully managed and highly scalable data discovery and metadata management service.", "discoveryRestUrl": "https://datacatalog.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/data-catalog/docs/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/data-catalog/docs/", - "preferred": true + "id": "datacatalog:v1", + "kind": "discovery#directoryItem", + "name": "datacatalog", + "preferred": true, + "title": "Google Cloud Data Catalog API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "dataflow:v1b3", - "name": "dataflow", - "version": "v1b3", - "title": "Dataflow API", "description": "Manages Google Cloud Dataflow projects on Google Cloud Platform.", "discoveryRestUrl": "https://dataflow.googleapis.com/$discovery/rest?version=v1b3", + "documentationLink": "https://cloud.google.com/dataflow", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/dataflow", - "preferred": true + "id": "dataflow:v1b3", + "kind": "discovery#directoryItem", + "name": "dataflow", + "preferred": true, + "title": "Dataflow API", + "version": "v1b3" }, { - "kind": "discovery#directoryItem", - "id": "dataform:v1beta1", - "name": "dataform", - "version": "v1beta1", - "title": "Dataform API", "description": "Service to develop, version control, and operationalize SQL pipelines in BigQuery.", "discoveryRestUrl": "https://dataform.googleapis.com/$discovery/rest?version=v1beta1", + "documentationLink": "https://cloud.google.com/dataform/docs", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/dataform/docs", - "preferred": true + "id": "dataform:v1beta1", + "kind": "discovery#directoryItem", + "name": "dataform", + "preferred": true, + "title": "Dataform API", + "version": "v1beta1" }, { - "kind": "discovery#directoryItem", - "id": "datafusion:v1beta1", - "name": "datafusion", - "version": "v1beta1", - "title": "Cloud Data Fusion API", "description": "Cloud Data Fusion is a fully-managed, cloud native, enterprise data integration service for quickly building and managing data pipelines. It provides a graphical interface to increase time efficiency and reduce complexity, and allows business users, developers, and data scientists to easily and reliably build scalable data integration solutions to cleanse, prepare, blend, transfer and transform data without having to wrestle with infrastructure.", "discoveryRestUrl": "https://datafusion.googleapis.com/$discovery/rest?version=v1beta1", + "documentationLink": "https://cloud.google.com/data-fusion/docs", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/data-fusion/docs", - "preferred": false - }, - { + "id": "datafusion:v1beta1", "kind": "discovery#directoryItem", - "id": "datafusion:v1", "name": "datafusion", - "version": "v1", + "preferred": false, "title": "Cloud Data Fusion API", + "version": "v1beta1" + }, + { "description": "Cloud Data Fusion is a fully-managed, cloud native, enterprise data integration service for quickly building and managing data pipelines. It provides a graphical interface to increase time efficiency and reduce complexity, and allows business users, developers, and data scientists to easily and reliably build scalable data integration solutions to cleanse, prepare, blend, transfer and transform data without having to wrestle with infrastructure.", "discoveryRestUrl": "https://datafusion.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/data-fusion/docs", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/data-fusion/docs", - "preferred": true + "id": "datafusion:v1", + "kind": "discovery#directoryItem", + "name": "datafusion", + "preferred": true, + "title": "Cloud Data Fusion API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "datalabeling:v1beta1", - "name": "datalabeling", - "version": "v1beta1", - "title": "Data Labeling API", "description": "Public API for Google Cloud AI Data Labeling Service.", "discoveryRestUrl": "https://datalabeling.googleapis.com/$discovery/rest?version=v1beta1", + "documentationLink": "https://cloud.google.com/data-labeling/docs/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/data-labeling/docs/", - "preferred": true + "id": "datalabeling:v1beta1", + "kind": "discovery#directoryItem", + "name": "datalabeling", + "preferred": true, + "title": "Data Labeling API", + "version": "v1beta1" }, { - "kind": "discovery#directoryItem", - "id": "datalineage:v1", - "name": "datalineage", - "version": "v1", - "title": "Data Lineage API", "description": "", "discoveryRestUrl": "https://datalineage.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/data-catalog", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/data-catalog", - "preferred": true + "id": "datalineage:v1", + "kind": "discovery#directoryItem", + "name": "datalineage", + "preferred": true, + "title": "Data Lineage API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "datamigration:v1beta1", - "name": "datamigration", - "version": "v1beta1", - "title": "Database Migration API", "description": "Manage Cloud Database Migration Service resources on Google Cloud Platform.", "discoveryRestUrl": "https://datamigration.googleapis.com/$discovery/rest?version=v1beta1", + "documentationLink": "https://cloud.google.com/database-migration/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/database-migration/", - "preferred": false - }, - { + "id": "datamigration:v1beta1", "kind": "discovery#directoryItem", - "id": "datamigration:v1", "name": "datamigration", - "version": "v1", + "preferred": false, "title": "Database Migration API", + "version": "v1beta1" + }, + { "description": "Manage Cloud Database Migration Service resources on Google Cloud Platform.", "discoveryRestUrl": "https://datamigration.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/database-migration/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/database-migration/", - "preferred": true + "id": "datamigration:v1", + "kind": "discovery#directoryItem", + "name": "datamigration", + "preferred": true, + "title": "Database Migration API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "datapipelines:v1", - "name": "datapipelines", - "version": "v1", - "title": "Data pipelines API", "description": "Data Pipelines provides an interface for creating, updating, and managing recurring Data Analytics jobs.", "discoveryRestUrl": "https://datapipelines.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/dataflow/docs/guides/data-pipelines", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/dataflow/docs/guides/data-pipelines", - "preferred": true + "id": "datapipelines:v1", + "kind": "discovery#directoryItem", + "name": "datapipelines", + "preferred": true, + "title": "Data pipelines API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "dataplex:v1", - "name": "dataplex", - "version": "v1", - "title": "Cloud Dataplex API", "description": "Dataplex API is used to manage the lifecycle of data lakes.", "discoveryRestUrl": "https://dataplex.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/dataplex/docs", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/dataplex/docs", - "preferred": true + "id": "dataplex:v1", + "kind": "discovery#directoryItem", + "name": "dataplex", + "preferred": true, + "title": "Cloud Dataplex API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "dataportability:v1beta", - "name": "dataportability", - "version": "v1beta", - "title": "Data Portability API", "description": "The Data Portability API lets you build applications that request authorization from a user to move a copy of data from Google services into your application. This enables data portability and facilitates switching services.", "discoveryRestUrl": "https://dataportability.googleapis.com/$discovery/rest?version=v1beta", + "documentationLink": "https://developers.google.com/data-portability", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://developers.google.com/data-portability", - "preferred": false - }, - { + "id": "dataportability:v1beta", "kind": "discovery#directoryItem", - "id": "dataportability:v1", "name": "dataportability", - "version": "v1", + "preferred": false, "title": "Data Portability API", + "version": "v1beta" + }, + { "description": "The Data Portability API lets you build applications that request authorization from a user to move a copy of data from Google services into your application. This enables data portability and facilitates switching services.", "discoveryRestUrl": "https://dataportability.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://developers.google.com/data-portability", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://developers.google.com/data-portability", - "preferred": true + "id": "dataportability:v1", + "kind": "discovery#directoryItem", + "name": "dataportability", + "preferred": true, + "title": "Data Portability API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "dataproc:v1", - "name": "dataproc", - "version": "v1", - "title": "Cloud Dataproc API", "description": "Manages Hadoop-based clusters and jobs on Google Cloud Platform.", "discoveryRestUrl": "https://dataproc.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/dataproc/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/dataproc/", - "preferred": true + "id": "dataproc:v1", + "kind": "discovery#directoryItem", + "name": "dataproc", + "preferred": true, + "title": "Cloud Dataproc API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "datastore:v1beta1", - "name": "datastore", - "version": "v1beta1", - "title": "Cloud Datastore API", "description": "Accesses the schemaless NoSQL database to provide fully managed, robust, scalable storage for your application.", "discoveryRestUrl": "https://datastore.googleapis.com/$discovery/rest?version=v1beta1", + "documentationLink": "https://cloud.google.com/datastore/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/datastore/", - "preferred": false - }, - { + "id": "datastore:v1beta1", "kind": "discovery#directoryItem", - "id": "datastore:v1beta3", "name": "datastore", - "version": "v1beta3", + "preferred": false, "title": "Cloud Datastore API", + "version": "v1beta1" + }, + { "description": "Accesses the schemaless NoSQL database to provide fully managed, robust, scalable storage for your application.", "discoveryRestUrl": "https://datastore.googleapis.com/$discovery/rest?version=v1beta3", + "documentationLink": "https://cloud.google.com/datastore/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/datastore/", - "preferred": false - }, - { + "id": "datastore:v1beta3", "kind": "discovery#directoryItem", - "id": "datastore:v1", "name": "datastore", - "version": "v1", + "preferred": false, "title": "Cloud Datastore API", + "version": "v1beta3" + }, + { "description": "Accesses the schemaless NoSQL database to provide fully managed, robust, scalable storage for your application.", "discoveryRestUrl": "https://datastore.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/datastore/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/datastore/", - "preferred": true + "id": "datastore:v1", + "kind": "discovery#directoryItem", + "name": "datastore", + "preferred": true, + "title": "Cloud Datastore API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "datastream:v1alpha1", - "name": "datastream", - "version": "v1alpha1", - "title": "Datastream API", "description": "", "discoveryRestUrl": "https://datastream.googleapis.com/$discovery/rest?version=v1alpha1", + "documentationLink": "https://cloud.google.com/datastream/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/datastream/", - "preferred": false - }, - { + "id": "datastream:v1alpha1", "kind": "discovery#directoryItem", - "id": "datastream:v1", "name": "datastream", - "version": "v1", + "preferred": false, "title": "Datastream API", + "version": "v1alpha1" + }, + { "description": "", "discoveryRestUrl": "https://datastream.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/datastream/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/datastream/", - "preferred": true + "id": "datastream:v1", + "kind": "discovery#directoryItem", + "name": "datastream", + "preferred": true, + "title": "Datastream API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "deploymentmanager:alpha", - "name": "deploymentmanager", - "version": "alpha", - "title": "Cloud Deployment Manager V2 API", "description": "The Google Cloud Deployment Manager v2 API provides services for configuring, deploying, and viewing Google Cloud services and APIs via templates which specify deployments of Cloud resources.", "discoveryRestUrl": "https://deploymentmanager.googleapis.com/$discovery/rest?version=alpha", + "documentationLink": "https://cloud.google.com/deployment-manager", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/deployment-manager", - "preferred": false - }, - { + "id": "deploymentmanager:alpha", "kind": "discovery#directoryItem", - "id": "deploymentmanager:v2beta", "name": "deploymentmanager", - "version": "v2beta", + "preferred": false, "title": "Cloud Deployment Manager V2 API", + "version": "alpha" + }, + { "description": "The Google Cloud Deployment Manager v2 API provides services for configuring, deploying, and viewing Google Cloud services and APIs via templates which specify deployments of Cloud resources.", "discoveryRestUrl": "https://deploymentmanager.googleapis.com/$discovery/rest?version=v2beta", + "documentationLink": "https://cloud.google.com/deployment-manager", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/deployment-manager", - "preferred": false - }, - { + "id": "deploymentmanager:v2beta", "kind": "discovery#directoryItem", - "id": "deploymentmanager:v2", "name": "deploymentmanager", - "version": "v2", + "preferred": false, "title": "Cloud Deployment Manager V2 API", + "version": "v2beta" + }, + { "description": "The Google Cloud Deployment Manager v2 API provides services for configuring, deploying, and viewing Google Cloud services and APIs via templates which specify deployments of Cloud resources.", "discoveryRestUrl": "https://deploymentmanager.googleapis.com/$discovery/rest?version=v2", + "documentationLink": "https://cloud.google.com/deployment-manager", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/deployment-manager", - "preferred": true + "id": "deploymentmanager:v2", + "kind": "discovery#directoryItem", + "name": "deploymentmanager", + "preferred": true, + "title": "Cloud Deployment Manager V2 API", + "version": "v2" }, { - "kind": "discovery#directoryItem", - "id": "developerconnect:v1", - "name": "developerconnect", - "version": "v1", - "title": "Developer Connect API", "description": "Connect third-party source code management to Google", "discoveryRestUrl": "https://developerconnect.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "http://cloud.google.com/developer-connect/docs/overview", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "http://cloud.google.com/developer-connect/docs/overview", - "preferred": true + "id": "developerconnect:v1", + "kind": "discovery#directoryItem", + "name": "developerconnect", + "preferred": true, + "title": "Developer Connect API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "dfareporting:v3.5", - "name": "dfareporting", - "version": "v3.5", - "title": "Campaign Manager 360 API", "description": "Build applications to efficiently manage large or complex trafficking, reporting, and attribution workflows for Campaign Manager 360.", "discoveryRestUrl": "https://dfareporting.googleapis.com/$discovery/rest?version=v3.5", + "documentationLink": "https://developers.google.com/doubleclick-advertisers/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://developers.google.com/doubleclick-advertisers/", - "preferred": false - }, - { + "id": "dfareporting:v3.5", "kind": "discovery#directoryItem", - "id": "dfareporting:v4", "name": "dfareporting", - "version": "v4", + "preferred": false, "title": "Campaign Manager 360 API", + "version": "v3.5" + }, + { "description": "Build applications to efficiently manage large or complex trafficking, reporting, and attribution workflows for Campaign Manager 360.", "discoveryRestUrl": "https://dfareporting.googleapis.com/$discovery/rest?version=v4", + "documentationLink": "https://developers.google.com/doubleclick-advertisers/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://developers.google.com/doubleclick-advertisers/", - "preferred": true + "id": "dfareporting:v4", + "kind": "discovery#directoryItem", + "name": "dfareporting", + "preferred": true, + "title": "Campaign Manager 360 API", + "version": "v4" }, { - "kind": "discovery#directoryItem", - "id": "dialogflow:v2beta1", - "name": "dialogflow", - "version": "v2beta1", - "title": "Dialogflow API", "description": "Builds conversational interfaces (for example, chatbots, and voice-powered apps and devices).", "discoveryRestUrl": "https://dialogflow.googleapis.com/$discovery/rest?version=v2beta1", + "documentationLink": "https://cloud.google.com/dialogflow/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/dialogflow/", - "preferred": false - }, - { + "id": "dialogflow:v2beta1", "kind": "discovery#directoryItem", - "id": "dialogflow:v3beta1", "name": "dialogflow", - "version": "v3beta1", + "preferred": false, "title": "Dialogflow API", + "version": "v2beta1" + }, + { "description": "Builds conversational interfaces (for example, chatbots, and voice-powered apps and devices).", "discoveryRestUrl": "https://dialogflow.googleapis.com/$discovery/rest?version=v3beta1", + "documentationLink": "https://cloud.google.com/dialogflow/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/dialogflow/", - "preferred": false - }, - { + "id": "dialogflow:v3beta1", "kind": "discovery#directoryItem", - "id": "dialogflow:v2", "name": "dialogflow", - "version": "v2", + "preferred": false, "title": "Dialogflow API", + "version": "v3beta1" + }, + { "description": "Builds conversational interfaces (for example, chatbots, and voice-powered apps and devices).", "discoveryRestUrl": "https://dialogflow.googleapis.com/$discovery/rest?version=v2", + "documentationLink": "https://cloud.google.com/dialogflow/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/dialogflow/", - "preferred": false - }, - { + "id": "dialogflow:v2", "kind": "discovery#directoryItem", - "id": "dialogflow:v3", "name": "dialogflow", - "version": "v3", + "preferred": false, "title": "Dialogflow API", + "version": "v2" + }, + { "description": "Builds conversational interfaces (for example, chatbots, and voice-powered apps and devices).", "discoveryRestUrl": "https://dialogflow.googleapis.com/$discovery/rest?version=v3", + "documentationLink": "https://cloud.google.com/dialogflow/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/dialogflow/", - "preferred": true + "id": "dialogflow:v3", + "kind": "discovery#directoryItem", + "name": "dialogflow", + "preferred": true, + "title": "Dialogflow API", + "version": "v3" }, { - "kind": "discovery#directoryItem", - "id": "digitalassetlinks:v1", - "name": "digitalassetlinks", - "version": "v1", - "title": "Digital Asset Links API", "description": "Discovers relationships between online assets such as websites or mobile apps.", "discoveryRestUrl": "https://digitalassetlinks.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://developers.google.com/digital-asset-links/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://developers.google.com/digital-asset-links/", - "preferred": true + "id": "digitalassetlinks:v1", + "kind": "discovery#directoryItem", + "name": "digitalassetlinks", + "preferred": true, + "title": "Digital Asset Links API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "discovery:v1", - "name": "discovery", - "version": "v1", - "title": "API Discovery Service", "description": "Google API Discovery Service allows service consumers to list the discovery metadata of all public APIs managed by the API Platform.", "discoveryRestUrl": "https://discovery.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://developers.google.com/discovery", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://developers.google.com/discovery", - "preferred": true + "id": "discovery:v1", + "kind": "discovery#directoryItem", + "name": "discovery", + "preferred": true, + "title": "API Discovery Service", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "discoveryengine:v1alpha", - "name": "discoveryengine", - "version": "v1alpha", - "title": "Discovery Engine API", "description": "Discovery Engine API.", "discoveryRestUrl": "https://discoveryengine.googleapis.com/$discovery/rest?version=v1alpha", + "documentationLink": "https://cloud.google.com/discovery-engine/docs", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/discovery-engine/docs", - "preferred": false - }, - { + "id": "discoveryengine:v1alpha", "kind": "discovery#directoryItem", - "id": "discoveryengine:v1beta", "name": "discoveryengine", - "version": "v1beta", + "preferred": false, "title": "Discovery Engine API", + "version": "v1alpha" + }, + { "description": "Discovery Engine API.", "discoveryRestUrl": "https://discoveryengine.googleapis.com/$discovery/rest?version=v1beta", + "documentationLink": "https://cloud.google.com/discovery-engine/docs", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/discovery-engine/docs", - "preferred": false - }, - { + "id": "discoveryengine:v1beta", "kind": "discovery#directoryItem", - "id": "discoveryengine:v1", "name": "discoveryengine", - "version": "v1", + "preferred": false, "title": "Discovery Engine API", + "version": "v1beta" + }, + { "description": "Discovery Engine API.", "discoveryRestUrl": "https://discoveryengine.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/discovery-engine/docs", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/discovery-engine/docs", - "preferred": true + "id": "discoveryengine:v1", + "kind": "discovery#directoryItem", + "name": "discoveryengine", + "preferred": true, + "title": "Discovery Engine API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "displayvideo:v2", - "name": "displayvideo", - "version": "v2", - "title": "Display & Video 360 API", "description": "Display & Video 360 API allows users to automate complex Display & Video 360 workflows, such as creating insertion orders and setting targeting options for individual line items.", "discoveryRestUrl": "https://displayvideo.googleapis.com/$discovery/rest?version=v2", + "documentationLink": "https://developers.google.com/display-video/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://developers.google.com/display-video/", - "preferred": false - }, - { + "id": "displayvideo:v2", "kind": "discovery#directoryItem", - "id": "displayvideo:v3", "name": "displayvideo", - "version": "v3", + "preferred": false, "title": "Display & Video 360 API", + "version": "v2" + }, + { "description": "Display & Video 360 API allows users to automate complex Display & Video 360 workflows, such as creating insertion orders and setting targeting options for individual line items.", "discoveryRestUrl": "https://displayvideo.googleapis.com/$discovery/rest?version=v3", + "documentationLink": "https://developers.google.com/display-video/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://developers.google.com/display-video/", - "preferred": true + "id": "displayvideo:v3", + "kind": "discovery#directoryItem", + "name": "displayvideo", + "preferred": true, + "title": "Display & Video 360 API", + "version": "v3" }, { - "kind": "discovery#directoryItem", - "id": "dlp:v2", - "name": "dlp", - "version": "v2", - "title": "Sensitive Data Protection (DLP)", "description": "Discover and protect your sensitive data. A fully managed service designed to help you discover, classify, and protect your valuable data assets with ease.", "discoveryRestUrl": "https://dlp.googleapis.com/$discovery/rest?version=v2", + "documentationLink": "https://cloud.google.com/sensitive-data-protection/docs/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/sensitive-data-protection/docs/", - "preferred": true + "id": "dlp:v2", + "kind": "discovery#directoryItem", + "name": "dlp", + "preferred": true, + "title": "Sensitive Data Protection (DLP)", + "version": "v2" }, { - "kind": "discovery#directoryItem", - "id": "dns:v1beta2", - "name": "dns", - "version": "v1beta2", - "title": "Cloud DNS API", "description": "", "discoveryRestUrl": "https://dns.googleapis.com/$discovery/rest?version=v1beta2", + "documentationLink": "https://cloud.google.com/dns/docs", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/dns/docs", - "preferred": false - }, - { + "id": "dns:v1beta2", "kind": "discovery#directoryItem", - "id": "dns:v1", "name": "dns", - "version": "v1", + "preferred": false, "title": "Cloud DNS API", + "version": "v1beta2" + }, + { "description": "", "discoveryRestUrl": "https://dns.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/dns/docs", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/dns/docs", - "preferred": true + "id": "dns:v1", + "kind": "discovery#directoryItem", + "name": "dns", + "preferred": true, + "title": "Cloud DNS API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "docs:v1", - "name": "docs", - "version": "v1", - "title": "Google Docs API", "description": "Reads and writes Google Docs documents.", "discoveryRestUrl": "https://docs.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://developers.google.com/docs/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://developers.google.com/docs/", - "preferred": true + "id": "docs:v1", + "kind": "discovery#directoryItem", + "name": "docs", + "preferred": true, + "title": "Google Docs API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "documentai:v1beta2", - "name": "documentai", - "version": "v1beta2", - "title": "Cloud Document AI API", "description": "Service to parse structured information from unstructured or semi-structured documents using state-of-the-art Google AI such as natural language, computer vision, translation, and AutoML.", "discoveryRestUrl": "https://documentai.googleapis.com/$discovery/rest?version=v1beta2", + "documentationLink": "https://cloud.google.com/document-ai/docs/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/document-ai/docs/", - "preferred": false - }, - { + "id": "documentai:v1beta2", "kind": "discovery#directoryItem", - "id": "documentai:v1beta3", "name": "documentai", - "version": "v1beta3", + "preferred": false, "title": "Cloud Document AI API", + "version": "v1beta2" + }, + { "description": "Service to parse structured information from unstructured or semi-structured documents using state-of-the-art Google AI such as natural language, computer vision, translation, and AutoML.", "discoveryRestUrl": "https://documentai.googleapis.com/$discovery/rest?version=v1beta3", + "documentationLink": "https://cloud.google.com/document-ai/docs/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/document-ai/docs/", - "preferred": false - }, - { + "id": "documentai:v1beta3", "kind": "discovery#directoryItem", - "id": "documentai:v1", "name": "documentai", - "version": "v1", + "preferred": false, "title": "Cloud Document AI API", + "version": "v1beta3" + }, + { "description": "Service to parse structured information from unstructured or semi-structured documents using state-of-the-art Google AI such as natural language, computer vision, translation, and AutoML.", "discoveryRestUrl": "https://documentai.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/document-ai/docs/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/document-ai/docs/", - "preferred": true + "id": "documentai:v1", + "kind": "discovery#directoryItem", + "name": "documentai", + "preferred": true, + "title": "Cloud Document AI API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "domains:v1alpha2", - "name": "domains", - "version": "v1alpha2", - "title": "Cloud Domains API", "description": "Enables management and configuration of domain names.", "discoveryRestUrl": "https://domains.googleapis.com/$discovery/rest?version=v1alpha2", + "documentationLink": "https://cloud.google.com/domains/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/domains/", - "preferred": false - }, - { + "id": "domains:v1alpha2", "kind": "discovery#directoryItem", - "id": "domains:v1beta1", "name": "domains", - "version": "v1beta1", + "preferred": false, "title": "Cloud Domains API", + "version": "v1alpha2" + }, + { "description": "Enables management and configuration of domain names.", "discoveryRestUrl": "https://domains.googleapis.com/$discovery/rest?version=v1beta1", + "documentationLink": "https://cloud.google.com/domains/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/domains/", - "preferred": false - }, - { + "id": "domains:v1beta1", "kind": "discovery#directoryItem", - "id": "domains:v1", "name": "domains", - "version": "v1", + "preferred": false, "title": "Cloud Domains API", + "version": "v1beta1" + }, + { "description": "Enables management and configuration of domain names.", "discoveryRestUrl": "https://domains.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/domains/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/domains/", - "preferred": true + "id": "domains:v1", + "kind": "discovery#directoryItem", + "name": "domains", + "preferred": true, + "title": "Cloud Domains API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "domainsrdap:v1", - "name": "domainsrdap", - "version": "v1", - "title": "Domains RDAP API", "description": "Read-only public API that lets users search for information about domain names.", "discoveryRestUrl": "https://domainsrdap.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://developers.google.com/domains/rdap/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://developers.google.com/domains/rdap/", - "preferred": true + "id": "domainsrdap:v1", + "kind": "discovery#directoryItem", + "name": "domainsrdap", + "preferred": true, + "title": "Domains RDAP API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "doubleclickbidmanager:v2", - "name": "doubleclickbidmanager", - "version": "v2", - "title": "DoubleClick Bid Manager API", "description": "DoubleClick Bid Manager API allows users to manage and create campaigns and reports.", "discoveryRestUrl": "https://doubleclickbidmanager.googleapis.com/$discovery/rest?version=v2", + "documentationLink": "https://developers.google.com/bid-manager/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://developers.google.com/bid-manager/", - "preferred": true + "id": "doubleclickbidmanager:v2", + "kind": "discovery#directoryItem", + "name": "doubleclickbidmanager", + "preferred": true, + "title": "DoubleClick Bid Manager API", + "version": "v2" }, { - "kind": "discovery#directoryItem", - "id": "doubleclicksearch:v2", - "name": "doubleclicksearch", - "version": "v2", - "title": "Search Ads 360 API", "description": "The Search Ads 360 API allows developers to automate uploading conversions and downloading reports from Search Ads 360.", "discoveryRestUrl": "https://doubleclicksearch.googleapis.com/$discovery/rest?version=v2", + "documentationLink": "https://developers.google.com/search-ads", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://developers.google.com/search-ads", - "preferred": true + "id": "doubleclicksearch:v2", + "kind": "discovery#directoryItem", + "name": "doubleclicksearch", + "preferred": true, + "title": "Search Ads 360 API", + "version": "v2" }, { - "kind": "discovery#directoryItem", - "id": "drive:v2", - "name": "drive", - "version": "v2", - "title": "Drive API", "description": "Manages files in Drive including uploading, downloading, searching, detecting changes, and updating sharing permissions.", - "discoveryRestUrl": "https://www.googleapis.com/discovery/v1/apis/drive/v2/rest", "discoveryLink": "./apis/drive/v2/rest", + "discoveryRestUrl": "https://www.googleapis.com/discovery/v1/apis/drive/v2/rest", + "documentationLink": "https://developers.google.com/drive/", "icons": { "x16": "https://ssl.gstatic.com/docs/doclist/images/drive_icon_16.png", "x32": "https://ssl.gstatic.com/docs/doclist/images/drive_icon_32.png" }, - "documentationLink": "https://developers.google.com/drive/", - "preferred": false - }, - { + "id": "drive:v2", "kind": "discovery#directoryItem", - "id": "drive:v3", "name": "drive", - "version": "v3", + "preferred": false, "title": "Drive API", + "version": "v2" + }, + { "description": "Manages files in Drive including uploading, downloading, searching, detecting changes, and updating sharing permissions.", - "discoveryRestUrl": "https://www.googleapis.com/discovery/v1/apis/drive/v3/rest", "discoveryLink": "./apis/drive/v3/rest", + "discoveryRestUrl": "https://www.googleapis.com/discovery/v1/apis/drive/v3/rest", + "documentationLink": "https://developers.google.com/drive/", "icons": { "x16": "https://ssl.gstatic.com/docs/doclist/images/drive_icon_16.png", "x32": "https://ssl.gstatic.com/docs/doclist/images/drive_icon_32.png" }, - "documentationLink": "https://developers.google.com/drive/", - "preferred": true + "id": "drive:v3", + "kind": "discovery#directoryItem", + "name": "drive", + "preferred": true, + "title": "Drive API", + "version": "v3" }, { - "kind": "discovery#directoryItem", - "id": "driveactivity:v2", - "name": "driveactivity", - "version": "v2", - "title": "Drive Activity API", "description": "Provides a historical view of activity in Google Drive.", "discoveryRestUrl": "https://driveactivity.googleapis.com/$discovery/rest?version=v2", + "documentationLink": "https://developers.google.com/drive/activity/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://developers.google.com/drive/activity/", - "preferred": true + "id": "driveactivity:v2", + "kind": "discovery#directoryItem", + "name": "driveactivity", + "preferred": true, + "title": "Drive Activity API", + "version": "v2" }, { - "kind": "discovery#directoryItem", - "id": "drivelabels:v2beta", - "name": "drivelabels", - "version": "v2beta", - "title": "Drive Labels API", "description": "An API for managing Drive Labels", "discoveryRestUrl": "https://drivelabels.googleapis.com/$discovery/rest?version=v2beta", + "documentationLink": "https://developers.google.com/drive/labels", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://developers.google.com/drive/labels", - "preferred": false - }, - { + "id": "drivelabels:v2beta", "kind": "discovery#directoryItem", - "id": "drivelabels:v2", "name": "drivelabels", - "version": "v2", + "preferred": false, "title": "Drive Labels API", + "version": "v2beta" + }, + { "description": "An API for managing Drive Labels", "discoveryRestUrl": "https://drivelabels.googleapis.com/$discovery/rest?version=v2", + "documentationLink": "https://developers.google.com/drive/labels", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://developers.google.com/drive/labels", - "preferred": true + "id": "drivelabels:v2", + "kind": "discovery#directoryItem", + "name": "drivelabels", + "preferred": true, + "title": "Drive Labels API", + "version": "v2" }, { - "kind": "discovery#directoryItem", - "id": "essentialcontacts:v1", - "name": "essentialcontacts", - "version": "v1", - "title": "Essential Contacts API", "description": "", "discoveryRestUrl": "https://essentialcontacts.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/essentialcontacts/docs/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/essentialcontacts/docs/", - "preferred": true + "id": "essentialcontacts:v1", + "kind": "discovery#directoryItem", + "name": "essentialcontacts", + "preferred": true, + "title": "Essential Contacts API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "eventarc:v1", - "name": "eventarc", - "version": "v1", - "title": "Eventarc API", "description": "Build event-driven applications on Google Cloud Platform.", "discoveryRestUrl": "https://eventarc.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/eventarc", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/eventarc", - "preferred": true + "id": "eventarc:v1", + "kind": "discovery#directoryItem", + "name": "eventarc", + "preferred": true, + "title": "Eventarc API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "factchecktools:v1alpha1", - "name": "factchecktools", - "version": "v1alpha1", - "title": "Fact Check Tools API", "description": "", "discoveryRestUrl": "https://factchecktools.googleapis.com/$discovery/rest?version=v1alpha1", + "documentationLink": "https://developers.google.com/fact-check/tools/api/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://developers.google.com/fact-check/tools/api/", - "preferred": true + "id": "factchecktools:v1alpha1", + "kind": "discovery#directoryItem", + "name": "factchecktools", + "preferred": true, + "title": "Fact Check Tools API", + "version": "v1alpha1" }, { - "kind": "discovery#directoryItem", - "id": "fcm:v1", - "name": "fcm", - "version": "v1", - "title": "Firebase Cloud Messaging API", "description": "FCM send API that provides a cross-platform messaging solution to reliably deliver messages at no cost.", "discoveryRestUrl": "https://fcm.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://firebase.google.com/docs/cloud-messaging", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://firebase.google.com/docs/cloud-messaging", - "preferred": true + "id": "fcm:v1", + "kind": "discovery#directoryItem", + "name": "fcm", + "preferred": true, + "title": "Firebase Cloud Messaging API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "fcmdata:v1beta1", - "name": "fcmdata", - "version": "v1beta1", - "title": "Firebase Cloud Messaging Data API", "description": "Provides additional information about Firebase Cloud Messaging (FCM) message sends and deliveries.", "discoveryRestUrl": "https://fcmdata.googleapis.com/$discovery/rest?version=v1beta1", + "documentationLink": "https://firebase.google.com/docs/cloud-messaging", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://firebase.google.com/docs/cloud-messaging", - "preferred": true + "id": "fcmdata:v1beta1", + "kind": "discovery#directoryItem", + "name": "fcmdata", + "preferred": true, + "title": "Firebase Cloud Messaging Data API", + "version": "v1beta1" }, { - "kind": "discovery#directoryItem", - "id": "file:v1beta1", - "name": "file", - "version": "v1beta1", - "title": "Cloud Filestore API", "description": "The Cloud Filestore API is used for creating and managing cloud file servers.", "discoveryRestUrl": "https://file.googleapis.com/$discovery/rest?version=v1beta1", + "documentationLink": "https://cloud.google.com/filestore/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/filestore/", - "preferred": false - }, - { + "id": "file:v1beta1", "kind": "discovery#directoryItem", - "id": "file:v1", "name": "file", - "version": "v1", + "preferred": false, "title": "Cloud Filestore API", + "version": "v1beta1" + }, + { "description": "The Cloud Filestore API is used for creating and managing cloud file servers.", "discoveryRestUrl": "https://file.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/filestore/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/filestore/", - "preferred": true + "id": "file:v1", + "kind": "discovery#directoryItem", + "name": "file", + "preferred": true, + "title": "Cloud Filestore API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "firebase:v1beta1", - "name": "firebase", - "version": "v1beta1", - "title": "Firebase Management API", "description": "The Firebase Management API enables programmatic setup and management of Firebase projects, including a project's Firebase resources and Firebase apps.", "discoveryRestUrl": "https://firebase.googleapis.com/$discovery/rest?version=v1beta1", + "documentationLink": "https://firebase.google.com", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://firebase.google.com", - "preferred": true + "id": "firebase:v1beta1", + "kind": "discovery#directoryItem", + "name": "firebase", + "preferred": true, + "title": "Firebase Management API", + "version": "v1beta1" }, { - "kind": "discovery#directoryItem", - "id": "firebaseappcheck:v1beta", - "name": "firebaseappcheck", - "version": "v1beta", - "title": "Firebase App Check API", "description": "Firebase App Check works alongside other Firebase services to help protect your backend resources from abuse, such as billing fraud or phishing.", "discoveryRestUrl": "https://firebaseappcheck.googleapis.com/$discovery/rest?version=v1beta", + "documentationLink": "https://firebase.google.com/docs/app-check", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://firebase.google.com/docs/app-check", - "preferred": false - }, - { + "id": "firebaseappcheck:v1beta", "kind": "discovery#directoryItem", - "id": "firebaseappcheck:v1", "name": "firebaseappcheck", - "version": "v1", + "preferred": false, "title": "Firebase App Check API", + "version": "v1beta" + }, + { "description": "Firebase App Check works alongside other Firebase services to help protect your backend resources from abuse, such as billing fraud or phishing.", "discoveryRestUrl": "https://firebaseappcheck.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://firebase.google.com/docs/app-check", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://firebase.google.com/docs/app-check", - "preferred": true + "id": "firebaseappcheck:v1", + "kind": "discovery#directoryItem", + "name": "firebaseappcheck", + "preferred": true, + "title": "Firebase App Check API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "firebaseappdistribution:v1alpha", - "name": "firebaseappdistribution", - "version": "v1alpha", - "title": "Firebase App Distribution API", "description": "", "discoveryRestUrl": "https://firebaseappdistribution.googleapis.com/$discovery/rest?version=v1alpha", + "documentationLink": "https://firebase.google.com/products/app-distribution", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://firebase.google.com/products/app-distribution", - "preferred": false - }, - { + "id": "firebaseappdistribution:v1alpha", "kind": "discovery#directoryItem", - "id": "firebaseappdistribution:v1", "name": "firebaseappdistribution", - "version": "v1", + "preferred": false, "title": "Firebase App Distribution API", + "version": "v1alpha" + }, + { "description": "", "discoveryRestUrl": "https://firebaseappdistribution.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://firebase.google.com/products/app-distribution", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://firebase.google.com/products/app-distribution", - "preferred": true + "id": "firebaseappdistribution:v1", + "kind": "discovery#directoryItem", + "name": "firebaseappdistribution", + "preferred": true, + "title": "Firebase App Distribution API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "firebasedatabase:v1beta", - "name": "firebasedatabase", - "version": "v1beta", - "title": "Firebase Realtime Database API", "description": "The Firebase Realtime Database API enables programmatic provisioning and management of Realtime Database instances.", "discoveryRestUrl": "https://firebasedatabase.googleapis.com/$discovery/rest?version=v1beta", + "documentationLink": "https://firebase.google.com/docs/reference/rest/database/database-management/rest/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://firebase.google.com/docs/reference/rest/database/database-management/rest/", - "preferred": true + "id": "firebasedatabase:v1beta", + "kind": "discovery#directoryItem", + "name": "firebasedatabase", + "preferred": true, + "title": "Firebase Realtime Database API", + "version": "v1beta" }, { - "kind": "discovery#directoryItem", - "id": "firebasedynamiclinks:v1", - "name": "firebasedynamiclinks", - "version": "v1", - "title": "Firebase Dynamic Links API", "description": "Programmatically creates and manages Firebase Dynamic Links.", "discoveryRestUrl": "https://firebasedynamiclinks.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://firebase.google.com/docs/dynamic-links/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://firebase.google.com/docs/dynamic-links/", - "preferred": true + "id": "firebasedynamiclinks:v1", + "kind": "discovery#directoryItem", + "name": "firebasedynamiclinks", + "preferred": true, + "title": "Firebase Dynamic Links API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "firebasehosting:v1beta1", - "name": "firebasehosting", - "version": "v1beta1", - "title": "Firebase Hosting API", "description": "The Firebase Hosting REST API enables programmatic and customizable management and deployments to your Firebase-hosted sites. Use this REST API to create and manage channels and sites as well as to deploy new or updated hosting configurations and content files.", "discoveryRestUrl": "https://firebasehosting.googleapis.com/$discovery/rest?version=v1beta1", + "documentationLink": "https://firebase.google.com/docs/hosting/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://firebase.google.com/docs/hosting/", - "preferred": false - }, - { + "id": "firebasehosting:v1beta1", "kind": "discovery#directoryItem", - "id": "firebasehosting:v1", "name": "firebasehosting", - "version": "v1", + "preferred": false, "title": "Firebase Hosting API", + "version": "v1beta1" + }, + { "description": "The Firebase Hosting REST API enables programmatic and customizable management and deployments to your Firebase-hosted sites. Use this REST API to create and manage channels and sites as well as to deploy new or updated hosting configurations and content files.", "discoveryRestUrl": "https://firebasehosting.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://firebase.google.com/docs/hosting/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://firebase.google.com/docs/hosting/", - "preferred": true + "id": "firebasehosting:v1", + "kind": "discovery#directoryItem", + "name": "firebasehosting", + "preferred": true, + "title": "Firebase Hosting API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "firebaseml:v1beta2", - "name": "firebaseml", - "version": "v1beta2", - "title": "Firebase ML API", "description": "Access custom machine learning models hosted via Firebase ML.", "discoveryRestUrl": "https://firebaseml.googleapis.com/$discovery/rest?version=v1beta2", + "documentationLink": "https://firebase.google.com", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://firebase.google.com", - "preferred": false - }, - { + "id": "firebaseml:v1beta2", "kind": "discovery#directoryItem", - "id": "firebaseml:v2beta", "name": "firebaseml", - "version": "v2beta", + "preferred": false, "title": "Firebase ML API", + "version": "v1beta2" + }, + { "description": "Access custom machine learning models hosted via Firebase ML.", "discoveryRestUrl": "https://firebaseml.googleapis.com/$discovery/rest?version=v2beta", + "documentationLink": "https://firebase.google.com", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://firebase.google.com", - "preferred": false - }, - { + "id": "firebaseml:v2beta", "kind": "discovery#directoryItem", - "id": "firebaseml:v1", "name": "firebaseml", - "version": "v1", + "preferred": false, "title": "Firebase ML API", + "version": "v2beta" + }, + { "description": "Access custom machine learning models hosted via Firebase ML.", "discoveryRestUrl": "https://firebaseml.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://firebase.google.com", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://firebase.google.com", - "preferred": true + "id": "firebaseml:v1", + "kind": "discovery#directoryItem", + "name": "firebaseml", + "preferred": true, + "title": "Firebase ML API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "firebaserules:v1", - "name": "firebaserules", - "version": "v1", - "title": "Firebase Rules API", "description": "Creates and manages rules that determine when a Firebase Rules-enabled service should permit a request.", "discoveryRestUrl": "https://firebaserules.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://firebase.google.com/docs/storage/security", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://firebase.google.com/docs/storage/security", - "preferred": true + "id": "firebaserules:v1", + "kind": "discovery#directoryItem", + "name": "firebaserules", + "preferred": true, + "title": "Firebase Rules API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "firebasestorage:v1beta", - "name": "firebasestorage", - "version": "v1beta", - "title": "Cloud Storage for Firebase API", "description": "The Cloud Storage for Firebase API enables programmatic management of Cloud Storage buckets for use in Firebase projects", "discoveryRestUrl": "https://firebasestorage.googleapis.com/$discovery/rest?version=v1beta", + "documentationLink": "https://firebase.google.com/docs/storage", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://firebase.google.com/docs/storage", - "preferred": true + "id": "firebasestorage:v1beta", + "kind": "discovery#directoryItem", + "name": "firebasestorage", + "preferred": true, + "title": "Cloud Storage for Firebase API", + "version": "v1beta" }, { - "kind": "discovery#directoryItem", - "id": "firestore:v1beta1", - "name": "firestore", - "version": "v1beta1", - "title": "Cloud Firestore API", "description": "Accesses the NoSQL document database built for automatic scaling, high performance, and ease of application development.", "discoveryRestUrl": "https://firestore.googleapis.com/$discovery/rest?version=v1beta1", + "documentationLink": "https://cloud.google.com/firestore", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/firestore", - "preferred": false - }, - { + "id": "firestore:v1beta1", "kind": "discovery#directoryItem", - "id": "firestore:v1beta2", "name": "firestore", - "version": "v1beta2", + "preferred": false, "title": "Cloud Firestore API", + "version": "v1beta1" + }, + { "description": "Accesses the NoSQL document database built for automatic scaling, high performance, and ease of application development.", "discoveryRestUrl": "https://firestore.googleapis.com/$discovery/rest?version=v1beta2", + "documentationLink": "https://cloud.google.com/firestore", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/firestore", - "preferred": false - }, - { + "id": "firestore:v1beta2", "kind": "discovery#directoryItem", - "id": "firestore:v1", "name": "firestore", - "version": "v1", + "preferred": false, "title": "Cloud Firestore API", + "version": "v1beta2" + }, + { "description": "Accesses the NoSQL document database built for automatic scaling, high performance, and ease of application development.", "discoveryRestUrl": "https://firestore.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/firestore", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/firestore", - "preferred": true + "id": "firestore:v1", + "kind": "discovery#directoryItem", + "name": "firestore", + "preferred": true, + "title": "Cloud Firestore API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "fitness:v1", - "name": "fitness", - "version": "v1", - "title": "Fitness API", "description": "The Fitness API for managing users' fitness tracking data.", "discoveryRestUrl": "https://fitness.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://developers.google.com/fit/rest/v1/get-started", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://developers.google.com/fit/rest/v1/get-started", - "preferred": true + "id": "fitness:v1", + "kind": "discovery#directoryItem", + "name": "fitness", + "preferred": true, + "title": "Fitness API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "forms:v1", - "name": "forms", - "version": "v1", - "title": "Google Forms API", "description": "Reads and writes Google Forms and responses.", "discoveryRestUrl": "https://forms.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://developers.google.com/forms/api", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://developers.google.com/forms/api", - "preferred": true + "id": "forms:v1", + "kind": "discovery#directoryItem", + "name": "forms", + "preferred": true, + "title": "Google Forms API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "games:v1", - "name": "games", - "version": "v1", - "title": "Google Play Game Services", "description": "The Google Play games service allows developers to enhance games with social leaderboards, achievements, game state, sign-in with Google, and more.", "discoveryRestUrl": "https://games.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://developers.google.com/games/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://developers.google.com/games/", - "preferred": true + "id": "games:v1", + "kind": "discovery#directoryItem", + "name": "games", + "preferred": true, + "title": "Google Play Game Services", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "gamesConfiguration:v1configuration", - "name": "gamesConfiguration", - "version": "v1configuration", - "title": "Google Play Game Services Publishing API", "description": "The Google Play Game Services Publishing API allows developers to configure their games in Game Services.", "discoveryRestUrl": "https://gamesconfiguration.googleapis.com/$discovery/rest?version=v1configuration", + "documentationLink": "https://developers.google.com/games/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://developers.google.com/games/", - "preferred": true + "id": "gamesConfiguration:v1configuration", + "kind": "discovery#directoryItem", + "name": "gamesConfiguration", + "preferred": true, + "title": "Google Play Game Services Publishing API", + "version": "v1configuration" }, { - "kind": "discovery#directoryItem", - "id": "gamesManagement:v1management", - "name": "gamesManagement", - "version": "v1management", - "title": "Google Play Game Management", "description": "The Google Play Game Management API allows developers to manage resources from the Google Play Game service.", "discoveryRestUrl": "https://gamesmanagement.googleapis.com/$discovery/rest?version=v1management", + "documentationLink": "https://developers.google.com/games/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://developers.google.com/games/", - "preferred": true + "id": "gamesManagement:v1management", + "kind": "discovery#directoryItem", + "name": "gamesManagement", + "preferred": true, + "title": "Google Play Game Management", + "version": "v1management" }, { - "kind": "discovery#directoryItem", - "id": "gkebackup:v1", - "name": "gkebackup", - "version": "v1", - "title": "Backup for GKE API", "description": "Backup for GKE is a managed Kubernetes workload backup and restore service for GKE clusters.", "discoveryRestUrl": "https://gkebackup.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/kubernetes-engine/docs/add-on/backup-for-gke", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/kubernetes-engine/docs/add-on/backup-for-gke", - "preferred": true + "id": "gkebackup:v1", + "kind": "discovery#directoryItem", + "name": "gkebackup", + "preferred": true, + "title": "Backup for GKE API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "gkehub:v1alpha", - "name": "gkehub", - "version": "v1alpha", - "title": "GKE Hub API", "description": "", "discoveryRestUrl": "https://gkehub.googleapis.com/$discovery/rest?version=v1alpha", + "documentationLink": "https://cloud.google.com/anthos/multicluster-management/connect/registering-a-cluster", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/anthos/multicluster-management/connect/registering-a-cluster", - "preferred": false - }, - { + "id": "gkehub:v1alpha", "kind": "discovery#directoryItem", - "id": "gkehub:v2alpha", "name": "gkehub", - "version": "v2alpha", + "preferred": false, "title": "GKE Hub API", + "version": "v1alpha" + }, + { "description": "", "discoveryRestUrl": "https://gkehub.googleapis.com/$discovery/rest?version=v2alpha", + "documentationLink": "https://cloud.google.com/anthos/multicluster-management/connect/registering-a-cluster", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/anthos/multicluster-management/connect/registering-a-cluster", - "preferred": false - }, - { + "id": "gkehub:v2alpha", "kind": "discovery#directoryItem", - "id": "gkehub:v1beta", "name": "gkehub", - "version": "v1beta", + "preferred": false, "title": "GKE Hub API", + "version": "v2alpha" + }, + { "description": "", "discoveryRestUrl": "https://gkehub.googleapis.com/$discovery/rest?version=v1beta", + "documentationLink": "https://cloud.google.com/anthos/multicluster-management/connect/registering-a-cluster", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/anthos/multicluster-management/connect/registering-a-cluster", - "preferred": false - }, - { + "id": "gkehub:v1beta", "kind": "discovery#directoryItem", - "id": "gkehub:v1beta1", "name": "gkehub", - "version": "v1beta1", + "preferred": false, "title": "GKE Hub API", + "version": "v1beta" + }, + { "description": "", "discoveryRestUrl": "https://gkehub.googleapis.com/$discovery/rest?version=v1beta1", + "documentationLink": "https://cloud.google.com/anthos/multicluster-management/connect/registering-a-cluster", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/anthos/multicluster-management/connect/registering-a-cluster", - "preferred": false - }, - { + "id": "gkehub:v1beta1", "kind": "discovery#directoryItem", - "id": "gkehub:v1", "name": "gkehub", - "version": "v1", + "preferred": false, "title": "GKE Hub API", + "version": "v1beta1" + }, + { "description": "", "discoveryRestUrl": "https://gkehub.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/anthos/multicluster-management/connect/registering-a-cluster", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/anthos/multicluster-management/connect/registering-a-cluster", - "preferred": true + "id": "gkehub:v1", + "kind": "discovery#directoryItem", + "name": "gkehub", + "preferred": true, + "title": "GKE Hub API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "gkeonprem:v1", - "name": "gkeonprem", - "version": "v1", - "title": "GDC Virtual API", "description": "", "discoveryRestUrl": "https://gkeonprem.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/anthos/clusters/docs/on-prem/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/anthos/clusters/docs/on-prem/", - "preferred": true + "id": "gkeonprem:v1", + "kind": "discovery#directoryItem", + "name": "gkeonprem", + "preferred": true, + "title": "GDC Virtual API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "gmail:v1", - "name": "gmail", - "version": "v1", - "title": "Gmail API", "description": "The Gmail API lets you view and manage Gmail mailbox data like threads, messages, and labels.", "discoveryRestUrl": "https://gmail.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://developers.google.com/gmail/api/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://developers.google.com/gmail/api/", - "preferred": true + "id": "gmail:v1", + "kind": "discovery#directoryItem", + "name": "gmail", + "preferred": true, + "title": "Gmail API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "gmailpostmastertools:v1beta1", - "name": "gmailpostmastertools", - "version": "v1beta1", - "title": "Gmail Postmaster Tools API", "description": "The Postmaster Tools API is a RESTful API that provides programmatic access to email traffic metrics (like spam reports, delivery errors etc) otherwise available through the Gmail Postmaster Tools UI currently.", "discoveryRestUrl": "https://gmailpostmastertools.googleapis.com/$discovery/rest?version=v1beta1", + "documentationLink": "https://developers.google.com/gmail/postmaster", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://developers.google.com/gmail/postmaster", - "preferred": false - }, - { + "id": "gmailpostmastertools:v1beta1", "kind": "discovery#directoryItem", - "id": "gmailpostmastertools:v1", "name": "gmailpostmastertools", - "version": "v1", + "preferred": false, "title": "Gmail Postmaster Tools API", + "version": "v1beta1" + }, + { "description": "The Postmaster Tools API is a RESTful API that provides programmatic access to email traffic metrics (like spam reports, delivery errors etc) otherwise available through the Gmail Postmaster Tools UI currently.", "discoveryRestUrl": "https://gmailpostmastertools.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://developers.google.com/gmail/postmaster", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://developers.google.com/gmail/postmaster", - "preferred": true - }, - { + "id": "gmailpostmastertools:v1", "kind": "discovery#directoryItem", - "id": "groupsmigration:v1", - "name": "groupsmigration", - "version": "v1", - "title": "Groups Migration API", + "name": "gmailpostmastertools", + "preferred": true, + "title": "Gmail Postmaster Tools API", + "version": "v1" + }, + { "description": "The Groups Migration API allows domain administrators to archive emails into Google groups.", "discoveryRestUrl": "https://groupsmigration.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://developers.google.com/google-apps/groups-migration/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://developers.google.com/google-apps/groups-migration/", - "preferred": true + "id": "groupsmigration:v1", + "kind": "discovery#directoryItem", + "name": "groupsmigration", + "preferred": true, + "title": "Groups Migration API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "groupssettings:v1", - "name": "groupssettings", - "version": "v1", - "title": "Groups Settings API", "description": "The Groups Settings API allows domain administrators to view and manage access levels and advanced settings for a group.", "discoveryRestUrl": "https://groupssettings.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://developers.google.com/admin-sdk/groups-settings", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://developers.google.com/admin-sdk/groups-settings", - "preferred": true + "id": "groupssettings:v1", + "kind": "discovery#directoryItem", + "name": "groupssettings", + "preferred": true, + "title": "Groups Settings API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "healthcare:v1beta1", - "name": "healthcare", - "version": "v1beta1", - "title": "Cloud Healthcare API", "description": "Manage, store, and access healthcare data in Google Cloud Platform.", "discoveryRestUrl": "https://healthcare.googleapis.com/$discovery/rest?version=v1beta1", + "documentationLink": "https://cloud.google.com/healthcare", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/healthcare", - "preferred": false - }, - { + "id": "healthcare:v1beta1", "kind": "discovery#directoryItem", - "id": "healthcare:v1", "name": "healthcare", - "version": "v1", + "preferred": false, "title": "Cloud Healthcare API", + "version": "v1beta1" + }, + { "description": "Manage, store, and access healthcare data in Google Cloud Platform.", "discoveryRestUrl": "https://healthcare.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/healthcare", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/healthcare", - "preferred": true + "id": "healthcare:v1", + "kind": "discovery#directoryItem", + "name": "healthcare", + "preferred": true, + "title": "Cloud Healthcare API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "homegraph:v1", - "name": "homegraph", - "version": "v1", - "title": "HomeGraph API", "description": "", "discoveryRestUrl": "https://homegraph.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://developers.home.google.com/cloud-to-cloud/get-started", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://developers.home.google.com/cloud-to-cloud/get-started", - "preferred": true + "id": "homegraph:v1", + "kind": "discovery#directoryItem", + "name": "homegraph", + "preferred": true, + "title": "HomeGraph API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "iam:v2beta", - "name": "iam", - "version": "v2beta", - "title": "Identity and Access Management (IAM) API", "description": "Manages identity and access control for Google Cloud resources, including the creation of service accounts, which you can use to authenticate to Google and make API calls. Enabling this API also enables the IAM Service Account Credentials API (iamcredentials.googleapis.com). However, disabling this API doesn't disable the IAM Service Account Credentials API.", "discoveryRestUrl": "https://iam.googleapis.com/$discovery/rest?version=v2beta", + "documentationLink": "https://cloud.google.com/iam/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/iam/", - "preferred": false - }, - { + "id": "iam:v2beta", "kind": "discovery#directoryItem", - "id": "iam:v1", "name": "iam", - "version": "v1", + "preferred": false, "title": "Identity and Access Management (IAM) API", + "version": "v2beta" + }, + { "description": "Manages identity and access control for Google Cloud resources, including the creation of service accounts, which you can use to authenticate to Google and make API calls. Enabling this API also enables the IAM Service Account Credentials API (iamcredentials.googleapis.com). However, disabling this API doesn't disable the IAM Service Account Credentials API.", "discoveryRestUrl": "https://iam.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/iam/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/iam/", - "preferred": false - }, - { + "id": "iam:v1", "kind": "discovery#directoryItem", - "id": "iam:v2", "name": "iam", - "version": "v2", + "preferred": false, "title": "Identity and Access Management (IAM) API", + "version": "v1" + }, + { "description": "Manages identity and access control for Google Cloud resources, including the creation of service accounts, which you can use to authenticate to Google and make API calls. Enabling this API also enables the IAM Service Account Credentials API (iamcredentials.googleapis.com). However, disabling this API doesn't disable the IAM Service Account Credentials API.", "discoveryRestUrl": "https://iam.googleapis.com/$discovery/rest?version=v2", + "documentationLink": "https://cloud.google.com/iam/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/iam/", - "preferred": true + "id": "iam:v2", + "kind": "discovery#directoryItem", + "name": "iam", + "preferred": true, + "title": "Identity and Access Management (IAM) API", + "version": "v2" }, { - "kind": "discovery#directoryItem", - "id": "iamcredentials:v1", - "name": "iamcredentials", - "version": "v1", - "title": "IAM Service Account Credentials API", "description": "Creates short-lived credentials for impersonating IAM service accounts. Disabling this API also disables the IAM API (iam.googleapis.com). However, enabling this API doesn't enable the IAM API.", "discoveryRestUrl": "https://iamcredentials.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/iam/docs/creating-short-lived-service-account-credentials", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/iam/docs/creating-short-lived-service-account-credentials", - "preferred": true + "id": "iamcredentials:v1", + "kind": "discovery#directoryItem", + "name": "iamcredentials", + "preferred": true, + "title": "IAM Service Account Credentials API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "iap:v1beta1", - "name": "iap", - "version": "v1beta1", - "title": "Cloud Identity-Aware Proxy API", "description": "Controls access to cloud applications running on Google Cloud Platform.", "discoveryRestUrl": "https://iap.googleapis.com/$discovery/rest?version=v1beta1", + "documentationLink": "https://cloud.google.com/iap", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/iap", - "preferred": false - }, - { + "id": "iap:v1beta1", "kind": "discovery#directoryItem", - "id": "iap:v1", "name": "iap", - "version": "v1", + "preferred": false, "title": "Cloud Identity-Aware Proxy API", + "version": "v1beta1" + }, + { "description": "Controls access to cloud applications running on Google Cloud Platform.", "discoveryRestUrl": "https://iap.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/iap", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/iap", - "preferred": true + "id": "iap:v1", + "kind": "discovery#directoryItem", + "name": "iap", + "preferred": true, + "title": "Cloud Identity-Aware Proxy API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "identitytoolkit:v1", - "name": "identitytoolkit", - "version": "v1", - "title": "Identity Toolkit API", "description": "The Google Identity Toolkit API lets you use open standards to verify a user's identity.", "discoveryRestUrl": "https://identitytoolkit.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/identity-platform", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/identity-platform", - "preferred": false - }, - { + "id": "identitytoolkit:v1", "kind": "discovery#directoryItem", - "id": "identitytoolkit:v2", "name": "identitytoolkit", - "version": "v2", + "preferred": false, "title": "Identity Toolkit API", + "version": "v1" + }, + { "description": "The Google Identity Toolkit API lets you use open standards to verify a user's identity.", "discoveryRestUrl": "https://identitytoolkit.googleapis.com/$discovery/rest?version=v2", + "documentationLink": "https://cloud.google.com/identity-platform", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/identity-platform", - "preferred": false - }, - { + "id": "identitytoolkit:v2", "kind": "discovery#directoryItem", - "id": "identitytoolkit:v3", "name": "identitytoolkit", - "version": "v3", + "preferred": false, "title": "Identity Toolkit API", + "version": "v2" + }, + { "description": "The Google Identity Toolkit API lets you use open standards to verify a user's identity.", "discoveryRestUrl": "https://identitytoolkit.googleapis.com/$discovery/rest?version=v3", + "documentationLink": "https://cloud.google.com/identity-platform", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/identity-platform", - "preferred": true + "id": "identitytoolkit:v3", + "kind": "discovery#directoryItem", + "name": "identitytoolkit", + "preferred": true, + "title": "Identity Toolkit API", + "version": "v3" }, { - "kind": "discovery#directoryItem", - "id": "ids:v1", - "name": "ids", - "version": "v1", - "title": "Cloud IDS API", "description": "Cloud IDS (Cloud Intrusion Detection System) detects malware, spyware, command-and-control attacks, and other network-based threats. Its security efficacy is industry leading, built with Palo Alto Networks technologies. When you use this product, your organization name and consumption levels will be shared with Palo Alto Networks.", "discoveryRestUrl": "https://ids.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/", - "preferred": true + "id": "ids:v1", + "kind": "discovery#directoryItem", + "name": "ids", + "preferred": true, + "title": "Cloud IDS API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "indexing:v3", - "name": "indexing", - "version": "v3", - "title": "Web Search Indexing API", "description": "Notifies Google Web Search when your web pages change.", "discoveryRestUrl": "https://indexing.googleapis.com/$discovery/rest?version=v3", + "documentationLink": "https://developers.google.com/search/apis/indexing-api/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://developers.google.com/search/apis/indexing-api/", - "preferred": true + "id": "indexing:v3", + "kind": "discovery#directoryItem", + "name": "indexing", + "preferred": true, + "title": "Web Search Indexing API", + "version": "v3" }, { - "kind": "discovery#directoryItem", - "id": "integrations:v1", - "name": "integrations", - "version": "v1", - "title": "Application Integration API", "description": "", "discoveryRestUrl": "https://integrations.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/application-integration", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/application-integration", - "preferred": true + "id": "integrations:v1", + "kind": "discovery#directoryItem", + "name": "integrations", + "preferred": true, + "title": "Application Integration API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "jobs:v3p1beta1", - "name": "jobs", - "version": "v3p1beta1", - "title": "Cloud Talent Solution API", "description": "Cloud Talent Solution provides the capability to create, read, update, and delete job postings, as well as search jobs based on keywords and filters.", "discoveryRestUrl": "https://jobs.googleapis.com/$discovery/rest?version=v3p1beta1", + "documentationLink": "https://cloud.google.com/talent-solution/job-search/docs/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/talent-solution/job-search/docs/", - "preferred": false - }, - { + "id": "jobs:v3p1beta1", "kind": "discovery#directoryItem", - "id": "jobs:v3", "name": "jobs", - "version": "v3", + "preferred": false, "title": "Cloud Talent Solution API", + "version": "v3p1beta1" + }, + { "description": "Cloud Talent Solution provides the capability to create, read, update, and delete job postings, as well as search jobs based on keywords and filters.", "discoveryRestUrl": "https://jobs.googleapis.com/$discovery/rest?version=v3", + "documentationLink": "https://cloud.google.com/talent-solution/job-search/docs/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/talent-solution/job-search/docs/", - "preferred": false - }, - { + "id": "jobs:v3", "kind": "discovery#directoryItem", - "id": "jobs:v4", "name": "jobs", - "version": "v4", + "preferred": false, "title": "Cloud Talent Solution API", + "version": "v3" + }, + { "description": "Cloud Talent Solution provides the capability to create, read, update, and delete job postings, as well as search jobs based on keywords and filters.", "discoveryRestUrl": "https://jobs.googleapis.com/$discovery/rest?version=v4", + "documentationLink": "https://cloud.google.com/talent-solution/job-search/docs/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/talent-solution/job-search/docs/", - "preferred": true + "id": "jobs:v4", + "kind": "discovery#directoryItem", + "name": "jobs", + "preferred": true, + "title": "Cloud Talent Solution API", + "version": "v4" }, { - "kind": "discovery#directoryItem", - "id": "keep:v1", - "name": "keep", - "version": "v1", - "title": "Google Keep API", "description": "The Google Keep API is used in an enterprise environment to manage Google Keep content and resolve issues identified by cloud security software.", "discoveryRestUrl": "https://keep.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://developers.google.com/keep/api", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://developers.google.com/keep/api", - "preferred": true + "id": "keep:v1", + "kind": "discovery#directoryItem", + "name": "keep", + "preferred": true, + "title": "Google Keep API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "kgsearch:v1", - "name": "kgsearch", - "version": "v1", - "title": "Knowledge Graph Search API", "description": "Searches the Google Knowledge Graph for entities.", "discoveryRestUrl": "https://kgsearch.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://developers.google.com/knowledge-graph/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://developers.google.com/knowledge-graph/", - "preferred": true + "id": "kgsearch:v1", + "kind": "discovery#directoryItem", + "name": "kgsearch", + "preferred": true, + "title": "Knowledge Graph Search API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "kmsinventory:v1", - "name": "kmsinventory", - "version": "v1", - "title": "KMS Inventory API", "description": "", "discoveryRestUrl": "https://kmsinventory.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/kms/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/kms/", - "preferred": true + "id": "kmsinventory:v1", + "kind": "discovery#directoryItem", + "name": "kmsinventory", + "preferred": true, + "title": "KMS Inventory API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "language:v1beta2", - "name": "language", - "version": "v1beta2", - "title": "Cloud Natural Language API", "description": "Provides natural language understanding technologies, such as sentiment analysis, entity recognition, entity sentiment analysis, and other text annotations, to developers.", "discoveryRestUrl": "https://language.googleapis.com/$discovery/rest?version=v1beta2", + "documentationLink": "https://cloud.google.com/natural-language/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/natural-language/", - "preferred": false - }, - { + "id": "language:v1beta2", "kind": "discovery#directoryItem", - "id": "language:v1", "name": "language", - "version": "v1", + "preferred": false, "title": "Cloud Natural Language API", + "version": "v1beta2" + }, + { "description": "Provides natural language understanding technologies, such as sentiment analysis, entity recognition, entity sentiment analysis, and other text annotations, to developers.", "discoveryRestUrl": "https://language.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/natural-language/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/natural-language/", - "preferred": false - }, - { + "id": "language:v1", "kind": "discovery#directoryItem", - "id": "language:v2", "name": "language", - "version": "v2", + "preferred": false, "title": "Cloud Natural Language API", + "version": "v1" + }, + { "description": "Provides natural language understanding technologies, such as sentiment analysis, entity recognition, entity sentiment analysis, and other text annotations, to developers.", "discoveryRestUrl": "https://language.googleapis.com/$discovery/rest?version=v2", + "documentationLink": "https://cloud.google.com/natural-language/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/natural-language/", - "preferred": true + "id": "language:v2", + "kind": "discovery#directoryItem", + "name": "language", + "preferred": true, + "title": "Cloud Natural Language API", + "version": "v2" }, { - "kind": "discovery#directoryItem", - "id": "libraryagent:v1", - "name": "libraryagent", - "version": "v1", - "title": "Library Agent API", "description": "A simple Google Example Library API.", "discoveryRestUrl": "https://libraryagent.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/docs/quota", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/docs/quota", - "preferred": true + "id": "libraryagent:v1", + "kind": "discovery#directoryItem", + "name": "libraryagent", + "preferred": true, + "title": "Library Agent API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "licensing:v1", - "name": "licensing", - "version": "v1", - "title": "Enterprise License Manager API", "description": "The Google Enterprise License Manager API lets you manage Google Workspace and related licenses for all users of a customer that you manage.", "discoveryRestUrl": "https://licensing.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://developers.google.com/admin-sdk/licensing/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://developers.google.com/admin-sdk/licensing/", - "preferred": true + "id": "licensing:v1", + "kind": "discovery#directoryItem", + "name": "licensing", + "preferred": true, + "title": "Enterprise License Manager API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "lifesciences:v2beta", - "name": "lifesciences", - "version": "v2beta", - "title": "Cloud Life Sciences API", "description": "Cloud Life Sciences is a suite of services and tools for managing, processing, and transforming life sciences data.", "discoveryRestUrl": "https://lifesciences.googleapis.com/$discovery/rest?version=v2beta", + "documentationLink": "https://cloud.google.com/life-sciences", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/life-sciences", - "preferred": true + "id": "lifesciences:v2beta", + "kind": "discovery#directoryItem", + "name": "lifesciences", + "preferred": true, + "title": "Cloud Life Sciences API", + "version": "v2beta" }, { - "kind": "discovery#directoryItem", - "id": "localservices:v1", - "name": "localservices", - "version": "v1", - "title": "Local Services API", "description": "", "discoveryRestUrl": "https://localservices.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://ads.google.com/local-services-ads/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://ads.google.com/local-services-ads/", - "preferred": true + "id": "localservices:v1", + "kind": "discovery#directoryItem", + "name": "localservices", + "preferred": true, + "title": "Local Services API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "logging:v2", - "name": "logging", - "version": "v2", - "title": "Cloud Logging API", "description": "Writes log entries and manages your Cloud Logging configuration.", "discoveryRestUrl": "https://logging.googleapis.com/$discovery/rest?version=v2", + "documentationLink": "https://cloud.google.com/logging/docs/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/logging/docs/", - "preferred": true + "id": "logging:v2", + "kind": "discovery#directoryItem", + "name": "logging", + "preferred": true, + "title": "Cloud Logging API", + "version": "v2" }, { - "kind": "discovery#directoryItem", - "id": "looker:v1", - "name": "looker", - "version": "v1", - "title": "Looker (Google Cloud core) API", "description": "", "discoveryRestUrl": "https://looker.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/looker/docs/reference/rest/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/looker/docs/reference/rest/", - "preferred": true + "id": "looker:v1", + "kind": "discovery#directoryItem", + "name": "looker", + "preferred": true, + "title": "Looker (Google Cloud core) API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "managedidentities:v1alpha1", - "name": "managedidentities", - "version": "v1alpha1", - "title": "Managed Service for Microsoft Active Directory API", "description": "The Managed Service for Microsoft Active Directory API is used for managing a highly available, hardened service running Microsoft Active Directory (AD).", "discoveryRestUrl": "https://managedidentities.googleapis.com/$discovery/rest?version=v1alpha1", + "documentationLink": "https://cloud.google.com/managed-microsoft-ad/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/managed-microsoft-ad/", - "preferred": false - }, - { + "id": "managedidentities:v1alpha1", "kind": "discovery#directoryItem", - "id": "managedidentities:v1beta1", "name": "managedidentities", - "version": "v1beta1", + "preferred": false, "title": "Managed Service for Microsoft Active Directory API", + "version": "v1alpha1" + }, + { "description": "The Managed Service for Microsoft Active Directory API is used for managing a highly available, hardened service running Microsoft Active Directory (AD).", "discoveryRestUrl": "https://managedidentities.googleapis.com/$discovery/rest?version=v1beta1", + "documentationLink": "https://cloud.google.com/managed-microsoft-ad/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/managed-microsoft-ad/", - "preferred": false - }, - { + "id": "managedidentities:v1beta1", "kind": "discovery#directoryItem", - "id": "managedidentities:v1", "name": "managedidentities", - "version": "v1", + "preferred": false, "title": "Managed Service for Microsoft Active Directory API", + "version": "v1beta1" + }, + { "description": "The Managed Service for Microsoft Active Directory API is used for managing a highly available, hardened service running Microsoft Active Directory (AD).", "discoveryRestUrl": "https://managedidentities.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/managed-microsoft-ad/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/managed-microsoft-ad/", - "preferred": true + "id": "managedidentities:v1", + "kind": "discovery#directoryItem", + "name": "managedidentities", + "preferred": true, + "title": "Managed Service for Microsoft Active Directory API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "manufacturers:v1", - "name": "manufacturers", - "version": "v1", - "title": "Manufacturer Center API", "description": "Public API for managing Manufacturer Center related data.", "discoveryRestUrl": "https://manufacturers.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://developers.google.com/manufacturers/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://developers.google.com/manufacturers/", - "preferred": true + "id": "manufacturers:v1", + "kind": "discovery#directoryItem", + "name": "manufacturers", + "preferred": true, + "title": "Manufacturer Center API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "marketingplatformadmin:v1alpha", - "name": "marketingplatformadmin", - "version": "v1alpha", - "title": "Google Marketing Platform Admin API", "description": "The Google Marketing Platform Admin API allows for programmatic access to the Google Marketing Platform configuration data. You can use the Google Marketing Platform Admin API to manage links between your Google Marketing Platform organization and Google Analytics accounts, and to set the service level of your GA4 properties.", "discoveryRestUrl": "https://marketingplatformadmin.googleapis.com/$discovery/rest?version=v1alpha", + "documentationLink": "https://developers.google.com/analytics/devguides/config/gmp/v1", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://developers.google.com/analytics/devguides/config/gmp/v1", - "preferred": true + "id": "marketingplatformadmin:v1alpha", + "kind": "discovery#directoryItem", + "name": "marketingplatformadmin", + "preferred": true, + "title": "Google Marketing Platform Admin API", + "version": "v1alpha" }, { - "kind": "discovery#directoryItem", - "id": "meet:v2", - "name": "meet", - "version": "v2", - "title": "Google Meet API", "description": "Create and manage meetings in Google Meet.", "discoveryRestUrl": "https://meet.googleapis.com/$discovery/rest?version=v2", + "documentationLink": "https://developers.google.com/meet/api", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://developers.google.com/meet/api", - "preferred": true + "id": "meet:v2", + "kind": "discovery#directoryItem", + "name": "meet", + "preferred": true, + "title": "Google Meet API", + "version": "v2" }, { - "kind": "discovery#directoryItem", - "id": "memcache:v1beta2", - "name": "memcache", - "version": "v1beta2", - "title": "Cloud Memorystore for Memcached API", "description": "Google Cloud Memorystore for Memcached API is used for creating and managing Memcached instances in GCP.", "discoveryRestUrl": "https://memcache.googleapis.com/$discovery/rest?version=v1beta2", + "documentationLink": "https://cloud.google.com/memorystore/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/memorystore/", - "preferred": false - }, - { + "id": "memcache:v1beta2", "kind": "discovery#directoryItem", - "id": "memcache:v1", "name": "memcache", - "version": "v1", + "preferred": false, "title": "Cloud Memorystore for Memcached API", + "version": "v1beta2" + }, + { "description": "Google Cloud Memorystore for Memcached API is used for creating and managing Memcached instances in GCP.", "discoveryRestUrl": "https://memcache.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/memorystore/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/memorystore/", - "preferred": true + "id": "memcache:v1", + "kind": "discovery#directoryItem", + "name": "memcache", + "preferred": true, + "title": "Cloud Memorystore for Memcached API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "merchantapi:accounts_v1beta", - "name": "merchantapi", - "version": "accounts_v1beta", - "title": "Merchant API", "description": "Programmatically manage your Merchant Center Accounts.", "discoveryRestUrl": "https://merchantapi.googleapis.com/$discovery/rest?version=accounts_v1beta", + "documentationLink": "https://developers.devsite.corp.google.com/merchant/api", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://developers.devsite.corp.google.com/merchant/api", - "preferred": false - }, - { + "id": "merchantapi:accounts_v1beta", "kind": "discovery#directoryItem", - "id": "merchantapi:conversions_v1beta", "name": "merchantapi", - "version": "conversions_v1beta", + "preferred": false, "title": "Merchant API", + "version": "accounts_v1beta" + }, + { "description": "Programmatically manage your Merchant Center Accounts.", "discoveryRestUrl": "https://merchantapi.googleapis.com/$discovery/rest?version=conversions_v1beta", + "documentationLink": "https://developers.devsite.corp.google.com/merchant/api", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://developers.devsite.corp.google.com/merchant/api", - "preferred": false - }, - { + "id": "merchantapi:conversions_v1beta", "kind": "discovery#directoryItem", - "id": "merchantapi:datasources_v1beta", "name": "merchantapi", - "version": "datasources_v1beta", + "preferred": false, "title": "Merchant API", + "version": "conversions_v1beta" + }, + { "description": "Programmatically manage your Merchant Center Accounts.", "discoveryRestUrl": "https://merchantapi.googleapis.com/$discovery/rest?version=datasources_v1beta", + "documentationLink": "https://developers.devsite.corp.google.com/merchant/api", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://developers.devsite.corp.google.com/merchant/api", - "preferred": false - }, - { + "id": "merchantapi:datasources_v1beta", "kind": "discovery#directoryItem", - "id": "merchantapi:inventories_v1beta", "name": "merchantapi", - "version": "inventories_v1beta", + "preferred": false, "title": "Merchant API", + "version": "datasources_v1beta" + }, + { "description": "Programmatically manage your Merchant Center Accounts.", "discoveryRestUrl": "https://merchantapi.googleapis.com/$discovery/rest?version=inventories_v1beta", + "documentationLink": "https://developers.devsite.corp.google.com/merchant/api", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://developers.devsite.corp.google.com/merchant/api", - "preferred": false - }, - { + "id": "merchantapi:inventories_v1beta", "kind": "discovery#directoryItem", - "id": "merchantapi:lfp_v1beta", "name": "merchantapi", - "version": "lfp_v1beta", + "preferred": false, "title": "Merchant API", + "version": "inventories_v1beta" + }, + { "description": "Programmatically manage your Merchant Center Accounts.", "discoveryRestUrl": "https://merchantapi.googleapis.com/$discovery/rest?version=lfp_v1beta", + "documentationLink": "https://developers.devsite.corp.google.com/merchant/api", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://developers.devsite.corp.google.com/merchant/api", - "preferred": false - }, - { + "id": "merchantapi:lfp_v1beta", "kind": "discovery#directoryItem", - "id": "merchantapi:notifications_v1beta", "name": "merchantapi", - "version": "notifications_v1beta", + "preferred": false, "title": "Merchant API", + "version": "lfp_v1beta" + }, + { "description": "Programmatically manage your Merchant Center Accounts.", "discoveryRestUrl": "https://merchantapi.googleapis.com/$discovery/rest?version=notifications_v1beta", + "documentationLink": "https://developers.devsite.corp.google.com/merchant/api", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://developers.devsite.corp.google.com/merchant/api", - "preferred": false - }, - { + "id": "merchantapi:notifications_v1beta", "kind": "discovery#directoryItem", - "id": "merchantapi:products_v1beta", "name": "merchantapi", - "version": "products_v1beta", + "preferred": false, "title": "Merchant API", + "version": "notifications_v1beta" + }, + { "description": "Programmatically manage your Merchant Center Accounts.", "discoveryRestUrl": "https://merchantapi.googleapis.com/$discovery/rest?version=products_v1beta", + "documentationLink": "https://developers.devsite.corp.google.com/merchant/api", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://developers.devsite.corp.google.com/merchant/api", - "preferred": false - }, - { + "id": "merchantapi:products_v1beta", "kind": "discovery#directoryItem", - "id": "merchantapi:promotions_v1beta", "name": "merchantapi", - "version": "promotions_v1beta", + "preferred": false, "title": "Merchant API", + "version": "products_v1beta" + }, + { "description": "Programmatically manage your Merchant Center Accounts.", "discoveryRestUrl": "https://merchantapi.googleapis.com/$discovery/rest?version=promotions_v1beta", + "documentationLink": "https://developers.devsite.corp.google.com/merchant/api", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://developers.devsite.corp.google.com/merchant/api", - "preferred": false - }, - { + "id": "merchantapi:promotions_v1beta", "kind": "discovery#directoryItem", - "id": "merchantapi:quota_v1beta", "name": "merchantapi", - "version": "quota_v1beta", + "preferred": false, "title": "Merchant API", + "version": "promotions_v1beta" + }, + { "description": "Programmatically manage your Merchant Center Accounts.", "discoveryRestUrl": "https://merchantapi.googleapis.com/$discovery/rest?version=quota_v1beta", + "documentationLink": "https://developers.devsite.corp.google.com/merchant/api", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://developers.devsite.corp.google.com/merchant/api", - "preferred": false - }, - { + "id": "merchantapi:quota_v1beta", "kind": "discovery#directoryItem", - "id": "merchantapi:reports_v1beta", "name": "merchantapi", - "version": "reports_v1beta", + "preferred": false, "title": "Merchant API", + "version": "quota_v1beta" + }, + { "description": "Programmatically manage your Merchant Center Accounts.", "discoveryRestUrl": "https://merchantapi.googleapis.com/$discovery/rest?version=reports_v1beta", + "documentationLink": "https://developers.devsite.corp.google.com/merchant/api", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://developers.devsite.corp.google.com/merchant/api", - "preferred": true + "id": "merchantapi:reports_v1beta", + "kind": "discovery#directoryItem", + "name": "merchantapi", + "preferred": true, + "title": "Merchant API", + "version": "reports_v1beta" }, { - "kind": "discovery#directoryItem", - "id": "metastore:v1alpha", - "name": "metastore", - "version": "v1alpha", - "title": "Dataproc Metastore API", "description": "The Dataproc Metastore API is used to manage the lifecycle and configuration of metastore services.", "discoveryRestUrl": "https://metastore.googleapis.com/$discovery/rest?version=v1alpha", + "documentationLink": "https://cloud.google.com/dataproc-metastore/docs", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/dataproc-metastore/docs", - "preferred": false - }, - { + "id": "metastore:v1alpha", "kind": "discovery#directoryItem", - "id": "metastore:v1beta", "name": "metastore", - "version": "v1beta", + "preferred": false, "title": "Dataproc Metastore API", + "version": "v1alpha" + }, + { "description": "The Dataproc Metastore API is used to manage the lifecycle and configuration of metastore services.", "discoveryRestUrl": "https://metastore.googleapis.com/$discovery/rest?version=v1beta", + "documentationLink": "https://cloud.google.com/dataproc-metastore/docs", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/dataproc-metastore/docs", - "preferred": false - }, - { + "id": "metastore:v1beta", "kind": "discovery#directoryItem", - "id": "metastore:v1", "name": "metastore", - "version": "v1", + "preferred": false, "title": "Dataproc Metastore API", + "version": "v1beta" + }, + { "description": "The Dataproc Metastore API is used to manage the lifecycle and configuration of metastore services.", "discoveryRestUrl": "https://metastore.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/dataproc-metastore/docs", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/dataproc-metastore/docs", - "preferred": true + "id": "metastore:v1", + "kind": "discovery#directoryItem", + "name": "metastore", + "preferred": true, + "title": "Dataproc Metastore API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "migrationcenter:v1alpha1", - "name": "migrationcenter", - "version": "v1alpha1", - "title": "Migration Center API", "description": "A unified platform that helps you accelerate your end-to-end cloud journey from your current on-premises or cloud environments to Google Cloud.", "discoveryRestUrl": "https://migrationcenter.googleapis.com/$discovery/rest?version=v1alpha1", + "documentationLink": "https://cloud.google.com/migration-center", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/migration-center", - "preferred": false - }, - { + "id": "migrationcenter:v1alpha1", "kind": "discovery#directoryItem", - "id": "migrationcenter:v1", "name": "migrationcenter", - "version": "v1", + "preferred": false, "title": "Migration Center API", + "version": "v1alpha1" + }, + { "description": "A unified platform that helps you accelerate your end-to-end cloud journey from your current on-premises or cloud environments to Google Cloud.", "discoveryRestUrl": "https://migrationcenter.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/migration-center", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/migration-center", - "preferred": true + "id": "migrationcenter:v1", + "kind": "discovery#directoryItem", + "name": "migrationcenter", + "preferred": true, + "title": "Migration Center API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "ml:v1", - "name": "ml", - "version": "v1", - "title": "AI Platform Training & Prediction API", "description": "An API to enable creating and using machine learning models.", "discoveryRestUrl": "https://ml.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/ml/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/ml/", - "preferred": true + "id": "ml:v1", + "kind": "discovery#directoryItem", + "name": "ml", + "preferred": true, + "title": "AI Platform Training & Prediction API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "monitoring:v1", - "name": "monitoring", - "version": "v1", - "title": "Cloud Monitoring API", "description": "Manages your Cloud Monitoring data and configurations.", "discoveryRestUrl": "https://monitoring.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/monitoring/api/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/monitoring/api/", - "preferred": false - }, - { + "id": "monitoring:v1", "kind": "discovery#directoryItem", - "id": "monitoring:v3", "name": "monitoring", - "version": "v3", + "preferred": false, "title": "Cloud Monitoring API", + "version": "v1" + }, + { "description": "Manages your Cloud Monitoring data and configurations.", "discoveryRestUrl": "https://monitoring.googleapis.com/$discovery/rest?version=v3", + "documentationLink": "https://cloud.google.com/monitoring/api/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/monitoring/api/", - "preferred": true + "id": "monitoring:v3", + "kind": "discovery#directoryItem", + "name": "monitoring", + "preferred": true, + "title": "Cloud Monitoring API", + "version": "v3" }, { - "kind": "discovery#directoryItem", - "id": "mybusinessaccountmanagement:v1", - "name": "mybusinessaccountmanagement", - "version": "v1", - "title": "My Business Account Management API", "description": "The My Business Account Management API provides an interface for managing access to a location on Google. Note - If you have a quota of 0 after enabling the API, please request for GBP API access.", "discoveryRestUrl": "https://mybusinessaccountmanagement.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://developers.google.com/my-business/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://developers.google.com/my-business/", - "preferred": true + "id": "mybusinessaccountmanagement:v1", + "kind": "discovery#directoryItem", + "name": "mybusinessaccountmanagement", + "preferred": true, + "title": "My Business Account Management API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "mybusinessbusinessinformation:v1", - "name": "mybusinessbusinessinformation", - "version": "v1", - "title": "My Business Business Information API", "description": "The My Business Business Information API provides an interface for managing business information. Note - If you have a quota of 0 after enabling the API, please request for GBP API access.", "discoveryRestUrl": "https://mybusinessbusinessinformation.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://developers.google.com/my-business/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://developers.google.com/my-business/", - "preferred": true + "id": "mybusinessbusinessinformation:v1", + "kind": "discovery#directoryItem", + "name": "mybusinessbusinessinformation", + "preferred": true, + "title": "My Business Business Information API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "mybusinesslodging:v1", - "name": "mybusinesslodging", - "version": "v1", - "title": "My Business Lodging API", "description": "The My Business Lodging API enables managing lodging business information on Google. Note - If you have a quota of 0 after enabling the API, please request for GBP API access.", "discoveryRestUrl": "https://mybusinesslodging.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://developers.google.com/my-business/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://developers.google.com/my-business/", - "preferred": true + "id": "mybusinesslodging:v1", + "kind": "discovery#directoryItem", + "name": "mybusinesslodging", + "preferred": true, + "title": "My Business Lodging API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "mybusinessnotifications:v1", - "name": "mybusinessnotifications", - "version": "v1", - "title": "My Business Notifications API", "description": "The My Business Notification Settings API enables managing notification settings for business accounts. Note - If you have a quota of 0 after enabling the API, please request for GBP API access.", "discoveryRestUrl": "https://mybusinessnotifications.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://developers.google.com/my-business/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://developers.google.com/my-business/", - "preferred": true + "id": "mybusinessnotifications:v1", + "kind": "discovery#directoryItem", + "name": "mybusinessnotifications", + "preferred": true, + "title": "My Business Notifications API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "mybusinessplaceactions:v1", - "name": "mybusinessplaceactions", - "version": "v1", - "title": "My Business Place Actions API", "description": "The My Business Place Actions API provides an interface for managing place action links of a location on Google. Note - If you have a quota of 0 after enabling the API, please request for GBP API access.", "discoveryRestUrl": "https://mybusinessplaceactions.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://developers.google.com/my-business/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://developers.google.com/my-business/", - "preferred": true + "id": "mybusinessplaceactions:v1", + "kind": "discovery#directoryItem", + "name": "mybusinessplaceactions", + "preferred": true, + "title": "My Business Place Actions API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "mybusinessqanda:v1", - "name": "mybusinessqanda", - "version": "v1", - "title": "My Business Q&A API", "description": "The My Business Q&A API allows questions and answers to be posted for specific listings. Note - If you have a quota of 0 after enabling the API, please request for GBP API access.", "discoveryRestUrl": "https://mybusinessqanda.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://developers.google.com/my-business/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://developers.google.com/my-business/", - "preferred": true + "id": "mybusinessqanda:v1", + "kind": "discovery#directoryItem", + "name": "mybusinessqanda", + "preferred": true, + "title": "My Business Q&A API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "mybusinessverifications:v1", - "name": "mybusinessverifications", - "version": "v1", - "title": "My Business Verifications API", "description": "The My Business Verifications API provides an interface for taking verifications related actions for locations.", "discoveryRestUrl": "https://mybusinessverifications.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://developers.google.com/my-business/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://developers.google.com/my-business/", - "preferred": true + "id": "mybusinessverifications:v1", + "kind": "discovery#directoryItem", + "name": "mybusinessverifications", + "preferred": true, + "title": "My Business Verifications API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "networkconnectivity:v1alpha1", - "name": "networkconnectivity", - "version": "v1alpha1", - "title": "Network Connectivity API", "description": "This API enables connectivity with and between Google Cloud resources.", "discoveryRestUrl": "https://networkconnectivity.googleapis.com/$discovery/rest?version=v1alpha1", + "documentationLink": "https://cloud.google.com/network-connectivity/docs/reference/networkconnectivity/rest", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/network-connectivity/docs/reference/networkconnectivity/rest", - "preferred": false - }, - { + "id": "networkconnectivity:v1alpha1", "kind": "discovery#directoryItem", - "id": "networkconnectivity:v1", "name": "networkconnectivity", - "version": "v1", + "preferred": false, "title": "Network Connectivity API", + "version": "v1alpha1" + }, + { "description": "This API enables connectivity with and between Google Cloud resources.", "discoveryRestUrl": "https://networkconnectivity.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/network-connectivity/docs/reference/networkconnectivity/rest", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/network-connectivity/docs/reference/networkconnectivity/rest", - "preferred": true + "id": "networkconnectivity:v1", + "kind": "discovery#directoryItem", + "name": "networkconnectivity", + "preferred": true, + "title": "Network Connectivity API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "networkmanagement:v1beta1", - "name": "networkmanagement", - "version": "v1beta1", - "title": "Network Management API", "description": "The Network Management API provides a collection of network performance monitoring and diagnostic capabilities.", "discoveryRestUrl": "https://networkmanagement.googleapis.com/$discovery/rest?version=v1beta1", + "documentationLink": "https://cloud.google.com/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/", - "preferred": false - }, - { + "id": "networkmanagement:v1beta1", "kind": "discovery#directoryItem", - "id": "networkmanagement:v1", "name": "networkmanagement", - "version": "v1", + "preferred": false, "title": "Network Management API", + "version": "v1beta1" + }, + { "description": "The Network Management API provides a collection of network performance monitoring and diagnostic capabilities.", "discoveryRestUrl": "https://networkmanagement.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/", - "preferred": true + "id": "networkmanagement:v1", + "kind": "discovery#directoryItem", + "name": "networkmanagement", + "preferred": true, + "title": "Network Management API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "networksecurity:v1beta1", - "name": "networksecurity", - "version": "v1beta1", - "title": "Network Security API", "description": "", "discoveryRestUrl": "https://networksecurity.googleapis.com/$discovery/rest?version=v1beta1", + "documentationLink": "https://cloud.google.com/networking", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/networking", - "preferred": false - }, - { + "id": "networksecurity:v1beta1", "kind": "discovery#directoryItem", - "id": "networksecurity:v1", "name": "networksecurity", - "version": "v1", + "preferred": false, "title": "Network Security API", + "version": "v1beta1" + }, + { "description": "", "discoveryRestUrl": "https://networksecurity.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/networking", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/networking", - "preferred": true + "id": "networksecurity:v1", + "kind": "discovery#directoryItem", + "name": "networksecurity", + "preferred": true, + "title": "Network Security API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "networkservices:v1beta1", - "name": "networkservices", - "version": "v1beta1", - "title": "Network Services API", "description": "", "discoveryRestUrl": "https://networkservices.googleapis.com/$discovery/rest?version=v1beta1", + "documentationLink": "https://cloud.google.com/networking", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/networking", - "preferred": false - }, - { + "id": "networkservices:v1beta1", "kind": "discovery#directoryItem", - "id": "networkservices:v1", "name": "networkservices", - "version": "v1", + "preferred": false, "title": "Network Services API", + "version": "v1beta1" + }, + { "description": "", "discoveryRestUrl": "https://networkservices.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/networking", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/networking", - "preferred": true + "id": "networkservices:v1", + "kind": "discovery#directoryItem", + "name": "networkservices", + "preferred": true, + "title": "Network Services API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "notebooks:v1", - "name": "notebooks", - "version": "v1", - "title": "Notebooks API", "description": "Notebooks API is used to manage notebook resources in Google Cloud.", "discoveryRestUrl": "https://notebooks.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/notebooks/docs/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/notebooks/docs/", - "preferred": false - }, - { + "id": "notebooks:v1", "kind": "discovery#directoryItem", - "id": "notebooks:v2", "name": "notebooks", - "version": "v2", + "preferred": false, "title": "Notebooks API", + "version": "v1" + }, + { "description": "Notebooks API is used to manage notebook resources in Google Cloud.", "discoveryRestUrl": "https://notebooks.googleapis.com/$discovery/rest?version=v2", + "documentationLink": "https://cloud.google.com/notebooks/docs/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/notebooks/docs/", - "preferred": true + "id": "notebooks:v2", + "kind": "discovery#directoryItem", + "name": "notebooks", + "preferred": true, + "title": "Notebooks API", + "version": "v2" }, { - "kind": "discovery#directoryItem", - "id": "oauth2:v2", - "name": "oauth2", - "version": "v2", - "title": "Google OAuth2 API", "description": "[Deprecated] Obtains end-user authorization grants for use with other Google APIs.", - "discoveryRestUrl": "https://www.googleapis.com/discovery/v1/apis/oauth2/v2/rest", "discoveryLink": "./apis/oauth2/v2/rest", + "discoveryRestUrl": "https://www.googleapis.com/discovery/v1/apis/oauth2/v2/rest", + "documentationLink": "https://developers.google.com/accounts/docs/OAuth2", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://developers.google.com/accounts/docs/OAuth2", - "preferred": true + "id": "oauth2:v2", + "kind": "discovery#directoryItem", + "name": "oauth2", + "preferred": true, + "title": "Google OAuth2 API", + "version": "v2" }, { - "kind": "discovery#directoryItem", - "id": "ondemandscanning:v1beta1", - "name": "ondemandscanning", - "version": "v1beta1", - "title": "On-Demand Scanning API", "description": "A service to scan container images for vulnerabilities.", "discoveryRestUrl": "https://ondemandscanning.googleapis.com/$discovery/rest?version=v1beta1", + "documentationLink": "https://cloud.google.com/container-analysis/docs/on-demand-scanning/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/container-analysis/docs/on-demand-scanning/", - "preferred": false - }, - { + "id": "ondemandscanning:v1beta1", "kind": "discovery#directoryItem", - "id": "ondemandscanning:v1", "name": "ondemandscanning", - "version": "v1", + "preferred": false, "title": "On-Demand Scanning API", + "version": "v1beta1" + }, + { "description": "A service to scan container images for vulnerabilities.", "discoveryRestUrl": "https://ondemandscanning.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/container-analysis/docs/on-demand-scanning/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/container-analysis/docs/on-demand-scanning/", - "preferred": true + "id": "ondemandscanning:v1", + "kind": "discovery#directoryItem", + "name": "ondemandscanning", + "preferred": true, + "title": "On-Demand Scanning API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "orgpolicy:v2", - "name": "orgpolicy", - "version": "v2", - "title": "Organization Policy API", "description": "The Organization Policy API allows users to configure governance rules on their Google Cloud resources across the resource hierarchy.", "discoveryRestUrl": "https://orgpolicy.googleapis.com/$discovery/rest?version=v2", + "documentationLink": "https://cloud.google.com/orgpolicy/docs/reference/rest/index.html", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/orgpolicy/docs/reference/rest/index.html", - "preferred": true + "id": "orgpolicy:v2", + "kind": "discovery#directoryItem", + "name": "orgpolicy", + "preferred": true, + "title": "Organization Policy API", + "version": "v2" }, { - "kind": "discovery#directoryItem", - "id": "osconfig:v1alpha", - "name": "osconfig", - "version": "v1alpha", - "title": "OS Config API", "description": "OS management tools that can be used for patch management, patch compliance, and configuration management on VM instances.", "discoveryRestUrl": "https://osconfig.googleapis.com/$discovery/rest?version=v1alpha", + "documentationLink": "https://cloud.google.com/compute/docs/osconfig/rest", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/compute/docs/osconfig/rest", - "preferred": false - }, - { + "id": "osconfig:v1alpha", "kind": "discovery#directoryItem", - "id": "osconfig:v1beta", "name": "osconfig", - "version": "v1beta", + "preferred": false, "title": "OS Config API", + "version": "v1alpha" + }, + { "description": "OS management tools that can be used for patch management, patch compliance, and configuration management on VM instances.", "discoveryRestUrl": "https://osconfig.googleapis.com/$discovery/rest?version=v1beta", + "documentationLink": "https://cloud.google.com/compute/docs/osconfig/rest", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/compute/docs/osconfig/rest", - "preferred": false - }, - { + "id": "osconfig:v1beta", "kind": "discovery#directoryItem", - "id": "osconfig:v1", "name": "osconfig", - "version": "v1", + "preferred": false, "title": "OS Config API", + "version": "v1beta" + }, + { "description": "OS management tools that can be used for patch management, patch compliance, and configuration management on VM instances.", "discoveryRestUrl": "https://osconfig.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/compute/docs/osconfig/rest", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/compute/docs/osconfig/rest", - "preferred": true + "id": "osconfig:v1", + "kind": "discovery#directoryItem", + "name": "osconfig", + "preferred": true, + "title": "OS Config API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "oslogin:v1alpha", - "name": "oslogin", - "version": "v1alpha", - "title": "Cloud OS Login API", "description": "You can use OS Login to manage access to your VM instances using IAM roles.", "discoveryRestUrl": "https://oslogin.googleapis.com/$discovery/rest?version=v1alpha", + "documentationLink": "https://cloud.google.com/compute/docs/oslogin/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/compute/docs/oslogin/", - "preferred": false - }, - { + "id": "oslogin:v1alpha", "kind": "discovery#directoryItem", - "id": "oslogin:v1beta", "name": "oslogin", - "version": "v1beta", + "preferred": false, "title": "Cloud OS Login API", + "version": "v1alpha" + }, + { "description": "You can use OS Login to manage access to your VM instances using IAM roles.", "discoveryRestUrl": "https://oslogin.googleapis.com/$discovery/rest?version=v1beta", + "documentationLink": "https://cloud.google.com/compute/docs/oslogin/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/compute/docs/oslogin/", - "preferred": false - }, - { + "id": "oslogin:v1beta", "kind": "discovery#directoryItem", - "id": "oslogin:v1", "name": "oslogin", - "version": "v1", + "preferred": false, "title": "Cloud OS Login API", + "version": "v1beta" + }, + { "description": "You can use OS Login to manage access to your VM instances using IAM roles.", "discoveryRestUrl": "https://oslogin.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/compute/docs/oslogin/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/compute/docs/oslogin/", - "preferred": true + "id": "oslogin:v1", + "kind": "discovery#directoryItem", + "name": "oslogin", + "preferred": true, + "title": "Cloud OS Login API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "pagespeedonline:v5", - "name": "pagespeedonline", - "version": "v5", - "title": "PageSpeed Insights API", "description": "The PageSpeed Insights API lets you analyze the performance of your website with a simple API. It offers tailored suggestions for how you can optimize your site, and lets you easily integrate PageSpeed Insights analysis into your development tools and workflow.", "discoveryRestUrl": "https://pagespeedonline.googleapis.com/$discovery/rest?version=v5", + "documentationLink": "https://developers.google.com/speed/docs/insights/v5/about", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://developers.google.com/speed/docs/insights/v5/about", - "preferred": true + "id": "pagespeedonline:v5", + "kind": "discovery#directoryItem", + "name": "pagespeedonline", + "preferred": true, + "title": "PageSpeed Insights API", + "version": "v5" }, { - "kind": "discovery#directoryItem", - "id": "paymentsresellersubscription:v1", - "name": "paymentsresellersubscription", - "version": "v1", - "title": "Payments Reseller Subscription API", "description": "", "discoveryRestUrl": "https://paymentsresellersubscription.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://developers.google.com/payments/reseller/subscription/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://developers.google.com/payments/reseller/subscription/", - "preferred": true + "id": "paymentsresellersubscription:v1", + "kind": "discovery#directoryItem", + "name": "paymentsresellersubscription", + "preferred": true, + "title": "Payments Reseller Subscription API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "people:v1", - "name": "people", - "version": "v1", - "title": "People API", "description": "Provides access to information about profiles and contacts.", "discoveryRestUrl": "https://people.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://developers.google.com/people/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://developers.google.com/people/", - "preferred": true + "id": "people:v1", + "kind": "discovery#directoryItem", + "name": "people", + "preferred": true, + "title": "People API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "places:v1", - "name": "places", - "version": "v1", - "title": "Places API (New)", "description": "", "discoveryRestUrl": "https://places.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://mapsplatform.google.com/maps-products/#places-section", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://mapsplatform.google.com/maps-products/#places-section", - "preferred": true + "id": "places:v1", + "kind": "discovery#directoryItem", + "name": "places", + "preferred": true, + "title": "Places API (New)", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "playcustomapp:v1", - "name": "playcustomapp", - "version": "v1", - "title": "Google Play Custom App Publishing API", "description": "API to create and publish custom Android apps", "discoveryRestUrl": "https://playcustomapp.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://developers.google.com/android/work/play/custom-app-api/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://developers.google.com/android/work/play/custom-app-api/", - "preferred": true + "id": "playcustomapp:v1", + "kind": "discovery#directoryItem", + "name": "playcustomapp", + "preferred": true, + "title": "Google Play Custom App Publishing API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "playdeveloperreporting:v1alpha1", - "name": "playdeveloperreporting", - "version": "v1alpha1", - "title": "Google Play Developer Reporting API", "description": "", "discoveryRestUrl": "https://playdeveloperreporting.googleapis.com/$discovery/rest?version=v1alpha1", + "documentationLink": "https://developers.google.com/play/developer/reporting", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://developers.google.com/play/developer/reporting", - "preferred": false - }, - { + "id": "playdeveloperreporting:v1alpha1", "kind": "discovery#directoryItem", - "id": "playdeveloperreporting:v1beta1", "name": "playdeveloperreporting", - "version": "v1beta1", + "preferred": false, "title": "Google Play Developer Reporting API", + "version": "v1alpha1" + }, + { "description": "", "discoveryRestUrl": "https://playdeveloperreporting.googleapis.com/$discovery/rest?version=v1beta1", + "documentationLink": "https://developers.google.com/play/developer/reporting", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://developers.google.com/play/developer/reporting", - "preferred": true + "id": "playdeveloperreporting:v1beta1", + "kind": "discovery#directoryItem", + "name": "playdeveloperreporting", + "preferred": true, + "title": "Google Play Developer Reporting API", + "version": "v1beta1" }, { - "kind": "discovery#directoryItem", - "id": "playgrouping:v1alpha1", - "name": "playgrouping", - "version": "v1alpha1", - "title": "Google Play Grouping API", "description": "playgrouping.googleapis.com API.", "discoveryRestUrl": "https://playgrouping.googleapis.com/$discovery/rest?version=v1alpha1", + "documentationLink": "https://cloud.google.com/playgrouping/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/playgrouping/", - "preferred": true + "id": "playgrouping:v1alpha1", + "kind": "discovery#directoryItem", + "name": "playgrouping", + "preferred": true, + "title": "Google Play Grouping API", + "version": "v1alpha1" }, { - "kind": "discovery#directoryItem", - "id": "playintegrity:v1", - "name": "playintegrity", - "version": "v1", - "title": "Google Play Integrity API", "description": "The Play Integrity API helps you check that you're interacting with your genuine app on a genuine Android device powered by Google Play services. The Play Integrity API has replaced SafetyNet Attestation and Android Device Verification.", "discoveryRestUrl": "https://playintegrity.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://developer.android.com/google/play/integrity", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://developer.android.com/google/play/integrity", - "preferred": true + "id": "playintegrity:v1", + "kind": "discovery#directoryItem", + "name": "playintegrity", + "preferred": true, + "title": "Google Play Integrity API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "policyanalyzer:v1beta1", - "name": "policyanalyzer", - "version": "v1beta1", - "title": "Policy Analyzer API", "description": "", "discoveryRestUrl": "https://policyanalyzer.googleapis.com/$discovery/rest?version=v1beta1", + "documentationLink": "https://www.google.com", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://www.google.com", - "preferred": false - }, - { + "id": "policyanalyzer:v1beta1", "kind": "discovery#directoryItem", - "id": "policyanalyzer:v1", "name": "policyanalyzer", - "version": "v1", + "preferred": false, "title": "Policy Analyzer API", + "version": "v1beta1" + }, + { "description": "", "discoveryRestUrl": "https://policyanalyzer.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://www.google.com", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://www.google.com", - "preferred": true + "id": "policyanalyzer:v1", + "kind": "discovery#directoryItem", + "name": "policyanalyzer", + "preferred": true, + "title": "Policy Analyzer API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "policysimulator:v1alpha", - "name": "policysimulator", - "version": "v1alpha", - "title": "Policy Simulator API", "description": "Policy Simulator is a collection of endpoints for creating, running, and viewing a [Replay][google.cloud.policysimulator.v1.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.", "discoveryRestUrl": "https://policysimulator.googleapis.com/$discovery/rest?version=v1alpha", + "documentationLink": "https://cloud.google.com/iam/docs/simulating-access", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/iam/docs/simulating-access", - "preferred": false - }, - { + "id": "policysimulator:v1alpha", "kind": "discovery#directoryItem", - "id": "policysimulator:v1beta", "name": "policysimulator", - "version": "v1beta", + "preferred": false, "title": "Policy Simulator API", + "version": "v1alpha" + }, + { "description": "Policy Simulator is a collection of endpoints for creating, running, and viewing a [Replay][google.cloud.policysimulator.v1.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.", "discoveryRestUrl": "https://policysimulator.googleapis.com/$discovery/rest?version=v1beta", + "documentationLink": "https://cloud.google.com/iam/docs/simulating-access", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/iam/docs/simulating-access", - "preferred": false - }, - { + "id": "policysimulator:v1beta", "kind": "discovery#directoryItem", - "id": "policysimulator:v1", "name": "policysimulator", - "version": "v1", + "preferred": false, "title": "Policy Simulator API", + "version": "v1beta" + }, + { "description": "Policy Simulator is a collection of endpoints for creating, running, and viewing a [Replay][google.cloud.policysimulator.v1.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.", "discoveryRestUrl": "https://policysimulator.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/iam/docs/simulating-access", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/iam/docs/simulating-access", - "preferred": true + "id": "policysimulator:v1", + "kind": "discovery#directoryItem", + "name": "policysimulator", + "preferred": true, + "title": "Policy Simulator API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "policytroubleshooter:v1beta", - "name": "policytroubleshooter", - "version": "v1beta", - "title": "Policy Troubleshooter API", "description": "", "discoveryRestUrl": "https://policytroubleshooter.googleapis.com/$discovery/rest?version=v1beta", + "documentationLink": "https://cloud.google.com/iam/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/iam/", - "preferred": false - }, - { + "id": "policytroubleshooter:v1beta", "kind": "discovery#directoryItem", - "id": "policytroubleshooter:v1", "name": "policytroubleshooter", - "version": "v1", + "preferred": false, "title": "Policy Troubleshooter API", + "version": "v1beta" + }, + { "description": "", "discoveryRestUrl": "https://policytroubleshooter.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/iam/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/iam/", - "preferred": true + "id": "policytroubleshooter:v1", + "kind": "discovery#directoryItem", + "name": "policytroubleshooter", + "preferred": true, + "title": "Policy Troubleshooter API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "pollen:v1", - "name": "pollen", - "version": "v1", - "title": "Pollen API", "description": "The Pollen API.", "discoveryRestUrl": "https://pollen.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://developers.google.com/maps/documentation/pollen", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://developers.google.com/maps/documentation/pollen", - "preferred": true + "id": "pollen:v1", + "kind": "discovery#directoryItem", + "name": "pollen", + "preferred": true, + "title": "Pollen API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "poly:v1", - "name": "poly", - "version": "v1", - "title": "Poly API", "description": "The Poly API provides read access to assets hosted on poly.google.com to all, and upload access to poly.google.com for whitelisted accounts.", "discoveryRestUrl": "https://poly.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://developers.google.com/poly/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://developers.google.com/poly/", - "preferred": true + "id": "poly:v1", + "kind": "discovery#directoryItem", + "name": "poly", + "preferred": true, + "title": "Poly API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "privateca:v1beta1", - "name": "privateca", - "version": "v1beta1", - "title": "Certificate Authority API", "description": "The Certificate Authority Service API is a highly-available, scalable service that enables you to simplify and automate the management of private certificate authorities (CAs) while staying in control of your private keys.", "discoveryRestUrl": "https://privateca.googleapis.com/$discovery/rest?version=v1beta1", + "documentationLink": "https://cloud.google.com/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/", - "preferred": false - }, - { + "id": "privateca:v1beta1", "kind": "discovery#directoryItem", - "id": "privateca:v1", "name": "privateca", - "version": "v1", + "preferred": false, "title": "Certificate Authority API", + "version": "v1beta1" + }, + { "description": "The Certificate Authority Service API is a highly-available, scalable service that enables you to simplify and automate the management of private certificate authorities (CAs) while staying in control of your private keys.", "discoveryRestUrl": "https://privateca.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/", - "preferred": true + "id": "privateca:v1", + "kind": "discovery#directoryItem", + "name": "privateca", + "preferred": true, + "title": "Certificate Authority API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "prod_tt_sasportal:v1alpha1", - "name": "prod_tt_sasportal", - "version": "v1alpha1", - "title": "SAS Portal API (Testing)", "description": "", "discoveryRestUrl": "https://prod-tt-sasportal.googleapis.com/$discovery/rest?version=v1alpha1", + "documentationLink": "https://developers.google.com/spectrum-access-system/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://developers.google.com/spectrum-access-system/", - "preferred": true + "id": "prod_tt_sasportal:v1alpha1", + "kind": "discovery#directoryItem", + "name": "prod_tt_sasportal", + "preferred": true, + "title": "SAS Portal API (Testing)", + "version": "v1alpha1" }, { - "kind": "discovery#directoryItem", - "id": "publicca:v1alpha1", - "name": "publicca", - "version": "v1alpha1", - "title": "Public Certificate Authority API", "description": "The Public Certificate Authority API may be used to create and manage ACME external account binding keys associated with Google Trust Services' publicly trusted certificate authority.", "discoveryRestUrl": "https://publicca.googleapis.com/$discovery/rest?version=v1alpha1", + "documentationLink": "https://cloud.google.com/public-certificate-authority/docs", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/public-certificate-authority/docs", - "preferred": false - }, - { + "id": "publicca:v1alpha1", "kind": "discovery#directoryItem", - "id": "publicca:v1beta1", "name": "publicca", - "version": "v1beta1", + "preferred": false, "title": "Public Certificate Authority API", + "version": "v1alpha1" + }, + { "description": "The Public Certificate Authority API may be used to create and manage ACME external account binding keys associated with Google Trust Services' publicly trusted certificate authority.", "discoveryRestUrl": "https://publicca.googleapis.com/$discovery/rest?version=v1beta1", + "documentationLink": "https://cloud.google.com/public-certificate-authority/docs", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/public-certificate-authority/docs", - "preferred": false - }, - { + "id": "publicca:v1beta1", "kind": "discovery#directoryItem", - "id": "publicca:v1", "name": "publicca", - "version": "v1", + "preferred": false, "title": "Public Certificate Authority API", + "version": "v1beta1" + }, + { "description": "The Public Certificate Authority API may be used to create and manage ACME external account binding keys associated with Google Trust Services' publicly trusted certificate authority.", "discoveryRestUrl": "https://publicca.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/public-certificate-authority/docs", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/public-certificate-authority/docs", - "preferred": true + "id": "publicca:v1", + "kind": "discovery#directoryItem", + "name": "publicca", + "preferred": true, + "title": "Public Certificate Authority API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "pubsub:v1beta1a", - "name": "pubsub", - "version": "v1beta1a", - "title": "Cloud Pub/Sub API", "description": "Provides reliable, many-to-many, asynchronous messaging between applications.", "discoveryRestUrl": "https://pubsub.googleapis.com/$discovery/rest?version=v1beta1a", + "documentationLink": "https://cloud.google.com/pubsub/docs", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/pubsub/docs", - "preferred": false - }, - { + "id": "pubsub:v1beta1a", "kind": "discovery#directoryItem", - "id": "pubsub:v1beta2", "name": "pubsub", - "version": "v1beta2", + "preferred": false, "title": "Cloud Pub/Sub API", + "version": "v1beta1a" + }, + { "description": "Provides reliable, many-to-many, asynchronous messaging between applications.", "discoveryRestUrl": "https://pubsub.googleapis.com/$discovery/rest?version=v1beta2", + "documentationLink": "https://cloud.google.com/pubsub/docs", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/pubsub/docs", - "preferred": false - }, - { + "id": "pubsub:v1beta2", "kind": "discovery#directoryItem", - "id": "pubsub:v1", "name": "pubsub", - "version": "v1", + "preferred": false, "title": "Cloud Pub/Sub API", + "version": "v1beta2" + }, + { "description": "Provides reliable, many-to-many, asynchronous messaging between applications.", "discoveryRestUrl": "https://pubsub.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/pubsub/docs", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/pubsub/docs", - "preferred": true + "id": "pubsub:v1", + "kind": "discovery#directoryItem", + "name": "pubsub", + "preferred": true, + "title": "Cloud Pub/Sub API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "pubsublite:v1", - "name": "pubsublite", - "version": "v1", - "title": "Pub/Sub Lite API", "description": "", "discoveryRestUrl": "https://pubsublite.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/pubsub/lite/docs", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/pubsub/lite/docs", - "preferred": true + "id": "pubsublite:v1", + "kind": "discovery#directoryItem", + "name": "pubsublite", + "preferred": true, + "title": "Pub/Sub Lite API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "rapidmigrationassessment:v1", - "name": "rapidmigrationassessment", - "version": "v1", - "title": "Rapid Migration Assessment API", "description": "The Rapid Migration Assessment service is our first-party migration assessment and planning tool.", "discoveryRestUrl": "https://rapidmigrationassessment.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/migration-center", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/migration-center", - "preferred": true + "id": "rapidmigrationassessment:v1", + "kind": "discovery#directoryItem", + "name": "rapidmigrationassessment", + "preferred": true, + "title": "Rapid Migration Assessment API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "readerrevenuesubscriptionlinking:v1", - "name": "readerrevenuesubscriptionlinking", - "version": "v1", - "title": "Reader Revenue Subscription Linking API", "description": "readerrevenuesubscriptionlinking.googleapis.com API.", "discoveryRestUrl": "https://readerrevenuesubscriptionlinking.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://developers.google.com/news/subscribe/subscription-linking/overview", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://developers.google.com/news/subscribe/subscription-linking/overview", - "preferred": true + "id": "readerrevenuesubscriptionlinking:v1", + "kind": "discovery#directoryItem", + "name": "readerrevenuesubscriptionlinking", + "preferred": true, + "title": "Reader Revenue Subscription Linking API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "realtimebidding:v1alpha", - "name": "realtimebidding", - "version": "v1alpha", - "title": "Real-time Bidding API", "description": "Allows external bidders to manage their RTB integration with Google. This includes managing bidder endpoints, QPS quotas, configuring what ad inventory to receive via pretargeting, submitting creatives for verification, and accessing creative metadata such as approval status.", "discoveryRestUrl": "https://realtimebidding.googleapis.com/$discovery/rest?version=v1alpha", + "documentationLink": "https://developers.google.com/authorized-buyers/apis/realtimebidding/reference/rest/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://developers.google.com/authorized-buyers/apis/realtimebidding/reference/rest/", - "preferred": false - }, - { + "id": "realtimebidding:v1alpha", "kind": "discovery#directoryItem", - "id": "realtimebidding:v1", "name": "realtimebidding", - "version": "v1", + "preferred": false, "title": "Real-time Bidding API", + "version": "v1alpha" + }, + { "description": "Allows external bidders to manage their RTB integration with Google. This includes managing bidder endpoints, QPS quotas, configuring what ad inventory to receive via pretargeting, submitting creatives for verification, and accessing creative metadata such as approval status.", "discoveryRestUrl": "https://realtimebidding.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://developers.google.com/authorized-buyers/apis/realtimebidding/reference/rest/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://developers.google.com/authorized-buyers/apis/realtimebidding/reference/rest/", - "preferred": true + "id": "realtimebidding:v1", + "kind": "discovery#directoryItem", + "name": "realtimebidding", + "preferred": true, + "title": "Real-time Bidding API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "recaptchaenterprise:v1", - "name": "recaptchaenterprise", - "version": "v1", - "title": "reCAPTCHA Enterprise API", "description": "Help protect your website from fraudulent activity, spam, and abuse without creating friction.", "discoveryRestUrl": "https://recaptchaenterprise.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/recaptcha-enterprise/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/recaptcha-enterprise/", - "preferred": true + "id": "recaptchaenterprise:v1", + "kind": "discovery#directoryItem", + "name": "recaptchaenterprise", + "preferred": true, + "title": "reCAPTCHA Enterprise API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "recommendationengine:v1beta1", - "name": "recommendationengine", - "version": "v1beta1", - "title": "Recommendations AI (Beta)", "description": "Note that we now highly recommend new customers to use Retail API, which incorporates the GA version of the Recommendations AI funtionalities. To enable Retail API, please visit https://console.cloud.google.com/apis/library/retail.googleapis.com. The Recommendations AI service enables customers to build end-to-end personalized recommendation systems without requiring a high level of expertise in machine learning, recommendation system, or Google Cloud.", "discoveryRestUrl": "https://recommendationengine.googleapis.com/$discovery/rest?version=v1beta1", + "documentationLink": "https://cloud.google.com/recommendations-ai/docs", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/recommendations-ai/docs", - "preferred": true + "id": "recommendationengine:v1beta1", + "kind": "discovery#directoryItem", + "name": "recommendationengine", + "preferred": true, + "title": "Recommendations AI (Beta)", + "version": "v1beta1" }, { - "kind": "discovery#directoryItem", - "id": "recommender:v1beta1", - "name": "recommender", - "version": "v1beta1", - "title": "Recommender API", "description": "", "discoveryRestUrl": "https://recommender.googleapis.com/$discovery/rest?version=v1beta1", + "documentationLink": "https://cloud.google.com/recommender/docs/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/recommender/docs/", - "preferred": false - }, - { + "id": "recommender:v1beta1", "kind": "discovery#directoryItem", - "id": "recommender:v1", "name": "recommender", - "version": "v1", + "preferred": false, "title": "Recommender API", + "version": "v1beta1" + }, + { "description": "", "discoveryRestUrl": "https://recommender.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/recommender/docs/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/recommender/docs/", - "preferred": true + "id": "recommender:v1", + "kind": "discovery#directoryItem", + "name": "recommender", + "preferred": true, + "title": "Recommender API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "redis:v1beta1", - "name": "redis", - "version": "v1beta1", - "title": "Google Cloud Memorystore for Redis API", "description": "Creates and manages Redis instances on the Google Cloud Platform.", "discoveryRestUrl": "https://redis.googleapis.com/$discovery/rest?version=v1beta1", + "documentationLink": "https://cloud.google.com/memorystore/docs/redis/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/memorystore/docs/redis/", - "preferred": false - }, - { + "id": "redis:v1beta1", "kind": "discovery#directoryItem", - "id": "redis:v1", "name": "redis", - "version": "v1", + "preferred": false, "title": "Google Cloud Memorystore for Redis API", + "version": "v1beta1" + }, + { "description": "Creates and manages Redis instances on the Google Cloud Platform.", "discoveryRestUrl": "https://redis.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/memorystore/docs/redis/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/memorystore/docs/redis/", - "preferred": true + "id": "redis:v1", + "kind": "discovery#directoryItem", + "name": "redis", + "preferred": true, + "title": "Google Cloud Memorystore for Redis API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "reseller:v1", - "name": "reseller", - "version": "v1", - "title": "Google Workspace Reseller API", "description": "Perform common functions that are available on the Channel Services console at scale, like placing orders and viewing customer information", "discoveryRestUrl": "https://reseller.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://developers.google.com/google-apps/reseller/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://developers.google.com/google-apps/reseller/", - "preferred": true + "id": "reseller:v1", + "kind": "discovery#directoryItem", + "name": "reseller", + "preferred": true, + "title": "Google Workspace Reseller API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "resourcesettings:v1", - "name": "resourcesettings", - "version": "v1", - "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.", "discoveryRestUrl": "https://resourcesettings.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/resource-manager/docs/resource-settings/overview", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/resource-manager/docs/resource-settings/overview", - "preferred": true + "id": "resourcesettings:v1", + "kind": "discovery#directoryItem", + "name": "resourcesettings", + "preferred": true, + "title": "Resource Settings API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "retail:v2alpha", - "name": "retail", - "version": "v2alpha", - "title": "Vertex AI Search for Retail API", "description": "Vertex AI Search for Retail 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.", "discoveryRestUrl": "https://retail.googleapis.com/$discovery/rest?version=v2alpha", + "documentationLink": "https://cloud.google.com/recommendations", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/recommendations", - "preferred": false - }, - { + "id": "retail:v2alpha", "kind": "discovery#directoryItem", - "id": "retail:v2beta", "name": "retail", - "version": "v2beta", + "preferred": false, "title": "Vertex AI Search for Retail API", + "version": "v2alpha" + }, + { "description": "Vertex AI Search for Retail 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.", "discoveryRestUrl": "https://retail.googleapis.com/$discovery/rest?version=v2beta", + "documentationLink": "https://cloud.google.com/recommendations", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/recommendations", - "preferred": false - }, - { + "id": "retail:v2beta", "kind": "discovery#directoryItem", - "id": "retail:v2", "name": "retail", - "version": "v2", + "preferred": false, "title": "Vertex AI Search for Retail API", + "version": "v2beta" + }, + { "description": "Vertex AI Search for Retail 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.", "discoveryRestUrl": "https://retail.googleapis.com/$discovery/rest?version=v2", + "documentationLink": "https://cloud.google.com/recommendations", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/recommendations", - "preferred": true + "id": "retail:v2", + "kind": "discovery#directoryItem", + "name": "retail", + "preferred": true, + "title": "Vertex AI Search for Retail API", + "version": "v2" }, { - "kind": "discovery#directoryItem", - "id": "run:v1", - "name": "run", - "version": "v1", - "title": "Cloud Run Admin API", "description": "Deploy and manage user provided container images that scale automatically based on incoming requests. The Cloud Run Admin API v1 follows the Knative Serving API specification, while v2 is aligned with Google Cloud AIP-based API standards, as described in https://google.aip.dev/.", "discoveryRestUrl": "https://run.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/run/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/run/", - "preferred": false - }, - { + "id": "run:v1", "kind": "discovery#directoryItem", - "id": "run:v2", "name": "run", - "version": "v2", + "preferred": false, "title": "Cloud Run Admin API", + "version": "v1" + }, + { "description": "Deploy and manage user provided container images that scale automatically based on incoming requests. The Cloud Run Admin API v1 follows the Knative Serving API specification, while v2 is aligned with Google Cloud AIP-based API standards, as described in https://google.aip.dev/.", "discoveryRestUrl": "https://run.googleapis.com/$discovery/rest?version=v2", + "documentationLink": "https://cloud.google.com/run/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/run/", - "preferred": true + "id": "run:v2", + "kind": "discovery#directoryItem", + "name": "run", + "preferred": true, + "title": "Cloud Run Admin API", + "version": "v2" }, { - "kind": "discovery#directoryItem", - "id": "runtimeconfig:v1beta1", - "name": "runtimeconfig", - "version": "v1beta1", - "title": "Cloud Runtime Configuration API", "description": "The Runtime Configurator allows you to dynamically configure and expose variables through Google Cloud Platform. In addition, you can also set Watchers and Waiters that will watch for changes to your data and return based on certain conditions.", "discoveryRestUrl": "https://runtimeconfig.googleapis.com/$discovery/rest?version=v1beta1", + "documentationLink": "https://cloud.google.com/deployment-manager/runtime-configurator/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/deployment-manager/runtime-configurator/", - "preferred": false - }, - { + "id": "runtimeconfig:v1beta1", "kind": "discovery#directoryItem", - "id": "runtimeconfig:v1", "name": "runtimeconfig", - "version": "v1", + "preferred": false, "title": "Cloud Runtime Configuration API", + "version": "v1beta1" + }, + { "description": "The Runtime Configurator allows you to dynamically configure and expose variables through Google Cloud Platform. In addition, you can also set Watchers and Waiters that will watch for changes to your data and return based on certain conditions.", "discoveryRestUrl": "https://runtimeconfig.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/deployment-manager/runtime-configurator/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/deployment-manager/runtime-configurator/", - "preferred": true + "id": "runtimeconfig:v1", + "kind": "discovery#directoryItem", + "name": "runtimeconfig", + "preferred": true, + "title": "Cloud Runtime Configuration API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "safebrowsing:v4", - "name": "safebrowsing", - "version": "v4", - "title": "Safe Browsing API", "description": "Enables client applications to check web resources (most commonly URLs) against Google-generated lists of unsafe web resources. The Safe Browsing APIs are for non-commercial use only. If you need to use APIs to detect malicious URLs for commercial purposes – meaning “for sale or revenue-generating purposes” – please refer to the Web Risk API.", "discoveryRestUrl": "https://safebrowsing.googleapis.com/$discovery/rest?version=v4", + "documentationLink": "https://developers.google.com/safe-browsing/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://developers.google.com/safe-browsing/", - "preferred": false - }, - { + "id": "safebrowsing:v4", "kind": "discovery#directoryItem", - "id": "safebrowsing:v5", "name": "safebrowsing", - "version": "v5", + "preferred": false, "title": "Safe Browsing API", + "version": "v4" + }, + { "description": "Enables client applications to check web resources (most commonly URLs) against Google-generated lists of unsafe web resources. The Safe Browsing APIs are for non-commercial use only. If you need to use APIs to detect malicious URLs for commercial purposes – meaning “for sale or revenue-generating purposes” – please refer to the Web Risk API.", "discoveryRestUrl": "https://safebrowsing.googleapis.com/$discovery/rest?version=v5", + "documentationLink": "https://developers.google.com/safe-browsing/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://developers.google.com/safe-browsing/", - "preferred": true + "id": "safebrowsing:v5", + "kind": "discovery#directoryItem", + "name": "safebrowsing", + "preferred": true, + "title": "Safe Browsing API", + "version": "v5" }, { - "kind": "discovery#directoryItem", - "id": "sasportal:v1alpha1", - "name": "sasportal", - "version": "v1alpha1", - "title": "SAS Portal API", "description": "", "discoveryRestUrl": "https://sasportal.googleapis.com/$discovery/rest?version=v1alpha1", + "documentationLink": "https://developers.google.com/spectrum-access-system/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://developers.google.com/spectrum-access-system/", - "preferred": true + "id": "sasportal:v1alpha1", + "kind": "discovery#directoryItem", + "name": "sasportal", + "preferred": true, + "title": "SAS Portal API", + "version": "v1alpha1" }, { - "kind": "discovery#directoryItem", - "id": "script:v1", - "name": "script", - "version": "v1", - "title": "Apps Script API", "description": "Manages and executes Google Apps Script projects.", "discoveryRestUrl": "https://script.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://developers.google.com/apps-script/api/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://developers.google.com/apps-script/api/", - "preferred": true + "id": "script:v1", + "kind": "discovery#directoryItem", + "name": "script", + "preferred": true, + "title": "Apps Script API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "searchads360:v0", - "name": "searchads360", - "version": "v0", - "title": "Search Ads 360 Reporting API", "description": "The Search Ads 360 API allows developers to automate downloading reports from Search Ads 360.", "discoveryRestUrl": "https://searchads360.googleapis.com/$discovery/rest?version=v0", + "documentationLink": "https://developers.google.com/search-ads/reporting", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://developers.google.com/search-ads/reporting", - "preferred": true + "id": "searchads360:v0", + "kind": "discovery#directoryItem", + "name": "searchads360", + "preferred": true, + "title": "Search Ads 360 Reporting API", + "version": "v0" }, { - "kind": "discovery#directoryItem", - "id": "searchconsole:v1", - "name": "searchconsole", - "version": "v1", - "title": "Google Search Console API", "description": "The Search Console API provides access to both Search Console data (verified users only) and to public information on an URL basis (anyone)", "discoveryRestUrl": "https://searchconsole.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://developers.google.com/webmaster-tools/about", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://developers.google.com/webmaster-tools/search-console-api/", - "preferred": true + "id": "searchconsole:v1", + "kind": "discovery#directoryItem", + "name": "searchconsole", + "preferred": true, + "title": "Google Search Console API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "secretmanager:v1beta1", - "name": "secretmanager", - "version": "v1beta1", - "title": "Secret Manager API", "description": "Stores sensitive data such as API keys, passwords, and certificates. Provides convenience while improving security.", "discoveryRestUrl": "https://secretmanager.googleapis.com/$discovery/rest?version=v1beta1", + "documentationLink": "https://cloud.google.com/secret-manager/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", - "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" - }, - "documentationLink": "https://cloud.google.com/secret-manager/", - "preferred": false - }, - { + "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" + }, + "id": "secretmanager:v1beta1", "kind": "discovery#directoryItem", - "id": "secretmanager:v1beta2", "name": "secretmanager", - "version": "v1beta2", + "preferred": false, "title": "Secret Manager API", + "version": "v1beta1" + }, + { "description": "Stores sensitive data such as API keys, passwords, and certificates. Provides convenience while improving security.", "discoveryRestUrl": "https://secretmanager.googleapis.com/$discovery/rest?version=v1beta2", + "documentationLink": "https://cloud.google.com/secret-manager/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/secret-manager/", - "preferred": false - }, - { + "id": "secretmanager:v1beta2", "kind": "discovery#directoryItem", - "id": "secretmanager:v1", "name": "secretmanager", - "version": "v1", + "preferred": false, "title": "Secret Manager API", + "version": "v1beta2" + }, + { "description": "Stores sensitive data such as API keys, passwords, and certificates. Provides convenience while improving security.", "discoveryRestUrl": "https://secretmanager.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/secret-manager/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/secret-manager/", - "preferred": true + "id": "secretmanager:v1", + "kind": "discovery#directoryItem", + "name": "secretmanager", + "preferred": true, + "title": "Secret Manager API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "securitycenter:v1beta1", - "name": "securitycenter", - "version": "v1beta1", - "title": "Security Command Center API", "description": "Security Command Center API provides access to temporal views of assets and findings within an organization.", "discoveryRestUrl": "https://securitycenter.googleapis.com/$discovery/rest?version=v1beta1", + "documentationLink": "https://cloud.google.com/security-command-center", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/security-command-center", - "preferred": false - }, - { + "id": "securitycenter:v1beta1", "kind": "discovery#directoryItem", - "id": "securitycenter:v1beta2", "name": "securitycenter", - "version": "v1beta2", + "preferred": false, "title": "Security Command Center API", + "version": "v1beta1" + }, + { "description": "Security Command Center API provides access to temporal views of assets and findings within an organization.", "discoveryRestUrl": "https://securitycenter.googleapis.com/$discovery/rest?version=v1beta2", + "documentationLink": "https://cloud.google.com/security-command-center", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/security-command-center", - "preferred": false - }, - { + "id": "securitycenter:v1beta2", "kind": "discovery#directoryItem", - "id": "securitycenter:v1", "name": "securitycenter", - "version": "v1", + "preferred": false, "title": "Security Command Center API", + "version": "v1beta2" + }, + { "description": "Security Command Center API provides access to temporal views of assets and findings within an organization.", "discoveryRestUrl": "https://securitycenter.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/security-command-center", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/security-command-center", - "preferred": true + "id": "securitycenter:v1", + "kind": "discovery#directoryItem", + "name": "securitycenter", + "preferred": true, + "title": "Security Command Center API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "serviceconsumermanagement:v1beta1", - "name": "serviceconsumermanagement", - "version": "v1beta1", - "title": "Service Consumer Management API", "description": "Manages the service consumers of a Service Infrastructure service.", "discoveryRestUrl": "https://serviceconsumermanagement.googleapis.com/$discovery/rest?version=v1beta1", + "documentationLink": "https://cloud.google.com/service-consumer-management/docs/overview", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/service-consumer-management/docs/overview", - "preferred": false - }, - { + "id": "serviceconsumermanagement:v1beta1", "kind": "discovery#directoryItem", - "id": "serviceconsumermanagement:v1", "name": "serviceconsumermanagement", - "version": "v1", + "preferred": false, "title": "Service Consumer Management API", + "version": "v1beta1" + }, + { "description": "Manages the service consumers of a Service Infrastructure service.", "discoveryRestUrl": "https://serviceconsumermanagement.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/service-consumer-management/docs/overview", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/service-consumer-management/docs/overview", - "preferred": true + "id": "serviceconsumermanagement:v1", + "kind": "discovery#directoryItem", + "name": "serviceconsumermanagement", + "preferred": true, + "title": "Service Consumer Management API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "servicecontrol:v1", - "name": "servicecontrol", - "version": "v1", - "title": "Service Control API", "description": "Provides admission control and telemetry reporting for services integrated with Service Infrastructure.", "discoveryRestUrl": "https://servicecontrol.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/service-control/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/service-control/", - "preferred": false - }, - { + "id": "servicecontrol:v1", "kind": "discovery#directoryItem", - "id": "servicecontrol:v2", "name": "servicecontrol", - "version": "v2", + "preferred": false, "title": "Service Control API", + "version": "v1" + }, + { "description": "Provides admission control and telemetry reporting for services integrated with Service Infrastructure.", "discoveryRestUrl": "https://servicecontrol.googleapis.com/$discovery/rest?version=v2", + "documentationLink": "https://cloud.google.com/service-control/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/service-control/", - "preferred": true + "id": "servicecontrol:v2", + "kind": "discovery#directoryItem", + "name": "servicecontrol", + "preferred": true, + "title": "Service Control API", + "version": "v2" }, { - "kind": "discovery#directoryItem", - "id": "servicedirectory:v1beta1", - "name": "servicedirectory", - "version": "v1beta1", - "title": "Service Directory API", "description": "Service Directory is a platform for discovering, publishing, and connecting services.", "discoveryRestUrl": "https://servicedirectory.googleapis.com/$discovery/rest?version=v1beta1", + "documentationLink": "https://cloud.google.com/service-directory", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/service-directory", - "preferred": false - }, - { + "id": "servicedirectory:v1beta1", "kind": "discovery#directoryItem", - "id": "servicedirectory:v1", "name": "servicedirectory", - "version": "v1", + "preferred": false, "title": "Service Directory API", + "version": "v1beta1" + }, + { "description": "Service Directory is a platform for discovering, publishing, and connecting services.", "discoveryRestUrl": "https://servicedirectory.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/service-directory", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/service-directory", - "preferred": true + "id": "servicedirectory:v1", + "kind": "discovery#directoryItem", + "name": "servicedirectory", + "preferred": true, + "title": "Service Directory API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "servicemanagement:v1", - "name": "servicemanagement", - "version": "v1", - "title": "Service Management API", "description": "Google Service Management allows service producers to publish their services on Google Cloud Platform so that they can be discovered and used by service consumers.", "discoveryRestUrl": "https://servicemanagement.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/service-management/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/service-management/", - "preferred": true + "id": "servicemanagement:v1", + "kind": "discovery#directoryItem", + "name": "servicemanagement", + "preferred": true, + "title": "Service Management API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "servicenetworking:v1beta", - "name": "servicenetworking", - "version": "v1beta", - "title": "Service Networking API", "description": "Provides automatic management of network configurations necessary for certain services.", "discoveryRestUrl": "https://servicenetworking.googleapis.com/$discovery/rest?version=v1beta", + "documentationLink": "https://cloud.google.com/service-infrastructure/docs/service-networking/getting-started", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/service-infrastructure/docs/service-networking/getting-started", - "preferred": false - }, - { + "id": "servicenetworking:v1beta", "kind": "discovery#directoryItem", - "id": "servicenetworking:v1", "name": "servicenetworking", - "version": "v1", + "preferred": false, "title": "Service Networking API", + "version": "v1beta" + }, + { "description": "Provides automatic management of network configurations necessary for certain services.", "discoveryRestUrl": "https://servicenetworking.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/service-infrastructure/docs/service-networking/getting-started", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/service-infrastructure/docs/service-networking/getting-started", - "preferred": true + "id": "servicenetworking:v1", + "kind": "discovery#directoryItem", + "name": "servicenetworking", + "preferred": true, + "title": "Service Networking API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "serviceusage:v1beta1", - "name": "serviceusage", - "version": "v1beta1", - "title": "Service Usage API", "description": "Enables services that service consumers want to use on Google Cloud Platform, lists the available or enabled services, or disables services that service consumers no longer use.", "discoveryRestUrl": "https://serviceusage.googleapis.com/$discovery/rest?version=v1beta1", + "documentationLink": "https://cloud.google.com/service-usage/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/service-usage/", - "preferred": false - }, - { + "id": "serviceusage:v1beta1", "kind": "discovery#directoryItem", - "id": "serviceusage:v1", "name": "serviceusage", - "version": "v1", + "preferred": false, "title": "Service Usage API", + "version": "v1beta1" + }, + { "description": "Enables services that service consumers want to use on Google Cloud Platform, lists the available or enabled services, or disables services that service consumers no longer use.", "discoveryRestUrl": "https://serviceusage.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/service-usage/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/service-usage/", - "preferred": true + "id": "serviceusage:v1", + "kind": "discovery#directoryItem", + "name": "serviceusage", + "preferred": true, + "title": "Service Usage API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "sheets:v4", - "name": "sheets", - "version": "v4", - "title": "Google Sheets API", "description": "Reads and writes Google Sheets.", "discoveryRestUrl": "https://sheets.googleapis.com/$discovery/rest?version=v4", + "documentationLink": "https://developers.google.com/sheets/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://developers.google.com/sheets/", - "preferred": true + "id": "sheets:v4", + "kind": "discovery#directoryItem", + "name": "sheets", + "preferred": true, + "title": "Google Sheets API", + "version": "v4" }, { - "kind": "discovery#directoryItem", - "id": "siteVerification:v1", - "name": "siteVerification", - "version": "v1", - "title": "Site Verification API", "description": "The Google Site Verification API lets applications automate the process of managing ownership records for websites and domains.", "discoveryRestUrl": "https://siteverification.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://code.google.com/apis/siteverification/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://code.google.com/apis/siteverification/", - "preferred": true + "id": "siteVerification:v1", + "kind": "discovery#directoryItem", + "name": "siteVerification", + "preferred": true, + "title": "Site Verification API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "slides:v1", - "name": "slides", - "version": "v1", - "title": "Google Slides API", "description": "Reads and writes Google Slides presentations.", "discoveryRestUrl": "https://slides.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://developers.google.com/slides/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://developers.google.com/slides/", - "preferred": true + "id": "slides:v1", + "kind": "discovery#directoryItem", + "name": "slides", + "preferred": true, + "title": "Google Slides API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "smartdevicemanagement:v1", - "name": "smartdevicemanagement", - "version": "v1", - "title": "Smart Device Management API", "description": "Allow select enterprise partners to access, control, and manage Google and Nest devices programmatically.", "discoveryRestUrl": "https://smartdevicemanagement.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://developers.google.com/nest/device-access", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://developers.google.com/nest/device-access", - "preferred": true + "id": "smartdevicemanagement:v1", + "kind": "discovery#directoryItem", + "name": "smartdevicemanagement", + "preferred": true, + "title": "Smart Device Management API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "solar:v1", - "name": "solar", - "version": "v1", - "title": "Solar API", "description": "Solar API.", "discoveryRestUrl": "https://solar.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://developers.google.com/maps/documentation/solar", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://developers.google.com/maps/documentation/solar", - "preferred": true + "id": "solar:v1", + "kind": "discovery#directoryItem", + "name": "solar", + "preferred": true, + "title": "Solar API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "spanner:v1", - "name": "spanner", - "version": "v1", - "title": "Cloud Spanner API", "description": "Cloud Spanner is a managed, mission-critical, globally consistent and scalable relational database service.", "discoveryRestUrl": "https://spanner.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/spanner/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/spanner/", - "preferred": true + "id": "spanner:v1", + "kind": "discovery#directoryItem", + "name": "spanner", + "preferred": true, + "title": "Cloud Spanner API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "speech:v1p1beta1", - "name": "speech", - "version": "v1p1beta1", - "title": "Cloud Speech-to-Text API", "description": "Converts audio to text by applying powerful neural network models.", "discoveryRestUrl": "https://speech.googleapis.com/$discovery/rest?version=v1p1beta1", + "documentationLink": "https://cloud.google.com/speech-to-text/docs/quickstart-protocol", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/speech-to-text/docs/quickstart-protocol", - "preferred": false - }, - { + "id": "speech:v1p1beta1", "kind": "discovery#directoryItem", - "id": "speech:v1", "name": "speech", - "version": "v1", + "preferred": false, "title": "Cloud Speech-to-Text API", + "version": "v1p1beta1" + }, + { "description": "Converts audio to text by applying powerful neural network models.", "discoveryRestUrl": "https://speech.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/speech-to-text/docs/quickstart-protocol", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/speech-to-text/docs/quickstart-protocol", - "preferred": true + "id": "speech:v1", + "kind": "discovery#directoryItem", + "name": "speech", + "preferred": true, + "title": "Cloud Speech-to-Text API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "sqladmin:v1beta4", - "name": "sqladmin", - "version": "v1beta4", - "title": "Cloud SQL Admin API", "description": "API for Cloud SQL database instance management", "discoveryRestUrl": "https://sqladmin.googleapis.com/$discovery/rest?version=v1beta4", + "documentationLink": "https://developers.google.com/cloud-sql/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://developers.google.com/cloud-sql/", - "preferred": false - }, - { + "id": "sqladmin:v1beta4", "kind": "discovery#directoryItem", - "id": "sqladmin:v1", "name": "sqladmin", - "version": "v1", + "preferred": false, "title": "Cloud SQL Admin API", + "version": "v1beta4" + }, + { "description": "API for Cloud SQL database instance management", "discoveryRestUrl": "https://sqladmin.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://developers.google.com/cloud-sql/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://developers.google.com/cloud-sql/", - "preferred": true + "id": "sqladmin:v1", + "kind": "discovery#directoryItem", + "name": "sqladmin", + "preferred": true, + "title": "Cloud SQL Admin API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "storage:v1", - "name": "storage", - "version": "v1", - "title": "Cloud Storage API", "description": "Lets you store and retrieve potentially-large, immutable data objects.", "discoveryRestUrl": "https://storage.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/storage/docs/apis", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/storage/docs/apis", - "preferred": true - }, - { + "id": "storage:v1", "kind": "discovery#directoryItem", - "id": "storagetransfer:v1", - "name": "storagetransfer", - "version": "v1", - "title": "Storage Transfer API", + "name": "storage", + "preferred": true, + "title": "Cloud Storage API", + "version": "v1" + }, + { "description": "Transfers data from external data sources to a Google Cloud Storage bucket or between Google Cloud Storage buckets.", "discoveryRestUrl": "https://storagetransfer.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/storage-transfer/docs", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/storage-transfer/docs", - "preferred": true + "id": "storagetransfer:v1", + "kind": "discovery#directoryItem", + "name": "storagetransfer", + "preferred": true, + "title": "Storage Transfer API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "streetviewpublish:v1", - "name": "streetviewpublish", - "version": "v1", - "title": "Street View Publish API", "description": "Publishes 360 photos to Google Maps, along with position, orientation, and connectivity metadata. Apps can offer an interface for positioning, connecting, and uploading user-generated Street View images.", "discoveryRestUrl": "https://streetviewpublish.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://developers.google.com/streetview/publish/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://developers.google.com/streetview/publish/", - "preferred": true + "id": "streetviewpublish:v1", + "kind": "discovery#directoryItem", + "name": "streetviewpublish", + "preferred": true, + "title": "Street View Publish API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "sts:v1beta", - "name": "sts", - "version": "v1beta", - "title": "Security Token Service API", "description": "The Security Token Service exchanges Google or third-party credentials for a short-lived access token to Google Cloud resources.", "discoveryRestUrl": "https://sts.googleapis.com/$discovery/rest?version=v1beta", + "documentationLink": "http://cloud.google.com/iam/docs/workload-identity-federation", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "http://cloud.google.com/iam/docs/workload-identity-federation", - "preferred": false - }, - { + "id": "sts:v1beta", "kind": "discovery#directoryItem", - "id": "sts:v1", "name": "sts", - "version": "v1", + "preferred": false, "title": "Security Token Service API", + "version": "v1beta" + }, + { "description": "The Security Token Service exchanges Google or third-party credentials for a short-lived access token to Google Cloud resources.", "discoveryRestUrl": "https://sts.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "http://cloud.google.com/iam/docs/workload-identity-federation", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "http://cloud.google.com/iam/docs/workload-identity-federation", - "preferred": true + "id": "sts:v1", + "kind": "discovery#directoryItem", + "name": "sts", + "preferred": true, + "title": "Security Token Service API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "tagmanager:v1", - "name": "tagmanager", - "version": "v1", - "title": "Tag Manager API", "description": "This API allows clients to access and modify container and tag configuration.", "discoveryRestUrl": "https://tagmanager.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://developers.google.com/tag-manager", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://developers.google.com/tag-manager", - "preferred": false - }, - { + "id": "tagmanager:v1", "kind": "discovery#directoryItem", - "id": "tagmanager:v2", "name": "tagmanager", - "version": "v2", + "preferred": false, "title": "Tag Manager API", + "version": "v1" + }, + { "description": "This API allows clients to access and modify container and tag configuration.", "discoveryRestUrl": "https://tagmanager.googleapis.com/$discovery/rest?version=v2", + "documentationLink": "https://developers.google.com/tag-manager", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://developers.google.com/tag-manager", - "preferred": true + "id": "tagmanager:v2", + "kind": "discovery#directoryItem", + "name": "tagmanager", + "preferred": true, + "title": "Tag Manager API", + "version": "v2" }, { - "kind": "discovery#directoryItem", - "id": "tasks:v1", - "name": "tasks", - "version": "v1", - "title": "Google Tasks API", "description": "The Google Tasks API lets you manage your tasks and task lists.", "discoveryRestUrl": "https://tasks.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://developers.google.com/tasks/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://developers.google.com/tasks/", - "preferred": true + "id": "tasks:v1", + "kind": "discovery#directoryItem", + "name": "tasks", + "preferred": true, + "title": "Google Tasks API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "testing:v1", - "name": "testing", - "version": "v1", - "title": "Cloud Testing API", "description": "Allows developers to run automated tests for their mobile applications on Google infrastructure.", "discoveryRestUrl": "https://testing.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://firebase.google.com/docs/test-lab/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://firebase.google.com/docs/test-lab/", - "preferred": true + "id": "testing:v1", + "kind": "discovery#directoryItem", + "name": "testing", + "preferred": true, + "title": "Cloud Testing API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "texttospeech:v1beta1", - "name": "texttospeech", - "version": "v1beta1", - "title": "Cloud Text-to-Speech API", "description": "Synthesizes natural-sounding speech by applying powerful neural network models.", "discoveryRestUrl": "https://texttospeech.googleapis.com/$discovery/rest?version=v1beta1", + "documentationLink": "https://cloud.google.com/text-to-speech/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/text-to-speech/", - "preferred": false - }, - { + "id": "texttospeech:v1beta1", "kind": "discovery#directoryItem", - "id": "texttospeech:v1", "name": "texttospeech", - "version": "v1", + "preferred": false, "title": "Cloud Text-to-Speech API", + "version": "v1beta1" + }, + { "description": "Synthesizes natural-sounding speech by applying powerful neural network models.", "discoveryRestUrl": "https://texttospeech.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/text-to-speech/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/text-to-speech/", - "preferred": true + "id": "texttospeech:v1", + "kind": "discovery#directoryItem", + "name": "texttospeech", + "preferred": true, + "title": "Cloud Text-to-Speech API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "toolresults:v1beta3", - "name": "toolresults", - "version": "v1beta3", - "title": "Cloud Tool Results API", "description": "API to publish and access results from developer tools.", "discoveryRestUrl": "https://toolresults.googleapis.com/$discovery/rest?version=v1beta3", + "documentationLink": "https://firebase.google.com/docs/test-lab/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://firebase.google.com/docs/test-lab/", - "preferred": true + "id": "toolresults:v1beta3", + "kind": "discovery#directoryItem", + "name": "toolresults", + "preferred": true, + "title": "Cloud Tool Results API", + "version": "v1beta3" }, { - "kind": "discovery#directoryItem", - "id": "tpu:v1alpha1", - "name": "tpu", - "version": "v1alpha1", - "title": "Cloud TPU API", "description": "TPU API provides customers with access to Google TPU technology.", "discoveryRestUrl": "https://tpu.googleapis.com/$discovery/rest?version=v1alpha1", + "documentationLink": "https://cloud.google.com/tpu/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/tpu/", - "preferred": false - }, - { + "id": "tpu:v1alpha1", "kind": "discovery#directoryItem", - "id": "tpu:v2alpha1", "name": "tpu", - "version": "v2alpha1", + "preferred": false, "title": "Cloud TPU API", + "version": "v1alpha1" + }, + { "description": "TPU API provides customers with access to Google TPU technology.", "discoveryRestUrl": "https://tpu.googleapis.com/$discovery/rest?version=v2alpha1", + "documentationLink": "https://cloud.google.com/tpu/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/tpu/", - "preferred": false - }, - { + "id": "tpu:v2alpha1", "kind": "discovery#directoryItem", - "id": "tpu:v1", "name": "tpu", - "version": "v1", + "preferred": false, "title": "Cloud TPU API", + "version": "v2alpha1" + }, + { "description": "TPU API provides customers with access to Google TPU technology.", "discoveryRestUrl": "https://tpu.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/tpu/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/tpu/", - "preferred": false - }, - { + "id": "tpu:v1", "kind": "discovery#directoryItem", - "id": "tpu:v2", "name": "tpu", - "version": "v2", + "preferred": false, "title": "Cloud TPU API", + "version": "v1" + }, + { "description": "TPU API provides customers with access to Google TPU technology.", "discoveryRestUrl": "https://tpu.googleapis.com/$discovery/rest?version=v2", + "documentationLink": "https://cloud.google.com/tpu/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/tpu/", - "preferred": true + "id": "tpu:v2", + "kind": "discovery#directoryItem", + "name": "tpu", + "preferred": true, + "title": "Cloud TPU API", + "version": "v2" }, { - "kind": "discovery#directoryItem", - "id": "trafficdirector:v2", - "name": "trafficdirector", - "version": "v2", - "title": "Traffic Director API", "description": "", "discoveryRestUrl": "https://trafficdirector.googleapis.com/$discovery/rest?version=v2", + "documentationLink": "https://cloud.google.com/traffic-director", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/traffic-director", - "preferred": false - }, - { + "id": "trafficdirector:v2", "kind": "discovery#directoryItem", - "id": "trafficdirector:v3", "name": "trafficdirector", - "version": "v3", + "preferred": false, "title": "Traffic Director API", + "version": "v2" + }, + { "description": "", "discoveryRestUrl": "https://trafficdirector.googleapis.com/$discovery/rest?version=v3", + "documentationLink": "https://cloud.google.com/traffic-director", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/traffic-director", - "preferred": true + "id": "trafficdirector:v3", + "kind": "discovery#directoryItem", + "name": "trafficdirector", + "preferred": true, + "title": "Traffic Director API", + "version": "v3" }, { - "kind": "discovery#directoryItem", - "id": "transcoder:v1", - "name": "transcoder", - "version": "v1", - "title": "Transcoder API", "description": "This API converts video files into formats suitable for consumer distribution. For more information, see the Transcoder API overview .", "discoveryRestUrl": "https://transcoder.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/transcoder/docs/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/transcoder/docs/", - "preferred": true + "id": "transcoder:v1", + "kind": "discovery#directoryItem", + "name": "transcoder", + "preferred": true, + "title": "Transcoder API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "translate:v3beta1", - "name": "translate", - "version": "v3beta1", - "title": "Cloud Translation API", "description": "Integrates text translation into your website or application.", "discoveryRestUrl": "https://translation.googleapis.com/$discovery/rest?version=v3beta1", + "documentationLink": "https://cloud.google.com/translate/docs/quickstarts", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/translate/docs/quickstarts", - "preferred": false - }, - { + "id": "translate:v3beta1", "kind": "discovery#directoryItem", - "id": "translate:v2", "name": "translate", - "version": "v2", + "preferred": false, "title": "Cloud Translation API", + "version": "v3beta1" + }, + { "description": "Integrates text translation into your website or application.", "discoveryRestUrl": "https://translation.googleapis.com/$discovery/rest?version=v2", + "documentationLink": "https://cloud.google.com/translate/docs/quickstarts", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/translate/docs/quickstarts", - "preferred": false - }, - { + "id": "translate:v2", "kind": "discovery#directoryItem", - "id": "translate:v3", "name": "translate", - "version": "v3", + "preferred": false, "title": "Cloud Translation API", + "version": "v2" + }, + { "description": "Integrates text translation into your website or application.", "discoveryRestUrl": "https://translation.googleapis.com/$discovery/rest?version=v3", + "documentationLink": "https://cloud.google.com/translate/docs/quickstarts", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/translate/docs/quickstarts", - "preferred": true + "id": "translate:v3", + "kind": "discovery#directoryItem", + "name": "translate", + "preferred": true, + "title": "Cloud Translation API", + "version": "v3" }, { - "kind": "discovery#directoryItem", - "id": "travelimpactmodel:v1", - "name": "travelimpactmodel", - "version": "v1", - "title": "Travel Impact Model API", "description": "Travel Impact Model API lets you query travel carbon emission estimates.", "discoveryRestUrl": "https://travelimpactmodel.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://developers.google.com/travel/impact-model", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://developers.google.com/travel/impact-model", - "preferred": true + "id": "travelimpactmodel:v1", + "kind": "discovery#directoryItem", + "name": "travelimpactmodel", + "preferred": true, + "title": "Travel Impact Model API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "vault:v1", - "name": "vault", - "version": "v1", - "title": "Google Vault API", "description": "Retention and eDiscovery for Google Workspace. To work with Vault resources, the account must have the [required Vault privileges](https://support.google.com/vault/answer/2799699) and access to the matter. To access a matter, the account must have created the matter, have the matter shared with them, or have the **View All Matters** privilege. For example, to download an export, an account needs the **Manage Exports** privilege and the matter shared with them.", "discoveryRestUrl": "https://vault.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://developers.google.com/vault", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://developers.google.com/vault", - "preferred": true + "id": "vault:v1", + "kind": "discovery#directoryItem", + "name": "vault", + "preferred": true, + "title": "Google Vault API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "verifiedaccess:v1", - "name": "verifiedaccess", - "version": "v1", - "title": "Chrome Verified Access API", "description": "API for Verified Access chrome extension to provide credential verification for chrome devices connecting to an enterprise network", "discoveryRestUrl": "https://verifiedaccess.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://developers.google.com/chrome/verified-access", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://developers.google.com/chrome/verified-access", - "preferred": false - }, - { + "id": "verifiedaccess:v1", "kind": "discovery#directoryItem", - "id": "verifiedaccess:v2", "name": "verifiedaccess", - "version": "v2", + "preferred": false, "title": "Chrome Verified Access API", + "version": "v1" + }, + { "description": "API for Verified Access chrome extension to provide credential verification for chrome devices connecting to an enterprise network", "discoveryRestUrl": "https://verifiedaccess.googleapis.com/$discovery/rest?version=v2", + "documentationLink": "https://developers.google.com/chrome/verified-access", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://developers.google.com/chrome/verified-access", - "preferred": true + "id": "verifiedaccess:v2", + "kind": "discovery#directoryItem", + "name": "verifiedaccess", + "preferred": true, + "title": "Chrome Verified Access API", + "version": "v2" }, { - "kind": "discovery#directoryItem", - "id": "versionhistory:v1", - "name": "versionhistory", - "version": "v1", - "title": "versionhistory.googleapis.com API", "description": "Version History API - Prod", "discoveryRestUrl": "https://versionhistory.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://developers.chrome.com/versionhistory", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://developers.chrome.com/versionhistory", - "preferred": true + "id": "versionhistory:v1", + "kind": "discovery#directoryItem", + "name": "versionhistory", + "preferred": true, + "title": "versionhistory.googleapis.com API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "videointelligence:v1p1beta1", - "name": "videointelligence", - "version": "v1p1beta1", - "title": "Cloud Video Intelligence API", "description": "Detects objects, explicit content, and scene changes in videos. It also specifies the region for annotation and transcribes speech to text. Supports both asynchronous API and streaming API.", "discoveryRestUrl": "https://videointelligence.googleapis.com/$discovery/rest?version=v1p1beta1", + "documentationLink": "https://cloud.google.com/video-intelligence/docs/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/video-intelligence/docs/", - "preferred": false - }, - { + "id": "videointelligence:v1p1beta1", "kind": "discovery#directoryItem", - "id": "videointelligence:v1p2beta1", "name": "videointelligence", - "version": "v1p2beta1", + "preferred": false, "title": "Cloud Video Intelligence API", + "version": "v1p1beta1" + }, + { "description": "Detects objects, explicit content, and scene changes in videos. It also specifies the region for annotation and transcribes speech to text. Supports both asynchronous API and streaming API.", "discoveryRestUrl": "https://videointelligence.googleapis.com/$discovery/rest?version=v1p2beta1", + "documentationLink": "https://cloud.google.com/video-intelligence/docs/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/video-intelligence/docs/", - "preferred": false - }, - { + "id": "videointelligence:v1p2beta1", "kind": "discovery#directoryItem", - "id": "videointelligence:v1p3beta1", "name": "videointelligence", - "version": "v1p3beta1", + "preferred": false, "title": "Cloud Video Intelligence API", + "version": "v1p2beta1" + }, + { "description": "Detects objects, explicit content, and scene changes in videos. It also specifies the region for annotation and transcribes speech to text. Supports both asynchronous API and streaming API.", "discoveryRestUrl": "https://videointelligence.googleapis.com/$discovery/rest?version=v1p3beta1", + "documentationLink": "https://cloud.google.com/video-intelligence/docs/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/video-intelligence/docs/", - "preferred": false - }, - { + "id": "videointelligence:v1p3beta1", "kind": "discovery#directoryItem", - "id": "videointelligence:v1beta2", "name": "videointelligence", - "version": "v1beta2", + "preferred": false, "title": "Cloud Video Intelligence API", + "version": "v1p3beta1" + }, + { "description": "Detects objects, explicit content, and scene changes in videos. It also specifies the region for annotation and transcribes speech to text. Supports both asynchronous API and streaming API.", "discoveryRestUrl": "https://videointelligence.googleapis.com/$discovery/rest?version=v1beta2", + "documentationLink": "https://cloud.google.com/video-intelligence/docs/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/video-intelligence/docs/", - "preferred": false - }, - { + "id": "videointelligence:v1beta2", "kind": "discovery#directoryItem", - "id": "videointelligence:v1", "name": "videointelligence", - "version": "v1", + "preferred": false, "title": "Cloud Video Intelligence API", + "version": "v1beta2" + }, + { "description": "Detects objects, explicit content, and scene changes in videos. It also specifies the region for annotation and transcribes speech to text. Supports both asynchronous API and streaming API.", "discoveryRestUrl": "https://videointelligence.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/video-intelligence/docs/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/video-intelligence/docs/", - "preferred": true + "id": "videointelligence:v1", + "kind": "discovery#directoryItem", + "name": "videointelligence", + "preferred": true, + "title": "Cloud Video Intelligence API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "vision:v1p1beta1", - "name": "vision", - "version": "v1p1beta1", - "title": "Cloud Vision API", "description": "Integrates Google Vision features, including image labeling, face, logo, and landmark detection, optical character recognition (OCR), and detection of explicit content, into applications.", "discoveryRestUrl": "https://vision.googleapis.com/$discovery/rest?version=v1p1beta1", + "documentationLink": "https://cloud.google.com/vision/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/vision/", - "preferred": false - }, - { + "id": "vision:v1p1beta1", "kind": "discovery#directoryItem", - "id": "vision:v1p2beta1", "name": "vision", - "version": "v1p2beta1", + "preferred": false, "title": "Cloud Vision API", + "version": "v1p1beta1" + }, + { "description": "Integrates Google Vision features, including image labeling, face, logo, and landmark detection, optical character recognition (OCR), and detection of explicit content, into applications.", "discoveryRestUrl": "https://vision.googleapis.com/$discovery/rest?version=v1p2beta1", + "documentationLink": "https://cloud.google.com/vision/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/vision/", - "preferred": false - }, - { + "id": "vision:v1p2beta1", "kind": "discovery#directoryItem", - "id": "vision:v1", "name": "vision", - "version": "v1", + "preferred": false, "title": "Cloud Vision API", + "version": "v1p2beta1" + }, + { "description": "Integrates Google Vision features, including image labeling, face, logo, and landmark detection, optical character recognition (OCR), and detection of explicit content, into applications.", "discoveryRestUrl": "https://vision.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/vision/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/vision/", - "preferred": true + "id": "vision:v1", + "kind": "discovery#directoryItem", + "name": "vision", + "preferred": true, + "title": "Cloud Vision API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "vmmigration:v1alpha1", - "name": "vmmigration", - "version": "v1alpha1", - "title": "VM Migration API", "description": "Use the Migrate to Virtual Machines API to programmatically migrate workloads.", "discoveryRestUrl": "https://vmmigration.googleapis.com/$discovery/rest?version=v1alpha1", + "documentationLink": "https://cloud.google.com/migrate/virtual-machines", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/migrate/virtual-machines", - "preferred": false - }, - { + "id": "vmmigration:v1alpha1", "kind": "discovery#directoryItem", - "id": "vmmigration:v1", "name": "vmmigration", - "version": "v1", + "preferred": false, "title": "VM Migration API", + "version": "v1alpha1" + }, + { "description": "Use the Migrate to Virtual Machines API to programmatically migrate workloads.", "discoveryRestUrl": "https://vmmigration.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/migrate/virtual-machines", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/migrate/virtual-machines", - "preferred": true + "id": "vmmigration:v1", + "kind": "discovery#directoryItem", + "name": "vmmigration", + "preferred": true, + "title": "VM Migration API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "vmwareengine:v1", - "name": "vmwareengine", - "version": "v1", - "title": "VMware Engine API", "description": "The Google VMware Engine API lets you programmatically manage VMware environments.", "discoveryRestUrl": "https://vmwareengine.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/solutions/vmware-as-a-service", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/solutions/vmware-as-a-service", - "preferred": true + "id": "vmwareengine:v1", + "kind": "discovery#directoryItem", + "name": "vmwareengine", + "preferred": true, + "title": "VMware Engine API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "vpcaccess:v1beta1", - "name": "vpcaccess", - "version": "v1beta1", - "title": "Serverless VPC Access API", "description": "API for managing VPC access connectors.", "discoveryRestUrl": "https://vpcaccess.googleapis.com/$discovery/rest?version=v1beta1", + "documentationLink": "https://cloud.google.com/vpc/docs/configure-serverless-vpc-access", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/vpc/docs/configure-serverless-vpc-access", - "preferred": false - }, - { + "id": "vpcaccess:v1beta1", "kind": "discovery#directoryItem", - "id": "vpcaccess:v1", "name": "vpcaccess", - "version": "v1", + "preferred": false, "title": "Serverless VPC Access API", + "version": "v1beta1" + }, + { "description": "API for managing VPC access connectors.", "discoveryRestUrl": "https://vpcaccess.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/vpc/docs/configure-serverless-vpc-access", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/vpc/docs/configure-serverless-vpc-access", - "preferred": true + "id": "vpcaccess:v1", + "kind": "discovery#directoryItem", + "name": "vpcaccess", + "preferred": true, + "title": "Serverless VPC Access API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "walletobjects:v1", - "name": "walletobjects", - "version": "v1", - "title": "Google Wallet API", "description": "API for issuers to save and manage Google Wallet Objects.", "discoveryRestUrl": "https://walletobjects.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://developers.google.com/pay/passes", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://developers.google.com/pay/passes", - "preferred": true + "id": "walletobjects:v1", + "kind": "discovery#directoryItem", + "name": "walletobjects", + "preferred": true, + "title": "Google Wallet API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "webfonts:v1", - "name": "webfonts", - "version": "v1", - "title": "Web Fonts Developer API", "description": "The Google Web Fonts Developer API lets you retrieve information about web fonts served by Google.", "discoveryRestUrl": "https://webfonts.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://developers.google.com/fonts/docs/developer_api", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://developers.google.com/fonts/docs/developer_api", - "preferred": true + "id": "webfonts:v1", + "kind": "discovery#directoryItem", + "name": "webfonts", + "preferred": true, + "title": "Web Fonts Developer API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "webrisk:v1", - "name": "webrisk", - "version": "v1", - "title": "Web Risk API", "description": "", "discoveryRestUrl": "https://webrisk.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/web-risk/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/web-risk/", - "preferred": true + "id": "webrisk:v1", + "kind": "discovery#directoryItem", + "name": "webrisk", + "preferred": true, + "title": "Web Risk API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "websecurityscanner:v1alpha", - "name": "websecurityscanner", - "version": "v1alpha", - "title": "Web Security Scanner API", "description": "Scans your Compute and App Engine apps for common web vulnerabilities.", "discoveryRestUrl": "https://websecurityscanner.googleapis.com/$discovery/rest?version=v1alpha", + "documentationLink": "https://cloud.google.com/security-command-center/docs/concepts-web-security-scanner-overview/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/security-command-center/docs/concepts-web-security-scanner-overview/", - "preferred": false - }, - { + "id": "websecurityscanner:v1alpha", "kind": "discovery#directoryItem", - "id": "websecurityscanner:v1beta", "name": "websecurityscanner", - "version": "v1beta", + "preferred": false, "title": "Web Security Scanner API", + "version": "v1alpha" + }, + { "description": "Scans your Compute and App Engine apps for common web vulnerabilities.", "discoveryRestUrl": "https://websecurityscanner.googleapis.com/$discovery/rest?version=v1beta", + "documentationLink": "https://cloud.google.com/security-command-center/docs/concepts-web-security-scanner-overview/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/security-command-center/docs/concepts-web-security-scanner-overview/", - "preferred": false - }, - { + "id": "websecurityscanner:v1beta", "kind": "discovery#directoryItem", - "id": "websecurityscanner:v1", "name": "websecurityscanner", - "version": "v1", + "preferred": false, "title": "Web Security Scanner API", + "version": "v1beta" + }, + { "description": "Scans your Compute and App Engine apps for common web vulnerabilities.", "discoveryRestUrl": "https://websecurityscanner.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/security-command-center/docs/concepts-web-security-scanner-overview/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/security-command-center/docs/concepts-web-security-scanner-overview/", - "preferred": true + "id": "websecurityscanner:v1", + "kind": "discovery#directoryItem", + "name": "websecurityscanner", + "preferred": true, + "title": "Web Security Scanner API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "workflowexecutions:v1beta", - "name": "workflowexecutions", - "version": "v1beta", - "title": "Workflow Executions API", "description": "Execute workflows created with Workflows API.", "discoveryRestUrl": "https://workflowexecutions.googleapis.com/$discovery/rest?version=v1beta", + "documentationLink": "https://cloud.google.com/workflows", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/workflows", - "preferred": false - }, - { + "id": "workflowexecutions:v1beta", "kind": "discovery#directoryItem", - "id": "workflowexecutions:v1", "name": "workflowexecutions", - "version": "v1", + "preferred": false, "title": "Workflow Executions API", + "version": "v1beta" + }, + { "description": "Execute workflows created with Workflows API.", "discoveryRestUrl": "https://workflowexecutions.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/workflows", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/workflows", - "preferred": true + "id": "workflowexecutions:v1", + "kind": "discovery#directoryItem", + "name": "workflowexecutions", + "preferred": true, + "title": "Workflow Executions API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "workflows:v1beta", - "name": "workflows", - "version": "v1beta", - "title": "Workflows API", "description": "Manage workflow definitions. To execute workflows and manage executions, see the Workflows Executions API.", "discoveryRestUrl": "https://workflows.googleapis.com/$discovery/rest?version=v1beta", + "documentationLink": "https://cloud.google.com/workflows", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/workflows", - "preferred": false - }, - { + "id": "workflows:v1beta", "kind": "discovery#directoryItem", - "id": "workflows:v1", "name": "workflows", - "version": "v1", + "preferred": false, "title": "Workflows API", + "version": "v1beta" + }, + { "description": "Manage workflow definitions. To execute workflows and manage executions, see the Workflows Executions API.", "discoveryRestUrl": "https://workflows.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/workflows", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/workflows", - "preferred": true + "id": "workflows:v1", + "kind": "discovery#directoryItem", + "name": "workflows", + "preferred": true, + "title": "Workflows API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "workloadmanager:v1", - "name": "workloadmanager", - "version": "v1", - "title": "Workload Manager API", "description": "Workload Manager is a service that provides tooling for enterprise workloads to automate the deployment and validation of your workloads against best practices and recommendations.", "discoveryRestUrl": "https://workloadmanager.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/workload-manager/docs", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/workload-manager/docs", - "preferred": true + "id": "workloadmanager:v1", + "kind": "discovery#directoryItem", + "name": "workloadmanager", + "preferred": true, + "title": "Workload Manager API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "workspaceevents:v1", - "name": "workspaceevents", - "version": "v1", - "title": "Google Workspace Events API", "description": "The Google Workspace Events API lets you subscribe to events and manage change notifications across Google Workspace applications.", "discoveryRestUrl": "https://workspaceevents.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://developers.google.com/workspace/events", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://developers.google.com/workspace/events", - "preferred": true + "id": "workspaceevents:v1", + "kind": "discovery#directoryItem", + "name": "workspaceevents", + "preferred": true, + "title": "Google Workspace Events API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "workstations:v1beta", - "name": "workstations", - "version": "v1beta", - "title": "Cloud Workstations API", "description": "Allows administrators to create managed developer environments in the cloud.", "discoveryRestUrl": "https://workstations.googleapis.com/$discovery/rest?version=v1beta", + "documentationLink": "https://cloud.google.com/workstations", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/workstations", - "preferred": false - }, - { + "id": "workstations:v1beta", "kind": "discovery#directoryItem", - "id": "workstations:v1", "name": "workstations", - "version": "v1", + "preferred": false, "title": "Cloud Workstations API", + "version": "v1beta" + }, + { "description": "Allows administrators to create managed developer environments in the cloud.", "discoveryRestUrl": "https://workstations.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/workstations", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://cloud.google.com/workstations", - "preferred": true + "id": "workstations:v1", + "kind": "discovery#directoryItem", + "name": "workstations", + "preferred": true, + "title": "Cloud Workstations API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "youtube:v3", - "name": "youtube", - "version": "v3", - "title": "YouTube Data API v3", "description": "The YouTube Data API v3 is an API that provides access to YouTube data, such as videos, playlists, and channels.", "discoveryRestUrl": "https://youtube.googleapis.com/$discovery/rest?version=v3", + "documentationLink": "https://developers.google.com/youtube/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://developers.google.com/youtube/", - "preferred": true + "id": "youtube:v3", + "kind": "discovery#directoryItem", + "name": "youtube", + "preferred": true, + "title": "YouTube Data API v3", + "version": "v3" }, { - "kind": "discovery#directoryItem", - "id": "youtubeAnalytics:v2", - "name": "youtubeAnalytics", - "version": "v2", - "title": "YouTube Analytics API", "description": "Retrieves your YouTube Analytics data.", "discoveryRestUrl": "https://youtubeanalytics.googleapis.com/$discovery/rest?version=v2", + "documentationLink": "https://developers.google.com/youtube/analytics", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://developers.google.com/youtube/analytics", - "preferred": true + "id": "youtubeAnalytics:v2", + "kind": "discovery#directoryItem", + "name": "youtubeAnalytics", + "preferred": true, + "title": "YouTube Analytics API", + "version": "v2" }, { - "kind": "discovery#directoryItem", - "id": "youtubereporting:v1", - "name": "youtubereporting", - "version": "v1", - "title": "YouTube Reporting API", "description": "Schedules reporting jobs containing your YouTube Analytics data and downloads the resulting bulk data reports in the form of CSV files.", "discoveryRestUrl": "https://youtubereporting.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://developers.google.com/youtube/reporting/v1/reports/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://developers.google.com/youtube/reporting/v1/reports/", - "preferred": true + "id": "youtubereporting:v1", + "kind": "discovery#directoryItem", + "name": "youtubereporting", + "preferred": true, + "title": "YouTube Reporting API", + "version": "v1" } - ] + ], + "kind": "discovery#directoryList" } \ No newline at end of file diff --git a/discovery/integrations-v1.json b/discovery/integrations-v1.json index 0474e03293..a4d47f9791 100644 --- a/discovery/integrations-v1.json +++ b/discovery/integrations-v1.json @@ -3790,6 +3790,46 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "download": { + "description": "Downloads a template. Retrieves the `Template` and returns the response as a string.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/templates/{templatesId}:download", + "httpMethod": "GET", + "id": "integrations.projects.locations.templates.download", + "parameterOrder": [ + "name" + ], + "parameters": { + "fileFormat": { + "description": "Required. File format for download request.", + "enum": [ + "FILE_FORMAT_UNSPECIFIED", + "JSON", + "YAML" + ], + "enumDescriptions": [ + "Unspecified file format", + "JSON File Format", + "YAML File Format" + ], + "location": "query", + "type": "string" + }, + "name": { + "description": "Required. The template to download. Format: projects/{project}/locations/{location}/template/{template_id}", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/templates/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:download", + "response": { + "$ref": "GoogleCloudIntegrationsV1alphaDownloadTemplateResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "get": { "description": "Get a template in the specified project.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/templates/{templatesId}", @@ -4037,6 +4077,34 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "upload": { + "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.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/templates:upload", + "httpMethod": "POST", + "id": "integrations.projects.locations.templates.upload", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The template to upload. Format: projects/{project}/locations/{location}", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/templates:upload", + "request": { + "$ref": "GoogleCloudIntegrationsV1alphaUploadTemplateRequest" + }, + "response": { + "$ref": "GoogleCloudIntegrationsV1alphaUploadTemplateResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "use": { "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.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/templates/{templatesId}:use", @@ -4072,7 +4140,7 @@ } } }, - "revision": "20240622", + "revision": "20240713", "rootUrl": "https://integrations.googleapis.com/", "schemas": { "CrmlogErrorCode": { @@ -5277,6 +5345,10 @@ "description": "Represents external traffic type and id.", "id": "EnterpriseCrmEventbusProtoExternalTraffic", "properties": { + "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.", "type": "string" @@ -7541,7 +7613,7 @@ "type": "object" }, "EnterpriseCrmFrontendsEventbusProtoEventExecutionInfo": { - "description": "Contains all the execution details for a workflow instance. Next available id: 26", + "description": "Contains all the execution details for a workflow instance. Next available id: 27", "id": "EnterpriseCrmFrontendsEventbusProtoEventExecutionInfo", "properties": { "clientId": { @@ -7580,6 +7652,10 @@ "$ref": "EnterpriseCrmEventbusProtoExecutionTraceInfo", "description": "Execution trace info to aggregate parent-child executions." }, + "integrationVersionUserLabel": { + "description": "User-defined label that annotates the executed integration version.", + "type": "string" + }, "lastModifiedTime": { "description": "Auto-generated.", "format": "int64", @@ -10114,6 +10190,10 @@ "description": "Description of what the client is used for", "type": "string" }, + "enableInternalIp": { + "description": "Optional. Indicates the client enables internal IP feature, this is applicable for internal clients only.", + "type": "boolean" + }, "enableVariableMasking": { "description": "Optional. True if variable masking feature should be turned on for this region", "type": "boolean" @@ -10469,6 +10549,17 @@ }, "type": "object" }, + "GoogleCloudIntegrationsV1alphaDownloadTemplateResponse": { + "description": "Response for DownloadTemplate.", + "id": "GoogleCloudIntegrationsV1alphaDownloadTemplateResponse", + "properties": { + "content": { + "description": "String representation of the template.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudIntegrationsV1alphaEnumerateConnectorPlatformRegionsResponse": { "description": "Response containing all provisioned regions for Connector Platform.", "id": "GoogleCloudIntegrationsV1alphaEnumerateConnectorPlatformRegionsResponse", @@ -11013,16 +11104,20 @@ "description": "Request to Import template", "id": "GoogleCloudIntegrationsV1alphaImportTemplateRequest", "properties": { - "configParameters": { - "description": "Optional. Config parameters which would be used to configure template bundles.", - "items": { - "$ref": "GoogleCloudIntegrationsV1alphaIntegrationConfigParameter" - }, - "type": "array" - }, "integration": { "description": "Required. Name of the integration where template needs to be imported.", "type": "string" + }, + "integrationRegion": { + "description": "Required. The region of the Integration to be created.", + "type": "string" + }, + "subIntegrations": { + "additionalProperties": { + "$ref": "GoogleCloudIntegrationsV1alphaUseTemplateRequestIntegrationDetails" + }, + "description": "Optional. Sub Integration which would be created via templates.", + "type": "object" } }, "type": "object" @@ -11516,16 +11611,13 @@ "description": "Define the template of IntegrationVersion.", "id": "GoogleCloudIntegrationsV1alphaIntegrationVersionTemplate", "properties": { - "configParameters": { - "description": "Required. Config parameters which are required for the integration template. These config parameters would be requested by users while creating integration.", - "items": { - "$ref": "GoogleCloudIntegrationsV1alphaIntegrationConfigParameter" - }, - "type": "array" - }, "integrationVersion": { "$ref": "GoogleCloudIntegrationsV1alphaIntegrationVersion", "description": "Required. Templatized version of integration." + }, + "key": { + "description": "Required. Unique Key of the IntegrationVersion.", + "type": "string" } }, "type": "object" @@ -12970,7 +13062,7 @@ "enum": [ "CATEGORY_UNSPECIFIED", "AI_MACHINE_LEARNING", - "BUSINESS_INTELLIGENCE_", + "BUSINESS_INTELLIGENCE", "COLLABORATION", "CUSTOMER_SERVICE", "DATABASES", @@ -13291,7 +13383,7 @@ "type": "string" }, "triggerId": { - "description": "Optional. The backend trigger ID.", + "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}", "type": "string" }, "triggerNumber": { @@ -13383,23 +13475,74 @@ }, "type": "object" }, + "GoogleCloudIntegrationsV1alphaUploadTemplateRequest": { + "description": "Request for UploadTemplate.", + "id": "GoogleCloudIntegrationsV1alphaUploadTemplateRequest", + "properties": { + "content": { + "description": "Required. The textproto of the template.", + "type": "string" + }, + "fileFormat": { + "description": "Required. File format for upload request.", + "enum": [ + "FILE_FORMAT_UNSPECIFIED", + "JSON", + "YAML" + ], + "enumDescriptions": [ + "Unspecified file format", + "JSON File Format", + "YAML File Format" + ], + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudIntegrationsV1alphaUploadTemplateResponse": { + "description": "Response for UploadTemplate.", + "id": "GoogleCloudIntegrationsV1alphaUploadTemplateResponse", + "properties": { + "template": { + "$ref": "GoogleCloudIntegrationsV1alphaTemplate", + "description": "The uploaded Template" + } + }, + "type": "object" + }, "GoogleCloudIntegrationsV1alphaUseTemplateRequest": { "description": "Request to Use template", "id": "GoogleCloudIntegrationsV1alphaUseTemplateRequest", "properties": { - "configParameters": { - "description": "Optional. Config parameters which would be used to configure template bundles.", - "items": { - "$ref": "GoogleCloudIntegrationsV1alphaIntegrationConfigParameter" - }, - "type": "array" + "integrationDetails": { + "$ref": "GoogleCloudIntegrationsV1alphaUseTemplateRequestIntegrationDetails", + "description": "Required. Integration details which would be created via templates." }, + "integrationRegion": { + "description": "Required. The region of the Integration to be created.", + "type": "string" + }, + "subIntegrations": { + "additionalProperties": { + "$ref": "GoogleCloudIntegrationsV1alphaUseTemplateRequestIntegrationDetails" + }, + "description": "Optional. Sub Integration which would be created via templates.", + "type": "object" + } + }, + "type": "object" + }, + "GoogleCloudIntegrationsV1alphaUseTemplateRequestIntegrationDetails": { + "description": "Sub Integration which would be created via templates.", + "id": "GoogleCloudIntegrationsV1alphaUseTemplateRequestIntegrationDetails", + "properties": { "integration": { - "description": "Required. Name of the integration which would be created via templates.", + "description": "Required. Name of the sub integration which would be created via templates.", "type": "string" }, "integrationDescription": { - "description": "Optional. Description of the integration which would be created via templates.", + "description": "Optional. Description of the sub integration which would be created via templates.", "type": "string" } }, diff --git a/discovery/language-v1.json b/discovery/language-v1.json index 297e094461..43a6f0f5f1 100644 --- a/discovery/language-v1.json +++ b/discovery/language-v1.json @@ -246,7 +246,7 @@ } } }, - "revision": "20240310", + "revision": "20240713", "rootUrl": "https://language.googleapis.com/", "schemas": { "AnalyzeEntitiesRequest": { @@ -757,6 +757,7 @@ "A2_ULTRAGPU_4G", "A2_ULTRAGPU_8G", "A3_HIGHGPU_8G", + "A3_MEGAGPU_8G", "E2_STANDARD_2", "E2_STANDARD_4", "E2_STANDARD_8", @@ -1042,6 +1043,7 @@ "", "", "", + "", "" ], "type": "string" @@ -1474,6 +1476,7 @@ "A2_ULTRAGPU_4G", "A2_ULTRAGPU_8G", "A3_HIGHGPU_8G", + "A3_MEGAGPU_8G", "E2_STANDARD_2", "E2_STANDARD_4", "E2_STANDARD_8", @@ -1759,6 +1762,7 @@ "", "", "", + "", "" ], "type": "string" @@ -2150,6 +2154,7 @@ "A2_ULTRAGPU_4G", "A2_ULTRAGPU_8G", "A3_HIGHGPU_8G", + "A3_MEGAGPU_8G", "E2_STANDARD_2", "E2_STANDARD_4", "E2_STANDARD_8", @@ -2435,6 +2440,7 @@ "", "", "", + "", "" ], "type": "string" @@ -3616,6 +3622,7 @@ "NVIDIA_A100_80GB", "NVIDIA_L4", "NVIDIA_H100_80GB", + "NVIDIA_H100_MEGA_80GB", "TPU_V2", "TPU_V3", "TPU_V4_POD", @@ -3632,6 +3639,7 @@ "Nvidia A100 80GB GPU.", "Nvidia L4 GPU.", "Nvidia H100 80Gb GPU.", + "Nvidia H100 80Gb GPU.", "TPU v2 (JellyFish).", "TPU v3 (DragonFish).", "TPU_v4 (PufferFish).", diff --git a/discovery/language-v1beta2.json b/discovery/language-v1beta2.json index 4cc5240900..ddd51d165f 100644 --- a/discovery/language-v1beta2.json +++ b/discovery/language-v1beta2.json @@ -246,7 +246,7 @@ } } }, - "revision": "20240225", + "revision": "20240713", "rootUrl": "https://language.googleapis.com/", "schemas": { "AnalyzeEntitiesRequest": { @@ -757,6 +757,7 @@ "A2_ULTRAGPU_4G", "A2_ULTRAGPU_8G", "A3_HIGHGPU_8G", + "A3_MEGAGPU_8G", "E2_STANDARD_2", "E2_STANDARD_4", "E2_STANDARD_8", @@ -1042,6 +1043,7 @@ "", "", "", + "", "" ], "type": "string" @@ -1492,6 +1494,7 @@ "A2_ULTRAGPU_4G", "A2_ULTRAGPU_8G", "A3_HIGHGPU_8G", + "A3_MEGAGPU_8G", "E2_STANDARD_2", "E2_STANDARD_4", "E2_STANDARD_8", @@ -1777,6 +1780,7 @@ "", "", "", + "", "" ], "type": "string" @@ -2168,6 +2172,7 @@ "A2_ULTRAGPU_4G", "A2_ULTRAGPU_8G", "A3_HIGHGPU_8G", + "A3_MEGAGPU_8G", "E2_STANDARD_2", "E2_STANDARD_4", "E2_STANDARD_8", @@ -2453,6 +2458,7 @@ "", "", "", + "", "" ], "type": "string" @@ -3634,6 +3640,7 @@ "NVIDIA_A100_80GB", "NVIDIA_L4", "NVIDIA_H100_80GB", + "NVIDIA_H100_MEGA_80GB", "TPU_V2", "TPU_V3", "TPU_V4_POD", @@ -3650,6 +3657,7 @@ "Nvidia A100 80GB GPU.", "Nvidia L4 GPU.", "Nvidia H100 80Gb GPU.", + "Nvidia H100 80Gb GPU.", "TPU v2 (JellyFish).", "TPU v3 (DragonFish).", "TPU_v4 (PufferFish).", diff --git a/discovery/language-v2.json b/discovery/language-v2.json index 0e1a289197..2ca253270c 100644 --- a/discovery/language-v2.json +++ b/discovery/language-v2.json @@ -208,7 +208,7 @@ } } }, - "revision": "20240310", + "revision": "20240713", "rootUrl": "https://language.googleapis.com/", "schemas": { "AnalyzeEntitiesRequest": { @@ -577,6 +577,7 @@ "A2_ULTRAGPU_4G", "A2_ULTRAGPU_8G", "A3_HIGHGPU_8G", + "A3_MEGAGPU_8G", "E2_STANDARD_2", "E2_STANDARD_4", "E2_STANDARD_8", @@ -862,6 +863,7 @@ "", "", "", + "", "" ], "type": "string" @@ -1108,6 +1110,7 @@ "A2_ULTRAGPU_4G", "A2_ULTRAGPU_8G", "A3_HIGHGPU_8G", + "A3_MEGAGPU_8G", "E2_STANDARD_2", "E2_STANDARD_4", "E2_STANDARD_8", @@ -1393,6 +1396,7 @@ "", "", "", + "", "" ], "type": "string" @@ -1525,6 +1529,7 @@ "A2_ULTRAGPU_4G", "A2_ULTRAGPU_8G", "A3_HIGHGPU_8G", + "A3_MEGAGPU_8G", "E2_STANDARD_2", "E2_STANDARD_4", "E2_STANDARD_8", @@ -1810,6 +1815,7 @@ "", "", "", + "", "" ], "type": "string" @@ -2968,6 +2974,7 @@ "NVIDIA_A100_80GB", "NVIDIA_L4", "NVIDIA_H100_80GB", + "NVIDIA_H100_MEGA_80GB", "TPU_V2", "TPU_V3", "TPU_V4_POD", @@ -2984,6 +2991,7 @@ "Nvidia A100 80GB GPU.", "Nvidia L4 GPU.", "Nvidia H100 80Gb GPU.", + "Nvidia H100 80Gb GPU.", "TPU v2 (JellyFish).", "TPU v3 (DragonFish).", "TPU_v4 (PufferFish).", diff --git a/discovery/logging-v2.json b/discovery/logging-v2.json index 5db00b4cf9..e0f6c1698c 100644 --- a/discovery/logging-v2.json +++ b/discovery/logging-v2.json @@ -1362,6 +1362,11 @@ "parent" ], "parameters": { + "filter": { + "description": "Optional. Specifies the type (\"Logging\" or \"OpsAnalytics\") and the visibility (PRIVATE or SHARED) of the saved queries to list. If provided, the filter must contain either the type function or a visibility token, or both. If both are chosen, they can be placed in any order, but they must be joined by the AND operator or the empty character.The two supported type function calls are: type(\"Logging\") type(\"OpsAnalytics\")The two supported visibility tokens are: visibility = PRIVATE visibility = SHAREDFor example:type(\"Logging\") AND visibility = PRIVATE visibility=SHARED type(\"OpsAnalytics\") type(\"OpsAnalytics)\" visibility = PRIVATE visibility = SHARED", + "location": "query", + "type": "string" + }, "pageSize": { "description": "Optional. The maximum number of results to return from this request.Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.", "format": "int32", @@ -2053,7 +2058,7 @@ ], "parameters": { "name": { - "description": "Required. The resource name for the settings to update. \"organizations/[ORGANIZATION_ID]/settings\" For example:\"organizations/12345/settings\"", + "description": "Required. The resource name for the settings to update. \"organizations/[ORGANIZATION_ID]/settings\" \"folders/[FOLDER_ID]/settings\" For example:\"organizations/12345/settings\"", "location": "path", "pattern": "^folders/[^/]+$", "required": true, @@ -3274,6 +3279,11 @@ "parent" ], "parameters": { + "filter": { + "description": "Optional. Specifies the type (\"Logging\" or \"OpsAnalytics\") and the visibility (PRIVATE or SHARED) of the saved queries to list. If provided, the filter must contain either the type function or a visibility token, or both. If both are chosen, they can be placed in any order, but they must be joined by the AND operator or the empty character.The two supported type function calls are: type(\"Logging\") type(\"OpsAnalytics\")The two supported visibility tokens are: visibility = PRIVATE visibility = SHAREDFor example:type(\"Logging\") AND visibility = PRIVATE visibility=SHARED type(\"OpsAnalytics\") type(\"OpsAnalytics)\" visibility = PRIVATE visibility = SHARED", + "location": "query", + "type": "string" + }, "pageSize": { "description": "Optional. The maximum number of results to return from this request.Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.", "format": "int32", @@ -4700,7 +4710,7 @@ ], "parameters": { "name": { - "description": "Required. The resource name for the settings to update. \"organizations/[ORGANIZATION_ID]/settings\" For example:\"organizations/12345/settings\"", + "description": "Required. The resource name for the settings to update. \"organizations/[ORGANIZATION_ID]/settings\" \"folders/[FOLDER_ID]/settings\" For example:\"organizations/12345/settings\"", "location": "path", "pattern": "^organizations/[^/]+$", "required": true, @@ -5921,6 +5931,11 @@ "parent" ], "parameters": { + "filter": { + "description": "Optional. Specifies the type (\"Logging\" or \"OpsAnalytics\") and the visibility (PRIVATE or SHARED) of the saved queries to list. If provided, the filter must contain either the type function or a visibility token, or both. If both are chosen, they can be placed in any order, but they must be joined by the AND operator or the empty character.The two supported type function calls are: type(\"Logging\") type(\"OpsAnalytics\")The two supported visibility tokens are: visibility = PRIVATE visibility = SHAREDFor example:type(\"Logging\") AND visibility = PRIVATE visibility=SHARED type(\"OpsAnalytics\") type(\"OpsAnalytics)\" visibility = PRIVATE visibility = SHARED", + "location": "query", + "type": "string" + }, "pageSize": { "description": "Optional. The maximum number of results to return from this request.Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.", "format": "int32", @@ -7552,6 +7567,11 @@ "parent" ], "parameters": { + "filter": { + "description": "Optional. Specifies the type (\"Logging\" or \"OpsAnalytics\") and the visibility (PRIVATE or SHARED) of the saved queries to list. If provided, the filter must contain either the type function or a visibility token, or both. If both are chosen, they can be placed in any order, but they must be joined by the AND operator or the empty character.The two supported type function calls are: type(\"Logging\") type(\"OpsAnalytics\")The two supported visibility tokens are: visibility = PRIVATE visibility = SHAREDFor example:type(\"Logging\") AND visibility = PRIVATE visibility=SHARED type(\"OpsAnalytics\") type(\"OpsAnalytics)\" visibility = PRIVATE visibility = SHARED", + "location": "query", + "type": "string" + }, "pageSize": { "description": "Optional. The maximum number of results to return from this request.Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.", "format": "int32", @@ -8376,7 +8396,7 @@ ], "parameters": { "name": { - "description": "Required. The resource name for the settings to update. \"organizations/[ORGANIZATION_ID]/settings\" For example:\"organizations/12345/settings\"", + "description": "Required. The resource name for the settings to update. \"organizations/[ORGANIZATION_ID]/settings\" \"folders/[FOLDER_ID]/settings\" For example:\"organizations/12345/settings\"", "location": "path", "pattern": "^[^/]+/[^/]+$", "required": true, @@ -8404,7 +8424,7 @@ } } }, - "revision": "20240620", + "revision": "20240705", "rootUrl": "https://logging.googleapis.com/", "schemas": { "AuditConfig": { diff --git a/discovery/manufacturers-v1.json b/discovery/manufacturers-v1.json index 45adff4ccc..0432a4c316 100644 --- a/discovery/manufacturers-v1.json +++ b/discovery/manufacturers-v1.json @@ -416,7 +416,7 @@ } } }, - "revision": "20231113", + "revision": "20240716", "rootUrl": "https://manufacturers.googleapis.com/", "schemas": { "Attributes": { @@ -892,6 +892,14 @@ "description": "Product issue.", "id": "Issue", "properties": { + "applicableCountries": { + "description": "Output only. List of country codes (ISO 3166-1 alpha-2) where issue applies to the manufacturer product.", + "items": { + "type": "string" + }, + "readOnly": true, + "type": "array" + }, "attribute": { "description": "If present, the attribute that triggered the issue. For more information about attributes, see https://support.google.com/manufacturers/answer/6124116.", "type": "string" diff --git a/discovery/meet-v2.json b/discovery/meet-v2.json index 54ef93fb5a..461ede640b 100644 --- a/discovery/meet-v2.json +++ b/discovery/meet-v2.json @@ -543,7 +543,7 @@ ] }, "endActiveConference": { - "description": "Ends an active conference (if there's one).", + "description": "Ends an active conference (if there's one). For an example, see [End active conference](https://developers.google.com/meet/api/guides/meeting-spaces#end-active-conference).", "flatPath": "v2/spaces/{spacesId}:endActiveConference", "httpMethod": "POST", "id": "meet.spaces.endActiveConference", @@ -552,7 +552,7 @@ ], "parameters": { "name": { - "description": "Required. Resource name of the space.", + "description": "Required. Resource name of the space. Format: `spaces/{space}`. `{space}` is the resource identifier for the space. It's a unique, server-generated ID and is case sensitive. For example, `jQCFfuBOdN5z`. For more information, see [How Meet identifies a meeting space](https://developers.google.com/meet/api/guides/meeting-spaces#identify-meeting-space).", "location": "path", "pattern": "^spaces/[^/]+$", "required": true, @@ -571,7 +571,7 @@ ] }, "get": { - "description": "Gets a space by `space_id` or `meeting_code`.", + "description": "Gets details about a meeting space. For an example, see [Get a meeting space](https://developers.google.com/meet/api/guides/meeting-spaces#get-meeting-space).", "flatPath": "v2/spaces/{spacesId}", "httpMethod": "GET", "id": "meet.spaces.get", @@ -580,7 +580,7 @@ ], "parameters": { "name": { - "description": "Required. Resource name of the space.", + "description": "Required. Resource name of the space. Format: `spaces/{space}` or `spaces/{meetingCode}`. `{space}` is the resource identifier for the space. It's a unique, server-generated ID and is case sensitive. For example, `jQCFfuBOdN5z`. `{meetingCode}` is an alias for the space. It's a typeable, unique character string and is non-case sensitive. For example, `abc-mnop-xyz`. The maximum length is 128 characters. A `meetingCode` shouldn't be stored long term as it can become dissociated from a meeting space and can be reused for different meeting spaces in the future. Generally, a `meetingCode` expires 365 days after last use. For more information, see [Learn about meeting codes in Google Meet](https://support.google.com/meet/answer/10710509). For more information, see [How Meet identifies a meeting space](https://developers.google.com/meet/api/guides/meeting-spaces#identify-meeting-space).", "location": "path", "pattern": "^spaces/[^/]+$", "required": true, @@ -597,7 +597,7 @@ ] }, "patch": { - "description": "Updates a space.", + "description": "Updates details about a meeting space. For an example, see [Update a meeting space](https://developers.google.com/meet/api/guides/meeting-spaces#update-meeting-space).", "flatPath": "v2/spaces/{spacesId}", "httpMethod": "PATCH", "id": "meet.spaces.patch", @@ -606,7 +606,7 @@ ], "parameters": { "name": { - "description": "Immutable. Resource name of the space. Format: `spaces/{space}`", + "description": "Immutable. Resource name of the space. Format: `spaces/{space}`. `{space}` is the resource identifier for the space. It's a unique, server-generated ID and is case sensitive. For example, `jQCFfuBOdN5z`. For more information, see [How Meet identifies a meeting space](https://developers.google.com/meet/api/guides/meeting-spaces#identify-meeting-space).", "location": "path", "pattern": "^spaces/[^/]+$", "required": true, @@ -633,7 +633,7 @@ } } }, - "revision": "20240627", + "revision": "20240716", "rootUrl": "https://meet.googleapis.com/", "schemas": { "ActiveConference": { @@ -1000,17 +1000,17 @@ "description": "Configuration pertaining to the meeting space." }, "meetingCode": { - "description": "Output only. Type friendly code to join the meeting. Format: `[a-z]+-[a-z]+-[a-z]+` such as `abc-mnop-xyz`. The maximum length is 128 characters. Can only be used as an alias of the space ID to get the space.", + "description": "Output only. Type friendly unique string used to join the meeting. Format: `[a-z]+-[a-z]+-[a-z]+`. For example, `abc-mnop-xyz`. The maximum length is 128 characters. Can only be used as an alias of the space name to get the space.", "readOnly": true, "type": "string" }, "meetingUri": { - "description": "Output only. URI used to join meetings, such as `https://meet.google.com/abc-mnop-xyz`.", + "description": "Output only. URI used to join meetings consisting of `https://meet.google.com/` followed by the `meeting_code`. For example, `https://meet.google.com/abc-mnop-xyz`.", "readOnly": true, "type": "string" }, "name": { - "description": "Immutable. Resource name of the space. Format: `spaces/{space}`", + "description": "Immutable. Resource name of the space. Format: `spaces/{space}`. `{space}` is the resource identifier for the space. It's a unique, server-generated ID and is case sensitive. For example, `jQCFfuBOdN5z`. For more information, see [How Meet identifies a meeting space](https://developers.google.com/meet/api/guides/meeting-spaces#identify-meeting-space).", "type": "string" } }, diff --git a/discovery/merchantapi-accounts_v1beta.json b/discovery/merchantapi-accounts_v1beta.json index 301647be78..5a65da82c7 100644 --- a/discovery/merchantapi-accounts_v1beta.json +++ b/discovery/merchantapi-accounts_v1beta.json @@ -175,106 +175,6 @@ "https://www.googleapis.com/auth/content" ] }, - "getBusinessIdentity": { - "description": "Retrieves the business identity of an account.", - "flatPath": "accounts/v1beta/accounts/{accountsId}/businessIdentity", - "httpMethod": "GET", - "id": "merchantapi.accounts.getBusinessIdentity", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The resource name of the business identity. Format: `accounts/{account}/businessIdentity`", - "location": "path", - "pattern": "^accounts/[^/]+/businessIdentity$", - "required": true, - "type": "string" - } - }, - "path": "accounts/v1beta/{+name}", - "response": { - "$ref": "BusinessIdentity" - }, - "scopes": [ - "https://www.googleapis.com/auth/content" - ] - }, - "getBusinessInfo": { - "description": "Retrieves the business info of an account.", - "flatPath": "accounts/v1beta/accounts/{accountsId}/businessInfo", - "httpMethod": "GET", - "id": "merchantapi.accounts.getBusinessInfo", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The resource name of the business info. Format: `accounts/{account}/businessInfo`", - "location": "path", - "pattern": "^accounts/[^/]+/businessInfo$", - "required": true, - "type": "string" - } - }, - "path": "accounts/v1beta/{+name}", - "response": { - "$ref": "BusinessInfo" - }, - "scopes": [ - "https://www.googleapis.com/auth/content" - ] - }, - "getHomepage": { - "description": "Retrieves a store's homepage.", - "flatPath": "accounts/v1beta/accounts/{accountsId}/homepage", - "httpMethod": "GET", - "id": "merchantapi.accounts.getHomepage", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the homepage to retrieve. Format: `accounts/{account}/homepage`", - "location": "path", - "pattern": "^accounts/[^/]+/homepage$", - "required": true, - "type": "string" - } - }, - "path": "accounts/v1beta/{+name}", - "response": { - "$ref": "Homepage" - }, - "scopes": [ - "https://www.googleapis.com/auth/content" - ] - }, - "getShippingSettings": { - "description": "Retrieve shipping setting information.", - "flatPath": "accounts/v1beta/accounts/{accountsId}/shippingSettings", - "httpMethod": "GET", - "id": "merchantapi.accounts.getShippingSettings", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the shipping setting to retrieve. Format: `accounts/{account}/shippingsetting`", - "location": "path", - "pattern": "^accounts/[^/]+/shippingSettings$", - "required": true, - "type": "string" - } - }, - "path": "accounts/v1beta/{+name}", - "response": { - "$ref": "ShippingSettings" - }, - "scopes": [ - "https://www.googleapis.com/auth/content" - ] - }, "list": { "description": "Lists accounts accessible to the calling user and matching the constraints of the request such as page size or filters. This is not just listing the sub-accounts of an MCA, but all accounts the calling user has access to including other MCAs, linked accounts, standalone accounts and so on.", "flatPath": "accounts/v1beta/accounts", @@ -376,108 +276,6 @@ "scopes": [ "https://www.googleapis.com/auth/content" ] - }, - "updateBusinessIdentity": { - "description": "Updates the business identity of an account. Executing this method requires admin access.", - "flatPath": "accounts/v1beta/accounts/{accountsId}/businessIdentity", - "httpMethod": "PATCH", - "id": "merchantapi.accounts.updateBusinessIdentity", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Identifier. The resource name of the business identity. Format: `accounts/{account}/businessIdentity`", - "location": "path", - "pattern": "^accounts/[^/]+/businessIdentity$", - "required": true, - "type": "string" - }, - "updateMask": { - "description": "Required. List of fields being updated.", - "format": "google-fieldmask", - "location": "query", - "type": "string" - } - }, - "path": "accounts/v1beta/{+name}", - "request": { - "$ref": "BusinessIdentity" - }, - "response": { - "$ref": "BusinessIdentity" - }, - "scopes": [ - "https://www.googleapis.com/auth/content" - ] - }, - "updateBusinessInfo": { - "description": "Updates the business info of an account. Executing this method requires admin access.", - "flatPath": "accounts/v1beta/accounts/{accountsId}/businessInfo", - "httpMethod": "PATCH", - "id": "merchantapi.accounts.updateBusinessInfo", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Identifier. The resource name of the business info. Format: `accounts/{account}/businessInfo`", - "location": "path", - "pattern": "^accounts/[^/]+/businessInfo$", - "required": true, - "type": "string" - }, - "updateMask": { - "description": "Required. List of fields being updated.", - "format": "google-fieldmask", - "location": "query", - "type": "string" - } - }, - "path": "accounts/v1beta/{+name}", - "request": { - "$ref": "BusinessInfo" - }, - "response": { - "$ref": "BusinessInfo" - }, - "scopes": [ - "https://www.googleapis.com/auth/content" - ] - }, - "updateHomepage": { - "description": "Updates a store's homepage. Executing this method requires admin access.", - "flatPath": "accounts/v1beta/accounts/{accountsId}/homepage", - "httpMethod": "PATCH", - "id": "merchantapi.accounts.updateHomepage", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Identifier. The resource name of the store's homepage. Format: `accounts/{account}/homepage`", - "location": "path", - "pattern": "^accounts/[^/]+/homepage$", - "required": true, - "type": "string" - }, - "updateMask": { - "description": "Required. List of fields being updated.", - "format": "google-fieldmask", - "location": "query", - "type": "string" - } - }, - "path": "accounts/v1beta/{+name}", - "request": { - "$ref": "Homepage" - }, - "response": { - "$ref": "Homepage" - }, - "scopes": [ - "https://www.googleapis.com/auth/content" - ] } }, "resources": { @@ -580,6 +378,195 @@ } } }, + "businessIdentity": { + "methods": { + "getBusinessIdentity": { + "description": "Retrieves the business identity of an account.", + "flatPath": "accounts/v1beta/accounts/{accountsId}/businessIdentity", + "httpMethod": "GET", + "id": "merchantapi.accounts.businessIdentity.getBusinessIdentity", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the business identity. Format: `accounts/{account}/businessIdentity`", + "location": "path", + "pattern": "^accounts/[^/]+/businessIdentity$", + "required": true, + "type": "string" + } + }, + "path": "accounts/v1beta/{+name}", + "response": { + "$ref": "BusinessIdentity" + }, + "scopes": [ + "https://www.googleapis.com/auth/content" + ] + }, + "updateBusinessIdentity": { + "description": "Updates the business identity of an account. Executing this method requires admin access.", + "flatPath": "accounts/v1beta/accounts/{accountsId}/businessIdentity", + "httpMethod": "PATCH", + "id": "merchantapi.accounts.businessIdentity.updateBusinessIdentity", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Identifier. The resource name of the business identity. Format: `accounts/{account}/businessIdentity`", + "location": "path", + "pattern": "^accounts/[^/]+/businessIdentity$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Required. List of fields being updated.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "accounts/v1beta/{+name}", + "request": { + "$ref": "BusinessIdentity" + }, + "response": { + "$ref": "BusinessIdentity" + }, + "scopes": [ + "https://www.googleapis.com/auth/content" + ] + } + } + }, + "businessInfo": { + "methods": { + "getBusinessInfo": { + "description": "Retrieves the business info of an account.", + "flatPath": "accounts/v1beta/accounts/{accountsId}/businessInfo", + "httpMethod": "GET", + "id": "merchantapi.accounts.businessInfo.getBusinessInfo", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the business info. Format: `accounts/{account}/businessInfo`", + "location": "path", + "pattern": "^accounts/[^/]+/businessInfo$", + "required": true, + "type": "string" + } + }, + "path": "accounts/v1beta/{+name}", + "response": { + "$ref": "BusinessInfo" + }, + "scopes": [ + "https://www.googleapis.com/auth/content" + ] + }, + "updateBusinessInfo": { + "description": "Updates the business info of an account. Executing this method requires admin access.", + "flatPath": "accounts/v1beta/accounts/{accountsId}/businessInfo", + "httpMethod": "PATCH", + "id": "merchantapi.accounts.businessInfo.updateBusinessInfo", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Identifier. The resource name of the business info. Format: `accounts/{account}/businessInfo`", + "location": "path", + "pattern": "^accounts/[^/]+/businessInfo$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Required. List of fields being updated.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "accounts/v1beta/{+name}", + "request": { + "$ref": "BusinessInfo" + }, + "response": { + "$ref": "BusinessInfo" + }, + "scopes": [ + "https://www.googleapis.com/auth/content" + ] + } + } + }, + "emailpreferences": { + "methods": { + "getEmailPreferences": { + "description": "Returns the email preferences for a Merchant Center account user. Use the name=accounts/*/users/me/emailPreferences alias to get preferences for the authenticated user.", + "flatPath": "accounts/v1beta/accounts/{accountsId}/users/{usersId}/emailPreferences", + "httpMethod": "GET", + "id": "merchantapi.accounts.emailpreferences.getEmailPreferences", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the `EmailPreferences` resource. Format: `accounts/{account}/users/{email}/emailPreferences`", + "location": "path", + "pattern": "^accounts/[^/]+/users/[^/]+/emailPreferences$", + "required": true, + "type": "string" + } + }, + "path": "accounts/v1beta/{+name}", + "response": { + "$ref": "EmailPreferences" + }, + "scopes": [ + "https://www.googleapis.com/auth/content" + ] + }, + "updateEmailPreferences": { + "description": "Updates the email preferences for a Merchant Center account user. MCA users should specify the MCA account rather than a sub-account of the MCA. Preferences which are not explicitly selected in the update mask will not be updated. It is invalid for updates to specify an UNCONFIRMED opt-in status value. Use the name=accounts/*/users/me/emailPreferences alias to update preferences for the authenticated user.", + "flatPath": "accounts/v1beta/accounts/{accountsId}/users/{usersId}/emailPreferences", + "httpMethod": "PATCH", + "id": "merchantapi.accounts.emailpreferences.updateEmailPreferences", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Identifier. The name of the EmailPreferences. The endpoint is only supported for the authenticated user.", + "location": "path", + "pattern": "^accounts/[^/]+/users/[^/]+/emailPreferences$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Required. List of fields being updated.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "accounts/v1beta/{+name}", + "request": { + "$ref": "EmailPreferences" + }, + "response": { + "$ref": "EmailPreferences" + }, + "scopes": [ + "https://www.googleapis.com/auth/content" + ] + } + } + }, "homepage": { "methods": { "claim": { @@ -610,6 +597,31 @@ "https://www.googleapis.com/auth/content" ] }, + "getHomepage": { + "description": "Retrieves a store's homepage.", + "flatPath": "accounts/v1beta/accounts/{accountsId}/homepage", + "httpMethod": "GET", + "id": "merchantapi.accounts.homepage.getHomepage", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the homepage to retrieve. Format: `accounts/{account}/homepage`", + "location": "path", + "pattern": "^accounts/[^/]+/homepage$", + "required": true, + "type": "string" + } + }, + "path": "accounts/v1beta/{+name}", + "response": { + "$ref": "Homepage" + }, + "scopes": [ + "https://www.googleapis.com/auth/content" + ] + }, "unclaim": { "description": "Unclaims a store's homepage. Executing this method requires admin access.", "flatPath": "accounts/v1beta/accounts/{accountsId}/homepage:unclaim", @@ -637,6 +649,40 @@ "scopes": [ "https://www.googleapis.com/auth/content" ] + }, + "updateHomepage": { + "description": "Updates a store's homepage. Executing this method requires admin access.", + "flatPath": "accounts/v1beta/accounts/{accountsId}/homepage", + "httpMethod": "PATCH", + "id": "merchantapi.accounts.homepage.updateHomepage", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Identifier. The resource name of the store's homepage. Format: `accounts/{account}/homepage`", + "location": "path", + "pattern": "^accounts/[^/]+/homepage$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Required. List of fields being updated.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "accounts/v1beta/{+name}", + "request": { + "$ref": "Homepage" + }, + "response": { + "$ref": "Homepage" + }, + "scopes": [ + "https://www.googleapis.com/auth/content" + ] } } }, @@ -1040,6 +1086,31 @@ }, "shippingSettings": { "methods": { + "getShippingSettings": { + "description": "Retrieve shipping setting information.", + "flatPath": "accounts/v1beta/accounts/{accountsId}/shippingSettings", + "httpMethod": "GET", + "id": "merchantapi.accounts.shippingSettings.getShippingSettings", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the shipping setting to retrieve. Format: `accounts/{account}/shippingsetting`", + "location": "path", + "pattern": "^accounts/[^/]+/shippingSettings$", + "required": true, + "type": "string" + } + }, + "path": "accounts/v1beta/{+name}", + "response": { + "$ref": "ShippingSettings" + }, + "scopes": [ + "https://www.googleapis.com/auth/content" + ] + }, "insert": { "description": "Replace the shipping setting of a merchant with the request shipping setting. Executing this method requires admin access.", "flatPath": "accounts/v1beta/accounts/{accountsId}/shippingSettings:insert", @@ -1082,7 +1153,7 @@ ], "parameters": { "name": { - "description": "Required. The resource name of the terms of service version. Format: `accounts/{account}/termsOfServiceAgreementState/{identifier}`", + "description": "Required. The resource name of the terms of service version. Format: `accounts/{account}/termsOfServiceAgreementState/{identifier}` The identifier format is: `{TermsOfServiceKind}-{country}`", "location": "path", "pattern": "^accounts/[^/]+/termsOfServiceAgreementStates/[^/]+$", "required": true, @@ -1209,31 +1280,6 @@ "https://www.googleapis.com/auth/content" ] }, - "getEmailPreferences": { - "description": "Returns the email preferences for a Merchant Center account user. Use the name=accounts/*/users/me/emailPreferences alias to get preferences for the authenticated user.", - "flatPath": "accounts/v1beta/accounts/{accountsId}/users/{usersId}/emailPreferences", - "httpMethod": "GET", - "id": "merchantapi.accounts.users.getEmailPreferences", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the `EmailPreferences` resource. Format: `accounts/{account}/users/{email}/emailPreferences`", - "location": "path", - "pattern": "^accounts/[^/]+/users/[^/]+/emailPreferences$", - "required": true, - "type": "string" - } - }, - "path": "accounts/v1beta/{+name}", - "response": { - "$ref": "EmailPreferences" - }, - "scopes": [ - "https://www.googleapis.com/auth/content" - ] - }, "list": { "description": "Lists all users of a Merchant Center account.", "flatPath": "accounts/v1beta/accounts/{accountsId}/users", @@ -1303,40 +1349,6 @@ "scopes": [ "https://www.googleapis.com/auth/content" ] - }, - "updateEmailPreferences": { - "description": "Updates the email preferences for a Merchant Center account user. MCA users should specify the MCA account rather than a sub-account of the MCA. Preferences which are not explicitly selected in the update mask will not be updated. It is invalid for updates to specify an UNCONFIRMED opt-in status value. Use the name=accounts/*/users/me/emailPreferences alias to update preferences for the authenticated user.", - "flatPath": "accounts/v1beta/accounts/{accountsId}/users/{usersId}/emailPreferences", - "httpMethod": "PATCH", - "id": "merchantapi.accounts.users.updateEmailPreferences", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Identifier. The name of the EmailPreferences. The endpoint is only supported for the authenticated user.", - "location": "path", - "pattern": "^accounts/[^/]+/users/[^/]+/emailPreferences$", - "required": true, - "type": "string" - }, - "updateMask": { - "description": "Required. List of fields being updated.", - "format": "google-fieldmask", - "location": "query", - "type": "string" - } - }, - "path": "accounts/v1beta/{+name}", - "request": { - "$ref": "EmailPreferences" - }, - "response": { - "$ref": "EmailPreferences" - }, - "scopes": [ - "https://www.googleapis.com/auth/content" - ] } } } @@ -1441,7 +1453,7 @@ } } }, - "revision": "20240614", + "revision": "20240712", "rootUrl": "https://merchantapi.googleapis.com/", "schemas": { "AcceptTermsOfService": { @@ -3346,7 +3358,7 @@ "description": "The accepted terms of service of this kind and for the associated region_code" }, "name": { - "description": "Identifier. The resource name of the terms of service version. Format: `accounts/{account}/termsOfServiceAgreementState/{identifier}`", + "description": "Identifier. The resource name of the terms of service version. Format: `accounts/{account}/termsOfServiceAgreementState/{identifier}` The identifier format is: `{TermsOfServiceKind}-{country}` For example, an identifier could be: `MERCHANT_CENTER-US`", "type": "string" }, "regionCode": { diff --git a/discovery/metastore-v1.json b/discovery/metastore-v1.json index c36e218787..56363ceb62 100644 --- a/discovery/metastore-v1.json +++ b/discovery/metastore-v1.json @@ -1684,7 +1684,7 @@ } } }, - "revision": "20240627", + "revision": "20240709", "rootUrl": "https://metastore.googleapis.com/", "schemas": { "AlterMetadataResourceLocationRequest": { @@ -2060,6 +2060,31 @@ }, "type": "object" }, + "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.", + "id": "CustomRegionMetadata", + "properties": { + "optionalReadOnlyRegions": { + "description": "The read-only regions for this custom region.", + "items": { + "type": "string" + }, + "type": "array" + }, + "requiredReadWriteRegions": { + "description": "The read-write regions for this custom region.", + "items": { + "type": "string" + }, + "type": "array" + }, + "witnessRegion": { + "description": "The Spanner witness region for this custom region.", + "type": "string" + } + }, + "type": "object" + }, "DataCatalogConfig": { "description": "Specifies how metastore metadata should be integrated with the Data Catalog service.", "id": "DataCatalogConfig", @@ -2608,6 +2633,13 @@ "description": "Metadata about the service in a location.", "id": "LocationMetadata", "properties": { + "customRegionMetadata": { + "description": "Possible configurations supported if the current region is a custom region.", + "items": { + "$ref": "CustomRegionMetadata" + }, + "type": "array" + }, "multiRegionMetadata": { "$ref": "MultiRegionMetadata", "description": "The multi-region metadata if the current region is a multi-region." @@ -3363,6 +3395,7 @@ "UPDATING", "DELETING", "ERROR", + "AUTOSCALING", "MIGRATING" ], "enumDescriptions": [ @@ -3374,6 +3407,7 @@ "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." ], "readOnly": true, diff --git a/discovery/metastore-v1alpha.json b/discovery/metastore-v1alpha.json index ed1b090fc8..4382f0af6d 100644 --- a/discovery/metastore-v1alpha.json +++ b/discovery/metastore-v1alpha.json @@ -1796,7 +1796,7 @@ } } }, - "revision": "20240613", + "revision": "20240709", "rootUrl": "https://metastore.googleapis.com/", "schemas": { "AlterMetadataResourceLocationRequest": { @@ -2196,6 +2196,52 @@ }, "type": "object" }, + "CustomRegionConfig": { + "description": "Custom configuration used to specify regions that the metastore service runs in. Currently only supported in the us multi-region.", + "id": "CustomRegionConfig", + "properties": { + "readOnlyRegions": { + "description": "Optional. The list of read-only regions where the metastore service runs in. These regions should be part (or subset) of the multi-region.", + "items": { + "type": "string" + }, + "type": "array" + }, + "readWriteRegions": { + "description": "Required. The list of read-write regions where the metastore service runs in. These regions should be part (or subset) of the multi-region.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "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.", + "id": "CustomRegionMetadata", + "properties": { + "optionalReadOnlyRegions": { + "description": "The read-only regions for this custom region.", + "items": { + "type": "string" + }, + "type": "array" + }, + "requiredReadWriteRegions": { + "description": "The read-write regions for this custom region.", + "items": { + "type": "string" + }, + "type": "array" + }, + "witnessRegion": { + "description": "The Spanner witness region for this custom region.", + "type": "string" + } + }, + "type": "object" + }, "DataCatalogConfig": { "description": "Specifies how metastore metadata should be integrated with the Data Catalog service.", "id": "DataCatalogConfig", @@ -2769,6 +2815,13 @@ "description": "Metadata about the service in a location.", "id": "LocationMetadata", "properties": { + "customRegionMetadata": { + "description": "Possible configurations supported if the current region is a custom region.", + "items": { + "$ref": "CustomRegionMetadata" + }, + "type": "array" + }, "multiRegionMetadata": { "$ref": "MultiRegionMetadata", "description": "The multi-region metadata if the current region is a multi-region." @@ -3071,6 +3124,25 @@ "properties": {}, "type": "object" }, + "MultiRegionConfig": { + "description": "The multi-region config for the Dataproc Metastore service.", + "id": "MultiRegionConfig", + "properties": { + "certificates": { + "deprecated": true, + "description": "Output only. The list of root CA certificates that a gRPC client uses to connect to a multi-regional Dataproc Metastore service.", + "items": { + "$ref": "RootCACertificate" + }, + "readOnly": true, + "type": "array" + }, + "customRegionConfig": { + "$ref": "CustomRegionConfig" + } + }, + "type": "object" + }, "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.", "id": "MultiRegionMetadata", @@ -3357,6 +3429,25 @@ }, "type": "object" }, + "RootCACertificate": { + "deprecated": true, + "description": "A gRPC client must install all root CA certificates to connect to a multi-regional Dataproc Metastore service and achieve failover.", + "id": "RootCACertificate", + "properties": { + "certificate": { + "deprecated": true, + "description": "The root CA certificate in PEM format. The maximum length is 65536 bytes.", + "type": "string" + }, + "expirationTime": { + "deprecated": true, + "description": "The certificate expiration time in timestamp format.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, "ScalingConfig": { "description": "Represents the scaling configuration of a metastore service.", "id": "ScalingConfig", @@ -3504,6 +3595,10 @@ "description": "Output only. The metadata management activities of the metastore service.", "readOnly": true }, + "multiRegionConfig": { + "$ref": "MultiRegionConfig", + "description": "Optional. Specifies the multi-region configuration information for the Hive metastore service." + }, "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" @@ -3554,6 +3649,7 @@ "UPDATING", "DELETING", "ERROR", + "AUTOSCALING", "MIGRATING" ], "enumDescriptions": [ @@ -3565,6 +3661,7 @@ "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." ], "readOnly": true, diff --git a/discovery/metastore-v1beta.json b/discovery/metastore-v1beta.json index 3613a8d5db..17d8b8078a 100644 --- a/discovery/metastore-v1beta.json +++ b/discovery/metastore-v1beta.json @@ -1796,7 +1796,7 @@ } } }, - "revision": "20240613", + "revision": "20240709", "rootUrl": "https://metastore.googleapis.com/", "schemas": { "AlterMetadataResourceLocationRequest": { @@ -2196,6 +2196,52 @@ }, "type": "object" }, + "CustomRegionConfig": { + "description": "Custom configuration used to specify regions that the metastore service runs in. Currently only supported in the us multi-region.", + "id": "CustomRegionConfig", + "properties": { + "readOnlyRegions": { + "description": "Optional. The list of read-only regions where the metastore service runs in. These regions should be part (or subset) of the multi-region.", + "items": { + "type": "string" + }, + "type": "array" + }, + "readWriteRegions": { + "description": "Required. The list of read-write regions where the metastore service runs in. These regions should be part (or subset) of the multi-region.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "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.", + "id": "CustomRegionMetadata", + "properties": { + "optionalReadOnlyRegions": { + "description": "The read-only regions for this custom region.", + "items": { + "type": "string" + }, + "type": "array" + }, + "requiredReadWriteRegions": { + "description": "The read-write regions for this custom region.", + "items": { + "type": "string" + }, + "type": "array" + }, + "witnessRegion": { + "description": "The Spanner witness region for this custom region.", + "type": "string" + } + }, + "type": "object" + }, "DataCatalogConfig": { "description": "Specifies how metastore metadata should be integrated with the Data Catalog service.", "id": "DataCatalogConfig", @@ -2769,6 +2815,13 @@ "description": "Metadata about the service in a location.", "id": "LocationMetadata", "properties": { + "customRegionMetadata": { + "description": "Possible configurations supported if the current region is a custom region.", + "items": { + "$ref": "CustomRegionMetadata" + }, + "type": "array" + }, "multiRegionMetadata": { "$ref": "MultiRegionMetadata", "description": "The multi-region metadata if the current region is a multi-region." @@ -3071,6 +3124,25 @@ "properties": {}, "type": "object" }, + "MultiRegionConfig": { + "description": "The multi-region config for the Dataproc Metastore service.", + "id": "MultiRegionConfig", + "properties": { + "certificates": { + "deprecated": true, + "description": "Output only. The list of root CA certificates that a gRPC client uses to connect to a multi-regional Dataproc Metastore service.", + "items": { + "$ref": "RootCACertificate" + }, + "readOnly": true, + "type": "array" + }, + "customRegionConfig": { + "$ref": "CustomRegionConfig" + } + }, + "type": "object" + }, "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.", "id": "MultiRegionMetadata", @@ -3357,6 +3429,25 @@ }, "type": "object" }, + "RootCACertificate": { + "deprecated": true, + "description": "A gRPC client must install all root CA certificates to connect to a multi-regional Dataproc Metastore service and achieve failover.", + "id": "RootCACertificate", + "properties": { + "certificate": { + "deprecated": true, + "description": "The root CA certificate in PEM format. The maximum length is 65536 bytes.", + "type": "string" + }, + "expirationTime": { + "deprecated": true, + "description": "The certificate expiration time in timestamp format.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, "ScalingConfig": { "description": "Represents the scaling configuration of a metastore service.", "id": "ScalingConfig", @@ -3504,6 +3595,10 @@ "description": "Output only. The metadata management activities of the metastore service.", "readOnly": true }, + "multiRegionConfig": { + "$ref": "MultiRegionConfig", + "description": "Optional. Specifies the multi-region configuration information for the Hive metastore service." + }, "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" @@ -3554,6 +3649,7 @@ "UPDATING", "DELETING", "ERROR", + "AUTOSCALING", "MIGRATING" ], "enumDescriptions": [ @@ -3565,6 +3661,7 @@ "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." ], "readOnly": true, diff --git a/discovery/migrationcenter-v1alpha1.json b/discovery/migrationcenter-v1alpha1.json index f3faaf86a3..d32b336f8b 100644 --- a/discovery/migrationcenter-v1alpha1.json +++ b/discovery/migrationcenter-v1alpha1.json @@ -2473,7 +2473,7 @@ } } }, - "revision": "20240620", + "revision": "20240704", "rootUrl": "https://migrationcenter.googleapis.com/", "schemas": { "AddAssetsToGroupRequest": { @@ -3443,7 +3443,7 @@ "enumDescriptions": [ "Unspecified (default value).", "Default Google Cloud licensing plan. Licensing is charged per usage. This a good value to start with.", - "Bring-your-own-license (BYOL) plan. User provides the OS license." + "Bring-your-own-license (BYOL) plan. User provides the license." ], "type": "string" }, @@ -6255,7 +6255,7 @@ "type": "string" }, "licenseType": { - "description": "Optional. License type of the OS image.", + "description": "Optional. License type for premium images (RHEL, RHEL for SAP, SLES, SLES for SAP, Windows Server).", "enum": [ "LICENSE_TYPE_UNSPECIFIED", "LICENSE_TYPE_DEFAULT", @@ -6264,7 +6264,7 @@ "enumDescriptions": [ "Unspecified (default value).", "Default Google Cloud licensing plan. Licensing is charged per usage. This a good value to start with.", - "Bring-your-own-license (BYOL) plan. User provides the OS license." + "Bring-your-own-license (BYOL) plan. User provides the license." ], "type": "string" } @@ -8296,7 +8296,9 @@ "COMMITMENT_1_YEAR_MONTHLY_PAYMENTS", "COMMITMENT_3_YEAR_MONTHLY_PAYMENTS", "COMMITMENT_1_YEAR_UPFRONT_PAYMENT", - "COMMITMENT_3_YEAR_UPFRONT_PAYMENT" + "COMMITMENT_3_YEAR_UPFRONT_PAYMENT", + "COMMITMENT_FLEXIBLE_3_YEAR_MONTHLY_PAYMENTS", + "COMMITMENT_FLEXIBLE_3_YEAR_UPFRONT_PAYMENT" ], "enumDescriptions": [ "Unspecified commitment plan.", @@ -8304,7 +8306,9 @@ "1 year commitment (monthly payments).", "3 year commitment (monthly payments).", "1 year commitment (upfront payment).", - "3 years commitment (upfront payment)." + "3 years commitment (upfront payment).", + "3-year flexible commitment (monthly payments). While not supported in the v1 API, this value is converted to UNSPECIFIED in conversions to the v1 API.", + "3-year flexible commitment (upfront payment). While not supported in the v1 API, this value is converted to UNSPECIFIED in conversions to the v1 API." ], "type": "string" }, diff --git a/discovery/monitoring-v1.json b/discovery/monitoring-v1.json index 454cbb34e7..6ce089ef23 100644 --- a/discovery/monitoring-v1.json +++ b/discovery/monitoring-v1.json @@ -463,7 +463,7 @@ "type": "string" }, "name": { - "description": "The workspace on which to execute the request. It is not part of the open source API but used as a request path prefix to distinguish different virtual Prometheus instances of Google Prometheus Engine. The format is: projects/PROJECT_ID_OR_NUMBER.", + "description": "Required. The workspace on which to execute the request. It is not part of the open source API but used as a request path prefix to distinguish different virtual Prometheus instances of Google Prometheus Engine. The format is: projects/PROJECT_ID_OR_NUMBER.", "location": "path", "pattern": "^projects/[^/]+$", "required": true, @@ -500,7 +500,7 @@ "type": "string" }, "name": { - "description": "The project on which to execute the request. Data associcated with the project's workspace stored under the The format is: projects/PROJECT_ID_OR_NUMBER. Open source API but used as a request path prefix to distinguish different virtual Prometheus instances of Google Prometheus Engine.", + "description": "Required. The project on which to execute the request. Data associcated with the project's workspace stored under the The format is: projects/PROJECT_ID_OR_NUMBER. Open source API but used as a request path prefix to distinguish different virtual Prometheus instances of Google Prometheus Engine.", "location": "path", "pattern": "^projects/[^/]+$", "required": true, @@ -537,7 +537,7 @@ "type": "string" }, "name": { - "description": "The project on which to execute the request. Data associcated with the project's workspace stored under the The format is: projects/PROJECT_ID_OR_NUMBER. Open source API but used as a request path prefix to distinguish different virtual Prometheus instances of Google Prometheus Engine.", + "description": "Required. The project on which to execute the request. Data associcated with the project's workspace stored under the The format is: projects/PROJECT_ID_OR_NUMBER. Open source API but used as a request path prefix to distinguish different virtual Prometheus instances of Google Prometheus Engine.", "location": "path", "pattern": "^projects/[^/]+$", "required": true, @@ -574,7 +574,7 @@ "type": "string" }, "name": { - "description": "The project on which to execute the request. Data associcated with the project's workspace stored under the The format is: projects/PROJECT_ID_OR_NUMBER. Open source API but used as a request path prefix to distinguish different virtual Prometheus instances of Google Prometheus Engine.", + "description": "Required. The project on which to execute the request. Data associcated with the project's workspace stored under the The format is: projects/PROJECT_ID_OR_NUMBER. Open source API but used as a request path prefix to distinguish different virtual Prometheus instances of Google Prometheus Engine.", "location": "path", "pattern": "^projects/[^/]+$", "required": true, @@ -669,7 +669,7 @@ "type": "string" }, "name": { - "description": "The workspace on which to execute the request. It is not part of the open source API but used as a request path prefix to distinguish different virtual Prometheus instances of Google Prometheus Engine. The format is: projects/PROJECT_ID_OR_NUMBER.", + "description": "Required. The workspace on which to execute the request. It is not part of the open source API but used as a request path prefix to distinguish different virtual Prometheus instances of Google Prometheus Engine. The format is: projects/PROJECT_ID_OR_NUMBER.", "location": "path", "pattern": "^projects/[^/]+$", "required": true, @@ -753,7 +753,7 @@ } } }, - "revision": "20240623", + "revision": "20240713", "rootUrl": "https://monitoring.googleapis.com/", "schemas": { "Aggregation": { @@ -1356,7 +1356,9 @@ "CLOUD_SQL_FAILOVER", "CLOUD_SQL_START_STOP", "CLOUD_SQL_STORAGE", - "UPTIME_CHECK_FAILURE" + "UPTIME_CHECK_FAILURE", + "CLOUD_ALERTING_ALERT", + "SERVICE_HEALTH_INCIDENT" ], "enumDescriptions": [ "No event type specified.", @@ -1378,7 +1380,9 @@ "Failover of a Cloud SQL instance.", "Start/stop of a Cloud SQL instance.", "Storage event for a Cloud SQL instance.", - "Failure of a Cloud Monitoring uptime check." + "Failure of a Cloud Monitoring uptime check.", + "Alerts from Cloud Alerting", + "Incidents from Service Health" ], "type": "string" }, diff --git a/discovery/monitoring-v3.json b/discovery/monitoring-v3.json index c081b81b42..fb885ec198 100644 --- a/discovery/monitoring-v3.json +++ b/discovery/monitoring-v3.json @@ -1562,7 +1562,7 @@ ], "parameters": { "name": { - "description": "The full REST resource name for this channel. The format is: projects/[PROJECT_ID_OR_NUMBER]/notificationChannels/[CHANNEL_ID] The [CHANNEL_ID] is automatically assigned by the server on creation.", + "description": "Identifier. The full REST resource name for this channel. The format is: projects/[PROJECT_ID_OR_NUMBER]/notificationChannels/[CHANNEL_ID] The [CHANNEL_ID] is automatically assigned by the server on creation.", "location": "path", "pattern": "^projects/[^/]+/notificationChannels/[^/]+$", "required": true, @@ -2714,7 +2714,7 @@ } } }, - "revision": "20240616", + "revision": "20240713", "rootUrl": "https://monitoring.googleapis.com/", "schemas": { "Aggregation": { @@ -4905,7 +4905,7 @@ "type": "array" }, "name": { - "description": "The full REST resource name for this channel. The format is: projects/[PROJECT_ID_OR_NUMBER]/notificationChannels/[CHANNEL_ID] The [CHANNEL_ID] is automatically assigned by the server on creation.", + "description": "Identifier. The full REST resource name for this channel. The format is: projects/[PROJECT_ID_OR_NUMBER]/notificationChannels/[CHANNEL_ID] The [CHANNEL_ID] is automatically assigned by the server on creation.", "type": "string" }, "type": { @@ -5639,6 +5639,10 @@ "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.", "id": "TimeSeries", "properties": { + "description": { + "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.", + "type": "string" + }, "metadata": { "$ref": "MonitoredResourceMetadata", "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." @@ -5675,7 +5679,7 @@ "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)." }, "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.", + "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 or \"1\".", "type": "string" }, "valueType": { diff --git a/discovery/networksecurity-v1.json b/discovery/networksecurity-v1.json index ad58709553..dee8892363 100644 --- a/discovery/networksecurity-v1.json +++ b/discovery/networksecurity-v1.json @@ -3162,7 +3162,7 @@ } } }, - "revision": "20240505", + "revision": "20240626", "rootUrl": "https://networksecurity.googleapis.com/", "schemas": { "AddAddressGroupItemsRequest": { @@ -4262,14 +4262,14 @@ "id": "MTLSPolicy", "properties": { "clientValidationCa": { - "description": "Required if the policy is to be used with Traffic Director. For external HTTPS load balancers it must be empty. Defines the mechanism to obtain the Certificate Authority certificate to validate the client certificate.", + "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.", "items": { "$ref": "ValidationCA" }, "type": "array" }, "clientValidationMode": { - "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 external HTTPS load balancing. For Traffic Director it must be empty.", + "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.", "enum": [ "CLIENT_VALIDATION_MODE_UNSPECIFIED", "ALLOW_INVALID_OR_MISSING_CLIENT_CERT", @@ -4283,7 +4283,7 @@ "type": "string" }, "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 external HTTPS load balancers.", + "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" } }, @@ -4408,7 +4408,7 @@ "type": "object" }, "SecurityProfile": { - "description": "SecurityProfile is a resource that defines the behavior for one of many ProfileTypes. Next ID: 10", + "description": "SecurityProfile is a resource that defines the behavior for one of many ProfileTypes. Next ID: 11", "id": "SecurityProfile", "properties": { "createTime": { @@ -4463,7 +4463,7 @@ "type": "object" }, "SecurityProfileGroup": { - "description": "SecurityProfileGroup is a resource that defines the behavior for various ProfileTypes. Next ID: 9", + "description": "SecurityProfileGroup is a resource that defines the behavior for various ProfileTypes. Next ID: 10", "id": "SecurityProfileGroup", "properties": { "createTime": { @@ -4506,11 +4506,11 @@ "type": "object" }, "ServerTlsPolicy": { - "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 external HTTPS load balancers can be attached only to TargetHttpsProxy with an `EXTERNAL` or `EXTERNAL_MANAGED` load balancing scheme. Traffic Director compatible ServerTlsPolicies can be attached to EndpointPolicy and TargetHttpsProxy with Traffic Director `INTERNAL_SELF_MANAGED` load balancing scheme.", + "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.", "id": "ServerTlsPolicy", "properties": { "allowOpen": { - "description": "This field applies only for Traffic Director policies. It is must be set to false for external HTTPS 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.", + "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" }, "createTime": { @@ -4532,7 +4532,7 @@ }, "mtlsPolicy": { "$ref": "MTLSPolicy", - "description": "This field is required if the policy is used with external HTTPS 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." + "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." }, "name": { "description": "Required. Name of the ServerTlsPolicy resource. It matches the pattern `projects/*/locations/{location}/serverTlsPolicies/{server_tls_policy}`", @@ -4540,7 +4540,7 @@ }, "serverCertificate": { "$ref": "GoogleCloudNetworksecurityV1CertificateProvider", - "description": "Optional if policy is to be used with Traffic Director. For external HTTPS load balancer 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." + "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." }, "updateTime": { "description": "Output only. The timestamp when the resource was updated.", diff --git a/discovery/networksecurity-v1beta1.json b/discovery/networksecurity-v1beta1.json index 232b1ecdda..dd546e6cae 100644 --- a/discovery/networksecurity-v1beta1.json +++ b/discovery/networksecurity-v1beta1.json @@ -3162,7 +3162,7 @@ } } }, - "revision": "20240510", + "revision": "20240626", "rootUrl": "https://networksecurity.googleapis.com/", "schemas": { "AddAddressGroupItemsRequest": { @@ -4279,14 +4279,14 @@ "id": "MTLSPolicy", "properties": { "clientValidationCa": { - "description": "Required if the policy is to be used with Traffic Director. For external HTTPS load balancers it must be empty. Defines the mechanism to obtain the Certificate Authority certificate to validate the client certificate.", + "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.", "items": { "$ref": "ValidationCA" }, "type": "array" }, "clientValidationMode": { - "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 external HTTPS load balancing. For Traffic Director it must be empty.", + "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.", "enum": [ "CLIENT_VALIDATION_MODE_UNSPECIFIED", "ALLOW_INVALID_OR_MISSING_CLIENT_CERT", @@ -4300,7 +4300,7 @@ "type": "string" }, "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 external HTTPS load balancers.", + "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" } }, @@ -4425,7 +4425,7 @@ "type": "object" }, "SecurityProfile": { - "description": "SecurityProfile is a resource that defines the behavior for one of many ProfileTypes. Next ID: 10", + "description": "SecurityProfile is a resource that defines the behavior for one of many ProfileTypes. Next ID: 11", "id": "SecurityProfile", "properties": { "createTime": { @@ -4480,7 +4480,7 @@ "type": "object" }, "SecurityProfileGroup": { - "description": "SecurityProfileGroup is a resource that defines the behavior for various ProfileTypes. Next ID: 9", + "description": "SecurityProfileGroup is a resource that defines the behavior for various ProfileTypes. Next ID: 10", "id": "SecurityProfileGroup", "properties": { "createTime": { @@ -4523,11 +4523,11 @@ "type": "object" }, "ServerTlsPolicy": { - "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 external HTTPS load balancers can be attached only to TargetHttpsProxy with an `EXTERNAL` or `EXTERNAL_MANAGED` load balancing scheme. Traffic Director compatible ServerTlsPolicies can be attached to EndpointPolicy and TargetHttpsProxy with Traffic Director `INTERNAL_SELF_MANAGED` load balancing scheme.", + "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.", "id": "ServerTlsPolicy", "properties": { "allowOpen": { - "description": "This field applies only for Traffic Director policies. It is must be set to false for external HTTPS 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.", + "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" }, "createTime": { @@ -4549,7 +4549,7 @@ }, "mtlsPolicy": { "$ref": "MTLSPolicy", - "description": "This field is required if the policy is used with external HTTPS 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." + "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." }, "name": { "description": "Required. Name of the ServerTlsPolicy resource. It matches the pattern `projects/*/locations/{location}/serverTlsPolicies/{server_tls_policy}`", @@ -4557,7 +4557,7 @@ }, "serverCertificate": { "$ref": "GoogleCloudNetworksecurityV1beta1CertificateProvider", - "description": "Optional if policy is to be used with Traffic Director. For external HTTPS load balancer 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." + "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." }, "updateTime": { "description": "Output only. The timestamp when the resource was updated.", diff --git a/discovery/networkservices-v1.json b/discovery/networkservices-v1.json index 33a8cf1910..7cadeb5687 100644 --- a/discovery/networkservices-v1.json +++ b/discovery/networkservices-v1.json @@ -535,37 +535,6 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, - "getIamPolicy": { - "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpointPolicies/{endpointPoliciesId}:getIamPolicy", - "httpMethod": "GET", - "id": "networkservices.projects.locations.endpointPolicies.getIamPolicy", - "parameterOrder": [ - "resource" - ], - "parameters": { - "options.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).", - "format": "int32", - "location": "query", - "type": "integer" - }, - "resource": { - "description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/endpointPolicies/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+resource}:getIamPolicy", - "response": { - "$ref": "Policy" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, "list": { "description": "Lists EndpointPolicies in a given project and location.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpointPolicies", @@ -635,62 +604,6 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] - }, - "setIamPolicy": { - "description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpointPolicies/{endpointPoliciesId}:setIamPolicy", - "httpMethod": "POST", - "id": "networkservices.projects.locations.endpointPolicies.setIamPolicy", - "parameterOrder": [ - "resource" - ], - "parameters": { - "resource": { - "description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/endpointPolicies/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+resource}:setIamPolicy", - "request": { - "$ref": "SetIamPolicyRequest" - }, - "response": { - "$ref": "Policy" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "testIamPermissions": { - "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.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpointPolicies/{endpointPoliciesId}:testIamPermissions", - "httpMethod": "POST", - "id": "networkservices.projects.locations.endpointPolicies.testIamPermissions", - "parameterOrder": [ - "resource" - ], - "parameters": { - "resource": { - "description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/endpointPolicies/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+resource}:testIamPermissions", - "request": { - "$ref": "TestIamPermissionsRequest" - }, - "response": { - "$ref": "TestIamPermissionsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] } } }, @@ -779,37 +692,6 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, - "getIamPolicy": { - "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/gateways/{gatewaysId}:getIamPolicy", - "httpMethod": "GET", - "id": "networkservices.projects.locations.gateways.getIamPolicy", - "parameterOrder": [ - "resource" - ], - "parameters": { - "options.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).", - "format": "int32", - "location": "query", - "type": "integer" - }, - "resource": { - "description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/gateways/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+resource}:getIamPolicy", - "response": { - "$ref": "Policy" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, "list": { "description": "Lists Gateways in a given project and location.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/gateways", @@ -879,62 +761,6 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] - }, - "setIamPolicy": { - "description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/gateways/{gatewaysId}:setIamPolicy", - "httpMethod": "POST", - "id": "networkservices.projects.locations.gateways.setIamPolicy", - "parameterOrder": [ - "resource" - ], - "parameters": { - "resource": { - "description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/gateways/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+resource}:setIamPolicy", - "request": { - "$ref": "SetIamPolicyRequest" - }, - "response": { - "$ref": "Policy" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "testIamPermissions": { - "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.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/gateways/{gatewaysId}:testIamPermissions", - "httpMethod": "POST", - "id": "networkservices.projects.locations.gateways.testIamPermissions", - "parameterOrder": [ - "resource" - ], - "parameters": { - "resource": { - "description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/gateways/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+resource}:testIamPermissions", - "request": { - "$ref": "TestIamPermissionsRequest" - }, - "response": { - "$ref": "TestIamPermissionsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] } } }, @@ -1701,37 +1527,6 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, - "getIamPolicy": { - "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/meshes/{meshesId}:getIamPolicy", - "httpMethod": "GET", - "id": "networkservices.projects.locations.meshes.getIamPolicy", - "parameterOrder": [ - "resource" - ], - "parameters": { - "options.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).", - "format": "int32", - "location": "query", - "type": "integer" - }, - "resource": { - "description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/meshes/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+resource}:getIamPolicy", - "response": { - "$ref": "Policy" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, "list": { "description": "Lists Meshes in a given project and location.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/meshes", @@ -1801,62 +1596,6 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] - }, - "setIamPolicy": { - "description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/meshes/{meshesId}:setIamPolicy", - "httpMethod": "POST", - "id": "networkservices.projects.locations.meshes.setIamPolicy", - "parameterOrder": [ - "resource" - ], - "parameters": { - "resource": { - "description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/meshes/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+resource}:setIamPolicy", - "request": { - "$ref": "SetIamPolicyRequest" - }, - "response": { - "$ref": "Policy" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "testIamPermissions": { - "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.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/meshes/{meshesId}:testIamPermissions", - "httpMethod": "POST", - "id": "networkservices.projects.locations.meshes.testIamPermissions", - "parameterOrder": [ - "resource" - ], - "parameters": { - "resource": { - "description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/meshes/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+resource}:testIamPermissions", - "request": { - "$ref": "TestIamPermissionsRequest" - }, - "response": { - "$ref": "TestIamPermissionsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] } } }, @@ -2068,37 +1807,6 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, - "getIamPolicy": { - "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/serviceBindings/{serviceBindingsId}:getIamPolicy", - "httpMethod": "GET", - "id": "networkservices.projects.locations.serviceBindings.getIamPolicy", - "parameterOrder": [ - "resource" - ], - "parameters": { - "options.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).", - "format": "int32", - "location": "query", - "type": "integer" - }, - "resource": { - "description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/serviceBindings/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+resource}:getIamPolicy", - "response": { - "$ref": "Policy" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, "list": { "description": "Lists ServiceBinding in a given project and location.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/serviceBindings", @@ -2134,62 +1842,6 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] - }, - "setIamPolicy": { - "description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/serviceBindings/{serviceBindingsId}:setIamPolicy", - "httpMethod": "POST", - "id": "networkservices.projects.locations.serviceBindings.setIamPolicy", - "parameterOrder": [ - "resource" - ], - "parameters": { - "resource": { - "description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/serviceBindings/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+resource}:setIamPolicy", - "request": { - "$ref": "SetIamPolicyRequest" - }, - "response": { - "$ref": "Policy" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "testIamPermissions": { - "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.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/serviceBindings/{serviceBindingsId}:testIamPermissions", - "httpMethod": "POST", - "id": "networkservices.projects.locations.serviceBindings.testIamPermissions", - "parameterOrder": [ - "resource" - ], - "parameters": { - "resource": { - "description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/serviceBindings/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+resource}:testIamPermissions", - "request": { - "$ref": "TestIamPermissionsRequest" - }, - "response": { - "$ref": "TestIamPermissionsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] } } }, @@ -2725,7 +2377,7 @@ ], "parameters": { "name": { - "description": "Required. Name of the TlsRoute resource. It matches pattern `projects/*/locations/global/tlsRoutes/tls_route_name>`.", + "description": "Identifier. Name of the TlsRoute resource. It matches pattern `projects/*/locations/global/tlsRoutes/tls_route_name>`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/tlsRoutes/[^/]+$", "required": true, @@ -2756,7 +2408,7 @@ } } }, - "revision": "20240620", + "revision": "20240707", "rootUrl": "https://networkservices.googleapis.com/", "schemas": { "AuditConfig": { @@ -5021,7 +4673,7 @@ "type": "array" }, "name": { - "description": "Required. Name of the TlsRoute resource. It matches pattern `projects/*/locations/global/tlsRoutes/tls_route_name>`.", + "description": "Identifier. Name of the TlsRoute resource. It matches pattern `projects/*/locations/global/tlsRoutes/tls_route_name>`.", "type": "string" }, "rules": { diff --git a/discovery/networkservices-v1beta1.json b/discovery/networkservices-v1beta1.json index c2664bf126..07adb5fd8a 100644 --- a/discovery/networkservices-v1beta1.json +++ b/discovery/networkservices-v1beta1.json @@ -262,37 +262,6 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, - "getIamPolicy": { - "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpointPolicies/{endpointPoliciesId}:getIamPolicy", - "httpMethod": "GET", - "id": "networkservices.projects.locations.endpointPolicies.getIamPolicy", - "parameterOrder": [ - "resource" - ], - "parameters": { - "options.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).", - "format": "int32", - "location": "query", - "type": "integer" - }, - "resource": { - "description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/endpointPolicies/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+resource}:getIamPolicy", - "response": { - "$ref": "Policy" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, "list": { "description": "Lists EndpointPolicies in a given project and location.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpointPolicies", @@ -362,62 +331,6 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] - }, - "setIamPolicy": { - "description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpointPolicies/{endpointPoliciesId}:setIamPolicy", - "httpMethod": "POST", - "id": "networkservices.projects.locations.endpointPolicies.setIamPolicy", - "parameterOrder": [ - "resource" - ], - "parameters": { - "resource": { - "description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/endpointPolicies/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+resource}:setIamPolicy", - "request": { - "$ref": "SetIamPolicyRequest" - }, - "response": { - "$ref": "Policy" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "testIamPermissions": { - "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.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpointPolicies/{endpointPoliciesId}:testIamPermissions", - "httpMethod": "POST", - "id": "networkservices.projects.locations.endpointPolicies.testIamPermissions", - "parameterOrder": [ - "resource" - ], - "parameters": { - "resource": { - "description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/endpointPolicies/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+resource}:testIamPermissions", - "request": { - "$ref": "TestIamPermissionsRequest" - }, - "response": { - "$ref": "TestIamPermissionsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] } } }, @@ -506,37 +419,6 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, - "getIamPolicy": { - "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/gateways/{gatewaysId}:getIamPolicy", - "httpMethod": "GET", - "id": "networkservices.projects.locations.gateways.getIamPolicy", - "parameterOrder": [ - "resource" - ], - "parameters": { - "options.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).", - "format": "int32", - "location": "query", - "type": "integer" - }, - "resource": { - "description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/gateways/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+resource}:getIamPolicy", - "response": { - "$ref": "Policy" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, "list": { "description": "Lists Gateways in a given project and location.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/gateways", @@ -606,62 +488,6 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] - }, - "setIamPolicy": { - "description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/gateways/{gatewaysId}:setIamPolicy", - "httpMethod": "POST", - "id": "networkservices.projects.locations.gateways.setIamPolicy", - "parameterOrder": [ - "resource" - ], - "parameters": { - "resource": { - "description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/gateways/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+resource}:setIamPolicy", - "request": { - "$ref": "SetIamPolicyRequest" - }, - "response": { - "$ref": "Policy" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "testIamPermissions": { - "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.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/gateways/{gatewaysId}:testIamPermissions", - "httpMethod": "POST", - "id": "networkservices.projects.locations.gateways.testIamPermissions", - "parameterOrder": [ - "resource" - ], - "parameters": { - "resource": { - "description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/gateways/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+resource}:testIamPermissions", - "request": { - "$ref": "TestIamPermissionsRequest" - }, - "response": { - "$ref": "TestIamPermissionsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] } } }, @@ -1428,37 +1254,6 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, - "getIamPolicy": { - "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/meshes/{meshesId}:getIamPolicy", - "httpMethod": "GET", - "id": "networkservices.projects.locations.meshes.getIamPolicy", - "parameterOrder": [ - "resource" - ], - "parameters": { - "options.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).", - "format": "int32", - "location": "query", - "type": "integer" - }, - "resource": { - "description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/meshes/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+resource}:getIamPolicy", - "response": { - "$ref": "Policy" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, "list": { "description": "Lists Meshes in a given project and location.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/meshes", @@ -1528,62 +1323,6 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] - }, - "setIamPolicy": { - "description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/meshes/{meshesId}:setIamPolicy", - "httpMethod": "POST", - "id": "networkservices.projects.locations.meshes.setIamPolicy", - "parameterOrder": [ - "resource" - ], - "parameters": { - "resource": { - "description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/meshes/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+resource}:setIamPolicy", - "request": { - "$ref": "SetIamPolicyRequest" - }, - "response": { - "$ref": "Policy" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "testIamPermissions": { - "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.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/meshes/{meshesId}:testIamPermissions", - "httpMethod": "POST", - "id": "networkservices.projects.locations.meshes.testIamPermissions", - "parameterOrder": [ - "resource" - ], - "parameters": { - "resource": { - "description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/meshes/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+resource}:testIamPermissions", - "request": { - "$ref": "TestIamPermissionsRequest" - }, - "response": { - "$ref": "TestIamPermissionsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] } } }, @@ -1795,37 +1534,6 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, - "getIamPolicy": { - "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/serviceBindings/{serviceBindingsId}:getIamPolicy", - "httpMethod": "GET", - "id": "networkservices.projects.locations.serviceBindings.getIamPolicy", - "parameterOrder": [ - "resource" - ], - "parameters": { - "options.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).", - "format": "int32", - "location": "query", - "type": "integer" - }, - "resource": { - "description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/serviceBindings/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+resource}:getIamPolicy", - "response": { - "$ref": "Policy" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, "list": { "description": "Lists ServiceBinding in a given project and location.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/serviceBindings", @@ -1861,62 +1569,6 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] - }, - "setIamPolicy": { - "description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/serviceBindings/{serviceBindingsId}:setIamPolicy", - "httpMethod": "POST", - "id": "networkservices.projects.locations.serviceBindings.setIamPolicy", - "parameterOrder": [ - "resource" - ], - "parameters": { - "resource": { - "description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/serviceBindings/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+resource}:setIamPolicy", - "request": { - "$ref": "SetIamPolicyRequest" - }, - "response": { - "$ref": "Policy" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "testIamPermissions": { - "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.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/serviceBindings/{serviceBindingsId}:testIamPermissions", - "httpMethod": "POST", - "id": "networkservices.projects.locations.serviceBindings.testIamPermissions", - "parameterOrder": [ - "resource" - ], - "parameters": { - "resource": { - "description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/serviceBindings/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+resource}:testIamPermissions", - "request": { - "$ref": "TestIamPermissionsRequest" - }, - "response": { - "$ref": "TestIamPermissionsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] } } }, @@ -2452,7 +2104,7 @@ ], "parameters": { "name": { - "description": "Required. Name of the TlsRoute resource. It matches pattern `projects/*/locations/global/tlsRoutes/tls_route_name>`.", + "description": "Identifier. Name of the TlsRoute resource. It matches pattern `projects/*/locations/global/tlsRoutes/tls_route_name>`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/tlsRoutes/[^/]+$", "required": true, @@ -2483,7 +2135,7 @@ } } }, - "revision": "20240613", + "revision": "20240707", "rootUrl": "https://networkservices.googleapis.com/", "schemas": { "AuditConfig": { @@ -4748,7 +4400,7 @@ "type": "array" }, "name": { - "description": "Required. Name of the TlsRoute resource. It matches pattern `projects/*/locations/global/tlsRoutes/tls_route_name>`.", + "description": "Identifier. Name of the TlsRoute resource. It matches pattern `projects/*/locations/global/tlsRoutes/tls_route_name>`.", "type": "string" }, "rules": { diff --git a/discovery/ondemandscanning-v1.json b/discovery/ondemandscanning-v1.json index 54485be337..6a954a1a83 100644 --- a/discovery/ondemandscanning-v1.json +++ b/discovery/ondemandscanning-v1.json @@ -339,7 +339,7 @@ } } }, - "revision": "20240624", + "revision": "20240715", "rootUrl": "https://ondemandscanning.googleapis.com/", "schemas": { "AliasContext": { @@ -1110,10 +1110,6 @@ "sbomStatus": { "$ref": "SBOMStatus", "description": "The status of an SBOM generation." - }, - "vulnerabilityAttestation": { - "$ref": "VulnerabilityAttestation", - "description": "The status of an vulnerability attestation generation." } }, "type": "object" @@ -1943,7 +1939,8 @@ "NUGET", "RUBYGEMS", "RUST", - "COMPOSER" + "COMPOSER", + "SWIFT" ], "enumDescriptions": [ "", @@ -1956,7 +1953,8 @@ "Nuget (C#/.NET) packages.", "Ruby packges (from RubyGems package manager).", "Rust packages from Cargo (Github ecosystem is `RUST`).", - "PHP packages from Composer package manager." + "PHP packages from Composer package manager.", + "Swift packages from Swift Package Manager (SwiftPM)." ], "type": "string" }, @@ -2846,36 +2844,6 @@ }, "type": "object" }, - "VulnerabilityAttestation": { - "description": "The status of an vulnerability attestation generation.", - "id": "VulnerabilityAttestation", - "properties": { - "error": { - "description": "If failure, the error reason for why the attestation generation failed.", - "type": "string" - }, - "lastAttemptTime": { - "description": "The last time we attempted to generate an attestation.", - "format": "google-datetime", - "type": "string" - }, - "state": { - "description": "The success/failure state of the latest attestation attempt.", - "enum": [ - "VULNERABILITY_ATTESTATION_STATE_UNSPECIFIED", - "SUCCESS", - "FAILURE" - ], - "enumDescriptions": [ - "Default unknown state.", - "Attestation was successfully generated and stored.", - "Attestation was unsuccessfully generated and stored." - ], - "type": "string" - } - }, - "type": "object" - }, "VulnerabilityOccurrence": { "description": "An occurrence of a severity vulnerability on a resource.", "id": "VulnerabilityOccurrence", diff --git a/discovery/ondemandscanning-v1beta1.json b/discovery/ondemandscanning-v1beta1.json index e7d20882ec..2732e38a5b 100644 --- a/discovery/ondemandscanning-v1beta1.json +++ b/discovery/ondemandscanning-v1beta1.json @@ -339,7 +339,7 @@ } } }, - "revision": "20240624", + "revision": "20240715", "rootUrl": "https://ondemandscanning.googleapis.com/", "schemas": { "AliasContext": { @@ -1105,10 +1105,6 @@ "sbomStatus": { "$ref": "SBOMStatus", "description": "The status of an SBOM generation." - }, - "vulnerabilityAttestation": { - "$ref": "VulnerabilityAttestation", - "description": "The status of an vulnerability attestation generation." } }, "type": "object" @@ -1938,7 +1934,8 @@ "NUGET", "RUBYGEMS", "RUST", - "COMPOSER" + "COMPOSER", + "SWIFT" ], "enumDescriptions": [ "", @@ -1951,7 +1948,8 @@ "Nuget (C#/.NET) packages.", "Ruby packges (from RubyGems package manager).", "Rust packages from Cargo (Github ecosystem is `RUST`).", - "PHP packages from Composer package manager." + "PHP packages from Composer package manager.", + "Swift packages from Swift Package Manager (SwiftPM)." ], "type": "string" }, @@ -2841,36 +2839,6 @@ }, "type": "object" }, - "VulnerabilityAttestation": { - "description": "The status of an vulnerability attestation generation.", - "id": "VulnerabilityAttestation", - "properties": { - "error": { - "description": "If failure, the error reason for why the attestation generation failed.", - "type": "string" - }, - "lastAttemptTime": { - "description": "The last time we attempted to generate an attestation.", - "format": "google-datetime", - "type": "string" - }, - "state": { - "description": "The success/failure state of the latest attestation attempt.", - "enum": [ - "VULNERABILITY_ATTESTATION_STATE_UNSPECIFIED", - "SUCCESS", - "FAILURE" - ], - "enumDescriptions": [ - "Default unknown state.", - "Attestation was successfully generated and stored.", - "Attestation was unsuccessfully generated and stored." - ], - "type": "string" - } - }, - "type": "object" - }, "VulnerabilityOccurrence": { "description": "An occurrence of a severity vulnerability on a resource.", "id": "VulnerabilityOccurrence", diff --git a/discovery/playdeveloperreporting-v1alpha1.json b/discovery/playdeveloperreporting-v1alpha1.json index 3124e77c6a..8e06b5a97b 100644 --- a/discovery/playdeveloperreporting-v1alpha1.json +++ b/discovery/playdeveloperreporting-v1alpha1.json @@ -947,7 +947,7 @@ } } }, - "revision": "20240312", + "revision": "20240716", "rootUrl": "https://playdeveloperreporting.googleapis.com/", "schemas": { "GooglePlayDeveloperReportingV1alpha1Anomaly": { @@ -1558,14 +1558,14 @@ "id": "GooglePlayDeveloperReportingV1alpha1QueryErrorCountMetricSetRequest", "properties": { "dimensions": { - "description": "Dimensions to slice the data by. **Supported dimensions:** * `apiLevel` (string): the API level of Android that was running on the user's device, e.g., 26. * `versionCode` (int64): unique identifier of the user's device model. The form of the identifier is 'deviceBrand/device', where deviceBrand corresponds to Build.BRAND and device corresponds to Build.DEVICE, e.g., google/coral. * `deviceModel` (string): unique identifier of the user's device model. * `deviceType` (string): identifier of the device's form factor, e.g., PHONE. * `reportType` (string): the type of error. The value should correspond to one of the possible values in ErrorType. * `isUserPerceived` (string): denotes whether error is user perceived or not, USER_PERCEIVED or NOT_USER_PERCEIVED. * `issueId` (string): the id an error was assigned to. The value should correspond to the `{issue}` component of the issue name. * `deviceRamBucket` (int64): RAM of the device, in MB, in buckets (3GB, 4GB, etc.). * `deviceSocMake` (string): Make of the device's primary system-on-chip, e.g., Samsung. [Reference](https://developer.android.com/reference/android/os/Build#SOC_MANUFACTURER) * `deviceSocModel` (string): Model of the device's primary system-on-chip, e.g., \"Exynos 2100\". [Reference](https://developer.android.com/reference/android/os/Build#SOC_MODEL) * `deviceCpuMake` (string): Make of the device's CPU, e.g., Qualcomm. * `deviceCpuModel` (string): Model of the device's CPU, e.g., \"Kryo 240\". * `deviceGpuMake` (string): Make of the device's GPU, e.g., ARM. * `deviceGpuModel` (string): Model of the device's GPU, e.g., Mali. * `deviceGpuVersion` (string): Version of the device's GPU, e.g., T750. * `deviceVulkanVersion` (string): Vulkan version of the device, e.g., \"4198400\". * `deviceGlEsVersion` (string): OpenGL ES version of the device, e.g., \"196610\". * `deviceScreenSize` (string): Screen size of the device, e.g., NORMAL, LARGE. * `deviceScreenDpi` (string): Screen density of the device, e.g., mdpi, hdpi.", + "description": "Dimensions to slice the data by. **Supported dimensions:** * `apiLevel` (string): the API level of Android that was running on the user's device, e.g., 26. * `versionCode` (int64): unique identifier of the user's device model. The form of the identifier is 'deviceBrand/device', where deviceBrand corresponds to Build.BRAND and device corresponds to Build.DEVICE, e.g., google/coral. * `deviceModel` (string): unique identifier of the user's device model. * `deviceType` (string): identifier of the device's form factor, e.g., PHONE. * `reportType` (string): the type of error. The value should correspond to one of the possible values in ErrorType. * `issueId` (string): the id an error was assigned to. The value should correspond to the `{issue}` component of the issue name. * `deviceRamBucket` (int64): RAM of the device, in MB, in buckets (3GB, 4GB, etc.). * `deviceSocMake` (string): Make of the device's primary system-on-chip, e.g., Samsung. [Reference](https://developer.android.com/reference/android/os/Build#SOC_MANUFACTURER) * `deviceSocModel` (string): Model of the device's primary system-on-chip, e.g., \"Exynos 2100\". [Reference](https://developer.android.com/reference/android/os/Build#SOC_MODEL) * `deviceCpuMake` (string): Make of the device's CPU, e.g., Qualcomm. * `deviceCpuModel` (string): Model of the device's CPU, e.g., \"Kryo 240\". * `deviceGpuMake` (string): Make of the device's GPU, e.g., ARM. * `deviceGpuModel` (string): Model of the device's GPU, e.g., Mali. * `deviceGpuVersion` (string): Version of the device's GPU, e.g., T750. * `deviceVulkanVersion` (string): Vulkan version of the device, e.g., \"4198400\". * `deviceGlEsVersion` (string): OpenGL ES version of the device, e.g., \"196610\". * `deviceScreenSize` (string): Screen size of the device, e.g., NORMAL, LARGE. * `deviceScreenDpi` (string): Screen density of the device, e.g., mdpi, hdpi.", "items": { "type": "string" }, "type": "array" }, "filter": { - "description": "Filters to apply to data. The filtering expression follows [AIP-160](https://google.aip.dev/160) standard and supports filtering by equality of all breakdown dimensions.", + "description": "Filters to apply to data. The filtering expression follows [AIP-160](https://google.aip.dev/160) standard and supports filtering by equality of all breakdown dimensions and: * `isUserPerceived` (string): denotes whether error is user perceived or not, USER_PERCEIVED or NOT_USER_PERCEIVED.", "type": "string" }, "metrics": { diff --git a/discovery/playdeveloperreporting-v1beta1.json b/discovery/playdeveloperreporting-v1beta1.json index 86ad107a53..ff863bc1b4 100644 --- a/discovery/playdeveloperreporting-v1beta1.json +++ b/discovery/playdeveloperreporting-v1beta1.json @@ -947,7 +947,7 @@ } } }, - "revision": "20240312", + "revision": "20240716", "rootUrl": "https://playdeveloperreporting.googleapis.com/", "schemas": { "GooglePlayDeveloperReportingV1beta1Anomaly": { @@ -1558,14 +1558,14 @@ "id": "GooglePlayDeveloperReportingV1beta1QueryErrorCountMetricSetRequest", "properties": { "dimensions": { - "description": "Dimensions to slice the data by. **Supported dimensions:** * `apiLevel` (string): the API level of Android that was running on the user's device, e.g., 26. * `versionCode` (int64): unique identifier of the user's device model. The form of the identifier is 'deviceBrand/device', where deviceBrand corresponds to Build.BRAND and device corresponds to Build.DEVICE, e.g., google/coral. * `deviceModel` (string): unique identifier of the user's device model. * `deviceType` (string): identifier of the device's form factor, e.g., PHONE. * `reportType` (string): the type of error. The value should correspond to one of the possible values in ErrorType. * `isUserPerceived` (string): denotes whether error is user perceived or not, USER_PERCEIVED or NOT_USER_PERCEIVED. * `issueId` (string): the id an error was assigned to. The value should correspond to the `{issue}` component of the issue name. * `deviceRamBucket` (int64): RAM of the device, in MB, in buckets (3GB, 4GB, etc.). * `deviceSocMake` (string): Make of the device's primary system-on-chip, e.g., Samsung. [Reference](https://developer.android.com/reference/android/os/Build#SOC_MANUFACTURER) * `deviceSocModel` (string): Model of the device's primary system-on-chip, e.g., \"Exynos 2100\". [Reference](https://developer.android.com/reference/android/os/Build#SOC_MODEL) * `deviceCpuMake` (string): Make of the device's CPU, e.g., Qualcomm. * `deviceCpuModel` (string): Model of the device's CPU, e.g., \"Kryo 240\". * `deviceGpuMake` (string): Make of the device's GPU, e.g., ARM. * `deviceGpuModel` (string): Model of the device's GPU, e.g., Mali. * `deviceGpuVersion` (string): Version of the device's GPU, e.g., T750. * `deviceVulkanVersion` (string): Vulkan version of the device, e.g., \"4198400\". * `deviceGlEsVersion` (string): OpenGL ES version of the device, e.g., \"196610\". * `deviceScreenSize` (string): Screen size of the device, e.g., NORMAL, LARGE. * `deviceScreenDpi` (string): Screen density of the device, e.g., mdpi, hdpi.", + "description": "Dimensions to slice the data by. **Supported dimensions:** * `apiLevel` (string): the API level of Android that was running on the user's device, e.g., 26. * `versionCode` (int64): unique identifier of the user's device model. The form of the identifier is 'deviceBrand/device', where deviceBrand corresponds to Build.BRAND and device corresponds to Build.DEVICE, e.g., google/coral. * `deviceModel` (string): unique identifier of the user's device model. * `deviceType` (string): identifier of the device's form factor, e.g., PHONE. * `reportType` (string): the type of error. The value should correspond to one of the possible values in ErrorType. * `issueId` (string): the id an error was assigned to. The value should correspond to the `{issue}` component of the issue name. * `deviceRamBucket` (int64): RAM of the device, in MB, in buckets (3GB, 4GB, etc.). * `deviceSocMake` (string): Make of the device's primary system-on-chip, e.g., Samsung. [Reference](https://developer.android.com/reference/android/os/Build#SOC_MANUFACTURER) * `deviceSocModel` (string): Model of the device's primary system-on-chip, e.g., \"Exynos 2100\". [Reference](https://developer.android.com/reference/android/os/Build#SOC_MODEL) * `deviceCpuMake` (string): Make of the device's CPU, e.g., Qualcomm. * `deviceCpuModel` (string): Model of the device's CPU, e.g., \"Kryo 240\". * `deviceGpuMake` (string): Make of the device's GPU, e.g., ARM. * `deviceGpuModel` (string): Model of the device's GPU, e.g., Mali. * `deviceGpuVersion` (string): Version of the device's GPU, e.g., T750. * `deviceVulkanVersion` (string): Vulkan version of the device, e.g., \"4198400\". * `deviceGlEsVersion` (string): OpenGL ES version of the device, e.g., \"196610\". * `deviceScreenSize` (string): Screen size of the device, e.g., NORMAL, LARGE. * `deviceScreenDpi` (string): Screen density of the device, e.g., mdpi, hdpi.", "items": { "type": "string" }, "type": "array" }, "filter": { - "description": "Filters to apply to data. The filtering expression follows [AIP-160](https://google.aip.dev/160) standard and supports filtering by equality of all breakdown dimensions.", + "description": "Filters to apply to data. The filtering expression follows [AIP-160](https://google.aip.dev/160) standard and supports filtering by equality of all breakdown dimensions and: * `isUserPerceived` (string): denotes whether error is user perceived or not, USER_PERCEIVED or NOT_USER_PERCEIVED.", "type": "string" }, "metrics": { diff --git a/discovery/playintegrity-v1.json b/discovery/playintegrity-v1.json index 87c0268890..0eb6563c99 100644 --- a/discovery/playintegrity-v1.json +++ b/discovery/playintegrity-v1.json @@ -105,6 +105,38 @@ }, "protocol": "rest", "resources": { + "deviceRecall": { + "methods": { + "write": { + "description": "Writes recall bits for the device where Play Integrity API token is obtained. The endpoint is available to select Play partners in an early access program (EAP).", + "flatPath": "v1/{v1Id}/deviceRecall:write", + "httpMethod": "POST", + "id": "playintegrity.deviceRecall.write", + "parameterOrder": [ + "packageName" + ], + "parameters": { + "packageName": { + "description": "Required. Package name of the app the attached integrity token belongs to.", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+packageName}/deviceRecall:write", + "request": { + "$ref": "WriteDeviceRecallRequest" + }, + "response": { + "$ref": "WriteDeviceRecallResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/playintegrity" + ] + } + } + }, "v1": { "methods": { "decodeIntegrityToken": { @@ -138,7 +170,7 @@ } } }, - "revision": "20240508", + "revision": "20240716", "rootUrl": "https://playintegrity.googleapis.com/", "schemas": { "AccountActivity": { @@ -491,6 +523,46 @@ } }, "type": "object" + }, + "Values": { + "description": "Contains the recall bits values.", + "id": "Values", + "properties": { + "bitFirst": { + "description": "Required. First recall bit value.", + "type": "boolean" + }, + "bitSecond": { + "description": "Required. Second recall bit value.", + "type": "boolean" + }, + "bitThird": { + "description": "Required. Third recall bit value.", + "type": "boolean" + } + }, + "type": "object" + }, + "WriteDeviceRecallRequest": { + "description": "Request to write device recall bits.", + "id": "WriteDeviceRecallRequest", + "properties": { + "integrityToken": { + "description": "Required. Integrity token obtained from calling Play Integrity API. Note that the integrity token contains the existing device recall bits. The write will only succeed if those bits in the integrity token are up to date.", + "type": "string" + }, + "newValues": { + "$ref": "Values", + "description": "Required. The new values for the device recall bits to be written." + } + }, + "type": "object" + }, + "WriteDeviceRecallResponse": { + "description": "Response for the Write Device Recall action. Currently empty.", + "id": "WriteDeviceRecallResponse", + "properties": {}, + "type": "object" } }, "servicePath": "", diff --git a/discovery/pubsub-v1.json b/discovery/pubsub-v1.json index 30116a81a4..3a96238037 100644 --- a/discovery/pubsub-v1.json +++ b/discovery/pubsub-v1.json @@ -1583,7 +1583,7 @@ } } }, - "revision": "20240618", + "revision": "20240702", "rootUrl": "https://pubsub.googleapis.com/", "schemas": { "AcknowledgeRequest": { @@ -1782,6 +1782,11 @@ "format": "google-duration", "type": "string" }, + "maxMessages": { + "description": "Optional. The maximum number of messages that can be written to a Cloud Storage file before a new file is created. Min 1000 messages.", + "format": "int64", + "type": "string" + }, "serviceAccountEmail": { "description": "Optional. The service account to use to write to Cloud Storage. The subscription creator or updater that specifies this field must have `iam.serviceAccounts.actAs` permission on the service account. If not specified, the Pub/Sub [service agent](https://cloud.google.com/iam/docs/service-agents), service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com, is used.", "type": "string" diff --git a/discovery/recaptchaenterprise-v1.json b/discovery/recaptchaenterprise-v1.json index 129c55f48b..44adb37471 100644 --- a/discovery/recaptchaenterprise-v1.json +++ b/discovery/recaptchaenterprise-v1.json @@ -694,7 +694,7 @@ } } }, - "revision": "20240526", + "revision": "20240713", "rootUrl": "https://recaptchaenterprise.googleapis.com/", "schemas": { "GoogleCloudRecaptchaenterpriseV1AccountDefenderAssessment": { @@ -1032,7 +1032,7 @@ "type": "string" }, "express": { - "description": "Optional. Flag for a reCAPTCHA express request for an assessment without a token. If enabled, `site_key` must reference a SCORE key with WAF feature set to 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" }, "firewallPolicyEvaluation": { @@ -1105,6 +1105,12 @@ }, "type": "object" }, + "GoogleCloudRecaptchaenterpriseV1ExpressKeySettings": { + "description": "Settings specific to keys that can be used for reCAPTCHA Express.", + "id": "GoogleCloudRecaptchaenterpriseV1ExpressKeySettings", + "properties": {}, + "type": "object" + }, "GoogleCloudRecaptchaenterpriseV1FirewallAction": { "description": "An individual action. Each action represents what to do if a policy matches.", "id": "GoogleCloudRecaptchaenterpriseV1FirewallAction", @@ -1403,6 +1409,10 @@ "description": "Required. Human-readable display name of this key. Modifiable by user.", "type": "string" }, + "expressSettings": { + "$ref": "GoogleCloudRecaptchaenterpriseV1ExpressKeySettings", + "description": "Settings for keys that can be used by reCAPTCHA Express." + }, "iosSettings": { "$ref": "GoogleCloudRecaptchaenterpriseV1IOSKeySettings", "description": "Settings for keys that can be used by iOS apps." @@ -1411,7 +1421,7 @@ "additionalProperties": { "type": "string" }, - "description": "Optional. See [Creating and managing labels] (https://cloud.google.com/recaptcha-enterprise/docs/labels).", + "description": "Optional. See [Creating and managing labels] (https://cloud.google.com/recaptcha/docs/labels).", "type": "object" }, "name": { @@ -1541,7 +1551,7 @@ "id": "GoogleCloudRecaptchaenterpriseV1MigrateKeyRequest", "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-enterprise/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-enterprise/docs/billing-information.", + "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" } }, diff --git a/discovery/retail-v2.json b/discovery/retail-v2.json index f8bc69d5f2..09c6f2dbf7 100644 --- a/discovery/retail-v2.json +++ b/discovery/retail-v2.json @@ -2092,7 +2092,7 @@ } } }, - "revision": "20240614", + "revision": "20240711", "rootUrl": "https://retail.googleapis.com/", "schemas": { "GoogleApiHttpBody": { @@ -2637,14 +2637,6 @@ "mergedFacetKey": { "description": "The merged facet key should be a valid facet key that is different than the facet key of the current catalog attribute. We refer this is merged facet key as the child of the current catalog attribute. This merged facet key can't be a parent of another facet key (i.e. no directed path of length 2). This merged facet key needs to be either a textual custom attribute or a numerical custom attribute.", "type": "string" - }, - "mergedFacetValues": { - "deprecated": true, - "description": "Each instance is a list of facet values that map into the same (possibly different) merged facet value. For the current attribute config, each facet value should map to at most one merged facet value.", - "items": { - "$ref": "GoogleCloudRetailV2CatalogAttributeFacetConfigMergedFacetValue" - }, - "type": "array" } }, "type": "object" @@ -2752,7 +2744,7 @@ }, "GoogleCloudRetailV2CompleteQueryResponseRecentSearchResult": { "deprecated": true, - "description": "Recent search of this user.", + "description": "Deprecated: Recent search of this user.", "id": "GoogleCloudRetailV2CompleteQueryResponseRecentSearchResult", "properties": { "recentSearch": { diff --git a/discovery/retail-v2alpha.json b/discovery/retail-v2alpha.json index 12c8b7f9a9..67e11d0c35 100644 --- a/discovery/retail-v2alpha.json +++ b/discovery/retail-v2alpha.json @@ -2259,6 +2259,34 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "export": { + "description": "Exports user events. `Operation.response` is of type `ExportResponse`. `Operation.metadata` is of type `ExportMetadata`.", + "flatPath": "v2alpha/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/userEvents:export", + "httpMethod": "POST", + "id": "retail.projects.locations.catalogs.userEvents.export", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. Resource name of a Catalog. For example `projects/1234/locations/global/catalogs/default_catalog`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/catalogs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2alpha/{+parent}/userEvents:export", + "request": { + "$ref": "GoogleCloudRetailV2alphaExportUserEventsRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "import": { "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`.", "flatPath": "v2alpha/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/userEvents:import", @@ -2557,7 +2585,7 @@ } } }, - "revision": "20240614", + "revision": "20240711", "rootUrl": "https://retail.googleapis.com/", "schemas": { "GoogleApiHttpBody": { @@ -3610,16 +3638,6 @@ "readOnly": true, "type": "array" }, - "productCounts": { - "additionalProperties": { - "format": "int64", - "type": "string" - }, - "deprecated": true, - "description": "Output only. The number of products in different groups that this branch has. The key is a group representing a set of products, and the value is the number of products in that group. Note: keys in this map may change over time. Possible keys: * \"primary-in-stock\", products have Product.Type.PRIMARY type and Product.Availability.IN_STOCK availability. * \"primary-out-of-stock\", products have Product.Type.PRIMARY type and Product.Availability.OUT_OF_STOCK availability. * \"primary-preorder\", products have Product.Type.PRIMARY type and Product.Availability.PREORDER availability. * \"primary-backorder\", products have Product.Type.PRIMARY type and Product.Availability.BACKORDER availability. * \"variant-in-stock\", products have Product.Type.VARIANT type and Product.Availability.IN_STOCK availability. * \"variant-out-of-stock\", products have Product.Type.VARIANT type and Product.Availability.OUT_OF_STOCK availability. * \"variant-preorder\", products have Product.Type.VARIANT type and Product.Availability.PREORDER availability. * \"variant-backorder\", products have Product.Type.VARIANT type and Product.Availability.BACKORDER availability. * \"price-discounted\", products have [Product.price_info.price] < [Product.price_info.original_price]. This field is not populated in BranchView.BASIC view.", - "readOnly": true, - "type": "object" - }, "qualityMetrics": { "description": "Output only. The quality metrics measured among products of this branch. See QualityMetric.requirement_key for supported metrics. Metrics could be missing if failed to retrieve. This field is not populated in BranchView.BASIC view.", "items": { @@ -3902,14 +3920,6 @@ "mergedFacetKey": { "description": "The merged facet key should be a valid facet key that is different than the facet key of the current catalog attribute. We refer this is merged facet key as the child of the current catalog attribute. This merged facet key can't be a parent of another facet key (i.e. no directed path of length 2). This merged facet key needs to be either a textual custom attribute or a numerical custom attribute.", "type": "string" - }, - "mergedFacetValues": { - "deprecated": true, - "description": "Each instance is a list of facet values that map into the same (possibly different) merged facet value. For the current attribute config, each facet value should map to at most one merged facet value.", - "items": { - "$ref": "GoogleCloudRetailV2alphaCatalogAttributeFacetConfigMergedFacetValue" - }, - "type": "array" } }, "type": "object" @@ -4050,7 +4060,7 @@ }, "GoogleCloudRetailV2alphaCompleteQueryResponseRecentSearchResult": { "deprecated": true, - "description": "Recent search of this user.", + "description": "Deprecated: Recent search of this user.", "id": "GoogleCloudRetailV2alphaCompleteQueryResponseRecentSearchResult", "properties": { "recentSearch": { @@ -4501,6 +4511,21 @@ }, "type": "object" }, + "GoogleCloudRetailV2alphaExportUserEventsRequest": { + "description": "Request message for the `ExportUserEvents` method.", + "id": "GoogleCloudRetailV2alphaExportUserEventsRequest", + "properties": { + "filter": { + "description": "A filtering expression to specify restrictions on returned events. The expression is a sequence of terms. Each term applies a restriction to the returned user events. Use this expression to restrict results to a specific time range or to filter events by eventType. For example, `eventTime > \"2012-04-23T18:25:43.511Z\" eventsMissingCatalogItems eventTime<\"2012-04-23T18:25:43.511Z\" eventType=search` We expect only three types of fields: * `eventTime`: This can be specified twice, once with a less than operator and once with a greater than operator. The `eventTime` restriction should result in one, contiguous, valid, `eventTime` range. * `eventType`: Boolean operators `OR` and `NOT` are supported if the expression is enclosed in parentheses and the operators are separated from the tag values by a space. * `eventsMissingCatalogItems`: This restricts results to events for which catalog items were not found in the catalog. The default behavior is to return only those events for which catalog items were found. Some examples of valid filters expressions: * Example 1: `eventTime > \"2012-04-23T18:25:43.511Z\" eventTime < \"2012-04-23T18:30:43.511Z\"` * Example 2: `eventTime > \"2012-04-23T18:25:43.511Z\" eventType = detail-page-view` * Example 3: `eventsMissingCatalogItems eventType = (NOT search) eventTime < \"2018-04-23T18:30:43.511Z\"` * Example 4: `eventTime > \"2012-04-23T18:25:43.511Z\"` * Example 5: `eventType = (detail-page-view OR search)` * Example 6: `eventsMissingCatalogItems`", + "type": "string" + }, + "outputConfig": { + "$ref": "GoogleCloudRetailV2alphaOutputConfig", + "description": "Required. The output location of the data." + } + }, + "type": "object" + }, "GoogleCloudRetailV2alphaExportUserEventsResponse": { "description": "Response of the ExportUserEventsRequest. If the long running operation was successful, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.", "id": "GoogleCloudRetailV2alphaExportUserEventsResponse", diff --git a/discovery/retail-v2beta.json b/discovery/retail-v2beta.json index 97f75ae690..a4bebf1d8f 100644 --- a/discovery/retail-v2beta.json +++ b/discovery/retail-v2beta.json @@ -1854,6 +1854,34 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "export": { + "description": "Exports user events. `Operation.response` is of type `ExportResponse`. `Operation.metadata` is of type `ExportMetadata`.", + "flatPath": "v2beta/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/userEvents:export", + "httpMethod": "POST", + "id": "retail.projects.locations.catalogs.userEvents.export", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. Resource name of a Catalog. For example `projects/1234/locations/global/catalogs/default_catalog`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/catalogs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2beta/{+parent}/userEvents:export", + "request": { + "$ref": "GoogleCloudRetailV2betaExportUserEventsRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "import": { "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`.", "flatPath": "v2beta/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/userEvents:import", @@ -2120,7 +2148,7 @@ } } }, - "revision": "20240614", + "revision": "20240711", "rootUrl": "https://retail.googleapis.com/", "schemas": { "GoogleApiHttpBody": { @@ -4113,14 +4141,6 @@ "mergedFacetKey": { "description": "The merged facet key should be a valid facet key that is different than the facet key of the current catalog attribute. We refer this is merged facet key as the child of the current catalog attribute. This merged facet key can't be a parent of another facet key (i.e. no directed path of length 2). This merged facet key needs to be either a textual custom attribute or a numerical custom attribute.", "type": "string" - }, - "mergedFacetValues": { - "deprecated": true, - "description": "Each instance is a list of facet values that map into the same (possibly different) merged facet value. For the current attribute config, each facet value should map to at most one merged facet value.", - "items": { - "$ref": "GoogleCloudRetailV2betaCatalogAttributeFacetConfigMergedFacetValue" - }, - "type": "array" } }, "type": "object" @@ -4228,7 +4248,7 @@ }, "GoogleCloudRetailV2betaCompleteQueryResponseRecentSearchResult": { "deprecated": true, - "description": "Recent search of this user.", + "description": "Deprecated: Recent search of this user.", "id": "GoogleCloudRetailV2betaCompleteQueryResponseRecentSearchResult", "properties": { "recentSearch": { @@ -4614,6 +4634,21 @@ }, "type": "object" }, + "GoogleCloudRetailV2betaExportUserEventsRequest": { + "description": "Request message for the `ExportUserEvents` method.", + "id": "GoogleCloudRetailV2betaExportUserEventsRequest", + "properties": { + "filter": { + "description": "A filtering expression to specify restrictions on returned events. The expression is a sequence of terms. Each term applies a restriction to the returned user events. Use this expression to restrict results to a specific time range or to filter events by eventType. For example, `eventTime > \"2012-04-23T18:25:43.511Z\" eventsMissingCatalogItems eventTime<\"2012-04-23T18:25:43.511Z\" eventType=search` We expect only three types of fields: * `eventTime`: This can be specified twice, once with a less than operator and once with a greater than operator. The `eventTime` restriction should result in one, contiguous, valid, `eventTime` range. * `eventType`: Boolean operators `OR` and `NOT` are supported if the expression is enclosed in parentheses and the operators are separated from the tag values by a space. * `eventsMissingCatalogItems`: This restricts results to events for which catalog items were not found in the catalog. The default behavior is to return only those events for which catalog items were found. Some examples of valid filters expressions: * Example 1: `eventTime > \"2012-04-23T18:25:43.511Z\" eventTime < \"2012-04-23T18:30:43.511Z\"` * Example 2: `eventTime > \"2012-04-23T18:25:43.511Z\" eventType = detail-page-view` * Example 3: `eventsMissingCatalogItems eventType = (NOT search) eventTime < \"2018-04-23T18:30:43.511Z\"` * Example 4: `eventTime > \"2012-04-23T18:25:43.511Z\"` * Example 5: `eventType = (detail-page-view OR search)` * Example 6: `eventsMissingCatalogItems`", + "type": "string" + }, + "outputConfig": { + "$ref": "GoogleCloudRetailV2betaOutputConfig", + "description": "Required. The output location of the data." + } + }, + "type": "object" + }, "GoogleCloudRetailV2betaExportUserEventsResponse": { "description": "Response of the ExportUserEventsRequest. If the long running operation was successful, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.", "id": "GoogleCloudRetailV2betaExportUserEventsResponse", diff --git a/discovery/run-v1.json b/discovery/run-v1.json index 1c29b457a7..a0e3cd5d54 100644 --- a/discovery/run-v1.json +++ b/discovery/run-v1.json @@ -2614,7 +2614,7 @@ } } }, - "revision": "20240524", + "revision": "20240712", "rootUrl": "https://run.googleapis.com/", "schemas": { "Addressable": { @@ -3229,6 +3229,26 @@ "description": "Reference to an Execution. Use /Executions.GetExecution with the given name to get full execution including the latest status.", "id": "ExecutionReference", "properties": { + "completionStatus": { + "description": "Optional. Status for the execution completion.", + "enum": [ + "COMPLETION_STATUS_UNSPECIFIED", + "EXECUTION_SUCCEEDED", + "EXECUTION_FAILED", + "EXECUTION_RUNNING", + "EXECUTION_PENDING", + "EXECUTION_CANCELLED" + ], + "enumDescriptions": [ + "The default value. This value is used if the state is omitted.", + "Job execution has succeeded.", + "Job execution has failed.", + "Job execution is running normally.", + "Waiting for backing resources to be provisioned.", + "Job execution has been cancelled by the user." + ], + "type": "string" + }, "completionTimestamp": { "description": "Optional. Completion timestamp of the execution.", "format": "google-datetime", @@ -3239,6 +3259,11 @@ "format": "google-datetime", "type": "string" }, + "deletionTimestamp": { + "description": "Optional. The read-only soft deletion timestamp of the execution.", + "format": "google-datetime", + "type": "string" + }, "name": { "description": "Optional. Name of the execution.", "type": "string" @@ -4172,26 +4197,6 @@ }, "type": "object" }, - "GoogleDevtoolsCloudbuildV1GCSLocation": { - "description": "Represents a storage location in Cloud Storage", - "id": "GoogleDevtoolsCloudbuildV1GCSLocation", - "properties": { - "bucket": { - "description": "Cloud Storage bucket. See https://cloud.google.com/storage/docs/naming#requirements", - "type": "string" - }, - "generation": { - "description": "Cloud Storage generation for the object. If the generation is omitted, the latest generation will be used.", - "format": "int64", - "type": "string" - }, - "object": { - "description": "Cloud Storage object. See https://cloud.google.com/storage/docs/naming#objectnames", - "type": "string" - } - }, - "type": "object" - }, "GoogleDevtoolsCloudbuildV1GitConfig": { "description": "GitConfig is a configuration for git operations.", "id": "GoogleDevtoolsCloudbuildV1GitConfig", @@ -4255,12 +4260,8 @@ "id": "GoogleDevtoolsCloudbuildV1HttpConfig", "properties": { "proxySecretVersionName": { - "description": "SecretVersion resource of the HTTP proxy URL. The proxy URL should be in format protocol://@]proxyhost[:port].", + "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" - }, - "proxySslCaInfo": { - "$ref": "GoogleDevtoolsCloudbuildV1GCSLocation", - "description": "Optional. Cloud Storage object storing the certificate to use with the HTTP proxy." } }, "type": "object" @@ -5673,12 +5674,12 @@ "id": "RevisionSpec", "properties": { "containerConcurrency": { - "description": "ContainerConcurrency specifies the maximum allowed in-flight (concurrent) requests per container instance of the Revision. If not specified, defaults to 80.", + "description": "ContainerConcurrency specifies the maximum allowed in-flight (concurrent) requests per container instance of the Revision. If not specified or 0, defaults to 80 when requested CPU >= 1 and defaults to 1 when requested CPU < 1.", "format": "int32", "type": "integer" }, "containers": { - "description": "Required. Containers holds the single container that defines the unit of execution for this Revision. In the context of a Revision, we disallow a number of fields on this Container, including: name and lifecycle. In Cloud Run, only a single container may be provided.", + "description": "Required. Containers holds the list which define the units of execution for this Revision. In the context of a Revision, we disallow a number of fields on this Container, including: name and lifecycle.", "items": { "$ref": "Container" }, diff --git a/discovery/run-v2.json b/discovery/run-v2.json index 707d6deba9..9e6324c94e 100644 --- a/discovery/run-v2.json +++ b/discovery/run-v2.json @@ -388,6 +388,31 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] + }, + "exportProjectMetadata": { + "description": "Export generated customer metadata for a given project.", + "flatPath": "v2/projects/{projectsId}/locations/{locationsId}:exportProjectMetadata", + "httpMethod": "GET", + "id": "run.projects.locations.exportProjectMetadata", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the project of which metadata should be exported. Format: `projects/{project_id_or_number}/locations/{location}` for Project in a given location.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/{+name}:exportProjectMetadata", + "response": { + "$ref": "GoogleCloudRunV2Metadata" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] } }, "resources": { @@ -1469,7 +1494,7 @@ } } }, - "revision": "20240621", + "revision": "20240705", "rootUrl": "https://run.googleapis.com/", "schemas": { "GoogleCloudRunV2BinaryAuthorization": { @@ -2029,6 +2054,26 @@ "description": "Reference to an Execution. Use /Executions.GetExecution with the given name to get full execution including the latest status.", "id": "GoogleCloudRunV2ExecutionReference", "properties": { + "completionStatus": { + "description": "Status for the execution completion.", + "enum": [ + "COMPLETION_STATUS_UNSPECIFIED", + "EXECUTION_SUCCEEDED", + "EXECUTION_FAILED", + "EXECUTION_RUNNING", + "EXECUTION_PENDING", + "EXECUTION_CANCELLED" + ], + "enumDescriptions": [ + "The default value. This value is used if the state is omitted.", + "Job execution has succeeded.", + "Job execution has failed.", + "Job execution is running normally.", + "Waiting for backing resources to be provisioned.", + "Job execution has been cancelled by the user." + ], + "type": "string" + }, "completionTime": { "description": "Creation timestamp of the execution.", "format": "google-datetime", @@ -2039,6 +2084,11 @@ "format": "google-datetime", "type": "string" }, + "deleteTime": { + "description": "The deletion time of the execution. It is only populated as a response to a Delete request.", + "format": "google-datetime", + "type": "string" + }, "name": { "description": "Name of the execution.", "type": "string" @@ -2141,7 +2191,7 @@ "id": "GoogleCloudRunV2GCSVolumeSource", "properties": { "bucket": { - "description": "Cloud Storage Bucket name. TODO (b/344678062) Fix the error validation once dynamic mounting is public.", + "description": "Cloud Storage Bucket name.", "type": "string" }, "readOnly": { @@ -4464,26 +4514,6 @@ }, "type": "object" }, - "GoogleDevtoolsCloudbuildV1GCSLocation": { - "description": "Represents a storage location in Cloud Storage", - "id": "GoogleDevtoolsCloudbuildV1GCSLocation", - "properties": { - "bucket": { - "description": "Cloud Storage bucket. See https://cloud.google.com/storage/docs/naming#requirements", - "type": "string" - }, - "generation": { - "description": "Cloud Storage generation for the object. If the generation is omitted, the latest generation will be used.", - "format": "int64", - "type": "string" - }, - "object": { - "description": "Cloud Storage object. See https://cloud.google.com/storage/docs/naming#objectnames", - "type": "string" - } - }, - "type": "object" - }, "GoogleDevtoolsCloudbuildV1GitConfig": { "description": "GitConfig is a configuration for git operations.", "id": "GoogleDevtoolsCloudbuildV1GitConfig", @@ -4547,12 +4577,8 @@ "id": "GoogleDevtoolsCloudbuildV1HttpConfig", "properties": { "proxySecretVersionName": { - "description": "SecretVersion resource of the HTTP proxy URL. The proxy URL should be in format protocol://@]proxyhost[:port].", + "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" - }, - "proxySslCaInfo": { - "$ref": "GoogleDevtoolsCloudbuildV1GCSLocation", - "description": "Optional. Cloud Storage object storing the certificate to use with the HTTP proxy." } }, "type": "object" diff --git a/discovery/searchconsole-v1.json b/discovery/searchconsole-v1.json index 9066b7e97c..def43f3ce8 100644 --- a/discovery/searchconsole-v1.json +++ b/discovery/searchconsole-v1.json @@ -17,7 +17,7 @@ "canonicalName": "Search Console", "description": "The Search Console API provides access to both Search Console data (verified users only) and to public information on an URL basis (anyone)", "discoveryVersion": "v1", - "documentationLink": "https://developers.google.com/webmaster-tools/search-console-api/", + "documentationLink": "https://developers.google.com/webmaster-tools/about", "fullyEncodeReservedExpansion": true, "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", @@ -400,7 +400,7 @@ } } }, - "revision": "20230920", + "revision": "20240716", "rootUrl": "https://searchconsole.googleapis.com/", "schemas": { "AmpInspectionResult": { diff --git a/discovery/securitycenter-v1.json b/discovery/securitycenter-v1.json index 52642277af..80aca647a7 100644 --- a/discovery/securitycenter-v1.json +++ b/discovery/securitycenter-v1.json @@ -120,7 +120,7 @@ ], "parameters": { "parent": { - "description": "Required. The name of the parent to group the assets by. Its format is \"organizations/[organization_id]\", \"folders/[folder_id]\", or \"projects/[project_id]\".", + "description": "Required. The name of the parent to group the assets by. Its format is `organizations/[organization_id]`, `folders/[folder_id]`, or `projects/[project_id]`.", "location": "path", "pattern": "^folders/[^/]+$", "required": true, @@ -182,7 +182,7 @@ "type": "string" }, "parent": { - "description": "Required. The name of the parent resource that contains the assets. The value that you can specify on parent depends on the method in which you specify parent. You can specify one of the following values: \"organizations/[organization_id]\", \"folders/[folder_id]\", or \"projects/[project_id]\".", + "description": "Required. The name of the parent resource that contains the assets. The value that you can specify on parent depends on the method in which you specify parent. You can specify one of the following values: `organizations/[organization_id]`, `folders/[folder_id]`, or `projects/[project_id]`.", "location": "path", "pattern": "^folders/[^/]+$", "required": true, @@ -262,7 +262,7 @@ "type": "string" }, "parent": { - "description": "Required. The name of the parent resource of the new BigQuery export. Its format is \"organizations/[organization_id]\", \"folders/[folder_id]\", or \"projects/[project_id]\".", + "description": "Required. The name of the parent resource of the new BigQuery export. Its format is `organizations/[organization_id]`, `folders/[folder_id]`, or `projects/[project_id]`.", "location": "path", "pattern": "^folders/[^/]+$", "required": true, @@ -290,7 +290,7 @@ ], "parameters": { "name": { - "description": "Required. The name of the BigQuery export to delete. Its format is organizations/{organization}/bigQueryExports/{export_id}, folders/{folder}/bigQueryExports/{export_id}, or projects/{project}/bigQueryExports/{export_id}", + "description": "Required. The name of the BigQuery export to delete. Its format is `organizations/{organization}/bigQueryExports/{export_id}`, `folders/{folder}/bigQueryExports/{export_id}`, or `projects/{project}/bigQueryExports/{export_id}`", "location": "path", "pattern": "^folders/[^/]+/bigQueryExports/[^/]+$", "required": true, @@ -315,7 +315,7 @@ ], "parameters": { "name": { - "description": "Required. Name of the BigQuery export to retrieve. Its format is organizations/{organization}/bigQueryExports/{export_id}, folders/{folder}/bigQueryExports/{export_id}, or projects/{project}/bigQueryExports/{export_id}", + "description": "Required. Name of the BigQuery export to retrieve. Its format is `organizations/{organization}/bigQueryExports/{export_id}`, `folders/{folder}/bigQueryExports/{export_id}`, or `projects/{project}/bigQueryExports/{export_id}`", "location": "path", "pattern": "^folders/[^/]+/bigQueryExports/[^/]+$", "required": true, @@ -351,7 +351,7 @@ "type": "string" }, "parent": { - "description": "Required. The parent, which owns the collection of BigQuery exports. Its format is \"organizations/[organization_id]\", \"folders/[folder_id]\", \"projects/[project_id]\".", + "description": "Required. The parent, which owns the collection of BigQuery exports. Its format is `organizations/[organization_id]`, `folders/[folder_id]`, `projects/[project_id]`.", "location": "path", "pattern": "^folders/[^/]+$", "required": true, @@ -414,7 +414,7 @@ ], "parameters": { "parent": { - "description": "Required. Resource name of the parent to validate the Custom Module under. Its format is: * \"organizations/{organization}/eventThreatDetectionSettings\". * \"folders/{folder}/eventThreatDetectionSettings\". * \"projects/{project}/eventThreatDetectionSettings\".", + "description": "Required. Resource name of the parent to validate the Custom Module under. Its format is: * `organizations/{organization}/eventThreatDetectionSettings`. * `folders/{folder}/eventThreatDetectionSettings`. * `projects/{project}/eventThreatDetectionSettings`.", "location": "path", "pattern": "^folders/[^/]+/eventThreatDetectionSettings$", "required": true, @@ -446,7 +446,7 @@ ], "parameters": { "parent": { - "description": "Required. The new custom module's parent. Its format is: * \"organizations/{organization}/eventThreatDetectionSettings\". * \"folders/{folder}/eventThreatDetectionSettings\". * \"projects/{project}/eventThreatDetectionSettings\".", + "description": "Required. The new custom module's parent. Its format is: * `organizations/{organization}/eventThreatDetectionSettings`. * `folders/{folder}/eventThreatDetectionSettings`. * `projects/{project}/eventThreatDetectionSettings`.", "location": "path", "pattern": "^folders/[^/]+/eventThreatDetectionSettings$", "required": true, @@ -474,7 +474,7 @@ ], "parameters": { "name": { - "description": "Required. Name of the custom module to delete. Its format is: * \"organizations/{organization}/eventThreatDetectionSettings/customModules/{module}\". * \"folders/{folder}/eventThreatDetectionSettings/customModules/{module}\". * \"projects/{project}/eventThreatDetectionSettings/customModules/{module}\".", + "description": "Required. Name of the custom module to delete. Its format is: * `organizations/{organization}/eventThreatDetectionSettings/customModules/{module}`. * `folders/{folder}/eventThreatDetectionSettings/customModules/{module}`. * `projects/{project}/eventThreatDetectionSettings/customModules/{module}`.", "location": "path", "pattern": "^folders/[^/]+/eventThreatDetectionSettings/customModules/[^/]+$", "required": true, @@ -499,7 +499,7 @@ ], "parameters": { "name": { - "description": "Required. Name of the custom module to get. Its format is: * \"organizations/{organization}/eventThreatDetectionSettings/customModules/{module}\". * \"folders/{folder}/eventThreatDetectionSettings/customModules/{module}\". * \"projects/{project}/eventThreatDetectionSettings/customModules/{module}\".", + "description": "Required. Name of the custom module to get. Its format is: * `organizations/{organization}/eventThreatDetectionSettings/customModules/{module}`. * `folders/{folder}/eventThreatDetectionSettings/customModules/{module}`. * `projects/{project}/eventThreatDetectionSettings/customModules/{module}`.", "location": "path", "pattern": "^folders/[^/]+/eventThreatDetectionSettings/customModules/[^/]+$", "required": true, @@ -535,7 +535,7 @@ "type": "string" }, "parent": { - "description": "Required. Name of the parent to list custom modules under. Its format is: * \"organizations/{organization}/eventThreatDetectionSettings\". * \"folders/{folder}/eventThreatDetectionSettings\". * \"projects/{project}/eventThreatDetectionSettings\".", + "description": "Required. Name of the parent to list custom modules under. Its format is: * `organizations/{organization}/eventThreatDetectionSettings`. * `folders/{folder}/eventThreatDetectionSettings`. * `projects/{project}/eventThreatDetectionSettings`.", "location": "path", "pattern": "^folders/[^/]+/eventThreatDetectionSettings$", "required": true, @@ -571,7 +571,7 @@ "type": "string" }, "parent": { - "description": "Required. Name of the parent to list custom modules under. Its format is: * \"organizations/{organization}/eventThreatDetectionSettings\". * \"folders/{folder}/eventThreatDetectionSettings\". * \"projects/{project}/eventThreatDetectionSettings\".", + "description": "Required. Name of the parent to list custom modules under. Its format is: * `organizations/{organization}/eventThreatDetectionSettings`. * `folders/{folder}/eventThreatDetectionSettings`. * `projects/{project}/eventThreatDetectionSettings`.", "location": "path", "pattern": "^folders/[^/]+/eventThreatDetectionSettings$", "required": true, @@ -596,7 +596,7 @@ ], "parameters": { "name": { - "description": "Immutable. The resource name of the Event Threat Detection custom module. Its format is: * \"organizations/{organization}/eventThreatDetectionSettings/customModules/{module}\". * \"folders/{folder}/eventThreatDetectionSettings/customModules/{module}\". * \"projects/{project}/eventThreatDetectionSettings/customModules/{module}\".", + "description": "Immutable. The resource name of the Event Threat Detection custom module. Its format is: * `organizations/{organization}/eventThreatDetectionSettings/customModules/{module}`. * `folders/{folder}/eventThreatDetectionSettings/customModules/{module}`. * `projects/{project}/eventThreatDetectionSettings/customModules/{module}`.", "location": "path", "pattern": "^folders/[^/]+/eventThreatDetectionSettings/customModules/[^/]+$", "required": true, @@ -634,7 +634,7 @@ ], "parameters": { "name": { - "description": "Required. The resource name of the effective Event Threat Detection custom module. Its format is: * \"organizations/{organization}/eventThreatDetectionSettings/effectiveCustomModules/{module}\". * \"folders/{folder}/eventThreatDetectionSettings/effectiveCustomModules/{module}\". * \"projects/{project}/eventThreatDetectionSettings/effectiveCustomModules/{module}\".", + "description": "Required. The resource name of the effective Event Threat Detection custom module. Its format is: * `organizations/{organization}/eventThreatDetectionSettings/effectiveCustomModules/{module}`. * `folders/{folder}/eventThreatDetectionSettings/effectiveCustomModules/{module}`. * `projects/{project}/eventThreatDetectionSettings/effectiveCustomModules/{module}`.", "location": "path", "pattern": "^folders/[^/]+/eventThreatDetectionSettings/effectiveCustomModules/[^/]+$", "required": true, @@ -670,7 +670,7 @@ "type": "string" }, "parent": { - "description": "Required. Name of the parent to list custom modules for. Its format is: * \"organizations/{organization}/eventThreatDetectionSettings\". * \"folders/{folder}/eventThreatDetectionSettings\". * \"projects/{project}/eventThreatDetectionSettings\".", + "description": "Required. Name of the parent to list custom modules for. Its format is: * `organizations/{organization}/eventThreatDetectionSettings`. * `folders/{folder}/eventThreatDetectionSettings`. * `projects/{project}/eventThreatDetectionSettings`.", "location": "path", "pattern": "^folders/[^/]+/eventThreatDetectionSettings$", "required": true, @@ -701,7 +701,7 @@ ], "parameters": { "parent": { - "description": "Required. The parent, at which bulk action needs to be applied. Its format is \"organizations/[organization_id]\", \"folders/[folder_id]\", \"projects/[project_id]\".", + "description": "Required. The parent, at which bulk action needs to be applied. Its format is `organizations/[organization_id]`, `folders/[folder_id]`, `projects/[project_id]`.", "location": "path", "pattern": "^folders/[^/]+$", "required": true, @@ -740,7 +740,7 @@ "type": "string" }, "parent": { - "description": "Required. Resource name of the new mute configs's parent. Its format is \"organizations/[organization_id]\", \"folders/[folder_id]\", or \"projects/[project_id]\".", + "description": "Required. Resource name of the new mute configs's parent. Its format is `organizations/[organization_id]`, `folders/[folder_id]`, or `projects/[project_id]`.", "location": "path", "pattern": "^folders/[^/]+/locations/[^/]+$", "required": true, @@ -768,7 +768,7 @@ ], "parameters": { "name": { - "description": "Required. Name of the mute config to delete. Its format is organizations/{organization}/muteConfigs/{config_id}, folders/{folder}/muteConfigs/{config_id}, projects/{project}/muteConfigs/{config_id}, organizations/{organization}/locations/global/muteConfigs/{config_id}, folders/{folder}/locations/global/muteConfigs/{config_id}, or projects/{project}/locations/global/muteConfigs/{config_id}.", + "description": "Required. Name of the mute config to delete. Its format is `organizations/{organization}/muteConfigs/{config_id}`, `folders/{folder}/muteConfigs/{config_id}`, `projects/{project}/muteConfigs/{config_id}`, `organizations/{organization}/locations/global/muteConfigs/{config_id}`, `folders/{folder}/locations/global/muteConfigs/{config_id}`, or `projects/{project}/locations/global/muteConfigs/{config_id}`.", "location": "path", "pattern": "^folders/[^/]+/locations/[^/]+/muteConfigs/[^/]+$", "required": true, @@ -793,7 +793,7 @@ ], "parameters": { "name": { - "description": "Required. Name of the mute config to retrieve. Its format is organizations/{organization}/muteConfigs/{config_id}, folders/{folder}/muteConfigs/{config_id}, projects/{project}/muteConfigs/{config_id}, organizations/{organization}/locations/global/muteConfigs/{config_id}, folders/{folder}/locations/global/muteConfigs/{config_id}, or projects/{project}/locations/global/muteConfigs/{config_id}.", + "description": "Required. Name of the mute config to retrieve. Its format is `organizations/{organization}/muteConfigs/{config_id}`, `folders/{folder}/muteConfigs/{config_id}`, `projects/{project}/muteConfigs/{config_id}`, `organizations/{organization}/locations/global/muteConfigs/{config_id}`, `folders/{folder}/locations/global/muteConfigs/{config_id}`, or `projects/{project}/locations/global/muteConfigs/{config_id}`.", "location": "path", "pattern": "^folders/[^/]+/locations/[^/]+/muteConfigs/[^/]+$", "required": true, @@ -829,7 +829,7 @@ "type": "string" }, "parent": { - "description": "Required. The parent, which owns the collection of mute configs. Its format is \"organizations/[organization_id]\", \"folders/[folder_id]\", \"projects/[project_id]\".", + "description": "Required. The parent, which owns the collection of mute configs. Its format is `organizations/[organization_id]`, `folders/[folder_id]`, `projects/[project_id]`.", "location": "path", "pattern": "^folders/[^/]+/locations/[^/]+/muteConfigs$", "required": true, @@ -854,7 +854,7 @@ ], "parameters": { "name": { - "description": "This field will be ignored if provided on config creation. Format \"organizations/{organization}/muteConfigs/{mute_config}\" \"folders/{folder}/muteConfigs/{mute_config}\" \"projects/{project}/muteConfigs/{mute_config}\" \"organizations/{organization}/locations/global/muteConfigs/{mute_config}\" \"folders/{folder}/locations/global/muteConfigs/{mute_config}\" \"projects/{project}/locations/global/muteConfigs/{mute_config}\"", + "description": "This field will be ignored if provided on config creation. Format `organizations/{organization}/muteConfigs/{mute_config}` `folders/{folder}/muteConfigs/{mute_config}` `projects/{project}/muteConfigs/{mute_config}` `organizations/{organization}/locations/global/muteConfigs/{mute_config}` `folders/{folder}/locations/global/muteConfigs/{mute_config}` `projects/{project}/locations/global/muteConfigs/{mute_config}`", "location": "path", "pattern": "^folders/[^/]+/locations/[^/]+/muteConfigs/[^/]+$", "required": true, @@ -899,7 +899,7 @@ "type": "string" }, "parent": { - "description": "Required. Resource name of the new mute configs's parent. Its format is \"organizations/[organization_id]\", \"folders/[folder_id]\", or \"projects/[project_id]\".", + "description": "Required. Resource name of the new mute configs's parent. Its format is `organizations/[organization_id]`, `folders/[folder_id]`, or `projects/[project_id]`.", "location": "path", "pattern": "^folders/[^/]+$", "required": true, @@ -927,7 +927,7 @@ ], "parameters": { "name": { - "description": "Required. Name of the mute config to delete. Its format is organizations/{organization}/muteConfigs/{config_id}, folders/{folder}/muteConfigs/{config_id}, projects/{project}/muteConfigs/{config_id}, organizations/{organization}/locations/global/muteConfigs/{config_id}, folders/{folder}/locations/global/muteConfigs/{config_id}, or projects/{project}/locations/global/muteConfigs/{config_id}.", + "description": "Required. Name of the mute config to delete. Its format is `organizations/{organization}/muteConfigs/{config_id}`, `folders/{folder}/muteConfigs/{config_id}`, `projects/{project}/muteConfigs/{config_id}`, `organizations/{organization}/locations/global/muteConfigs/{config_id}`, `folders/{folder}/locations/global/muteConfigs/{config_id}`, or `projects/{project}/locations/global/muteConfigs/{config_id}`.", "location": "path", "pattern": "^folders/[^/]+/muteConfigs/[^/]+$", "required": true, @@ -952,7 +952,7 @@ ], "parameters": { "name": { - "description": "Required. Name of the mute config to retrieve. Its format is organizations/{organization}/muteConfigs/{config_id}, folders/{folder}/muteConfigs/{config_id}, projects/{project}/muteConfigs/{config_id}, organizations/{organization}/locations/global/muteConfigs/{config_id}, folders/{folder}/locations/global/muteConfigs/{config_id}, or projects/{project}/locations/global/muteConfigs/{config_id}.", + "description": "Required. Name of the mute config to retrieve. Its format is `organizations/{organization}/muteConfigs/{config_id}`, `folders/{folder}/muteConfigs/{config_id}`, `projects/{project}/muteConfigs/{config_id}`, `organizations/{organization}/locations/global/muteConfigs/{config_id}`, `folders/{folder}/locations/global/muteConfigs/{config_id}`, or `projects/{project}/locations/global/muteConfigs/{config_id}`.", "location": "path", "pattern": "^folders/[^/]+/muteConfigs/[^/]+$", "required": true, @@ -988,7 +988,7 @@ "type": "string" }, "parent": { - "description": "Required. The parent, which owns the collection of mute configs. Its format is \"organizations/[organization_id]\", \"folders/[folder_id]\", \"projects/[project_id]\".", + "description": "Required. The parent, which owns the collection of mute configs. Its format is `organizations/[organization_id]`, `folders/[folder_id]`, `projects/[project_id]`.", "location": "path", "pattern": "^folders/[^/]+$", "required": true, @@ -1013,7 +1013,7 @@ ], "parameters": { "name": { - "description": "This field will be ignored if provided on config creation. Format \"organizations/{organization}/muteConfigs/{mute_config}\" \"folders/{folder}/muteConfigs/{mute_config}\" \"projects/{project}/muteConfigs/{mute_config}\" \"organizations/{organization}/locations/global/muteConfigs/{mute_config}\" \"folders/{folder}/locations/global/muteConfigs/{mute_config}\" \"projects/{project}/locations/global/muteConfigs/{mute_config}\"", + "description": "This field will be ignored if provided on config creation. Format `organizations/{organization}/muteConfigs/{mute_config}` `folders/{folder}/muteConfigs/{mute_config}` `projects/{project}/muteConfigs/{mute_config}` `organizations/{organization}/locations/global/muteConfigs/{mute_config}` `folders/{folder}/locations/global/muteConfigs/{mute_config}` `projects/{project}/locations/global/muteConfigs/{mute_config}`", "location": "path", "pattern": "^folders/[^/]+/muteConfigs/[^/]+$", "required": true, @@ -1056,7 +1056,7 @@ "type": "string" }, "parent": { - "description": "Required. Resource name of the new notification config's parent. Its format is \"organizations/[organization_id]\", \"folders/[folder_id]\", or \"projects/[project_id]\".", + "description": "Required. Resource name of the new notification config's parent. Its format is `organizations/[organization_id]`, `folders/[folder_id]`, or `projects/[project_id]`.", "location": "path", "pattern": "^folders/[^/]+$", "required": true, @@ -1084,7 +1084,7 @@ ], "parameters": { "name": { - "description": "Required. Name of the notification config to delete. Its format is \"organizations/[organization_id]/notificationConfigs/[config_id]\", \"folders/[folder_id]/notificationConfigs/[config_id]\", or \"projects/[project_id]/notificationConfigs/[config_id]\".", + "description": "Required. Name of the notification config to delete. Its format is `organizations/[organization_id]/notificationConfigs/[config_id]`, `folders/[folder_id]/notificationConfigs/[config_id]`, or `projects/[project_id]/notificationConfigs/[config_id]`.", "location": "path", "pattern": "^folders/[^/]+/notificationConfigs/[^/]+$", "required": true, @@ -1109,7 +1109,7 @@ ], "parameters": { "name": { - "description": "Required. Name of the notification config to get. Its format is \"organizations/[organization_id]/notificationConfigs/[config_id]\", \"folders/[folder_id]/notificationConfigs/[config_id]\", or \"projects/[project_id]/notificationConfigs/[config_id]\".", + "description": "Required. Name of the notification config to get. Its format is `organizations/[organization_id]/notificationConfigs/[config_id]`, `folders/[folder_id]/notificationConfigs/[config_id]`, or `projects/[project_id]/notificationConfigs/[config_id]`.", "location": "path", "pattern": "^folders/[^/]+/notificationConfigs/[^/]+$", "required": true, @@ -1210,7 +1210,7 @@ ], "parameters": { "parent": { - "description": "Required. Resource name of the new custom module's parent. Its format is \"organizations/{organization}/securityHealthAnalyticsSettings\", \"folders/{folder}/securityHealthAnalyticsSettings\", or \"projects/{project}/securityHealthAnalyticsSettings\"", + "description": "Required. Resource name of the new custom module's parent. Its format is `organizations/{organization}/securityHealthAnalyticsSettings`, `folders/{folder}/securityHealthAnalyticsSettings`, or `projects/{project}/securityHealthAnalyticsSettings`", "location": "path", "pattern": "^folders/[^/]+/securityHealthAnalyticsSettings$", "required": true, @@ -1238,7 +1238,7 @@ ], "parameters": { "name": { - "description": "Required. Name of the custom module to delete. Its format is \"organizations/{organization}/securityHealthAnalyticsSettings/customModules/{customModule}\", \"folders/{folder}/securityHealthAnalyticsSettings/customModules/{customModule}\", or \"projects/{project}/securityHealthAnalyticsSettings/customModules/{customModule}\"", + "description": "Required. Name of the custom module to delete. Its format is `organizations/{organization}/securityHealthAnalyticsSettings/customModules/{customModule}`, `folders/{folder}/securityHealthAnalyticsSettings/customModules/{customModule}`, or `projects/{project}/securityHealthAnalyticsSettings/customModules/{customModule}`", "location": "path", "pattern": "^folders/[^/]+/securityHealthAnalyticsSettings/customModules/[^/]+$", "required": true, @@ -1263,7 +1263,7 @@ ], "parameters": { "name": { - "description": "Required. Name of the custom module to get. Its format is \"organizations/{organization}/securityHealthAnalyticsSettings/customModules/{customModule}\", \"folders/{folder}/securityHealthAnalyticsSettings/customModules/{customModule}\", or \"projects/{project}/securityHealthAnalyticsSettings/customModules/{customModule}\"", + "description": "Required. Name of the custom module to get. Its format is `organizations/{organization}/securityHealthAnalyticsSettings/customModules/{customModule}`, `folders/{folder}/securityHealthAnalyticsSettings/customModules/{customModule}`, or `projects/{project}/securityHealthAnalyticsSettings/customModules/{customModule}`", "location": "path", "pattern": "^folders/[^/]+/securityHealthAnalyticsSettings/customModules/[^/]+$", "required": true, @@ -1299,7 +1299,7 @@ "type": "string" }, "parent": { - "description": "Required. Name of parent to list custom modules. Its format is \"organizations/{organization}/securityHealthAnalyticsSettings\", \"folders/{folder}/securityHealthAnalyticsSettings\", or \"projects/{project}/securityHealthAnalyticsSettings\"", + "description": "Required. Name of parent to list custom modules. Its format is `organizations/{organization}/securityHealthAnalyticsSettings`, `folders/{folder}/securityHealthAnalyticsSettings`, or `projects/{project}/securityHealthAnalyticsSettings`", "location": "path", "pattern": "^folders/[^/]+/securityHealthAnalyticsSettings$", "required": true, @@ -1335,7 +1335,7 @@ "type": "string" }, "parent": { - "description": "Required. Name of parent to list descendant custom modules. Its format is \"organizations/{organization}/securityHealthAnalyticsSettings\", \"folders/{folder}/securityHealthAnalyticsSettings\", or \"projects/{project}/securityHealthAnalyticsSettings\"", + "description": "Required. Name of parent to list descendant custom modules. Its format is `organizations/{organization}/securityHealthAnalyticsSettings`, `folders/{folder}/securityHealthAnalyticsSettings`, or `projects/{project}/securityHealthAnalyticsSettings`", "location": "path", "pattern": "^folders/[^/]+/securityHealthAnalyticsSettings$", "required": true, @@ -1426,7 +1426,7 @@ ], "parameters": { "name": { - "description": "Required. Name of the effective custom module to get. Its format is \"organizations/{organization}/securityHealthAnalyticsSettings/effectiveCustomModules/{customModule}\", \"folders/{folder}/securityHealthAnalyticsSettings/effectiveCustomModules/{customModule}\", or \"projects/{project}/securityHealthAnalyticsSettings/effectiveCustomModules/{customModule}\"", + "description": "Required. Name of the effective custom module to get. Its format is `organizations/{organization}/securityHealthAnalyticsSettings/effectiveCustomModules/{customModule}`, `folders/{folder}/securityHealthAnalyticsSettings/effectiveCustomModules/{customModule}`, or `projects/{project}/securityHealthAnalyticsSettings/effectiveCustomModules/{customModule}`", "location": "path", "pattern": "^folders/[^/]+/securityHealthAnalyticsSettings/effectiveCustomModules/[^/]+$", "required": true, @@ -1462,7 +1462,7 @@ "type": "string" }, "parent": { - "description": "Required. Name of parent to list effective custom modules. Its format is \"organizations/{organization}/securityHealthAnalyticsSettings\", \"folders/{folder}/securityHealthAnalyticsSettings\", or \"projects/{project}/securityHealthAnalyticsSettings\"", + "description": "Required. Name of parent to list effective custom modules. Its format is `organizations/{organization}/securityHealthAnalyticsSettings`, `folders/{folder}/securityHealthAnalyticsSettings`, or `projects/{project}/securityHealthAnalyticsSettings`", "location": "path", "pattern": "^folders/[^/]+/securityHealthAnalyticsSettings$", "required": true, @@ -1504,7 +1504,7 @@ "type": "string" }, "parent": { - "description": "Required. Resource name of the parent of sources to list. Its format should be \"organizations/[organization_id]\", \"folders/[folder_id]\", or \"projects/[project_id]\".", + "description": "Required. Resource name of the parent of sources to list. Its format should be `organizations/[organization_id]`, `folders/[folder_id]`, or `projects/[project_id]`.", "location": "path", "pattern": "^folders/[^/]+$", "required": true, @@ -1533,7 +1533,7 @@ ], "parameters": { "parent": { - "description": "Required. Name of the source to groupBy. Its format is \"organizations/[organization_id]/sources/[source_id]\", folders/[folder_id]/sources/[source_id], or projects/[project_id]/sources/[source_id]. To groupBy across all sources provide a source_id of `-`. For example: organizations/{organization_id}/sources/-, folders/{folder_id}/sources/-, or projects/{project_id}/sources/-", + "description": "Required. Name of the source to groupBy. Its format is `organizations/[organization_id]/sources/[source_id]`, `folders/[folder_id]/sources/[source_id]`, or `projects/[project_id]/sources/[source_id]`. To groupBy across all sources provide a source_id of `-`. For example: `organizations/{organization_id}/sources/-, folders/{folder_id}/sources/-`, or `projects/{project_id}/sources/-`", "location": "path", "pattern": "^folders/[^/]+/sources/[^/]+$", "required": true, @@ -1594,7 +1594,7 @@ "type": "string" }, "parent": { - "description": "Required. Name of the source the findings belong to. Its format is \"organizations/[organization_id]/sources/[source_id], folders/[folder_id]/sources/[source_id], or projects/[project_id]/sources/[source_id]\". To list across all sources provide a source_id of `-`. For example: organizations/{organization_id}/sources/-, folders/{folder_id}/sources/- or projects/{projects_id}/sources/-", + "description": "Required. Name of the source the findings belong to. Its format is `organizations/[organization_id]/sources/[source_id]`, `folders/[folder_id]/sources/[source_id]`, or `projects/[project_id]/sources/[source_id]`. To list across all sources provide a source_id of `-`. For example: `organizations/{organization_id}/sources/-`, `folders/{folder_id}/sources/-` or `projects/{projects_id}/sources/-`", "location": "path", "pattern": "^folders/[^/]+/sources/[^/]+$", "required": true, @@ -1659,7 +1659,7 @@ ], "parameters": { "name": { - "description": "Required. The [relative resource name](https://cloud.google.com/apis/design/resource_names#relative_resource_name) of the finding. Example: \"organizations/{organization_id}/sources/{source_id}/findings/{finding_id}\", \"folders/{folder_id}/sources/{source_id}/findings/{finding_id}\", \"projects/{project_id}/sources/{source_id}/findings/{finding_id}\".", + "description": "Required. The [relative resource name](https://cloud.google.com/apis/design/resource_names#relative_resource_name) of the finding. Example: `organizations/{organization_id}/sources/{source_id}/findings/{finding_id}`, `folders/{folder_id}/sources/{source_id}/findings/{finding_id}`, `projects/{project_id}/sources/{source_id}/findings/{finding_id}`.", "location": "path", "pattern": "^folders/[^/]+/sources/[^/]+/findings/[^/]+$", "required": true, @@ -1687,7 +1687,7 @@ ], "parameters": { "name": { - "description": "Required. The [relative resource name](https://cloud.google.com/apis/design/resource_names#relative_resource_name) of the finding. Example: \"organizations/{organization_id}/sources/{source_id}/findings/{finding_id}\", \"folders/{folder_id}/sources/{source_id}/findings/{finding_id}\", \"projects/{project_id}/sources/{source_id}/findings/{finding_id}\".", + "description": "Required. The [relative resource name](https://cloud.google.com/apis/design/resource_names#relative_resource_name) of the finding. Example: `organizations/{organization_id}/sources/{source_id}/findings/{finding_id}`, `folders/{folder_id}/sources/{source_id}/findings/{finding_id}`, `projects/{project_id}/sources/{source_id}/findings/{finding_id}`.", "location": "path", "pattern": "^folders/[^/]+/sources/[^/]+/findings/[^/]+$", "required": true, @@ -1803,7 +1803,7 @@ ], "parameters": { "name": { - "description": "Required. Name of the organization to get organization settings for. Its format is \"organizations/[organization_id]/organizationSettings\".", + "description": "Required. Name of the organization to get organization settings for. Its format is `organizations/[organization_id]/organizationSettings`.", "location": "path", "pattern": "^organizations/[^/]+/organizationSettings$", "required": true, @@ -1867,7 +1867,7 @@ ], "parameters": { "parent": { - "description": "Required. The name of the parent to group the assets by. Its format is \"organizations/[organization_id]\", \"folders/[folder_id]\", or \"projects/[project_id]\".", + "description": "Required. The name of the parent to group the assets by. Its format is `organizations/[organization_id]`, `folders/[folder_id]`, or `projects/[project_id]`.", "location": "path", "pattern": "^organizations/[^/]+$", "required": true, @@ -1929,7 +1929,7 @@ "type": "string" }, "parent": { - "description": "Required. The name of the parent resource that contains the assets. The value that you can specify on parent depends on the method in which you specify parent. You can specify one of the following values: \"organizations/[organization_id]\", \"folders/[folder_id]\", or \"projects/[project_id]\".", + "description": "Required. The name of the parent resource that contains the assets. The value that you can specify on parent depends on the method in which you specify parent. You can specify one of the following values: `organizations/[organization_id]`, `folders/[folder_id]`, or `projects/[project_id]`.", "location": "path", "pattern": "^organizations/[^/]+$", "required": true, @@ -1961,7 +1961,7 @@ ], "parameters": { "parent": { - "description": "Required. Name of the organization to run asset discovery for. Its format is \"organizations/[organization_id]\".", + "description": "Required. Name of the organization to run asset discovery for. Its format is `organizations/[organization_id]`.", "location": "path", "pattern": "^organizations/[^/]+$", "required": true, @@ -2038,7 +2038,7 @@ "type": "string" }, "parent": { - "description": "Required. The name of the parent resource of the new BigQuery export. Its format is \"organizations/[organization_id]\", \"folders/[folder_id]\", or \"projects/[project_id]\".", + "description": "Required. The name of the parent resource of the new BigQuery export. Its format is `organizations/[organization_id]`, `folders/[folder_id]`, or `projects/[project_id]`.", "location": "path", "pattern": "^organizations/[^/]+$", "required": true, @@ -2066,7 +2066,7 @@ ], "parameters": { "name": { - "description": "Required. The name of the BigQuery export to delete. Its format is organizations/{organization}/bigQueryExports/{export_id}, folders/{folder}/bigQueryExports/{export_id}, or projects/{project}/bigQueryExports/{export_id}", + "description": "Required. The name of the BigQuery export to delete. Its format is `organizations/{organization}/bigQueryExports/{export_id}`, `folders/{folder}/bigQueryExports/{export_id}`, or `projects/{project}/bigQueryExports/{export_id}`", "location": "path", "pattern": "^organizations/[^/]+/bigQueryExports/[^/]+$", "required": true, @@ -2091,7 +2091,7 @@ ], "parameters": { "name": { - "description": "Required. Name of the BigQuery export to retrieve. Its format is organizations/{organization}/bigQueryExports/{export_id}, folders/{folder}/bigQueryExports/{export_id}, or projects/{project}/bigQueryExports/{export_id}", + "description": "Required. Name of the BigQuery export to retrieve. Its format is `organizations/{organization}/bigQueryExports/{export_id}`, `folders/{folder}/bigQueryExports/{export_id}`, or `projects/{project}/bigQueryExports/{export_id}`", "location": "path", "pattern": "^organizations/[^/]+/bigQueryExports/[^/]+$", "required": true, @@ -2127,7 +2127,7 @@ "type": "string" }, "parent": { - "description": "Required. The parent, which owns the collection of BigQuery exports. Its format is \"organizations/[organization_id]\", \"folders/[folder_id]\", \"projects/[project_id]\".", + "description": "Required. The parent, which owns the collection of BigQuery exports. Its format is `organizations/[organization_id]`, `folders/[folder_id]`, `projects/[project_id]`.", "location": "path", "pattern": "^organizations/[^/]+$", "required": true, @@ -2190,7 +2190,7 @@ ], "parameters": { "parent": { - "description": "Required. Resource name of the parent to validate the Custom Module under. Its format is: * \"organizations/{organization}/eventThreatDetectionSettings\". * \"folders/{folder}/eventThreatDetectionSettings\". * \"projects/{project}/eventThreatDetectionSettings\".", + "description": "Required. Resource name of the parent to validate the Custom Module under. Its format is: * `organizations/{organization}/eventThreatDetectionSettings`. * `folders/{folder}/eventThreatDetectionSettings`. * `projects/{project}/eventThreatDetectionSettings`.", "location": "path", "pattern": "^organizations/[^/]+/eventThreatDetectionSettings$", "required": true, @@ -2222,7 +2222,7 @@ ], "parameters": { "parent": { - "description": "Required. The new custom module's parent. Its format is: * \"organizations/{organization}/eventThreatDetectionSettings\". * \"folders/{folder}/eventThreatDetectionSettings\". * \"projects/{project}/eventThreatDetectionSettings\".", + "description": "Required. The new custom module's parent. Its format is: * `organizations/{organization}/eventThreatDetectionSettings`. * `folders/{folder}/eventThreatDetectionSettings`. * `projects/{project}/eventThreatDetectionSettings`.", "location": "path", "pattern": "^organizations/[^/]+/eventThreatDetectionSettings$", "required": true, @@ -2250,7 +2250,7 @@ ], "parameters": { "name": { - "description": "Required. Name of the custom module to delete. Its format is: * \"organizations/{organization}/eventThreatDetectionSettings/customModules/{module}\". * \"folders/{folder}/eventThreatDetectionSettings/customModules/{module}\". * \"projects/{project}/eventThreatDetectionSettings/customModules/{module}\".", + "description": "Required. Name of the custom module to delete. Its format is: * `organizations/{organization}/eventThreatDetectionSettings/customModules/{module}`. * `folders/{folder}/eventThreatDetectionSettings/customModules/{module}`. * `projects/{project}/eventThreatDetectionSettings/customModules/{module}`.", "location": "path", "pattern": "^organizations/[^/]+/eventThreatDetectionSettings/customModules/[^/]+$", "required": true, @@ -2275,7 +2275,7 @@ ], "parameters": { "name": { - "description": "Required. Name of the custom module to get. Its format is: * \"organizations/{organization}/eventThreatDetectionSettings/customModules/{module}\". * \"folders/{folder}/eventThreatDetectionSettings/customModules/{module}\". * \"projects/{project}/eventThreatDetectionSettings/customModules/{module}\".", + "description": "Required. Name of the custom module to get. Its format is: * `organizations/{organization}/eventThreatDetectionSettings/customModules/{module}`. * `folders/{folder}/eventThreatDetectionSettings/customModules/{module}`. * `projects/{project}/eventThreatDetectionSettings/customModules/{module}`.", "location": "path", "pattern": "^organizations/[^/]+/eventThreatDetectionSettings/customModules/[^/]+$", "required": true, @@ -2311,7 +2311,7 @@ "type": "string" }, "parent": { - "description": "Required. Name of the parent to list custom modules under. Its format is: * \"organizations/{organization}/eventThreatDetectionSettings\". * \"folders/{folder}/eventThreatDetectionSettings\". * \"projects/{project}/eventThreatDetectionSettings\".", + "description": "Required. Name of the parent to list custom modules under. Its format is: * `organizations/{organization}/eventThreatDetectionSettings`. * `folders/{folder}/eventThreatDetectionSettings`. * `projects/{project}/eventThreatDetectionSettings`.", "location": "path", "pattern": "^organizations/[^/]+/eventThreatDetectionSettings$", "required": true, @@ -2347,7 +2347,7 @@ "type": "string" }, "parent": { - "description": "Required. Name of the parent to list custom modules under. Its format is: * \"organizations/{organization}/eventThreatDetectionSettings\". * \"folders/{folder}/eventThreatDetectionSettings\". * \"projects/{project}/eventThreatDetectionSettings\".", + "description": "Required. Name of the parent to list custom modules under. Its format is: * `organizations/{organization}/eventThreatDetectionSettings`. * `folders/{folder}/eventThreatDetectionSettings`. * `projects/{project}/eventThreatDetectionSettings`.", "location": "path", "pattern": "^organizations/[^/]+/eventThreatDetectionSettings$", "required": true, @@ -2372,7 +2372,7 @@ ], "parameters": { "name": { - "description": "Immutable. The resource name of the Event Threat Detection custom module. Its format is: * \"organizations/{organization}/eventThreatDetectionSettings/customModules/{module}\". * \"folders/{folder}/eventThreatDetectionSettings/customModules/{module}\". * \"projects/{project}/eventThreatDetectionSettings/customModules/{module}\".", + "description": "Immutable. The resource name of the Event Threat Detection custom module. Its format is: * `organizations/{organization}/eventThreatDetectionSettings/customModules/{module}`. * `folders/{folder}/eventThreatDetectionSettings/customModules/{module}`. * `projects/{project}/eventThreatDetectionSettings/customModules/{module}`.", "location": "path", "pattern": "^organizations/[^/]+/eventThreatDetectionSettings/customModules/[^/]+$", "required": true, @@ -2410,7 +2410,7 @@ ], "parameters": { "name": { - "description": "Required. The resource name of the effective Event Threat Detection custom module. Its format is: * \"organizations/{organization}/eventThreatDetectionSettings/effectiveCustomModules/{module}\". * \"folders/{folder}/eventThreatDetectionSettings/effectiveCustomModules/{module}\". * \"projects/{project}/eventThreatDetectionSettings/effectiveCustomModules/{module}\".", + "description": "Required. The resource name of the effective Event Threat Detection custom module. Its format is: * `organizations/{organization}/eventThreatDetectionSettings/effectiveCustomModules/{module}`. * `folders/{folder}/eventThreatDetectionSettings/effectiveCustomModules/{module}`. * `projects/{project}/eventThreatDetectionSettings/effectiveCustomModules/{module}`.", "location": "path", "pattern": "^organizations/[^/]+/eventThreatDetectionSettings/effectiveCustomModules/[^/]+$", "required": true, @@ -2446,7 +2446,7 @@ "type": "string" }, "parent": { - "description": "Required. Name of the parent to list custom modules for. Its format is: * \"organizations/{organization}/eventThreatDetectionSettings\". * \"folders/{folder}/eventThreatDetectionSettings\". * \"projects/{project}/eventThreatDetectionSettings\".", + "description": "Required. Name of the parent to list custom modules for. Its format is: * `organizations/{organization}/eventThreatDetectionSettings`. * `folders/{folder}/eventThreatDetectionSettings`. * `projects/{project}/eventThreatDetectionSettings`.", "location": "path", "pattern": "^organizations/[^/]+/eventThreatDetectionSettings$", "required": true, @@ -2477,7 +2477,7 @@ ], "parameters": { "parent": { - "description": "Required. The parent, at which bulk action needs to be applied. Its format is \"organizations/[organization_id]\", \"folders/[folder_id]\", \"projects/[project_id]\".", + "description": "Required. The parent, at which bulk action needs to be applied. Its format is `organizations/[organization_id]`, `folders/[folder_id]`, `projects/[project_id]`.", "location": "path", "pattern": "^organizations/[^/]+$", "required": true, @@ -2516,7 +2516,7 @@ "type": "string" }, "parent": { - "description": "Required. Resource name of the new mute configs's parent. Its format is \"organizations/[organization_id]\", \"folders/[folder_id]\", or \"projects/[project_id]\".", + "description": "Required. Resource name of the new mute configs's parent. Its format is `organizations/[organization_id]`, `folders/[folder_id]`, or `projects/[project_id]`.", "location": "path", "pattern": "^organizations/[^/]+/locations/[^/]+$", "required": true, @@ -2544,7 +2544,7 @@ ], "parameters": { "name": { - "description": "Required. Name of the mute config to delete. Its format is organizations/{organization}/muteConfigs/{config_id}, folders/{folder}/muteConfigs/{config_id}, projects/{project}/muteConfigs/{config_id}, organizations/{organization}/locations/global/muteConfigs/{config_id}, folders/{folder}/locations/global/muteConfigs/{config_id}, or projects/{project}/locations/global/muteConfigs/{config_id}.", + "description": "Required. Name of the mute config to delete. Its format is `organizations/{organization}/muteConfigs/{config_id}`, `folders/{folder}/muteConfigs/{config_id}`, `projects/{project}/muteConfigs/{config_id}`, `organizations/{organization}/locations/global/muteConfigs/{config_id}`, `folders/{folder}/locations/global/muteConfigs/{config_id}`, or `projects/{project}/locations/global/muteConfigs/{config_id}`.", "location": "path", "pattern": "^organizations/[^/]+/locations/[^/]+/muteConfigs/[^/]+$", "required": true, @@ -2569,7 +2569,7 @@ ], "parameters": { "name": { - "description": "Required. Name of the mute config to retrieve. Its format is organizations/{organization}/muteConfigs/{config_id}, folders/{folder}/muteConfigs/{config_id}, projects/{project}/muteConfigs/{config_id}, organizations/{organization}/locations/global/muteConfigs/{config_id}, folders/{folder}/locations/global/muteConfigs/{config_id}, or projects/{project}/locations/global/muteConfigs/{config_id}.", + "description": "Required. Name of the mute config to retrieve. Its format is `organizations/{organization}/muteConfigs/{config_id}`, `folders/{folder}/muteConfigs/{config_id}`, `projects/{project}/muteConfigs/{config_id}`, `organizations/{organization}/locations/global/muteConfigs/{config_id}`, `folders/{folder}/locations/global/muteConfigs/{config_id}`, or `projects/{project}/locations/global/muteConfigs/{config_id}`.", "location": "path", "pattern": "^organizations/[^/]+/locations/[^/]+/muteConfigs/[^/]+$", "required": true, @@ -2605,7 +2605,7 @@ "type": "string" }, "parent": { - "description": "Required. The parent, which owns the collection of mute configs. Its format is \"organizations/[organization_id]\", \"folders/[folder_id]\", \"projects/[project_id]\".", + "description": "Required. The parent, which owns the collection of mute configs. Its format is `organizations/[organization_id]`, `folders/[folder_id]`, `projects/[project_id]`.", "location": "path", "pattern": "^organizations/[^/]+/locations/[^/]+/muteConfigs$", "required": true, @@ -2630,7 +2630,7 @@ ], "parameters": { "name": { - "description": "This field will be ignored if provided on config creation. Format \"organizations/{organization}/muteConfigs/{mute_config}\" \"folders/{folder}/muteConfigs/{mute_config}\" \"projects/{project}/muteConfigs/{mute_config}\" \"organizations/{organization}/locations/global/muteConfigs/{mute_config}\" \"folders/{folder}/locations/global/muteConfigs/{mute_config}\" \"projects/{project}/locations/global/muteConfigs/{mute_config}\"", + "description": "This field will be ignored if provided on config creation. Format `organizations/{organization}/muteConfigs/{mute_config}` `folders/{folder}/muteConfigs/{mute_config}` `projects/{project}/muteConfigs/{mute_config}` `organizations/{organization}/locations/global/muteConfigs/{mute_config}` `folders/{folder}/locations/global/muteConfigs/{mute_config}` `projects/{project}/locations/global/muteConfigs/{mute_config}`", "location": "path", "pattern": "^organizations/[^/]+/locations/[^/]+/muteConfigs/[^/]+$", "required": true, @@ -2675,7 +2675,7 @@ "type": "string" }, "parent": { - "description": "Required. Resource name of the new mute configs's parent. Its format is \"organizations/[organization_id]\", \"folders/[folder_id]\", or \"projects/[project_id]\".", + "description": "Required. Resource name of the new mute configs's parent. Its format is `organizations/[organization_id]`, `folders/[folder_id]`, or `projects/[project_id]`.", "location": "path", "pattern": "^organizations/[^/]+$", "required": true, @@ -2703,7 +2703,7 @@ ], "parameters": { "name": { - "description": "Required. Name of the mute config to delete. Its format is organizations/{organization}/muteConfigs/{config_id}, folders/{folder}/muteConfigs/{config_id}, projects/{project}/muteConfigs/{config_id}, organizations/{organization}/locations/global/muteConfigs/{config_id}, folders/{folder}/locations/global/muteConfigs/{config_id}, or projects/{project}/locations/global/muteConfigs/{config_id}.", + "description": "Required. Name of the mute config to delete. Its format is `organizations/{organization}/muteConfigs/{config_id}`, `folders/{folder}/muteConfigs/{config_id}`, `projects/{project}/muteConfigs/{config_id}`, `organizations/{organization}/locations/global/muteConfigs/{config_id}`, `folders/{folder}/locations/global/muteConfigs/{config_id}`, or `projects/{project}/locations/global/muteConfigs/{config_id}`.", "location": "path", "pattern": "^organizations/[^/]+/muteConfigs/[^/]+$", "required": true, @@ -2728,7 +2728,7 @@ ], "parameters": { "name": { - "description": "Required. Name of the mute config to retrieve. Its format is organizations/{organization}/muteConfigs/{config_id}, folders/{folder}/muteConfigs/{config_id}, projects/{project}/muteConfigs/{config_id}, organizations/{organization}/locations/global/muteConfigs/{config_id}, folders/{folder}/locations/global/muteConfigs/{config_id}, or projects/{project}/locations/global/muteConfigs/{config_id}.", + "description": "Required. Name of the mute config to retrieve. Its format is `organizations/{organization}/muteConfigs/{config_id}`, `folders/{folder}/muteConfigs/{config_id}`, `projects/{project}/muteConfigs/{config_id}`, `organizations/{organization}/locations/global/muteConfigs/{config_id}`, `folders/{folder}/locations/global/muteConfigs/{config_id}`, or `projects/{project}/locations/global/muteConfigs/{config_id}`.", "location": "path", "pattern": "^organizations/[^/]+/muteConfigs/[^/]+$", "required": true, @@ -2764,7 +2764,7 @@ "type": "string" }, "parent": { - "description": "Required. The parent, which owns the collection of mute configs. Its format is \"organizations/[organization_id]\", \"folders/[folder_id]\", \"projects/[project_id]\".", + "description": "Required. The parent, which owns the collection of mute configs. Its format is `organizations/[organization_id]`, `folders/[folder_id]`, `projects/[project_id]`.", "location": "path", "pattern": "^organizations/[^/]+$", "required": true, @@ -2789,7 +2789,7 @@ ], "parameters": { "name": { - "description": "This field will be ignored if provided on config creation. Format \"organizations/{organization}/muteConfigs/{mute_config}\" \"folders/{folder}/muteConfigs/{mute_config}\" \"projects/{project}/muteConfigs/{mute_config}\" \"organizations/{organization}/locations/global/muteConfigs/{mute_config}\" \"folders/{folder}/locations/global/muteConfigs/{mute_config}\" \"projects/{project}/locations/global/muteConfigs/{mute_config}\"", + "description": "This field will be ignored if provided on config creation. Format `organizations/{organization}/muteConfigs/{mute_config}` `folders/{folder}/muteConfigs/{mute_config}` `projects/{project}/muteConfigs/{mute_config}` `organizations/{organization}/locations/global/muteConfigs/{mute_config}` `folders/{folder}/locations/global/muteConfigs/{mute_config}` `projects/{project}/locations/global/muteConfigs/{mute_config}`", "location": "path", "pattern": "^organizations/[^/]+/muteConfigs/[^/]+$", "required": true, @@ -2832,7 +2832,7 @@ "type": "string" }, "parent": { - "description": "Required. Resource name of the new notification config's parent. Its format is \"organizations/[organization_id]\", \"folders/[folder_id]\", or \"projects/[project_id]\".", + "description": "Required. Resource name of the new notification config's parent. Its format is `organizations/[organization_id]`, `folders/[folder_id]`, or `projects/[project_id]`.", "location": "path", "pattern": "^organizations/[^/]+$", "required": true, @@ -2860,7 +2860,7 @@ ], "parameters": { "name": { - "description": "Required. Name of the notification config to delete. Its format is \"organizations/[organization_id]/notificationConfigs/[config_id]\", \"folders/[folder_id]/notificationConfigs/[config_id]\", or \"projects/[project_id]/notificationConfigs/[config_id]\".", + "description": "Required. Name of the notification config to delete. Its format is `organizations/[organization_id]/notificationConfigs/[config_id]`, `folders/[folder_id]/notificationConfigs/[config_id]`, or `projects/[project_id]/notificationConfigs/[config_id]`.", "location": "path", "pattern": "^organizations/[^/]+/notificationConfigs/[^/]+$", "required": true, @@ -2885,7 +2885,7 @@ ], "parameters": { "name": { - "description": "Required. Name of the notification config to get. Its format is \"organizations/[organization_id]/notificationConfigs/[config_id]\", \"folders/[folder_id]/notificationConfigs/[config_id]\", or \"projects/[project_id]/notificationConfigs/[config_id]\".", + "description": "Required. Name of the notification config to get. Its format is `organizations/[organization_id]/notificationConfigs/[config_id]`, `folders/[folder_id]/notificationConfigs/[config_id]`, or `projects/[project_id]/notificationConfigs/[config_id]`.", "location": "path", "pattern": "^organizations/[^/]+/notificationConfigs/[^/]+$", "required": true, @@ -3157,7 +3157,7 @@ ], "parameters": { "name": { - "description": "Required. Name of the resource value config to retrieve. Its format is organizations/{organization}/resourceValueConfigs/{config_id}.", + "description": "Required. Name of the resource value config to retrieve. Its format is `organizations/{organization}/resourceValueConfigs/{config_id}`.", "location": "path", "pattern": "^organizations/[^/]+/resourceValueConfigs/[^/]+$", "required": true, @@ -3193,7 +3193,7 @@ "type": "string" }, "parent": { - "description": "Required. The parent, which owns the collection of resource value configs. Its format is \"organizations/[organization_id]\"", + "description": "Required. The parent, which owns the collection of resource value configs. Its format is `organizations/[organization_id]`", "location": "path", "pattern": "^organizations/[^/]+$", "required": true, @@ -3258,7 +3258,7 @@ ], "parameters": { "parent": { - "description": "Required. Resource name of the new custom module's parent. Its format is \"organizations/{organization}/securityHealthAnalyticsSettings\", \"folders/{folder}/securityHealthAnalyticsSettings\", or \"projects/{project}/securityHealthAnalyticsSettings\"", + "description": "Required. Resource name of the new custom module's parent. Its format is `organizations/{organization}/securityHealthAnalyticsSettings`, `folders/{folder}/securityHealthAnalyticsSettings`, or `projects/{project}/securityHealthAnalyticsSettings`", "location": "path", "pattern": "^organizations/[^/]+/securityHealthAnalyticsSettings$", "required": true, @@ -3286,7 +3286,7 @@ ], "parameters": { "name": { - "description": "Required. Name of the custom module to delete. Its format is \"organizations/{organization}/securityHealthAnalyticsSettings/customModules/{customModule}\", \"folders/{folder}/securityHealthAnalyticsSettings/customModules/{customModule}\", or \"projects/{project}/securityHealthAnalyticsSettings/customModules/{customModule}\"", + "description": "Required. Name of the custom module to delete. Its format is `organizations/{organization}/securityHealthAnalyticsSettings/customModules/{customModule}`, `folders/{folder}/securityHealthAnalyticsSettings/customModules/{customModule}`, or `projects/{project}/securityHealthAnalyticsSettings/customModules/{customModule}`", "location": "path", "pattern": "^organizations/[^/]+/securityHealthAnalyticsSettings/customModules/[^/]+$", "required": true, @@ -3311,7 +3311,7 @@ ], "parameters": { "name": { - "description": "Required. Name of the custom module to get. Its format is \"organizations/{organization}/securityHealthAnalyticsSettings/customModules/{customModule}\", \"folders/{folder}/securityHealthAnalyticsSettings/customModules/{customModule}\", or \"projects/{project}/securityHealthAnalyticsSettings/customModules/{customModule}\"", + "description": "Required. Name of the custom module to get. Its format is `organizations/{organization}/securityHealthAnalyticsSettings/customModules/{customModule}`, `folders/{folder}/securityHealthAnalyticsSettings/customModules/{customModule}`, or `projects/{project}/securityHealthAnalyticsSettings/customModules/{customModule}`", "location": "path", "pattern": "^organizations/[^/]+/securityHealthAnalyticsSettings/customModules/[^/]+$", "required": true, @@ -3347,7 +3347,7 @@ "type": "string" }, "parent": { - "description": "Required. Name of parent to list custom modules. Its format is \"organizations/{organization}/securityHealthAnalyticsSettings\", \"folders/{folder}/securityHealthAnalyticsSettings\", or \"projects/{project}/securityHealthAnalyticsSettings\"", + "description": "Required. Name of parent to list custom modules. Its format is `organizations/{organization}/securityHealthAnalyticsSettings`, `folders/{folder}/securityHealthAnalyticsSettings`, or `projects/{project}/securityHealthAnalyticsSettings`", "location": "path", "pattern": "^organizations/[^/]+/securityHealthAnalyticsSettings$", "required": true, @@ -3383,7 +3383,7 @@ "type": "string" }, "parent": { - "description": "Required. Name of parent to list descendant custom modules. Its format is \"organizations/{organization}/securityHealthAnalyticsSettings\", \"folders/{folder}/securityHealthAnalyticsSettings\", or \"projects/{project}/securityHealthAnalyticsSettings\"", + "description": "Required. Name of parent to list descendant custom modules. Its format is `organizations/{organization}/securityHealthAnalyticsSettings`, `folders/{folder}/securityHealthAnalyticsSettings`, or `projects/{project}/securityHealthAnalyticsSettings`", "location": "path", "pattern": "^organizations/[^/]+/securityHealthAnalyticsSettings$", "required": true, @@ -3474,7 +3474,7 @@ ], "parameters": { "name": { - "description": "Required. Name of the effective custom module to get. Its format is \"organizations/{organization}/securityHealthAnalyticsSettings/effectiveCustomModules/{customModule}\", \"folders/{folder}/securityHealthAnalyticsSettings/effectiveCustomModules/{customModule}\", or \"projects/{project}/securityHealthAnalyticsSettings/effectiveCustomModules/{customModule}\"", + "description": "Required. Name of the effective custom module to get. Its format is `organizations/{organization}/securityHealthAnalyticsSettings/effectiveCustomModules/{customModule}`, `folders/{folder}/securityHealthAnalyticsSettings/effectiveCustomModules/{customModule}`, or `projects/{project}/securityHealthAnalyticsSettings/effectiveCustomModules/{customModule}`", "location": "path", "pattern": "^organizations/[^/]+/securityHealthAnalyticsSettings/effectiveCustomModules/[^/]+$", "required": true, @@ -3510,7 +3510,7 @@ "type": "string" }, "parent": { - "description": "Required. Name of parent to list effective custom modules. Its format is \"organizations/{organization}/securityHealthAnalyticsSettings\", \"folders/{folder}/securityHealthAnalyticsSettings\", or \"projects/{project}/securityHealthAnalyticsSettings\"", + "description": "Required. Name of parent to list effective custom modules. Its format is `organizations/{organization}/securityHealthAnalyticsSettings`, `folders/{folder}/securityHealthAnalyticsSettings`, or `projects/{project}/securityHealthAnalyticsSettings`", "location": "path", "pattern": "^organizations/[^/]+/securityHealthAnalyticsSettings$", "required": true, @@ -3541,7 +3541,7 @@ ], "parameters": { "name": { - "description": "Required. The organization name or simulation name of this simulation Valid format: \"organizations/{organization}/simulations/latest\" \"organizations/{organization}/simulations/{simulation}\"", + "description": "Required. The organization name or simulation name of this simulation Valid format: `organizations/{organization}/simulations/latest` `organizations/{organization}/simulations/{simulation}`", "location": "path", "pattern": "^organizations/[^/]+/simulations/[^/]+$", "required": true, @@ -3588,7 +3588,7 @@ "type": "string" }, "parent": { - "description": "Required. Name of parent to list attack paths. Valid formats: \"organizations/{organization}\", \"organizations/{organization}/simulations/{simulation}\" \"organizations/{organization}/simulations/{simulation}/attackExposureResults/{attack_exposure_result_v2}\" \"organizations/{organization}/simulations/{simulation}/valuedResources/{valued_resource}\"", + "description": "Required. Name of parent to list attack paths. Valid formats: `organizations/{organization}`, `organizations/{organization}/simulations/{simulation}` `organizations/{organization}/simulations/{simulation}/attackExposureResults/{attack_exposure_result_v2}` `organizations/{organization}/simulations/{simulation}/valuedResources/{valued_resource}`", "location": "path", "pattern": "^organizations/[^/]+/simulations/[^/]+/attackExposureResults/[^/]+$", "required": true, @@ -3622,7 +3622,7 @@ "type": "string" }, "orderBy": { - "description": "Optional. The fields by which to order the valued resources response. Supported fields: * `exposed_score` * `resource_value` * `resource_type` * `resource` * `display_name` Values should be a comma separated list of fields. For example: `exposed_score,resource_value`. The default sorting order is descending. To specify ascending or descending order for a field, append a \" ASC\" or a \" DESC\" suffix, respectively; for example: `exposed_score DESC`.", + "description": "Optional. The fields by which to order the valued resources response. Supported fields: * `exposed_score` * `resource_value` * `resource_type` * `resource` * `display_name` Values should be a comma separated list of fields. For example: `exposed_score,resource_value`. The default sorting order is descending. To specify ascending or descending order for a field, append a ` ASC` or a ` DESC` suffix, respectively; for example: `exposed_score DESC`.", "location": "query", "type": "string" }, @@ -3638,7 +3638,7 @@ "type": "string" }, "parent": { - "description": "Required. Name of parent to list valued resources. Valid formats: \"organizations/{organization}\", \"organizations/{organization}/simulations/{simulation}\" \"organizations/{organization}/simulations/{simulation}/attackExposureResults/{attack_exposure_result_v2}\"", + "description": "Required. Name of parent to list valued resources. Valid formats: `organizations/{organization}`, `organizations/{organization}/simulations/{simulation}` `organizations/{organization}/simulations/{simulation}/attackExposureResults/{attack_exposure_result_v2}`", "location": "path", "pattern": "^organizations/[^/]+/simulations/[^/]+/attackExposureResults/[^/]+$", "required": true, @@ -3685,7 +3685,7 @@ "type": "string" }, "parent": { - "description": "Required. Name of parent to list attack paths. Valid formats: \"organizations/{organization}\", \"organizations/{organization}/simulations/{simulation}\" \"organizations/{organization}/simulations/{simulation}/attackExposureResults/{attack_exposure_result_v2}\" \"organizations/{organization}/simulations/{simulation}/valuedResources/{valued_resource}\"", + "description": "Required. Name of parent to list attack paths. Valid formats: `organizations/{organization}`, `organizations/{organization}/simulations/{simulation}` `organizations/{organization}/simulations/{simulation}/attackExposureResults/{attack_exposure_result_v2}` `organizations/{organization}/simulations/{simulation}/valuedResources/{valued_resource}`", "location": "path", "pattern": "^organizations/[^/]+/simulations/[^/]+$", "required": true, @@ -3714,7 +3714,7 @@ ], "parameters": { "name": { - "description": "Required. The name of this valued resource Valid format: \"organizations/{organization}/simulations/{simulation}/valuedResources/{valued_resource}\"", + "description": "Required. The name of this valued resource Valid format: `organizations/{organization}/simulations/{simulation}/valuedResources/{valued_resource}`", "location": "path", "pattern": "^organizations/[^/]+/simulations/[^/]+/valuedResources/[^/]+$", "required": true, @@ -3744,7 +3744,7 @@ "type": "string" }, "orderBy": { - "description": "Optional. The fields by which to order the valued resources response. Supported fields: * `exposed_score` * `resource_value` * `resource_type` * `resource` * `display_name` Values should be a comma separated list of fields. For example: `exposed_score,resource_value`. The default sorting order is descending. To specify ascending or descending order for a field, append a \" ASC\" or a \" DESC\" suffix, respectively; for example: `exposed_score DESC`.", + "description": "Optional. The fields by which to order the valued resources response. Supported fields: * `exposed_score` * `resource_value` * `resource_type` * `resource` * `display_name` Values should be a comma separated list of fields. For example: `exposed_score,resource_value`. The default sorting order is descending. To specify ascending or descending order for a field, append a ` ASC` or a ` DESC` suffix, respectively; for example: `exposed_score DESC`.", "location": "query", "type": "string" }, @@ -3760,7 +3760,7 @@ "type": "string" }, "parent": { - "description": "Required. Name of parent to list valued resources. Valid formats: \"organizations/{organization}\", \"organizations/{organization}/simulations/{simulation}\" \"organizations/{organization}/simulations/{simulation}/attackExposureResults/{attack_exposure_result_v2}\"", + "description": "Required. Name of parent to list valued resources. Valid formats: `organizations/{organization}`, `organizations/{organization}/simulations/{simulation}` `organizations/{organization}/simulations/{simulation}/attackExposureResults/{attack_exposure_result_v2}`", "location": "path", "pattern": "^organizations/[^/]+/simulations/[^/]+$", "required": true, @@ -3805,7 +3805,7 @@ "type": "string" }, "parent": { - "description": "Required. Name of parent to list attack paths. Valid formats: \"organizations/{organization}\", \"organizations/{organization}/simulations/{simulation}\" \"organizations/{organization}/simulations/{simulation}/attackExposureResults/{attack_exposure_result_v2}\" \"organizations/{organization}/simulations/{simulation}/valuedResources/{valued_resource}\"", + "description": "Required. Name of parent to list attack paths. Valid formats: `organizations/{organization}`, `organizations/{organization}/simulations/{simulation}` `organizations/{organization}/simulations/{simulation}/attackExposureResults/{attack_exposure_result_v2}` `organizations/{organization}/simulations/{simulation}/valuedResources/{valued_resource}`", "location": "path", "pattern": "^organizations/[^/]+/simulations/[^/]+/valuedResources/[^/]+$", "required": true, @@ -3838,7 +3838,7 @@ ], "parameters": { "parent": { - "description": "Required. Resource name of the new source's parent. Its format should be \"organizations/[organization_id]\".", + "description": "Required. Resource name of the new source's parent. Its format should be `organizations/[organization_id]`.", "location": "path", "pattern": "^organizations/[^/]+$", "required": true, @@ -3866,7 +3866,7 @@ ], "parameters": { "name": { - "description": "Required. Relative resource name of the source. Its format is \"organizations/[organization_id]/source/[source_id]\".", + "description": "Required. Relative resource name of the source. Its format is `organizations/[organization_id]/source/[source_id]`.", "location": "path", "pattern": "^organizations/[^/]+/sources/[^/]+$", "required": true, @@ -3930,7 +3930,7 @@ "type": "string" }, "parent": { - "description": "Required. Resource name of the parent of sources to list. Its format should be \"organizations/[organization_id]\", \"folders/[folder_id]\", or \"projects/[project_id]\".", + "description": "Required. Resource name of the parent of sources to list. Its format should be `organizations/[organization_id]`, `folders/[folder_id]`, or `projects/[project_id]`.", "location": "path", "pattern": "^organizations/[^/]+$", "required": true, @@ -4054,7 +4054,7 @@ "type": "string" }, "parent": { - "description": "Required. Resource name of the new finding's parent. Its format should be \"organizations/[organization_id]/sources/[source_id]\".", + "description": "Required. Resource name of the new finding's parent. Its format should be `organizations/[organization_id]/sources/[source_id]`.", "location": "path", "pattern": "^organizations/[^/]+/sources/[^/]+$", "required": true, @@ -4082,7 +4082,7 @@ ], "parameters": { "parent": { - "description": "Required. Name of the source to groupBy. Its format is \"organizations/[organization_id]/sources/[source_id]\", folders/[folder_id]/sources/[source_id], or projects/[project_id]/sources/[source_id]. To groupBy across all sources provide a source_id of `-`. For example: organizations/{organization_id}/sources/-, folders/{folder_id}/sources/-, or projects/{project_id}/sources/-", + "description": "Required. Name of the source to groupBy. Its format is `organizations/[organization_id]/sources/[source_id]`, `folders/[folder_id]/sources/[source_id]`, or `projects/[project_id]/sources/[source_id]`. To groupBy across all sources provide a source_id of `-`. For example: `organizations/{organization_id}/sources/-, folders/{folder_id}/sources/-`, or `projects/{project_id}/sources/-`", "location": "path", "pattern": "^organizations/[^/]+/sources/[^/]+$", "required": true, @@ -4143,7 +4143,7 @@ "type": "string" }, "parent": { - "description": "Required. Name of the source the findings belong to. Its format is \"organizations/[organization_id]/sources/[source_id], folders/[folder_id]/sources/[source_id], or projects/[project_id]/sources/[source_id]\". To list across all sources provide a source_id of `-`. For example: organizations/{organization_id}/sources/-, folders/{folder_id}/sources/- or projects/{projects_id}/sources/-", + "description": "Required. Name of the source the findings belong to. Its format is `organizations/[organization_id]/sources/[source_id]`, `folders/[folder_id]/sources/[source_id]`, or `projects/[project_id]/sources/[source_id]`. To list across all sources provide a source_id of `-`. For example: `organizations/{organization_id}/sources/-`, `folders/{folder_id}/sources/-` or `projects/{projects_id}/sources/-`", "location": "path", "pattern": "^organizations/[^/]+/sources/[^/]+$", "required": true, @@ -4208,7 +4208,7 @@ ], "parameters": { "name": { - "description": "Required. The [relative resource name](https://cloud.google.com/apis/design/resource_names#relative_resource_name) of the finding. Example: \"organizations/{organization_id}/sources/{source_id}/findings/{finding_id}\", \"folders/{folder_id}/sources/{source_id}/findings/{finding_id}\", \"projects/{project_id}/sources/{source_id}/findings/{finding_id}\".", + "description": "Required. The [relative resource name](https://cloud.google.com/apis/design/resource_names#relative_resource_name) of the finding. Example: `organizations/{organization_id}/sources/{source_id}/findings/{finding_id}`, `folders/{folder_id}/sources/{source_id}/findings/{finding_id}`, `projects/{project_id}/sources/{source_id}/findings/{finding_id}`.", "location": "path", "pattern": "^organizations/[^/]+/sources/[^/]+/findings/[^/]+$", "required": true, @@ -4236,7 +4236,7 @@ ], "parameters": { "name": { - "description": "Required. The [relative resource name](https://cloud.google.com/apis/design/resource_names#relative_resource_name) of the finding. Example: \"organizations/{organization_id}/sources/{source_id}/findings/{finding_id}\", \"folders/{folder_id}/sources/{source_id}/findings/{finding_id}\", \"projects/{project_id}/sources/{source_id}/findings/{finding_id}\".", + "description": "Required. The [relative resource name](https://cloud.google.com/apis/design/resource_names#relative_resource_name) of the finding. Example: `organizations/{organization_id}/sources/{source_id}/findings/{finding_id}`, `folders/{folder_id}/sources/{source_id}/findings/{finding_id}`, `projects/{project_id}/sources/{source_id}/findings/{finding_id}`.", "location": "path", "pattern": "^organizations/[^/]+/sources/[^/]+/findings/[^/]+$", "required": true, @@ -4355,7 +4355,7 @@ ], "parameters": { "parent": { - "description": "Required. The name of the parent to group the assets by. Its format is \"organizations/[organization_id]\", \"folders/[folder_id]\", or \"projects/[project_id]\".", + "description": "Required. The name of the parent to group the assets by. Its format is `organizations/[organization_id]`, `folders/[folder_id]`, or `projects/[project_id]`.", "location": "path", "pattern": "^projects/[^/]+$", "required": true, @@ -4417,7 +4417,7 @@ "type": "string" }, "parent": { - "description": "Required. The name of the parent resource that contains the assets. The value that you can specify on parent depends on the method in which you specify parent. You can specify one of the following values: \"organizations/[organization_id]\", \"folders/[folder_id]\", or \"projects/[project_id]\".", + "description": "Required. The name of the parent resource that contains the assets. The value that you can specify on parent depends on the method in which you specify parent. You can specify one of the following values: `organizations/[organization_id]`, `folders/[folder_id]`, or `projects/[project_id]`.", "location": "path", "pattern": "^projects/[^/]+$", "required": true, @@ -4497,7 +4497,7 @@ "type": "string" }, "parent": { - "description": "Required. The name of the parent resource of the new BigQuery export. Its format is \"organizations/[organization_id]\", \"folders/[folder_id]\", or \"projects/[project_id]\".", + "description": "Required. The name of the parent resource of the new BigQuery export. Its format is `organizations/[organization_id]`, `folders/[folder_id]`, or `projects/[project_id]`.", "location": "path", "pattern": "^projects/[^/]+$", "required": true, @@ -4525,7 +4525,7 @@ ], "parameters": { "name": { - "description": "Required. The name of the BigQuery export to delete. Its format is organizations/{organization}/bigQueryExports/{export_id}, folders/{folder}/bigQueryExports/{export_id}, or projects/{project}/bigQueryExports/{export_id}", + "description": "Required. The name of the BigQuery export to delete. Its format is `organizations/{organization}/bigQueryExports/{export_id}`, `folders/{folder}/bigQueryExports/{export_id}`, or `projects/{project}/bigQueryExports/{export_id}`", "location": "path", "pattern": "^projects/[^/]+/bigQueryExports/[^/]+$", "required": true, @@ -4550,7 +4550,7 @@ ], "parameters": { "name": { - "description": "Required. Name of the BigQuery export to retrieve. Its format is organizations/{organization}/bigQueryExports/{export_id}, folders/{folder}/bigQueryExports/{export_id}, or projects/{project}/bigQueryExports/{export_id}", + "description": "Required. Name of the BigQuery export to retrieve. Its format is `organizations/{organization}/bigQueryExports/{export_id}`, `folders/{folder}/bigQueryExports/{export_id}`, or `projects/{project}/bigQueryExports/{export_id}`", "location": "path", "pattern": "^projects/[^/]+/bigQueryExports/[^/]+$", "required": true, @@ -4586,7 +4586,7 @@ "type": "string" }, "parent": { - "description": "Required. The parent, which owns the collection of BigQuery exports. Its format is \"organizations/[organization_id]\", \"folders/[folder_id]\", \"projects/[project_id]\".", + "description": "Required. The parent, which owns the collection of BigQuery exports. Its format is `organizations/[organization_id]`, `folders/[folder_id]`, `projects/[project_id]`.", "location": "path", "pattern": "^projects/[^/]+$", "required": true, @@ -4649,7 +4649,7 @@ ], "parameters": { "parent": { - "description": "Required. Resource name of the parent to validate the Custom Module under. Its format is: * \"organizations/{organization}/eventThreatDetectionSettings\". * \"folders/{folder}/eventThreatDetectionSettings\". * \"projects/{project}/eventThreatDetectionSettings\".", + "description": "Required. Resource name of the parent to validate the Custom Module under. Its format is: * `organizations/{organization}/eventThreatDetectionSettings`. * `folders/{folder}/eventThreatDetectionSettings`. * `projects/{project}/eventThreatDetectionSettings`.", "location": "path", "pattern": "^projects/[^/]+/eventThreatDetectionSettings$", "required": true, @@ -4681,7 +4681,7 @@ ], "parameters": { "parent": { - "description": "Required. The new custom module's parent. Its format is: * \"organizations/{organization}/eventThreatDetectionSettings\". * \"folders/{folder}/eventThreatDetectionSettings\". * \"projects/{project}/eventThreatDetectionSettings\".", + "description": "Required. The new custom module's parent. Its format is: * `organizations/{organization}/eventThreatDetectionSettings`. * `folders/{folder}/eventThreatDetectionSettings`. * `projects/{project}/eventThreatDetectionSettings`.", "location": "path", "pattern": "^projects/[^/]+/eventThreatDetectionSettings$", "required": true, @@ -4709,7 +4709,7 @@ ], "parameters": { "name": { - "description": "Required. Name of the custom module to delete. Its format is: * \"organizations/{organization}/eventThreatDetectionSettings/customModules/{module}\". * \"folders/{folder}/eventThreatDetectionSettings/customModules/{module}\". * \"projects/{project}/eventThreatDetectionSettings/customModules/{module}\".", + "description": "Required. Name of the custom module to delete. Its format is: * `organizations/{organization}/eventThreatDetectionSettings/customModules/{module}`. * `folders/{folder}/eventThreatDetectionSettings/customModules/{module}`. * `projects/{project}/eventThreatDetectionSettings/customModules/{module}`.", "location": "path", "pattern": "^projects/[^/]+/eventThreatDetectionSettings/customModules/[^/]+$", "required": true, @@ -4734,7 +4734,7 @@ ], "parameters": { "name": { - "description": "Required. Name of the custom module to get. Its format is: * \"organizations/{organization}/eventThreatDetectionSettings/customModules/{module}\". * \"folders/{folder}/eventThreatDetectionSettings/customModules/{module}\". * \"projects/{project}/eventThreatDetectionSettings/customModules/{module}\".", + "description": "Required. Name of the custom module to get. Its format is: * `organizations/{organization}/eventThreatDetectionSettings/customModules/{module}`. * `folders/{folder}/eventThreatDetectionSettings/customModules/{module}`. * `projects/{project}/eventThreatDetectionSettings/customModules/{module}`.", "location": "path", "pattern": "^projects/[^/]+/eventThreatDetectionSettings/customModules/[^/]+$", "required": true, @@ -4770,7 +4770,7 @@ "type": "string" }, "parent": { - "description": "Required. Name of the parent to list custom modules under. Its format is: * \"organizations/{organization}/eventThreatDetectionSettings\". * \"folders/{folder}/eventThreatDetectionSettings\". * \"projects/{project}/eventThreatDetectionSettings\".", + "description": "Required. Name of the parent to list custom modules under. Its format is: * `organizations/{organization}/eventThreatDetectionSettings`. * `folders/{folder}/eventThreatDetectionSettings`. * `projects/{project}/eventThreatDetectionSettings`.", "location": "path", "pattern": "^projects/[^/]+/eventThreatDetectionSettings$", "required": true, @@ -4806,7 +4806,7 @@ "type": "string" }, "parent": { - "description": "Required. Name of the parent to list custom modules under. Its format is: * \"organizations/{organization}/eventThreatDetectionSettings\". * \"folders/{folder}/eventThreatDetectionSettings\". * \"projects/{project}/eventThreatDetectionSettings\".", + "description": "Required. Name of the parent to list custom modules under. Its format is: * `organizations/{organization}/eventThreatDetectionSettings`. * `folders/{folder}/eventThreatDetectionSettings`. * `projects/{project}/eventThreatDetectionSettings`.", "location": "path", "pattern": "^projects/[^/]+/eventThreatDetectionSettings$", "required": true, @@ -4831,7 +4831,7 @@ ], "parameters": { "name": { - "description": "Immutable. The resource name of the Event Threat Detection custom module. Its format is: * \"organizations/{organization}/eventThreatDetectionSettings/customModules/{module}\". * \"folders/{folder}/eventThreatDetectionSettings/customModules/{module}\". * \"projects/{project}/eventThreatDetectionSettings/customModules/{module}\".", + "description": "Immutable. The resource name of the Event Threat Detection custom module. Its format is: * `organizations/{organization}/eventThreatDetectionSettings/customModules/{module}`. * `folders/{folder}/eventThreatDetectionSettings/customModules/{module}`. * `projects/{project}/eventThreatDetectionSettings/customModules/{module}`.", "location": "path", "pattern": "^projects/[^/]+/eventThreatDetectionSettings/customModules/[^/]+$", "required": true, @@ -4869,7 +4869,7 @@ ], "parameters": { "name": { - "description": "Required. The resource name of the effective Event Threat Detection custom module. Its format is: * \"organizations/{organization}/eventThreatDetectionSettings/effectiveCustomModules/{module}\". * \"folders/{folder}/eventThreatDetectionSettings/effectiveCustomModules/{module}\". * \"projects/{project}/eventThreatDetectionSettings/effectiveCustomModules/{module}\".", + "description": "Required. The resource name of the effective Event Threat Detection custom module. Its format is: * `organizations/{organization}/eventThreatDetectionSettings/effectiveCustomModules/{module}`. * `folders/{folder}/eventThreatDetectionSettings/effectiveCustomModules/{module}`. * `projects/{project}/eventThreatDetectionSettings/effectiveCustomModules/{module}`.", "location": "path", "pattern": "^projects/[^/]+/eventThreatDetectionSettings/effectiveCustomModules/[^/]+$", "required": true, @@ -4905,7 +4905,7 @@ "type": "string" }, "parent": { - "description": "Required. Name of the parent to list custom modules for. Its format is: * \"organizations/{organization}/eventThreatDetectionSettings\". * \"folders/{folder}/eventThreatDetectionSettings\". * \"projects/{project}/eventThreatDetectionSettings\".", + "description": "Required. Name of the parent to list custom modules for. Its format is: * `organizations/{organization}/eventThreatDetectionSettings`. * `folders/{folder}/eventThreatDetectionSettings`. * `projects/{project}/eventThreatDetectionSettings`.", "location": "path", "pattern": "^projects/[^/]+/eventThreatDetectionSettings$", "required": true, @@ -4936,7 +4936,7 @@ ], "parameters": { "parent": { - "description": "Required. The parent, at which bulk action needs to be applied. Its format is \"organizations/[organization_id]\", \"folders/[folder_id]\", \"projects/[project_id]\".", + "description": "Required. The parent, at which bulk action needs to be applied. Its format is `organizations/[organization_id]`, `folders/[folder_id]`, `projects/[project_id]`.", "location": "path", "pattern": "^projects/[^/]+$", "required": true, @@ -4975,7 +4975,7 @@ "type": "string" }, "parent": { - "description": "Required. Resource name of the new mute configs's parent. Its format is \"organizations/[organization_id]\", \"folders/[folder_id]\", or \"projects/[project_id]\".", + "description": "Required. Resource name of the new mute configs's parent. Its format is `organizations/[organization_id]`, `folders/[folder_id]`, or `projects/[project_id]`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -5003,7 +5003,7 @@ ], "parameters": { "name": { - "description": "Required. Name of the mute config to delete. Its format is organizations/{organization}/muteConfigs/{config_id}, folders/{folder}/muteConfigs/{config_id}, projects/{project}/muteConfigs/{config_id}, organizations/{organization}/locations/global/muteConfigs/{config_id}, folders/{folder}/locations/global/muteConfigs/{config_id}, or projects/{project}/locations/global/muteConfigs/{config_id}.", + "description": "Required. Name of the mute config to delete. Its format is `organizations/{organization}/muteConfigs/{config_id}`, `folders/{folder}/muteConfigs/{config_id}`, `projects/{project}/muteConfigs/{config_id}`, `organizations/{organization}/locations/global/muteConfigs/{config_id}`, `folders/{folder}/locations/global/muteConfigs/{config_id}`, or `projects/{project}/locations/global/muteConfigs/{config_id}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/muteConfigs/[^/]+$", "required": true, @@ -5028,7 +5028,7 @@ ], "parameters": { "name": { - "description": "Required. Name of the mute config to retrieve. Its format is organizations/{organization}/muteConfigs/{config_id}, folders/{folder}/muteConfigs/{config_id}, projects/{project}/muteConfigs/{config_id}, organizations/{organization}/locations/global/muteConfigs/{config_id}, folders/{folder}/locations/global/muteConfigs/{config_id}, or projects/{project}/locations/global/muteConfigs/{config_id}.", + "description": "Required. Name of the mute config to retrieve. Its format is `organizations/{organization}/muteConfigs/{config_id}`, `folders/{folder}/muteConfigs/{config_id}`, `projects/{project}/muteConfigs/{config_id}`, `organizations/{organization}/locations/global/muteConfigs/{config_id}`, `folders/{folder}/locations/global/muteConfigs/{config_id}`, or `projects/{project}/locations/global/muteConfigs/{config_id}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/muteConfigs/[^/]+$", "required": true, @@ -5064,7 +5064,7 @@ "type": "string" }, "parent": { - "description": "Required. The parent, which owns the collection of mute configs. Its format is \"organizations/[organization_id]\", \"folders/[folder_id]\", \"projects/[project_id]\".", + "description": "Required. The parent, which owns the collection of mute configs. Its format is `organizations/[organization_id]`, `folders/[folder_id]`, `projects/[project_id]`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/muteConfigs$", "required": true, @@ -5089,7 +5089,7 @@ ], "parameters": { "name": { - "description": "This field will be ignored if provided on config creation. Format \"organizations/{organization}/muteConfigs/{mute_config}\" \"folders/{folder}/muteConfigs/{mute_config}\" \"projects/{project}/muteConfigs/{mute_config}\" \"organizations/{organization}/locations/global/muteConfigs/{mute_config}\" \"folders/{folder}/locations/global/muteConfigs/{mute_config}\" \"projects/{project}/locations/global/muteConfigs/{mute_config}\"", + "description": "This field will be ignored if provided on config creation. Format `organizations/{organization}/muteConfigs/{mute_config}` `folders/{folder}/muteConfigs/{mute_config}` `projects/{project}/muteConfigs/{mute_config}` `organizations/{organization}/locations/global/muteConfigs/{mute_config}` `folders/{folder}/locations/global/muteConfigs/{mute_config}` `projects/{project}/locations/global/muteConfigs/{mute_config}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/muteConfigs/[^/]+$", "required": true, @@ -5134,7 +5134,7 @@ "type": "string" }, "parent": { - "description": "Required. Resource name of the new mute configs's parent. Its format is \"organizations/[organization_id]\", \"folders/[folder_id]\", or \"projects/[project_id]\".", + "description": "Required. Resource name of the new mute configs's parent. Its format is `organizations/[organization_id]`, `folders/[folder_id]`, or `projects/[project_id]`.", "location": "path", "pattern": "^projects/[^/]+$", "required": true, @@ -5162,7 +5162,7 @@ ], "parameters": { "name": { - "description": "Required. Name of the mute config to delete. Its format is organizations/{organization}/muteConfigs/{config_id}, folders/{folder}/muteConfigs/{config_id}, projects/{project}/muteConfigs/{config_id}, organizations/{organization}/locations/global/muteConfigs/{config_id}, folders/{folder}/locations/global/muteConfigs/{config_id}, or projects/{project}/locations/global/muteConfigs/{config_id}.", + "description": "Required. Name of the mute config to delete. Its format is `organizations/{organization}/muteConfigs/{config_id}`, `folders/{folder}/muteConfigs/{config_id}`, `projects/{project}/muteConfigs/{config_id}`, `organizations/{organization}/locations/global/muteConfigs/{config_id}`, `folders/{folder}/locations/global/muteConfigs/{config_id}`, or `projects/{project}/locations/global/muteConfigs/{config_id}`.", "location": "path", "pattern": "^projects/[^/]+/muteConfigs/[^/]+$", "required": true, @@ -5187,7 +5187,7 @@ ], "parameters": { "name": { - "description": "Required. Name of the mute config to retrieve. Its format is organizations/{organization}/muteConfigs/{config_id}, folders/{folder}/muteConfigs/{config_id}, projects/{project}/muteConfigs/{config_id}, organizations/{organization}/locations/global/muteConfigs/{config_id}, folders/{folder}/locations/global/muteConfigs/{config_id}, or projects/{project}/locations/global/muteConfigs/{config_id}.", + "description": "Required. Name of the mute config to retrieve. Its format is `organizations/{organization}/muteConfigs/{config_id}`, `folders/{folder}/muteConfigs/{config_id}`, `projects/{project}/muteConfigs/{config_id}`, `organizations/{organization}/locations/global/muteConfigs/{config_id}`, `folders/{folder}/locations/global/muteConfigs/{config_id}`, or `projects/{project}/locations/global/muteConfigs/{config_id}`.", "location": "path", "pattern": "^projects/[^/]+/muteConfigs/[^/]+$", "required": true, @@ -5223,7 +5223,7 @@ "type": "string" }, "parent": { - "description": "Required. The parent, which owns the collection of mute configs. Its format is \"organizations/[organization_id]\", \"folders/[folder_id]\", \"projects/[project_id]\".", + "description": "Required. The parent, which owns the collection of mute configs. Its format is `organizations/[organization_id]`, `folders/[folder_id]`, `projects/[project_id]`.", "location": "path", "pattern": "^projects/[^/]+$", "required": true, @@ -5248,7 +5248,7 @@ ], "parameters": { "name": { - "description": "This field will be ignored if provided on config creation. Format \"organizations/{organization}/muteConfigs/{mute_config}\" \"folders/{folder}/muteConfigs/{mute_config}\" \"projects/{project}/muteConfigs/{mute_config}\" \"organizations/{organization}/locations/global/muteConfigs/{mute_config}\" \"folders/{folder}/locations/global/muteConfigs/{mute_config}\" \"projects/{project}/locations/global/muteConfigs/{mute_config}\"", + "description": "This field will be ignored if provided on config creation. Format `organizations/{organization}/muteConfigs/{mute_config}` `folders/{folder}/muteConfigs/{mute_config}` `projects/{project}/muteConfigs/{mute_config}` `organizations/{organization}/locations/global/muteConfigs/{mute_config}` `folders/{folder}/locations/global/muteConfigs/{mute_config}` `projects/{project}/locations/global/muteConfigs/{mute_config}`", "location": "path", "pattern": "^projects/[^/]+/muteConfigs/[^/]+$", "required": true, @@ -5291,7 +5291,7 @@ "type": "string" }, "parent": { - "description": "Required. Resource name of the new notification config's parent. Its format is \"organizations/[organization_id]\", \"folders/[folder_id]\", or \"projects/[project_id]\".", + "description": "Required. Resource name of the new notification config's parent. Its format is `organizations/[organization_id]`, `folders/[folder_id]`, or `projects/[project_id]`.", "location": "path", "pattern": "^projects/[^/]+$", "required": true, @@ -5319,7 +5319,7 @@ ], "parameters": { "name": { - "description": "Required. Name of the notification config to delete. Its format is \"organizations/[organization_id]/notificationConfigs/[config_id]\", \"folders/[folder_id]/notificationConfigs/[config_id]\", or \"projects/[project_id]/notificationConfigs/[config_id]\".", + "description": "Required. Name of the notification config to delete. Its format is `organizations/[organization_id]/notificationConfigs/[config_id]`, `folders/[folder_id]/notificationConfigs/[config_id]`, or `projects/[project_id]/notificationConfigs/[config_id]`.", "location": "path", "pattern": "^projects/[^/]+/notificationConfigs/[^/]+$", "required": true, @@ -5344,7 +5344,7 @@ ], "parameters": { "name": { - "description": "Required. Name of the notification config to get. Its format is \"organizations/[organization_id]/notificationConfigs/[config_id]\", \"folders/[folder_id]/notificationConfigs/[config_id]\", or \"projects/[project_id]/notificationConfigs/[config_id]\".", + "description": "Required. Name of the notification config to get. Its format is `organizations/[organization_id]/notificationConfigs/[config_id]`, `folders/[folder_id]/notificationConfigs/[config_id]`, or `projects/[project_id]/notificationConfigs/[config_id]`.", "location": "path", "pattern": "^projects/[^/]+/notificationConfigs/[^/]+$", "required": true, @@ -5445,7 +5445,7 @@ ], "parameters": { "parent": { - "description": "Required. Resource name of the new custom module's parent. Its format is \"organizations/{organization}/securityHealthAnalyticsSettings\", \"folders/{folder}/securityHealthAnalyticsSettings\", or \"projects/{project}/securityHealthAnalyticsSettings\"", + "description": "Required. Resource name of the new custom module's parent. Its format is `organizations/{organization}/securityHealthAnalyticsSettings`, `folders/{folder}/securityHealthAnalyticsSettings`, or `projects/{project}/securityHealthAnalyticsSettings`", "location": "path", "pattern": "^projects/[^/]+/securityHealthAnalyticsSettings$", "required": true, @@ -5473,7 +5473,7 @@ ], "parameters": { "name": { - "description": "Required. Name of the custom module to delete. Its format is \"organizations/{organization}/securityHealthAnalyticsSettings/customModules/{customModule}\", \"folders/{folder}/securityHealthAnalyticsSettings/customModules/{customModule}\", or \"projects/{project}/securityHealthAnalyticsSettings/customModules/{customModule}\"", + "description": "Required. Name of the custom module to delete. Its format is `organizations/{organization}/securityHealthAnalyticsSettings/customModules/{customModule}`, `folders/{folder}/securityHealthAnalyticsSettings/customModules/{customModule}`, or `projects/{project}/securityHealthAnalyticsSettings/customModules/{customModule}`", "location": "path", "pattern": "^projects/[^/]+/securityHealthAnalyticsSettings/customModules/[^/]+$", "required": true, @@ -5498,7 +5498,7 @@ ], "parameters": { "name": { - "description": "Required. Name of the custom module to get. Its format is \"organizations/{organization}/securityHealthAnalyticsSettings/customModules/{customModule}\", \"folders/{folder}/securityHealthAnalyticsSettings/customModules/{customModule}\", or \"projects/{project}/securityHealthAnalyticsSettings/customModules/{customModule}\"", + "description": "Required. Name of the custom module to get. Its format is `organizations/{organization}/securityHealthAnalyticsSettings/customModules/{customModule}`, `folders/{folder}/securityHealthAnalyticsSettings/customModules/{customModule}`, or `projects/{project}/securityHealthAnalyticsSettings/customModules/{customModule}`", "location": "path", "pattern": "^projects/[^/]+/securityHealthAnalyticsSettings/customModules/[^/]+$", "required": true, @@ -5534,7 +5534,7 @@ "type": "string" }, "parent": { - "description": "Required. Name of parent to list custom modules. Its format is \"organizations/{organization}/securityHealthAnalyticsSettings\", \"folders/{folder}/securityHealthAnalyticsSettings\", or \"projects/{project}/securityHealthAnalyticsSettings\"", + "description": "Required. Name of parent to list custom modules. Its format is `organizations/{organization}/securityHealthAnalyticsSettings`, `folders/{folder}/securityHealthAnalyticsSettings`, or `projects/{project}/securityHealthAnalyticsSettings`", "location": "path", "pattern": "^projects/[^/]+/securityHealthAnalyticsSettings$", "required": true, @@ -5570,7 +5570,7 @@ "type": "string" }, "parent": { - "description": "Required. Name of parent to list descendant custom modules. Its format is \"organizations/{organization}/securityHealthAnalyticsSettings\", \"folders/{folder}/securityHealthAnalyticsSettings\", or \"projects/{project}/securityHealthAnalyticsSettings\"", + "description": "Required. Name of parent to list descendant custom modules. Its format is `organizations/{organization}/securityHealthAnalyticsSettings`, `folders/{folder}/securityHealthAnalyticsSettings`, or `projects/{project}/securityHealthAnalyticsSettings`", "location": "path", "pattern": "^projects/[^/]+/securityHealthAnalyticsSettings$", "required": true, @@ -5661,7 +5661,7 @@ ], "parameters": { "name": { - "description": "Required. Name of the effective custom module to get. Its format is \"organizations/{organization}/securityHealthAnalyticsSettings/effectiveCustomModules/{customModule}\", \"folders/{folder}/securityHealthAnalyticsSettings/effectiveCustomModules/{customModule}\", or \"projects/{project}/securityHealthAnalyticsSettings/effectiveCustomModules/{customModule}\"", + "description": "Required. Name of the effective custom module to get. Its format is `organizations/{organization}/securityHealthAnalyticsSettings/effectiveCustomModules/{customModule}`, `folders/{folder}/securityHealthAnalyticsSettings/effectiveCustomModules/{customModule}`, or `projects/{project}/securityHealthAnalyticsSettings/effectiveCustomModules/{customModule}`", "location": "path", "pattern": "^projects/[^/]+/securityHealthAnalyticsSettings/effectiveCustomModules/[^/]+$", "required": true, @@ -5697,7 +5697,7 @@ "type": "string" }, "parent": { - "description": "Required. Name of parent to list effective custom modules. Its format is \"organizations/{organization}/securityHealthAnalyticsSettings\", \"folders/{folder}/securityHealthAnalyticsSettings\", or \"projects/{project}/securityHealthAnalyticsSettings\"", + "description": "Required. Name of parent to list effective custom modules. Its format is `organizations/{organization}/securityHealthAnalyticsSettings`, `folders/{folder}/securityHealthAnalyticsSettings`, or `projects/{project}/securityHealthAnalyticsSettings`", "location": "path", "pattern": "^projects/[^/]+/securityHealthAnalyticsSettings$", "required": true, @@ -5739,7 +5739,7 @@ "type": "string" }, "parent": { - "description": "Required. Resource name of the parent of sources to list. Its format should be \"organizations/[organization_id]\", \"folders/[folder_id]\", or \"projects/[project_id]\".", + "description": "Required. Resource name of the parent of sources to list. Its format should be `organizations/[organization_id]`, `folders/[folder_id]`, or `projects/[project_id]`.", "location": "path", "pattern": "^projects/[^/]+$", "required": true, @@ -5768,7 +5768,7 @@ ], "parameters": { "parent": { - "description": "Required. Name of the source to groupBy. Its format is \"organizations/[organization_id]/sources/[source_id]\", folders/[folder_id]/sources/[source_id], or projects/[project_id]/sources/[source_id]. To groupBy across all sources provide a source_id of `-`. For example: organizations/{organization_id}/sources/-, folders/{folder_id}/sources/-, or projects/{project_id}/sources/-", + "description": "Required. Name of the source to groupBy. Its format is `organizations/[organization_id]/sources/[source_id]`, `folders/[folder_id]/sources/[source_id]`, or `projects/[project_id]/sources/[source_id]`. To groupBy across all sources provide a source_id of `-`. For example: `organizations/{organization_id}/sources/-, folders/{folder_id}/sources/-`, or `projects/{project_id}/sources/-`", "location": "path", "pattern": "^projects/[^/]+/sources/[^/]+$", "required": true, @@ -5829,7 +5829,7 @@ "type": "string" }, "parent": { - "description": "Required. Name of the source the findings belong to. Its format is \"organizations/[organization_id]/sources/[source_id], folders/[folder_id]/sources/[source_id], or projects/[project_id]/sources/[source_id]\". To list across all sources provide a source_id of `-`. For example: organizations/{organization_id}/sources/-, folders/{folder_id}/sources/- or projects/{projects_id}/sources/-", + "description": "Required. Name of the source the findings belong to. Its format is `organizations/[organization_id]/sources/[source_id]`, `folders/[folder_id]/sources/[source_id]`, or `projects/[project_id]/sources/[source_id]`. To list across all sources provide a source_id of `-`. For example: `organizations/{organization_id}/sources/-`, `folders/{folder_id}/sources/-` or `projects/{projects_id}/sources/-`", "location": "path", "pattern": "^projects/[^/]+/sources/[^/]+$", "required": true, @@ -5894,7 +5894,7 @@ ], "parameters": { "name": { - "description": "Required. The [relative resource name](https://cloud.google.com/apis/design/resource_names#relative_resource_name) of the finding. Example: \"organizations/{organization_id}/sources/{source_id}/findings/{finding_id}\", \"folders/{folder_id}/sources/{source_id}/findings/{finding_id}\", \"projects/{project_id}/sources/{source_id}/findings/{finding_id}\".", + "description": "Required. The [relative resource name](https://cloud.google.com/apis/design/resource_names#relative_resource_name) of the finding. Example: `organizations/{organization_id}/sources/{source_id}/findings/{finding_id}`, `folders/{folder_id}/sources/{source_id}/findings/{finding_id}`, `projects/{project_id}/sources/{source_id}/findings/{finding_id}`.", "location": "path", "pattern": "^projects/[^/]+/sources/[^/]+/findings/[^/]+$", "required": true, @@ -5922,7 +5922,7 @@ ], "parameters": { "name": { - "description": "Required. The [relative resource name](https://cloud.google.com/apis/design/resource_names#relative_resource_name) of the finding. Example: \"organizations/{organization_id}/sources/{source_id}/findings/{finding_id}\", \"folders/{folder_id}/sources/{source_id}/findings/{finding_id}\", \"projects/{project_id}/sources/{source_id}/findings/{finding_id}\".", + "description": "Required. The [relative resource name](https://cloud.google.com/apis/design/resource_names#relative_resource_name) of the finding. Example: `organizations/{organization_id}/sources/{source_id}/findings/{finding_id}`, `folders/{folder_id}/sources/{source_id}/findings/{finding_id}`, `projects/{project_id}/sources/{source_id}/findings/{finding_id}`.", "location": "path", "pattern": "^projects/[^/]+/sources/[^/]+/findings/[^/]+$", "required": true, @@ -6027,7 +6027,7 @@ } } }, - "revision": "20240622", + "revision": "20240712", "rootUrl": "https://securitycenter.googleapis.com/", "schemas": { "Access": { @@ -6251,7 +6251,7 @@ "id": "AttackExposure", "properties": { "attackExposureResult": { - "description": "The resource name of the attack path simulation result that contains the details regarding this attack exposure score. Example: organizations/123/simulations/456/attackExposureResults/789", + "description": "The resource name of the attack path simulation result that contains the details regarding this attack exposure score. Example: `organizations/123/simulations/456/attackExposureResults/789`", "type": "string" }, "exposedHighValueResourcesCount": { @@ -6359,11 +6359,11 @@ "type": "string" }, "resource": { - "description": "The name of the resource at this point in the attack path. The format of the name follows the Cloud Asset Inventory [resource name format](\"https://cloud.google.com/asset-inventory/docs/resource-name-format\")", + "description": "The name of the resource at this point in the attack path. The format of the name follows the Cloud Asset Inventory [resource name format](https://cloud.google.com/asset-inventory/docs/resource-name-format)", "type": "string" }, "resourceType": { - "description": "The [supported resource type](https://cloud.google.com/asset-inventory/docs/supported-asset-types\")", + "description": "The [supported resource type](https://cloud.google.com/asset-inventory/docs/supported-asset-types)", "type": "string" }, "uuid": { @@ -6537,7 +6537,7 @@ "type": "string" }, "id": { - "description": "The UUID of the Azure management group, for example, \"20000000-0001-0000-0000-000000000000\".", + "description": "The UUID of the Azure management group, for example, `20000000-0001-0000-0000-000000000000`.", "type": "string" } }, @@ -6585,7 +6585,7 @@ "type": "string" }, "id": { - "description": "The UUID of the Azure subscription, for example, \"291bba3f-e0a5-47bc-a099-3bdcb2a50a05\".", + "description": "The UUID of the Azure subscription, for example, `291bba3f-e0a5-47bc-a099-3bdcb2a50a05`.", "type": "string" } }, @@ -7358,7 +7358,7 @@ "type": "string" }, "name": { - "description": "Output only. The resource name of the effective ETD custom module. Its format is: * \"organizations/{organization}/eventThreatDetectionSettings/effectiveCustomModules/{module}\". * \"folders/{folder}/eventThreatDetectionSettings/effectiveCustomModules/{module}\". * \"projects/{project}/eventThreatDetectionSettings/effectiveCustomModules/{module}\".", + "description": "Output only. The resource name of the effective ETD custom module. Its format is: * `organizations/{organization}/eventThreatDetectionSettings/effectiveCustomModules/{module}`. * `folders/{folder}/eventThreatDetectionSettings/effectiveCustomModules/{module}`. * `projects/{project}/eventThreatDetectionSettings/effectiveCustomModules/{module}`.", "readOnly": true, "type": "string" }, @@ -7438,7 +7438,7 @@ "type": "string" }, "name": { - "description": "Immutable. The resource name of the Event Threat Detection custom module. Its format is: * \"organizations/{organization}/eventThreatDetectionSettings/customModules/{module}\". * \"folders/{folder}/eventThreatDetectionSettings/customModules/{module}\". * \"projects/{project}/eventThreatDetectionSettings/customModules/{module}\".", + "description": "Immutable. The resource name of the Event Threat Detection custom module. Its format is: * `organizations/{organization}/eventThreatDetectionSettings/customModules/{module}`. * `folders/{folder}/eventThreatDetectionSettings/customModules/{module}`. * `projects/{project}/eventThreatDetectionSettings/customModules/{module}`.", "type": "string" }, "type": { @@ -8208,7 +8208,7 @@ "type": "string" }, "name": { - "description": "This field will be ignored if provided on config creation. Format \"organizations/{organization}/muteConfigs/{mute_config}\" \"folders/{folder}/muteConfigs/{mute_config}\" \"projects/{project}/muteConfigs/{mute_config}\" \"organizations/{organization}/locations/global/muteConfigs/{mute_config}\" \"folders/{folder}/locations/global/muteConfigs/{mute_config}\" \"projects/{project}/locations/global/muteConfigs/{mute_config}\"", + "description": "This field will be ignored if provided on config creation. Format `organizations/{organization}/muteConfigs/{mute_config}` `folders/{folder}/muteConfigs/{mute_config}` `projects/{project}/muteConfigs/{mute_config}` `organizations/{organization}/locations/global/muteConfigs/{mute_config}` `folders/{folder}/locations/global/muteConfigs/{mute_config}` `projects/{project}/locations/global/muteConfigs/{mute_config}`", "type": "string" }, "updateTime": { @@ -8327,7 +8327,7 @@ "description": "Provides the path to the resource within the resource hierarchy." }, "resourcePathString": { - "description": "A string representation of the resource path. For Google Cloud, it has the format of organizations/{organization_id}/folders/{folder_id}/folders/{folder_id}/projects/{project_id} where there can be any number of folders. For AWS, it has the format of org/{organization_id}/ou/{organizational_unit_id}/ou/{organizational_unit_id}/account/{account_id} where there can be any number of organizational units. For Azure, it has the format of mg/{management_group_id}/mg/{management_group_id}/subscription/{subscription_id}/rg/{resource_group_name} where there can be any number of management groups.", + "description": "A string representation of the resource path. For Google Cloud, it has the format of `organizations/{organization_id}/folders/{folder_id}/folders/{folder_id}/projects/{project_id}` where there can be any number of folders. For AWS, it has the format of `org/{organization_id}/ou/{organizational_unit_id}/ou/{organizational_unit_id}/account/{account_id}` where there can be any number of organizational units. For Azure, it has the format of `mg/{management_group_id}/mg/{management_group_id}/subscription/{subscription_id}/rg/{resource_group_name}` where there can be any number of management groups.", "type": "string" }, "service": { @@ -8393,11 +8393,11 @@ "additionalProperties": { "type": "string" }, - "description": "List of resource labels to search for, evaluated with AND. For example, \"resource_labels_selector\": {\"key\": \"value\", \"env\": \"prod\"} will match resources with labels \"key\": \"value\" AND \"env\": \"prod\" https://cloud.google.com/resource-manager/docs/creating-managing-labels", + "description": "List of resource labels to search for, evaluated with `AND`. For example, `\"resource_labels_selector\": {\"key\": \"value\", \"env\": \"prod\"}` will match resources with labels \"key\": \"value\" `AND` \"env\": \"prod\" https://cloud.google.com/resource-manager/docs/creating-managing-labels", "type": "object" }, "resourceType": { - "description": "Apply resource_value only to resources that match resource_type. resource_type will be checked with AND of other resources. For example, \"storage.googleapis.com/Bucket\" with resource_value \"HIGH\" will apply \"HIGH\" value only to \"storage.googleapis.com/Bucket\" resources.", + "description": "Apply resource_value only to resources that match resource_type. resource_type will be checked with `AND` of other resources. For example, \"storage.googleapis.com/Bucket\" with resource_value \"HIGH\" will apply \"HIGH\" value only to \"storage.googleapis.com/Bucket\" resources.", "type": "string" }, "resourceValue": { @@ -8419,7 +8419,7 @@ "type": "string" }, "scope": { - "description": "Project or folder to scope this configuration to. For example, \"project/456\" would apply this configuration only to resources in \"project/456\" scope will be checked with AND of other resources.", + "description": "Project or folder to scope this configuration to. For example, \"project/456\" would apply this configuration only to resources in \"project/456\" scope will be checked with `AND` of other resources.", "type": "string" }, "sensitiveDataProtectionMapping": { @@ -8427,7 +8427,7 @@ "description": "A mapping of the sensitivity on Sensitive Data Protection finding to resource values. This mapping can only be used in combination with a resource_type that is related to BigQuery, e.g. \"bigquery.googleapis.com/Dataset\"." }, "tagValues": { - "description": "Required. Tag values combined with AND to check against. Values in the form \"tagValues/123\" Example: [ \"tagValues/123\", \"tagValues/456\", \"tagValues/789\" ] https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing", + "description": "Required. Tag values combined with `AND` to check against. Values in the form \"tagValues/123\" Example: `[ \"tagValues/123\", \"tagValues/456\", \"tagValues/789\" ]` https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing", "items": { "type": "string" }, @@ -8938,7 +8938,7 @@ "id": "GoogleCloudSecuritycenterV2AttackExposure", "properties": { "attackExposureResult": { - "description": "The resource name of the attack path simulation result that contains the details regarding this attack exposure score. Example: organizations/123/simulations/456/attackExposureResults/789", + "description": "The resource name of the attack path simulation result that contains the details regarding this attack exposure score. Example: `organizations/123/simulations/456/attackExposureResults/789`", "type": "string" }, "exposedHighValueResourcesCount": { @@ -9056,7 +9056,7 @@ "type": "string" }, "id": { - "description": "The UUID of the Azure management group, for example, \"20000000-0001-0000-0000-000000000000\".", + "description": "The UUID of the Azure management group, for example, `20000000-0001-0000-0000-000000000000`.", "type": "string" } }, @@ -9104,7 +9104,7 @@ "type": "string" }, "id": { - "description": "The UUID of the Azure subscription, for example, \"291bba3f-e0a5-47bc-a099-3bdcb2a50a05\".", + "description": "The UUID of the Azure subscription, for example, `291bba3f-e0a5-47bc-a099-3bdcb2a50a05`.", "type": "string" } }, @@ -9178,7 +9178,7 @@ "type": "string" }, "dataset": { - "description": "The dataset to write findings' updates to. Its format is \"projects/[project_id]/datasets/[bigquery_dataset_id]\". BigQuery Dataset unique ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_).", + "description": "The dataset to write findings' updates to. Its format is \"projects/[project_id]/datasets/[bigquery_dataset_id]\". BigQuery dataset unique ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_).", "type": "string" }, "description": { @@ -9195,7 +9195,7 @@ "type": "string" }, "name": { - "description": "The relative resource name of this export. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name. The following list shows some examples: + `organizations/{organization_id}/locations/{location_id}/bigQueryExports/{export_id}` + `folders/{folder_id}/locations/{location_id}/bigQueryExports/{export_id}` + `projects/{project_id}/locations/{location_id}/bigQueryExports/{export_id}` This field is provided in responses, and is ignored when provided in create requests.", + "description": "Identifier. The relative resource name of this export. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name. The following list shows some examples: + `organizations/{organization_id}/locations/{location_id}/bigQueryExports/{export_id}` + `folders/{folder_id}/locations/{location_id}/bigQueryExports/{export_id}` + `projects/{project_id}/locations/{location_id}/bigQueryExports/{export_id}` This field is provided in responses, and is ignored when provided in create requests.", "type": "string" }, "principal": { @@ -10534,8 +10534,10 @@ "COMMAND_AND_SCRIPTING_INTERPRETER", "UNIX_SHELL", "PYTHON", + "EXPLOITATION_FOR_PRIVILEGE_ESCALATION", "PERMISSION_GROUPS_DISCOVERY", "CLOUD_GROUPS", + "INDICATOR_REMOVAL_FILE_DELETION", "APPLICATION_LAYER_PROTOCOL", "DNS", "SOFTWARE_DEPLOYMENT_TOOLS", @@ -10599,8 +10601,10 @@ "T1059", "T1059.004", "T1059.006", + "T1068", "T1069", "T1069.003", + "T1070.004", "T1071", "T1071.004", "T1072", @@ -10648,7 +10652,7 @@ "T1588", "T1595", "T1595.001", - "T1613", + "T1609", "T1611", "T1613", "T1649" @@ -10709,8 +10713,10 @@ "COMMAND_AND_SCRIPTING_INTERPRETER", "UNIX_SHELL", "PYTHON", + "EXPLOITATION_FOR_PRIVILEGE_ESCALATION", "PERMISSION_GROUPS_DISCOVERY", "CLOUD_GROUPS", + "INDICATOR_REMOVAL_FILE_DELETION", "APPLICATION_LAYER_PROTOCOL", "DNS", "SOFTWARE_DEPLOYMENT_TOOLS", @@ -10774,8 +10780,10 @@ "T1059", "T1059.004", "T1059.006", + "T1068", "T1069", "T1069.003", + "T1070.004", "T1071", "T1071.004", "T1072", @@ -10823,7 +10831,7 @@ "T1588", "T1595", "T1595.001", - "T1613", + "T1609", "T1611", "T1613", "T1649" @@ -10863,7 +10871,7 @@ "type": "string" }, "name": { - "description": "This field will be ignored if provided on config creation. The following list shows some examples of the format: + `organizations/{organization}/muteConfigs/{mute_config}` + `organizations/{organization}locations/{location}//muteConfigs/{mute_config}` + `folders/{folder}/muteConfigs/{mute_config}` + `folders/{folder}/locations/{location}/muteConfigs/{mute_config}` + `projects/{project}/muteConfigs/{mute_config}` + `projects/{project}/locations/{location}/muteConfigs/{mute_config}`", + "description": "Identifier. This field will be ignored if provided on config creation. The following list shows some examples of the format: + `organizations/{organization}/muteConfigs/{mute_config}` + `organizations/{organization}locations/{location}//muteConfigs/{mute_config}` + `folders/{folder}/muteConfigs/{mute_config}` + `folders/{folder}/locations/{location}/muteConfigs/{mute_config}` + `projects/{project}/muteConfigs/{mute_config}` + `projects/{project}/locations/{location}/muteConfigs/{mute_config}`", "type": "string" }, "type": { @@ -11249,7 +11257,7 @@ "description": "Provides the path to the resource within the resource hierarchy." }, "resourcePathString": { - "description": "A string representation of the resource path. For Google Cloud, it has the format of organizations/{organization_id}/folders/{folder_id}/folders/{folder_id}/projects/{project_id} where there can be any number of folders. For AWS, it has the format of org/{organization_id}/ou/{organizational_unit_id}/ou/{organizational_unit_id}/account/{account_id} where there can be any number of organizational units. For Azure, it has the format of mg/{management_group_id}/mg/{management_group_id}/subscription/{subscription_id}/rg/{resource_group_name} where there can be any number of management groups.", + "description": "A string representation of the resource path. For Google Cloud, it has the format of `organizations/{organization_id}/folders/{folder_id}/folders/{folder_id}/projects/{project_id}` where there can be any number of folders. For AWS, it has the format of `org/{organization_id}/ou/{organizational_unit_id}/ou/{organizational_unit_id}/account/{account_id}` where there can be any number of organizational units. For Azure, it has the format of `mg/{management_group_id}/mg/{management_group_id}/subscription/{subscription_id}/rg/{resource_group_name}` where there can be any number of management groups.", "type": "string" }, "service": { @@ -11351,22 +11359,22 @@ "type": "string" }, "name": { - "description": "Name for the resource value configuration", + "description": "Identifier. Name for the resource value configuration", "type": "string" }, "resourceLabelsSelector": { "additionalProperties": { "type": "string" }, - "description": "List of resource labels to search for, evaluated with AND. For example, \"resource_labels_selector\": {\"key\": \"value\", \"env\": \"prod\"} will match resources with labels \"key\": \"value\" AND \"env\": \"prod\" https://cloud.google.com/resource-manager/docs/creating-managing-labels", + "description": "List of resource labels to search for, evaluated with `AND`. For example, \"resource_labels_selector\": {\"key\": \"value\", \"env\": \"prod\"} will match resources with labels \"key\": \"value\" `AND` \"env\": \"prod\" https://cloud.google.com/resource-manager/docs/creating-managing-labels", "type": "object" }, "resourceType": { - "description": "Apply resource_value only to resources that match resource_type. resource_type will be checked with AND of other resources. For example, \"storage.googleapis.com/Bucket\" with resource_value \"HIGH\" will apply \"HIGH\" value only to \"storage.googleapis.com/Bucket\" resources.", + "description": "Apply resource_value only to resources that match resource_type. resource_type will be checked with `AND` of other resources. For example, \"storage.googleapis.com/Bucket\" with resource_value \"HIGH\" will apply \"HIGH\" value only to \"storage.googleapis.com/Bucket\" resources.", "type": "string" }, "resourceValue": { - "description": "Resource value level this expression represents Only required when there is no SDP mapping in the request", + "description": "Resource value level this expression represents Only required when there is no Sensitive Data Protection mapping in the request", "enum": [ "RESOURCE_VALUE_UNSPECIFIED", "HIGH", @@ -11384,7 +11392,7 @@ "type": "string" }, "scope": { - "description": "Project or folder to scope this configuration to. For example, \"project/456\" would apply this configuration only to resources in \"project/456\" scope will be checked with AND of other resources.", + "description": "Project or folder to scope this configuration to. For example, \"project/456\" would apply this configuration only to resources in \"project/456\" scope and will be checked with `AND` of other resources.", "type": "string" }, "sensitiveDataProtectionMapping": { @@ -11392,7 +11400,7 @@ "description": "A mapping of the sensitivity on Sensitive Data Protection finding to resource values. This mapping can only be used in combination with a resource_type that is related to BigQuery, e.g. \"bigquery.googleapis.com/Dataset\"." }, "tagValues": { - "description": "Required. Tag values combined with AND to check against. Values in the form \"tagValues/123\" Example: [ \"tagValues/123\", \"tagValues/456\", \"tagValues/789\" ] https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing", + "description": "Tag values combined with `AND` to check against. Values in the form \"tagValues/123\" Example: `[ \"tagValues/123\", \"tagValues/456\", \"tagValues/789\" ]` https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing", "items": { "type": "string" }, @@ -11670,7 +11678,7 @@ "type": "number" }, "relatedFindings": { - "description": "List of resource names of findings associated with this toxic combination. For example, organizations/123/sources/456/findings/789.", + "description": "List of resource names of findings associated with this toxic combination. For example, `organizations/123/sources/456/findings/789`.", "items": { "type": "string" }, @@ -12541,8 +12549,10 @@ "COMMAND_AND_SCRIPTING_INTERPRETER", "UNIX_SHELL", "PYTHON", + "EXPLOITATION_FOR_PRIVILEGE_ESCALATION", "PERMISSION_GROUPS_DISCOVERY", "CLOUD_GROUPS", + "INDICATOR_REMOVAL_FILE_DELETION", "APPLICATION_LAYER_PROTOCOL", "DNS", "SOFTWARE_DEPLOYMENT_TOOLS", @@ -12606,8 +12616,10 @@ "T1059", "T1059.004", "T1059.006", + "T1068", "T1069", "T1069.003", + "T1070.004", "T1071", "T1071.004", "T1072", @@ -12716,8 +12728,10 @@ "COMMAND_AND_SCRIPTING_INTERPRETER", "UNIX_SHELL", "PYTHON", + "EXPLOITATION_FOR_PRIVILEGE_ESCALATION", "PERMISSION_GROUPS_DISCOVERY", "CLOUD_GROUPS", + "INDICATOR_REMOVAL_FILE_DELETION", "APPLICATION_LAYER_PROTOCOL", "DNS", "SOFTWARE_DEPLOYMENT_TOOLS", @@ -12781,8 +12795,10 @@ "T1059", "T1059.004", "T1059.006", + "T1068", "T1069", "T1069.003", + "T1070.004", "T1071", "T1071.004", "T1072", @@ -13050,7 +13066,7 @@ "id": "PathNodeAssociatedFinding", "properties": { "canonicalFinding": { - "description": "Canonical name of the associated findings. Example: organizations/123/sources/456/findings/789", + "description": "Canonical name of the associated findings. Example: `organizations/123/sources/456/findings/789`", "type": "string" }, "findingCategory": { @@ -13359,7 +13375,7 @@ "description": "Provides the path to the resource within the resource hierarchy." }, "resourcePathString": { - "description": "A string representation of the resource path. For Google Cloud, it has the format of org/{organization_id}/folder/{folder_id}/folder/{folder_id}/project/{project_id} where there can be any number of folders. For AWS, it has the format of org/{organization_id}/ou/{organizational_unit_id}/ou/{organizational_unit_id}/account/{account_id} where there can be any number of organizational units. For Azure, it has the format of mg/{management_group_id}/mg/{management_group_id}/subscription/{subscription_id}/rg/{resource_group_name} where there can be any number of management groups.", + "description": "A string representation of the resource path. For Google Cloud, it has the format of `org/{organization_id}/folder/{folder_id}/folder/{folder_id}/project/{project_id}` where there can be any number of folders. For AWS, it has the format of `org/{organization_id}/ou/{organizational_unit_id}/ou/{organizational_unit_id}/account/{account_id}` where there can be any number of organizational units. For Azure, it has the format of `mg/{management_group_id}/mg/{management_group_id}/subscription/{subscription_id}/rg/{resource_group_name}` where there can be any number of management groups.", "type": "string" }, "service": { @@ -13803,7 +13819,7 @@ "type": "string" }, "name": { - "description": "Full resource name of the Simulation: organizations/123/simulations/456", + "description": "Full resource name of the Simulation: `organizations/123/simulations/456`", "type": "string" }, "resourceValueConfigsMetadata": { @@ -13978,7 +13994,7 @@ "type": "number" }, "relatedFindings": { - "description": "List of resource names of findings associated with this toxic combination. For example, organizations/123/sources/456/findings/789.", + "description": "List of resource names of findings associated with this toxic combination. For example, `organizations/123/sources/456/findings/789`.", "items": { "type": "string" }, diff --git a/discovery/securitycenter-v1beta1.json b/discovery/securitycenter-v1beta1.json index ac2ab6fd8f..905461221a 100644 --- a/discovery/securitycenter-v1beta1.json +++ b/discovery/securitycenter-v1beta1.json @@ -896,7 +896,7 @@ } } }, - "revision": "20240622", + "revision": "20240712", "rootUrl": "https://securitycenter.googleapis.com/", "schemas": { "Access": { @@ -1105,7 +1105,7 @@ "id": "AttackExposure", "properties": { "attackExposureResult": { - "description": "The resource name of the attack path simulation result that contains the details regarding this attack exposure score. Example: organizations/123/simulations/456/attackExposureResults/789", + "description": "The resource name of the attack path simulation result that contains the details regarding this attack exposure score. Example: `organizations/123/simulations/456/attackExposureResults/789`", "type": "string" }, "exposedHighValueResourcesCount": { @@ -1270,7 +1270,7 @@ "type": "string" }, "id": { - "description": "The UUID of the Azure management group, for example, \"20000000-0001-0000-0000-000000000000\".", + "description": "The UUID of the Azure management group, for example, `20000000-0001-0000-0000-000000000000`.", "type": "string" } }, @@ -1318,7 +1318,7 @@ "type": "string" }, "id": { - "description": "The UUID of the Azure subscription, for example, \"291bba3f-e0a5-47bc-a099-3bdcb2a50a05\".", + "description": "The UUID of the Azure subscription, for example, `291bba3f-e0a5-47bc-a099-3bdcb2a50a05`.", "type": "string" } }, @@ -2738,7 +2738,7 @@ "type": "string" }, "name": { - "description": "This field will be ignored if provided on config creation. Format \"organizations/{organization}/muteConfigs/{mute_config}\" \"folders/{folder}/muteConfigs/{mute_config}\" \"projects/{project}/muteConfigs/{mute_config}\" \"organizations/{organization}/locations/global/muteConfigs/{mute_config}\" \"folders/{folder}/locations/global/muteConfigs/{mute_config}\" \"projects/{project}/locations/global/muteConfigs/{mute_config}\"", + "description": "This field will be ignored if provided on config creation. Format `organizations/{organization}/muteConfigs/{mute_config}` `folders/{folder}/muteConfigs/{mute_config}` `projects/{project}/muteConfigs/{mute_config}` `organizations/{organization}/locations/global/muteConfigs/{mute_config}` `folders/{folder}/locations/global/muteConfigs/{mute_config}` `projects/{project}/locations/global/muteConfigs/{mute_config}`", "type": "string" }, "updateTime": { @@ -2857,7 +2857,7 @@ "description": "Provides the path to the resource within the resource hierarchy." }, "resourcePathString": { - "description": "A string representation of the resource path. For Google Cloud, it has the format of organizations/{organization_id}/folders/{folder_id}/folders/{folder_id}/projects/{project_id} where there can be any number of folders. For AWS, it has the format of org/{organization_id}/ou/{organizational_unit_id}/ou/{organizational_unit_id}/account/{account_id} where there can be any number of organizational units. For Azure, it has the format of mg/{management_group_id}/mg/{management_group_id}/subscription/{subscription_id}/rg/{resource_group_name} where there can be any number of management groups.", + "description": "A string representation of the resource path. For Google Cloud, it has the format of `organizations/{organization_id}/folders/{folder_id}/folders/{folder_id}/projects/{project_id}` where there can be any number of folders. For AWS, it has the format of `org/{organization_id}/ou/{organizational_unit_id}/ou/{organizational_unit_id}/account/{account_id}` where there can be any number of organizational units. For Azure, it has the format of `mg/{management_group_id}/mg/{management_group_id}/subscription/{subscription_id}/rg/{resource_group_name}` where there can be any number of management groups.", "type": "string" }, "service": { @@ -2923,11 +2923,11 @@ "additionalProperties": { "type": "string" }, - "description": "List of resource labels to search for, evaluated with AND. For example, \"resource_labels_selector\": {\"key\": \"value\", \"env\": \"prod\"} will match resources with labels \"key\": \"value\" AND \"env\": \"prod\" https://cloud.google.com/resource-manager/docs/creating-managing-labels", + "description": "List of resource labels to search for, evaluated with `AND`. For example, `\"resource_labels_selector\": {\"key\": \"value\", \"env\": \"prod\"}` will match resources with labels \"key\": \"value\" `AND` \"env\": \"prod\" https://cloud.google.com/resource-manager/docs/creating-managing-labels", "type": "object" }, "resourceType": { - "description": "Apply resource_value only to resources that match resource_type. resource_type will be checked with AND of other resources. For example, \"storage.googleapis.com/Bucket\" with resource_value \"HIGH\" will apply \"HIGH\" value only to \"storage.googleapis.com/Bucket\" resources.", + "description": "Apply resource_value only to resources that match resource_type. resource_type will be checked with `AND` of other resources. For example, \"storage.googleapis.com/Bucket\" with resource_value \"HIGH\" will apply \"HIGH\" value only to \"storage.googleapis.com/Bucket\" resources.", "type": "string" }, "resourceValue": { @@ -2949,7 +2949,7 @@ "type": "string" }, "scope": { - "description": "Project or folder to scope this configuration to. For example, \"project/456\" would apply this configuration only to resources in \"project/456\" scope will be checked with AND of other resources.", + "description": "Project or folder to scope this configuration to. For example, \"project/456\" would apply this configuration only to resources in \"project/456\" scope will be checked with `AND` of other resources.", "type": "string" }, "sensitiveDataProtectionMapping": { @@ -2957,7 +2957,7 @@ "description": "A mapping of the sensitivity on Sensitive Data Protection finding to resource values. This mapping can only be used in combination with a resource_type that is related to BigQuery, e.g. \"bigquery.googleapis.com/Dataset\"." }, "tagValues": { - "description": "Required. Tag values combined with AND to check against. Values in the form \"tagValues/123\" Example: [ \"tagValues/123\", \"tagValues/456\", \"tagValues/789\" ] https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing", + "description": "Required. Tag values combined with `AND` to check against. Values in the form \"tagValues/123\" Example: `[ \"tagValues/123\", \"tagValues/456\", \"tagValues/789\" ]` https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing", "items": { "type": "string" }, @@ -3549,7 +3549,7 @@ "id": "GoogleCloudSecuritycenterV2AttackExposure", "properties": { "attackExposureResult": { - "description": "The resource name of the attack path simulation result that contains the details regarding this attack exposure score. Example: organizations/123/simulations/456/attackExposureResults/789", + "description": "The resource name of the attack path simulation result that contains the details regarding this attack exposure score. Example: `organizations/123/simulations/456/attackExposureResults/789`", "type": "string" }, "exposedHighValueResourcesCount": { @@ -3667,7 +3667,7 @@ "type": "string" }, "id": { - "description": "The UUID of the Azure management group, for example, \"20000000-0001-0000-0000-000000000000\".", + "description": "The UUID of the Azure management group, for example, `20000000-0001-0000-0000-000000000000`.", "type": "string" } }, @@ -3715,7 +3715,7 @@ "type": "string" }, "id": { - "description": "The UUID of the Azure subscription, for example, \"291bba3f-e0a5-47bc-a099-3bdcb2a50a05\".", + "description": "The UUID of the Azure subscription, for example, `291bba3f-e0a5-47bc-a099-3bdcb2a50a05`.", "type": "string" } }, @@ -3789,7 +3789,7 @@ "type": "string" }, "dataset": { - "description": "The dataset to write findings' updates to. Its format is \"projects/[project_id]/datasets/[bigquery_dataset_id]\". BigQuery Dataset unique ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_).", + "description": "The dataset to write findings' updates to. Its format is \"projects/[project_id]/datasets/[bigquery_dataset_id]\". BigQuery dataset unique ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_).", "type": "string" }, "description": { @@ -3806,7 +3806,7 @@ "type": "string" }, "name": { - "description": "The relative resource name of this export. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name. The following list shows some examples: + `organizations/{organization_id}/locations/{location_id}/bigQueryExports/{export_id}` + `folders/{folder_id}/locations/{location_id}/bigQueryExports/{export_id}` + `projects/{project_id}/locations/{location_id}/bigQueryExports/{export_id}` This field is provided in responses, and is ignored when provided in create requests.", + "description": "Identifier. The relative resource name of this export. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name. The following list shows some examples: + `organizations/{organization_id}/locations/{location_id}/bigQueryExports/{export_id}` + `folders/{folder_id}/locations/{location_id}/bigQueryExports/{export_id}` + `projects/{project_id}/locations/{location_id}/bigQueryExports/{export_id}` This field is provided in responses, and is ignored when provided in create requests.", "type": "string" }, "principal": { @@ -5145,8 +5145,10 @@ "COMMAND_AND_SCRIPTING_INTERPRETER", "UNIX_SHELL", "PYTHON", + "EXPLOITATION_FOR_PRIVILEGE_ESCALATION", "PERMISSION_GROUPS_DISCOVERY", "CLOUD_GROUPS", + "INDICATOR_REMOVAL_FILE_DELETION", "APPLICATION_LAYER_PROTOCOL", "DNS", "SOFTWARE_DEPLOYMENT_TOOLS", @@ -5210,8 +5212,10 @@ "T1059", "T1059.004", "T1059.006", + "T1068", "T1069", "T1069.003", + "T1070.004", "T1071", "T1071.004", "T1072", @@ -5259,7 +5263,7 @@ "T1588", "T1595", "T1595.001", - "T1613", + "T1609", "T1611", "T1613", "T1649" @@ -5320,8 +5324,10 @@ "COMMAND_AND_SCRIPTING_INTERPRETER", "UNIX_SHELL", "PYTHON", + "EXPLOITATION_FOR_PRIVILEGE_ESCALATION", "PERMISSION_GROUPS_DISCOVERY", "CLOUD_GROUPS", + "INDICATOR_REMOVAL_FILE_DELETION", "APPLICATION_LAYER_PROTOCOL", "DNS", "SOFTWARE_DEPLOYMENT_TOOLS", @@ -5385,8 +5391,10 @@ "T1059", "T1059.004", "T1059.006", + "T1068", "T1069", "T1069.003", + "T1070.004", "T1071", "T1071.004", "T1072", @@ -5434,7 +5442,7 @@ "T1588", "T1595", "T1595.001", - "T1613", + "T1609", "T1611", "T1613", "T1649" @@ -5474,7 +5482,7 @@ "type": "string" }, "name": { - "description": "This field will be ignored if provided on config creation. The following list shows some examples of the format: + `organizations/{organization}/muteConfigs/{mute_config}` + `organizations/{organization}locations/{location}//muteConfigs/{mute_config}` + `folders/{folder}/muteConfigs/{mute_config}` + `folders/{folder}/locations/{location}/muteConfigs/{mute_config}` + `projects/{project}/muteConfigs/{mute_config}` + `projects/{project}/locations/{location}/muteConfigs/{mute_config}`", + "description": "Identifier. This field will be ignored if provided on config creation. The following list shows some examples of the format: + `organizations/{organization}/muteConfigs/{mute_config}` + `organizations/{organization}locations/{location}//muteConfigs/{mute_config}` + `folders/{folder}/muteConfigs/{mute_config}` + `folders/{folder}/locations/{location}/muteConfigs/{mute_config}` + `projects/{project}/muteConfigs/{mute_config}` + `projects/{project}/locations/{location}/muteConfigs/{mute_config}`", "type": "string" }, "type": { @@ -5860,7 +5868,7 @@ "description": "Provides the path to the resource within the resource hierarchy." }, "resourcePathString": { - "description": "A string representation of the resource path. For Google Cloud, it has the format of organizations/{organization_id}/folders/{folder_id}/folders/{folder_id}/projects/{project_id} where there can be any number of folders. For AWS, it has the format of org/{organization_id}/ou/{organizational_unit_id}/ou/{organizational_unit_id}/account/{account_id} where there can be any number of organizational units. For Azure, it has the format of mg/{management_group_id}/mg/{management_group_id}/subscription/{subscription_id}/rg/{resource_group_name} where there can be any number of management groups.", + "description": "A string representation of the resource path. For Google Cloud, it has the format of `organizations/{organization_id}/folders/{folder_id}/folders/{folder_id}/projects/{project_id}` where there can be any number of folders. For AWS, it has the format of `org/{organization_id}/ou/{organizational_unit_id}/ou/{organizational_unit_id}/account/{account_id}` where there can be any number of organizational units. For Azure, it has the format of `mg/{management_group_id}/mg/{management_group_id}/subscription/{subscription_id}/rg/{resource_group_name}` where there can be any number of management groups.", "type": "string" }, "service": { @@ -5962,22 +5970,22 @@ "type": "string" }, "name": { - "description": "Name for the resource value configuration", + "description": "Identifier. Name for the resource value configuration", "type": "string" }, "resourceLabelsSelector": { "additionalProperties": { "type": "string" }, - "description": "List of resource labels to search for, evaluated with AND. For example, \"resource_labels_selector\": {\"key\": \"value\", \"env\": \"prod\"} will match resources with labels \"key\": \"value\" AND \"env\": \"prod\" https://cloud.google.com/resource-manager/docs/creating-managing-labels", + "description": "List of resource labels to search for, evaluated with `AND`. For example, \"resource_labels_selector\": {\"key\": \"value\", \"env\": \"prod\"} will match resources with labels \"key\": \"value\" `AND` \"env\": \"prod\" https://cloud.google.com/resource-manager/docs/creating-managing-labels", "type": "object" }, "resourceType": { - "description": "Apply resource_value only to resources that match resource_type. resource_type will be checked with AND of other resources. For example, \"storage.googleapis.com/Bucket\" with resource_value \"HIGH\" will apply \"HIGH\" value only to \"storage.googleapis.com/Bucket\" resources.", + "description": "Apply resource_value only to resources that match resource_type. resource_type will be checked with `AND` of other resources. For example, \"storage.googleapis.com/Bucket\" with resource_value \"HIGH\" will apply \"HIGH\" value only to \"storage.googleapis.com/Bucket\" resources.", "type": "string" }, "resourceValue": { - "description": "Resource value level this expression represents Only required when there is no SDP mapping in the request", + "description": "Resource value level this expression represents Only required when there is no Sensitive Data Protection mapping in the request", "enum": [ "RESOURCE_VALUE_UNSPECIFIED", "HIGH", @@ -5995,7 +6003,7 @@ "type": "string" }, "scope": { - "description": "Project or folder to scope this configuration to. For example, \"project/456\" would apply this configuration only to resources in \"project/456\" scope will be checked with AND of other resources.", + "description": "Project or folder to scope this configuration to. For example, \"project/456\" would apply this configuration only to resources in \"project/456\" scope and will be checked with `AND` of other resources.", "type": "string" }, "sensitiveDataProtectionMapping": { @@ -6003,7 +6011,7 @@ "description": "A mapping of the sensitivity on Sensitive Data Protection finding to resource values. This mapping can only be used in combination with a resource_type that is related to BigQuery, e.g. \"bigquery.googleapis.com/Dataset\"." }, "tagValues": { - "description": "Required. Tag values combined with AND to check against. Values in the form \"tagValues/123\" Example: [ \"tagValues/123\", \"tagValues/456\", \"tagValues/789\" ] https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing", + "description": "Tag values combined with `AND` to check against. Values in the form \"tagValues/123\" Example: `[ \"tagValues/123\", \"tagValues/456\", \"tagValues/789\" ]` https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing", "items": { "type": "string" }, @@ -6281,7 +6289,7 @@ "type": "number" }, "relatedFindings": { - "description": "List of resource names of findings associated with this toxic combination. For example, organizations/123/sources/456/findings/789.", + "description": "List of resource names of findings associated with this toxic combination. For example, `organizations/123/sources/456/findings/789`.", "items": { "type": "string" }, @@ -6873,8 +6881,10 @@ "COMMAND_AND_SCRIPTING_INTERPRETER", "UNIX_SHELL", "PYTHON", + "EXPLOITATION_FOR_PRIVILEGE_ESCALATION", "PERMISSION_GROUPS_DISCOVERY", "CLOUD_GROUPS", + "INDICATOR_REMOVAL_FILE_DELETION", "APPLICATION_LAYER_PROTOCOL", "DNS", "SOFTWARE_DEPLOYMENT_TOOLS", @@ -6938,8 +6948,10 @@ "T1059", "T1059.004", "T1059.006", + "T1068", "T1069", "T1069.003", + "T1070.004", "T1071", "T1071.004", "T1072", @@ -7048,8 +7060,10 @@ "COMMAND_AND_SCRIPTING_INTERPRETER", "UNIX_SHELL", "PYTHON", + "EXPLOITATION_FOR_PRIVILEGE_ESCALATION", "PERMISSION_GROUPS_DISCOVERY", "CLOUD_GROUPS", + "INDICATOR_REMOVAL_FILE_DELETION", "APPLICATION_LAYER_PROTOCOL", "DNS", "SOFTWARE_DEPLOYMENT_TOOLS", @@ -7113,8 +7127,10 @@ "T1059", "T1059.004", "T1059.006", + "T1068", "T1069", "T1069.003", + "T1070.004", "T1071", "T1071.004", "T1072", @@ -7986,7 +8002,7 @@ "type": "number" }, "relatedFindings": { - "description": "List of resource names of findings associated with this toxic combination. For example, organizations/123/sources/456/findings/789.", + "description": "List of resource names of findings associated with this toxic combination. For example, `organizations/123/sources/456/findings/789`.", "items": { "type": "string" }, diff --git a/discovery/securitycenter-v1beta2.json b/discovery/securitycenter-v1beta2.json index 431ba799d4..745373260e 100644 --- a/discovery/securitycenter-v1beta2.json +++ b/discovery/securitycenter-v1beta2.json @@ -292,7 +292,7 @@ ], "parameters": { "name": { - "description": "The resource name of the ContainerThreatDetectionSettings. Formats: * organizations/{organization}/containerThreatDetectionSettings * folders/{folder}/containerThreatDetectionSettings * projects/{project}/containerThreatDetectionSettings * projects/{project}/locations/{location}/clusters/{cluster}/containerThreatDetectionSettings", + "description": "Identifier. The resource name of the ContainerThreatDetectionSettings. Formats: * organizations/{organization}/containerThreatDetectionSettings * folders/{folder}/containerThreatDetectionSettings * projects/{project}/containerThreatDetectionSettings * projects/{project}/locations/{location}/clusters/{cluster}/containerThreatDetectionSettings", "location": "path", "pattern": "^folders/[^/]+/containerThreatDetectionSettings$", "required": true, @@ -326,7 +326,7 @@ ], "parameters": { "name": { - "description": "The resource name of the EventThreatDetectionSettings. Formats: * organizations/{organization}/eventThreatDetectionSettings * folders/{folder}/eventThreatDetectionSettings * projects/{project}/eventThreatDetectionSettings", + "description": "Identifier. The resource name of the EventThreatDetectionSettings. Formats: * organizations/{organization}/eventThreatDetectionSettings * folders/{folder}/eventThreatDetectionSettings * projects/{project}/eventThreatDetectionSettings", "location": "path", "pattern": "^folders/[^/]+/eventThreatDetectionSettings$", "required": true, @@ -394,7 +394,7 @@ ], "parameters": { "name": { - "description": "The resource name of the SecurityHealthAnalyticsSettings. Formats: * organizations/{organization}/securityHealthAnalyticsSettings * folders/{folder}/securityHealthAnalyticsSettings * projects/{project}/securityHealthAnalyticsSettings", + "description": "Identifier. The resource name of the SecurityHealthAnalyticsSettings. Formats: * organizations/{organization}/securityHealthAnalyticsSettings * folders/{folder}/securityHealthAnalyticsSettings * projects/{project}/securityHealthAnalyticsSettings", "location": "path", "pattern": "^folders/[^/]+/securityHealthAnalyticsSettings$", "required": true, @@ -428,7 +428,7 @@ ], "parameters": { "name": { - "description": "The resource name of the VirtualMachineThreatDetectionSettings. Formats: * organizations/{organization}/virtualMachineThreatDetectionSettings * folders/{folder}/virtualMachineThreatDetectionSettings * projects/{project}/virtualMachineThreatDetectionSettings", + "description": "Identifier. The resource name of the VirtualMachineThreatDetectionSettings. Formats: * organizations/{organization}/virtualMachineThreatDetectionSettings * folders/{folder}/virtualMachineThreatDetectionSettings * projects/{project}/virtualMachineThreatDetectionSettings", "location": "path", "pattern": "^folders/[^/]+/virtualMachineThreatDetectionSettings$", "required": true, @@ -462,7 +462,7 @@ ], "parameters": { "name": { - "description": "The resource name of the WebSecurityScannerSettings. Formats: * organizations/{organization}/webSecurityScannerSettings * folders/{folder}/webSecurityScannerSettings * projects/{project}/webSecurityScannerSettings", + "description": "Identifier. The resource name of the WebSecurityScannerSettings. Formats: * organizations/{organization}/webSecurityScannerSettings * folders/{folder}/webSecurityScannerSettings * projects/{project}/webSecurityScannerSettings", "location": "path", "pattern": "^folders/[^/]+/webSecurityScannerSettings$", "required": true, @@ -876,7 +876,7 @@ ], "parameters": { "name": { - "description": "The resource name of the ContainerThreatDetectionSettings. Formats: * organizations/{organization}/containerThreatDetectionSettings * folders/{folder}/containerThreatDetectionSettings * projects/{project}/containerThreatDetectionSettings * projects/{project}/locations/{location}/clusters/{cluster}/containerThreatDetectionSettings", + "description": "Identifier. The resource name of the ContainerThreatDetectionSettings. Formats: * organizations/{organization}/containerThreatDetectionSettings * folders/{folder}/containerThreatDetectionSettings * projects/{project}/containerThreatDetectionSettings * projects/{project}/locations/{location}/clusters/{cluster}/containerThreatDetectionSettings", "location": "path", "pattern": "^organizations/[^/]+/containerThreatDetectionSettings$", "required": true, @@ -910,7 +910,7 @@ ], "parameters": { "name": { - "description": "The resource name of the EventThreatDetectionSettings. Formats: * organizations/{organization}/eventThreatDetectionSettings * folders/{folder}/eventThreatDetectionSettings * projects/{project}/eventThreatDetectionSettings", + "description": "Identifier. The resource name of the EventThreatDetectionSettings. Formats: * organizations/{organization}/eventThreatDetectionSettings * folders/{folder}/eventThreatDetectionSettings * projects/{project}/eventThreatDetectionSettings", "location": "path", "pattern": "^organizations/[^/]+/eventThreatDetectionSettings$", "required": true, @@ -978,7 +978,7 @@ ], "parameters": { "name": { - "description": "The resource name of the SecurityHealthAnalyticsSettings. Formats: * organizations/{organization}/securityHealthAnalyticsSettings * folders/{folder}/securityHealthAnalyticsSettings * projects/{project}/securityHealthAnalyticsSettings", + "description": "Identifier. The resource name of the SecurityHealthAnalyticsSettings. Formats: * organizations/{organization}/securityHealthAnalyticsSettings * folders/{folder}/securityHealthAnalyticsSettings * projects/{project}/securityHealthAnalyticsSettings", "location": "path", "pattern": "^organizations/[^/]+/securityHealthAnalyticsSettings$", "required": true, @@ -1012,7 +1012,7 @@ ], "parameters": { "name": { - "description": "The resource name of the VirtualMachineThreatDetectionSettings. Formats: * organizations/{organization}/virtualMachineThreatDetectionSettings * folders/{folder}/virtualMachineThreatDetectionSettings * projects/{project}/virtualMachineThreatDetectionSettings", + "description": "Identifier. The resource name of the VirtualMachineThreatDetectionSettings. Formats: * organizations/{organization}/virtualMachineThreatDetectionSettings * folders/{folder}/virtualMachineThreatDetectionSettings * projects/{project}/virtualMachineThreatDetectionSettings", "location": "path", "pattern": "^organizations/[^/]+/virtualMachineThreatDetectionSettings$", "required": true, @@ -1046,7 +1046,7 @@ ], "parameters": { "name": { - "description": "The resource name of the WebSecurityScannerSettings. Formats: * organizations/{organization}/webSecurityScannerSettings * folders/{folder}/webSecurityScannerSettings * projects/{project}/webSecurityScannerSettings", + "description": "Identifier. The resource name of the WebSecurityScannerSettings. Formats: * organizations/{organization}/webSecurityScannerSettings * folders/{folder}/webSecurityScannerSettings * projects/{project}/webSecurityScannerSettings", "location": "path", "pattern": "^organizations/[^/]+/webSecurityScannerSettings$", "required": true, @@ -1435,7 +1435,7 @@ ], "parameters": { "name": { - "description": "The resource name of the ContainerThreatDetectionSettings. Formats: * organizations/{organization}/containerThreatDetectionSettings * folders/{folder}/containerThreatDetectionSettings * projects/{project}/containerThreatDetectionSettings * projects/{project}/locations/{location}/clusters/{cluster}/containerThreatDetectionSettings", + "description": "Identifier. The resource name of the ContainerThreatDetectionSettings. Formats: * organizations/{organization}/containerThreatDetectionSettings * folders/{folder}/containerThreatDetectionSettings * projects/{project}/containerThreatDetectionSettings * projects/{project}/locations/{location}/clusters/{cluster}/containerThreatDetectionSettings", "location": "path", "pattern": "^projects/[^/]+/containerThreatDetectionSettings$", "required": true, @@ -1469,7 +1469,7 @@ ], "parameters": { "name": { - "description": "The resource name of the EventThreatDetectionSettings. Formats: * organizations/{organization}/eventThreatDetectionSettings * folders/{folder}/eventThreatDetectionSettings * projects/{project}/eventThreatDetectionSettings", + "description": "Identifier. The resource name of the EventThreatDetectionSettings. Formats: * organizations/{organization}/eventThreatDetectionSettings * folders/{folder}/eventThreatDetectionSettings * projects/{project}/eventThreatDetectionSettings", "location": "path", "pattern": "^projects/[^/]+/eventThreatDetectionSettings$", "required": true, @@ -1537,7 +1537,7 @@ ], "parameters": { "name": { - "description": "The resource name of the SecurityHealthAnalyticsSettings. Formats: * organizations/{organization}/securityHealthAnalyticsSettings * folders/{folder}/securityHealthAnalyticsSettings * projects/{project}/securityHealthAnalyticsSettings", + "description": "Identifier. The resource name of the SecurityHealthAnalyticsSettings. Formats: * organizations/{organization}/securityHealthAnalyticsSettings * folders/{folder}/securityHealthAnalyticsSettings * projects/{project}/securityHealthAnalyticsSettings", "location": "path", "pattern": "^projects/[^/]+/securityHealthAnalyticsSettings$", "required": true, @@ -1571,7 +1571,7 @@ ], "parameters": { "name": { - "description": "The resource name of the VirtualMachineThreatDetectionSettings. Formats: * organizations/{organization}/virtualMachineThreatDetectionSettings * folders/{folder}/virtualMachineThreatDetectionSettings * projects/{project}/virtualMachineThreatDetectionSettings", + "description": "Identifier. The resource name of the VirtualMachineThreatDetectionSettings. Formats: * organizations/{organization}/virtualMachineThreatDetectionSettings * folders/{folder}/virtualMachineThreatDetectionSettings * projects/{project}/virtualMachineThreatDetectionSettings", "location": "path", "pattern": "^projects/[^/]+/virtualMachineThreatDetectionSettings$", "required": true, @@ -1605,7 +1605,7 @@ ], "parameters": { "name": { - "description": "The resource name of the WebSecurityScannerSettings. Formats: * organizations/{organization}/webSecurityScannerSettings * folders/{folder}/webSecurityScannerSettings * projects/{project}/webSecurityScannerSettings", + "description": "Identifier. The resource name of the WebSecurityScannerSettings. Formats: * organizations/{organization}/webSecurityScannerSettings * folders/{folder}/webSecurityScannerSettings * projects/{project}/webSecurityScannerSettings", "location": "path", "pattern": "^projects/[^/]+/webSecurityScannerSettings$", "required": true, @@ -1728,7 +1728,7 @@ ], "parameters": { "name": { - "description": "The resource name of the ContainerThreatDetectionSettings. Formats: * organizations/{organization}/containerThreatDetectionSettings * folders/{folder}/containerThreatDetectionSettings * projects/{project}/containerThreatDetectionSettings * projects/{project}/locations/{location}/clusters/{cluster}/containerThreatDetectionSettings", + "description": "Identifier. The resource name of the ContainerThreatDetectionSettings. Formats: * organizations/{organization}/containerThreatDetectionSettings * folders/{folder}/containerThreatDetectionSettings * projects/{project}/containerThreatDetectionSettings * projects/{project}/locations/{location}/clusters/{cluster}/containerThreatDetectionSettings", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+/containerThreatDetectionSettings$", "required": true, @@ -1906,7 +1906,7 @@ } } }, - "revision": "20240622", + "revision": "20240712", "rootUrl": "https://securitycenter.googleapis.com/", "schemas": { "Access": { @@ -2051,7 +2051,7 @@ "id": "AttackExposure", "properties": { "attackExposureResult": { - "description": "The resource name of the attack path simulation result that contains the details regarding this attack exposure score. Example: organizations/123/simulations/456/attackExposureResults/789", + "description": "The resource name of the attack path simulation result that contains the details regarding this attack exposure score. Example: `organizations/123/simulations/456/attackExposureResults/789`", "type": "string" }, "exposedHighValueResourcesCount": { @@ -2168,7 +2168,7 @@ "type": "string" }, "id": { - "description": "The UUID of the Azure management group, for example, \"20000000-0001-0000-0000-000000000000\".", + "description": "The UUID of the Azure management group, for example, `20000000-0001-0000-0000-000000000000`.", "type": "string" } }, @@ -2216,7 +2216,7 @@ "type": "string" }, "id": { - "description": "The UUID of the Azure subscription, for example, \"291bba3f-e0a5-47bc-a099-3bdcb2a50a05\".", + "description": "The UUID of the Azure subscription, for example, `291bba3f-e0a5-47bc-a099-3bdcb2a50a05`.", "type": "string" } }, @@ -2599,11 +2599,11 @@ "additionalProperties": { "$ref": "Config" }, - "description": "The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's.", + "description": "The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration.", "type": "object" }, "name": { - "description": "The resource name of the ContainerThreatDetectionSettings. Formats: * organizations/{organization}/containerThreatDetectionSettings * folders/{folder}/containerThreatDetectionSettings * projects/{project}/containerThreatDetectionSettings * projects/{project}/locations/{location}/clusters/{cluster}/containerThreatDetectionSettings", + "description": "Identifier. The resource name of the ContainerThreatDetectionSettings. Formats: * organizations/{organization}/containerThreatDetectionSettings * folders/{folder}/containerThreatDetectionSettings * projects/{project}/containerThreatDetectionSettings * projects/{project}/locations/{location}/clusters/{cluster}/containerThreatDetectionSettings", "type": "string" }, "serviceAccount": { @@ -2969,11 +2969,11 @@ "additionalProperties": { "$ref": "Config" }, - "description": "The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's.", + "description": "The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration.", "type": "object" }, "name": { - "description": "The resource name of the EventThreatDetectionSettings. Formats: * organizations/{organization}/eventThreatDetectionSettings * folders/{folder}/eventThreatDetectionSettings * projects/{project}/eventThreatDetectionSettings", + "description": "Identifier. The resource name of the EventThreatDetectionSettings. Formats: * organizations/{organization}/eventThreatDetectionSettings * folders/{folder}/eventThreatDetectionSettings * projects/{project}/eventThreatDetectionSettings", "type": "string" }, "serviceEnablementState": { @@ -3732,7 +3732,7 @@ "type": "string" }, "name": { - "description": "This field will be ignored if provided on config creation. Format \"organizations/{organization}/muteConfigs/{mute_config}\" \"folders/{folder}/muteConfigs/{mute_config}\" \"projects/{project}/muteConfigs/{mute_config}\" \"organizations/{organization}/locations/global/muteConfigs/{mute_config}\" \"folders/{folder}/locations/global/muteConfigs/{mute_config}\" \"projects/{project}/locations/global/muteConfigs/{mute_config}\"", + "description": "This field will be ignored if provided on config creation. Format `organizations/{organization}/muteConfigs/{mute_config}` `folders/{folder}/muteConfigs/{mute_config}` `projects/{project}/muteConfigs/{mute_config}` `organizations/{organization}/locations/global/muteConfigs/{mute_config}` `folders/{folder}/locations/global/muteConfigs/{mute_config}` `projects/{project}/locations/global/muteConfigs/{mute_config}`", "type": "string" }, "updateTime": { @@ -3851,7 +3851,7 @@ "description": "Provides the path to the resource within the resource hierarchy." }, "resourcePathString": { - "description": "A string representation of the resource path. For Google Cloud, it has the format of organizations/{organization_id}/folders/{folder_id}/folders/{folder_id}/projects/{project_id} where there can be any number of folders. For AWS, it has the format of org/{organization_id}/ou/{organizational_unit_id}/ou/{organizational_unit_id}/account/{account_id} where there can be any number of organizational units. For Azure, it has the format of mg/{management_group_id}/mg/{management_group_id}/subscription/{subscription_id}/rg/{resource_group_name} where there can be any number of management groups.", + "description": "A string representation of the resource path. For Google Cloud, it has the format of `organizations/{organization_id}/folders/{folder_id}/folders/{folder_id}/projects/{project_id}` where there can be any number of folders. For AWS, it has the format of `org/{organization_id}/ou/{organizational_unit_id}/ou/{organizational_unit_id}/account/{account_id}` where there can be any number of organizational units. For Azure, it has the format of `mg/{management_group_id}/mg/{management_group_id}/subscription/{subscription_id}/rg/{resource_group_name}` where there can be any number of management groups.", "type": "string" }, "service": { @@ -3917,11 +3917,11 @@ "additionalProperties": { "type": "string" }, - "description": "List of resource labels to search for, evaluated with AND. For example, \"resource_labels_selector\": {\"key\": \"value\", \"env\": \"prod\"} will match resources with labels \"key\": \"value\" AND \"env\": \"prod\" https://cloud.google.com/resource-manager/docs/creating-managing-labels", + "description": "List of resource labels to search for, evaluated with `AND`. For example, `\"resource_labels_selector\": {\"key\": \"value\", \"env\": \"prod\"}` will match resources with labels \"key\": \"value\" `AND` \"env\": \"prod\" https://cloud.google.com/resource-manager/docs/creating-managing-labels", "type": "object" }, "resourceType": { - "description": "Apply resource_value only to resources that match resource_type. resource_type will be checked with AND of other resources. For example, \"storage.googleapis.com/Bucket\" with resource_value \"HIGH\" will apply \"HIGH\" value only to \"storage.googleapis.com/Bucket\" resources.", + "description": "Apply resource_value only to resources that match resource_type. resource_type will be checked with `AND` of other resources. For example, \"storage.googleapis.com/Bucket\" with resource_value \"HIGH\" will apply \"HIGH\" value only to \"storage.googleapis.com/Bucket\" resources.", "type": "string" }, "resourceValue": { @@ -3943,7 +3943,7 @@ "type": "string" }, "scope": { - "description": "Project or folder to scope this configuration to. For example, \"project/456\" would apply this configuration only to resources in \"project/456\" scope will be checked with AND of other resources.", + "description": "Project or folder to scope this configuration to. For example, \"project/456\" would apply this configuration only to resources in \"project/456\" scope will be checked with `AND` of other resources.", "type": "string" }, "sensitiveDataProtectionMapping": { @@ -3951,7 +3951,7 @@ "description": "A mapping of the sensitivity on Sensitive Data Protection finding to resource values. This mapping can only be used in combination with a resource_type that is related to BigQuery, e.g. \"bigquery.googleapis.com/Dataset\"." }, "tagValues": { - "description": "Required. Tag values combined with AND to check against. Values in the form \"tagValues/123\" Example: [ \"tagValues/123\", \"tagValues/456\", \"tagValues/789\" ] https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing", + "description": "Required. Tag values combined with `AND` to check against. Values in the form \"tagValues/123\" Example: `[ \"tagValues/123\", \"tagValues/456\", \"tagValues/789\" ]` https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing", "items": { "type": "string" }, @@ -4462,7 +4462,7 @@ "id": "GoogleCloudSecuritycenterV2AttackExposure", "properties": { "attackExposureResult": { - "description": "The resource name of the attack path simulation result that contains the details regarding this attack exposure score. Example: organizations/123/simulations/456/attackExposureResults/789", + "description": "The resource name of the attack path simulation result that contains the details regarding this attack exposure score. Example: `organizations/123/simulations/456/attackExposureResults/789`", "type": "string" }, "exposedHighValueResourcesCount": { @@ -4580,7 +4580,7 @@ "type": "string" }, "id": { - "description": "The UUID of the Azure management group, for example, \"20000000-0001-0000-0000-000000000000\".", + "description": "The UUID of the Azure management group, for example, `20000000-0001-0000-0000-000000000000`.", "type": "string" } }, @@ -4628,7 +4628,7 @@ "type": "string" }, "id": { - "description": "The UUID of the Azure subscription, for example, \"291bba3f-e0a5-47bc-a099-3bdcb2a50a05\".", + "description": "The UUID of the Azure subscription, for example, `291bba3f-e0a5-47bc-a099-3bdcb2a50a05`.", "type": "string" } }, @@ -4702,7 +4702,7 @@ "type": "string" }, "dataset": { - "description": "The dataset to write findings' updates to. Its format is \"projects/[project_id]/datasets/[bigquery_dataset_id]\". BigQuery Dataset unique ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_).", + "description": "The dataset to write findings' updates to. Its format is \"projects/[project_id]/datasets/[bigquery_dataset_id]\". BigQuery dataset unique ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_).", "type": "string" }, "description": { @@ -4719,7 +4719,7 @@ "type": "string" }, "name": { - "description": "The relative resource name of this export. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name. The following list shows some examples: + `organizations/{organization_id}/locations/{location_id}/bigQueryExports/{export_id}` + `folders/{folder_id}/locations/{location_id}/bigQueryExports/{export_id}` + `projects/{project_id}/locations/{location_id}/bigQueryExports/{export_id}` This field is provided in responses, and is ignored when provided in create requests.", + "description": "Identifier. The relative resource name of this export. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name. The following list shows some examples: + `organizations/{organization_id}/locations/{location_id}/bigQueryExports/{export_id}` + `folders/{folder_id}/locations/{location_id}/bigQueryExports/{export_id}` + `projects/{project_id}/locations/{location_id}/bigQueryExports/{export_id}` This field is provided in responses, and is ignored when provided in create requests.", "type": "string" }, "principal": { @@ -6058,8 +6058,10 @@ "COMMAND_AND_SCRIPTING_INTERPRETER", "UNIX_SHELL", "PYTHON", + "EXPLOITATION_FOR_PRIVILEGE_ESCALATION", "PERMISSION_GROUPS_DISCOVERY", "CLOUD_GROUPS", + "INDICATOR_REMOVAL_FILE_DELETION", "APPLICATION_LAYER_PROTOCOL", "DNS", "SOFTWARE_DEPLOYMENT_TOOLS", @@ -6123,8 +6125,10 @@ "T1059", "T1059.004", "T1059.006", + "T1068", "T1069", "T1069.003", + "T1070.004", "T1071", "T1071.004", "T1072", @@ -6172,7 +6176,7 @@ "T1588", "T1595", "T1595.001", - "T1613", + "T1609", "T1611", "T1613", "T1649" @@ -6233,8 +6237,10 @@ "COMMAND_AND_SCRIPTING_INTERPRETER", "UNIX_SHELL", "PYTHON", + "EXPLOITATION_FOR_PRIVILEGE_ESCALATION", "PERMISSION_GROUPS_DISCOVERY", "CLOUD_GROUPS", + "INDICATOR_REMOVAL_FILE_DELETION", "APPLICATION_LAYER_PROTOCOL", "DNS", "SOFTWARE_DEPLOYMENT_TOOLS", @@ -6298,8 +6304,10 @@ "T1059", "T1059.004", "T1059.006", + "T1068", "T1069", "T1069.003", + "T1070.004", "T1071", "T1071.004", "T1072", @@ -6347,7 +6355,7 @@ "T1588", "T1595", "T1595.001", - "T1613", + "T1609", "T1611", "T1613", "T1649" @@ -6387,7 +6395,7 @@ "type": "string" }, "name": { - "description": "This field will be ignored if provided on config creation. The following list shows some examples of the format: + `organizations/{organization}/muteConfigs/{mute_config}` + `organizations/{organization}locations/{location}//muteConfigs/{mute_config}` + `folders/{folder}/muteConfigs/{mute_config}` + `folders/{folder}/locations/{location}/muteConfigs/{mute_config}` + `projects/{project}/muteConfigs/{mute_config}` + `projects/{project}/locations/{location}/muteConfigs/{mute_config}`", + "description": "Identifier. This field will be ignored if provided on config creation. The following list shows some examples of the format: + `organizations/{organization}/muteConfigs/{mute_config}` + `organizations/{organization}locations/{location}//muteConfigs/{mute_config}` + `folders/{folder}/muteConfigs/{mute_config}` + `folders/{folder}/locations/{location}/muteConfigs/{mute_config}` + `projects/{project}/muteConfigs/{mute_config}` + `projects/{project}/locations/{location}/muteConfigs/{mute_config}`", "type": "string" }, "type": { @@ -6773,7 +6781,7 @@ "description": "Provides the path to the resource within the resource hierarchy." }, "resourcePathString": { - "description": "A string representation of the resource path. For Google Cloud, it has the format of organizations/{organization_id}/folders/{folder_id}/folders/{folder_id}/projects/{project_id} where there can be any number of folders. For AWS, it has the format of org/{organization_id}/ou/{organizational_unit_id}/ou/{organizational_unit_id}/account/{account_id} where there can be any number of organizational units. For Azure, it has the format of mg/{management_group_id}/mg/{management_group_id}/subscription/{subscription_id}/rg/{resource_group_name} where there can be any number of management groups.", + "description": "A string representation of the resource path. For Google Cloud, it has the format of `organizations/{organization_id}/folders/{folder_id}/folders/{folder_id}/projects/{project_id}` where there can be any number of folders. For AWS, it has the format of `org/{organization_id}/ou/{organizational_unit_id}/ou/{organizational_unit_id}/account/{account_id}` where there can be any number of organizational units. For Azure, it has the format of `mg/{management_group_id}/mg/{management_group_id}/subscription/{subscription_id}/rg/{resource_group_name}` where there can be any number of management groups.", "type": "string" }, "service": { @@ -6875,22 +6883,22 @@ "type": "string" }, "name": { - "description": "Name for the resource value configuration", + "description": "Identifier. Name for the resource value configuration", "type": "string" }, "resourceLabelsSelector": { "additionalProperties": { "type": "string" }, - "description": "List of resource labels to search for, evaluated with AND. For example, \"resource_labels_selector\": {\"key\": \"value\", \"env\": \"prod\"} will match resources with labels \"key\": \"value\" AND \"env\": \"prod\" https://cloud.google.com/resource-manager/docs/creating-managing-labels", + "description": "List of resource labels to search for, evaluated with `AND`. For example, \"resource_labels_selector\": {\"key\": \"value\", \"env\": \"prod\"} will match resources with labels \"key\": \"value\" `AND` \"env\": \"prod\" https://cloud.google.com/resource-manager/docs/creating-managing-labels", "type": "object" }, "resourceType": { - "description": "Apply resource_value only to resources that match resource_type. resource_type will be checked with AND of other resources. For example, \"storage.googleapis.com/Bucket\" with resource_value \"HIGH\" will apply \"HIGH\" value only to \"storage.googleapis.com/Bucket\" resources.", + "description": "Apply resource_value only to resources that match resource_type. resource_type will be checked with `AND` of other resources. For example, \"storage.googleapis.com/Bucket\" with resource_value \"HIGH\" will apply \"HIGH\" value only to \"storage.googleapis.com/Bucket\" resources.", "type": "string" }, "resourceValue": { - "description": "Resource value level this expression represents Only required when there is no SDP mapping in the request", + "description": "Resource value level this expression represents Only required when there is no Sensitive Data Protection mapping in the request", "enum": [ "RESOURCE_VALUE_UNSPECIFIED", "HIGH", @@ -6908,7 +6916,7 @@ "type": "string" }, "scope": { - "description": "Project or folder to scope this configuration to. For example, \"project/456\" would apply this configuration only to resources in \"project/456\" scope will be checked with AND of other resources.", + "description": "Project or folder to scope this configuration to. For example, \"project/456\" would apply this configuration only to resources in \"project/456\" scope and will be checked with `AND` of other resources.", "type": "string" }, "sensitiveDataProtectionMapping": { @@ -6916,7 +6924,7 @@ "description": "A mapping of the sensitivity on Sensitive Data Protection finding to resource values. This mapping can only be used in combination with a resource_type that is related to BigQuery, e.g. \"bigquery.googleapis.com/Dataset\"." }, "tagValues": { - "description": "Required. Tag values combined with AND to check against. Values in the form \"tagValues/123\" Example: [ \"tagValues/123\", \"tagValues/456\", \"tagValues/789\" ] https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing", + "description": "Tag values combined with `AND` to check against. Values in the form \"tagValues/123\" Example: `[ \"tagValues/123\", \"tagValues/456\", \"tagValues/789\" ]` https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing", "items": { "type": "string" }, @@ -7194,7 +7202,7 @@ "type": "number" }, "relatedFindings": { - "description": "List of resource names of findings associated with this toxic combination. For example, organizations/123/sources/456/findings/789.", + "description": "List of resource names of findings associated with this toxic combination. For example, `organizations/123/sources/456/findings/789`.", "items": { "type": "string" }, @@ -7537,8 +7545,10 @@ "COMMAND_AND_SCRIPTING_INTERPRETER", "UNIX_SHELL", "PYTHON", + "EXPLOITATION_FOR_PRIVILEGE_ESCALATION", "PERMISSION_GROUPS_DISCOVERY", "CLOUD_GROUPS", + "INDICATOR_REMOVAL_FILE_DELETION", "APPLICATION_LAYER_PROTOCOL", "DNS", "SOFTWARE_DEPLOYMENT_TOOLS", @@ -7602,8 +7612,10 @@ "T1059", "T1059.004", "T1059.006", + "T1068", "T1069", "T1069.003", + "T1070.004", "T1071", "T1071.004", "T1072", @@ -7712,8 +7724,10 @@ "COMMAND_AND_SCRIPTING_INTERPRETER", "UNIX_SHELL", "PYTHON", + "EXPLOITATION_FOR_PRIVILEGE_ESCALATION", "PERMISSION_GROUPS_DISCOVERY", "CLOUD_GROUPS", + "INDICATOR_REMOVAL_FILE_DELETION", "APPLICATION_LAYER_PROTOCOL", "DNS", "SOFTWARE_DEPLOYMENT_TOOLS", @@ -7777,8 +7791,10 @@ "T1059", "T1059.004", "T1059.006", + "T1068", "T1069", "T1069.003", + "T1070.004", "T1071", "T1071.004", "T1072", @@ -8316,11 +8332,11 @@ "additionalProperties": { "$ref": "Config" }, - "description": "The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's.", + "description": "The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration.", "type": "object" }, "name": { - "description": "The resource name of the SecurityHealthAnalyticsSettings. Formats: * organizations/{organization}/securityHealthAnalyticsSettings * folders/{folder}/securityHealthAnalyticsSettings * projects/{project}/securityHealthAnalyticsSettings", + "description": "Identifier. The resource name of the SecurityHealthAnalyticsSettings. Formats: * organizations/{organization}/securityHealthAnalyticsSettings * folders/{folder}/securityHealthAnalyticsSettings * projects/{project}/securityHealthAnalyticsSettings", "type": "string" }, "serviceAccount": { @@ -8557,7 +8573,7 @@ "type": "number" }, "relatedFindings": { - "description": "List of resource names of findings associated with this toxic combination. For example, organizations/123/sources/456/findings/789.", + "description": "List of resource names of findings associated with this toxic combination. For example, `organizations/123/sources/456/findings/789`.", "items": { "type": "string" }, @@ -8574,11 +8590,11 @@ "additionalProperties": { "$ref": "Config" }, - "description": "The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's.", + "description": "The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration.", "type": "object" }, "name": { - "description": "The resource name of the VirtualMachineThreatDetectionSettings. Formats: * organizations/{organization}/virtualMachineThreatDetectionSettings * folders/{folder}/virtualMachineThreatDetectionSettings * projects/{project}/virtualMachineThreatDetectionSettings", + "description": "Identifier. The resource name of the VirtualMachineThreatDetectionSettings. Formats: * organizations/{organization}/virtualMachineThreatDetectionSettings * folders/{folder}/virtualMachineThreatDetectionSettings * projects/{project}/virtualMachineThreatDetectionSettings", "type": "string" }, "serviceAccount": { @@ -8693,11 +8709,11 @@ "additionalProperties": { "$ref": "Config" }, - "description": "The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's.", + "description": "The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration.", "type": "object" }, "name": { - "description": "The resource name of the WebSecurityScannerSettings. Formats: * organizations/{organization}/webSecurityScannerSettings * folders/{folder}/webSecurityScannerSettings * projects/{project}/webSecurityScannerSettings", + "description": "Identifier. The resource name of the WebSecurityScannerSettings. Formats: * organizations/{organization}/webSecurityScannerSettings * folders/{folder}/webSecurityScannerSettings * projects/{project}/webSecurityScannerSettings", "type": "string" }, "serviceEnablementState": { diff --git a/discovery/serviceconsumermanagement-v1.json b/discovery/serviceconsumermanagement-v1.json index 152879431f..183b086949 100644 --- a/discovery/serviceconsumermanagement-v1.json +++ b/discovery/serviceconsumermanagement-v1.json @@ -542,7 +542,7 @@ } } }, - "revision": "20240623", + "revision": "20240707", "rootUrl": "https://serviceconsumermanagement.googleapis.com/", "schemas": { "AddTenantProjectRequest": { @@ -1126,7 +1126,7 @@ "type": "object" }, "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.", + "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: > ... code_snippet_rules: - selector: google.calendar.Calendar.Delete code_snippets: - includes: - github_include: region_tag: calendar_delete code_language: JAVA account: GoogleCloudPlatform project: java-docs-samples file: calendar/delete.java 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", "properties": { "documentationRootUrl": { diff --git a/discovery/serviceconsumermanagement-v1beta1.json b/discovery/serviceconsumermanagement-v1beta1.json index 85aea90165..e2dd27179f 100644 --- a/discovery/serviceconsumermanagement-v1beta1.json +++ b/discovery/serviceconsumermanagement-v1beta1.json @@ -715,7 +715,7 @@ } } }, - "revision": "20240623", + "revision": "20240707", "rootUrl": "https://serviceconsumermanagement.googleapis.com/", "schemas": { "Api": { @@ -1211,7 +1211,7 @@ "type": "object" }, "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.", + "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: > ... code_snippet_rules: - selector: google.calendar.Calendar.Delete code_snippets: - includes: - github_include: region_tag: calendar_delete code_language: JAVA account: GoogleCloudPlatform project: java-docs-samples file: calendar/delete.java 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", "properties": { "documentationRootUrl": { diff --git a/discovery/servicemanagement-v1.json b/discovery/servicemanagement-v1.json index efefee8aa0..30057210ae 100644 --- a/discovery/servicemanagement-v1.json +++ b/discovery/servicemanagement-v1.json @@ -830,7 +830,7 @@ } } }, - "revision": "20240531", + "revision": "20240705", "rootUrl": "https://servicemanagement.googleapis.com/", "schemas": { "Advice": { @@ -1561,7 +1561,7 @@ "type": "object" }, "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.", + "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: > ... code_snippet_rules: - selector: google.calendar.Calendar.Delete code_snippets: - includes: - github_include: region_tag: calendar_delete code_language: JAVA account: GoogleCloudPlatform project: java-docs-samples file: calendar/delete.java 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", "properties": { "documentationRootUrl": { diff --git a/discovery/servicenetworking-v1.json b/discovery/servicenetworking-v1.json index 7491df43d9..34089b65d9 100644 --- a/discovery/servicenetworking-v1.json +++ b/discovery/servicenetworking-v1.json @@ -1029,7 +1029,7 @@ } } }, - "revision": "20240626", + "revision": "20240715", "rootUrl": "https://servicenetworking.googleapis.com/", "schemas": { "AddDnsRecordSetMetadata": { @@ -1765,14 +1765,14 @@ "type": "array" }, "provided": { - "description": "A list of full type names of provided contexts.", + "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": { - "description": "A list of full type names of requested contexts.", + "description": "A list of full type names of requested contexts, only the requested context will be made available to the backend.", "items": { "type": "string" }, @@ -1957,7 +1957,7 @@ "type": "object" }, "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: > ... code_snippet_rules: - selector: google.calendar.Calendar.Delete code_snippets: - includes: - github_include: region_tag: calendar_delete code_language: JAVA account: GoogleCloudPlatform project: java-docs-samples file: calendar/delete.java 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.", + "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", "properties": { "documentationRootUrl": { @@ -2421,7 +2421,7 @@ "type": "object" }, "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. Example below selects a gRPC method and applies 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.", + "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": { "additionalBindings": { diff --git a/discovery/servicenetworking-v1beta.json b/discovery/servicenetworking-v1beta.json index edfdf0293d..69832e895b 100644 --- a/discovery/servicenetworking-v1beta.json +++ b/discovery/servicenetworking-v1beta.json @@ -307,7 +307,7 @@ } } }, - "revision": "20240626", + "revision": "20240715", "rootUrl": "https://servicenetworking.googleapis.com/", "schemas": { "AddDnsRecordSetMetadata": { @@ -918,14 +918,14 @@ "type": "array" }, "provided": { - "description": "A list of full type names of provided contexts.", + "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": { - "description": "A list of full type names of requested contexts.", + "description": "A list of full type names of requested contexts, only the requested context will be made available to the backend.", "items": { "type": "string" }, @@ -1073,7 +1073,7 @@ "type": "object" }, "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: > ... code_snippet_rules: - selector: google.calendar.Calendar.Delete code_snippets: - includes: - github_include: region_tag: calendar_delete code_language: JAVA account: GoogleCloudPlatform project: java-docs-samples file: calendar/delete.java 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.", + "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", "properties": { "documentationRootUrl": { @@ -1505,7 +1505,7 @@ "type": "object" }, "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. Example below selects a gRPC method and applies 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.", + "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": { "additionalBindings": { diff --git a/discovery/serviceusage-v1.json b/discovery/serviceusage-v1.json index 99b819e396..14d77c7887 100644 --- a/discovery/serviceusage-v1.json +++ b/discovery/serviceusage-v1.json @@ -426,7 +426,7 @@ } } }, - "revision": "20240623", + "revision": "20240712", "rootUrl": "https://serviceusage.googleapis.com/", "schemas": { "AddEnableRulesMetadata": { @@ -998,14 +998,14 @@ "type": "array" }, "provided": { - "description": "A list of full type names of provided contexts.", + "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": { - "description": "A list of full type names of requested contexts.", + "description": "A list of full type names of requested contexts, only the requested context will be made available to the backend.", "items": { "type": "string" }, @@ -1971,7 +1971,7 @@ "type": "object" }, "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. Example below selects a gRPC method and applies 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.", + "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": { "additionalBindings": { diff --git a/discovery/serviceusage-v1beta1.json b/discovery/serviceusage-v1beta1.json index 6a2282f59c..1dd8888f0f 100644 --- a/discovery/serviceusage-v1beta1.json +++ b/discovery/serviceusage-v1beta1.json @@ -964,7 +964,7 @@ } } }, - "revision": "20240623", + "revision": "20240712", "rootUrl": "https://serviceusage.googleapis.com/", "schemas": { "AddEnableRulesMetadata": { @@ -1594,14 +1594,14 @@ "type": "array" }, "provided": { - "description": "A list of full type names of provided contexts.", + "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": { - "description": "A list of full type names of requested contexts.", + "description": "A list of full type names of requested contexts, only the requested context will be made available to the backend.", "items": { "type": "string" }, @@ -2548,7 +2548,7 @@ "type": "object" }, "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. Example below selects a gRPC method and applies 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.", + "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": { "additionalBindings": { diff --git a/discovery/sheets-v4.json b/discovery/sheets-v4.json index b506cf5b4f..933d7ad25f 100644 --- a/discovery/sheets-v4.json +++ b/discovery/sheets-v4.json @@ -870,7 +870,7 @@ } } }, - "revision": "20240521", + "revision": "20240712", "rootUrl": "https://sheets.googleapis.com/", "schemas": { "AddBandingRequest": { @@ -934,7 +934,7 @@ "type": "object" }, "AddDataSourceRequest": { - "description": "Adds a data source. After the data source is added successfully, an associated DATA_SOURCE sheet is created and an execution is triggered to refresh the sheet to read data from the data source. The request requires an additional `bigquery.readonly` OAuth scope.", + "description": "Adds a data source. After the data source is added successfully, an associated DATA_SOURCE sheet is created and an execution is triggered to refresh the sheet to read data from the data source. The request requires an additional `bigquery.readonly` OAuth scope if you are adding a BigQuery data source.", "id": "AddDataSourceRequest", "properties": { "dataSource": { @@ -2330,7 +2330,7 @@ "type": "object" }, "CancelDataSourceRefreshRequest": { - "description": "Cancels one or multiple refreshes of data source objects in the spreadsheet by the specified references.", + "description": "Cancels one or multiple refreshes of data source objects in the spreadsheet by the specified references. The request requires an additional `bigquery.readonly` OAuth scope if you are cancelling a refresh on a BigQuery data source.", "id": "CancelDataSourceRefreshRequest", "properties": { "dataSourceId": { @@ -5960,7 +5960,7 @@ "type": "object" }, "RefreshDataSourceRequest": { - "description": "Refreshes one or multiple data source objects in the spreadsheet by the specified references. The request requires an additional `bigquery.readonly` OAuth scope. If there are multiple refresh requests referencing the same data source objects in one batch, only the last refresh request is processed, and all those requests will have the same response accordingly.", + "description": "Refreshes one or multiple data source objects in the spreadsheet by the specified references. The request requires an additional `bigquery.readonly` OAuth scope if you are refreshing a BigQuery data source. If there are multiple refresh requests referencing the same data source objects in one batch, only the last refresh request is processed, and all those requests will have the same response accordingly.", "id": "RefreshDataSourceRequest", "properties": { "dataSourceId": { @@ -7468,7 +7468,7 @@ "type": "object" }, "UpdateDataSourceRequest": { - "description": "Updates a data source. After the data source is updated successfully, an execution is triggered to refresh the associated DATA_SOURCE sheet to read data from the updated data source. The request requires an additional `bigquery.readonly` OAuth scope.", + "description": "Updates a data source. After the data source is updated successfully, an execution is triggered to refresh the associated DATA_SOURCE sheet to read data from the updated data source. The request requires an additional `bigquery.readonly` OAuth scope if you are updating a BigQuery data source.", "id": "UpdateDataSourceRequest", "properties": { "dataSource": { diff --git a/discovery/spanner-v1.json b/discovery/spanner-v1.json index ee57f051e2..cf0172f9aa 100644 --- a/discovery/spanner-v1.json +++ b/discovery/spanner-v1.json @@ -123,7 +123,7 @@ "instanceConfigOperations": { "methods": { "list": { - "description": "Lists the user-managed instance config long-running operations in the given project. An instance config operation has a name of the form `projects//instanceConfigs//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.", + "description": "Lists the user-managed instance configuration long-running operations in the given project. An instance configuration operation has a name of the form `projects//instanceConfigs//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.", "flatPath": "v1/projects/{projectsId}/instanceConfigOperations", "httpMethod": "GET", "id": "spanner.projects.instanceConfigOperations.list", @@ -132,7 +132,7 @@ ], "parameters": { "filter": { - "description": "An expression that filters the list of returned operations. 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 one of: `<`, `>`, `<=`, `>=`, `!=`, `=`, or `:`. Colon `:` is the contains operator. Filter rules are not case sensitive. The following fields in the Operation are eligible for filtering: * `name` - The name of the long-running operation * `done` - False if the operation is in progress, else true. * `metadata.@type` - the type of metadata. For example, the type string for CreateInstanceConfigMetadata is `type.googleapis.com/google.spanner.admin.instance.v1.CreateInstanceConfigMetadata`. * `metadata.` - any field in metadata.value. `metadata.@type` must be specified first, if filtering on metadata fields. * `error` - Error associated with the long-running operation. * `response.@type` - the type of response. * `response.` - any field in response.value. You can combine multiple expressions by enclosing each expression in parentheses. By default, expressions are combined with AND logic. However, you can specify AND, OR, and NOT logic explicitly. Here are a few examples: * `done:true` - The operation is complete. * `(metadata.@type=` \\ `type.googleapis.com/google.spanner.admin.instance.v1.CreateInstanceConfigMetadata) AND` \\ `(metadata.instance_config.name:custom-config) AND` \\ `(metadata.progress.start_time < \\\"2021-03-28T14:50:00Z\\\") AND` \\ `(error:*)` - Return operations where: * The operation's metadata type is CreateInstanceConfigMetadata. * The instance config name contains \"custom-config\". * The operation started before 2021-03-28T14:50:00Z. * The operation resulted in an error.", + "description": "An expression that filters the list of returned operations. 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 one of: `<`, `>`, `<=`, `>=`, `!=`, `=`, or `:`. Colon `:` is the contains operator. Filter rules are not case sensitive. The following fields in the Operation are eligible for filtering: * `name` - The name of the long-running operation * `done` - False if the operation is in progress, else true. * `metadata.@type` - the type of metadata. For example, the type string for CreateInstanceConfigMetadata is `type.googleapis.com/google.spanner.admin.instance.v1.CreateInstanceConfigMetadata`. * `metadata.` - any field in metadata.value. `metadata.@type` must be specified first, if filtering on metadata fields. * `error` - Error associated with the long-running operation. * `response.@type` - the type of response. * `response.` - any field in response.value. You can combine multiple expressions by enclosing each expression in parentheses. By default, expressions are combined with AND logic. However, you can specify AND, OR, and NOT logic explicitly. Here are a few examples: * `done:true` - The operation is complete. * `(metadata.@type=` \\ `type.googleapis.com/google.spanner.admin.instance.v1.CreateInstanceConfigMetadata) AND` \\ `(metadata.instance_config.name:custom-config) AND` \\ `(metadata.progress.start_time < \\\"2021-03-28T14:50:00Z\\\") AND` \\ `(error:*)` - Return operations where: * The operation's metadata type is CreateInstanceConfigMetadata. * The instance configuration name contains \"custom-config\". * The operation started before 2021-03-28T14:50:00Z. * The operation resulted in an error.", "location": "query", "type": "string" }, @@ -148,7 +148,7 @@ "type": "string" }, "parent": { - "description": "Required. The project of the instance config operations. Values are of the form `projects/`.", + "description": "Required. The project of the instance configuration operations. Values are of the form `projects/`.", "location": "path", "pattern": "^projects/[^/]+$", "required": true, @@ -169,7 +169,7 @@ "instanceConfigs": { "methods": { "create": { - "description": "Creates an instance config and begins preparing it to be used. The returned long-running operation can be used to track the progress of preparing the new instance config. The instance config name is assigned by the caller. If the named instance config already exists, `CreateInstanceConfig` returns `ALREADY_EXISTS`. Immediately after the request returns: * The instance config is readable via the API, with all requested attributes. The instance config's reconciling field is set to true. Its state is `CREATING`. While the operation is pending: * Cancelling the operation renders the instance config immediately unreadable via the API. * Except for deleting the creating resource, all other attempts to modify the instance config are rejected. Upon completion of the returned operation: * Instances can be created using the instance configuration. * The instance config's reconciling field becomes false. Its 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 config. The metadata field type is CreateInstanceConfigMetadata. The response field type is InstanceConfig, if successful. Authorization requires `spanner.instanceConfigs.create` permission on the resource parent.", + "description": "Creates an instance configuration and begins preparing it to be used. The returned long-running operation can be used to track the progress of preparing the new instance config. The instance configuration name is assigned by the caller. If the named instance configuration already exists, `CreateInstanceConfig` returns `ALREADY_EXISTS`. Immediately after the request returns: * The instance configuration is readable via the API, with all requested attributes. The instance config's reconciling field is set to true. Its state is `CREATING`. While the operation is pending: * Cancelling the operation renders the instance configuration immediately unreadable via the API. * Except for deleting the creating resource, all other attempts to modify the instance configuration are rejected. Upon completion of the returned operation: * Instances can be created using the instance configuration. * The instance config's reconciling field becomes false. Its 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 config. The metadata field type is CreateInstanceConfigMetadata. The response field type is InstanceConfig, if successful. Authorization requires `spanner.instanceConfigs.create` permission on the resource parent.", "flatPath": "v1/projects/{projectsId}/instanceConfigs", "httpMethod": "POST", "id": "spanner.projects.instanceConfigs.create", @@ -198,7 +198,7 @@ ] }, "delete": { - "description": "Deletes the instance config. Deletion is only allowed when no instances are using the configuration. If any instances are using the config, returns `FAILED_PRECONDITION`. Only user managed configurations can be deleted. Authorization requires `spanner.instanceConfigs.delete` permission on the resource name.", + "description": "Deletes the instance config. Deletion is only allowed when no instances are using the configuration. If any instances are using the config, returns `FAILED_PRECONDITION`. Only user-managed configurations can be deleted. Authorization requires `spanner.instanceConfigs.delete` permission on the resource name.", "flatPath": "v1/projects/{projectsId}/instanceConfigs/{instanceConfigsId}", "httpMethod": "DELETE", "id": "spanner.projects.instanceConfigs.delete", @@ -207,7 +207,7 @@ ], "parameters": { "etag": { - "description": "Used for optimistic concurrency control as a way to help prevent simultaneous deletes of an instance config from overwriting each other. If not empty, the API only deletes the instance config when the etag provided matches the current status of the requested instance config. Otherwise, deletes the instance config without checking the current status of the requested instance config.", + "description": "Used for optimistic concurrency control as a way to help prevent simultaneous deletes of an instance configuration from overwriting each other. If not empty, the API only deletes the instance configuration when the etag provided matches the current status of the requested instance config. Otherwise, deletes the instance configuration without checking the current status of the requested instance config.", "location": "query", "type": "string" }, @@ -260,7 +260,7 @@ ] }, "list": { - "description": "Lists the supported instance configurations for a given project. Returns both Google managed configs and user managed configs.", + "description": "Lists the supported instance configurations for a given project. Returns both Google-managed configurations and user-managed configurations.", "flatPath": "v1/projects/{projectsId}/instanceConfigs", "httpMethod": "GET", "id": "spanner.projects.instanceConfigs.list", @@ -297,7 +297,7 @@ ] }, "patch": { - "description": "Updates an instance config. The returned long-running operation can be used to track the progress of updating the instance. If the named instance config does not exist, returns `NOT_FOUND`. Only user managed configurations can be updated. Immediately after the request returns: * The instance config's reconciling field is set to true. While the operation is pending: * Cancelling the operation sets its metadata's cancel_time. The operation is guaranteed to succeed at undoing all changes, after which point it terminates with a `CANCELLED` status. * All other attempts to modify the instance config are rejected. * Reading the instance config via the API continues to give the pre-request values. Upon completion of the returned operation: * Creating instances using the instance configuration uses the new values. * The instance config's new values are readable via the API. * The instance config's reconciling field becomes false. The returned long-running operation will have a name of the format `/operations/` and can be used to track the instance config modification. The metadata field type is UpdateInstanceConfigMetadata. The response field type is InstanceConfig, if successful. Authorization requires `spanner.instanceConfigs.update` permission on the resource name.", + "description": "Updates an instance config. The returned long-running operation can be used to track the progress of updating the instance. If the named instance configuration does not exist, returns `NOT_FOUND`. Only user-managed configurations can be updated. Immediately after the request returns: * The instance config's reconciling field is set to true. While the operation is pending: * Cancelling the operation sets its metadata's cancel_time. The operation is guaranteed to succeed at undoing all changes, after which point it terminates with a `CANCELLED` status. * All other attempts to modify the instance configuration are rejected. * Reading the instance configuration via the API continues to give the pre-request values. Upon completion of the returned operation: * Creating instances using the instance configuration uses the new values. * The instance config's new values are readable via the API. * The instance config's reconciling field becomes false. The returned long-running operation will have a name of the format `/operations/` and can be used to track the instance configuration modification. The metadata field type is UpdateInstanceConfigMetadata. The response field type is InstanceConfig, if successful. Authorization requires `spanner.instanceConfigs.update` permission on the resource name.", "flatPath": "v1/projects/{projectsId}/instanceConfigs/{instanceConfigsId}", "httpMethod": "PATCH", "id": "spanner.projects.instanceConfigs.patch", @@ -306,7 +306,7 @@ ], "parameters": { "name": { - "description": "A unique identifier for the instance configuration. Values are of the form `projects//instanceConfigs/a-z*`. User instance config must start with `custom-`.", + "description": "A unique identifier for the instance configuration. Values are of the form `projects//instanceConfigs/a-z*`. User instance configuration must start with `custom-`.", "location": "path", "pattern": "^projects/[^/]+/instanceConfigs/[^/]+$", "required": true, @@ -748,7 +748,7 @@ ] }, "move": { - "description": "Moves the instance to the target instance config. The returned long-running operation can be used to track the progress of moving the instance. `MoveInstance` returns `FAILED_PRECONDITION` if the instance meets any of the following criteria: * Has an ongoing move to a different instance config * Has backups * Has an ongoing update * Is under free trial * Contains any CMEK-enabled databases While the operation is pending: * All other attempts to modify the instance, including changes to its compute capacity, are rejected. * The following database and backup admin operations are rejected: * DatabaseAdmin.CreateDatabase, * DatabaseAdmin.UpdateDatabaseDdl (Disabled if default_leader is specified in the request.) * DatabaseAdmin.RestoreDatabase * DatabaseAdmin.CreateBackup * DatabaseAdmin.CopyBackup * Both the source and target instance configs are subject to hourly compute and storage charges. * The instance may experience higher read-write latencies and a higher transaction abort rate. However, moving an instance does not cause any downtime. The returned long-running operation will have a name of the format `/operations/` and can be used to track the move instance operation. The metadata field type is MoveInstanceMetadata. The response field type is Instance, if successful. Cancelling the operation sets its metadata's cancel_time. Cancellation is not immediate since it involves moving any data previously moved to target instance config back to the original instance config. The same operation can be used to track the progress of the cancellation. Upon successful completion of the cancellation, the operation terminates with CANCELLED status. Upon completion(if not cancelled) of the returned operation: * Instance would be successfully moved to the target instance config. * You are billed for compute and storage in target instance config. Authorization requires `spanner.instances.update` permission on the resource instance. For more details, please see [documentation](https://cloud.google.com/spanner/docs/move-instance).", + "description": "Moves the instance to the target instance config. The returned long-running operation can be used to track the progress of moving the instance. `MoveInstance` returns `FAILED_PRECONDITION` if the instance meets any of the following criteria: * Has an ongoing move to a different instance config * Has backups * Has an ongoing update * Is under free trial * Contains any CMEK-enabled databases While the operation is pending: * All other attempts to modify the instance, including changes to its compute capacity, are rejected. * The following database and backup admin operations are rejected: * DatabaseAdmin.CreateDatabase, * DatabaseAdmin.UpdateDatabaseDdl (Disabled if default_leader is specified in the request.) * DatabaseAdmin.RestoreDatabase * DatabaseAdmin.CreateBackup * DatabaseAdmin.CopyBackup * Both the source and target instance configurations are subject to hourly compute and storage charges. * The instance may experience higher read-write latencies and a higher transaction abort rate. However, moving an instance does not cause any downtime. The returned long-running operation will have a name of the format `/operations/` and can be used to track the move instance operation. The metadata field type is MoveInstanceMetadata. The response field type is Instance, if successful. Cancelling the operation sets its metadata's cancel_time. Cancellation is not immediate since it involves moving any data previously moved to target instance configuration back to the original instance config. The same operation can be used to track the progress of the cancellation. Upon successful completion of the cancellation, the operation terminates with `CANCELLED` status. Upon completion(if not cancelled) of the returned operation: * Instance would be successfully moved to the target instance config. * You are billed for compute and storage in target instance config. Authorization requires `spanner.instances.update` permission on the resource instance. For more details, please see [documentation](https://cloud.google.com/spanner/docs/move-instance).", "flatPath": "v1/projects/{projectsId}/instances/{instancesId}:move", "httpMethod": "POST", "id": "spanner.projects.instances.move", @@ -1426,7 +1426,7 @@ ] }, "create": { - "description": "Creates a new Cloud Spanner database and starts to prepare it for serving. The returned long-running operation will have a name of the format `/operations/` and can be used to track preparation of the database. The metadata field type is CreateDatabaseMetadata. The response field type is Database, if successful.", + "description": "Creates a new Spanner database and starts to prepare it for serving. The returned long-running operation will have a name of the format `/operations/` and can be used to track preparation of the database. The metadata field type is CreateDatabaseMetadata. The response field type is Database, if successful.", "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases", "httpMethod": "POST", "id": "spanner.projects.instances.databases.create", @@ -1804,6 +1804,97 @@ } }, "resources": { + "backupSchedules": { + "methods": { + "getIamPolicy": { + "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.", + "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/backupSchedules/{backupSchedulesId}:getIamPolicy", + "httpMethod": "POST", + "id": "spanner.projects.instances.databases.backupSchedules.getIamPolicy", + "parameterOrder": [ + "resource" + ], + "parameters": { + "resource": { + "description": "REQUIRED: The Cloud Spanner resource for which the policy is being retrieved. The format is `projects//instances/` for instance resources and `projects//instances//databases/` for database resources.", + "location": "path", + "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+/backupSchedules/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+resource}:getIamPolicy", + "request": { + "$ref": "GetIamPolicyRequest" + }, + "response": { + "$ref": "Policy" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/spanner.admin" + ] + }, + "setIamPolicy": { + "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.", + "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/backupSchedules/{backupSchedulesId}:setIamPolicy", + "httpMethod": "POST", + "id": "spanner.projects.instances.databases.backupSchedules.setIamPolicy", + "parameterOrder": [ + "resource" + ], + "parameters": { + "resource": { + "description": "REQUIRED: The Cloud Spanner resource for which the policy is being set. The format is `projects//instances/` for instance resources and `projects//instances//databases/` for databases resources.", + "location": "path", + "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+/backupSchedules/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+resource}:setIamPolicy", + "request": { + "$ref": "SetIamPolicyRequest" + }, + "response": { + "$ref": "Policy" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/spanner.admin" + ] + }, + "testIamPermissions": { + "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.", + "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/backupSchedules/{backupSchedulesId}:testIamPermissions", + "httpMethod": "POST", + "id": "spanner.projects.instances.databases.backupSchedules.testIamPermissions", + "parameterOrder": [ + "resource" + ], + "parameters": { + "resource": { + "description": "REQUIRED: The Cloud Spanner resource for which permissions are being tested. The format is `projects//instances/` for instance resources and `projects//instances//databases/` for database resources.", + "location": "path", + "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+/backupSchedules/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+resource}:testIamPermissions", + "request": { + "$ref": "TestIamPermissionsRequest" + }, + "response": { + "$ref": "TestIamPermissionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/spanner.admin" + ] + } + } + }, "databaseRoles": { "methods": { "list": { @@ -3005,11 +3096,11 @@ } } }, - "revision": "20240612", + "revision": "20240711", "rootUrl": "https://spanner.googleapis.com/", "schemas": { "AutoscalingConfig": { - "description": "Autoscaling config for an instance.", + "description": "Autoscaling configuration for an instance.", "id": "AutoscalingConfig", "properties": { "autoscalingLimits": { @@ -3620,7 +3711,7 @@ "type": "array" }, "protoDescriptors": { - "description": "Optional. Proto descriptors used by CREATE/ALTER PROTO BUNDLE statements in 'extra_statements' above. 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).", + "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).", "format": "byte", "type": "string" } @@ -3638,7 +3729,7 @@ }, "instanceConfig": { "$ref": "InstanceConfig", - "description": "The target instance config end state." + "description": "The target instance configuration end state." }, "progress": { "$ref": "InstanceOperationProgress", @@ -3653,10 +3744,10 @@ "properties": { "instanceConfig": { "$ref": "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." + "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." }, "instanceConfigId": { - "description": "Required. The ID of the instance config 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.", + "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" }, "validateOnly": { @@ -3810,7 +3901,7 @@ "type": "string" }, "enableDropProtection": { - "description": "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).", + "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" }, "encryptionConfig": { @@ -4152,7 +4243,7 @@ "enumDescriptions": [ "The default mode. Only the statement results are returned.", "This mode returns only the query plan, without any results or execution statistics information.", - "This mode returns both the query plan and the execution statistics along with the results." + "This mode returns both the query plan and the execution statistics along with the results. This has a performance overhead compared to the NORMAL mode. It is not recommended to use this mode for production traffic." ], "type": "string" }, @@ -4423,12 +4514,12 @@ "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 may be zero in API responses for instances that are not yet in state `READY`. See [the documentation](https://cloud.google.com/spanner/docs/compute-capacity) for more information about nodes and processing units.", + "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).", "format": "int32", "type": "integer" }, "processingUnits": { - "description": "The number of processing units allocated to this instance. At most one of 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 may be zero in API responses for instances that are not yet in state `READY`. See [the documentation](https://cloud.google.com/spanner/docs/compute-capacity) for more information about nodes and processing units.", + "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. See [the documentation](https://cloud.google.com/spanner/docs/compute-capacity) for more information about nodes and processing units.", "format": "int32", "type": "integer" }, @@ -4461,11 +4552,11 @@ "id": "InstanceConfig", "properties": { "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.", + "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" }, "configType": { - "description": "Output only. Whether this instance config is a Google or User Managed Configuration.", + "description": "Output only. Whether this instance configuration is a Google- or user-managed configuration.", "enum": [ "TYPE_UNSPECIFIED", "GOOGLE_MANAGED", @@ -4473,8 +4564,8 @@ ], "enumDescriptions": [ "Unspecified.", - "Google managed configuration.", - "User managed configuration." + "Google-managed configuration.", + "User-managed configuration." ], "readOnly": true, "type": "string" @@ -4484,7 +4575,7 @@ "type": "string" }, "etag": { - "description": "etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a instance config from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform instance config updates in order to avoid race conditions: An etag is returned in the response which contains instance configs, and systems are expected to put that etag in the request to update instance config to ensure that their change will be applied to the same version of the instance config. If no etag is provided in the call to update instance config, then the existing instance config is overwritten blindly.", + "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" }, "freeInstanceAvailability": { @@ -4501,7 +4592,7 @@ "Indicates that free instances are available to be created in this instance config.", "Indicates that free instances are not supported in this instance config.", "Indicates that free instances are currently not available to be created in this instance config.", - "Indicates that additional free instances cannot be created in this instance config because the project has reached its limit of free instances." + "Indicates that additional free instances cannot be created in this instance configuration because the project has reached its limit of free instances." ], "readOnly": true, "type": "string" @@ -4521,11 +4612,11 @@ "type": "array" }, "name": { - "description": "A unique identifier for the instance configuration. Values are of the form `projects//instanceConfigs/a-z*`. User instance config must start with `custom-`.", + "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" }, "optionalReplicas": { - "description": "Output only. The available optional replicas to choose from for user managed configurations. Populated for Google managed configurations.", + "description": "Output only. The available optional replicas to choose from for user-managed configurations. Populated for Google-managed configurations.", "items": { "$ref": "ReplicaInfo" }, @@ -4550,19 +4641,19 @@ "type": "string" }, "reconciling": { - "description": "Output only. If true, the instance config is being created or updated. If false, there are no ongoing operations for the instance config.", + "description": "Output only. If true, the instance configuration is being created or updated. If false, there are no ongoing operations for the instance config.", "readOnly": true, "type": "boolean" }, "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`.", + "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`.", "items": { "$ref": "ReplicaInfo" }, "type": "array" }, "state": { - "description": "Output only. The current instance config state. Applicable only for USER_MANAGED configs.", + "description": "Output only. The current instance configuration state. Applicable only for `USER_MANAGED` configurations.", "enum": [ "STATE_UNSPECIFIED", "CREATING", @@ -4570,8 +4661,8 @@ ], "enumDescriptions": [ "Not specified.", - "The instance config is still being created.", - "The instance config is fully created and ready to be used to create instances." + "The instance configuration is still being created.", + "The instance configuration is fully created and ready to be used to create instances." ], "readOnly": true, "type": "string" @@ -4634,12 +4725,12 @@ "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`.", + "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`.", "format": "int32", "type": "integer" }, "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 may be zero in API responses for instance partitions that are not yet in state `READY`.", + "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.", "format": "int32", "type": "integer" }, @@ -4915,7 +5006,7 @@ "type": "string" }, "operations": { - "description": "The list of matching instance config long-running operations. Each operation's name will be prefixed by the instance config's name. The operation's metadata field type `metadata.type_url` describes the type of the metadata.", + "description": "The list of matching instance configuration long-running operations. Each operation's name will be prefixed by the instance config's name. The operation's metadata field type `metadata.type_url` describes the type of the metadata.", "items": { "$ref": "Operation" }, @@ -5199,7 +5290,7 @@ "id": "MoveInstanceRequest", "properties": { "targetConfig": { - "description": "Required. The target instance config for the instance to move. Values are of the form `projects//instanceConfigs/`.", + "description": "Required. The target instance configuration for the instance to move. Values are of the form `projects//instanceConfigs/`.", "type": "string" } }, @@ -5402,7 +5493,7 @@ "description": "Additional options that affect how many partitions are created." }, "sql": { - "description": "Required. The query request to generate partitions for. The request will fail if the query is not 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 about other conditions, see [Read data in 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 operations.", + "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 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 about other conditions, see [Read data in 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 operations.", "type": "string" }, "transaction": { @@ -5933,7 +6024,7 @@ "type": "string" }, "kmsKeyNames": { - "description": "Optional. Specifies the KMS configuration for the 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 instance configuration. Some examples: * For single region database instance configs, specify a single regional location KMS key. * For multi-regional database instance configs of type GOOGLE_MANAGED, either specify a multi-regional location KMS key or multiple regional location KMS keys that cover all regions in the instance config. * For a database instance config of type USER_MANAGED, please specify only regional location KMS keys to cover each region in the instance config. Multi-regional location KMS keys are not supported for USER_MANAGED instance configs.", + "description": "Optional. Specifies the KMS configuration for the 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 instance configuration. Some examples: * For single region database instance configurations, specify a single regional location KMS key. * For multi-regional database instance configurations of type `GOOGLE_MANAGED`, either specify a multi-regional location KMS key or multiple regional location KMS keys that cover all regions in the instance configuration. * For a database instance configuration of type `USER_MANAGED`, please specify only regional location KMS keys to cover each region in the instance configuration. Multi-regional location KMS keys are not supported for USER_MANAGED instance configurations.", "items": { "type": "string" }, @@ -6585,7 +6676,7 @@ }, "instanceConfig": { "$ref": "InstanceConfig", - "description": "The desired instance config after updating." + "description": "The desired instance configuration after updating." }, "progress": { "$ref": "InstanceOperationProgress", @@ -6600,7 +6691,7 @@ "properties": { "instanceConfig": { "$ref": "InstanceConfig", - "description": "Required. The user instance config to update, which must always include the instance config name. Otherwise, only fields mentioned in update_mask need be included. To prevent conflicts of concurrent updates, etag can be used." + "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." }, "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.", diff --git a/discovery/sqladmin-v1.json b/discovery/sqladmin-v1.json index 714597fb0a..eedc39fc2e 100644 --- a/discovery/sqladmin-v1.json +++ b/discovery/sqladmin-v1.json @@ -2267,7 +2267,7 @@ } } }, - "revision": "20240618", + "revision": "20240709", "rootUrl": "https://sqladmin.googleapis.com/", "schemas": { "AclEntry": { @@ -3711,6 +3711,20 @@ "description": "Optional. Whether or not the export should be parallel.", "type": "boolean" }, + "postgresExportOptions": { + "description": "Options for exporting from a Cloud SQL for PostgreSQL instance.", + "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.", + "type": "boolean" + }, + "ifExists": { + "description": "Optional. Option to include an IF EXISTS SQL statement with each DROP statement produced by clean.", + "type": "boolean" + } + }, + "type": "object" + }, "schemaOnly": { "description": "Export only schemas.", "type": "boolean" @@ -4193,6 +4207,20 @@ "description": "Optional. Whether or not the import should be parallel.", "type": "boolean" }, + "postgresImportOptions": { + "description": "Optional. Options for importing from a Cloud SQL for PostgreSQL instance.", + "properties": { + "clean": { + "description": "Optional. The --clean flag for the pg_restore utility. This flag applies only if you enabled Cloud SQL to import files in parallel.", + "type": "boolean" + }, + "ifExists": { + "description": "Optional. The --if-exists flag for the pg_restore utility. This flag applies only if you enabled Cloud SQL to import files in parallel.", + "type": "boolean" + } + }, + "type": "object" + }, "threads": { "description": "Optional. The number of threads to use for parallel import.", "format": "int32", diff --git a/discovery/sqladmin-v1beta4.json b/discovery/sqladmin-v1beta4.json index 40660b458c..2b059258b7 100644 --- a/discovery/sqladmin-v1beta4.json +++ b/discovery/sqladmin-v1beta4.json @@ -2267,7 +2267,7 @@ } } }, - "revision": "20240618", + "revision": "20240709", "rootUrl": "https://sqladmin.googleapis.com/", "schemas": { "AclEntry": { @@ -3712,6 +3712,20 @@ "description": "Optional. Whether or not the export should be parallel.", "type": "boolean" }, + "postgresExportOptions": { + "description": "Options for exporting from a Cloud SQL for PostgreSQL instance.", + "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.", + "type": "boolean" + }, + "ifExists": { + "description": "Optional. Option to include an IF EXISTS SQL statement with each DROP statement produced by clean.", + "type": "boolean" + } + }, + "type": "object" + }, "schemaOnly": { "description": "Export only schemas.", "type": "boolean" @@ -4194,6 +4208,20 @@ "description": "Optional. Whether or not the import should be parallel.", "type": "boolean" }, + "postgresImportOptions": { + "description": "Optional. Options for importing from a Cloud SQL for PostgreSQL instance.", + "properties": { + "clean": { + "description": "Optional. The --clean flag for the pg_restore utility. This flag applies only if you enabled Cloud SQL to import files in parallel.", + "type": "boolean" + }, + "ifExists": { + "description": "Optional. The --if-exists flag for the pg_restore utility. This flag applies only if you enabled Cloud SQL to import files in parallel.", + "type": "boolean" + } + }, + "type": "object" + }, "threads": { "description": "Optional. The number of threads to use for parallel import.", "format": "int32", diff --git a/discovery/storage-v1.json b/discovery/storage-v1.json index 9c69351ac3..0dd039a385 100644 --- a/discovery/storage-v1.json +++ b/discovery/storage-v1.json @@ -43,7 +43,7 @@ "description": "Regional Endpoint" } ], - "etag": "\"39393931363036383932333134343736343437\"", + "etag": "\"34333232303233333736343936303730373437\"", "icons": { "x16": "https://www.google.com/images/icons/product/cloud_storage-16.png", "x32": "https://www.google.com/images/icons/product/cloud_storage-32.png" @@ -4085,7 +4085,7 @@ } } }, - "revision": "20240625", + "revision": "20240713", "rootUrl": "https://storage.googleapis.com/", "schemas": { "AnywhereCache": { @@ -4347,6 +4347,49 @@ "description": "The ID of the bucket. For buckets, the id and name properties are the same.", "type": "string" }, + "ipFilter": { + "description": "The bucket's IP filter configuration. Specifies the network sources that are allowed to access the operations on the bucket, as well as its underlying objects. Only enforced when the mode is set to 'Enabled'.", + "properties": { + "mode": { + "description": "The mode of the IP filter. Valid values are 'Enabled' and 'Disabled'.", + "type": "string" + }, + "publicNetworkSource": { + "description": "The public network source of the bucket's IP filter.", + "properties": { + "allowedIpCidrRanges": { + "description": "The list of public IPv4, IPv6 cidr ranges that are allowed to access the bucket.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "vpcNetworkSources": { + "description": "The list of [VPC network](https://cloud.google.com/vpc/docs/vpc) sources of the bucket's IP filter.", + "items": { + "properties": { + "allowedIpCidrRanges": { + "description": "The list of IPv4, IPv6 cidr ranges subnetworks that are allowed to access the bucket.", + "items": { + "type": "string" + }, + "type": "array" + }, + "network": { + "description": "Name of the network. Format: projects/{PROJECT_ID}/global/networks/{NETWORK_NAME}", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, "kind": { "default": "storage#bucket", "description": "The kind of item this is. For buckets, this is always storage#bucket.", diff --git a/discovery/sts-v1.json b/discovery/sts-v1.json index 6f057ef5a9..3c7a8f826f 100644 --- a/discovery/sts-v1.json +++ b/discovery/sts-v1.json @@ -116,7 +116,7 @@ } } }, - "revision": "20240501", + "revision": "20240704", "rootUrl": "https://sts.googleapis.com/", "schemas": { "GoogleIamV1Binding": { @@ -216,6 +216,11 @@ "description": "Response message for ExchangeToken.", "id": "GoogleIdentityStsV1ExchangeTokenResponse", "properties": { + "access_boundary_session_key": { + "description": "The access boundary session key. This key is used along with the access boundary intermediate token to generate Credential Access Boundary tokens at client side. This field is absent when the `requested_token_type` from the request is not `urn:ietf:params:oauth:token-type:access_boundary_intermediate_token`.", + "format": "byte", + "type": "string" + }, "access_token": { "description": "An OAuth 2.0 security token, issued by Google, in response to the token exchange request. Tokens can vary in size, depending in part on the size of mapped claims, up to a maximum of 12288 bytes (12 KB). Google reserves the right to change the token size and the maximum length at any time.", "type": "string" diff --git a/discovery/tagmanager-v2.json b/discovery/tagmanager-v2.json index 309afd8213..26e054c37b 100644 --- a/discovery/tagmanager-v2.json +++ b/discovery/tagmanager-v2.json @@ -374,14 +374,19 @@ ] }, "lookup": { - "description": "Looks up a Container by destination ID.", + "description": "Looks up a Container by destination ID or tag ID.", "flatPath": "tagmanager/v2/accounts/containers:lookup", "httpMethod": "GET", "id": "tagmanager.accounts.containers.lookup", "parameterOrder": [], "parameters": { "destinationId": { - "description": "Destination ID linked to a GTM Container, e.g. AW-123456789. Example: accounts/containers:lookup?destination_id={destination_id}.", + "description": "Destination ID linked to a GTM Container, e.g. AW-123456789. Example: accounts/containers:lookup?destination_id={destination_id}. Only one of destination_id or tag_id should be set.", + "location": "query", + "type": "string" + }, + "tagId": { + "description": "Tag ID for a GTM Container, e.g. GTM-123456789. Example: accounts/containers:lookup?tag_id={tag_id}. Only one of destination_id or tag_id should be set.", "location": "query", "type": "string" } @@ -3890,7 +3895,7 @@ } } }, - "revision": "20240619", + "revision": "20240715", "rootUrl": "https://tagmanager.googleapis.com/", "schemas": { "Account": { diff --git a/discovery/transcoder-v1.json b/discovery/transcoder-v1.json index a86c766589..2e4ef865bc 100644 --- a/discovery/transcoder-v1.json +++ b/discovery/transcoder-v1.json @@ -385,7 +385,7 @@ } } }, - "revision": "20240207", + "revision": "20240701", "rootUrl": "https://transcoder.googleapis.com/", "schemas": { "AdBreak": { @@ -1541,7 +1541,7 @@ "id": "Output", "properties": { "uri": { - "description": "URI for the output file(s). For example, `gs://my-bucket/outputs/`. If empty, the value is populated from Job.output_uri. See [Supported input and output formats](https://cloud.google.com/transcoder/docs/concepts/supported-input-and-output-formats).", + "description": "URI for the output file(s). For example, `gs://my-bucket/outputs/`. Must be a directory and not a top-level bucket. If empty, the value is populated from Job.output_uri. See [Supported input and output formats](https://cloud.google.com/transcoder/docs/concepts/supported-input-and-output-formats).", "type": "string" } }, diff --git a/discovery/translate-v3.json b/discovery/translate-v3.json index c4f967756e..810420356a 100644 --- a/discovery/translate-v3.json +++ b/discovery/translate-v3.json @@ -1132,7 +1132,8 @@ "$ref": "Operation" }, "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-translation" ] }, "delete": { @@ -1260,7 +1261,8 @@ "$ref": "Operation" }, "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-translation" ] } }, @@ -1395,7 +1397,7 @@ ], "parameters": { "name": { - "description": "Required. The resource name of the entry. Format: \"projects/*/locations/*/glossaries/*/glossaryEntries/*\"", + "description": "Identifier. The resource name of the entry. Format: \"projects/*/locations/*/glossaries/*/glossaryEntries/*\"", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/glossaries/[^/]+/glossaryEntries/[^/]+$", "required": true, @@ -1706,7 +1708,7 @@ } } }, - "revision": "20240126", + "revision": "20240717", "rootUrl": "https://translation.googleapis.com/", "schemas": { "AdaptiveMtDataset": { @@ -1817,7 +1819,7 @@ "id": "AdaptiveMtTranslateRequest", "properties": { "content": { - "description": "Required. The content of the input in string format. For now only one sentence per request is supported.", + "description": "Required. The content of the input in string format.", "items": { "type": "string" }, @@ -1826,6 +1828,14 @@ "dataset": { "description": "Required. The resource name for the dataset to use for adaptive MT. `projects/{project}/locations/{location-id}/adaptiveMtDatasets/{dataset}`", "type": "string" + }, + "glossaryConfig": { + "$ref": "TranslateTextGlossaryConfig", + "description": "Optional. Glossary to be applied. The glossary must be within the same region (have the same location-id) as the model, otherwise an INVALID_ARGUMENT (400) error is returned." + }, + "referenceSentenceConfig": { + "$ref": "ReferenceSentenceConfig", + "description": "Configuration for caller provided reference sentences." } }, "type": "object" @@ -1834,6 +1844,13 @@ "description": "An AdaptiveMtTranslate response.", "id": "AdaptiveMtTranslateResponse", "properties": { + "glossaryTranslations": { + "description": "Text translation response if a glossary is provided in the request. This could be the same as 'translation' above if no terms apply.", + "items": { + "$ref": "AdaptiveMtTranslation" + }, + "type": "array" + }, "languageCode": { "description": "Output only. The translation's language code.", "readOnly": true, @@ -2360,7 +2377,7 @@ "type": "string" }, "name": { - "description": "Required. The resource name of the entry. Format: \"projects/*/locations/*/glossaries/*/glossaryEntries/*\"", + "description": "Identifier. The resource name of the entry. Format: \"projects/*/locations/*/glossaries/*/glossaryEntries/*\"", "type": "string" }, "termsPair": { @@ -2848,6 +2865,57 @@ }, "type": "object" }, + "ReferenceSentenceConfig": { + "description": "Message of caller-provided reference configuration.", + "id": "ReferenceSentenceConfig", + "properties": { + "referenceSentencePairLists": { + "description": "Reference sentences pair lists. Each list will be used as the references to translate the sentence under \"content\" field at the corresponding index. Length of the list is required to be equal to the length of \"content\" field.", + "items": { + "$ref": "ReferenceSentencePairList" + }, + "type": "array" + }, + "sourceLanguageCode": { + "description": "Source language code.", + "type": "string" + }, + "targetLanguageCode": { + "description": "Target language code.", + "type": "string" + } + }, + "type": "object" + }, + "ReferenceSentencePair": { + "description": "A pair of sentences used as reference in source and target languages.", + "id": "ReferenceSentencePair", + "properties": { + "sourceSentence": { + "description": "Source sentence in the sentence pair.", + "type": "string" + }, + "targetSentence": { + "description": "Target sentence in the sentence pair.", + "type": "string" + } + }, + "type": "object" + }, + "ReferenceSentencePairList": { + "description": "A list of reference sentence pairs.", + "id": "ReferenceSentencePairList", + "properties": { + "referenceSentencePairs": { + "description": "Reference sentence pairs.", + "items": { + "$ref": "ReferenceSentencePair" + }, + "type": "array" + } + }, + "type": "object" + }, "Romanization": { "description": "A single romanization response.", "id": "Romanization", @@ -3078,7 +3146,7 @@ "type": "string" }, "model": { - "description": "Optional. The `model` type requested for this translation. The format depends on model type: - AutoML Translation models: `projects/{project-number-or-id}/locations/{location-id}/models/{model-id}` - General (built-in) models: `projects/{project-number-or-id}/locations/{location-id}/models/general/nmt`, For global (non-regionalized) requests, use `location-id` `global`. For example, `projects/{project-number-or-id}/locations/global/models/general/nmt`. If not provided, the default Google model (NMT) will be used", + "description": "Optional. The `model` type requested for this translation. The format depends on model type: - AutoML Translation models: `projects/{project-number-or-id}/locations/{location-id}/models/{model-id}` - General (built-in) models: `projects/{project-number-or-id}/locations/{location-id}/models/general/nmt`, - Translation LLM models: `projects/{project-number-or-id}/locations/{location-id}/models/general/translation-llm`, For global (non-regionalized) requests, use `location-id` `global`. For example, `projects/{project-number-or-id}/locations/global/models/general/nmt`. If not provided, the default Google model (NMT) will be used", "type": "string" }, "sourceLanguageCode": { diff --git a/discovery/translate-v3beta1.json b/discovery/translate-v3beta1.json index a19c87e780..e02e6e1a75 100644 --- a/discovery/translate-v3beta1.json +++ b/discovery/translate-v3beta1.json @@ -484,7 +484,8 @@ "$ref": "Operation" }, "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-translation" ] }, "delete": { @@ -744,7 +745,7 @@ } } }, - "revision": "20230922", + "revision": "20240717", "rootUrl": "https://translation.googleapis.com/", "schemas": { "BatchDocumentInputConfig": { diff --git a/discovery/vmmigration-v1.json b/discovery/vmmigration-v1.json index fa7cc65e46..8efe719aec 100644 --- a/discovery/vmmigration-v1.json +++ b/discovery/vmmigration-v1.json @@ -1180,6 +1180,66 @@ } } }, + "diskMigrationJobs": { + "methods": { + "cancel": { + "description": "Cancels the disk migration job.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/sources/{sourcesId}/diskMigrationJobs/{diskMigrationJobsId}:cancel", + "httpMethod": "POST", + "id": "vmmigration.projects.locations.sources.diskMigrationJobs.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the DiskMigrationJob.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/sources/[^/]+/diskMigrationJobs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:cancel", + "request": { + "$ref": "CancelDiskMigrationJobRequest" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "run": { + "description": "Runs the disk migration job.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/sources/{sourcesId}/diskMigrationJobs/{diskMigrationJobsId}:run", + "httpMethod": "POST", + "id": "vmmigration.projects.locations.sources.diskMigrationJobs.run", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the DiskMigrationJob.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/sources/[^/]+/diskMigrationJobs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:run", + "request": { + "$ref": "RunDiskMigrationJobRequest" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, "migratingVms": { "methods": { "create": { @@ -2220,7 +2280,7 @@ } } }, - "revision": "20240613", + "revision": "20240704", "rootUrl": "https://vmmigration.googleapis.com/", "schemas": { "AccessKeyCredentials": { @@ -2873,13 +2933,15 @@ "COMPUTE_ENGINE_DISK_TYPE_UNSPECIFIED", "COMPUTE_ENGINE_DISK_TYPE_STANDARD", "COMPUTE_ENGINE_DISK_TYPE_SSD", - "COMPUTE_ENGINE_DISK_TYPE_BALANCED" + "COMPUTE_ENGINE_DISK_TYPE_BALANCED", + "COMPUTE_ENGINE_DISK_TYPE_HYPERDISK_BALANCED" ], "enumDescriptions": [ "An unspecified disk type. Will be used as STANDARD.", "A Standard disk type.", "SSD hard disk type.", - "An alternative to SSD persistent disks that balance performance and cost." + "An alternative to SSD persistent disks that balance performance and cost.", + "Hyperdisk balanced disk type." ], "type": "string" }, @@ -2906,6 +2968,12 @@ "properties": {}, "type": "object" }, + "CancelDiskMigrationJobRequest": { + "description": "Request message for 'CancelDiskMigrationJob' request.", + "id": "CancelDiskMigrationJobRequest", + "properties": {}, + "type": "object" + }, "CancelImageImportJobRequest": { "description": "Request message for 'CancelImageImportJob' request.", "id": "CancelImageImportJobRequest", @@ -3137,13 +3205,15 @@ "COMPUTE_ENGINE_DISK_TYPE_UNSPECIFIED", "COMPUTE_ENGINE_DISK_TYPE_STANDARD", "COMPUTE_ENGINE_DISK_TYPE_SSD", - "COMPUTE_ENGINE_DISK_TYPE_BALANCED" + "COMPUTE_ENGINE_DISK_TYPE_BALANCED", + "COMPUTE_ENGINE_DISK_TYPE_HYPERDISK_BALANCED" ], "enumDescriptions": [ "An unspecified disk type. Will be used as STANDARD.", "A Standard disk type.", "SSD hard disk type.", - "An alternative to SSD persistent disks that balance performance and cost." + "An alternative to SSD persistent disks that balance performance and cost.", + "Hyperdisk balanced disk type." ], "type": "string" }, @@ -3267,13 +3337,15 @@ "COMPUTE_ENGINE_DISK_TYPE_UNSPECIFIED", "COMPUTE_ENGINE_DISK_TYPE_STANDARD", "COMPUTE_ENGINE_DISK_TYPE_SSD", - "COMPUTE_ENGINE_DISK_TYPE_BALANCED" + "COMPUTE_ENGINE_DISK_TYPE_BALANCED", + "COMPUTE_ENGINE_DISK_TYPE_HYPERDISK_BALANCED" ], "enumDescriptions": [ "An unspecified disk type. Will be used as STANDARD.", "A Standard disk type.", "SSD hard disk type.", - "An alternative to SSD persistent disks that balance performance and cost." + "An alternative to SSD persistent disks that balance performance and cost.", + "Hyperdisk balanced disk type." ], "type": "string" }, @@ -3713,7 +3785,7 @@ "id": "DiskImageTargetDetails", "properties": { "additionalLicenses": { - "description": "Optional. Additional licenses to assign to the image.", + "description": "Optional. Additional licenses to assign to the image. Format: https://www.googleapis.com/compute/v1/projects/PROJECT_ID/global/licenses/LICENSE_NAME Or https://www.googleapis.com/compute/beta/projects/PROJECT_ID/global/licenses/LICENSE_NAME", "items": { "type": "string" }, @@ -4874,7 +4946,7 @@ "type": "string" }, "subnetwork": { - "description": "The subnetwork to connect the NIC to.", + "description": "Optional. The subnetwork to connect the NIC to.", "type": "string" } }, @@ -5045,13 +5117,15 @@ "COMPUTE_ENGINE_DISK_TYPE_UNSPECIFIED", "COMPUTE_ENGINE_DISK_TYPE_STANDARD", "COMPUTE_ENGINE_DISK_TYPE_SSD", - "COMPUTE_ENGINE_DISK_TYPE_BALANCED" + "COMPUTE_ENGINE_DISK_TYPE_BALANCED", + "COMPUTE_ENGINE_DISK_TYPE_HYPERDISK_BALANCED" ], "enumDescriptions": [ "An unspecified disk type. Will be used as STANDARD.", "A Standard disk type.", "SSD hard disk type.", - "An alternative to SSD persistent disks that balance performance and cost." + "An alternative to SSD persistent disks that balance performance and cost.", + "Hyperdisk balanced disk type." ], "type": "string" }, @@ -5066,7 +5140,7 @@ }, "vmAttachmentDetails": { "$ref": "VmAttachmentDetails", - "description": "Optional. Details for attachment of the disk to a VM. Used when the disk is set to be attacked to a target VM." + "description": "Optional. Details for attachment of the disk to a VM. Used when the disk is set to be attached to a target VM." } }, "type": "object" @@ -5214,6 +5288,12 @@ "properties": {}, "type": "object" }, + "RunDiskMigrationJobRequest": { + "description": "Request message for 'RunDiskMigrationJobRequest' request.", + "id": "RunDiskMigrationJobRequest", + "properties": {}, + "type": "object" + }, "SchedulePolicy": { "description": "A policy for scheduling replications.", "id": "SchedulePolicy", diff --git a/discovery/vmmigration-v1alpha1.json b/discovery/vmmigration-v1alpha1.json index ecc11a46c2..aabc85c5c0 100644 --- a/discovery/vmmigration-v1alpha1.json +++ b/discovery/vmmigration-v1alpha1.json @@ -1180,6 +1180,66 @@ } } }, + "diskMigrationJobs": { + "methods": { + "cancel": { + "description": "Cancels the disk migration job.", + "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/sources/{sourcesId}/diskMigrationJobs/{diskMigrationJobsId}:cancel", + "httpMethod": "POST", + "id": "vmmigration.projects.locations.sources.diskMigrationJobs.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the DiskMigrationJob.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/sources/[^/]+/diskMigrationJobs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha1/{+name}:cancel", + "request": { + "$ref": "CancelDiskMigrationJobRequest" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "run": { + "description": "Runs the disk migration job.", + "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/sources/{sourcesId}/diskMigrationJobs/{diskMigrationJobsId}:run", + "httpMethod": "POST", + "id": "vmmigration.projects.locations.sources.diskMigrationJobs.run", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the DiskMigrationJob.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/sources/[^/]+/diskMigrationJobs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha1/{+name}:run", + "request": { + "$ref": "RunDiskMigrationJobRequest" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, "migratingVms": { "methods": { "create": { @@ -2220,7 +2280,7 @@ } } }, - "revision": "20240613", + "revision": "20240704", "rootUrl": "https://vmmigration.googleapis.com/", "schemas": { "AccessKeyCredentials": { @@ -2873,13 +2933,15 @@ "COMPUTE_ENGINE_DISK_TYPE_UNSPECIFIED", "COMPUTE_ENGINE_DISK_TYPE_STANDARD", "COMPUTE_ENGINE_DISK_TYPE_SSD", - "COMPUTE_ENGINE_DISK_TYPE_BALANCED" + "COMPUTE_ENGINE_DISK_TYPE_BALANCED", + "COMPUTE_ENGINE_DISK_TYPE_HYPERDISK_BALANCED" ], "enumDescriptions": [ "An unspecified disk type. Will be used as STANDARD.", "A Standard disk type.", "SSD hard disk type.", - "An alternative to SSD persistent disks that balance performance and cost." + "An alternative to SSD persistent disks that balance performance and cost.", + "Hyperdisk balanced disk type." ], "type": "string" }, @@ -2906,6 +2968,12 @@ "properties": {}, "type": "object" }, + "CancelDiskMigrationJobRequest": { + "description": "Request message for 'CancelDiskMigrationJob' request.", + "id": "CancelDiskMigrationJobRequest", + "properties": {}, + "type": "object" + }, "CancelImageImportJobRequest": { "description": "Request message for 'CancelImageImportJob' request.", "id": "CancelImageImportJobRequest", @@ -3149,13 +3217,15 @@ "COMPUTE_ENGINE_DISK_TYPE_UNSPECIFIED", "COMPUTE_ENGINE_DISK_TYPE_STANDARD", "COMPUTE_ENGINE_DISK_TYPE_SSD", - "COMPUTE_ENGINE_DISK_TYPE_BALANCED" + "COMPUTE_ENGINE_DISK_TYPE_BALANCED", + "COMPUTE_ENGINE_DISK_TYPE_HYPERDISK_BALANCED" ], "enumDescriptions": [ "An unspecified disk type. Will be used as STANDARD.", "A Standard disk type.", "SSD hard disk type.", - "An alternative to SSD persistent disks that balance performance and cost." + "An alternative to SSD persistent disks that balance performance and cost.", + "Hyperdisk balanced disk type." ], "type": "string" }, @@ -3279,13 +3349,15 @@ "COMPUTE_ENGINE_DISK_TYPE_UNSPECIFIED", "COMPUTE_ENGINE_DISK_TYPE_STANDARD", "COMPUTE_ENGINE_DISK_TYPE_SSD", - "COMPUTE_ENGINE_DISK_TYPE_BALANCED" + "COMPUTE_ENGINE_DISK_TYPE_BALANCED", + "COMPUTE_ENGINE_DISK_TYPE_HYPERDISK_BALANCED" ], "enumDescriptions": [ "An unspecified disk type. Will be used as STANDARD.", "A Standard disk type.", "SSD hard disk type.", - "An alternative to SSD persistent disks that balance performance and cost." + "An alternative to SSD persistent disks that balance performance and cost.", + "Hyperdisk balanced disk type." ], "type": "string" }, @@ -3748,7 +3820,7 @@ "id": "DiskImageTargetDetails", "properties": { "additionalLicenses": { - "description": "Optional. Additional licenses to assign to the image.", + "description": "Optional. Additional licenses to assign to the image. Format: https://www.googleapis.com/compute/v1/projects/PROJECT_ID/global/licenses/LICENSE_NAME Or https://www.googleapis.com/compute/beta/projects/PROJECT_ID/global/licenses/LICENSE_NAME", "items": { "type": "string" }, @@ -4919,7 +4991,7 @@ "type": "string" }, "subnetwork": { - "description": "The subnetwork to connect the NIC to.", + "description": "Optional. The subnetwork to connect the NIC to.", "type": "string" } }, @@ -5090,13 +5162,15 @@ "COMPUTE_ENGINE_DISK_TYPE_UNSPECIFIED", "COMPUTE_ENGINE_DISK_TYPE_STANDARD", "COMPUTE_ENGINE_DISK_TYPE_SSD", - "COMPUTE_ENGINE_DISK_TYPE_BALANCED" + "COMPUTE_ENGINE_DISK_TYPE_BALANCED", + "COMPUTE_ENGINE_DISK_TYPE_HYPERDISK_BALANCED" ], "enumDescriptions": [ "An unspecified disk type. Will be used as STANDARD.", "A Standard disk type.", "SSD hard disk type.", - "An alternative to SSD persistent disks that balance performance and cost." + "An alternative to SSD persistent disks that balance performance and cost.", + "Hyperdisk balanced disk type." ], "type": "string" }, @@ -5111,7 +5185,7 @@ }, "vmAttachmentDetails": { "$ref": "VmAttachmentDetails", - "description": "Optional. Details for attachment of the disk to a VM. Used when the disk is set to be attacked to a target VM." + "description": "Optional. Details for attachment of the disk to a VM. Used when the disk is set to be attached to a target VM." } }, "type": "object" @@ -5265,6 +5339,12 @@ "properties": {}, "type": "object" }, + "RunDiskMigrationJobRequest": { + "description": "Request message for 'RunDiskMigrationJobRequest' request.", + "id": "RunDiskMigrationJobRequest", + "properties": {}, + "type": "object" + }, "SchedulePolicy": { "description": "A policy for scheduling replications.", "id": "SchedulePolicy", diff --git a/discovery/vmwareengine-v1.json b/discovery/vmwareengine-v1.json index e90a85b188..b4094df5dd 100644 --- a/discovery/vmwareengine-v1.json +++ b/discovery/vmwareengine-v1.json @@ -3173,7 +3173,7 @@ } } }, - "revision": "20240528", + "revision": "20240701", "rootUrl": "https://vmwareengine.googleapis.com/", "schemas": { "AuditConfig": { @@ -3224,6 +3224,67 @@ }, "type": "object" }, + "AutoscalingPolicy": { + "description": "Autoscaling policy describes the behavior of the autoscaling with respect to the resource utilization. The scale-out operation is initiated if the utilization exceeds ANY of the respective thresholds. The scale-in operation is initiated if the utilization is below ALL of the respective thresholds.", + "id": "AutoscalingPolicy", + "properties": { + "consumedMemoryThresholds": { + "$ref": "Thresholds", + "description": "Optional. Utilization thresholds pertaining to amount of consumed memory." + }, + "cpuThresholds": { + "$ref": "Thresholds", + "description": "Optional. Utilization thresholds pertaining to CPU utilization." + }, + "grantedMemoryThresholds": { + "$ref": "Thresholds", + "description": "Optional. Utilization thresholds pertaining to amount of granted memory." + }, + "nodeTypeId": { + "description": "Required. The canonical identifier of the node type to add or remove. Corresponds to the `NodeType`.", + "type": "string" + }, + "scaleOutSize": { + "description": "Required. Number of nodes to add to a cluster during a scale-out operation. Must be divisible by 2 for stretched clusters. During a scale-in operation only one node (or 2 for stretched clusters) are removed in a single iteration.", + "format": "int32", + "type": "integer" + }, + "storageThresholds": { + "$ref": "Thresholds", + "description": "Optional. Utilization thresholds pertaining to amount of consumed storage." + } + }, + "type": "object" + }, + "AutoscalingSettings": { + "description": "Autoscaling settings define the rules used by VMware Engine to automatically scale-out and scale-in the clusters in a private cloud.", + "id": "AutoscalingSettings", + "properties": { + "autoscalingPolicies": { + "additionalProperties": { + "$ref": "AutoscalingPolicy" + }, + "description": "Required. The map with autoscaling policies applied to the cluster. The key is the identifier of the policy. It must meet the following requirements: * Only contains 1-63 alphanumeric characters and hyphens * Begins with an alphabetical character * Ends with a non-hyphen character * Not formatted as a UUID * Complies with [RFC 1034](https://datatracker.ietf.org/doc/html/rfc1034) (section 3.5) Currently there map must contain only one element that describes the autoscaling policy for compute nodes.", + "type": "object" + }, + "coolDownPeriod": { + "description": "Optional. The minimum duration between consecutive autoscale operations. It starts once addition or removal of nodes is fully completed. Defaults to 30 minutes if not specified. Cool down period must be in whole minutes (for example, 30, 31, 50, 180 minutes).", + "format": "google-duration", + "type": "string" + }, + "maxClusterNodeCount": { + "description": "Optional. Maximum number of nodes of any type in a cluster. If not specified the default limits apply.", + "format": "int32", + "type": "integer" + }, + "minClusterNodeCount": { + "description": "Optional. Minimum number of nodes of any type in a cluster. If not specified the default limits apply.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, "Binding": { "description": "Associates `members`, or principals, with a `role`.", "id": "Binding", @@ -3250,6 +3311,10 @@ "description": "A cluster in a private cloud.", "id": "Cluster", "properties": { + "autoscalingSettings": { + "$ref": "AutoscalingSettings", + "description": "Optional. Configuration of the autoscaling applied to this cluster." + }, "createTime": { "description": "Output only. Creation time of this resource.", "format": "google-datetime", @@ -5382,6 +5447,23 @@ }, "type": "object" }, + "Thresholds": { + "description": "Thresholds define the utilization of resources triggering scale-out and scale-in operations.", + "id": "Thresholds", + "properties": { + "scaleIn": { + "description": "Required. The utilization triggering the scale-in operation in percent.", + "format": "int32", + "type": "integer" + }, + "scaleOut": { + "description": "Required. The utilization triggering the scale-out operation in percent.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, "UndeletePrivateCloudRequest": { "description": "Request message for VmwareEngine.UndeletePrivateCloud", "id": "UndeletePrivateCloudRequest", diff --git a/discovery/workloadmanager-v1.json b/discovery/workloadmanager-v1.json index dcea7499b3..16b9e2f496 100644 --- a/discovery/workloadmanager-v1.json +++ b/discovery/workloadmanager-v1.json @@ -772,7 +772,7 @@ } } }, - "revision": "20240619", + "revision": "20240701", "rootUrl": "https://workloadmanager.googleapis.com/", "schemas": { "AgentCommand": { @@ -797,6 +797,10 @@ "description": "Provides the mapping of a cloud asset to a direct physical location or to a proxy that defines the location on its behalf.", "id": "AssetLocation", "properties": { + "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" + }, "expected": { "$ref": "IsolationExpectations", "description": "Defines the customer expectation around ZI/ZS for this asset and ZI/ZS state of the region at the time of asset creation." @@ -2318,7 +2322,15 @@ "SpannerLocation": { "id": "SpannerLocation", "properties": { + "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", + "items": { + "type": "string" + }, + "type": "array" + }, "dbName": { + "description": "Set of databases used by the resource in format /span//", "items": { "type": "string" }, diff --git a/discovery/workstations-v1.json b/discovery/workstations-v1.json index 75acfc3442..29cf47af73 100644 --- a/discovery/workstations-v1.json +++ b/discovery/workstations-v1.json @@ -1195,7 +1195,7 @@ } } }, - "revision": "20240619", + "revision": "20240709", "rootUrl": "https://workstations.googleapis.com/", "schemas": { "Accelerator": { @@ -1347,11 +1347,11 @@ "type": "object" }, "DomainConfig": { - "description": "Configuration options for private workstation clusters.", + "description": "Configuration options for a custom domain.", "id": "DomainConfig", "properties": { "domain": { - "description": "Immutable. Whether Workstations endpoint is private.", + "description": "Immutable. Domain used by Workstations for HTTP ingress.", "type": "string" } }, @@ -1940,23 +1940,45 @@ }, "type": "object" }, + "PortRange": { + "description": "A PortRange defines a range of ports. Both first and last are inclusive. To specify a single port, both first and last should be the same.", + "id": "PortRange", + "properties": { + "first": { + "description": "Required. Starting port number for the current range of ports.", + "format": "int32", + "type": "integer" + }, + "last": { + "description": "Required. Ending port number for the current range of ports.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, "PrivateClusterConfig": { + "description": "Configuration options for private workstation clusters.", "id": "PrivateClusterConfig", "properties": { "allowedProjects": { + "description": "Optional. Additional projects that are allowed to attach to the workstation cluster's service attachment. By default, the workstation cluster's project and the VPC host project (if different) are allowed.", "items": { "type": "string" }, "type": "array" }, "clusterHostname": { + "description": "Output only. Hostname for the workstation cluster. This field will be populated only when private endpoint is enabled. To access workstations in the workstation cluster, create a new DNS zone mapping this domain name to an internal IP address and a forwarding rule mapping that address to the service attachment.", "readOnly": true, "type": "string" }, "enablePrivateEndpoint": { + "description": "Immutable. Whether Workstations endpoint is private.", "type": "boolean" }, "serviceAttachmentUri": { + "description": "Output only. Service attachment URI for the workstation cluster. The service attachemnt 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).", "readOnly": true, "type": "string" } @@ -2282,6 +2304,13 @@ "description": "A workstation configuration resource in the Cloud Workstations API. Workstation configurations act as templates for workstations. The workstation configuration defines details such as the workstation virtual machine (VM) instance type, persistent storage, container image defining environment, which IDE or Code Editor to use, and more. Administrators and platform teams can also use [Identity and Access Management (IAM)](https://cloud.google.com/iam/docs/overview) rules to grant access to teams or to individual developers.", "id": "WorkstationConfig", "properties": { + "allowedPorts": { + "description": "Optional. A Single or Range of ports externally accessible in the workstation. If not specified defaults to ports 22, 80 and ports 1024-65535.", + "items": { + "$ref": "PortRange" + }, + "type": "array" + }, "annotations": { "additionalProperties": { "type": "string" diff --git a/discovery/workstations-v1beta.json b/discovery/workstations-v1beta.json index 6a06a9a850..cf8fefe315 100644 --- a/discovery/workstations-v1beta.json +++ b/discovery/workstations-v1beta.json @@ -1127,7 +1127,7 @@ } } }, - "revision": "20240619", + "revision": "20240709", "rootUrl": "https://workstations.googleapis.com/", "schemas": { "Accelerator": { @@ -1315,11 +1315,11 @@ "type": "object" }, "DomainConfig": { - "description": "Configuration options for private workstation clusters.", + "description": "Configuration options for a custom domain.", "id": "DomainConfig", "properties": { "domain": { - "description": "Immutable. Whether Workstations endpoint is private.", + "description": "Immutable. Domain used by Workstations for HTTP ingress.", "type": "string" } }, @@ -1875,7 +1875,7 @@ "type": "object" }, "PortRange": { - "description": "A PortsConfig defines a range of ports. Both first and last are inclusive. To specify a single port, both first and last should be the same.", + "description": "A PortRange defines a range of ports. Both first and last are inclusive. To specify a single port, both first and last should be the same.", "id": "PortRange", "properties": { "first": { @@ -1892,22 +1892,27 @@ "type": "object" }, "PrivateClusterConfig": { + "description": "Configuration options for private workstation clusters.", "id": "PrivateClusterConfig", "properties": { "allowedProjects": { + "description": "Optional. Additional projects that are allowed to attach to the workstation cluster's service attachment. By default, the workstation cluster's project and the VPC host project (if different) are allowed.", "items": { "type": "string" }, "type": "array" }, "clusterHostname": { + "description": "Output only. Hostname for the workstation cluster. This field will be populated only when private endpoint is enabled. To access workstations in the workstation cluster, create a new DNS zone mapping this domain name to an internal IP address and a forwarding rule mapping that address to the service attachment.", "readOnly": true, "type": "string" }, "enablePrivateEndpoint": { + "description": "Immutable. Whether Workstations endpoint is private.", "type": "boolean" }, "serviceAttachmentUri": { + "description": "Output only. Service attachment URI for the workstation cluster. The service attachemnt 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).", "readOnly": true, "type": "string" } @@ -2099,6 +2104,16 @@ "readOnly": true, "type": "boolean" }, + "satisfiesPzi": { + "description": "Output only. Reserved for future use.", + "readOnly": true, + "type": "boolean" + }, + "satisfiesPzs": { + "description": "Output only. Reserved for future use.", + "readOnly": true, + "type": "boolean" + }, "sourceWorkstation": { "description": "Optional. The source workstation from which this workstations persistent directories were cloned on creation.", "type": "string" @@ -2219,6 +2234,16 @@ "readOnly": true, "type": "boolean" }, + "satisfiesPzi": { + "description": "Output only. Reserved for future use.", + "readOnly": true, + "type": "boolean" + }, + "satisfiesPzs": { + "description": "Output only. Reserved for future use.", + "readOnly": true, + "type": "boolean" + }, "subnetwork": { "description": "Immutable. Name of the Compute Engine subnetwork in which instances associated with this workstation cluster will be created. Must be part of the subnetwork specified for this workstation cluster.", "type": "string" @@ -2366,6 +2391,16 @@ "format": "google-duration", "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" + }, "uid": { "description": "Output only. A system-assigned unique identifier for this workstation configuration.", "readOnly": true, diff --git a/release-please-config.json b/release-please-config.json index 66bfca6f90..504a6066ce 100644 --- a/release-please-config.json +++ b/release-please-config.json @@ -1,9 +1,10 @@ { "bootstrap-sha": "6e61af34c0bfdfc3d6f973bffcd6a7e2420590d2", - "initial-version": "0.1.0", "packages": { "src/apis/abusiveexperiencereport": {}, "src/apis/acceleratedmobilepageurl": {}, + "src/apis/acmedns": {}, + "src/apis/addressvalidation": {}, "src/apis/adexchangebuyer": {}, "src/apis/adexchangebuyer2": {}, "src/apis/adexperiencereport": {}, @@ -11,6 +12,8 @@ "src/apis/admob": {}, "src/apis/adsense": {}, "src/apis/adsensehost": {}, + "src/apis/adsenseplatform": {}, + "src/apis/airquality": {}, "src/apis/alertcenter": {}, "src/apis/analytics": {}, "src/apis/analyticsreporting": {}, @@ -18,30 +21,41 @@ "src/apis/androidenterprise": {}, "src/apis/androidmanagement": {}, "src/apis/androidpublisher": {}, + "src/apis/apim": {}, + "src/apis/apphub": {}, "src/apis/appsactivity": {}, "src/apis/authorizedbuyersmarketplace": {}, + "src/apis/backupdr": {}, + "src/apis/biglake": {}, "src/apis/bigtableadmin": {}, + "src/apis/blockchainnodeengine": {}, "src/apis/blogger": {}, "src/apis/books": {}, "src/apis/businessprofileperformance": {}, "src/apis/calendar": {}, "src/apis/chat": {}, + "src/apis/checks": {}, "src/apis/chromemanagement": {}, "src/apis/chromepolicy": {}, "src/apis/chromeuxreport": {}, "src/apis/civicinfo": {}, "src/apis/classroom": {}, + "src/apis/cloudcontrolspartner": {}, "src/apis/cloudidentity": {}, "src/apis/cloudkms": {}, "src/apis/cloudsearch": {}, "src/apis/cloudshell": {}, - "src/apis/cloudsupport": {}, "src/apis/cloudtasks": {}, + "src/apis/config": {}, "src/apis/connectors": {}, + "src/apis/contactcenteraiplatform": {}, "src/apis/content": {}, + "src/apis/css": {}, "src/apis/customsearch": {}, "src/apis/datapipelines": {}, + "src/apis/dataportability": {}, "src/apis/deploymentmanager": {}, + "src/apis/developerconnect": {}, "src/apis/dfareporting": {}, "src/apis/digitalassetlinks": {}, "src/apis/discovery": {}, @@ -58,6 +72,7 @@ "src/apis/fcmdata": {}, "src/apis/firebase": {}, "src/apis/firebaseappcheck": {}, + "src/apis/firebaseappdistribution": {}, "src/apis/firebasedatabase": {}, "src/apis/firebasedynamiclinks": {}, "src/apis/firebasehosting": {}, @@ -70,6 +85,7 @@ "src/apis/gamesConfiguration": {}, "src/apis/gamesManagement": {}, "src/apis/genomics": {}, + "src/apis/gkeonprem": {}, "src/apis/gmail": {}, "src/apis/gmailpostmastertools": {}, "src/apis/groupsmigration": {}, @@ -80,11 +96,17 @@ "src/apis/ideahub": {}, "src/apis/identitytoolkit": {}, "src/apis/indexing": {}, + "src/apis/integrations": {}, "src/apis/kgsearch": {}, + "src/apis/kmsinventory": {}, "src/apis/libraryagent": {}, "src/apis/licensing": {}, "src/apis/localservices": {}, + "src/apis/looker": {}, "src/apis/manufacturers": {}, + "src/apis/marketingplatformadmin": {}, + "src/apis/meet": {}, + "src/apis/merchantapi": {}, "src/apis/ml": {}, "src/apis/mybusinessaccountmanagement": {}, "src/apis/mybusinessbusinesscalls": {}, @@ -103,13 +125,16 @@ "src/apis/playablelocations": {}, "src/apis/playcustomapp": {}, "src/apis/playdeveloperreporting": {}, + "src/apis/playgrouping": {}, "src/apis/playintegrity": {}, "src/apis/plus": {}, "src/apis/policyanalyzer": {}, "src/apis/policysimulator": {}, + "src/apis/pollen": {}, "src/apis/poly": {}, "src/apis/prod_tt_sasportal": {}, "src/apis/pubsublite": {}, + "src/apis/readerrevenuesubscriptionlinking": {}, "src/apis/realtimebidding": {}, "src/apis/recommendationengine": {}, "src/apis/remotebuildexecution": {}, @@ -118,6 +143,7 @@ "src/apis/safebrowsing": {}, "src/apis/sasportal": {}, "src/apis/script": {}, + "src/apis/searchads360": {}, "src/apis/searchconsole": {}, "src/apis/serviceconsumermanagement": {}, "src/apis/servicenetworking": {}, @@ -125,6 +151,7 @@ "src/apis/siteVerification": {}, "src/apis/slides": {}, "src/apis/smartdevicemanagement": {}, + "src/apis/solar": {}, "src/apis/sourcerepo": {}, "src/apis/sql": {}, "src/apis/sqladmin": {}, @@ -140,165 +167,139 @@ "src/apis/vectortile": {}, "src/apis/verifiedaccess": {}, "src/apis/versionhistory": {}, + "src/apis/walletobjects": {}, "src/apis/webfonts": {}, "src/apis/webmasters": {}, "src/apis/workflowexecutions": {}, "src/apis/workloadmanager": {}, - "src/apis/workstations": {}, + "src/apis/workspaceevents": {}, "src/apis/youtube": {}, "src/apis/youtubeAnalytics": {}, "src/apis/youtubereporting": {}, ".": {}, - "src/apis/ids": {}, - "src/apis/places": {}, - "src/apis/vpcaccess": {}, - "src/apis/privateca": {}, - "src/apis/lifesciences": {}, - "src/apis/datalabeling": {}, - "src/apis/cloudasset": {}, - "src/apis/tasks": {}, - "src/apis/datalineage": {}, - "src/apis/transcoder": {}, + "src/apis/spanner": {}, + "src/apis/texttospeech": {}, + "src/apis/networkconnectivity": {}, + "src/apis/datafusion": {}, "src/apis/clouderrorreporting": {}, - "src/apis/kmsinventory": {}, "src/apis/websecurityscanner": {}, - "src/apis/apigateway": {}, - "src/apis/analyticshub": {}, - "src/apis/notebooks": {}, - "src/apis/bigqueryconnection": {}, - "src/apis/recommender": {}, - "src/apis/analyticsadmin": {}, - "src/apis/servicedirectory": {}, - "src/apis/monitoring": {}, - "src/apis/tpu": {}, "src/apis/gkebackup": {}, + "src/apis/cloudsupport": {}, + "src/apis/domains": {}, + "src/apis/networkmanagement": {}, + "src/apis/cloudasset": {}, + "src/apis/documentai": {}, + "src/apis/webrisk": {}, + "src/apis/batch": {}, + "src/apis/cloudprofiler": {}, + "src/apis/container": {}, "src/apis/workflows": {}, - "src/apis/jobs": {}, + "src/apis/file": {}, "src/apis/containeranalysis": {}, - "src/apis/accesscontextmanager": {}, - "src/apis/datafusion": {}, - "src/apis/orgpolicy": {}, - "src/apis/documentai": {}, - "src/apis/datastream": {}, - "src/apis/composer": {}, + "src/apis/notebooks": {}, + "src/apis/analyticsdata": {}, + "src/apis/securitycenter": {}, + "src/apis/places": {}, + "src/apis/billingbudgets": {}, + "src/apis/workstations": {}, + "src/apis/migrationcenter": {}, + "src/apis/compute": {}, + "src/apis/videointelligence": {}, + "src/apis/analyticsadmin": {}, + "src/apis/cloudchannel": {}, + "src/apis/pubsub": {}, + "src/apis/essentialcontacts": {}, + "src/apis/resourcesettings": {}, + "src/apis/area120tables": {}, + "src/apis/beyondcorp": {}, + "src/apis/appengine": {}, + "src/apis/managedidentities": {}, "src/apis/assuredworkloads": {}, + "src/apis/dataform": {}, + "src/apis/dns": {}, + "src/apis/tasks": {}, + "src/apis/dataplex": {}, + "src/apis/cloudscheduler": {}, + "src/apis/iamcredentials": {}, + "src/apis/osconfig": {}, + "src/apis/certificatemanager": {}, + "src/apis/retail": {}, + "src/apis/storagetransfer": {}, + "src/apis/transcoder": {}, + "src/apis/analyticshub": {}, + "src/apis/datalabeling": {}, "src/apis/logging": {}, - "src/apis/domains": {}, - "src/apis/gkehub": {}, - "src/apis/vision": {}, + "src/apis/accesscontextmanager": {}, "src/apis/policytroubleshooter": {}, - "src/apis/dataflow": {}, - "src/apis/gameservices": {}, - "src/apis/acmedns": {}, - "src/apis/discoveryengine": {}, - "src/apis/secretmanager": {}, - "src/apis/bigquery": {}, - "src/apis/cloudfunctions": {}, - "src/apis/vmmigration": {}, - "src/apis/certificatemanager": {}, + "src/apis/binaryauthorization": {}, + "src/apis/serviceusage": {}, "src/apis/baremetalsolution": {}, - "src/apis/accessapproval": {}, - "src/apis/container": {}, - "src/apis/datamigration": {}, - "src/apis/publicca": {}, - "src/apis/batch": {}, - "src/apis/datacatalog": {}, - "src/apis/managedidentities": {}, - "src/apis/bigquerydatatransfer": {}, + "src/apis/vmmigration": {}, + "src/apis/clouddeploy": {}, + "src/apis/redis": {}, + "src/apis/recommender": {}, "src/apis/apikeys": {}, - "src/apis/dns": {}, - "src/apis/memcache": {}, - "src/apis/cloudscheduler": {}, - "src/apis/dialogflow": {}, - "src/apis/contentwarehouse": {}, - "src/apis/speech": {}, - "src/apis/contactcenterinsights": {}, - "src/apis/oslogin": {}, - "src/apis/texttospeech": {}, - "src/apis/readerrevenuesubscriptionlinking": {}, - "src/apis/compute": {}, - "src/apis/cloudtrace": {}, - "src/apis/dataplex": {}, - "src/apis/advisorynotifications": {}, + "src/apis/vmwareengine": {}, + "src/apis/rapidmigrationassessment": {}, + "src/apis/metastore": {}, + "src/apis/dataflow": {}, + "src/apis/publicca": {}, + "src/apis/translate": {}, + "src/apis/cloudbilling": {}, "src/apis/language": {}, - "src/apis/retail": {}, - "src/apis/file": {}, - "src/apis/iap": {}, + "src/apis/servicemanagement": {}, + "src/apis/memcache": {}, + "src/apis/dlp": {}, + "src/apis/vision": {}, + "src/apis/servicecontrol": {}, + "src/apis/privateca": {}, + "src/apis/bigquery": {}, "src/apis/cloudresourcemanager": {}, - "src/apis/osconfig": {}, - "src/apis/essentialcontacts": {}, - "src/apis/appengine": {}, - "src/apis/checks": {}, - "src/apis/cloudchannel": {}, - "src/apis/translate": {}, - "src/apis/bigqueryreservation": {}, + "src/apis/datastore": {}, + "src/apis/contactcenterinsights": {}, + "src/apis/datacatalog": {}, "src/apis/apigeeregistry": {}, + "src/apis/accessapproval": {}, "src/apis/eventarc": {}, - "src/apis/redis": {}, + "src/apis/cloudfunctions": {}, + "src/apis/run": {}, + "src/apis/advisorynotifications": {}, "src/apis/clouddebugger": {}, - "src/apis/servicecontrol": {}, - "src/apis/videointelligence": {}, - "src/apis/cloudbuild": {}, - "src/apis/dlp": {}, - "src/apis/networksecurity": {}, - "src/apis/binaryauthorization": {}, - "src/apis/securitycenter": {}, - "src/apis/cloudprofiler": {}, - "src/apis/dataproc": {}, - "src/apis/pubsub": {}, - "src/apis/dataform": {}, - "src/apis/servicemanagement": {}, - "src/apis/searchads360": {}, - "src/apis/firebaseappdistribution": {}, - "src/apis/billingbudgets": {}, "src/apis/cloudiot": {}, - "src/apis/area120tables": {}, - "src/apis/beyondcorp": {}, - "src/apis/networkmanagement": {}, - "src/apis/networkconnectivity": {}, - "src/apis/analyticsdata": {}, - "src/apis/spanner": {}, - "src/apis/artifactregistry": {}, - "src/apis/firestore": {}, - "src/apis/recaptchaenterprise": {}, - "src/apis/clouddeploy": {}, - "src/apis/datastore": {}, - "src/apis/integrations": {}, - "src/apis/serviceusage": {}, - "src/apis/iamcredentials": {}, - "src/apis/resourcesettings": {}, - "src/apis/storagetransfer": {}, - "src/apis/run": {}, + "src/apis/dataproc": {}, + "src/apis/datamigration": {}, + "src/apis/secretmanager": {}, + "src/apis/dialogflow": {}, + "src/apis/bigquerydatatransfer": {}, "src/apis/aiplatform": {}, - "src/apis/webrisk": {}, - "src/apis/gkeonprem": {}, - "src/apis/blockchainnodeengine": {}, - "src/apis/migrationcenter": {}, - "src/apis/contactcenteraiplatform": {}, - "src/apis/cloudbilling": {}, - "src/apis/metastore": {}, - "src/apis/rapidmigrationassessment": {}, - "src/apis/playgrouping": {}, - "src/apis/alloydb": {}, - "src/apis/backupdr": {}, - "src/apis/vmwareengine": {}, - "src/apis/biglake": {}, - "src/apis/looker": {}, + "src/apis/datalineage": {}, "src/apis/bigquerydatapolicy": {}, - "src/apis/walletobjects": {}, - "src/apis/apphub": {}, - "src/apis/dataportability": {}, - "src/apis/workspaceevents": {}, - "src/apis/marketingplatformadmin": {}, - "src/apis/solar": {}, - "src/apis/config": {}, - "src/apis/cloudcontrolspartner": {}, - "src/apis/addressvalidation": {}, - "src/apis/developerconnect": {}, - "src/apis/merchantapi": {}, - "src/apis/meet": {}, - "src/apis/pollen": {}, - "src/apis/airquality": {}, - "src/apis/apim": {} + "src/apis/apigateway": {}, + "src/apis/iap": {}, + "src/apis/jobs": {}, + "src/apis/recaptchaenterprise": {}, + "src/apis/cloudbuild": {}, + "src/apis/alloydb": {}, + "src/apis/speech": {}, + "src/apis/firestore": {}, + "src/apis/lifesciences": {}, + "src/apis/datastream": {}, + "src/apis/servicedirectory": {}, + "src/apis/vpcaccess": {}, + "src/apis/composer": {}, + "src/apis/bigqueryconnection": {}, + "src/apis/contentwarehouse": {}, + "src/apis/gkehub": {}, + "src/apis/monitoring": {}, + "src/apis/gameservices": {}, + "src/apis/artifactregistry": {}, + "src/apis/networksecurity": {}, + "src/apis/cloudtrace": {}, + "src/apis/discoveryengine": {}, + "src/apis/bigqueryreservation": {}, + "src/apis/tpu": {}, + "src/apis/ids": {}, + "src/apis/oslogin": {}, + "src/apis/orgpolicy": {} } } \ No newline at end of file diff --git a/src/apis/accesscontextmanager/v1.ts b/src/apis/accesscontextmanager/v1.ts index 8a5e9a2eec..321c39d1e3 100644 --- a/src/apis/accesscontextmanager/v1.ts +++ b/src/apis/accesscontextmanager/v1.ts @@ -401,7 +401,7 @@ export namespace accesscontextmanager_v1 { */ sourceRestriction?: string | null; /** - * Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. + * Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out. */ sources?: Schema$EgressSource[]; } @@ -423,7 +423,7 @@ export namespace accesscontextmanager_v1 { */ export interface Schema$EgressSource { /** - * An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. + * An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out. */ accessLevel?: string | null; } @@ -944,7 +944,7 @@ export namespace accesscontextmanager_v1 { */ export interface Schema$VpcNetworkSource { /** - * Sub-segment ranges of a VPC network. + * Sub-segment ranges of a VPC network. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out. */ vpcSubnetwork?: Schema$VpcSubNetwork; } diff --git a/src/apis/addressvalidation/v1.ts b/src/apis/addressvalidation/v1.ts index e26afbdc55..3c283b6eab 100644 --- a/src/apis/addressvalidation/v1.ts +++ b/src/apis/addressvalidation/v1.ts @@ -395,7 +395,7 @@ export namespace addressvalidation_v1 { */ dpvDrop?: string | null; /** - * 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 by 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. + * 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. */ dpvEnhancedDeliveryCode?: string | null; /** diff --git a/src/apis/admin/directory_v1.ts b/src/apis/admin/directory_v1.ts index fdfc77260e..165c5cd01a 100644 --- a/src/apis/admin/directory_v1.ts +++ b/src/apis/admin/directory_v1.ts @@ -13914,7 +13914,7 @@ export namespace admin_directory_v1 { } /** - * Creates a user. Mutate calls immediately following user creation might sometimes fail as the user isn't fully created due to propagation delay in our backends. Check the error details for the "User creation is not complete" message to see if this is the case. Retrying the calls after some time can help in this case. + * Creates a user. Mutate calls immediately following user creation might sometimes fail as the user isn't fully created due to propagation delay in our backends. Check the error details for the "User creation is not complete" message to see if this is the case. Retrying the calls after some time can help in this case. If `resolveConflictAccount` is set to `true`, a `202` response code means that a conflicting unmanaged account exists and was invited to join the organization. A `409` response code means that a conflicting account exists so the user wasn't created based on the [handling unmanaged user accounts](https://support.google.com/a/answer/11112794) option selected. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. diff --git a/src/apis/adsenseplatform/README.md b/src/apis/adsenseplatform/README.md new file mode 100644 index 0000000000..62808e685e --- /dev/null +++ b/src/apis/adsenseplatform/README.md @@ -0,0 +1,28 @@ +Google Inc. logo + +# adsenseplatform + +> + +## Installation + +```sh +$ npm install @googleapis/adsenseplatform +``` + +## Usage +All documentation and usage information can be found on [GitHub](https://github.com/googleapis/google-api-nodejs-client). +Information on classes can be found in [Googleapis Documentation](https://googleapis.dev/nodejs/googleapis/latest/adsenseplatform/classes/Adsenseplatform.html). + +## License +This library is licensed under Apache 2.0. Full license text is available in [LICENSE](https://github.com/googleapis/google-api-nodejs-client/blob/main/LICENSE). + +## Contributing +We love contributions! Before submitting a Pull Request, it's always good to start with a new issue first. To learn more, see [CONTRIBUTING](https://github.com/google/google-api-nodejs-client/blob/main/.github/CONTRIBUTING.md). + +## Questions/problems? +* Ask your development related questions on [StackOverflow](http://stackoverflow.com/questions/tagged/google-api-nodejs-client). +* If you've found an bug/issue, please [file it on GitHub](https://github.com/googleapis/google-api-nodejs-client/issues). + + +*Crafted with ❤️ by the Google Node.js team* diff --git a/src/apis/adsenseplatform/index.ts b/src/apis/adsenseplatform/index.ts new file mode 100644 index 0000000000..07854a94c6 --- /dev/null +++ b/src/apis/adsenseplatform/index.ts @@ -0,0 +1,48 @@ +// Copyright 2020 Google LLC +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +/*! THIS FILE IS AUTO-GENERATED */ + +import {AuthPlus, getAPI, GoogleConfigurable} from 'googleapis-common'; +import {adsenseplatform_v1alpha} from './v1alpha'; + +export const VERSIONS = { + v1alpha: adsenseplatform_v1alpha.Adsenseplatform, +}; + +export function adsenseplatform( + version: 'v1alpha' +): adsenseplatform_v1alpha.Adsenseplatform; +export function adsenseplatform( + options: adsenseplatform_v1alpha.Options +): adsenseplatform_v1alpha.Adsenseplatform; +export function adsenseplatform( + this: GoogleConfigurable, + versionOrOptions: 'v1alpha' | adsenseplatform_v1alpha.Options +) { + return getAPI('adsenseplatform', versionOrOptions, VERSIONS, this); +} + +const auth = new AuthPlus(); +export {auth}; +export {adsenseplatform_v1alpha}; +export { + AuthPlus, + GlobalOptions, + APIRequestContext, + GoogleConfigurable, + StreamMethodOptions, + GaxiosPromise, + MethodOptions, + BodyResponseCallback, +} from 'googleapis-common'; diff --git a/src/apis/adsenseplatform/package.json b/src/apis/adsenseplatform/package.json new file mode 100644 index 0000000000..a7a05a26fd --- /dev/null +++ b/src/apis/adsenseplatform/package.json @@ -0,0 +1,43 @@ +{ + "name": "@googleapis/adsenseplatform", + "version": "0.1.0", + "description": "adsenseplatform", + "main": "build/index.js", + "types": "build/index.d.ts", + "keywords": [ + "google" + ], + "author": "Google LLC", + "license": "Apache-2.0", + "homepage": "https://github.com/googleapis/google-api-nodejs-client", + "bugs": { + "url": "https://github.com/googleapis/google-api-nodejs-client/issues" + }, + "repository": { + "type": "git", + "url": "https://github.com/googleapis/google-api-nodejs-client.git" + }, + "engines": { + "node": ">=12.0.0" + }, + "scripts": { + "fix": "gts fix", + "lint": "gts check", + "compile": "tsc -p .", + "prepare": "npm run compile", + "webpack": "webpack" + }, + "dependencies": { + "googleapis-common": "^7.0.0" + }, + "devDependencies": { + "@microsoft/api-documenter": "^7.8.10", + "@microsoft/api-extractor": "^7.8.10", + "gts": "^5.0.0", + "null-loader": "^4.0.0", + "ts-loader": "^9.0.0", + "typescript": "~4.8.4", + "webpack": "^5.0.0", + "webpack-cli": "^5.0.0" + } +} diff --git a/src/apis/adsenseplatform/tsconfig.json b/src/apis/adsenseplatform/tsconfig.json new file mode 100644 index 0000000000..e081090496 --- /dev/null +++ b/src/apis/adsenseplatform/tsconfig.json @@ -0,0 +1,10 @@ +{ + "extends": "./node_modules/gts/tsconfig-google.json", + "compilerOptions": { + "rootDir": ".", + "outDir": "build" + }, + "include": [ + "*.ts", + ] +} diff --git a/src/apis/adsenseplatform/v1alpha.ts b/src/apis/adsenseplatform/v1alpha.ts new file mode 100644 index 0000000000..273ecdcdda --- /dev/null +++ b/src/apis/adsenseplatform/v1alpha.ts @@ -0,0 +1,1465 @@ +// Copyright 2020 Google LLC +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +/* eslint-disable @typescript-eslint/no-explicit-any */ +/* eslint-disable @typescript-eslint/no-unused-vars */ +/* eslint-disable @typescript-eslint/no-empty-interface */ +/* eslint-disable @typescript-eslint/no-namespace */ +/* eslint-disable no-irregular-whitespace */ + +import { + OAuth2Client, + JWT, + Compute, + UserRefreshClient, + BaseExternalAccountClient, + GaxiosPromise, + GoogleConfigurable, + createAPIRequest, + MethodOptions, + StreamMethodOptions, + GlobalOptions, + GoogleAuth, + BodyResponseCallback, + APIRequestContext, +} from 'googleapis-common'; +import {Readable} from 'stream'; + +export namespace adsenseplatform_v1alpha { + export interface Options extends GlobalOptions { + version: 'v1alpha'; + } + + interface StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: + | string + | OAuth2Client + | JWT + | Compute + | UserRefreshClient + | BaseExternalAccountClient + | GoogleAuth; + + /** + * V1 error format. + */ + '$.xgafv'?: string; + /** + * OAuth access token. + */ + access_token?: string; + /** + * Data format for response. + */ + alt?: string; + /** + * JSONP + */ + callback?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * 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. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * 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. + */ + quotaUser?: string; + /** + * Legacy upload protocol for media (e.g. "media", "multipart"). + */ + uploadType?: string; + /** + * Upload protocol for media (e.g. "raw", "multipart"). + */ + upload_protocol?: string; + } + + /** + * AdSense Platform API + * + * + * + * @example + * ```js + * const {google} = require('googleapis'); + * const adsenseplatform = google.adsenseplatform('v1alpha'); + * ``` + */ + export class Adsenseplatform { + context: APIRequestContext; + platforms: Resource$Platforms; + + constructor(options: GlobalOptions, google?: GoogleConfigurable) { + this.context = { + _options: options || {}, + google, + }; + + this.platforms = new Resource$Platforms(this.context); + } + } + + /** + * Representation of an Account. + */ + export interface Schema$Account { + /** + * Output only. Creation time of the account. + */ + createTime?: string | null; + /** + * Required. An opaque token that uniquely identifies the account among all the platform's accounts. This string may contain at most 64 non-whitespace ASCII characters, but otherwise has no predefined structure. However, it is expected to be a platform-specific identifier for the user creating the account, so that only a single account can be created for any given user. This field must not contain any information that is recognizable as personally identifiable information. e.g. it should not be an email address or login name. Once an account has been created, a second attempt to create an account using the same creation_request_id will result in an ALREADY_EXISTS error. + */ + creationRequestId?: string | null; + /** + * Display name of this account. + */ + displayName?: string | null; + /** + * Output only. Resource name of the account. Format: platforms/pub-[0-9]+/accounts/pub-[0-9]+ + */ + name?: string | null; + /** + * Required. Input only. CLDR region code of the country/region of the address. Set this to country code of the child account if known, otherwise to your own country code. + */ + regionCode?: string | null; + /** + * Output only. Approval state of the account. + */ + state?: string | null; + /** + * Required. The IANA TZ timezone code of this account. For more information, see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones. This field is used for reporting. It is recommended to set it to the same value for all child accounts. + */ + timeZone?: Schema$TimeZone; + } + /** + * Address data. + */ + export interface Schema$Address { + /** + * First line of address. Max length 64 bytes or 30 characters. + */ + address1?: string | null; + /** + * Second line of address. Max length 64 bytes or 30 characters. + */ + address2?: string | null; + /** + * City. Max length 60 bytes or 30 characters. + */ + city?: string | null; + /** + * Name of the company. Max length 255 bytes or 34 characters. + */ + company?: string | null; + /** + * Contact name of the company. Max length 128 bytes or 34 characters. + */ + contact?: string | null; + /** + * Fax number with international code (i.e. +441234567890). + */ + fax?: string | null; + /** + * Phone number with international code (i.e. +441234567890). + */ + phone?: string | null; + /** + * Country/Region code. The region is specified as a CLDR region code (e.g. "US", "FR"). + */ + regionCode?: string | null; + /** + * State. Max length 60 bytes or 30 characters. + */ + state?: string | null; + /** + * Zip/post code. Max length 10 bytes or 10 characters. + */ + zip?: string | null; + } + /** + * Request definition for the account close rpc. + */ + export interface Schema$CloseAccountRequest {} + /** + * Response definition for the account close rpc. + */ + export interface Schema$CloseAccountResponse {} + /** + * 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); \} + */ + export interface Schema$Empty {} + /** + * A platform sub-account event to record spam signals. + */ + export interface Schema$Event { + /** + * Required. Information associated with the event. + */ + eventInfo?: Schema$EventInfo; + /** + * Required. Event timestamp. + */ + eventTime?: string | null; + /** + * Required. Event type. + */ + eventType?: string | null; + } + /** + * Private information for partner recorded events (PII). + */ + export interface Schema$EventInfo { + /** + * The billing address of the publisher associated with this event, if available. + */ + billingAddress?: Schema$Address; + /** + * Required. The email address that is associated with the publisher when performing the event. + */ + email?: string | null; + } + /** + * Response definition for the list accounts rpc. + */ + export interface Schema$ListAccountsResponse { + /** + * The Accounts returned in the list response. Represented by a partial view of the Account resource, populating `name` and `creation_request_id`. + */ + accounts?: Schema$Account[]; + /** + * Continuation token used to page through accounts. To retrieve the next page of the results, set the next request's "page_token" value to this. + */ + nextPageToken?: string | null; + } + /** + * Response definition for the site list rpc. + */ + export interface Schema$ListSitesResponse { + /** + * Continuation token used to page through sites. To retrieve the next page of the results, set the next request's "page_token" value to this. + */ + nextPageToken?: string | null; + /** + * The sites returned in this list response. + */ + sites?: Schema$Site[]; + } + /** + * Response definition for the lookup account rpc. + */ + export interface Schema$LookupAccountResponse { + /** + * The name of the Account Format: platforms/{platform\}/accounts/{account_id\} + */ + name?: string | null; + } + /** + * Response definition for the site request review rpc. + */ + export interface Schema$RequestSiteReviewResponse {} + /** + * Representation of a Site. + */ + export interface Schema$Site { + /** + * Domain/sub-domain of the site. Must be a valid domain complying with [RFC 1035](https://www.ietf.org/rfc/rfc1035.txt) and formatted as punycode [RFC 3492](https://www.ietf.org/rfc/rfc3492.txt) in case the domain contains unicode characters. + */ + domain?: string | null; + /** + * Output only. Resource name of a site. Format: platforms/{platform\}/accounts/{account\}/sites/{site\} + */ + name?: string | null; + /** + * Output only. State of a site. + */ + state?: string | null; + } + /** + * Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). + */ + export interface Schema$TimeZone { + /** + * IANA Time Zone Database time zone, e.g. "America/New_York". + */ + id?: string | null; + /** + * Optional. IANA Time Zone Database version number, e.g. "2019a". + */ + version?: string | null; + } + + export class Resource$Platforms { + context: APIRequestContext; + accounts: Resource$Platforms$Accounts; + constructor(context: APIRequestContext) { + this.context = context; + this.accounts = new Resource$Platforms$Accounts(this.context); + } + } + + export class Resource$Platforms$Accounts { + context: APIRequestContext; + events: Resource$Platforms$Accounts$Events; + sites: Resource$Platforms$Accounts$Sites; + constructor(context: APIRequestContext) { + this.context = context; + this.events = new Resource$Platforms$Accounts$Events(this.context); + this.sites = new Resource$Platforms$Accounts$Sites(this.context); + } + + /** + * Closes a sub-account. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + close( + params: Params$Resource$Platforms$Accounts$Close, + options: StreamMethodOptions + ): GaxiosPromise; + close( + params?: Params$Resource$Platforms$Accounts$Close, + options?: MethodOptions + ): GaxiosPromise; + close( + params: Params$Resource$Platforms$Accounts$Close, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + close( + params: Params$Resource$Platforms$Accounts$Close, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + close( + params: Params$Resource$Platforms$Accounts$Close, + callback: BodyResponseCallback + ): void; + close(callback: BodyResponseCallback): void; + close( + paramsOrCallback?: + | Params$Resource$Platforms$Accounts$Close + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Platforms$Accounts$Close; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Platforms$Accounts$Close; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://adsenseplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}:close').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Creates a sub-account. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + create( + params: Params$Resource$Platforms$Accounts$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Platforms$Accounts$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Platforms$Accounts$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Platforms$Accounts$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Platforms$Accounts$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Platforms$Accounts$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Platforms$Accounts$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Platforms$Accounts$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://adsenseplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+parent}/accounts').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets information about the selected sub-account. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Platforms$Accounts$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Platforms$Accounts$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Platforms$Accounts$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Platforms$Accounts$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Platforms$Accounts$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Platforms$Accounts$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Platforms$Accounts$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Platforms$Accounts$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://adsenseplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists a partial view of sub-accounts for a specific parent account. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Platforms$Accounts$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Platforms$Accounts$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Platforms$Accounts$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Platforms$Accounts$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Platforms$Accounts$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Platforms$Accounts$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Platforms$Accounts$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Platforms$Accounts$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://adsenseplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+parent}/accounts').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Looks up information about a sub-account for a specified creation_request_id. If no account exists for the given creation_request_id, returns 404. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + lookup( + params: Params$Resource$Platforms$Accounts$Lookup, + options: StreamMethodOptions + ): GaxiosPromise; + lookup( + params?: Params$Resource$Platforms$Accounts$Lookup, + options?: MethodOptions + ): GaxiosPromise; + lookup( + params: Params$Resource$Platforms$Accounts$Lookup, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + lookup( + params: Params$Resource$Platforms$Accounts$Lookup, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + lookup( + params: Params$Resource$Platforms$Accounts$Lookup, + callback: BodyResponseCallback + ): void; + lookup(callback: BodyResponseCallback): void; + lookup( + paramsOrCallback?: + | Params$Resource$Platforms$Accounts$Lookup + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Platforms$Accounts$Lookup; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Platforms$Accounts$Lookup; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://adsenseplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+parent}/accounts:lookup').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Platforms$Accounts$Close + extends StandardParameters { + /** + * Required. Account to close. Format: platforms/{platform\}/accounts/{account_id\} + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$CloseAccountRequest; + } + export interface Params$Resource$Platforms$Accounts$Create + extends StandardParameters { + /** + * Required. Platform to create an account for. Format: platforms/{platform\} + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Account; + } + export interface Params$Resource$Platforms$Accounts$Get + extends StandardParameters { + /** + * Required. Account to get information about. Format: platforms/{platform\}/accounts/{account_id\} + */ + name?: string; + } + export interface Params$Resource$Platforms$Accounts$List + extends StandardParameters { + /** + * Optional. The maximum number of accounts to include in the response, used for paging. If unspecified, at most 10000 accounts will be returned. The maximum value is 10000; values above 10000 will be coerced to 10000. + */ + pageSize?: number; + /** + * Optional. A page token, received from a previous `ListAccounts` call. Provide this to retrieve the subsequent page. + */ + pageToken?: string; + /** + * Required. Platform who parents the accounts. Format: platforms/{platform\} + */ + parent?: string; + } + export interface Params$Resource$Platforms$Accounts$Lookup + extends StandardParameters { + /** + * Optional. The creation_request_id provided when calling createAccount. + */ + creationRequestId?: string; + /** + * Required. Platform who parents the account. Format: platforms/{platform\} + */ + parent?: string; + } + + export class Resource$Platforms$Accounts$Events { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Creates an account event. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + create( + params: Params$Resource$Platforms$Accounts$Events$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Platforms$Accounts$Events$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Platforms$Accounts$Events$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Platforms$Accounts$Events$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Platforms$Accounts$Events$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Platforms$Accounts$Events$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Platforms$Accounts$Events$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Platforms$Accounts$Events$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://adsenseplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+parent}/events').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Platforms$Accounts$Events$Create + extends StandardParameters { + /** + * Required. Account to log events about. Format: platforms/{platform\}/accounts/{account\} + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Event; + } + + export class Resource$Platforms$Accounts$Sites { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Creates a site for a specified account. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + create( + params: Params$Resource$Platforms$Accounts$Sites$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Platforms$Accounts$Sites$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Platforms$Accounts$Sites$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Platforms$Accounts$Sites$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Platforms$Accounts$Sites$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Platforms$Accounts$Sites$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Platforms$Accounts$Sites$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Platforms$Accounts$Sites$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://adsenseplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+parent}/sites').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Deletes a site from a specified account. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Platforms$Accounts$Sites$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Platforms$Accounts$Sites$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Platforms$Accounts$Sites$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Platforms$Accounts$Sites$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Platforms$Accounts$Sites$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Platforms$Accounts$Sites$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Platforms$Accounts$Sites$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Platforms$Accounts$Sites$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://adsenseplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets a site from a specified sub-account. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Platforms$Accounts$Sites$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Platforms$Accounts$Sites$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Platforms$Accounts$Sites$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Platforms$Accounts$Sites$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Platforms$Accounts$Sites$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Platforms$Accounts$Sites$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Platforms$Accounts$Sites$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Platforms$Accounts$Sites$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://adsenseplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists sites for a specific account. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Platforms$Accounts$Sites$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Platforms$Accounts$Sites$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Platforms$Accounts$Sites$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Platforms$Accounts$Sites$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Platforms$Accounts$Sites$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Platforms$Accounts$Sites$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Platforms$Accounts$Sites$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Platforms$Accounts$Sites$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://adsenseplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+parent}/sites').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Requests the review of a site. The site should be in REQUIRES_REVIEW or NEEDS_ATTENTION state. Note: Make sure you place an [ad tag](https://developers.google.com/adsense/platforms/direct/ad-tags) on your site before requesting a review. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + requestReview( + params: Params$Resource$Platforms$Accounts$Sites$Requestreview, + options: StreamMethodOptions + ): GaxiosPromise; + requestReview( + params?: Params$Resource$Platforms$Accounts$Sites$Requestreview, + options?: MethodOptions + ): GaxiosPromise; + requestReview( + params: Params$Resource$Platforms$Accounts$Sites$Requestreview, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + requestReview( + params: Params$Resource$Platforms$Accounts$Sites$Requestreview, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + requestReview( + params: Params$Resource$Platforms$Accounts$Sites$Requestreview, + callback: BodyResponseCallback + ): void; + requestReview( + callback: BodyResponseCallback + ): void; + requestReview( + paramsOrCallback?: + | Params$Resource$Platforms$Accounts$Sites$Requestreview + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Platforms$Accounts$Sites$Requestreview; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Platforms$Accounts$Sites$Requestreview; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://adsenseplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}:requestReview').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Platforms$Accounts$Sites$Create + extends StandardParameters { + /** + * Required. Account to create site. Format: platforms/{platform\}/accounts/{account_id\} + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Site; + } + export interface Params$Resource$Platforms$Accounts$Sites$Delete + extends StandardParameters { + /** + * Required. The name of the site to delete. Format: platforms/{platform\}/accounts/{account\}/sites/{site\} + */ + name?: string; + } + export interface Params$Resource$Platforms$Accounts$Sites$Get + extends StandardParameters { + /** + * Required. The name of the site to retrieve. Format: platforms/{platform\}/accounts/{account\}/sites/{site\} + */ + name?: string; + } + export interface Params$Resource$Platforms$Accounts$Sites$List + extends StandardParameters { + /** + * The maximum number of sites to include in the response, used for paging. If unspecified, at most 10000 sites will be returned. The maximum value is 10000; values above 10000 will be coerced to 10000. + */ + pageSize?: number; + /** + * A page token, received from a previous `ListSites` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListSites` must match the call that provided the page token. + */ + pageToken?: string; + /** + * Required. The account which owns the sites. Format: platforms/{platform\}/accounts/{account\} + */ + parent?: string; + } + export interface Params$Resource$Platforms$Accounts$Sites$Requestreview + extends StandardParameters { + /** + * Required. The name of the site to submit for review. Format: platforms/{platform\}/accounts/{account\}/sites/{site\} + */ + name?: string; + } +} diff --git a/src/apis/adsenseplatform/webpack.config.js b/src/apis/adsenseplatform/webpack.config.js new file mode 100644 index 0000000000..f643dae195 --- /dev/null +++ b/src/apis/adsenseplatform/webpack.config.js @@ -0,0 +1,79 @@ +// Copyright 2019 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +// Use `npm run webpack` to produce Webpack bundle for this library. + +const path = require('path'); + +module.exports = { + entry: './index.ts', + resolve: { + extensions: ['.ts', '.js', '.json'], + fallback: { + crypto: false, + child_process: false, + fs: false, + http2: false, + buffer: 'browserify', + process: false, + os: false, + querystring: false, + path: false, + stream: 'stream-browserify', + url: false, + util: false, + zlib: false, + }, + }, + output: { + library: 'Adsenseplatform', + filename: 'adsenseplatform.min.js', + path: path.resolve(__dirname, 'dist'), + }, + module: { + rules: [ + { + test: /node_modules[\\/]google-auth-library[\\/]src[\\/]crypto[\\/]node[\\/]crypto/, + use: 'null-loader', + }, + { + test: /node_modules[\\/]https-proxy-agent[\\/]/, + use: 'null-loader', + }, + { + test: /node_modules[\\/]gcp-metadata[\\/]/, + use: 'null-loader', + }, + { + test: /node_modules[\\/]gtoken[\\/]/, + use: 'null-loader', + }, + { + test: /node_modules[\\/]pkginfo[\\/]/, + use: 'null-loader', + }, + { + test: /node_modules[\\/]semver[\\/]/, + use: 'null-loader', + }, + { + test: /\.ts$/, + use: 'ts-loader', + exclude: /node_modules/, + }, + ], + }, + mode: 'production', + plugins: [], +}; diff --git a/src/apis/aiplatform/v1.ts b/src/apis/aiplatform/v1.ts index a284d57744..b67bd55fbb 100644 --- a/src/apis/aiplatform/v1.ts +++ b/src/apis/aiplatform/v1.ts @@ -127,7 +127,7 @@ export namespace aiplatform_v1 { } /** - * Generate video response. + * Next ID: 8 Generate video response. */ export interface Schema$CloudAiLargeModelsVisionGenerateVideoResponse { /** @@ -1140,7 +1140,12 @@ export namespace aiplatform_v1 { /** * Spec for bleu score metric - calculates the precision of n-grams in the prediction as compared to reference - returns a score ranging between 0 to 1. */ - export interface Schema$GoogleCloudAiplatformV1BleuSpec {} + export interface Schema$GoogleCloudAiplatformV1BleuSpec { + /** + * Optional. Whether to use_effective_order to compute bleu score. + */ + useEffectiveOrder?: boolean | null; + } /** * Content blob. It's preferred to send as text directly rather than raw bytes. */ @@ -1236,6 +1241,10 @@ export namespace aiplatform_v1 { * Output only. List of ratings for the safety of a response candidate. There is at most one rating per category. */ safetyRatings?: Schema$GoogleCloudAiplatformV1SafetyRating[]; + /** + * Output only. Confidence score of the candidate. + */ + score?: number | null; } /** * This message will be placed in the metadata field of a google.longrunning.Operation associated with a CheckTrialEarlyStoppingState request. @@ -1396,9 +1405,17 @@ export namespace aiplatform_v1 { */ export interface Schema$GoogleCloudAiplatformV1ComputeTokensRequest { /** - * Required. The instances that are the input to token computing API call. Schema is identical to the prediction schema of the text model, even for the non-text models, like chat models, or Codey models. + * Optional. Input content. + */ + contents?: Schema$GoogleCloudAiplatformV1Content[]; + /** + * Optional. The instances that are the input to token computing API call. Schema is identical to the prediction schema of the text model, even for the non-text models, like chat models, or Codey models. */ instances?: any[] | null; + /** + * Optional. The name of the publisher model requested to serve the prediction. Format: projects/{project\}/locations/{location\}/publishers/x/models/x + */ + model?: string | null; } /** * Response message for ComputeTokens RPC call. @@ -1549,17 +1566,25 @@ export namespace aiplatform_v1 { */ export interface Schema$GoogleCloudAiplatformV1CountTokensRequest { /** - * Required. Input content. + * Optional. Input content. */ contents?: Schema$GoogleCloudAiplatformV1Content[]; /** - * Required. The instances that are the input to token counting call. Schema is identical to the prediction schema of the underlying model. + * Optional. The instances that are the input to token counting call. Schema is identical to the prediction schema of the underlying model. */ instances?: any[] | null; /** - * Required. The name of the publisher model requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/publishers/x/models/x` + * Optional. The name of the publisher model requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/publishers/x/models/x` */ model?: string | null; + /** + * Optional. The user provided system instructions for the model. Note: only text should be used in parts and content in each part will be in a separate paragraph. + */ + systemInstruction?: Schema$GoogleCloudAiplatformV1Content; + /** + * Optional. A list of `Tools` the model may use to generate the next 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. + */ + tools?: Schema$GoogleCloudAiplatformV1Tool[]; } /** * Response message for PredictionService.CountTokens. @@ -1725,6 +1750,19 @@ export namespace aiplatform_v1 { */ genericMetadata?: Schema$GoogleCloudAiplatformV1GenericOperationMetadata; } + /** + * Metadata information for NotebookService.CreateNotebookExecutionJob. + */ + export interface Schema$GoogleCloudAiplatformV1CreateNotebookExecutionJobOperationMetadata { + /** + * The operation generic information. + */ + genericMetadata?: Schema$GoogleCloudAiplatformV1GenericOperationMetadata; + /** + * A human-readable message that shows the intermediate progress details of NotebookRuntime. + */ + progressMessage?: string | null; + } /** * Metadata information for NotebookService.CreateNotebookRuntimeTemplate. */ @@ -3974,10 +4012,18 @@ export namespace aiplatform_v1 { * The dedicated serving endpoint for this FeatureOnlineStore. Only need to set when you choose Optimized storage type. Public endpoint is provisioned by default. */ export interface Schema$GoogleCloudAiplatformV1FeatureOnlineStoreDedicatedServingEndpoint { + /** + * Optional. Private service connect config. The private service connection is available only for Optimized storage type, not for embedding management now. If PrivateServiceConnectConfig.enable_private_service_connect set to true, customers will use private service connection to send request. Otherwise, the connection will set to public endpoint. + */ + privateServiceConnectConfig?: Schema$GoogleCloudAiplatformV1PrivateServiceConnectConfig; /** * Output only. This field will be populated with the domain name to use for this FeatureOnlineStore */ publicEndpointDomainName?: string | null; + /** + * Output only. The name of the service attachment resource. Populated if private service connect is enabled and after FeatureViewSync is created. + */ + serviceAttachment?: string | null; } /** * Optimized storage type @@ -5003,10 +5049,57 @@ export namespace aiplatform_v1 { */ version?: number | null; } + /** + * Grounding chunk. + */ + export interface Schema$GoogleCloudAiplatformV1GroundingChunk { + /** + * Grounding chunk from context retrieved by the retrieval tools. + */ + retrievedContext?: Schema$GoogleCloudAiplatformV1GroundingChunkRetrievedContext; + /** + * Grounding chunk from the web. + */ + web?: Schema$GoogleCloudAiplatformV1GroundingChunkWeb; + } + /** + * Chunk from context retrieved by the retrieval tools. + */ + export interface Schema$GoogleCloudAiplatformV1GroundingChunkRetrievedContext { + /** + * Title of the attribution. + */ + title?: string | null; + /** + * URI reference of the attribution. + */ + uri?: string | null; + } + /** + * Chunk from the web. + */ + export interface Schema$GoogleCloudAiplatformV1GroundingChunkWeb { + /** + * Title of the chunk. + */ + title?: string | null; + /** + * URI reference of the chunk. + */ + uri?: string | null; + } /** * Metadata returned to client when grounding is enabled. */ export interface Schema$GoogleCloudAiplatformV1GroundingMetadata { + /** + * List of supporting references retrieved from specified grounding source. + */ + groundingChunks?: Schema$GoogleCloudAiplatformV1GroundingChunk[]; + /** + * Optional. List of grounding support. + */ + groundingSupports?: Schema$GoogleCloudAiplatformV1GroundingSupport[]; /** * Optional. Google search entry for the following-up web searches. */ @@ -5016,6 +5109,23 @@ export namespace aiplatform_v1 { */ webSearchQueries?: string[] | null; } + /** + * Grounding support. + */ + export interface Schema$GoogleCloudAiplatformV1GroundingSupport { + /** + * 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. + */ + confidenceScores?: number[] | null; + /** + * A list of indices (into 'grounding_chunk') specifying the citations associated with the claim. For instance [1,3,4] means that grounding_chunk[1], grounding_chunk[3], grounding_chunk[4] are the retrieved content attributed to the claim. + */ + groundingChunkIndices?: number[] | null; + /** + * Segment of the content this support belongs to. + */ + segment?: Schema$GoogleCloudAiplatformV1Segment; + } /** * Represents a HyperparameterTuningJob. A HyperparameterTuningJob has a Study specification and multiple CustomJobs with identical CustomJob specification. */ @@ -6002,6 +6112,19 @@ export namespace aiplatform_v1 { */ nextPageToken?: string | null; } + /** + * Response message for [NotebookService.CreateNotebookExecutionJob] + */ + export interface Schema$GoogleCloudAiplatformV1ListNotebookExecutionJobsResponse { + /** + * A token to retrieve next page of results. Pass to ListNotebookExecutionJobs.page_token to obtain that page. + */ + nextPageToken?: string | null; + /** + * List of NotebookExecutionJobs in the requested page. + */ + notebookExecutionJobs?: Schema$GoogleCloudAiplatformV1NotebookExecutionJob[]; + } /** * Response message for NotebookService.ListNotebookRuntimes. */ @@ -6654,6 +6777,14 @@ export namespace aiplatform_v1 { * The schemata that describe formats of the Model's predictions and explanations as given and returned via PredictionService.Predict and PredictionService.Explain. */ predictSchemata?: Schema$GoogleCloudAiplatformV1PredictSchemata; + /** + * Output only. Reserved for future use. + */ + satisfiesPzi?: boolean | null; + /** + * Output only. Reserved for future use. + */ + satisfiesPzs?: boolean | null; /** * Output only. When this Model is deployed, its prediction resources are described by the `prediction_resources` field of the Endpoint.deployed_models object. Because not all Models support all resource configuration types, the configuration types this Model supports are listed here. If no configuration types are listed, the Model cannot be deployed to an Endpoint and does not support online predictions (PredictionService.Predict or PredictionService.Explain). Such a Model can serve predictions by using a BatchPredictionJob, if it has at least one entry each in supported_input_storage_formats and supported_output_storage_formats. */ @@ -7837,6 +7968,110 @@ export namespace aiplatform_v1 { */ eucDisabled?: boolean | null; } + /** + * NotebookExecutionJob represents an instance of a notebook execution. + */ + export interface Schema$GoogleCloudAiplatformV1NotebookExecutionJob { + /** + * Output only. Timestamp when this NotebookExecutionJob was created. + */ + createTime?: string | null; + /** + * The Dataform Repository pointing to a single file notebook repository. + */ + dataformRepositorySource?: Schema$GoogleCloudAiplatformV1NotebookExecutionJobDataformRepositorySource; + /** + * The contents of an input notebook file. + */ + directNotebookSource?: Schema$GoogleCloudAiplatformV1NotebookExecutionJobDirectNotebookSource; + /** + * The display name of the NotebookExecutionJob. The name can be up to 128 characters long and can consist of any UTF-8 characters. + */ + displayName?: string | null; + /** + * Max running time of the execution job in seconds (default 86400s / 24 hrs). + */ + executionTimeout?: string | null; + /** + * The user email to run the execution as. Only supported by Colab runtimes. + */ + executionUser?: string | null; + /** + * The Cloud Storage url pointing to the ipynb file. Format: `gs://bucket/notebook_file.ipynb` + */ + gcsNotebookSource?: Schema$GoogleCloudAiplatformV1NotebookExecutionJobGcsNotebookSource; + /** + * The Cloud Storage location to upload the result to. Format: `gs://bucket-name` + */ + gcsOutputUri?: string | null; + /** + * Output only. The state of the NotebookExecutionJob. + */ + jobState?: string | null; + /** + * The labels with user-defined metadata to organize NotebookExecutionJobs. 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. + */ + labels?: {[key: string]: string} | null; + /** + * Output only. The resource name of this NotebookExecutionJob. Format: `projects/{project_id\}/locations/{location\}/notebookExecutionJobs/{job_id\}` + */ + name?: string | null; + /** + * The NotebookRuntimeTemplate to source compute configuration from. + */ + notebookRuntimeTemplateResourceName?: string | null; + /** + * Output only. The Schedule resource name if this job is triggered by one. Format: `projects/{project_id\}/locations/{location\}/schedules/{schedule_id\}` + */ + scheduleResourceName?: string | null; + /** + * The service account to run the execution as. + */ + serviceAccount?: string | null; + /** + * Output only. Populated when the NotebookExecutionJob is completed. When there is an error during notebook execution, the error details are populated. + */ + status?: Schema$GoogleRpcStatus; + /** + * Output only. Timestamp when this NotebookExecutionJob was most recently updated. + */ + updateTime?: string | null; + } + /** + * The Dataform Repository containing the input notebook. + */ + export interface Schema$GoogleCloudAiplatformV1NotebookExecutionJobDataformRepositorySource { + /** + * The commit SHA to read repository with. If unset, the file will be read at HEAD. + */ + commitSha?: string | null; + /** + * The resource name of the Dataform Repository. Format: `projects/{project_id\}/locations/{location\}/repositories/{repository_id\}` + */ + dataformRepositoryResourceName?: string | null; + } + /** + * The content of the input notebook in ipynb format. + */ + export interface Schema$GoogleCloudAiplatformV1NotebookExecutionJobDirectNotebookSource { + /** + * The base64-encoded contents of the input notebook file. + */ + content?: string | null; + } + /** + * The Cloud Storage uri for the input notebook. + */ + export interface Schema$GoogleCloudAiplatformV1NotebookExecutionJobGcsNotebookSource { + /** + * The version of the Cloud Storage object to read. If unset, the current version of the object is read. See https://cloud.google.com/storage/docs/metadata#generation-number. + */ + generation?: string | null; + /** + * The Cloud Storage uri pointing to the ipynb file. Format: `gs://bucket/notebook_file.ipynb` + */ + uri?: string | null; + } /** * The idle shutdown configuration of NotebookRuntimeTemplate, which contains the idle_timeout as required field. */ @@ -8861,6 +9096,10 @@ export namespace aiplatform_v1 { * A description of resources that are dedicated to the DeployedModel, and that need a higher degree of manual configuration. */ dedicatedResources?: Schema$GoogleCloudAiplatformV1DedicatedResources; + /** + * Optional. Metadata information about this deployment config. + */ + deployMetadata?: Schema$GoogleCloudAiplatformV1PublisherModelCallToActionDeployDeployMetadata; /** * Optional. The name of the deploy task (e.g., "text to image generation"). */ @@ -8886,6 +9125,15 @@ export namespace aiplatform_v1 { */ title?: string | null; } + /** + * Metadata information about the deployment for managing deployment config. + */ + export interface Schema$GoogleCloudAiplatformV1PublisherModelCallToActionDeployDeployMetadata { + /** + * Optional. Labels for the deployment. For managing deployment config like verifying, source of deployment config, etc. + */ + labels?: {[key: string]: string} | null; + } /** * Configurations for PublisherModel GKE deployment */ @@ -9409,6 +9657,15 @@ export namespace aiplatform_v1 { */ httpBody?: Schema$GoogleApiHttpBody; } + /** + * Configuration for the Ray OSS Logs. + */ + export interface Schema$GoogleCloudAiplatformV1RayLogsSpec { + /** + * Optional. Flag to disable the export of Ray OSS logs to Cloud Logging. + */ + disabled?: boolean | null; + } /** * Configuration for the Ray metrics. */ @@ -9430,6 +9687,10 @@ export namespace aiplatform_v1 { * Optional. Default image for user to choose a preferred ML framework (for example, TensorFlow or Pytorch) by choosing from [Vertex prebuilt images](https://cloud.google.com/vertex-ai/docs/training/pre-built-containers). Either this or the resource_pool_images is required. Use this field if you need all the resource pools to have the same Ray image. Otherwise, use the {@code resource_pool_images\} field. */ imageUri?: string | null; + /** + * Optional. OSS Ray logging configurations. + */ + rayLogsSpec?: Schema$GoogleCloudAiplatformV1RayLogsSpec; /** * Optional. Ray metrics configurations. */ @@ -9645,7 +9906,7 @@ export namespace aiplatform_v1 { */ export interface Schema$GoogleCloudAiplatformV1ResourcePool { /** - * Optional. Optional spec to configure GKE autoscaling + * Optional. Optional spec to configure GKE or Ray-on-Vertex autoscaling */ autoscalingSpec?: Schema$GoogleCloudAiplatformV1ResourcePoolAutoscalingSpec; /** @@ -9678,7 +9939,7 @@ export namespace aiplatform_v1 { */ maxReplicaCount?: string | null; /** - * Optional. min replicas in the node pool, must be ≤ replica_count and < max_replica_count or will throw error + * Optional. min replicas in the node pool, must be ≤ replica_count and < max_replica_count or will throw error. For autoscaling enabled Ray-on-Vertex, we allow min_replica_count of a resource_pool to be 0 to match the OSS Ray behavior(https://docs.ray.io/en/latest/cluster/vms/user-guides/configuring-autoscaling.html#cluster-config-parameters). As for Persistent Resource, the min_replica_count must be \> 0, we added a corresponding validation inside CreatePersistentResourceRequestValidator.java. */ minReplicaCount?: string | null; } @@ -12945,6 +13206,27 @@ export namespace aiplatform_v1 { */ nearestNeighbors?: Schema$GoogleCloudAiplatformV1NearestNeighbors; } + /** + * Segment of the content. + */ + export interface Schema$GoogleCloudAiplatformV1Segment { + /** + * Output only. End index in the given Part, measured in bytes. Offset from the start of the Part, exclusive, starting at zero. + */ + endIndex?: number | null; + /** + * Output only. The index of a Part object within its parent Content object. + */ + partIndex?: number | null; + /** + * Output only. Start index in the given Part, measured in bytes. Offset from the start of the Part, inclusive, starting at zero. + */ + startIndex?: number | null; + /** + * Output only. The text corresponding to the segment from the response. + */ + text?: string | null; + } /** * Configuration for the use of custom service account to run the workloads. */ @@ -13732,6 +14014,10 @@ export namespace aiplatform_v1 { * Dataset distribution for Supervised Tuning. */ export interface Schema$GoogleCloudAiplatformV1SupervisedTuningDatasetDistribution { + /** + * Output only. Sum of a given population of values that are billable. + */ + billableSum?: string | null; /** * Output only. Defines the histogram bucket. */ @@ -13790,6 +14076,10 @@ export namespace aiplatform_v1 { * Output only. Number of billable characters in the tuning dataset. */ totalBillableCharacterCount?: string | null; + /** + * Output only. Number of billable tokens in the tuning dataset. + */ + totalBillableTokenCount?: string | null; /** * Output only. Number of tuning characters in the tuning dataset. */ @@ -13954,6 +14244,14 @@ export namespace aiplatform_v1 { * Output only. The number of Runs stored in this Tensorboard. */ runCount?: number | null; + /** + * Output only. Reserved for future use. + */ + satisfiesPzi?: boolean | null; + /** + * Output only. Reserved for future use. + */ + satisfiesPzs?: boolean | null; /** * Output only. Timestamp when this Tensorboard was last updated. */ @@ -14211,6 +14509,10 @@ export namespace aiplatform_v1 { * Tokens info with a list of tokens and the corresponding list of token ids. */ export interface Schema$GoogleCloudAiplatformV1TokensInfo { + /** + * Optional. Optional fields for the role from the corresponding Content. + */ + role?: string | null; /** * A list of token ids from the input. */ @@ -23757,6 +24059,99 @@ export namespace aiplatform_v1 { } } + /** + * Update a DeploymentResourcePool. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + patch( + params: Params$Resource$Projects$Locations$Deploymentresourcepools$Patch, + options: StreamMethodOptions + ): GaxiosPromise; + patch( + params?: Params$Resource$Projects$Locations$Deploymentresourcepools$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Deploymentresourcepools$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Deploymentresourcepools$Patch, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Deploymentresourcepools$Patch, + callback: BodyResponseCallback + ): void; + patch( + callback: BodyResponseCallback + ): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Deploymentresourcepools$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Deploymentresourcepools$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Deploymentresourcepools$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + /** * List DeployedModels that have been deployed on this DeploymentResourcePool. * @@ -23896,6 +24291,22 @@ export namespace aiplatform_v1 { */ parent?: string; } + export interface Params$Resource$Projects$Locations$Deploymentresourcepools$Patch + extends StandardParameters { + /** + * Immutable. The resource name of the DeploymentResourcePool. Format: `projects/{project\}/locations/{location\}/deploymentResourcePools/{deployment_resource_pool\}` + */ + name?: string; + /** + * Required. The list of fields to update. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1DeploymentResourcePool; + } export interface Params$Resource$Projects$Locations$Deploymentresourcepools$Querydeployedmodels extends StandardParameters { /** @@ -27578,7 +27989,7 @@ export namespace aiplatform_v1 { */ name?: string; /** - * Field mask is used to specify the fields to be overwritten in the FeatureGroup resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `labels` + * Field mask is used to specify the fields to be overwritten in the FeatureGroup resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `labels` * `description` * `big_query` * `big_query.entity_id_columns` */ updateMask?: string; @@ -28143,7 +28554,7 @@ export namespace aiplatform_v1 { */ name?: string; /** - * Field mask is used to specify the fields to be overwritten in the Features resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `description` * `labels` * `disable_monitoring` (Not supported for FeatureRegistry Feature) + * Field mask is used to specify the fields to be overwritten in the Features resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `description` * `labels` * `disable_monitoring` (Not supported for FeatureRegistryService Feature) * `point_of_contact` (Not supported for FeaturestoreService FeatureStore) */ updateMask?: string; @@ -29553,7 +29964,7 @@ export namespace aiplatform_v1 { */ name?: string; /** - * Field mask is used to specify the fields to be overwritten in the FeatureOnlineStore resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `big_query_source` * `bigtable` * `labels` * `sync_config` + * Field mask is used to specify the fields to be overwritten in the FeatureOnlineStore resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `labels` * `description` * `bigtable` * `bigtable.auto_scaling` * `bigtable.enable_multi_region_replica` */ updateMask?: string; @@ -30425,7 +30836,7 @@ export namespace aiplatform_v1 { */ name?: string; /** - * Field mask is used to specify the fields to be overwritten in the FeatureView resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `labels` * `serviceAgentType` + * Field mask is used to specify the fields to be overwritten in the FeatureView resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `labels` * `service_agent_type` * `big_query_source` * `big_query_source.uri` * `big_query_source.entity_id_columns` * `feature_registry_source` * `feature_registry_source.feature_groups` * `sync_config` * `sync_config.cron` */ updateMask?: string; @@ -34848,7 +35259,7 @@ export namespace aiplatform_v1 { */ name?: string; /** - * Field mask is used to specify the fields to be overwritten in the Features resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `description` * `labels` * `disable_monitoring` (Not supported for FeatureRegistry Feature) + * Field mask is used to specify the fields to be overwritten in the Features resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `description` * `labels` * `disable_monitoring` (Not supported for FeatureRegistryService Feature) * `point_of_contact` (Not supported for FeaturestoreService FeatureStore) */ updateMask?: string; @@ -52235,6 +52646,450 @@ export namespace aiplatform_v1 { this.context ); } + + /** + * Creates a NotebookExecutionJob. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + create( + params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Projects$Locations$Notebookexecutionjobs$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Create, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Create, + callback: BodyResponseCallback + ): void; + create( + callback: BodyResponseCallback + ): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Notebookexecutionjobs$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Notebookexecutionjobs$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Notebookexecutionjobs$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/notebookExecutionJobs').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Deletes a NotebookExecutionJob. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Projects$Locations$Notebookexecutionjobs$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Delete, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Delete, + callback: BodyResponseCallback + ): void; + delete( + callback: BodyResponseCallback + ): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Notebookexecutionjobs$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Notebookexecutionjobs$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Notebookexecutionjobs$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets a NotebookExecutionJob. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Notebookexecutionjobs$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Notebookexecutionjobs$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Notebookexecutionjobs$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Notebookexecutionjobs$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Lists NotebookExecutionJobs in a Location. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Locations$Notebookexecutionjobs$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Notebookexecutionjobs$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Notebookexecutionjobs$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Notebookexecutionjobs$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Notebookexecutionjobs$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Notebookexecutionjobs$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Notebookexecutionjobs$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Notebookexecutionjobs$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/notebookExecutionJobs').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Projects$Locations$Notebookexecutionjobs$Create + extends StandardParameters { + /** + * Optional. User specified ID for the NotebookExecutionJob. + */ + notebookExecutionJobId?: string; + /** + * Required. The resource name of the Location to create the NotebookExecutionJob. Format: `projects/{project\}/locations/{location\}` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1NotebookExecutionJob; + } + export interface Params$Resource$Projects$Locations$Notebookexecutionjobs$Delete + extends StandardParameters { + /** + * Required. The name of the NotebookExecutionJob resource to be deleted. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Notebookexecutionjobs$Get + extends StandardParameters { + /** + * Required. The name of the NotebookExecutionJob resource. + */ + name?: string; + /** + * Optional. The NotebookExecutionJob view. Defaults to BASIC. + */ + view?: string; + } + export interface Params$Resource$Projects$Locations$Notebookexecutionjobs$List + extends StandardParameters { + /** + * Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `notebookExecutionJob` supports = and !=. `notebookExecutionJob` represents the NotebookExecutionJob ID. * `displayName` supports = and != and regex. * `schedule` supports = and != and regex. Some examples: * `notebookExecutionJob="123"` * `notebookExecutionJob="my-execution-job"` * `displayName="myDisplayName"` and `displayName=~"myDisplayNameRegex"` + */ + filter?: string; + /** + * Optional. A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `display_name` * `create_time` * `update_time` Example: `display_name, create_time desc`. + */ + orderBy?: string; + /** + * Optional. The standard list page size. + */ + pageSize?: number; + /** + * Optional. The standard list page token. Typically obtained via ListNotebookExecutionJobs.next_page_token of the previous NotebookService.ListNotebookExecutionJobs call. + */ + pageToken?: string; + /** + * Required. The resource name of the Location from which to list the NotebookExecutionJobs. Format: `projects/{project\}/locations/{location\}` + */ + parent?: string; + /** + * Optional. The NotebookExecutionJob view. Defaults to BASIC. + */ + view?: string; } export class Resource$Projects$Locations$Notebookexecutionjobs$Operations { diff --git a/src/apis/aiplatform/v1beta1.ts b/src/apis/aiplatform/v1beta1.ts index 608ec0d889..bc28ac5cfc 100644 --- a/src/apis/aiplatform/v1beta1.ts +++ b/src/apis/aiplatform/v1beta1.ts @@ -129,7 +129,7 @@ export namespace aiplatform_v1beta1 { } /** - * Generate video response. + * Next ID: 8 Generate video response. */ export interface Schema$CloudAiLargeModelsVisionGenerateVideoResponse { /** @@ -1262,7 +1262,12 @@ export namespace aiplatform_v1beta1 { /** * Spec for bleu score metric - calculates the precision of n-grams in the prediction as compared to reference - returns a score ranging between 0 to 1. */ - export interface Schema$GoogleCloudAiplatformV1beta1BleuSpec {} + export interface Schema$GoogleCloudAiplatformV1beta1BleuSpec { + /** + * Optional. Whether to use_effective_order to compute bleu score. + */ + useEffectiveOrder?: boolean | null; + } /** * Content blob. It's preferred to send as text directly rather than raw bytes. */ @@ -1420,6 +1425,10 @@ export namespace aiplatform_v1beta1 { * Output only. List of ratings for the safety of a response candidate. There is at most one rating per category. */ safetyRatings?: Schema$GoogleCloudAiplatformV1beta1SafetyRating[]; + /** + * Output only. Confidence score of the candidate. + */ + score?: number | null; } /** * This message will be placed in the metadata field of a google.longrunning.Operation associated with a CheckTrialEarlyStoppingState request. @@ -1580,9 +1589,17 @@ export namespace aiplatform_v1beta1 { */ export interface Schema$GoogleCloudAiplatformV1beta1ComputeTokensRequest { /** - * Required. The instances that are the input to token computing API call. Schema is identical to the prediction schema of the text model, even for the non-text models, like chat models, or Codey models. + * Optional. Input content. + */ + contents?: Schema$GoogleCloudAiplatformV1beta1Content[]; + /** + * Optional. The instances that are the input to token computing API call. Schema is identical to the prediction schema of the text model, even for the non-text models, like chat models, or Codey models. */ instances?: any[] | null; + /** + * Optional. The name of the publisher model requested to serve the prediction. Format: projects/{project\}/locations/{location\}/publishers/x/models/x + */ + model?: string | null; } /** * Response message for ComputeTokens RPC call. @@ -1733,17 +1750,25 @@ export namespace aiplatform_v1beta1 { */ export interface Schema$GoogleCloudAiplatformV1beta1CountTokensRequest { /** - * Required. Input content. + * Optional. Input content. */ contents?: Schema$GoogleCloudAiplatformV1beta1Content[]; /** - * Required. The instances that are the input to token counting call. Schema is identical to the prediction schema of the underlying model. + * Optional. The instances that are the input to token counting call. Schema is identical to the prediction schema of the underlying model. */ instances?: any[] | null; /** - * Required. The name of the publisher model requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/publishers/x/models/x` + * Optional. The name of the publisher model requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/publishers/x/models/x` */ model?: string | null; + /** + * Optional. The user provided system instructions for the model. Note: only text should be used in parts and content in each part will be in a separate paragraph. + */ + systemInstruction?: Schema$GoogleCloudAiplatformV1beta1Content; + /** + * Optional. A list of `Tools` the model may use to generate the next 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. + */ + tools?: Schema$GoogleCloudAiplatformV1beta1Tool[]; } /** * Response message for PredictionService.CountTokens. @@ -5548,10 +5573,57 @@ export namespace aiplatform_v1beta1 { */ version?: number | null; } + /** + * Grounding chunk. + */ + export interface Schema$GoogleCloudAiplatformV1beta1GroundingChunk { + /** + * Grounding chunk from context retrieved by the retrieval tools. + */ + retrievedContext?: Schema$GoogleCloudAiplatformV1beta1GroundingChunkRetrievedContext; + /** + * Grounding chunk from the web. + */ + web?: Schema$GoogleCloudAiplatformV1beta1GroundingChunkWeb; + } + /** + * Chunk from context retrieved by the retrieval tools. + */ + export interface Schema$GoogleCloudAiplatformV1beta1GroundingChunkRetrievedContext { + /** + * Title of the attribution. + */ + title?: string | null; + /** + * URI reference of the attribution. + */ + uri?: string | null; + } + /** + * Chunk from the web. + */ + export interface Schema$GoogleCloudAiplatformV1beta1GroundingChunkWeb { + /** + * Title of the chunk. + */ + title?: string | null; + /** + * URI reference of the chunk. + */ + uri?: string | null; + } /** * Metadata returned to client when grounding is enabled. */ export interface Schema$GoogleCloudAiplatformV1beta1GroundingMetadata { + /** + * List of supporting references retrieved from specified grounding source. + */ + groundingChunks?: Schema$GoogleCloudAiplatformV1beta1GroundingChunk[]; + /** + * Optional. List of grounding support. + */ + groundingSupports?: Schema$GoogleCloudAiplatformV1beta1GroundingSupport[]; /** * Optional. Queries executed by the retrieval tools. */ @@ -5565,6 +5637,23 @@ export namespace aiplatform_v1beta1 { */ webSearchQueries?: string[] | null; } + /** + * Grounding support. + */ + export interface Schema$GoogleCloudAiplatformV1beta1GroundingSupport { + /** + * 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. + */ + confidenceScores?: number[] | null; + /** + * A list of indices (into 'grounding_chunk') specifying the citations associated with the claim. For instance [1,3,4] means that grounding_chunk[1], grounding_chunk[3], grounding_chunk[4] are the retrieved content attributed to the claim. + */ + groundingChunkIndices?: number[] | null; + /** + * Segment of the content this support belongs to. + */ + segment?: Schema$GoogleCloudAiplatformV1beta1Segment; + } /** * Represents a HyperparameterTuningJob. A HyperparameterTuningJob has a Study specification and multiple CustomJobs with identical CustomJob specification. */ @@ -7364,6 +7453,14 @@ export namespace aiplatform_v1beta1 { * The schemata that describe formats of the Model's predictions and explanations as given and returned via PredictionService.Predict and PredictionService.Explain. */ predictSchemata?: Schema$GoogleCloudAiplatformV1beta1PredictSchemata; + /** + * Output only. Reserved for future use. + */ + satisfiesPzi?: boolean | null; + /** + * Output only. Reserved for future use. + */ + satisfiesPzs?: boolean | null; /** * Output only. When this Model is deployed, its prediction resources are described by the `prediction_resources` field of the Endpoint.deployed_models object. Because not all Models support all resource configuration types, the configuration types this Model supports are listed here. If no configuration types are listed, the Model cannot be deployed to an Endpoint and does not support online predictions (PredictionService.Predict or PredictionService.Explain). Such a Model can serve predictions by using a BatchPredictionJob, if it has at least one entry each in supported_input_storage_formats and supported_output_storage_formats. */ @@ -10283,6 +10380,10 @@ export namespace aiplatform_v1beta1 { * A description of resources that are dedicated to the DeployedModel, and that need a higher degree of manual configuration. */ dedicatedResources?: Schema$GoogleCloudAiplatformV1beta1DedicatedResources; + /** + * Optional. Metadata information about this deployment config. + */ + deployMetadata?: Schema$GoogleCloudAiplatformV1beta1PublisherModelCallToActionDeployDeployMetadata; /** * Optional. The name of the deploy task (e.g., "text to image generation"). */ @@ -10308,6 +10409,15 @@ export namespace aiplatform_v1beta1 { */ title?: string | null; } + /** + * Metadata information about the deployment for managing deployment config. + */ + export interface Schema$GoogleCloudAiplatformV1beta1PublisherModelCallToActionDeployDeployMetadata { + /** + * Optional. Labels for the deployment. For managing deployment config like verifying, source of deployment config, etc. + */ + labels?: {[key: string]: string} | null; + } /** * Configurations for PublisherModel GKE deployment */ @@ -11026,10 +11136,6 @@ export namespace aiplatform_v1beta1 { * Optional. The query in text format to get relevant contexts. */ text?: string | null; - /** - * Optional. Only return contexts with vector distance smaller than the threshold. - */ - vectorDistanceThreshold?: number | null; } /** * Request message for PredictionService.RawPredict. @@ -11040,6 +11146,15 @@ export namespace aiplatform_v1beta1 { */ httpBody?: Schema$GoogleApiHttpBody; } + /** + * Configuration for the Ray OSS Logs. + */ + export interface Schema$GoogleCloudAiplatformV1beta1RayLogsSpec { + /** + * Optional. Flag to disable the export of Ray OSS logs to Cloud Logging. + */ + disabled?: boolean | null; + } /** * Configuration for the Ray metrics. */ @@ -11061,6 +11176,10 @@ export namespace aiplatform_v1beta1 { * Optional. Default image for user to choose a preferred ML framework (for example, TensorFlow or Pytorch) by choosing from [Vertex prebuilt images](https://cloud.google.com/vertex-ai/docs/training/pre-built-containers). Either this or the resource_pool_images is required. Use this field if you need all the resource pools to have the same Ray image. Otherwise, use the {@code resource_pool_images\} field. */ imageUri?: string | null; + /** + * Optional. OSS Ray logging configurations. + */ + rayLogsSpec?: Schema$GoogleCloudAiplatformV1beta1RayLogsSpec; /** * Optional. Ray metrics configurations. */ @@ -11398,7 +11517,7 @@ export namespace aiplatform_v1beta1 { */ export interface Schema$GoogleCloudAiplatformV1beta1ResourcePool { /** - * Optional. Optional spec to configure GKE autoscaling + * Optional. Optional spec to configure GKE or Ray-on-Vertex autoscaling */ autoscalingSpec?: Schema$GoogleCloudAiplatformV1beta1ResourcePoolAutoscalingSpec; /** @@ -11431,7 +11550,7 @@ export namespace aiplatform_v1beta1 { */ maxReplicaCount?: string | null; /** - * Optional. min replicas in the node pool, must be ≤ replica_count and < max_replica_count or will throw error + * Optional. min replicas in the node pool, must be ≤ replica_count and < max_replica_count or will throw error. For autoscaling enabled Ray-on-Vertex, we allow min_replica_count of a resource_pool to be 0 to match the OSS Ray behavior(https://docs.ray.io/en/latest/cluster/vms/user-guides/configuring-autoscaling.html#cluster-config-parameters). As for Persistent Resource, the min_replica_count must be \> 0, we added a corresponding validation inside CreatePersistentResourceRequestValidator.java. */ minReplicaCount?: string | null; } @@ -11635,7 +11754,7 @@ export namespace aiplatform_v1beta1 { */ defaultParams?: {[key: string]: any} | null; /** - * Runtime configuration for Vertext AI Search extension. + * Runtime configuration for Vertex AI Search extension. */ vertexAiSearchRuntimeConfig?: Schema$GoogleCloudAiplatformV1beta1RuntimeConfigVertexAISearchRuntimeConfig; } @@ -14824,6 +14943,27 @@ export namespace aiplatform_v1beta1 { */ nearestNeighbors?: Schema$GoogleCloudAiplatformV1beta1NearestNeighbors; } + /** + * Segment of the content. + */ + export interface Schema$GoogleCloudAiplatformV1beta1Segment { + /** + * Output only. End index in the given Part, measured in bytes. Offset from the start of the Part, exclusive, starting at zero. + */ + endIndex?: number | null; + /** + * Output only. The index of a Part object within its parent Content object. + */ + partIndex?: number | null; + /** + * Output only. Start index in the given Part, measured in bytes. Offset from the start of the Part, inclusive, starting at zero. + */ + startIndex?: number | null; + /** + * Output only. The text corresponding to the segment from the response. + */ + text?: string | null; + } /** * Configuration for the use of custom service account to run the workloads. */ @@ -15678,6 +15818,10 @@ export namespace aiplatform_v1beta1 { * Dataset distribution for Supervised Tuning. */ export interface Schema$GoogleCloudAiplatformV1beta1SupervisedTuningDatasetDistribution { + /** + * Output only. Sum of a given population of values that are billable. + */ + billableSum?: string | null; /** * Output only. Defines the histogram bucket. */ @@ -15736,6 +15880,10 @@ export namespace aiplatform_v1beta1 { * Output only. Number of billable characters in the tuning dataset. */ totalBillableCharacterCount?: string | null; + /** + * Output only. Number of billable tokens in the tuning dataset. + */ + totalBillableTokenCount?: string | null; /** * Output only. Number of tuning characters in the tuning dataset. */ @@ -15902,6 +16050,14 @@ export namespace aiplatform_v1beta1 { * Output only. The number of Runs stored in this Tensorboard. */ runCount?: number | null; + /** + * Output only. Reserved for future use. + */ + satisfiesPzi?: boolean | null; + /** + * Output only. Reserved for future use. + */ + satisfiesPzs?: boolean | null; /** * Output only. Timestamp when this Tensorboard was last updated. */ @@ -16159,6 +16315,10 @@ export namespace aiplatform_v1beta1 { * Tokens info with a list of tokens and the corresponding list of token ids. */ export interface Schema$GoogleCloudAiplatformV1beta1TokensInfo { + /** + * Optional. Optional fields for the role from the corresponding Content. + */ + role?: string | null; /** * A list of token ids from the input. */ @@ -28016,6 +28176,99 @@ export namespace aiplatform_v1beta1 { } } + /** + * Update a DeploymentResourcePool. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + patch( + params: Params$Resource$Projects$Locations$Deploymentresourcepools$Patch, + options: StreamMethodOptions + ): GaxiosPromise; + patch( + params?: Params$Resource$Projects$Locations$Deploymentresourcepools$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Deploymentresourcepools$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Deploymentresourcepools$Patch, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Deploymentresourcepools$Patch, + callback: BodyResponseCallback + ): void; + patch( + callback: BodyResponseCallback + ): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Deploymentresourcepools$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Deploymentresourcepools$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Deploymentresourcepools$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + /** * List DeployedModels that have been deployed on this DeploymentResourcePool. * @@ -28155,6 +28408,22 @@ export namespace aiplatform_v1beta1 { */ parent?: string; } + export interface Params$Resource$Projects$Locations$Deploymentresourcepools$Patch + extends StandardParameters { + /** + * Immutable. The resource name of the DeploymentResourcePool. Format: `projects/{project\}/locations/{location\}/deploymentResourcePools/{deployment_resource_pool\}` + */ + name?: string; + /** + * Required. The list of fields to update. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1beta1DeploymentResourcePool; + } export interface Params$Resource$Projects$Locations$Deploymentresourcepools$Querydeployedmodels extends StandardParameters { /** @@ -35626,7 +35895,7 @@ export namespace aiplatform_v1beta1 { */ name?: string; /** - * Field mask is used to specify the fields to be overwritten in the FeatureGroup resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `labels` + * Field mask is used to specify the fields to be overwritten in the FeatureGroup resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `labels` * `description` * `big_query` * `big_query.entity_id_columns` */ updateMask?: string; @@ -36191,7 +36460,7 @@ export namespace aiplatform_v1beta1 { */ name?: string; /** - * Field mask is used to specify the fields to be overwritten in the Features resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `description` * `labels` * `disable_monitoring` (Not supported for FeatureRegistry Feature) + * Field mask is used to specify the fields to be overwritten in the Features resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `description` * `labels` * `disable_monitoring` (Not supported for FeatureRegistryService Feature) * `point_of_contact` (Not supported for FeaturestoreService FeatureStore) */ updateMask?: string; @@ -37910,7 +38179,7 @@ export namespace aiplatform_v1beta1 { */ name?: string; /** - * Field mask is used to specify the fields to be overwritten in the FeatureOnlineStore resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `big_query_source` * `bigtable` * `labels` * `sync_config` + * Field mask is used to specify the fields to be overwritten in the FeatureOnlineStore resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `labels` * `description` * `bigtable` * `bigtable.auto_scaling` * `bigtable.enable_multi_region_replica` */ updateMask?: string; @@ -39197,7 +39466,7 @@ export namespace aiplatform_v1beta1 { */ name?: string; /** - * Field mask is used to specify the fields to be overwritten in the FeatureView resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `labels` * `serviceAgentType` + * Field mask is used to specify the fields to be overwritten in the FeatureView resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `labels` * `service_agent_type` * `big_query_source` * `big_query_source.uri` * `big_query_source.entity_id_columns` * `feature_registry_source` * `feature_registry_source.feature_groups` * `sync_config` * `sync_config.cron` */ updateMask?: string; @@ -43665,7 +43934,7 @@ export namespace aiplatform_v1beta1 { */ name?: string; /** - * Field mask is used to specify the fields to be overwritten in the Features resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `description` * `labels` * `disable_monitoring` (Not supported for FeatureRegistry Feature) + * Field mask is used to specify the fields to be overwritten in the Features resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `description` * `labels` * `disable_monitoring` (Not supported for FeatureRegistryService Feature) * `point_of_contact` (Not supported for FeaturestoreService FeatureStore) */ updateMask?: string; diff --git a/src/apis/alloydb/v1.ts b/src/apis/alloydb/v1.ts index eedfb7d373..1a1f66e76b 100644 --- a/src/apis/alloydb/v1.ts +++ b/src/apis/alloydb/v1.ts @@ -419,6 +419,14 @@ export namespace alloydb_v1 { * Output only. The current serving state of the cluster. */ state?: string | null; + /** + * Optional. Subscription type of the cluster. + */ + subscriptionType?: string | null; + /** + * Output only. Metadata for free trial clusters + */ + trialMetadata?: Schema$TrialMetadata; /** * Output only. The system-generated UID of the resource. The UID is assigned when the resource is created, and it is retained until it is deleted. */ @@ -1658,6 +1666,23 @@ export namespace alloydb_v1 { */ retentionPeriod?: string | null; } + /** + * Contains information and all metadata related to TRIAL clusters. + */ + export interface Schema$TrialMetadata { + /** + * End time of the trial cluster. + */ + endTime?: string | null; + /** + * start time of the trial cluster. + */ + startTime?: string | null; + /** + * Upgrade time of trial cluster to Standard cluster. + */ + upgradeTime?: string | null; + } /** * Message describing User object. */ diff --git a/src/apis/alloydb/v1alpha.ts b/src/apis/alloydb/v1alpha.ts index fea36f940e..25c9b358d1 100644 --- a/src/apis/alloydb/v1alpha.ts +++ b/src/apis/alloydb/v1alpha.ts @@ -1010,7 +1010,7 @@ export namespace alloydb_v1alpha { */ export interface Schema$ObservabilityInstanceConfig { /** - * Observability feature status for an instance. This is a read-only flag and modifiable only by producer API. This flag is turned "off" by default. + * Observability feature status for an instance. This flag is turned "off" by default. */ enabled?: boolean | null; /** @@ -1022,7 +1022,7 @@ export namespace alloydb_v1alpha { */ preserveComments?: boolean | null; /** - * Number of query execution plans captured by Insights per minute for all queries combined. The default value is 5. Any integer between 0 to 20 is considered valid. + * 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. */ queryPlansPerMinute?: number | null; /** diff --git a/src/apis/alloydb/v1beta.ts b/src/apis/alloydb/v1beta.ts index 27a9738cbb..4a9f595cb4 100644 --- a/src/apis/alloydb/v1beta.ts +++ b/src/apis/alloydb/v1beta.ts @@ -994,7 +994,7 @@ export namespace alloydb_v1beta { */ export interface Schema$ObservabilityInstanceConfig { /** - * Observability feature status for an instance. This is a read-only flag and modifiable only by producer API. This flag is turned "off" by default. + * Observability feature status for an instance. This flag is turned "off" by default. */ enabled?: boolean | null; /** @@ -1006,7 +1006,7 @@ export namespace alloydb_v1beta { */ preserveComments?: boolean | null; /** - * Number of query execution plans captured by Insights per minute for all queries combined. The default value is 5. Any integer between 0 to 20 is considered valid. + * 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. */ queryPlansPerMinute?: number | null; /** diff --git a/src/apis/analyticsadmin/v1alpha.ts b/src/apis/analyticsadmin/v1alpha.ts index 216ba8c0f3..8d24b91495 100644 --- a/src/apis/analyticsadmin/v1alpha.ts +++ b/src/apis/analyticsadmin/v1alpha.ts @@ -880,6 +880,10 @@ export namespace analyticsadmin_v1alpha { * If set true, enables daily data export to the linked Google Cloud project. */ dailyExportEnabled?: boolean | null; + /** + * Required. Immutable. The geographic location where the created BigQuery dataset should reside. See https://cloud.google.com/bigquery/docs/locations for supported locations. + */ + datasetLocation?: string | null; /** * The list of event names that will be excluded from exports. */ @@ -2574,15 +2578,6 @@ export namespace analyticsadmin_v1alpha { */ accountTicketId?: string | null; } - /** - * Request message for ReorderEventEditRules RPC. - */ - export interface Schema$GoogleAnalyticsAdminV1alphaReorderEventEditRulesRequest { - /** - * Required. EventEditRule resource names for the specified data stream, in the needed processing order. All EventEditRules for the stream must be present in the list. - */ - eventEditRules?: string[] | null; - } /** * A link that references a source property under the parent rollup property. */ @@ -9072,6 +9067,193 @@ export namespace analyticsadmin_v1alpha { this.context = context; } + /** + * Creates a BigQueryLink. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + create( + params: Params$Resource$Properties$Bigquerylinks$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Properties$Bigquerylinks$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Properties$Bigquerylinks$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Properties$Bigquerylinks$Create, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Properties$Bigquerylinks$Create, + callback: BodyResponseCallback + ): void; + create( + callback: BodyResponseCallback + ): void; + create( + paramsOrCallback?: + | Params$Resource$Properties$Bigquerylinks$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Properties$Bigquerylinks$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Properties$Bigquerylinks$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://analyticsadmin.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+parent}/bigQueryLinks').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Deletes a BigQueryLink on a property. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Properties$Bigquerylinks$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Properties$Bigquerylinks$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Properties$Bigquerylinks$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Properties$Bigquerylinks$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Properties$Bigquerylinks$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Properties$Bigquerylinks$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Properties$Bigquerylinks$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Properties$Bigquerylinks$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://analyticsadmin.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + /** * Lookup for a single BigQuery Link. * @@ -9264,8 +9446,122 @@ export namespace analyticsadmin_v1alpha { ); } } + + /** + * Updates a BigQueryLink. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + patch( + params: Params$Resource$Properties$Bigquerylinks$Patch, + options: StreamMethodOptions + ): GaxiosPromise; + patch( + params?: Params$Resource$Properties$Bigquerylinks$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Properties$Bigquerylinks$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Properties$Bigquerylinks$Patch, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Properties$Bigquerylinks$Patch, + callback: BodyResponseCallback + ): void; + patch( + callback: BodyResponseCallback + ): void; + patch( + paramsOrCallback?: + | Params$Resource$Properties$Bigquerylinks$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Properties$Bigquerylinks$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Properties$Bigquerylinks$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://analyticsadmin.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } } + export interface Params$Resource$Properties$Bigquerylinks$Create + extends StandardParameters { + /** + * Required. Example format: properties/1234 + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleAnalyticsAdminV1alphaBigQueryLink; + } + export interface Params$Resource$Properties$Bigquerylinks$Delete + extends StandardParameters { + /** + * Required. The BigQueryLink to delete. Example format: properties/1234/bigQueryLinks/5678 + */ + name?: string; + } export interface Params$Resource$Properties$Bigquerylinks$Get extends StandardParameters { /** @@ -9288,6 +9584,22 @@ export namespace analyticsadmin_v1alpha { */ parent?: string; } + export interface Params$Resource$Properties$Bigquerylinks$Patch + extends StandardParameters { + /** + * Output only. Resource name of this BigQuery link. Format: 'properties/{property_id\}/bigQueryLinks/{bigquery_link_id\}' Format: 'properties/1234/bigQueryLinks/abc567' + */ + name?: string; + /** + * Required. The list of fields to be updated. Field names must be in snake case (e.g., "field_to_update"). Omitted fields will not be updated. To replace the entire entity, use one path with the string "*" to match all fields. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleAnalyticsAdminV1alphaBigQueryLink; + } export class Resource$Properties$Calculatedmetrics { context: APIRequestContext; @@ -12012,16 +12324,12 @@ export namespace analyticsadmin_v1alpha { export class Resource$Properties$Datastreams { context: APIRequestContext; eventCreateRules: Resource$Properties$Datastreams$Eventcreaterules; - eventEditRules: Resource$Properties$Datastreams$Eventeditrules; measurementProtocolSecrets: Resource$Properties$Datastreams$Measurementprotocolsecrets; sKAdNetworkConversionValueSchema: Resource$Properties$Datastreams$Skadnetworkconversionvalueschema; constructor(context: APIRequestContext) { this.context = context; this.eventCreateRules = new Resource$Properties$Datastreams$Eventcreaterules(this.context); - this.eventEditRules = new Resource$Properties$Datastreams$Eventeditrules( - this.context - ); this.measurementProtocolSecrets = new Resource$Properties$Datastreams$Measurementprotocolsecrets( this.context @@ -13643,118 +13951,6 @@ export namespace analyticsadmin_v1alpha { requestBody?: Schema$GoogleAnalyticsAdminV1alphaEventCreateRule; } - export class Resource$Properties$Datastreams$Eventeditrules { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * Changes the processing order of event edit rules on the specified stream. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - reorder( - params: Params$Resource$Properties$Datastreams$Eventeditrules$Reorder, - options: StreamMethodOptions - ): GaxiosPromise; - reorder( - params?: Params$Resource$Properties$Datastreams$Eventeditrules$Reorder, - options?: MethodOptions - ): GaxiosPromise; - reorder( - params: Params$Resource$Properties$Datastreams$Eventeditrules$Reorder, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - reorder( - params: Params$Resource$Properties$Datastreams$Eventeditrules$Reorder, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - reorder( - params: Params$Resource$Properties$Datastreams$Eventeditrules$Reorder, - callback: BodyResponseCallback - ): void; - reorder(callback: BodyResponseCallback): void; - reorder( - paramsOrCallback?: - | Params$Resource$Properties$Datastreams$Eventeditrules$Reorder - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Properties$Datastreams$Eventeditrules$Reorder; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Properties$Datastreams$Eventeditrules$Reorder; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://analyticsadmin.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/v1alpha/{+parent}/eventEditRules:reorder' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['parent'], - pathParams: ['parent'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Properties$Datastreams$Eventeditrules$Reorder - extends StandardParameters { - /** - * Required. Example format: properties/123/dataStreams/456 - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleAnalyticsAdminV1alphaReorderEventEditRulesRequest; - } - export class Resource$Properties$Datastreams$Measurementprotocolsecrets { context: APIRequestContext; constructor(context: APIRequestContext) { diff --git a/src/apis/analyticsadmin/v1beta.ts b/src/apis/analyticsadmin/v1beta.ts index 7169dde47b..74b4f76a17 100644 --- a/src/apis/analyticsadmin/v1beta.ts +++ b/src/apis/analyticsadmin/v1beta.ts @@ -1161,15 +1161,6 @@ export namespace analyticsadmin_v1beta { */ accountTicketId?: string | null; } - /** - * Request message for ReorderEventEditRules RPC. - */ - export interface Schema$GoogleAnalyticsAdminV1betaReorderEventEditRulesRequest { - /** - * Required. EventEditRule resource names for the specified data stream, in the needed processing order. All EventEditRules for the stream must be present in the list. - */ - eventEditRules?: string[] | null; - } /** * The request for a Data Access Record Report. */ @@ -4888,13 +4879,9 @@ export namespace analyticsadmin_v1beta { export class Resource$Properties$Datastreams { context: APIRequestContext; - eventEditRules: Resource$Properties$Datastreams$Eventeditrules; measurementProtocolSecrets: Resource$Properties$Datastreams$Measurementprotocolsecrets; constructor(context: APIRequestContext) { this.context = context; - this.eventEditRules = new Resource$Properties$Datastreams$Eventeditrules( - this.context - ); this.measurementProtocolSecrets = new Resource$Properties$Datastreams$Measurementprotocolsecrets( this.context @@ -5435,119 +5422,6 @@ export namespace analyticsadmin_v1beta { requestBody?: Schema$GoogleAnalyticsAdminV1betaDataStream; } - export class Resource$Properties$Datastreams$Eventeditrules { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * Changes the processing order of event edit rules on the specified stream. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - reorder( - params: Params$Resource$Properties$Datastreams$Eventeditrules$Reorder, - options: StreamMethodOptions - ): GaxiosPromise; - reorder( - params?: Params$Resource$Properties$Datastreams$Eventeditrules$Reorder, - options?: MethodOptions - ): GaxiosPromise; - reorder( - params: Params$Resource$Properties$Datastreams$Eventeditrules$Reorder, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - reorder( - params: Params$Resource$Properties$Datastreams$Eventeditrules$Reorder, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - reorder( - params: Params$Resource$Properties$Datastreams$Eventeditrules$Reorder, - callback: BodyResponseCallback - ): void; - reorder(callback: BodyResponseCallback): void; - reorder( - paramsOrCallback?: - | Params$Resource$Properties$Datastreams$Eventeditrules$Reorder - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Properties$Datastreams$Eventeditrules$Reorder; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Properties$Datastreams$Eventeditrules$Reorder; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://analyticsadmin.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1beta/{+parent}/eventEditRules:reorder').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['parent'], - pathParams: ['parent'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Properties$Datastreams$Eventeditrules$Reorder - extends StandardParameters { - /** - * Required. Example format: properties/123/dataStreams/456 - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleAnalyticsAdminV1betaReorderEventEditRulesRequest; - } - export class Resource$Properties$Datastreams$Measurementprotocolsecrets { context: APIRequestContext; constructor(context: APIRequestContext) { diff --git a/src/apis/androidenterprise/v1.ts b/src/apis/androidenterprise/v1.ts index eaeee5b572..b9cb7a314e 100644 --- a/src/apis/androidenterprise/v1.ts +++ b/src/apis/androidenterprise/v1.ts @@ -3609,6 +3609,10 @@ export namespace androidenterprise_v1 { } export interface Params$Resource$Enterprises$Generatesignupurl extends StandardParameters { + /** + * Optional. Email address used to prefill the admin field of the enterprise signup form. This value is a hint only and can be altered by the user. + */ + adminEmail?: string; /** * The callback URL to which the Admin will be redirected after successfully creating an enterprise. Before redirecting there the system will add a single query parameter to this URL named "enterpriseToken" which will contain an opaque token to be used for the CompleteSignup request. Beware that this means that the URL will be parsed, the parameter added and then a new URL formatted, i.e. there may be some minor formatting changes and, more importantly, the URL must be well-formed so that it can be parsed. */ diff --git a/src/apis/androidpublisher/v3.ts b/src/apis/androidpublisher/v3.ts index e702e47b80..304edb33aa 100644 --- a/src/apis/androidpublisher/v3.ts +++ b/src/apis/androidpublisher/v3.ts @@ -1327,7 +1327,7 @@ export namespace androidpublisher_v3 { */ testPurchase?: Schema$ExternalTransactionTestPurchase; /** - * Optional. The transaction program code, used to help determine service fee for apps partcipating in special partner programs. This field can not be used for external offers transactions. Developers participating in the Play Media Experience Program (https://play.google.com/console/about/programs/mediaprogram/) must provide the program code when reporting alternative billing external transactions. If you are an eligible developer, please contact your BDM for more information on how to set this field. + * Optional. The transaction program code, used to help determine service fee for eligible apps participating in partner programs. Developers participating in the Play Media Experience Program (https://play.google.com/console/about/programs/mediaprogram/) must provide the program code when reporting alternative billing transactions. If you are an eligible developer, please contact your BDM for more information on how to set this field. Note: this field can not be used for external offers transactions. */ transactionProgramCode?: number | null; /** @@ -4378,102 +4378,6 @@ export namespace androidpublisher_v3 { } } - /** - * List all app recovery action resources associated with a particular package name and app version. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - appRecoveries( - params: Params$Resource$Apprecovery$Apprecoveries, - options: StreamMethodOptions - ): GaxiosPromise; - appRecoveries( - params?: Params$Resource$Apprecovery$Apprecoveries, - options?: MethodOptions - ): GaxiosPromise; - appRecoveries( - params: Params$Resource$Apprecovery$Apprecoveries, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - appRecoveries( - params: Params$Resource$Apprecovery$Apprecoveries, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - appRecoveries( - params: Params$Resource$Apprecovery$Apprecoveries, - callback: BodyResponseCallback - ): void; - appRecoveries( - callback: BodyResponseCallback - ): void; - appRecoveries( - paramsOrCallback?: - | Params$Resource$Apprecovery$Apprecoveries - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Apprecovery$Apprecoveries; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Apprecovery$Apprecoveries; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://androidpublisher.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/androidpublisher/v3/applications/{packageName}/appRecoveries' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['packageName'], - pathParams: ['packageName'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - /** * Cancel an already executing app recovery action. Note that this action changes status of the recovery action to CANCELED. * @@ -4757,6 +4661,101 @@ export namespace androidpublisher_v3 { return createAPIRequest(parameters); } } + + /** + * List all app recovery action resources associated with a particular package name and app version. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Apprecovery$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Apprecovery$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Apprecovery$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Apprecovery$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Apprecovery$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Apprecovery$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Apprecovery$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Apprecovery$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://androidpublisher.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/androidpublisher/v3/applications/{packageName}/appRecoveries' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['packageName'], + pathParams: ['packageName'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } } export interface Params$Resource$Apprecovery$Addtargeting @@ -4775,17 +4774,6 @@ export namespace androidpublisher_v3 { */ requestBody?: Schema$AddTargetingRequest; } - export interface Params$Resource$Apprecovery$Apprecoveries - extends StandardParameters { - /** - * Required. Package name of the app for which list of recovery actions is requested. - */ - packageName?: string; - /** - * Required. Version code targeted by the list of recovery actions. - */ - versionCode?: string; - } export interface Params$Resource$Apprecovery$Cancel extends StandardParameters { /** @@ -4830,6 +4818,16 @@ export namespace androidpublisher_v3 { */ requestBody?: Schema$DeployAppRecoveryRequest; } + export interface Params$Resource$Apprecovery$List extends StandardParameters { + /** + * Required. Package name of the app for which list of recovery actions is requested. + */ + packageName?: string; + /** + * Required. Version code targeted by the list of recovery actions. + */ + versionCode?: string; + } export class Resource$Edits { context: APIRequestContext; diff --git a/src/apis/artifactregistry/v1.ts b/src/apis/artifactregistry/v1.ts index 5dffe53a72..bb16f3b7ed 100644 --- a/src/apis/artifactregistry/v1.ts +++ b/src/apis/artifactregistry/v1.ts @@ -1050,6 +1050,10 @@ export namespace artifactregistry_v1 { */ name?: string | null; } + /** + * The metadata for promote artifact long running operation. + */ + export interface Schema$PromoteArtifactMetadata {} /** * PythonPackage represents a python artifact. */ @@ -1315,7 +1319,7 @@ export namespace artifactregistry_v1 { */ filename?: string | null; /** - * The ID of the package of the generic artifact. If the package does not exist, a new package will be created. The `package_id` must start with a letter, end with a letter or number, only contain letters, numbers, hyphens and periods i.e. [a-z0-9-.], and cannot exceed 256 characters. + * The ID of the package of the generic artifact. If the package does not exist, a new package will be created. The `package_id` should start and end with a letter or number, only contain letters, numbers, hyphens, underscores, and periods, and not exceed 256 characters. */ packageId?: string | null; /** diff --git a/src/apis/backupdr/v1.ts b/src/apis/backupdr/v1.ts index df71e2b6c6..cdc888c867 100644 --- a/src/apis/backupdr/v1.ts +++ b/src/apis/backupdr/v1.ts @@ -125,422 +125,3483 @@ export namespace backupdr_v1 { } /** - * 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. + * request message for AbandonBackup. */ - export interface Schema$AuditConfig { - /** - * The configuration for logging of each type of permission. - */ - auditLogConfigs?: Schema$AuditLogConfig[]; + export interface Schema$AbandonBackupRequest { /** - * 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. + * 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). */ - service?: string | null; + requestId?: string | null; } /** - * 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 specification of the type and number of accelerator cards attached to the instance. */ - export interface Schema$AuditLogConfig { + export interface Schema$AcceleratorConfig { /** - * Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. + * Optional. The number of the guest accelerator cards exposed to this instance. */ - exemptedMembers?: string[] | null; + acceleratorCount?: number | null; /** - * The log type that this config enables. + * Optional. Full or partial URL of the accelerator type resource to attach to this instance. */ - logType?: string | null; + acceleratorType?: string | null; } /** - * Associates `members`, or principals, with a `role`. + * An access configuration attached to an instance's network interface. Only one access config per instance is supported. */ - export interface Schema$Binding { + export interface Schema$AccessConfig { /** - * 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 external IPv6 address of this access configuration. */ - condition?: Schema$Expr; + externalIpv6?: string | null; /** - * 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\}/x`: 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\}/x`: 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`. + * Optional. The prefix length of the external IPv6 range. */ - members?: string[] | null; + externalIpv6PrefixLength?: number | null; /** - * 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). + * Optional. The name of this access configuration. */ - role?: string | null; - } - /** - * The request message for Operations.CancelOperation. - */ - export interface Schema$CancelOperationRequest {} - /** - * 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); \} - */ - export interface Schema$Empty {} - /** - * 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. - */ - export interface Schema$Expr { + name?: string | null; /** - * Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. + * Optional. The external IP address of this access configuration. */ - description?: string | null; + natIP?: string | null; /** - * Textual representation of an expression in Common Expression Language syntax. + * Optional. This signifies the networking tier used for configuring this access */ - expression?: string | null; + networkTier?: string | null; /** - * Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. + * Optional. The DNS domain name for the public PTR record. */ - location?: string | null; + publicPtrDomainName?: string | null; /** - * 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. Specifies whether a public DNS 'PTR' record should be created to map the external IP address of the instance to a DNS domain name. */ - title?: string | null; + setPublicPtr?: boolean | null; + /** + * Optional. 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 | null; } /** - * The response message for Locations.ListLocations. + * An alias IP range attached to an instance's network interface. */ - export interface Schema$ListLocationsResponse { + export interface Schema$AliasIpRange { /** - * A list of locations that matches the specified filter in the request. + * Optional. The IP alias ranges to allocate for this interface. */ - locations?: Schema$Location[]; + ipCidrRange?: string | null; /** - * The standard List next-page token. + * Optional. 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. */ - nextPageToken?: string | null; + subnetworkRangeName?: string | null; } /** - * Response message for listing management servers. + * An instance-attached disk resource. */ - export interface Schema$ListManagementServersResponse { + export interface Schema$AttachedDisk { /** - * The list of ManagementServer instances in the project for the specified location. If the `{location\}` value in the request is "-", the response contains a list of instances from all locations. In case any location is unreachable, the response will only return management servers in reachable locations and the 'unreachable' field will be populated with a list of unreachable locations. + * Optional. Specifies whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance). */ - managementServers?: Schema$ManagementServer[]; + autoDelete?: boolean | null; /** - * A token identifying a page of results the server should return. + * Optional. Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem. */ - nextPageToken?: string | null; + boot?: boolean | null; /** - * Locations that could not be reached. + * Optional. This is used as an identifier for the disks. This is the unique name has to provided to modify disk parameters like disk_name and replica_zones (in case of RePDs) */ - unreachable?: string[] | null; - } - /** - * The response message for Operations.ListOperations. - */ - export interface Schema$ListOperationsResponse { + deviceName?: string | null; /** - * The standard List next-page token. + * Optional. Encrypts or decrypts a disk using a customer-supplied encryption key. */ - nextPageToken?: string | null; + diskEncryptionKey?: Schema$CustomerEncryptionKey; /** - * A list of operations that matches the specified filter in the request. + * Optional. Specifies the disk interface to use for attaching this disk. */ - operations?: Schema$Operation[]; - } - /** - * A resource that represents a Google Cloud location. - */ - export interface Schema$Location { + diskInterface?: string | null; /** - * The friendly name for this location, typically a nearby city name. For example, "Tokyo". + * Optional. The size of the disk in GB. */ - displayName?: string | null; + diskSizeGb?: string | null; /** - * Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"\} + * Optional. Specifies the type of the disk. */ - labels?: {[key: string]: string} | null; + diskType?: string | null; /** - * The canonical id for this location. For example: `"us-east1"`. + * Optional. A list of features to enable on the guest operating system. Applicable only for bootable images. */ - locationId?: string | null; + guestOsFeature?: Schema$GuestOsFeature[]; /** - * Service-specific metadata. For example the available capacity at the given location. + * Optional. A zero-based index to this disk, where 0 is reserved for the boot disk. */ - metadata?: {[key: string]: any} | null; + index?: string | null; /** - * Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"` + * Optional. Specifies the parameters to initialize this disk. */ - name?: string | null; + initializeParams?: Schema$InitializeParams; + /** + * Optional. Type of the resource. + */ + kind?: string | null; + /** + * Optional. Any valid publicly visible licenses. + */ + license?: string[] | null; + /** + * Optional. The mode in which to attach this disk. + */ + mode?: string | null; + /** + * Optional. Output only. The state of the disk. + */ + savedState?: string | null; + /** + * Optional. Specifies a valid partial or full URL to an existing Persistent Disk resource. + */ + source?: string | null; } /** - * ManagementServer describes a single BackupDR ManagementServer instance. + * 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. */ - export interface Schema$ManagementServer { + export interface Schema$AuditConfig { /** - * Output only. The hostname or ip address of the exposed AGM endpoints, used by BAs to connect to BA proxy. + * The configuration for logging of each type of permission. */ - baProxyUri?: string[] | null; + auditLogConfigs?: Schema$AuditLogConfig[]; /** - * Output only. The time when the instance was created. + * 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. */ - createTime?: string | null; + service?: string | null; + } + /** + * 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. + */ + export interface Schema$AuditLogConfig { /** - * Optional. The description of the ManagementServer instance (2048 characters or less). + * Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. */ - description?: string | null; + exemptedMembers?: string[] | null; /** - * Optional. Server specified ETag for the ManagementServer resource to prevent simultaneous updates from overwiting each other. + * The log type that this config enables. */ - etag?: string | null; + logType?: string | null; + } + /** + * Message describing a Backup object. + */ + export interface Schema$Backup { + backupApplianceBackupProperties?: Schema$BackupApplianceBackupProperties; /** - * Optional. Resource labels to represent user provided metadata. Labels currently defined: 1. migrate_from_go= If set to true, the MS is created in migration ready mode. + * Optional. The list of BackupLocks taken by the accessor Backup Appliance. */ - labels?: {[key: string]: string} | null; + backupApplianceLocks?: Schema$BackupLock[]; + backupType?: string | null; + computeInstanceBackupProperties?: Schema$ComputeInstanceBackupProperties; /** - * Output only. The hostname or ip address of the exposed AGM endpoints, used by clients to connect to AGM/RD graphical user interface and APIs. + * Output only. The point in time when this backup was captured from the source. */ - managementUri?: Schema$ManagementURI; + consistencyTime?: string | null; /** - * Output only. Identifier. The resource name. + * Output only. The time when the instance was created. */ - name?: string | null; + createTime?: string | null; /** - * Required. VPC networks to which the ManagementServer instance is connected. For this version, only a single network is supported. + * Output only. The description of the Backup instance (2048 characters or less). */ - networks?: Schema$NetworkConfig[]; + description?: string | null; /** - * Output only. The OAuth 2.0 client id is required to make API calls to the BackupDR instance API of this ManagementServer. This is the value that should be provided in the ‘aud’ field of the OIDC ID Token (see openid specification https://openid.net/specs/openid-connect-core-1_0.html#IDToken). + * Optional. The backup can not be deleted before this time. */ - oauth2ClientId?: string | null; + enforcedRetentionEndTime?: string | null; /** - * Output only. Reserved for future use. + * Optional. Server specified ETag to prevent updates from overwriting each other. */ - satisfiesPzi?: boolean | null; + etag?: string | null; /** - * Output only. Reserved for future use. + * Optional. When this backup is automatically expired. */ - satisfiesPzs?: boolean | null; + expireTime?: string | null; /** - * Output only. The ManagementServer state. + * Output only. Configuration for a Google Cloud resource. */ - state?: string | null; + gcpBackupPlanInfo?: Schema$GCPBackupPlanInfo; /** - * Optional. The type of the ManagementServer resource. + * Optional. Resource labels to represent user provided metadata. No labels currently defined. */ - type?: string | null; + labels?: {[key: string]: string} | null; /** - * Output only. The time when the instance was updated. + * Output only. Name of the resource. */ - updateTime?: string | null; + name?: string | null; /** - * Output only. The hostnames of the exposed AGM endpoints for both types of user i.e. 1p and 3p, used to connect AGM/RM UI. + * Output only. source resource size in bytes at the time of the backup. */ - workforceIdentityBasedManagementUri?: Schema$WorkforceIdentityBasedManagementURI; + resourceSizeBytes?: string | null; /** - * Output only. The OAuth client IDs for both types of user i.e. 1p and 3p. + * Output only. The list of BackupLocks taken by the service to prevent the deletion of the backup. */ - workforceIdentityBasedOauth2ClientId?: Schema$WorkforceIdentityBasedOAuth2ClientID; - } - /** - * ManagementURI for the Management Server resource. - */ - export interface Schema$ManagementURI { + serviceLocks?: Schema$BackupLock[]; /** - * Output only. The ManagementServer AGM/RD API URL. + * Output only. The Backup resource instance state. */ - api?: string | null; + state?: string | null; /** - * Output only. The ManagementServer AGM/RD WebUI URL. + * Output only. The time when the instance was updated. */ - webUi?: string | null; + updateTime?: string | null; } /** - * Network configuration for ManagementServer instance. + * BackupApplianceBackupConfig captures the backup configuration for applications that are protected by Backup Appliances. */ - export interface Schema$NetworkConfig { + export interface Schema$BackupApplianceBackupConfig { /** - * Optional. The resource name of the Google Compute Engine VPC network to which the ManagementServer instance is connected. + * The name of the application. */ - network?: string | null; + applicationName?: string | null; /** - * Optional. The network connect mode of the ManagementServer instance. For this version, only PRIVATE_SERVICE_ACCESS is supported. + * The ID of the backup appliance. */ - peeringMode?: string | null; - } - /** - * This resource represents a long-running operation that is the result of a network API call. - */ - export interface Schema$Operation { + backupApplianceId?: string | null; /** - * 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. + * The name of the backup appliance. */ - done?: boolean | null; + backupApplianceName?: string | null; /** - * The error result of the operation in case of failure or cancellation. + * The name of the host where the application is running. */ - error?: Schema$Status; + hostName?: string | null; /** - * 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. + * The ID of the SLA of this application. */ - metadata?: {[key: string]: any} | null; + slaId?: string | null; /** - * 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\}`. + * The name of the SLP associated with the application. */ - name?: string | null; + slpName?: string | null; /** - * 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 name of the SLT associated with the application. */ - response?: {[key: string]: any} | null; + sltName?: string | null; } /** - * Represents the metadata of the long-running operation. + * BackupApplianceBackupProperties represents BackupDR backup appliance's properties. */ - export interface Schema$OperationMetadata { + export interface Schema$BackupApplianceBackupProperties { /** - * Output only. AdditionalInfo contains additional Info related to backup plan association resource. + * Output only. The time when this backup object was finalized (if none, backup is not finalized). */ - additionalInfo?: {[key: string]: string} | null; + finalizeTime?: string | null; /** - * Output only. API version used to start the operation. + * Output only. The numeric generation ID of the backup (monotonically increasing). */ - apiVersion?: string | null; + generationId?: number | null; /** - * Output only. The time the operation was created. + * Optional. The latest timestamp of data available in this Backup. */ - createTime?: string | null; + recoveryRangeEndTime?: string | null; /** - * Output only. The time the operation finished running. + * Optional. The earliest timestamp of data available in this Backup. */ - endTime?: string | null; + recoveryRangeStartTime?: string | null; + } + /** + * BackupApplianceLockInfo contains metadata about the backupappliance that created the lock. + */ + export interface Schema$BackupApplianceLockInfo { /** - * 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`. + * Required. The ID of the backup/recovery appliance that created this lock. */ - requestedCancellation?: boolean | null; + backupApplianceId?: string | null; /** - * Output only. Human-readable status of the operation, if any. + * Required. The name of the backup/recovery appliance that created this lock. */ - statusMessage?: string | null; + backupApplianceName?: string | null; /** - * Output only. Server-defined resource path for the target of the operation. + * The image name that depends on this Backup. */ - target?: string | null; + backupImage?: string | null; /** - * Output only. Name of the verb executed by the operation. + * The job name on the backup/recovery appliance that created this lock. */ - verb?: string | null; + jobName?: string | null; + /** + * Required. The reason for the lock: e.g. MOUNT/RESTORE/BACKUP/etc. The value of this string is only meaningful to the client and it is not interpreted by the BackupVault service. + */ + lockReason?: string | null; + /** + * The SLA on the backup/recovery appliance that owns the lock. + */ + slaId?: string | null; } /** - * 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/). + * BackupConfigInfo has information about how the resource is configured for Backup and about the most recent backup to this vault. */ - export interface Schema$Policy { - /** - * Specifies cloud audit logging configuration for this policy. - */ - auditConfigs?: Schema$AuditConfig[]; + export interface Schema$BackupConfigInfo { /** - * 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`. + * Configuration for an application backed up by a Backup Appliance. */ - bindings?: Schema$Binding[]; + backupApplianceBackupConfig?: Schema$BackupApplianceBackupConfig; /** - * `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. + * Configuration for a Google Cloud resource. */ - etag?: string | null; + gcpBackupConfig?: Schema$GcpBackupConfig; /** - * 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. If the last backup failed, this field has the error message. */ - version?: number | null; - } - /** - * Request message for `SetIamPolicy` method. - */ - export interface Schema$SetIamPolicyRequest { + lastBackupError?: Schema$Status; /** - * 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. + * Output only. The status of the last backup to this BackupVault */ - policy?: Schema$Policy; + lastBackupState?: string | null; /** - * 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"` + * Output only. If the last backup were successful, this field has the consistency date. */ - updateMask?: string | null; + lastSuccessfulBackupConsistencyTime?: string | null; } /** - * 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). + * BackupLock represents a single lock on a Backup resource. An unexpired lock on a Backup prevents the Backup from being deleted. */ - export interface Schema$Status { + export interface Schema$BackupLock { /** - * The status code, which should be an enum value of google.rpc.Code. + * If the client is a backup and recovery appliance, this contains metadata about why the lock exists. */ - code?: number | null; + backupApplianceLockInfo?: Schema$BackupApplianceLockInfo; /** - * A list of messages that carry the error details. There is a common set of message types for APIs to use. + * Required. The time after which this lock is not considered valid and will no longer protect the Backup from deletion. */ - details?: Array<{[key: string]: any}> | null; + lockUntilTime?: string | null; /** - * 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. + * Output only. Contains metadata about the lock exist for Google Cloud native backups. */ - message?: string | null; + serviceLockInfo?: Schema$ServiceLockInfo; } /** - * Request message for `TestIamPermissions` method. + * Message describing a BackupVault object. */ - export interface Schema$TestIamPermissionsRequest { + export interface Schema$BackupVault { /** - * 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). + * Optional. User annotations. See https://google.aip.dev/128#annotations Stores small amounts of arbitrary data. */ - permissions?: string[] | null; - } - /** - * Response message for `TestIamPermissions` method. - */ - export interface Schema$TestIamPermissionsResponse { + annotations?: {[key: string]: string} | null; /** - * A subset of `TestPermissionsRequest.permissions` that the caller is allowed. + * Output only. The number of backups in this backup vault. */ - permissions?: string[] | null; - } - /** - * ManagementURI depending on the Workforce Identity i.e. either 1p or 3p. - */ - export interface Schema$WorkforceIdentityBasedManagementURI { + backupCount?: string | null; /** - * Output only. First party Management URI for Google Identities. + * Required. The default and minimum enforced retention for each backup within the backup vault. The enforced retention for each backup can be extended. */ - firstPartyManagementUri?: string | null; + backupMinimumEnforcedRetentionDuration?: string | null; + /** + * Output only. The time when the instance was created. + */ + createTime?: string | null; + /** + * Output only. Set to true when there are no backups nested under this resource. + */ + deletable?: boolean | null; + /** + * Optional. The description of the BackupVault instance (2048 characters or less). + */ + description?: string | null; + /** + * Optional. Time after which the BackupVault resource is locked. + */ + effectiveTime?: string | null; + /** + * Required. The default retention period for each backup in the backup vault (Deprecated). + */ + enforcedRetentionDuration?: string | null; + /** + * Optional. Server specified ETag for the backup vault resource to prevent simultaneous updates from overwiting each other. + */ + etag?: string | null; + /** + * Optional. Resource labels to represent user provided metadata. No labels currently defined: + */ + labels?: {[key: string]: string} | null; + /** + * Output only. The resource name. + */ + name?: string | null; + /** + * Output only. Service account used by the BackupVault Service for this BackupVault. The user should grant this account permissions in their workload project to enable the service to run backups and restores there. + */ + serviceAccount?: string | null; + /** + * Output only. The BackupVault resource instance state. + */ + state?: string | null; + /** + * Output only. Total size of the storage used by all backup resources. + */ + totalStoredBytes?: string | null; + /** + * Output only. Output only Immutable after resource creation until resource deletion. + */ + uid?: string | null; + /** + * Output only. The time when the instance was updated. + */ + updateTime?: string | null; + } + /** + * Associates `members`, or principals, with a `role`. + */ + export interface Schema$Binding { + /** + * 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). + */ + condition?: Schema$Expr; + /** + * 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\}/x`: 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\}/x`: 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`. + */ + members?: string[] | null; + /** + * 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). + */ + role?: string | null; + } + /** + * The request message for Operations.CancelOperation. + */ + export interface Schema$CancelOperationRequest {} + /** + * ComputeInstanceBackupProperties represents Compute Engine instance backup properties. + */ + export interface Schema$ComputeInstanceBackupProperties { + /** + * 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 https://cloud.google.com/vpc/docs/using-routes#canipforward documentation for more information. + */ + canIpForward?: boolean | null; + /** + * An optional text description for the instances that are created from these properties. + */ + description?: string | null; + /** + * An array of disks that are associated with the instances that are created from these properties. + */ + disk?: Schema$AttachedDisk[]; + /** + * A list of guest accelerator cards' type and count to use for instances created from these properties. + */ + guestAccelerator?: Schema$AcceleratorConfig[]; + /** + * KeyRevocationActionType of the instance. Supported options are "STOP" and "NONE". The default value is "NONE" if it is not specified. + */ + keyRevocationActionType?: string | null; + /** + * The machine type to use for instances that are created from these properties. + */ + machineType?: string | null; + /** + * 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 https://cloud.google.com/compute/docs/metadata/overview for more information. + */ + metadata?: Schema$Metadata; + /** + * 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 https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform. + */ + minCpuPlatform?: string | null; + /** + * An array of network access configurations for this interface. + */ + networkInterface?: Schema$NetworkInterface[]; + /** + * Specifies the scheduling options for the instances that are created from these properties. + */ + scheduling?: Schema$Scheduling; + /** + * 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. + */ + serviceAccount?: Schema$ServiceAccount[]; + /** + * Name of the source instance at the time of backup. The name is 1-63 characters long, and complies with RFC1035. + */ + sourceInstanceName?: string | null; + /** + * 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 (https://www.ietf.org/rfc/rfc1035.txt). + */ + tags?: Schema$Tags; + } + /** + * ComputeInstanceDataSourceProperties represents the properties of a ComputeEngine resource that are stored in the DataSource. + */ + export interface Schema$ComputeInstanceDataSourceProperties { + /** + * The description of the Compute Engine instance. + */ + description?: string | null; + /** + * The machine type of the instance. + */ + machineType?: string | null; + /** + * Name of the compute instance backed up by the datasource. + */ + name?: string | null; + /** + * The total number of disks attached to the Instance. + */ + totalDiskCount?: string | null; + /** + * The sum of all the disk sizes. + */ + totalDiskSizeGb?: string | null; + } + /** + * A customer-supplied encryption key. + */ + export interface Schema$CustomerEncryptionKey { + /** + * Optional. The name of the encryption key that is stored in Google Cloud KMS. + */ + kmsKeyName?: string | null; + /** + * Optional. The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used. + */ + kmsKeyServiceAccount?: string | null; + /** + * Optional. Specifies a 256-bit customer-supplied encryption key. + */ + rawKey?: string | null; + /** + * Optional. RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. + */ + rsaEncryptedKey?: string | null; + } + /** + * Message describing a DataSource object. Datasource object used to represent Datasource details for both admin and basic view. + */ + export interface Schema$DataSource { + /** + * Output only. Details of how the resource is configured for backup. + */ + backupConfigInfo?: Schema$BackupConfigInfo; + /** + * Number of backups in the data source. + */ + backupCount?: string | null; + /** + * The backup configuration state. + */ + configState?: string | null; + /** + * Output only. The time when the instance was created. + */ + createTime?: string | null; + /** + * The backed up resource is a backup appliance application. + */ + dataSourceBackupApplianceApplication?: Schema$DataSourceBackupApplianceApplication; + /** + * The backed up resource is a Google Cloud resource. The word 'DataSource' was included in the names to indicate that this is the representation of the Google Cloud resource used within the DataSource object. + */ + dataSourceGcpResource?: Schema$DataSourceGcpResource; + /** + * Server specified ETag for the ManagementServer resource to prevent simultaneous updates from overwiting each other. + */ + etag?: string | null; + /** + * Optional. Resource labels to represent user provided metadata. No labels currently defined: + */ + labels?: {[key: string]: string} | null; + /** + * Output only. The resource name. + */ + name?: string | null; + /** + * Output only. The DataSource resource instance state. + */ + state?: string | null; + /** + * The number of bytes (metadata and data) stored in this datasource. + */ + totalStoredBytes?: string | null; + /** + * Output only. The time when the instance was updated. + */ + updateTime?: string | null; + } + /** + * BackupApplianceApplication describes a Source Resource when it is an application backed up by a BackupAppliance. + */ + export interface Schema$DataSourceBackupApplianceApplication { + /** + * Appliance Id of the Backup Appliance. + */ + applianceId?: string | null; + /** + * The appid field of the application within the Backup Appliance. + */ + applicationId?: string | null; + /** + * The name of the Application as known to the Backup Appliance. + */ + applicationName?: string | null; + /** + * Appliance name. + */ + backupAppliance?: string | null; + /** + * Hostid of the application host. + */ + hostId?: string | null; + /** + * Hostname of the host where the application is running. + */ + hostname?: string | null; + /** + * The type of the application. e.g. VMBackup + */ + type?: string | null; + } + /** + * DataSourceGcpResource is used for protected resources that are Google Cloud Resources. This name is easeier to understand than GcpResourceDataSource or GcpDataSourceResource + */ + export interface Schema$DataSourceGcpResource { + /** + * ComputeInstanceDataSourceProperties has a subset of Compute Instance properties that are useful at the Datasource level. + */ + computeInstanceDatasourceProperties?: Schema$ComputeInstanceDataSourceProperties; + /** + * Output only. Full resource pathname URL of the source Google Cloud resource. + */ + gcpResourcename?: string | null; + /** + * Location of the resource: //"global"/"unspecified". + */ + location?: string | null; + /** + * The type of the Google Cloud resource. Use the Unified Resource Type, eg. compute.googleapis.com/Instance. + */ + type?: string | null; + } + /** + * 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); \} + */ + export interface Schema$Empty {} + /** + * A key/value pair to be used for storing metadata. + */ + export interface Schema$Entry { + /** + * Optional. Key for the metadata entry. + */ + key?: string | null; + /** + * Optional. 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). + */ + value?: string | null; + } + /** + * 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. + */ + export interface Schema$Expr { + /** + * Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. + */ + description?: string | null; + /** + * Textual representation of an expression in Common Expression Language syntax. + */ + expression?: string | null; + /** + * Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. + */ + location?: string | null; + /** + * 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. + */ + title?: string | null; + } + /** + * Request message for FetchAccessToken. + */ + export interface Schema$FetchAccessTokenRequest { + /** + * Required. The generation of the backup to update. + */ + generationId?: number | null; + } + /** + * Response message for FetchAccessToken. + */ + export interface Schema$FetchAccessTokenResponse { + /** + * The token is valid until this time. + */ + expireTime?: string | null; + /** + * The location in bucket that can be used for reading. + */ + readLocation?: string | null; + /** + * The downscoped token that was created. + */ + token?: string | null; + /** + * The location in bucket that can be used for writing. + */ + writeLocation?: string | null; + } + /** + * Response message for fetching usable BackupVaults. + */ + export interface Schema$FetchUsableBackupVaultsResponse { + /** + * The list of BackupVault instances in the project for the specified location. If the '{location\}' value in the request is "-", the response contains a list of instances from all locations. In case any location is unreachable, the response will only return backup vaults in reachable locations and the 'unreachable' field will be populated with a list of unreachable locations. + */ + backupVaults?: Schema$BackupVault[]; + /** + * A token identifying a page of results the server should return. + */ + nextPageToken?: string | null; + /** + * Locations that could not be reached. + */ + unreachable?: string[] | null; + } + /** + * Message for finalizing a Backup. + */ + export interface Schema$FinalizeBackupRequest { + /** + * Required. Resource ID of the Backup resource to be finalized. This must be the same backup_id that was used in the InitiateBackupRequest. + */ + backupId?: string | null; + /** + * The point in time when this backup was captured from the source. This will be assigned to the consistency_time field of the newly created Backup. + */ + consistencyTime?: string | null; + /** + * This will be assigned to the description field of the newly created Backup. + */ + description?: string | null; + /** + * The latest timestamp of data available in this Backup. This will be set on the newly created Backup. + */ + recoveryRangeEndTime?: string | null; + /** + * The earliest timestamp of data available in this Backup. This will set on the newly created Backup. + */ + recoveryRangeStartTime?: string | null; + /** + * 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). + */ + requestId?: string | null; + /** + * The ExpireTime on the backup will be set to FinalizeTime plus this duration. If the resulting ExpireTime is less than EnforcedRetentionEndTime, then ExpireTime is set to EnforcedRetentionEndTime. + */ + retentionDuration?: string | null; + } + /** + * GcpBackupConfig captures the Backup configuration details for Google Cloud resources. All Google Cloud resources regardless of type are protected with backup plan associations. + */ + export interface Schema$GcpBackupConfig { + /** + * The name of the backup plan. + */ + backupPlan?: string | null; + /** + * The name of the backup plan association. + */ + backupPlanAssociation?: string | null; + /** + * The description of the backup plan. + */ + backupPlanDescription?: string | null; + /** + * The names of the backup plan rules which point to this backupvault + */ + backupPlanRules?: string[] | null; + } + /** + * GCPBackupPlanInfo captures the plan configuration details of Google Cloud resources at the time of backup. + */ + export interface Schema$GCPBackupPlanInfo { + /** + * Resource name of backup plan by which workload is protected at the time of the backup. Format: projects/{project\}/locations/{location\}/backupPlans/{backupPlanId\} + */ + backupPlan?: string | null; + /** + * The rule id of the backup plan which triggered this backup in case of scheduled backup or used for + */ + backupPlanRuleId?: string | null; + } + /** + * Feature type of the Guest OS. + */ + export interface Schema$GuestOsFeature { + /** + * The ID of a supported feature. + */ + type?: string | null; + } + /** + * Specifies the parameters to initialize this disk. + */ + export interface Schema$InitializeParams { + /** + * Optional. Specifies the disk name. If not specified, the default is to use the name of the instance. + */ + diskName?: string | null; + /** + * Optional. URL of the zone where the disk should be created. Required for each regional disk associated with the instance. + */ + replicaZones?: string[] | null; + } + /** + * request message for InitiateBackup. + */ + export interface Schema$InitiateBackupRequest { + /** + * Required. Resource ID of the Backup resource. + */ + backupId?: string | null; + /** + * 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). + */ + requestId?: string | null; + } + /** + * Response message for InitiateBackup. + */ + export interface Schema$InitiateBackupResponse { + /** + * The name of the backup that was created. + */ + backup?: string | null; + /** + * The generation id of the base backup. It is needed for the incremental backups. + */ + baseBackupGenerationId?: number | null; + /** + * The generation id of the new backup. + */ + newBackupGenerationId?: number | null; + } + /** + * Response message for listing Backups. + */ + export interface Schema$ListBackupsResponse { + /** + * The list of Backup instances in the project for the specified location. If the '{location\}' value in the request is "-", the response contains a list of instances from all locations. In case any location is unreachable, the response will only return data sources in reachable locations and the 'unreachable' field will be populated with a list of unreachable locations. + */ + backups?: Schema$Backup[]; + /** + * A token identifying a page of results the server should return. + */ + nextPageToken?: string | null; + /** + * Locations that could not be reached. + */ + unreachable?: string[] | null; + } + /** + * Response message for listing BackupVaults. + */ + export interface Schema$ListBackupVaultsResponse { + /** + * The list of BackupVault instances in the project for the specified location. If the '{location\}' value in the request is "-", the response contains a list of instances from all locations. In case any location is unreachable, the response will only return backup vaults in reachable locations and the 'unreachable' field will be populated with a list of unreachable locations. + */ + backupVaults?: Schema$BackupVault[]; + /** + * A token identifying a page of results the server should return. + */ + nextPageToken?: string | null; + /** + * Locations that could not be reached. + */ + unreachable?: string[] | null; + } + /** + * Response message for listing DataSources. + */ + export interface Schema$ListDataSourcesResponse { + /** + * The list of DataSource instances in the project for the specified location. If the '{location\}' value in the request is "-", the response contains a list of instances from all locations. In case any location is unreachable, the response will only return data sources in reachable locations and the 'unreachable' field will be populated with a list of unreachable locations. + */ + dataSources?: Schema$DataSource[]; + /** + * A token identifying a page of results the server should return. + */ + nextPageToken?: string | null; + /** + * Locations that could not be reached. + */ + unreachable?: string[] | null; + } + /** + * The response message for Locations.ListLocations. + */ + export interface Schema$ListLocationsResponse { + /** + * A list of locations that matches the specified filter in the request. + */ + locations?: Schema$Location[]; + /** + * The standard List next-page token. + */ + nextPageToken?: string | null; + } + /** + * Response message for listing management servers. + */ + export interface Schema$ListManagementServersResponse { + /** + * The list of ManagementServer instances in the project for the specified location. If the '{location\}' value in the request is "-", the response contains a list of instances from all locations. In case any location is unreachable, the response will only return management servers in reachable locations and the 'unreachable' field will be populated with a list of unreachable locations. + */ + managementServers?: Schema$ManagementServer[]; + /** + * A token identifying a page of results the server should return. + */ + nextPageToken?: string | null; + /** + * Locations that could not be reached. + */ + unreachable?: string[] | null; + } + /** + * The response message for Operations.ListOperations. + */ + export interface Schema$ListOperationsResponse { + /** + * The standard List next-page token. + */ + nextPageToken?: string | null; + /** + * A list of operations that matches the specified filter in the request. + */ + operations?: Schema$Operation[]; + } + /** + * A resource that represents a Google Cloud location. + */ + export interface Schema$Location { + /** + * The friendly name for this location, typically a nearby city name. For example, "Tokyo". + */ + displayName?: string | null; + /** + * Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"\} + */ + labels?: {[key: string]: string} | null; + /** + * The canonical id for this location. For example: `"us-east1"`. + */ + locationId?: string | null; + /** + * Service-specific metadata. For example the available capacity at the given location. + */ + metadata?: {[key: string]: any} | null; + /** + * Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"` + */ + name?: string | null; + } + /** + * ManagementServer describes a single BackupDR ManagementServer instance. + */ + export interface Schema$ManagementServer { + /** + * Output only. The hostname or ip address of the exposed AGM endpoints, used by BAs to connect to BA proxy. + */ + baProxyUri?: string[] | null; + /** + * Output only. The time when the instance was created. + */ + createTime?: string | null; + /** + * Optional. The description of the ManagementServer instance (2048 characters or less). + */ + description?: string | null; + /** + * Optional. Server specified ETag for the ManagementServer resource to prevent simultaneous updates from overwiting each other. + */ + etag?: string | null; + /** + * Optional. Resource labels to represent user provided metadata. Labels currently defined: 1. migrate_from_go= If set to true, the MS is created in migration ready mode. + */ + labels?: {[key: string]: string} | null; + /** + * Output only. The hostname or ip address of the exposed AGM endpoints, used by clients to connect to AGM/RD graphical user interface and APIs. + */ + managementUri?: Schema$ManagementURI; + /** + * Output only. Identifier. The resource name. + */ + name?: string | null; + /** + * Required. VPC networks to which the ManagementServer instance is connected. For this version, only a single network is supported. + */ + networks?: Schema$NetworkConfig[]; + /** + * Output only. The OAuth 2.0 client id is required to make API calls to the BackupDR instance API of this ManagementServer. This is the value that should be provided in the 'aud' field of the OIDC ID Token (see openid specification https://openid.net/specs/openid-connect-core-1_0.html#IDToken). + */ + oauth2ClientId?: string | null; + /** + * Output only. Reserved for future use. + */ + satisfiesPzi?: boolean | null; + /** + * Output only. Reserved for future use. + */ + satisfiesPzs?: boolean | null; + /** + * Output only. The ManagementServer state. + */ + state?: string | null; + /** + * Optional. The type of the ManagementServer resource. + */ + type?: string | null; + /** + * Output only. The time when the instance was updated. + */ + updateTime?: string | null; + /** + * Output only. The hostnames of the exposed AGM endpoints for both types of user i.e. 1p and 3p, used to connect AGM/RM UI. + */ + workforceIdentityBasedManagementUri?: Schema$WorkforceIdentityBasedManagementURI; + /** + * Output only. The OAuth client IDs for both types of user i.e. 1p and 3p. + */ + workforceIdentityBasedOauth2ClientId?: Schema$WorkforceIdentityBasedOAuth2ClientID; + } + /** + * ManagementURI for the Management Server resource. + */ + export interface Schema$ManagementURI { + /** + * Output only. The ManagementServer AGM/RD API URL. + */ + api?: string | null; + /** + * Output only. The ManagementServer AGM/RD WebUI URL. + */ + webUi?: string | null; + } + /** + * A metadata key/value entry. + */ + export interface Schema$Metadata { + /** + * Optional. Array of key/value pairs. The total size of all keys and values must be less than 512 KB. + */ + items?: Schema$Entry[]; + } + /** + * Network configuration for ManagementServer instance. + */ + export interface Schema$NetworkConfig { + /** + * Optional. The resource name of the Google Compute Engine VPC network to which the ManagementServer instance is connected. + */ + network?: string | null; + /** + * Optional. The network connect mode of the ManagementServer instance. For this version, only PRIVATE_SERVICE_ACCESS is supported. + */ + peeringMode?: string | null; + } + /** + * A network interface resource attached to an instance. s + */ + export interface Schema$NetworkInterface { + /** + * Optional. 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. + */ + accessConfigs?: Schema$AccessConfig[]; + /** + * Optional. An array of alias IP ranges for this network interface. You can only specify this field for network interfaces in VPC networks. + */ + aliasIpRanges?: Schema$AliasIpRange[]; + /** + * Optional. The prefix length of the primary internal IPv6 range. + */ + internalIpv6PrefixLength?: number | null; + /** + * Optional. 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. + */ + ipv6AccessConfigs?: Schema$AccessConfig[]; + /** + * 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. + */ + ipv6AccessType?: string | null; + /** + * Optional. 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. + */ + ipv6Address?: string | null; + /** + * Output only. [Output Only] The name of the network interface, which is generated by the server. + */ + name?: string | null; + /** + * Optional. URL of the VPC network resource for this instance. + */ + network?: string | null; + /** + * Optional. 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\}. + */ + networkAttachment?: string | null; + /** + * Optional. 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. + */ + networkIP?: string | null; + /** + * Optional. The type of vNIC to be used on this interface. This may be gVNIC or VirtioNet. + */ + nicType?: string | null; + /** + * Optional. 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. + */ + queueCount?: number | null; + /** + * The stack type for this network interface. + */ + stackType?: string | null; + /** + * Optional. The URL of the Subnetwork resource for this instance. + */ + subnetwork?: string | null; + } + /** + * Node Affinity: the configuration of desired nodes onto which this Instance could be scheduled. + */ + export interface Schema$NodeAffinity { + /** + * Optional. Corresponds to the label key of Node resource. + */ + key?: string | null; + /** + * Optional. Defines the operation of node selection. + */ + operator?: string | null; + /** + * Optional. Corresponds to the label values of Node resource. + */ + values?: string[] | null; + } + /** + * This resource represents a long-running operation that is the result of a network API call. + */ + export interface Schema$Operation { + /** + * 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. + */ + done?: boolean | null; + /** + * The error result of the operation in case of failure or cancellation. + */ + error?: Schema$Status; + /** + * 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. + */ + metadata?: {[key: string]: any} | null; + /** + * 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\}`. + */ + name?: string | null; + /** + * 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`. + */ + response?: {[key: string]: any} | null; + } + /** + * Represents the metadata of the long-running operation. + */ + export interface Schema$OperationMetadata { + /** + * Output only. AdditionalInfo contains additional Info related to backup plan association resource. + */ + additionalInfo?: {[key: string]: string} | null; + /** + * Output only. API version used to start the operation. + */ + apiVersion?: string | null; + /** + * Output only. The time the operation was created. + */ + createTime?: string | null; + /** + * Output only. The time the operation finished running. + */ + endTime?: string | null; + /** + * 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'. + */ + requestedCancellation?: boolean | null; + /** + * Output only. Human-readable status of the operation, if any. + */ + statusMessage?: string | null; + /** + * Output only. Server-defined resource path for the target of the operation. + */ + target?: string | null; + /** + * Output only. Name of the verb executed by the operation. + */ + verb?: string | null; + } + /** + * 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/). + */ + export interface Schema$Policy { + /** + * Specifies cloud audit logging configuration for this policy. + */ + auditConfigs?: Schema$AuditConfig[]; + /** + * 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`. + */ + bindings?: Schema$Binding[]; + /** + * `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. + */ + etag?: string | null; + /** + * 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). + */ + version?: number | null; + } + /** + * Message for deleting a DataSource. + */ + export interface Schema$RemoveDataSourceRequest { + /** + * 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). + */ + requestId?: string | null; + } + /** + * Sets the scheduling options for an Instance. + */ + export interface Schema$Scheduling { + /** + * Optional. Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). + */ + automaticRestart?: boolean | null; + /** + * Optional. Specifies the termination action for the instance. + */ + instanceTerminationAction?: string | null; + /** + * Optional. 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. + */ + localSsdRecoveryTimeout?: Schema$SchedulingDuration; + /** + * Optional. The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node. + */ + minNodeCpus?: number | null; + /** + * Optional. A set of node affinity and anti-affinity configurations. Overrides reservationAffinity. + */ + nodeAffinities?: Schema$NodeAffinity[]; + /** + * Optional. Defines the maintenance behavior for this instance. + */ + onHostMaintenance?: string | null; + /** + * Optional. Defines whether the instance is preemptible. + */ + preemptible?: boolean | null; + /** + * Optional. Specifies the provisioning model of the instance. + */ + provisioningModel?: string | null; + } + /** + * A SchedulingDuration 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. + */ + export interface Schema$SchedulingDuration { + /** + * Optional. Span of time that's a fraction of a second at nanosecond resolution. + */ + nanos?: number | null; + /** + * Optional. Span of time at a resolution of a second. + */ + seconds?: string | null; + } + /** + * A service account. + */ + export interface Schema$ServiceAccount { + /** + * Optional. Email address of the service account. + */ + email?: string | null; + /** + * Optional. The list of scopes to be made available for this service account. + */ + scopes?: string[] | null; + } + /** + * ServiceLockInfo represents the details of a lock taken by the service on a Backup resource. + */ + export interface Schema$ServiceLockInfo { + /** + * Output only. The name of the operation that created this lock. The lock will automatically be released when the operation completes. + */ + operation?: string | null; + } + /** + * Request message for `SetIamPolicy` method. + */ + export interface Schema$SetIamPolicyRequest { + /** + * 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. + */ + policy?: Schema$Policy; + /** + * 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"` + */ + updateMask?: string | null; + } + /** + * Request message for SetStatusInternal method. + */ + export interface Schema$SetInternalStatusRequest { + /** + * Required. The new BackupConfigState to set for the DataSource. + */ + backupConfigState?: string | null; + /** + * 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. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string | null; + /** + * Required. The value required for this method to work. This field must be the 32-byte SHA256 hash of the DataSourceID. The DataSourceID used here is only the final piece of the fully qualified resource path for this DataSource (i.e. the part after '.../dataSources/'). This field exists to make this method difficult to call since it is intended for use only by Backup Appliances. + */ + value?: string | null; + } + /** + * 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). + */ + export interface Schema$Status { + /** + * The status code, which should be an enum value of google.rpc.Code. + */ + code?: number | null; + /** + * A list of messages that carry the error details. There is a common set of message types for APIs to use. + */ + details?: Array<{[key: string]: any}> | null; + /** + * 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. + */ + message?: string | null; + } + /** + * A set of instance tags. + */ + export interface Schema$Tags { + /** + * Optional. An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035. + */ + items?: string[] | null; + } + /** + * Request message for `TestIamPermissions` method. + */ + export interface Schema$TestIamPermissionsRequest { + /** + * 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). + */ + permissions?: string[] | null; + } + /** + * Response message for `TestIamPermissions` method. + */ + export interface Schema$TestIamPermissionsResponse { + /** + * A subset of `TestPermissionsRequest.permissions` that the caller is allowed. + */ + permissions?: string[] | null; + } + /** + * ManagementURI depending on the Workforce Identity i.e. either 1p or 3p. + */ + export interface Schema$WorkforceIdentityBasedManagementURI { + /** + * Output only. First party Management URI for Google Identities. + */ + firstPartyManagementUri?: string | null; /** * Output only. Third party Management URI for External Identity Providers. */ - thirdPartyManagementUri?: string | null; + thirdPartyManagementUri?: string | null; + } + /** + * OAuth Client ID depending on the Workforce Identity i.e. either 1p or 3p, + */ + export interface Schema$WorkforceIdentityBasedOAuth2ClientID { + /** + * Output only. First party OAuth Client ID for Google Identities. + */ + firstPartyOauth2ClientId?: string | null; + /** + * Output only. Third party OAuth Client ID for External Identity Providers. + */ + thirdPartyOauth2ClientId?: string | null; + } + + export class Resource$Projects { + context: APIRequestContext; + locations: Resource$Projects$Locations; + constructor(context: APIRequestContext) { + this.context = context; + this.locations = new Resource$Projects$Locations(this.context); + } + } + + export class Resource$Projects$Locations { + context: APIRequestContext; + backupVaults: Resource$Projects$Locations$Backupvaults; + managementServers: Resource$Projects$Locations$Managementservers; + operations: Resource$Projects$Locations$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.backupVaults = new Resource$Projects$Locations$Backupvaults( + this.context + ); + this.managementServers = + new Resource$Projects$Locations$Managementservers(this.context); + this.operations = new Resource$Projects$Locations$Operations( + this.context + ); + } + + /** + * Gets information about a location. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Projects$Locations$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://backupdr.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists information about the supported locations for this service. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Locations$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://backupdr.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}/locations').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Get + extends StandardParameters { + /** + * Resource name for the location. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$List + extends StandardParameters { + /** + * A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). + */ + filter?: string; + /** + * The resource that owns the locations collection, if applicable. + */ + name?: string; + /** + * The maximum number of results to return. If not set, the service selects a default. + */ + pageSize?: number; + /** + * A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. + */ + pageToken?: string; + } + + export class Resource$Projects$Locations$Backupvaults { + context: APIRequestContext; + dataSources: Resource$Projects$Locations$Backupvaults$Datasources; + constructor(context: APIRequestContext) { + this.context = context; + this.dataSources = + new Resource$Projects$Locations$Backupvaults$Datasources(this.context); + } + + /** + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + create( + params: Params$Resource$Projects$Locations$Backupvaults$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Projects$Locations$Backupvaults$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Backupvaults$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Backupvaults$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Backupvaults$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Backupvaults$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Backupvaults$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Backupvaults$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://backupdr.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/backupVaults').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Deletes a BackupVault. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Projects$Locations$Backupvaults$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Projects$Locations$Backupvaults$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Backupvaults$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Backupvaults$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Backupvaults$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Backupvaults$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Backupvaults$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Backupvaults$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://backupdr.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * FetchUsableBackupVaults lists usable BackupVaults in a given project and location. Usable BackupVault are the ones that user has backupdr.backupVaults.get permission. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + fetchUsable( + params: Params$Resource$Projects$Locations$Backupvaults$Fetchusable, + options: StreamMethodOptions + ): GaxiosPromise; + fetchUsable( + params?: Params$Resource$Projects$Locations$Backupvaults$Fetchusable, + options?: MethodOptions + ): GaxiosPromise; + fetchUsable( + params: Params$Resource$Projects$Locations$Backupvaults$Fetchusable, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + fetchUsable( + params: Params$Resource$Projects$Locations$Backupvaults$Fetchusable, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + fetchUsable( + params: Params$Resource$Projects$Locations$Backupvaults$Fetchusable, + callback: BodyResponseCallback + ): void; + fetchUsable( + callback: BodyResponseCallback + ): void; + fetchUsable( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Backupvaults$Fetchusable + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Backupvaults$Fetchusable; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Backupvaults$Fetchusable; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://backupdr.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/backupVaults:fetchUsable').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Gets details of a BackupVault. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Projects$Locations$Backupvaults$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Backupvaults$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Backupvaults$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Backupvaults$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Backupvaults$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Backupvaults$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Backupvaults$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Backupvaults$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://backupdr.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists BackupVaults in a given project and location. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Locations$Backupvaults$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Backupvaults$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Backupvaults$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Backupvaults$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Backupvaults$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Backupvaults$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Backupvaults$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Backupvaults$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://backupdr.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/backupVaults').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Updates the settings of a BackupVault. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + patch( + params: Params$Resource$Projects$Locations$Backupvaults$Patch, + options: StreamMethodOptions + ): GaxiosPromise; + patch( + params?: Params$Resource$Projects$Locations$Backupvaults$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Backupvaults$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Backupvaults$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Backupvaults$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Backupvaults$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Backupvaults$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Backupvaults$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://backupdr.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Returns the caller's permissions on a BackupVault resource. A caller is not required to have Google IAM permission to make this request. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + testIamPermissions( + params: Params$Resource$Projects$Locations$Backupvaults$Testiampermissions, + options: StreamMethodOptions + ): GaxiosPromise; + testIamPermissions( + params?: Params$Resource$Projects$Locations$Backupvaults$Testiampermissions, + options?: MethodOptions + ): GaxiosPromise; + testIamPermissions( + params: Params$Resource$Projects$Locations$Backupvaults$Testiampermissions, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Projects$Locations$Backupvaults$Testiampermissions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Projects$Locations$Backupvaults$Testiampermissions, + callback: BodyResponseCallback + ): void; + testIamPermissions( + callback: BodyResponseCallback + ): void; + testIamPermissions( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Backupvaults$Testiampermissions + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Backupvaults$Testiampermissions; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Backupvaults$Testiampermissions; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://backupdr.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+resource}:testIamPermissions').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['resource'], + pathParams: ['resource'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Backupvaults$Create + extends StandardParameters { + /** + * Required. ID of the requesting object If auto-generating ID server-side, remove this field and backup_vault_id from the method_signature of Create RPC + */ + backupVaultId?: string; + /** + * Required. Value for parent. + */ + parent?: string; + /** + * 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). + */ + requestId?: string; + /** + * Optional. Only validate the request, but do not perform mutations. The default is 'false'. + */ + validateOnly?: boolean; + + /** + * Request body metadata + */ + requestBody?: Schema$BackupVault; + } + export interface Params$Resource$Projects$Locations$Backupvaults$Delete + extends StandardParameters { + /** + * Optional. If true and the BackupVault is not found, the request will succeed but no action will be taken. + */ + allowMissing?: boolean; + /** + * The current etag of the backup vault. If an etag is provided and does not match the current etag of the connection, deletion will be blocked. + */ + etag?: string; + /** + * Optional. If set to true, any data source from this backup vault will also be deleted. + */ + force?: boolean; + /** + * Required. Name of the resource. + */ + name?: string; + /** + * 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). + */ + requestId?: string; + /** + * Optional. Only validate the request, but do not perform mutations. The default is 'false'. + */ + validateOnly?: boolean; + } + export interface Params$Resource$Projects$Locations$Backupvaults$Fetchusable + extends StandardParameters { + /** + * Optional. Filtering results. + */ + filter?: string; + /** + * Optional. Hint for how to order the results. + */ + orderBy?: string; + /** + * Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. + */ + pageSize?: number; + /** + * Optional. A token identifying a page of results the server should return. + */ + pageToken?: string; + /** + * Required. The project and location for which to retrieve backupvault stores information, in the format 'projects/{project_id\}/locations/{location\}'. In Cloud Backup and DR, locations map to Google Cloud regions, for example **us-central1**. To retrieve backupvault stores for all locations, use "-" for the '{location\}' value. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Backupvaults$Get + extends StandardParameters { + /** + * Required. Name of the backupvault store resource name, in the format 'projects/{project_id\}/locations/{location\}/backupVaults/{resource_name\}' + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Backupvaults$List + extends StandardParameters { + /** + * Optional. Filtering results. + */ + filter?: string; + /** + * Optional. Hint for how to order the results. + */ + orderBy?: string; + /** + * Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. + */ + pageSize?: number; + /** + * Optional. A token identifying a page of results the server should return. + */ + pageToken?: string; + /** + * Required. The project and location for which to retrieve backupvault stores information, in the format 'projects/{project_id\}/locations/{location\}'. In Cloud Backup and DR, locations map to Google Cloud regions, for example **us-central1**. To retrieve backupvault stores for all locations, use "-" for the '{location\}' value. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Backupvaults$Patch + extends StandardParameters { + /** + * Output only. The resource name. + */ + name?: string; + /** + * 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). + */ + requestId?: string; + /** + * Required. Field mask is used to specify the fields to be overwritten in the BackupVault resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then the request will fail. + */ + updateMask?: string; + /** + * Optional. Only validate the request, but do not perform mutations. The default is 'false'. + */ + validateOnly?: boolean; + + /** + * Request body metadata + */ + requestBody?: Schema$BackupVault; + } + export interface Params$Resource$Projects$Locations$Backupvaults$Testiampermissions + extends StandardParameters { + /** + * REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$TestIamPermissionsRequest; + } + + export class Resource$Projects$Locations$Backupvaults$Datasources { + context: APIRequestContext; + backups: Resource$Projects$Locations$Backupvaults$Datasources$Backups; + constructor(context: APIRequestContext) { + this.context = context; + this.backups = + new Resource$Projects$Locations$Backupvaults$Datasources$Backups( + this.context + ); + } + + /** + * Internal only. Abandons a backup. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + abandonBackup( + params: Params$Resource$Projects$Locations$Backupvaults$Datasources$Abandonbackup, + options: StreamMethodOptions + ): GaxiosPromise; + abandonBackup( + params?: Params$Resource$Projects$Locations$Backupvaults$Datasources$Abandonbackup, + options?: MethodOptions + ): GaxiosPromise; + abandonBackup( + params: Params$Resource$Projects$Locations$Backupvaults$Datasources$Abandonbackup, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + abandonBackup( + params: Params$Resource$Projects$Locations$Backupvaults$Datasources$Abandonbackup, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + abandonBackup( + params: Params$Resource$Projects$Locations$Backupvaults$Datasources$Abandonbackup, + callback: BodyResponseCallback + ): void; + abandonBackup(callback: BodyResponseCallback): void; + abandonBackup( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Backupvaults$Datasources$Abandonbackup + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Backupvaults$Datasources$Abandonbackup; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Backupvaults$Datasources$Abandonbackup; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://backupdr.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+dataSource}:abandonBackup').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['dataSource'], + pathParams: ['dataSource'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Internal only. Fetch access token for a given data source. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + fetchAccessToken( + params: Params$Resource$Projects$Locations$Backupvaults$Datasources$Fetchaccesstoken, + options: StreamMethodOptions + ): GaxiosPromise; + fetchAccessToken( + params?: Params$Resource$Projects$Locations$Backupvaults$Datasources$Fetchaccesstoken, + options?: MethodOptions + ): GaxiosPromise; + fetchAccessToken( + params: Params$Resource$Projects$Locations$Backupvaults$Datasources$Fetchaccesstoken, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + fetchAccessToken( + params: Params$Resource$Projects$Locations$Backupvaults$Datasources$Fetchaccesstoken, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + fetchAccessToken( + params: Params$Resource$Projects$Locations$Backupvaults$Datasources$Fetchaccesstoken, + callback: BodyResponseCallback + ): void; + fetchAccessToken( + callback: BodyResponseCallback + ): void; + fetchAccessToken( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Backupvaults$Datasources$Fetchaccesstoken + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Backupvaults$Datasources$Fetchaccesstoken; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Backupvaults$Datasources$Fetchaccesstoken; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://backupdr.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:fetchAccessToken').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Internal only. Finalize a backup that was started by a call to InitiateBackup. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + finalizeBackup( + params: Params$Resource$Projects$Locations$Backupvaults$Datasources$Finalizebackup, + options: StreamMethodOptions + ): GaxiosPromise; + finalizeBackup( + params?: Params$Resource$Projects$Locations$Backupvaults$Datasources$Finalizebackup, + options?: MethodOptions + ): GaxiosPromise; + finalizeBackup( + params: Params$Resource$Projects$Locations$Backupvaults$Datasources$Finalizebackup, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + finalizeBackup( + params: Params$Resource$Projects$Locations$Backupvaults$Datasources$Finalizebackup, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + finalizeBackup( + params: Params$Resource$Projects$Locations$Backupvaults$Datasources$Finalizebackup, + callback: BodyResponseCallback + ): void; + finalizeBackup(callback: BodyResponseCallback): void; + finalizeBackup( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Backupvaults$Datasources$Finalizebackup + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Backupvaults$Datasources$Finalizebackup; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Backupvaults$Datasources$Finalizebackup; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://backupdr.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+dataSource}:finalizeBackup').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['dataSource'], + pathParams: ['dataSource'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets details of a DataSource. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Projects$Locations$Backupvaults$Datasources$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Backupvaults$Datasources$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Backupvaults$Datasources$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Backupvaults$Datasources$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Backupvaults$Datasources$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Backupvaults$Datasources$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Backupvaults$Datasources$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Backupvaults$Datasources$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://backupdr.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Internal only. Initiates a backup. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + initiateBackup( + params: Params$Resource$Projects$Locations$Backupvaults$Datasources$Initiatebackup, + options: StreamMethodOptions + ): GaxiosPromise; + initiateBackup( + params?: Params$Resource$Projects$Locations$Backupvaults$Datasources$Initiatebackup, + options?: MethodOptions + ): GaxiosPromise; + initiateBackup( + params: Params$Resource$Projects$Locations$Backupvaults$Datasources$Initiatebackup, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + initiateBackup( + params: Params$Resource$Projects$Locations$Backupvaults$Datasources$Initiatebackup, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + initiateBackup( + params: Params$Resource$Projects$Locations$Backupvaults$Datasources$Initiatebackup, + callback: BodyResponseCallback + ): void; + initiateBackup( + callback: BodyResponseCallback + ): void; + initiateBackup( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Backupvaults$Datasources$Initiatebackup + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Backupvaults$Datasources$Initiatebackup; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Backupvaults$Datasources$Initiatebackup; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://backupdr.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+dataSource}:initiateBackup').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['dataSource'], + pathParams: ['dataSource'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists DataSources in a given project and location. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Locations$Backupvaults$Datasources$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Backupvaults$Datasources$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Backupvaults$Datasources$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Backupvaults$Datasources$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Backupvaults$Datasources$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Backupvaults$Datasources$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Backupvaults$Datasources$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Backupvaults$Datasources$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://backupdr.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/dataSources').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Updates the settings of a DataSource. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + patch( + params: Params$Resource$Projects$Locations$Backupvaults$Datasources$Patch, + options: StreamMethodOptions + ): GaxiosPromise; + patch( + params?: Params$Resource$Projects$Locations$Backupvaults$Datasources$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Backupvaults$Datasources$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Backupvaults$Datasources$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Backupvaults$Datasources$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Backupvaults$Datasources$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Backupvaults$Datasources$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Backupvaults$Datasources$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://backupdr.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * 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. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + remove( + params: Params$Resource$Projects$Locations$Backupvaults$Datasources$Remove, + options: StreamMethodOptions + ): GaxiosPromise; + remove( + params?: Params$Resource$Projects$Locations$Backupvaults$Datasources$Remove, + options?: MethodOptions + ): GaxiosPromise; + remove( + params: Params$Resource$Projects$Locations$Backupvaults$Datasources$Remove, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + remove( + params: Params$Resource$Projects$Locations$Backupvaults$Datasources$Remove, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + remove( + params: Params$Resource$Projects$Locations$Backupvaults$Datasources$Remove, + callback: BodyResponseCallback + ): void; + remove(callback: BodyResponseCallback): void; + remove( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Backupvaults$Datasources$Remove + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Backupvaults$Datasources$Remove; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Backupvaults$Datasources$Remove; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://backupdr.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:remove').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Sets the internal status of a DataSource. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + setInternalStatus( + params: Params$Resource$Projects$Locations$Backupvaults$Datasources$Setinternalstatus, + options: StreamMethodOptions + ): GaxiosPromise; + setInternalStatus( + params?: Params$Resource$Projects$Locations$Backupvaults$Datasources$Setinternalstatus, + options?: MethodOptions + ): GaxiosPromise; + setInternalStatus( + params: Params$Resource$Projects$Locations$Backupvaults$Datasources$Setinternalstatus, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setInternalStatus( + params: Params$Resource$Projects$Locations$Backupvaults$Datasources$Setinternalstatus, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setInternalStatus( + params: Params$Resource$Projects$Locations$Backupvaults$Datasources$Setinternalstatus, + callback: BodyResponseCallback + ): void; + setInternalStatus(callback: BodyResponseCallback): void; + setInternalStatus( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Backupvaults$Datasources$Setinternalstatus + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Backupvaults$Datasources$Setinternalstatus; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Backupvaults$Datasources$Setinternalstatus; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://backupdr.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+dataSource}:setInternalStatus').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['dataSource'], + pathParams: ['dataSource'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Backupvaults$Datasources$Abandonbackup + extends StandardParameters { + /** + * Required. The resource name of the instance, in the format 'projects/x/locations/x/backupVaults/x/dataSources/'. + */ + dataSource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$AbandonBackupRequest; + } + export interface Params$Resource$Projects$Locations$Backupvaults$Datasources$Fetchaccesstoken + extends StandardParameters { + /** + * Required. The resource name for the location for which static IPs should be returned. Must be in the format 'projects/x/locations/x/backupVaults/x/dataSources'. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$FetchAccessTokenRequest; + } + export interface Params$Resource$Projects$Locations$Backupvaults$Datasources$Finalizebackup + extends StandardParameters { + /** + * Required. The resource name of the instance, in the format 'projects/x/locations/x/backupVaults/x/dataSources/'. + */ + dataSource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$FinalizeBackupRequest; + } + export interface Params$Resource$Projects$Locations$Backupvaults$Datasources$Get + extends StandardParameters { + /** + * Required. Name of the data source resource name, in the format 'projects/{project_id\}/locations/{location\}/backupVaults/{resource_name\}/dataSource/{resource_name\}' + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Backupvaults$Datasources$Initiatebackup + extends StandardParameters { + /** + * Required. The resource name of the instance, in the format 'projects/x/locations/x/backupVaults/x/dataSources/'. + */ + dataSource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$InitiateBackupRequest; + } + export interface Params$Resource$Projects$Locations$Backupvaults$Datasources$List + extends StandardParameters { + /** + * Optional. Filtering results. + */ + filter?: string; + /** + * Optional. Hint for how to order the results. + */ + orderBy?: string; + /** + * Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. + */ + pageSize?: number; + /** + * Optional. A token identifying a page of results the server should return. + */ + pageToken?: string; + /** + * Required. The project and location for which to retrieve data sources information, in the format 'projects/{project_id\}/locations/{location\}'. In Cloud Backup and DR, locations map to Google Cloud regions, for example **us-central1**. To retrieve data sources for all locations, use "-" for the '{location\}' value. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Backupvaults$Datasources$Patch + extends StandardParameters { + /** + * Optional. Enable upsert. + */ + allowMissing?: boolean; + /** + * Output only. The resource name. + */ + name?: string; + /** + * 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). + */ + requestId?: string; + /** + * Required. Field mask is used to specify the fields to be overwritten in the DataSource resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then the request will fail. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$DataSource; + } + export interface Params$Resource$Projects$Locations$Backupvaults$Datasources$Remove + extends StandardParameters { + /** + * Required. Name of the resource. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$RemoveDataSourceRequest; } - /** - * OAuth Client ID depending on the Workforce Identity i.e. either 1p or 3p, - */ - export interface Schema$WorkforceIdentityBasedOAuth2ClientID { + export interface Params$Resource$Projects$Locations$Backupvaults$Datasources$Setinternalstatus + extends StandardParameters { /** - * Output only. First party OAuth Client ID for Google Identities. + * Required. The resource name of the instance, in the format 'projects/x/locations/x/backupVaults/x/dataSources/'. */ - firstPartyOauth2ClientId?: string | null; + dataSource?: string; + /** - * Output only. Third party OAuth Client ID for External Identity Providers. + * Request body metadata */ - thirdPartyOauth2ClientId?: string | null; + requestBody?: Schema$SetInternalStatusRequest; } - export class Resource$Projects { + export class Resource$Projects$Locations$Backupvaults$Datasources$Backups { context: APIRequestContext; - locations: Resource$Projects$Locations; constructor(context: APIRequestContext) { this.context = context; - this.locations = new Resource$Projects$Locations(this.context); } - } - export class Resource$Projects$Locations { - context: APIRequestContext; - managementServers: Resource$Projects$Locations$Managementservers; - operations: Resource$Projects$Locations$Operations; - constructor(context: APIRequestContext) { - this.context = context; - this.managementServers = - new Resource$Projects$Locations$Managementservers(this.context); - this.operations = new Resource$Projects$Locations$Operations( - this.context - ); + /** + * Deletes a Backup. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Projects$Locations$Backupvaults$Datasources$Backups$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Projects$Locations$Backupvaults$Datasources$Backups$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Backupvaults$Datasources$Backups$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Backupvaults$Datasources$Backups$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Backupvaults$Datasources$Backups$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Backupvaults$Datasources$Backups$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Backupvaults$Datasources$Backups$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Backupvaults$Datasources$Backups$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://backupdr.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } } /** - * Gets information about a location. + * Gets details of a Backup. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -548,49 +3609,50 @@ export namespace backupdr_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Get, + params: Params$Resource$Projects$Locations$Backupvaults$Datasources$Backups$Get, options: StreamMethodOptions ): GaxiosPromise; get( - params?: Params$Resource$Projects$Locations$Get, + params?: Params$Resource$Projects$Locations$Backupvaults$Datasources$Backups$Get, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; get( - params: Params$Resource$Projects$Locations$Get, + params: Params$Resource$Projects$Locations$Backupvaults$Datasources$Backups$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Backupvaults$Datasources$Backups$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Get, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Backupvaults$Datasources$Backups$Get, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; + get(callback: BodyResponseCallback): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Backupvaults$Datasources$Backups$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { + ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Get; + {}) as Params$Resource$Projects$Locations$Backupvaults$Datasources$Backups$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Get; + params = + {} as Params$Resource$Projects$Locations$Backupvaults$Datasources$Backups$Get; options = {}; } @@ -615,17 +3677,17 @@ export namespace backupdr_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Lists information about the supported locations for this service. + * Lists Backups in a given project and location. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -633,54 +3695,53 @@ export namespace backupdr_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$List, + params: Params$Resource$Projects$Locations$Backupvaults$Datasources$Backups$List, options: StreamMethodOptions ): GaxiosPromise; list( - params?: Params$Resource$Projects$Locations$List, + params?: Params$Resource$Projects$Locations$Backupvaults$Datasources$Backups$List, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; list( - params: Params$Resource$Projects$Locations$List, + params: Params$Resource$Projects$Locations$Backupvaults$Datasources$Backups$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Backupvaults$Datasources$Backups$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$List, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Backupvaults$Datasources$Backups$List, + callback: BodyResponseCallback ): void; - list(callback: BodyResponseCallback): void; + list(callback: BodyResponseCallback): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Backupvaults$Datasources$Backups$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$List; + {}) as Params$Resource$Projects$Locations$Backupvaults$Datasources$Backups$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$List; + params = + {} as Params$Resource$Projects$Locations$Backupvaults$Datasources$Backups$List; options = {}; } @@ -693,7 +3754,7 @@ export namespace backupdr_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}/locations').replace( + url: (rootUrl + '/v1/{+parent}/backups').replace( /([^:]\/)\/+/g, '$1' ), @@ -703,46 +3764,167 @@ export namespace backupdr_v1 { options ), params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Updates the settings of a Backup. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + patch( + params: Params$Resource$Projects$Locations$Backupvaults$Datasources$Backups$Patch, + options: StreamMethodOptions + ): GaxiosPromise; + patch( + params?: Params$Resource$Projects$Locations$Backupvaults$Datasources$Backups$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Backupvaults$Datasources$Backups$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Backupvaults$Datasources$Backups$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Backupvaults$Datasources$Backups$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Backupvaults$Datasources$Backups$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Backupvaults$Datasources$Backups$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Backupvaults$Datasources$Backups$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://backupdr.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + apiVersion: '', + }, + options + ), + params, requiredParams: ['name'], pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } } - export interface Params$Resource$Projects$Locations$Get + export interface Params$Resource$Projects$Locations$Backupvaults$Datasources$Backups$Delete extends StandardParameters { /** - * Resource name for the location. + * Required. Name of the resource. */ name?: string; + /** + * 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). + */ + requestId?: string; } - export interface Params$Resource$Projects$Locations$List + export interface Params$Resource$Projects$Locations$Backupvaults$Datasources$Backups$Get extends StandardParameters { /** - * A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). + * Required. Name of the data source resource name, in the format 'projects/{project_id\}/locations/{location\}/backupVaults/{backupVault\}/dataSources/{datasource\}/backups/{backup\}' + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Backupvaults$Datasources$Backups$List + extends StandardParameters { + /** + * Optional. Filtering results. */ filter?: string; /** - * The resource that owns the locations collection, if applicable. + * Optional. Hint for how to order the results. */ - name?: string; + orderBy?: string; /** - * The maximum number of results to return. If not set, the service selects a default. + * Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. */ pageSize?: number; /** - * A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. + * Optional. A token identifying a page of results the server should return. */ pageToken?: string; + /** + * Required. The project and location for which to retrieve backup information, in the format 'projects/{project_id\}/locations/{location\}'. In Cloud Backup and DR, locations map to Google Cloud regions, for example **us-central1**. To retrieve data sources for all locations, use "-" for the '{location\}' value. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Backupvaults$Datasources$Backups$Patch + extends StandardParameters { + /** + * Output only. Name of the resource. + */ + name?: string; + /** + * 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). + */ + requestId?: string; + /** + * Required. Field mask is used to specify the fields to be overwritten in the Backup resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then the request will fail. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Backup; } export class Resource$Projects$Locations$Managementservers { @@ -1391,7 +4573,7 @@ export namespace backupdr_v1 { */ managementServerId?: string; /** - * Required. The management server project and location in the format `projects/{project_id\}/locations/{location\}`. In Cloud Backup and DR locations map to GCP regions, for example **us-central1**. + * Required. The management server project and location in the format 'projects/{project_id\}/locations/{location\}'. In Cloud Backup and DR locations map to Google Cloud regions, for example **us-central1**. */ parent?: string; /** @@ -1418,7 +4600,7 @@ export namespace backupdr_v1 { export interface Params$Resource$Projects$Locations$Managementservers$Get extends StandardParameters { /** - * Required. Name of the management server resource name, in the format `projects/{project_id\}/locations/{location\}/managementServers/{resource_name\}` + * Required. Name of the management server resource name, in the format 'projects/{project_id\}/locations/{location\}/managementServers/{resource_name\}' */ name?: string; } @@ -1452,7 +4634,7 @@ export namespace backupdr_v1 { */ pageToken?: string; /** - * Required. The project and location for which to retrieve management servers information, in the format `projects/{project_id\}/locations/{location\}`. In Cloud BackupDR, locations map to GCP regions, for example **us-central1**. To retrieve management servers for all locations, use "-" for the `{location\}` value. + * Required. The project and location for which to retrieve management servers information, in the format 'projects/{project_id\}/locations/{location\}'. In Cloud BackupDR, locations map to Google Cloud regions, for example **us-central1**. To retrieve management servers for all locations, use "-" for the '{location\}' value. */ parent?: string; } diff --git a/src/apis/batch/v1.ts b/src/apis/batch/v1.ts index c7aa5c2996..e50cfc23a0 100644 --- a/src/apis/batch/v1.ts +++ b/src/apis/batch/v1.ts @@ -1151,7 +1151,7 @@ export namespace batch_v1 { message?: string | null; } /** - * Status event + * Status event. */ export interface Schema$StatusEvent { /** @@ -1163,11 +1163,11 @@ export namespace batch_v1 { */ eventTime?: string | null; /** - * Task Execution + * Task Execution. This field is only defined for task-level status events where the task fails. */ taskExecution?: Schema$TaskExecution; /** - * Task State + * Task State. This field is only defined for task-level status events. */ taskState?: string | null; /** @@ -1293,11 +1293,11 @@ export namespace batch_v1 { volumes?: Schema$Volume[]; } /** - * Status of a task + * Status of a task. */ export interface Schema$TaskStatus { /** - * Task state + * Task state. */ state?: string | null; /** diff --git a/src/apis/beyondcorp/v1alpha.ts b/src/apis/beyondcorp/v1alpha.ts index 2ce1b15eea..0e897e299d 100644 --- a/src/apis/beyondcorp/v1alpha.ts +++ b/src/apis/beyondcorp/v1alpha.ts @@ -5146,7 +5146,7 @@ export namespace beyondcorp_v1alpha { export interface Params$Resource$Organizations$Locations$Insights$List extends StandardParameters { /** - * Optional. Filter expression to restrict the insights returned. Supported filter fields: * `type` * `category` * `subCategory` Examples: * "category = application AND type = count" * "category = application AND subCategory = iap" * "type = status" Allowed values: * type: [count, latency, status, list] * category: [application, device, request, security] * subCategory: [iap, webprotect] NOTE: Only equality based comparison is allowed. Only `AND` conjunction is allowed. NOTE: The 'AND' in the filter field needs to be in capital letters only. NOTE: Just filtering on `subCategory` is not allowed. It should be passed in with the parent `category` too. (These expressions are based on the filter language described at https://google.aip.dev/160). + * Optional. Filter expression to restrict the insights returned. Supported filter fields: * `type` * `category` * `subCategory` Examples: * "category = application AND type = count" * "category = application AND subCategory = iap" * "type = status" Allowed values: * type: [count, latency, status, list] * category: [application, device, request, security] * subCategory: [iap, caa, webprotect] NOTE: Only equality based comparison is allowed. Only `AND` conjunction is allowed. NOTE: The 'AND' in the filter field needs to be in capital letters only. NOTE: Just filtering on `subCategory` is not allowed. It should be passed in with the parent `category` too. (These expressions are based on the filter language described at https://google.aip.dev/160). */ filter?: string; /** @@ -13170,7 +13170,7 @@ export namespace beyondcorp_v1alpha { export interface Params$Resource$Projects$Locations$Insights$List extends StandardParameters { /** - * Optional. Filter expression to restrict the insights returned. Supported filter fields: * `type` * `category` * `subCategory` Examples: * "category = application AND type = count" * "category = application AND subCategory = iap" * "type = status" Allowed values: * type: [count, latency, status, list] * category: [application, device, request, security] * subCategory: [iap, webprotect] NOTE: Only equality based comparison is allowed. Only `AND` conjunction is allowed. NOTE: The 'AND' in the filter field needs to be in capital letters only. NOTE: Just filtering on `subCategory` is not allowed. It should be passed in with the parent `category` too. (These expressions are based on the filter language described at https://google.aip.dev/160). + * Optional. Filter expression to restrict the insights returned. Supported filter fields: * `type` * `category` * `subCategory` Examples: * "category = application AND type = count" * "category = application AND subCategory = iap" * "type = status" Allowed values: * type: [count, latency, status, list] * category: [application, device, request, security] * subCategory: [iap, caa, webprotect] NOTE: Only equality based comparison is allowed. Only `AND` conjunction is allowed. NOTE: The 'AND' in the filter field needs to be in capital letters only. NOTE: Just filtering on `subCategory` is not allowed. It should be passed in with the parent `category` too. (These expressions are based on the filter language described at https://google.aip.dev/160). */ filter?: string; /** diff --git a/src/apis/bigquery/v2.ts b/src/apis/bigquery/v2.ts index 064ac527fe..424ac07f8c 100644 --- a/src/apis/bigquery/v2.ts +++ b/src/apis/bigquery/v2.ts @@ -458,7 +458,7 @@ export namespace bigquery_v2 { */ export interface Schema$BigLakeConfiguration { /** - * Required. 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 ".." or "projects//locations//connections/". + * Required. 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\}". */ connectionId?: string | null; /** @@ -466,7 +466,7 @@ export namespace bigquery_v2 { */ fileFormat?: string | null; /** - * Required. 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/" + * Required. 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/` */ storageUri?: string | null; /** @@ -501,7 +501,7 @@ export namespace bigquery_v2 { */ onlyReadLatest?: boolean | null; /** - * [Required] Qualifier of the column. Columns in the parent column family that has this exact qualifier are exposed as . field. If the qualifier is valid UTF-8 string, it can be specified in the qualifier_string field. Otherwise, a base-64 encoded value must be set to qualifier_encoded. The column field name is the same as the column qualifier. However, if the qualifier is not a valid BigQuery field identifier i.e. does not match a-zA-Z*, a valid identifier must be provided as field_name. + * [Required] Qualifier of the column. Columns in the parent column family that has this exact qualifier are exposed as `.` field. If the qualifier is valid UTF-8 string, it can be specified in the qualifier_string field. Otherwise, a base-64 encoded value must be set to qualifier_encoded. The column field name is the same as the column qualifier. However, if the qualifier is not a valid BigQuery field identifier i.e. does not match a-zA-Z*, a valid identifier must be provided as field_name. */ qualifierEncoded?: string | null; /** @@ -518,7 +518,7 @@ export namespace bigquery_v2 { */ export interface Schema$BigtableColumnFamily { /** - * Optional. Lists of columns that should be exposed as individual fields as opposed to a list of (column name, value) pairs. All columns whose qualifier matches a qualifier in this list can be accessed as .. Other columns can be accessed as a list through .Column field. + * Optional. Lists of columns that should be exposed as individual fields as opposed to a list of (column name, value) pairs. All columns whose qualifier matches a qualifier in this list can be accessed as `.`. Other columns can be accessed as a list through the `.Column` field. */ columns?: Schema$BigtableColumn[]; /** @@ -864,6 +864,9 @@ export namespace bigquery_v2 { */ dataMaskingApplied?: boolean | null; } + /** + * Represents a BigQuery dataset. + */ export interface Schema$Dataset { /** * Optional. An array of objects that define dataset access for one or more entities. You can set this property when inserting or updating a dataset in order to control who is allowed to access the data. If unspecified at dataset creation time, BigQuery adds default dataset access for the following entities: access.specialGroup: projectReaders; access.role: READER; access.specialGroup: projectWriters; access.role: WRITER; access.specialGroup: projectOwners; access.role: OWNER; access.userByEmail: [dataset creator email]; access.role: OWNER; @@ -940,7 +943,7 @@ export namespace bigquery_v2 { */ kind?: string | null; /** - * The labels associated with this dataset. You can use these to organize and group your datasets. You can set this property when inserting or updating a dataset. See Creating and Updating Dataset Labels for more information. + * The labels associated with this dataset. You can use these to organize and group your datasets. You can set this property when inserting or updating a dataset. See [Creating and Updating Dataset Labels](https://cloud.google.com/bigquery/docs/creating-managing-labels#creating_and_updating_dataset_labels) for more information. */ labels?: {[key: string]: string} | null; /** @@ -1041,6 +1044,9 @@ export namespace bigquery_v2 { */ unreachable?: string[] | null; } + /** + * Identifier for a dataset. + */ export interface Schema$DatasetReference { /** * Required. A unique ID for this dataset, without the project name. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters. @@ -1187,6 +1193,9 @@ export namespace bigquery_v2 { */ min?: number | null; } + /** + * Configuration for Cloud KMS encryption settings. + */ export interface Schema$EncryptionConfiguration { /** * Optional. Describes the Cloud KMS encryption key that will be used to protect destination BigQuery table. The BigQuery Service Account associated with your project requires access to this encryption key. @@ -1497,7 +1506,7 @@ export namespace bigquery_v2 { */ compression?: string | null; /** - * Optional. The connection specifying the credentials to be used to read external storage, such as Azure Blob, Cloud Storage, or S3. The connection_id can have the form ".." or "projects//locations//connections/". + * Optional. The connection specifying the credentials to be used to read external storage, such as Azure Blob, Cloud Storage, or S3. The connection_id can have the form `{project_id\}.{location_id\};{connection_id\}` or `projects/{project_id\}/locations/{location_id\}/connections/{connection_id\}`. */ connectionId?: string | null; /** @@ -4737,6 +4746,10 @@ export namespace bigquery_v2 { * Free form human-readable reason metadata caching was unused for the job. */ explanation?: string | null; + /** + * Duration since last refresh as of this job for managed tables (indicates metadata cache staleness as seen by this job). + */ + staleness?: string | null; /** * Metadata caching eligible table referenced in the query. */ @@ -5987,7 +6000,7 @@ export namespace bigquery_v2 { */ all?: boolean; /** - * An expression for filtering the results of the request by label. The syntax is \"labels.[:]\". Multiple filters can be ANDed together by connecting with a space. Example: \"labels.department:receiving labels.active\". See [Filtering datasets using labels](/bigquery/docs/filtering-labels#filtering_datasets_using_labels) for details. + * An expression for filtering the results of the request by label. The syntax is `labels.[:]`. Multiple filters can be ANDed together by connecting with a space. Example: `labels.department:receiving labels.active`. See [Filtering datasets using labels](https://cloud.google.com/bigquery/docs/filtering-labels#filtering_datasets_using_labels) for details. */ filter?: string; /** @@ -6681,7 +6694,7 @@ export namespace bigquery_v2 { */ jobId?: string; /** - * The geographic location of the job. You must specify the location to run the job for the following scenarios: - If the location to run a job is not in the `us` or the `eu` multi-regional location - If the job's location is in a single region (for example, `us-central1`) For more information, see https://cloud.google.com/bigquery/docs/locations#specifying_your_location. + * The geographic location of the job. You must specify the location to run the job for the following scenarios: * If the location to run a job is not in the `us` or the `eu` multi-regional location * If the job's location is in a single region (for example, `us-central1`) For more information, see https://cloud.google.com/bigquery/docs/locations#specifying_your_location. */ location?: string; /** @@ -6709,7 +6722,7 @@ export namespace bigquery_v2 { */ jobId?: string; /** - * The geographic location of the job. You must specify the location to run the job for the following scenarios: - If the location to run a job is not in the `us` or the `eu` multi-regional location - If the job's location is in a single region (for example, `us-central1`) For more information, see https://cloud.google.com/bigquery/docs/locations#specifying_your_location. + * The geographic location of the job. You must specify the location to run the job for the following scenarios: * If the location to run a job is not in the `us` or the `eu` multi-regional location * If the job's location is in a single region (for example, `us-central1`) For more information, see https://cloud.google.com/bigquery/docs/locations#specifying_your_location. */ location?: string; /** @@ -6728,7 +6741,7 @@ export namespace bigquery_v2 { */ jobId?: string; /** - * The geographic location of the job. You must specify the location to run the job for the following scenarios: - If the location to run a job is not in the `us` or the `eu` multi-regional location - If the job's location is in a single region (for example, `us-central1`) For more information, see https://cloud.google.com/bigquery/docs/locations#specifying_your_location. + * The geographic location of the job. You must specify the location to run the job for the following scenarios: * If the location to run a job is not in the `us` or the `eu` multi-regional location * If the job's location is in a single region (for example, `us-central1`) For more information, see https://cloud.google.com/bigquery/docs/locations#specifying_your_location. */ location?: string; /** diff --git a/src/apis/bigtableadmin/v2.ts b/src/apis/bigtableadmin/v2.ts index 4b7329e44f..4e0f7e830c 100644 --- a/src/apis/bigtableadmin/v2.ts +++ b/src/apis/bigtableadmin/v2.ts @@ -812,10 +812,22 @@ export namespace bigtableadmin_v2 { * A value that combines incremental updates into a summarized value. Data is never directly written or read using type `Aggregate`. Writes will provide either the `input_type` or `state_type`, and reads will always return the `state_type` . */ export interface Schema$GoogleBigtableAdminV2TypeAggregate { + /** + * HyperLogLogPlusPlusUniqueCount aggregator. + */ + hllppUniqueCount?: Schema$GoogleBigtableAdminV2TypeAggregateHyperLogLogPlusPlusUniqueCount; /** * Type of the inputs that are accumulated by this `Aggregate`, which must specify a full encoding. Use `AddInput` mutations to accumulate new inputs. */ inputType?: Schema$Type; + /** + * Max aggregator. + */ + max?: Schema$GoogleBigtableAdminV2TypeAggregateMax; + /** + * Min aggregator. + */ + min?: Schema$GoogleBigtableAdminV2TypeAggregateMin; /** * Output only. Type that holds the internal accumulator state for the `Aggregate`. This is a function of the `input_type` and `aggregator` chosen, and will always specify a full encoding. */ @@ -825,10 +837,35 @@ export namespace bigtableadmin_v2 { */ sum?: Schema$GoogleBigtableAdminV2TypeAggregateSum; } + /** + * Computes an approximate unique count over the input values. When using raw data as input, be careful to use a consistent encoding. Otherwise the same value encoded differently could count more than once, or two distinct values could count as identical. Input: Any, or omit for Raw State: TBD Special state conversions: `Int64` (the unique count estimate) + */ + export interface Schema$GoogleBigtableAdminV2TypeAggregateHyperLogLogPlusPlusUniqueCount {} + /** + * Computes the max of the input values. Allowed input: `Int64` State: same as input + */ + export interface Schema$GoogleBigtableAdminV2TypeAggregateMax {} + /** + * Computes the min of the input values. Allowed input: `Int64` State: same as input + */ + export interface Schema$GoogleBigtableAdminV2TypeAggregateMin {} /** * Computes the sum of the input values. Allowed input: `Int64` State: same as input */ export interface Schema$GoogleBigtableAdminV2TypeAggregateSum {} + /** + * An ordered list of elements of a given type. Values of type `Array` are stored in `Value.array_value`. + */ + export interface Schema$GoogleBigtableAdminV2TypeArray { + /** + * The type of the elements in the array. This must not be `Array`. + */ + elementType?: Schema$Type; + } + /** + * bool Values of type `Bool` are stored in `Value.bool_value`. + */ + export interface Schema$GoogleBigtableAdminV2TypeBool {} /** * Bytes Values of type `Bytes` are stored in `Value.bytes_value`. */ @@ -848,9 +885,21 @@ export namespace bigtableadmin_v2 { raw?: Schema$GoogleBigtableAdminV2TypeBytesEncodingRaw; } /** - * Leaves the value "as-is" * Natural sort? Yes * Self-delimiting? No * Compatibility? N/A + * Leaves the value "as-is" * Order-preserving? Yes * Self-delimiting? No * Compatibility? N/A */ export interface Schema$GoogleBigtableAdminV2TypeBytesEncodingRaw {} + /** + * Date Values of type `Date` are stored in `Value.date_value`. + */ + export interface Schema$GoogleBigtableAdminV2TypeDate {} + /** + * Float32 Values of type `Float32` are stored in `Value.float_value`. + */ + export interface Schema$GoogleBigtableAdminV2TypeFloat32 {} + /** + * Float64 Values of type `Float64` are stored in `Value.float_value`. + */ + export interface Schema$GoogleBigtableAdminV2TypeFloat64 {} /** * Int64 Values of type `Int64` are stored in `Value.int_value`. */ @@ -870,14 +919,75 @@ export namespace bigtableadmin_v2 { bigEndianBytes?: Schema$GoogleBigtableAdminV2TypeInt64EncodingBigEndianBytes; } /** - * Encodes the value as an 8-byte big endian twos complement `Bytes` value. * Natural sort? No (positive values only) * Self-delimiting? Yes * Compatibility? - BigQuery Federation `BINARY` encoding - HBase `Bytes.toBytes` - Java `ByteBuffer.putLong()` with `ByteOrder.BIG_ENDIAN` + * Encodes the value as an 8-byte big endian twos complement `Bytes` value. * Order-preserving? No (positive values only) * Self-delimiting? Yes * Compatibility? - BigQuery Federation `BINARY` encoding - HBase `Bytes.toBytes` - Java `ByteBuffer.putLong()` with `ByteOrder.BIG_ENDIAN` */ export interface Schema$GoogleBigtableAdminV2TypeInt64EncodingBigEndianBytes { /** - * The underlying `Bytes` type, which may be able to encode further. + * Deprecated: ignored if set. */ bytesType?: Schema$GoogleBigtableAdminV2TypeBytes; } + /** + * A mapping of keys to values of a given type. Values of type `Map` are stored in a `Value.array_value` where each entry is another `Value.array_value` with two elements (the key and the value, in that order). Normally encoded Map values won't have repeated keys, however, clients are expected to handle the case in which they do. If the same key appears multiple times, the _last_ value takes precedence. + */ + export interface Schema$GoogleBigtableAdminV2TypeMap { + /** + * The type of a map key. Only `Bytes`, `String`, and `Int64` are allowed as key types. + */ + keyType?: Schema$Type; + /** + * The type of the values in a map. + */ + valueType?: Schema$Type; + } + /** + * String Values of type `String` are stored in `Value.string_value`. + */ + export interface Schema$GoogleBigtableAdminV2TypeString { + /** + * The encoding to use when converting to/from lower level types. + */ + encoding?: Schema$GoogleBigtableAdminV2TypeStringEncoding; + } + /** + * Rules used to convert to/from lower level types. + */ + export interface Schema$GoogleBigtableAdminV2TypeStringEncoding { + /** + * Use `Utf8Bytes` encoding. + */ + utf8Bytes?: Schema$GoogleBigtableAdminV2TypeStringEncodingUtf8Bytes; + } + /** + * UTF-8 encoding * Order-preserving? Yes (code point order) * Self-delimiting? No * Compatibility? - BigQuery Federation `TEXT` encoding - HBase `Bytes.toBytes` - Java `String#getBytes(StandardCharsets.UTF_8)` + */ + export interface Schema$GoogleBigtableAdminV2TypeStringEncodingUtf8Bytes {} + /** + * A structured data value, consisting of fields which map to dynamically typed values. Values of type `Struct` are stored in `Value.array_value` where entries are in the same order and number as `field_types`. + */ + export interface Schema$GoogleBigtableAdminV2TypeStruct { + /** + * The names and types of the fields in this struct. + */ + fields?: Schema$GoogleBigtableAdminV2TypeStructField[]; + } + /** + * A struct field and its type. + */ + export interface Schema$GoogleBigtableAdminV2TypeStructField { + /** + * The field name (optional). Fields without a `field_name` are considered anonymous and cannot be referenced by name. + */ + fieldName?: string | null; + /** + * The type of values in this field. + */ + type?: Schema$Type; + } + /** + * Timestamp Values of type `Timestamp` are stored in `Value.timestamp_value`. + */ + export interface Schema$GoogleBigtableAdminV2TypeTimestamp {} /** * A tablet is a defined by a start and end key and is explained in https://cloud.google.com/bigtable/docs/overview#architecture and https://cloud.google.com/bigtable/docs/performance#optimization. A Hot tablet is a tablet that exhibits high average cpu usage during the time interval from start time to end time. */ @@ -1485,21 +1595,57 @@ export namespace bigtableadmin_v2 { permissions?: string[] | null; } /** - * `Type` represents the type of data that is written to, read from, or stored in Bigtable. It is heavily based on the GoogleSQL standard to help maintain familiarity and consistency across products and features. For compatibility with Bigtable's existing untyped APIs, each `Type` includes an `Encoding` which describes how to convert to/from the underlying data. This might involve composing a series of steps into an "encoding chain," for example to convert from INT64 -\> STRING -\> raw bytes. In most cases, a "link" in the encoding chain will be based an on existing GoogleSQL conversion function like `CAST`. Each link in the encoding chain also defines the following properties: * Natural sort: Does the encoded value sort consistently with the original typed value? Note that Bigtable will always sort data based on the raw encoded value, *not* the decoded type. - Example: BYTES values sort in the same order as their raw encodings. - Counterexample: Encoding INT64 to a fixed-width STRING does *not* preserve sort order when dealing with negative numbers. INT64(1) \> INT64(-1), but STRING("-00001") \> STRING("00001). - The overall encoding chain has this property if *every* link does. * Self-delimiting: If we concatenate two encoded values, can we always tell where the first one ends and the second one begins? - Example: If we encode INT64s to fixed-width STRINGs, the first value will always contain exactly N digits, possibly preceded by a sign. - Counterexample: If we concatenate two UTF-8 encoded STRINGs, we have no way to tell where the first one ends. - The overall encoding chain has this property if *any* link does. * Compatibility: Which other systems have matching encoding schemes? For example, does this encoding have a GoogleSQL equivalent? HBase? Java? + * `Type` represents the type of data that is written to, read from, or stored in Bigtable. It is heavily based on the GoogleSQL standard to help maintain familiarity and consistency across products and features. For compatibility with Bigtable's existing untyped APIs, each `Type` includes an `Encoding` which describes how to convert to/from the underlying data. Each encoding also defines the following properties: * Order-preserving: Does the encoded value sort consistently with the original typed value? Note that Bigtable will always sort data based on the raw encoded value, *not* the decoded type. - Example: BYTES values sort in the same order as their raw encodings. - Counterexample: Encoding INT64 as a fixed-width decimal string does *not* preserve sort order when dealing with negative numbers. INT64(1) \> INT64(-1), but STRING("-00001") \> STRING("00001). * Self-delimiting: If we concatenate two encoded values, can we always tell where the first one ends and the second one begins? - Example: If we encode INT64s to fixed-width STRINGs, the first value will always contain exactly N digits, possibly preceded by a sign. - Counterexample: If we concatenate two UTF-8 encoded STRINGs, we have no way to tell where the first one ends. * Compatibility: Which other systems have matching encoding schemes? For example, does this encoding have a GoogleSQL equivalent? HBase? Java? */ export interface Schema$Type { /** * Aggregate */ aggregateType?: Schema$GoogleBigtableAdminV2TypeAggregate; + /** + * Array + */ + arrayType?: Schema$GoogleBigtableAdminV2TypeArray; + /** + * Bool + */ + boolType?: Schema$GoogleBigtableAdminV2TypeBool; /** * Bytes */ bytesType?: Schema$GoogleBigtableAdminV2TypeBytes; + /** + * Date + */ + dateType?: Schema$GoogleBigtableAdminV2TypeDate; + /** + * Float32 + */ + float32Type?: Schema$GoogleBigtableAdminV2TypeFloat32; + /** + * Float64 + */ + float64Type?: Schema$GoogleBigtableAdminV2TypeFloat64; /** * Int64 */ int64Type?: Schema$GoogleBigtableAdminV2TypeInt64; + /** + * Map + */ + mapType?: Schema$GoogleBigtableAdminV2TypeMap; + /** + * String + */ + stringType?: Schema$GoogleBigtableAdminV2TypeString; + /** + * Struct + */ + structType?: Schema$GoogleBigtableAdminV2TypeStruct; + /** + * Timestamp + */ + timestampType?: Schema$GoogleBigtableAdminV2TypeTimestamp; } /** * Metadata type for the operation returned by google.bigtable.admin.v2.BigtableTableAdmin.UndeleteTable. @@ -4740,7 +4886,7 @@ export namespace bigtableadmin_v2 { export interface Params$Resource$Projects$Instances$Clusters$Backups$Copy extends StandardParameters { /** - * Required. The name of the destination cluster that will contain the backup copy. The cluster must already exists. Values are of the form: `projects/{project\}/instances/{instance\}/clusters/{cluster\}`. + * Required. The name of the destination cluster that will contain the backup copy. The cluster must already exist. Values are of the form: `projects/{project\}/instances/{instance\}/clusters/{cluster\}`. */ parent?: string; diff --git a/src/apis/calendar/v3.ts b/src/apis/calendar/v3.ts index 241d5a583c..7abcc4f2c1 100644 --- a/src/apis/calendar/v3.ts +++ b/src/apis/calendar/v3.ts @@ -760,7 +760,7 @@ export namespace calendar_v3 { */ recurringEventId?: string | null; /** - * Information about the event's reminders for the authenticated user. + * Information about the event's reminders for the authenticated user. Note that changing reminders does not also change the updated property of the enclosing event. */ reminders?: { overrides?: Schema$EventReminder[]; @@ -802,7 +802,7 @@ export namespace calendar_v3 { */ transparency?: string | null; /** - * Last modification time of the event (as a RFC3339 timestamp). Read-only. + * Last modification time of the main event data (as a RFC3339 timestamp). Updating event reminders will not cause this to change. Read-only. */ updated?: string | null; /** diff --git a/src/apis/chat/v1.ts b/src/apis/chat/v1.ts index 7f6100df47..82ac41dde2 100644 --- a/src/apis/chat/v1.ts +++ b/src/apis/chat/v1.ts @@ -146,7 +146,7 @@ export namespace chat_v1 { */ accessState?: string | null; /** - * Optional. The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover the space, join the space, and preview the messages in the space. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience\}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. + * Optional. The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover the space, join the space, and preview the messages in the space. If unset, only users or Google Groups who have been individually invited or added to the space can access it. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience\}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. */ audience?: string | null; } @@ -501,7 +501,7 @@ export namespace chat_v1 { deletionType?: string | null; } /** - * A Google Chat app interaction event. To learn about interaction events, see [Receive and respond to interactions with your Google Chat app](https://developers.google.com/workspace/chat/api/guides/message-formats). To learn about event types and for example event payloads, see [Types of Google Chat app interaction events](https://developers.google.com/workspace/chat/events). In addition to receiving events from user interactions, Chat apps can receive events about changes to spaces, such as when a new member is added to a space. To learn about space events, see [Work with events from Google Chat](https://developers.google.com/workspace/chat/events-overview). + * A Google Chat app interaction event that represents and contains data about a user's interaction with a Chat app. To configure your Chat app to receive interaction events, see [Receive and respond to user interactions](https://developers.google.com/workspace/chat/receive-respond-interactions). In addition to receiving events from user interactions, Chat apps can receive events about changes to spaces, such as when a new member is added to a space. To learn about space events, see [Work with events from Google Chat](https://developers.google.com/workspace/chat/events-overview). */ export interface Schema$DeprecatedEvent { /** @@ -509,7 +509,7 @@ export namespace chat_v1 { */ action?: Schema$FormAction; /** - * Represents informatmessage_visibilityion about the user's client, such as locale, host app, and platform. For Chat apps, `CommonEventObject` includes information submitted by users interacting with [dialogs](https://developers.google.com/workspace/chat/dialogs), like data entered on a card. + * Represents information about the user's client, such as locale, host app, and platform. For Chat apps, `CommonEventObject` includes information submitted by users interacting with [dialogs](https://developers.google.com/workspace/chat/dialogs), like data entered on a card. */ common?: Schema$CommonEventObject; /** @@ -533,7 +533,7 @@ export namespace chat_v1 { */ message?: Schema$Message; /** - * The space in which the interaction event occurred. + * The space in which the user interacted with the Chat app. */ space?: Schema$Space; /** @@ -545,11 +545,11 @@ export namespace chat_v1 { */ token?: string | null; /** - * The type of interaction event. For details, see [Types of Google Chat app interaction events](https://developers.google.com/workspace/chat/events). + * The [type](/workspace/chat/api/reference/rest/v1/EventType) of user interaction with the Chat app, such as `MESSAGE` or `ADDED_TO_SPACE`. */ type?: string | null; /** - * The user that triggered the interaction event. + * The user that interacted with the Chat app. */ user?: Schema$User; } @@ -2035,7 +2035,7 @@ export namespace chat_v1 { */ displayName?: string | null; /** - * Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. * The space is used to [import data to Google Chat] (https://developers.google.com/chat/api/guides/import-data-overview) because import mode spaces must only permit members from the same Google Workspace organization. However, as part of the [Google Workspace Developer Preview Program](https://developers.google.com/workspace/preview), import mode spaces can permit any Google Chat user so this field can then be set for import mode spaces. For existing spaces, this field is output only. + * Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. For existing spaces, this field is output only. */ externalUserAllowed?: boolean | null; /** @@ -3399,7 +3399,7 @@ export namespace chat_v1 { */ name?: string; /** - * Required. The updated field paths, comma separated if there are multiple. Currently supported field paths: - `display_name` (Only supports changing the display name of a space with the `SPACE` type, or when also including the `space_type` mask to change a `GROUP_CHAT` space type to `SPACE`. Trying to update the display name of a `GROUP_CHAT` or a `DIRECT_MESSAGE` space results in an invalid argument error. If you receive the error message `ALREADY_EXISTS` when updating the `displayName`, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name.) - `space_type` (Only supports changing a `GROUP_CHAT` space type to `SPACE`. Include `display_name` together with `space_type` in the update mask and ensure that the specified space has a non-empty display name and the `SPACE` space type. Including the `space_type` mask and the `SPACE` type in the specified space when updating the display name is optional if the existing space already has the `SPACE` type. Trying to update the space type in other ways results in an invalid argument error). `space_type` is not supported with admin access. - `space_details` - `space_history_state` (Supports [turning history on or off for the space](https://support.google.com/chat/answer/7664687) if [the organization allows users to change their history setting](https://support.google.com/a/answer/7664184). Warning: mutually exclusive with all other field paths.) `space_history_state` is not supported with admin access. - `access_settings.audience` (Supports changing the [access setting](https://support.google.com/chat/answer/11971020) of who can discover the space, join the space, and preview the messages in space. If no audience is specified in the access setting, the space's access setting is updated to private. Warning: mutually exclusive with all other field paths.) `access_settings.audience` is not supported with admin access. - Developer Preview: Supports changing the [permission settings](https://support.google.com/chat/answer/13340792) of a space, supported field paths include: `permission_settings.manage_members_and_groups`, `permission_settings.modify_space_details`, `permission_settings.toggle_history`, `permission_settings.use_at_mention_all`, `permission_settings.manage_apps`, `permission_settings.manage_webhooks`, `permission_settings.reply_messages` (Warning: mutually exclusive with all other non-permission settings field paths). `permission_settings` is not supported with admin access. + * Required. The updated field paths, comma separated if there are multiple. You can update the following fields for a space: - `space_details` - `display_name`: Only supports updating the display name for spaces where `spaceType` field is `SPACE`. If you receive the error message `ALREADY_EXISTS`, try a different value. An existing space within the Google Workspace organization might already use this display name. - `space_type`: Only supports changing a `GROUP_CHAT` space type to `SPACE`. Include `display_name` together with `space_type` in the update mask and ensure that the specified space has a non-empty display name and the `SPACE` space type. Including the `space_type` mask and the `SPACE` type in the specified space when updating the display name is optional if the existing space already has the `SPACE` type. Trying to update the space type in other ways results in an invalid argument error. `space_type` is not supported with admin access. - `space_history_state`: Updates [space history settings](https://support.google.com/chat/answer/7664687) by turning history on or off for the space. Only supported if history settings are enabled for the Google Workspace organization. To update the space history state, you must omit all other field masks in your request. `space_history_state` is not supported with admin access. - `access_settings.audience`: Updates the [access setting](https://support.google.com/chat/answer/11971020) of who can discover the space, join the space, and preview the messages in named space where `spaceType` field is `SPACE`. If the existing space has a target audience, you can remove the audience and restrict space access by omitting a value for this field mask. To update access settings for a space, the authenticating user must be a space manager and omit all other field masks in your request. You can't update this field if the space is in [import mode](https://developers.google.com/workspace/chat/import-data-overview). To learn more, see [Make a space discoverable to specific users](https://developers.google.com/workspace/chat/space-target-audience). `access_settings.audience` is not supported with admin access. - Developer Preview: Supports changing the [permission settings](https://support.google.com/chat/answer/13340792) of a space, supported field paths include: `permission_settings.manage_members_and_groups`, `permission_settings.modify_space_details`, `permission_settings.toggle_history`, `permission_settings.use_at_mention_all`, `permission_settings.manage_apps`, `permission_settings.manage_webhooks`, `permission_settings.reply_messages` (Warning: mutually exclusive with all other non-permission settings field paths). `permission_settings` is not supported with admin access. */ updateMask?: string; diff --git a/src/apis/chromemanagement/v1.ts b/src/apis/chromemanagement/v1.ts index 393699e8b3..ee67fb5953 100644 --- a/src/apis/chromemanagement/v1.ts +++ b/src/apis/chromemanagement/v1.ts @@ -4122,11 +4122,11 @@ export namespace chromemanagement_v1 { */ customer?: string; /** - * Query string to filter results, AND-separated fields in EBNF syntax. Note: OR operations are not supported in this filter. Supported filter fields: * app_name * app_type * install_type * number_of_permissions * total_install_count * latest_profile_active_date * permission_name * app_id + * Query string to filter results, AND-separated fields in EBNF syntax. Note: OR operations are not supported in this filter. Supported filter fields: * app_name * app_type * install_type * number_of_permissions * total_install_count * latest_profile_active_date * permission_name * app_id * manifest_versions */ filter?: string; /** - * Field used to order results. Supported order by fields: * app_name * app_type * install_type * number_of_permissions * total_install_count * app_id + * Field used to order results. Supported order by fields: * app_name * app_type * install_type * number_of_permissions * total_install_count * app_id * manifest_versions */ orderBy?: string; /** @@ -4634,7 +4634,7 @@ export namespace chromemanagement_v1 { */ parent?: string; /** - * Required. Read mask to specify which fields to return. Although currently required, this field will become optional, while the filter parameter with an event type will be come required. Supported read_mask paths are: - device - user - audio_severe_underrun_event - usb_peripherals_event - https_latency_change_event - network_state_change_event - wifi_signal_strength_event - vpn_connection_state_change_event - app_install_event - app_uninstall_event - app_launch_event + * Required. Read mask to specify which fields to return. Although currently required, this field will become optional, while the filter parameter with an event type will be come required. Supported read_mask paths are: - device - user - audio_severe_underrun_event - usb_peripherals_event - https_latency_change_event - network_state_change_event - wifi_signal_strength_event - vpn_connection_state_change_event - app_install_event - app_uninstall_event - app_launch_event - os_crash_event */ readMask?: string; } diff --git a/src/apis/classroom/v1.ts b/src/apis/classroom/v1.ts index 599569f9a4..46dbd8b07b 100644 --- a/src/apis/classroom/v1.ts +++ b/src/apis/classroom/v1.ts @@ -3080,7 +3080,7 @@ export namespace classroom_v1 { */ addOnToken?: string; /** - * Optional. The identifier of the attachment. This field is required for student users and optional for teacher users. If not provided in the student case, an error is returned. + * Optional. The identifier of the attachment. This field is required for all requests except when the user is in the [Attachment Discovery iframe](https://developers.google.com/classroom/add-ons/get-started/iframes/attachment-discovery-iframe). */ attachmentId?: string; /** @@ -4277,7 +4277,7 @@ export namespace classroom_v1 { } /** - * Updates one or more fields of a course work. See google.classroom.v1.CourseWork for details of which fields may be updated and who may change them. This request must be made by the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding course work item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting developer project did not create the corresponding course work, if the user is not permitted to make the requested modification to the student submission, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `FAILED_PRECONDITION` if the requested course work has already been deleted. * `NOT_FOUND` if the requested course, course work, or student submission does not exist. + * Updates one or more fields of a course work. See google.classroom.v1.CourseWork for details of which fields may be updated and who may change them. This request must be made by the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding course work item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting developer project did not create the corresponding course work, if the user is not permitted to make the requested modification to the student submission, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `FAILED_PRECONDITION` if the requested course work has already been deleted. * `NOT_FOUND` if the requested course or course work does not exist. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -4406,7 +4406,7 @@ export namespace classroom_v1 { */ addOnToken?: string; /** - * Optional. The identifier of the attachment. This field is required for student users and optional for teacher users. If not provided in the student case, an error is returned. + * Optional. The identifier of the attachment. This field is required for all requests except when the user is in the [Attachment Discovery iframe](https://developers.google.com/classroom/add-ons/get-started/iframes/attachment-discovery-iframe). */ attachmentId?: string; /** @@ -4472,7 +4472,7 @@ export namespace classroom_v1 { */ id?: string; /** - * Mask that identifies which fields on the course work to update. This field is required to do an update. The update fails if invalid fields are specified. If a field supports empty values, it can be cleared by specifying it in the update mask and not in the `CourseWork` object. If a field that does not support empty values is included in the update mask and not set in the `CourseWork` object, an `INVALID_ARGUMENT` error is returned. The following fields may be specified by teachers: * `title` * `description` * `state` * `due_date` * `due_time` * `max_points` * `scheduled_time` * `submission_modification_mode` * `topic_id` + * Mask that identifies which fields on the course work to update. This field is required to do an update. The update fails if invalid fields are specified. If a field supports empty values, it can be cleared by specifying it in the update mask and not in the `CourseWork` object. If a field that does not support empty values is included in the update mask and not set in the `CourseWork` object, an `INVALID_ARGUMENT` error is returned. The following fields may be specified by teachers: * `title` * `description` * `state` * `due_date` * `due_time` * `max_points` * `scheduled_time` * `submission_modification_mode` * `topic_id` * `grading_period_id` Available in [V1_20240401_PREVIEW](https://developers.google.com/classroom/reference/preview) and later. */ updateMask?: string; @@ -6713,7 +6713,7 @@ export namespace classroom_v1 { */ addOnToken?: string; /** - * Optional. The identifier of the attachment. This field is required for student users and optional for teacher users. If not provided in the student case, an error is returned. + * Optional. The identifier of the attachment. This field is required for all requests except when the user is in the [Attachment Discovery iframe](https://developers.google.com/classroom/add-ons/get-started/iframes/attachment-discovery-iframe). */ attachmentId?: string; /** @@ -7461,7 +7461,7 @@ export namespace classroom_v1 { */ addOnToken?: string; /** - * Optional. The identifier of the attachment. This field is required for student users and optional for teacher users. If not provided in the student case, an error is returned. + * Optional. The identifier of the attachment. This field is required for all requests except when the user is in the [Attachment Discovery iframe](https://developers.google.com/classroom/add-ons/get-started/iframes/attachment-discovery-iframe). */ attachmentId?: string; /** diff --git a/src/apis/cloudasset/v1.ts b/src/apis/cloudasset/v1.ts index a099d5e498..c976bda561 100644 --- a/src/apis/cloudasset/v1.ts +++ b/src/apis/cloudasset/v1.ts @@ -1384,7 +1384,7 @@ export namespace cloudasset_v1 { */ sourceRestriction?: string | null; /** - * Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. + * Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out. */ sources?: Schema$GoogleIdentityAccesscontextmanagerV1EgressSource[]; } @@ -1406,7 +1406,7 @@ export namespace cloudasset_v1 { */ export interface Schema$GoogleIdentityAccesscontextmanagerV1EgressSource { /** - * An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. + * An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out. */ accessLevel?: string | null; } @@ -1593,7 +1593,7 @@ export namespace cloudasset_v1 { */ export interface Schema$GoogleIdentityAccesscontextmanagerV1VpcNetworkSource { /** - * Sub-segment ranges of a VPC network. + * Sub-segment ranges of a VPC network. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out. */ vpcSubnetwork?: Schema$GoogleIdentityAccesscontextmanagerV1VpcSubNetwork; } diff --git a/src/apis/cloudasset/v1beta1.ts b/src/apis/cloudasset/v1beta1.ts index bcd126f93a..82dfe85aaf 100644 --- a/src/apis/cloudasset/v1beta1.ts +++ b/src/apis/cloudasset/v1beta1.ts @@ -653,7 +653,7 @@ export namespace cloudasset_v1beta1 { */ sourceRestriction?: string | null; /** - * Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. + * Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out. */ sources?: Schema$GoogleIdentityAccesscontextmanagerV1EgressSource[]; } @@ -675,7 +675,7 @@ export namespace cloudasset_v1beta1 { */ export interface Schema$GoogleIdentityAccesscontextmanagerV1EgressSource { /** - * An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. + * An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out. */ accessLevel?: string | null; } @@ -862,7 +862,7 @@ export namespace cloudasset_v1beta1 { */ export interface Schema$GoogleIdentityAccesscontextmanagerV1VpcNetworkSource { /** - * Sub-segment ranges of a VPC network. + * Sub-segment ranges of a VPC network. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out. */ vpcSubnetwork?: Schema$GoogleIdentityAccesscontextmanagerV1VpcSubNetwork; } diff --git a/src/apis/cloudasset/v1p1beta1.ts b/src/apis/cloudasset/v1p1beta1.ts index 543c72f327..4008b6b479 100644 --- a/src/apis/cloudasset/v1p1beta1.ts +++ b/src/apis/cloudasset/v1p1beta1.ts @@ -580,7 +580,7 @@ export namespace cloudasset_v1p1beta1 { */ sourceRestriction?: string | null; /** - * Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. + * Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out. */ sources?: Schema$GoogleIdentityAccesscontextmanagerV1EgressSource[]; } @@ -602,7 +602,7 @@ export namespace cloudasset_v1p1beta1 { */ export interface Schema$GoogleIdentityAccesscontextmanagerV1EgressSource { /** - * An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. + * An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out. */ accessLevel?: string | null; } @@ -789,7 +789,7 @@ export namespace cloudasset_v1p1beta1 { */ export interface Schema$GoogleIdentityAccesscontextmanagerV1VpcNetworkSource { /** - * Sub-segment ranges of a VPC network. + * Sub-segment ranges of a VPC network. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out. */ vpcSubnetwork?: Schema$GoogleIdentityAccesscontextmanagerV1VpcSubNetwork; } diff --git a/src/apis/cloudasset/v1p5beta1.ts b/src/apis/cloudasset/v1p5beta1.ts index c27d43edb3..3f4afe54c8 100644 --- a/src/apis/cloudasset/v1p5beta1.ts +++ b/src/apis/cloudasset/v1p5beta1.ts @@ -610,7 +610,7 @@ export namespace cloudasset_v1p5beta1 { */ sourceRestriction?: string | null; /** - * Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. + * Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out. */ sources?: Schema$GoogleIdentityAccesscontextmanagerV1EgressSource[]; } @@ -632,7 +632,7 @@ export namespace cloudasset_v1p5beta1 { */ export interface Schema$GoogleIdentityAccesscontextmanagerV1EgressSource { /** - * An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. + * An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out. */ accessLevel?: string | null; } @@ -819,7 +819,7 @@ export namespace cloudasset_v1p5beta1 { */ export interface Schema$GoogleIdentityAccesscontextmanagerV1VpcNetworkSource { /** - * Sub-segment ranges of a VPC network. + * Sub-segment ranges of a VPC network. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out. */ vpcSubnetwork?: Schema$GoogleIdentityAccesscontextmanagerV1VpcSubNetwork; } diff --git a/src/apis/cloudasset/v1p7beta1.ts b/src/apis/cloudasset/v1p7beta1.ts index 6e4b62544e..406fb63aca 100644 --- a/src/apis/cloudasset/v1p7beta1.ts +++ b/src/apis/cloudasset/v1p7beta1.ts @@ -656,7 +656,7 @@ export namespace cloudasset_v1p7beta1 { */ sourceRestriction?: string | null; /** - * Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. + * Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out. */ sources?: Schema$GoogleIdentityAccesscontextmanagerV1EgressSource[]; } @@ -678,7 +678,7 @@ export namespace cloudasset_v1p7beta1 { */ export interface Schema$GoogleIdentityAccesscontextmanagerV1EgressSource { /** - * An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. + * An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out. */ accessLevel?: string | null; } @@ -865,7 +865,7 @@ export namespace cloudasset_v1p7beta1 { */ export interface Schema$GoogleIdentityAccesscontextmanagerV1VpcNetworkSource { /** - * Sub-segment ranges of a VPC network. + * Sub-segment ranges of a VPC network. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out. */ vpcSubnetwork?: Schema$GoogleIdentityAccesscontextmanagerV1VpcSubNetwork; } diff --git a/src/apis/cloudbuild/v1.ts b/src/apis/cloudbuild/v1.ts index 50082a93c6..63dffae3db 100644 --- a/src/apis/cloudbuild/v1.ts +++ b/src/apis/cloudbuild/v1.ts @@ -1514,7 +1514,7 @@ export namespace cloudbuild_v1 { */ export interface Schema$HttpConfig { /** - * SecretVersion resource of the HTTP proxy URL. The Service Account should have accessor permissions on this secret. The proxy URL should be in format protocol://@]proxyhost[:port]. + * 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]`. */ proxySecretVersionName?: string | null; } diff --git a/src/apis/cloudbuild/v2.ts b/src/apis/cloudbuild/v2.ts index 9cb109be63..cca9bb6c5c 100644 --- a/src/apis/cloudbuild/v2.ts +++ b/src/apis/cloudbuild/v2.ts @@ -848,6 +848,10 @@ export namespace cloudbuild_v2 { * Value of the parameter if type is array. */ arrayVal?: string[] | null; + /** + * Optional. Value of the parameter if type is object. + */ + objectVal?: {[key: string]: string} | null; /** * Value of the parameter if type is string. */ diff --git a/src/apis/clouderrorreporting/v1beta1.ts b/src/apis/clouderrorreporting/v1beta1.ts index 431b27fa29..cfaef6d1ca 100644 --- a/src/apis/clouderrorreporting/v1beta1.ts +++ b/src/apis/clouderrorreporting/v1beta1.ts @@ -179,7 +179,7 @@ export namespace clouderrorreporting_v1beta1 { */ groupId?: string | null; /** - * The group resource name. Written as `projects/{projectID\}/groups/{group_id\}`. Example: `projects/my-project-123/groups/my-group` In the group resource name, the `group_id` is a unique identifier for a particular error group. The identifier is derived from key parts of the error-log content and is treated as Service Data. For information about how Service Data is handled, see [Google Cloud Privacy Notice](https://cloud.google.com/terms/cloud-privacy-notice). + * The group resource name. Written as `projects/{projectID\}/groups/{group_id\}` or `projects/{projectID\}/locations/{location\}/groups/{group_id\}` Examples: `projects/my-project-123/groups/my-group`, `projects/my-project-123/locations/us-central1/groups/my-group` In the group resource name, the `group_id` is a unique identifier for a particular error group. The identifier is derived from key parts of the error-log content and is treated as Service Data. For information about how Service Data is handled, see [Google Cloud Privacy Notice](https://cloud.google.com/terms/cloud-privacy-notice). For a list of supported locations, see [Supported Regions](https://cloud.google.com/logging/docs/region-support). `global` is the default when unspecified. */ name?: string | null; /** @@ -399,11 +399,13 @@ export namespace clouderrorreporting_v1beta1 { events: Resource$Projects$Events; groups: Resource$Projects$Groups; groupStats: Resource$Projects$Groupstats; + locations: Resource$Projects$Locations; constructor(context: APIRequestContext) { this.context = context; this.events = new Resource$Projects$Events(this.context); this.groups = new Resource$Projects$Groups(this.context); this.groupStats = new Resource$Projects$Groupstats(this.context); + this.locations = new Resource$Projects$Locations(this.context); } /** @@ -506,7 +508,7 @@ export namespace clouderrorreporting_v1beta1 { export interface Params$Resource$Projects$Deleteevents extends StandardParameters { /** - * Required. The resource name of the Google Cloud Platform project. Written as `projects/{projectID\}`, where `{projectID\}` is the [Google Cloud Platform project ID](https://support.google.com/cloud/answer/6158840). Example: `projects/my-project-123`. + * Required. The resource name of the Google Cloud Platform project. Written as `projects/{projectID\}` or `projects/{projectID\}/locations/{location\}`, where `{projectID\}` is the [Google Cloud Platform project ID](https://support.google.com/cloud/answer/6158840) and `{location\}` is a Cloud region. Examples: `projects/my-project-123`, `projects/my-project-123/locations/global`. For a list of supported locations, see [Supported Regions](https://cloud.google.com/logging/docs/region-support). `global` is the default when unspecified. */ projectName?: string; } @@ -610,7 +612,7 @@ export namespace clouderrorreporting_v1beta1 { } /** - * Report an individual error event and record the event to a log. This endpoint accepts **either** an OAuth token, **or** an [API key](https://support.google.com/cloud/answer/6158862) for authentication. To use an API key, append it to the URL as the value of a `key` parameter. For example: `POST https://clouderrorreporting.googleapis.com/v1beta1/{projectName\}/events:report?key=123ABC456` **Note:** [Error Reporting] (https://cloud.google.com/error-reporting) is a global service built on Cloud Logging and can analyze log entries when all of the following are true: * The log entries are stored in a log bucket in the `global` location. * Customer-managed encryption keys (CMEK) are disabled on the log bucket. * The log bucket satisfies one of the following: * The log bucket is stored in the same project where the logs originated. * The logs were routed to a project, and then that project stored those logs in a log bucket that it owns. + * Report an individual error event and record the event to a log. This endpoint accepts **either** an OAuth token, **or** an [API key](https://support.google.com/cloud/answer/6158862) for authentication. To use an API key, append it to the URL as the value of a `key` parameter. For example: `POST https://clouderrorreporting.googleapis.com/v1beta1/{projectName\}/events:report?key=123ABC456` **Note:** [Error Reporting] (https://cloud.google.com/error-reporting) is a service built on Cloud Logging and can analyze log entries when all of the following are true: * Customer-managed encryption keys (CMEK) are disabled on the log bucket. * The log bucket satisfies one of the following: * The log bucket is stored in the same project where the logs originated. * The logs were routed to a project, and then that project stored those logs in a log bucket that it owns. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -721,7 +723,7 @@ export namespace clouderrorreporting_v1beta1 { */ pageToken?: string; /** - * Required. The resource name of the Google Cloud Platform project. Written as `projects/{projectID\}`, where `{projectID\}` is the [Google Cloud Platform project ID](https://support.google.com/cloud/answer/6158840). Example: `projects/my-project-123`. + * Required. The resource name of the Google Cloud Platform project. Written as `projects/{projectID\}` or `projects/{projectID\}/locations/{location\}`, where `{projectID\}` is the [Google Cloud Platform project ID](https://support.google.com/cloud/answer/6158840) and `{location\}` is a Cloud region. Examples: `projects/my-project-123`, `projects/my-project-123/locations/global`. For a list of supported locations, see [Supported Regions](https://cloud.google.com/logging/docs/region-support). `global` is the default when unspecified. */ projectName?: string; /** @@ -939,14 +941,14 @@ export namespace clouderrorreporting_v1beta1 { export interface Params$Resource$Projects$Groups$Get extends StandardParameters { /** - * Required. The group resource name. Written as `projects/{projectID\}/groups/{group_id\}`. Call groupStats.list to return a list of groups belonging to this project. Example: `projects/my-project-123/groups/my-group` In the group resource name, the `group_id` is a unique identifier for a particular error group. The identifier is derived from key parts of the error-log content and is treated as Service Data. For information about how Service Data is handled, see [Google Cloud Privacy Notice](https://cloud.google.com/terms/cloud-privacy-notice). + * Required. The group resource name. Written as either `projects/{projectID\}/groups/{group_id\}` or `projects/{projectID\}/locations/{location\}/groups/{group_id\}`. Call groupStats.list to return a list of groups belonging to this project. Examples: `projects/my-project-123/groups/my-group`, `projects/my-project-123/locations/global/groups/my-group` In the group resource name, the `group_id` is a unique identifier for a particular error group. The identifier is derived from key parts of the error-log content and is treated as Service Data. For information about how Service Data is handled, see [Google Cloud Privacy Notice](https://cloud.google.com/terms/cloud-privacy-notice). For a list of supported locations, see [Supported Regions](https://cloud.google.com/logging/docs/region-support). `global` is the default when unspecified. */ groupName?: string; } export interface Params$Resource$Projects$Groups$Update extends StandardParameters { /** - * The group resource name. Written as `projects/{projectID\}/groups/{group_id\}`. Example: `projects/my-project-123/groups/my-group` In the group resource name, the `group_id` is a unique identifier for a particular error group. The identifier is derived from key parts of the error-log content and is treated as Service Data. For information about how Service Data is handled, see [Google Cloud Privacy Notice](https://cloud.google.com/terms/cloud-privacy-notice). + * The group resource name. Written as `projects/{projectID\}/groups/{group_id\}` or `projects/{projectID\}/locations/{location\}/groups/{group_id\}` Examples: `projects/my-project-123/groups/my-group`, `projects/my-project-123/locations/us-central1/groups/my-group` In the group resource name, the `group_id` is a unique identifier for a particular error group. The identifier is derived from key parts of the error-log content and is treated as Service Data. For information about how Service Data is handled, see [Google Cloud Privacy Notice](https://cloud.google.com/terms/cloud-privacy-notice). For a list of supported locations, see [Supported Regions](https://cloud.google.com/logging/docs/region-support). `global` is the default when unspecified. */ name?: string; @@ -1084,7 +1086,616 @@ export namespace clouderrorreporting_v1beta1 { */ pageToken?: string; /** - * Required. The resource name of the Google Cloud Platform project. Written as `projects/{projectID\}` or `projects/{projectNumber\}`, where `{projectID\}` and `{projectNumber\}` can be found in the [Google Cloud console](https://support.google.com/cloud/answer/6158840). Examples: `projects/my-project-123`, `projects/5551234`. + * Required. The resource name of the Google Cloud Platform project. Written as `projects/{projectID\}` or `projects/{projectNumber\}`, where `{projectID\}` and `{projectNumber\}` can be found in the [Google Cloud console](https://support.google.com/cloud/answer/6158840). It may also include a location, such as `projects/{projectID\}/locations/{location\}` where `{location\}` is a cloud region. Examples: `projects/my-project-123`, `projects/5551234`, `projects/my-project-123/locations/us-central1`, `projects/5551234/locations/us-central1`. For a list of supported locations, see [Supported Regions](https://cloud.google.com/logging/docs/region-support). `global` is the default when unspecified. Use `-` as a wildcard to request group stats from all regions. + */ + projectName?: string; + /** + * Optional. The exact value to match against [`ServiceContext.resource_type`](/error-reporting/reference/rest/v1beta1/ServiceContext#FIELDS.resource_type). + */ + 'serviceFilter.resourceType'?: string; + /** + * Optional. The exact value to match against [`ServiceContext.service`](/error-reporting/reference/rest/v1beta1/ServiceContext#FIELDS.service). + */ + 'serviceFilter.service'?: string; + /** + * Optional. The exact value to match against [`ServiceContext.version`](/error-reporting/reference/rest/v1beta1/ServiceContext#FIELDS.version). + */ + 'serviceFilter.version'?: string; + /** + * Optional. The preferred duration for a single returned TimedCount. If not set, no timed counts are returned. + */ + timedCountDuration?: string; + /** + * Restricts the query to the specified time range. + */ + 'timeRange.period'?: string; + } + + export class Resource$Projects$Locations { + context: APIRequestContext; + events: Resource$Projects$Locations$Events; + groups: Resource$Projects$Locations$Groups; + groupStats: Resource$Projects$Locations$Groupstats; + constructor(context: APIRequestContext) { + this.context = context; + this.events = new Resource$Projects$Locations$Events(this.context); + this.groups = new Resource$Projects$Locations$Groups(this.context); + this.groupStats = new Resource$Projects$Locations$Groupstats( + this.context + ); + } + + /** + * Deletes all error events of a given project. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + deleteEvents( + params: Params$Resource$Projects$Locations$Deleteevents, + options: StreamMethodOptions + ): GaxiosPromise; + deleteEvents( + params?: Params$Resource$Projects$Locations$Deleteevents, + options?: MethodOptions + ): GaxiosPromise; + deleteEvents( + params: Params$Resource$Projects$Locations$Deleteevents, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + deleteEvents( + params: Params$Resource$Projects$Locations$Deleteevents, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + deleteEvents( + params: Params$Resource$Projects$Locations$Deleteevents, + callback: BodyResponseCallback + ): void; + deleteEvents( + callback: BodyResponseCallback + ): void; + deleteEvents( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Deleteevents + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Deleteevents; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Deleteevents; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://clouderrorreporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+projectName}/events').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['projectName'], + pathParams: ['projectName'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Deleteevents + extends StandardParameters { + /** + * Required. The resource name of the Google Cloud Platform project. Written as `projects/{projectID\}` or `projects/{projectID\}/locations/{location\}`, where `{projectID\}` is the [Google Cloud Platform project ID](https://support.google.com/cloud/answer/6158840) and `{location\}` is a Cloud region. Examples: `projects/my-project-123`, `projects/my-project-123/locations/global`. For a list of supported locations, see [Supported Regions](https://cloud.google.com/logging/docs/region-support). `global` is the default when unspecified. + */ + projectName?: string; + } + + export class Resource$Projects$Locations$Events { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Lists the specified events. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Locations$Events$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Events$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Events$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Events$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Events$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Events$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Events$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Events$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://clouderrorreporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+projectName}/events').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['projectName'], + pathParams: ['projectName'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Events$List + extends StandardParameters { + /** + * Required. The group for which events shall be returned. The `group_id` is a unique identifier for a particular error group. The identifier is derived from key parts of the error-log content and is treated as Service Data. For information about how Service Data is handled, see [Google Cloud Privacy Notice](https://cloud.google.com/terms/cloud-privacy-notice). + */ + groupId?: string; + /** + * Optional. The maximum number of results to return per response. + */ + pageSize?: number; + /** + * Optional. A `next_page_token` provided by a previous response. + */ + pageToken?: string; + /** + * Required. The resource name of the Google Cloud Platform project. Written as `projects/{projectID\}` or `projects/{projectID\}/locations/{location\}`, where `{projectID\}` is the [Google Cloud Platform project ID](https://support.google.com/cloud/answer/6158840) and `{location\}` is a Cloud region. Examples: `projects/my-project-123`, `projects/my-project-123/locations/global`. For a list of supported locations, see [Supported Regions](https://cloud.google.com/logging/docs/region-support). `global` is the default when unspecified. + */ + projectName?: string; + /** + * Optional. The exact value to match against [`ServiceContext.resource_type`](/error-reporting/reference/rest/v1beta1/ServiceContext#FIELDS.resource_type). + */ + 'serviceFilter.resourceType'?: string; + /** + * Optional. The exact value to match against [`ServiceContext.service`](/error-reporting/reference/rest/v1beta1/ServiceContext#FIELDS.service). + */ + 'serviceFilter.service'?: string; + /** + * Optional. The exact value to match against [`ServiceContext.version`](/error-reporting/reference/rest/v1beta1/ServiceContext#FIELDS.version). + */ + 'serviceFilter.version'?: string; + /** + * Restricts the query to the specified time range. + */ + 'timeRange.period'?: string; + } + + export class Resource$Projects$Locations$Groups { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Get the specified group. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Projects$Locations$Groups$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Groups$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Groups$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Groups$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Groups$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Groups$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Groups$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Groups$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://clouderrorreporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+groupName}').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['groupName'], + pathParams: ['groupName'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Replace the data for the specified group. Fails if the group does not exist. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + update( + params: Params$Resource$Projects$Locations$Groups$Update, + options: StreamMethodOptions + ): GaxiosPromise; + update( + params?: Params$Resource$Projects$Locations$Groups$Update, + options?: MethodOptions + ): GaxiosPromise; + update( + params: Params$Resource$Projects$Locations$Groups$Update, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + update( + params: Params$Resource$Projects$Locations$Groups$Update, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + update( + params: Params$Resource$Projects$Locations$Groups$Update, + callback: BodyResponseCallback + ): void; + update(callback: BodyResponseCallback): void; + update( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Groups$Update + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Groups$Update; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Groups$Update; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://clouderrorreporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PUT', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Groups$Get + extends StandardParameters { + /** + * Required. The group resource name. Written as either `projects/{projectID\}/groups/{group_id\}` or `projects/{projectID\}/locations/{location\}/groups/{group_id\}`. Call groupStats.list to return a list of groups belonging to this project. Examples: `projects/my-project-123/groups/my-group`, `projects/my-project-123/locations/global/groups/my-group` In the group resource name, the `group_id` is a unique identifier for a particular error group. The identifier is derived from key parts of the error-log content and is treated as Service Data. For information about how Service Data is handled, see [Google Cloud Privacy Notice](https://cloud.google.com/terms/cloud-privacy-notice). For a list of supported locations, see [Supported Regions](https://cloud.google.com/logging/docs/region-support). `global` is the default when unspecified. + */ + groupName?: string; + } + export interface Params$Resource$Projects$Locations$Groups$Update + extends StandardParameters { + /** + * The group resource name. Written as `projects/{projectID\}/groups/{group_id\}` or `projects/{projectID\}/locations/{location\}/groups/{group_id\}` Examples: `projects/my-project-123/groups/my-group`, `projects/my-project-123/locations/us-central1/groups/my-group` In the group resource name, the `group_id` is a unique identifier for a particular error group. The identifier is derived from key parts of the error-log content and is treated as Service Data. For information about how Service Data is handled, see [Google Cloud Privacy Notice](https://cloud.google.com/terms/cloud-privacy-notice). For a list of supported locations, see [Supported Regions](https://cloud.google.com/logging/docs/region-support). `global` is the default when unspecified. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$ErrorGroup; + } + + export class Resource$Projects$Locations$Groupstats { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Lists the specified groups. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Locations$Groupstats$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Groupstats$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Groupstats$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Groupstats$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Groupstats$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Groupstats$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Groupstats$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Groupstats$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://clouderrorreporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+projectName}/groupStats').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['projectName'], + pathParams: ['projectName'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Groupstats$List + extends StandardParameters { + /** + * Optional. The alignment of the timed counts to be returned. Default is `ALIGNMENT_EQUAL_AT_END`. + */ + alignment?: string; + /** + * Optional. Time where the timed counts shall be aligned if rounded alignment is chosen. Default is 00:00 UTC. + */ + alignmentTime?: string; + /** + * Optional. List all ErrorGroupStats with these IDs. The `group_id` is a unique identifier for a particular error group. The identifier is derived from key parts of the error-log content and is treated as Service Data. For information about how Service Data is handled, see [Google Cloud Privacy Notice] (https://cloud.google.com/terms/cloud-privacy-notice). + */ + groupId?: string[]; + /** + * Optional. The sort order in which the results are returned. Default is `COUNT_DESC`. + */ + order?: string; + /** + * Optional. The maximum number of results to return per response. Default is 20. + */ + pageSize?: number; + /** + * Optional. A next_page_token provided by a previous response. To view additional results, pass this token along with the identical query parameters as the first request. + */ + pageToken?: string; + /** + * Required. The resource name of the Google Cloud Platform project. Written as `projects/{projectID\}` or `projects/{projectNumber\}`, where `{projectID\}` and `{projectNumber\}` can be found in the [Google Cloud console](https://support.google.com/cloud/answer/6158840). It may also include a location, such as `projects/{projectID\}/locations/{location\}` where `{location\}` is a cloud region. Examples: `projects/my-project-123`, `projects/5551234`, `projects/my-project-123/locations/us-central1`, `projects/5551234/locations/us-central1`. For a list of supported locations, see [Supported Regions](https://cloud.google.com/logging/docs/region-support). `global` is the default when unspecified. Use `-` as a wildcard to request group stats from all regions. */ projectName?: string; /** diff --git a/src/apis/cloudsearch/v1.ts b/src/apis/cloudsearch/v1.ts index 166fef229b..1a87d76e67 100644 --- a/src/apis/cloudsearch/v1.ts +++ b/src/apis/cloudsearch/v1.ts @@ -179,6 +179,11 @@ export namespace cloudsearch_v1 { */ text?: string | null; } + export interface Schema$BandWidthRangeKbps { + percentile10?: number | null; + percentile50?: number | null; + percentile90?: number | null; + } /** * Used to provide a search operator for boolean properties. This is optional. Search operators let users restrict the query to specific fields relevant to the type of item being searched. */ @@ -203,2018 +208,3536 @@ export namespace cloudsearch_v1 { */ hasAccess?: boolean | null; } - export interface Schema$CompositeFilter { - /** - * The logic operator of the sub filter. - */ - logicOperator?: string | null; + /** + * Represents the user's current opt-in status on the current device related to features such as Google Now, App and Web History, Device State and Content. Each opt-in status includes an eligibility status, which depends on the type of account (Dasher, etc.), country, language, and device specifics. Next id: 38 Note: if the proto is changed, please also update the code that converts it to corresponding logs proto (they are in the same name but incompatible so manual conversion is needed). LINT.IfChange + */ + export interface Schema$ClientOptInContext { /** - * Sub filters. + * Enrollment status for Ambient Mode feature go/assistant-ambient-mode */ - subFilters?: Schema$Filter[]; - } - export interface Schema$Content { + ambientEnrollmentStatus?: string | null; /** - * [Optional] Actions for this card. + * Enrollment status for PhotoFrame feature in Ambient Mode. This is different from PhotoFrame enrollment in other features such as Dreamliner. go/assistant-ambient-mode */ - actions?: Schema$Action[]; + ambientPhotoEnrollmentStatus?: string | null; /** - * [Optional] Description of the card. + * Whether the user has opted into enabling Assistant on Lockscreen. go/iris-newperm-prd */ - description?: Schema$SafeHtmlProto; + assistantOnLockscreenStatus?: string | null; /** - * [Optional] Subtitle of the card. + * Audio History. Used to improve speech recognition and hotword triggering. https://sites.google.com/a/google.com/android-speech/projects/audio-history */ - subtitle?: Schema$BackgroundColoredText; + audioHistoryStatus?: Schema$OptInStatus; /** - * [Optional] Title of the card. + * Whether the user has opted into bluetooth audio recording setting. */ - title?: Schema$BackgroundColoredText; - } - export interface Schema$Context { + bluetoothAudioRecordingStatus?: string | null; /** - * [Optional] App where the card should be shown. If missing, the card will be shown in TOPAZ. + * Set to true iff the user is signed into Chrome with the same account as GSA and has Chrome sync enabled (as reported by Chrome to GSA). This can be used to serve personalized suggestions based on the user's browsing history. */ - app?: string[] | null; + chromeSyncStatus?: Schema$OptInStatus; /** - * [Optional] Day of week when the card should be shown, where 0 is Monday. + * Allows Google to upload device app information. */ - dayOfWeek?: number[] | null; + deviceAppsStatus?: Schema$OptInStatus; /** - * [Optional] Date (in seconds since epoch) when the card should stop being shown. If missing, end_date_sec will be set to Jan 1st, 2100. + * Allows Google to upload contact information from device. */ - endDateSec?: string | null; + deviceContactsStatus?: Schema$OptInStatus; /** - * [Optional] End time in seconds, within a day, when the card should stop being shown if it's within [start_date_sec, end_date_sec]. If missing, this is set to 86400 (24 hours x 3600 sec/hour), i.e., midnight next day. + * User allows Google to upload state (aka settings) and content (documents and media) from their device. See https://goto.google.com/device-consents */ - endDayOffsetSec?: string | null; + deviceStateAndContentStatus?: Schema$OptInStatus; /** - * [Optional] The locales for which the card should be triggered (e.g., en_US and en_CA). If missing, the card is going to show to clients regardless of their locale. + * List of Android package names the user disabled from appearing in the autocomplete suggestions on their device. */ - locale?: string[] | null; + disabledIcingSourceApps?: string[] | null; /** - * [Optional] Text-free locations where the card should be shown. This is expected to match the user's location in focus. If no location is specified, the card will be shown for any location. + * List of Android packages and corpora that the user disabled. This replaces disabled_icing_source_apps and allows disabling a single corpus for a particular package. */ - location?: string[] | null; + disabledIcingSources?: Schema$DisabledIcingPackageCorpus[]; /** - * [Required only for Answer and RHS cards - will be ignored for Homepage] cards. It's the exact case-insensitive queries that will trigger the Answer or RHS card. + * Whether the user has opted into headphone personal results setting. go/enable-pr-with-headset */ - query?: string[] | null; + headphonePersonalResultsStatus?: string | null; /** - * [Optional] Date (in seconds since epoch) when the card should start being shown. If missing, start_date_sec will be Jan 1st, 1970 UTC. + * Enrollment status for Hotword any-screen/always-on. This information is sent to the server-side to know that the user can run Hotword. For example, in go/gsa-voice-feature-tips using this information, the user will be shown Voice Tips that will take the user directly to the enrollment and guide them to move to the next level of Voice Features experience. */ - startDateSec?: string | null; + hotwordEnrollmentStatus?: Schema$OptInStatus; /** - * [Optional] Start time in seconds, within a day, when the card should be shown if it's within [start_date_sec, end_date_sec]. If 0, the card will be shown from 12:00am on. + * User allows Google to upload location history from their device. See https://goto.google.com/gcore-ulr */ - startDayOffsetSec?: string | null; + locationHistoryStatus?: Schema$OptInStatus; /** - * [Optional] Surface where the card should be shown in. If missing, the card will be shown in any surface. + * Whether the user has opted into showing personal response on Lockscreen. */ - surface?: string[] | null; + lockscreenPersonalResponseStatus?: string | null; /** - * [Required] Type of the card (homepage, Answer or RHS). + * Whether the user has opted into lockscreen queries via bluetooth headsets setting. */ - type?: string[] | null; - } - /** - * A named attribute associated with an item which can be used for influencing the ranking of the item based on the context in the request. - */ - export interface Schema$ContextAttribute { + lockscreenSearchBluetoothStatus?: string | null; /** - * The name of the attribute. It should not be empty. The maximum length is 32 characters. The name must start with a letter and can only contain letters (A-Z, a-z) or numbers (0-9). The name will be normalized (lower-cased) before being matched. + * Whether the user has opted into lockscreen queries via wired headsets setting. */ - name?: string | null; + lockscreenSearchWiredHeadsetStatus?: string | null; /** - * Text values of the attribute. The maximum number of elements is 10. The maximum length of an element in the array is 32 characters. The value will be normalized (lower-cased) before being matched. + * Google Now push notifications. */ - values?: string[] | null; - } - /** - * Aggregation of items by status code as of the specified date. - */ - export interface Schema$CustomerIndexStats { + nowNotificationStatus?: Schema$OptInStatus; /** - * The date for which statistics were calculated. + * Google Now activation. */ - date?: Schema$Date; + nowStatus?: Schema$OptInStatus; /** - * Number of items aggregrated by status code. + * Google Now marks each release with a TOS version, so it can ask users to opt in again if the terms change from release to release. */ - itemCountByStatus?: Schema$ItemCountByStatus[]; - } - export interface Schema$CustomerQueryStats { + nowTosVersion?: number | null; /** - * The date for which query stats were calculated. Stats calculated on the next day close to midnight are returned. + * User's eligibility to use the Assistant. */ - date?: Schema$Date; - queryCountByStatus?: Schema$QueryCountByStatus[]; - } - /** - * Search application stats for a customer for the given date. - */ - export interface Schema$CustomerSearchApplicationStats { + opaEligibility?: string | null; /** - * The count of search applications for the date. + * Has the user opted-in to receiving emails for OPA? This is set when the user opts-in during the OPA upgrade flow. It has an UNKNOWN value otherwise. Note that this bit isn't updated if the user changes their email opt-in status through settings or unsubscribing in the email. */ - count?: string | null; + opaEmailOptInStatus?: string | null; /** - * The date for which search application stats were calculated. + * The Opa experience type. As of Feb 2019, it is only used to check whether the user is in the Try Before You Buy experience. */ - date?: Schema$Date; - } - export interface Schema$CustomerSessionStats { + opaExperienceType?: string | null; /** - * The date for which session stats were calculated. Stats are calculated on the following day, close to midnight PST, and then returned. + * The reason why user enters the OPA "signed-out mode" partial experience (go/opa-signed-out-everywhere). Note that the value only means how the user entered the partial experience. For example, if a user enters TBYB and becomes a full-experience user, this value will remain as TBYB. To check the current experience type, you should read opa_experience_type instead. */ - date?: Schema$Date; + opaPartialExperienceReason?: string | null; /** - * The count of search sessions on the day + * Has the user opted in to OPA's UDC requirements? "OPA UDC consent" is a one-time opt-in to the set of required UDC opt-in bits. If the user has already granted all required UDC opt-ins, then we automatically mark them as consented. We require that users grant OPA UDC consent before using OPA for the first time. Note: The user does not revoke OPA UDC consent if they turn off one of the UDC opt-in bits from Settings; for such users, the server either offers a degraded experience, or prompts the user to re-grant missing opt-ins.) */ - searchSessionsCount?: string | null; - } - /** - * Represents settings at a customer level. - */ - export interface Schema$CustomerSettings { + opaUdcConsentStatus?: string | null; /** - * Audit Logging settings for the customer. If update_mask is empty then this field will be updated based on UpdateCustomerSettings request. + * A user-configurable global on/off switch for the Assistant; the user can completely disable the assistant (go/opa-enabled-ss). Defaults to enabled. This setting is completely independent from the user's opa_eligibility; they can be eligible, but OPA disabled. There users are by definition not making Assistant queries, so this value is a signal of the population size. */ - auditLoggingSettings?: Schema$AuditLoggingSettings; + opaUserEnabledStatus?: string | null; /** - * VPC SC settings for the customer. If update_mask is empty then this field will be updated based on UpdateCustomerSettings request. + * Whether the user has opted into showing proactive personal suggestions on lock screen before asking. This is the proactive sub-bit for lockscreen_personal_response_status. */ - vpcSettings?: Schema$VPCSettings; - } - export interface Schema$CustomerUserStats { + proactivePersonalResponseStatus?: string | null; /** - * The date for which session stats were calculated. Stats calculated on the next day close to midnight are returned. + * Has the user granted permission for Google to read the contents of their screen. Note that in OPA, training hotword automatically opts the user into screen context. */ - date?: Schema$Date; + screenContextOptInStatus?: string | null; /** - * The count of unique active users in the past one day + * Whether the user has opted into skipping voice recognition. go/iris-newperm-prd */ - oneDayActiveUsersCount?: string | null; + skipVoiceRecognitionStatus?: string | null; /** - * The count of unique active users in the past seven days + * Whether the user has enrolled the Speaker ID model. */ - sevenDaysActiveUsersCount?: string | null; + speakerModelStatus?: string | null; /** - * The count of unique active users in the past thirty days + * Whether the user has acknowledged the third party disclosure. */ - thirtyDaysActiveUsersCount?: string | null; - } - /** - * Datasource is a logical namespace for items to be indexed. All items must belong to a datasource. This is the prerequisite before items can be indexed into Cloud Search. - */ - export interface Schema$DataSource { + thirdPartyDisclosureStatus?: string | null; /** - * If true, sets the datasource to read-only mode. In read-only mode, the Indexing API rejects any requests to index or delete items in this source. Enabling read-only mode does not stop the processing of previously accepted data. + * Whether the user has opted into alarms/timers context for Quick phrases. */ - disableModifications?: boolean | null; + warmActionsAlarmsTimersEnrollmentStatus?: string | null; /** - * Disable serving any search or assist results. + * Whether the user has opted into calls context for Quick phrases. */ - disableServing?: boolean | null; + warmActionsCallsEnrollmentStatus?: string | null; /** - * Required. Display name of the datasource The maximum length is 300 characters. + * Whether the user has opted into at least one Mobile Warm Words/Quick Phrases context. go/mww-prd */ - displayName?: string | null; + warmActionsEnrollmentStatus?: string | null; /** - * List of service accounts that have indexing access. + * User allows Google to upload usage history from their device. This field can be set to true iff web_history_status is set to true. Historically, this used to be called "Supplemental Search History". See https://goto.google.com/device-consents */ - indexingServiceAccounts?: string[] | null; + webAndAppHistoryStatus?: Schema$OptInStatus; /** - * This field restricts visibility to items at the datasource level. Items within the datasource are restricted to the union of users and groups included in this field. Note that, this does not ensure access to a specific item, as users need to have ACL permissions on the contained items. This ensures a high level access on the entire datasource, and that the individual items are not shared outside this visibility. + * User allows Google to log interactions with Search from their device. Historically, this used to be called "Search History". See https://goto.google.com/device-consents */ - itemsVisibility?: Schema$GSuitePrincipal[]; + webHistoryStatus?: Schema$OptInStatus; + } + /** + * A person's email address. + */ + export interface Schema$CloudsearchEmailAddress { /** - * The name of the datasource resource. Format: datasources/{source_id\}. The name is ignored when creating a datasource. + * The email address. */ - name?: string | null; + emailAddress?: string | null; /** - * IDs of the Long Running Operations (LROs) currently running for this schema. + * Indicates if this is the user's primary email. Only one entry can be marked as primary. */ - operationIds?: string[] | null; + primary?: boolean | null; + } + /** + * Generic way of expessing filters. It support two ways. 1. Setting name and the value. The name has to be an operator_name defined in schema. 2. Setting the operator and filters. The sub filters will be evaluated using the operator. + */ + export interface Schema$CloudsearchFilter { /** - * Can a user request to get thumbnail URI for Items indexed in this data source. + * Sub filters. If present, the operator must be set. */ - returnThumbnailUrls?: boolean | null; + filters?: Schema$CloudsearchFilter[]; /** - * A short name or alias for the source. This value will be used to match the 'source' operator. For example, if the short name is ** then queries like *source:* will only return results for this source. The value must be unique across all datasources. The value must only contain alphanumeric characters (a-zA-Z0-9). The value cannot start with 'google' and cannot be one of the following: mail, gmail, docs, drive, groups, sites, calendar, hangouts, gplus, keep, people, teams. Its maximum length is 32 characters. + * The operator_name that we apply to the query, e.g. price_greater_than. It can be either case, 1. operator_name in schema. We will filter the results with the property that matches the value. 2. greater_than_operator_name or less_than_operator_name in schema. We will filter the results that property is greater than or less than the given value. */ - shortName?: string | null; - } - /** - * Aggregation of items by status code as of the specified date. - */ - export interface Schema$DataSourceIndexStats { + name?: string | null; /** - * The date for which index stats were calculated. If the date of request is not the current date then stats calculated on the next day are returned. Stats are calculated close to mid night in this case. If date of request is current date, then real time stats are returned. + * The operator of the filter. */ - date?: Schema$Date; + operator?: string | null; /** - * Number of items aggregrated by status code. + * The value to check. If present, the name must be set. */ - itemCountByStatus?: Schema$ItemCountByStatus[]; + value?: Schema$CloudsearchValue; } /** - * Restriction on Datasource. + * A filter suggestion. */ - export interface Schema$DataSourceRestriction { + export interface Schema$CloudsearchFilterSuggestion { /** - * Filter options restricting the results. If multiple filters are present, they are grouped by object type before joining. Filters with the same object type are joined conjunctively, then the resulting expressions are joined disjunctively. The maximum number of elements is 20. NOTE: Suggest API supports only few filters at the moment: "objecttype", "type" and "mimetype". For now, schema specific filters cannot be used to filter suggestions. + * The filter suggestion. It can be 1. A value filter, e.g. type:documents 2. A composite filter before:today and after:yesterday */ - filterOptions?: Schema$FilterOptions[]; + filter?: Schema$CloudsearchFilter; /** - * The source of restriction. + * This field contains the suggestion match information returned by the backend after escaping the HTML in the suggestion string. The areas that we might like to extract from the suggestion string returned by the backend are marked using the match_ranges field inside Snippet. For example, if the snippet string inside suggestion_match_info is: "google search", and the keyword "goog" is supposed to be bolded, the match_ranges is the list of range of indexes in the snippet string where it is bolded: [[0, 4)]. */ - source?: Schema$Source; + suggestionMatchInfo?: Schema$CloudsearchSnippet; + type?: string | null; } /** - * Represents a whole calendar date, for example a date of birth. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the [Proleptic Gregorian Calendar](https://en.wikipedia.org/wiki/Proleptic_Gregorian_calendar). The date must be a valid calendar date between the year 1 and 9999. + * Object to represent a group. */ - export interface Schema$Date { + export interface Schema$CloudsearchGroup { /** - * Day of month. Must be from 1 to 31 and valid for the year and month. + * The group's email addresses */ - day?: number | null; + emailAddresses?: Schema$CloudsearchEmailAddress[]; /** - * Month of date. Must be from 1 to 12. + * Group's names */ - month?: number | null; + groupNames?: Schema$CloudsearchName[]; /** - * Year of date. Must be from 1 to 9999. + * The resource name of the group to provide information about. See People.get from Google People API. */ - year?: number | null; + name?: string | null; + /** + * Obfuscated GAIA ID of a google group. Used by first party Cloud Search clients. + */ + obfuscatedId?: string | null; } /** - * Optional. Provides a search operator for date properties. Search operators let users restrict the query to specific fields relevant to the type of item being searched. + * Image returned with suggestion; eg: person's photo or document thumbnail. */ - export interface Schema$DateOperatorOptions { - /** - * Indicates the operator name required in the query in order to isolate the date property using the greater-than operator. For example, if greaterThanOperatorName is *closedafter* and the property's name is *closeDate*, then queries like *closedafter:* show results only where the value of the property named *closeDate* is later than **. The operator name can only contain lowercase letters (a-z). The maximum length is 32 characters. - */ - greaterThanOperatorName?: string | null; + export interface Schema$CloudsearchImage { /** - * Indicates the operator name required in the query in order to isolate the date property using the less-than operator. For example, if lessThanOperatorName is *closedbefore* and the property's name is *closeDate*, then queries like *closedbefore:* show results only where the value of the property named *closeDate* is earlier than **. The operator name can only contain lowercase letters (a-z). The maximum length is 32 characters. + * Specifies the source from where the photo is fetched. */ - lessThanOperatorName?: string | null; + source?: string | null; /** - * Indicates the actual string required in the query in order to isolate the date property. For example, suppose an issue tracking schema object has a property named *closeDate* that specifies an operator with an operatorName of *closedon*. For searches on that data, queries like *closedon:* show results only where the value of the *closeDate* property matches **. By contrast, a search that uses the same ** without an operator returns all items where ** matches the value of any String properties or text within the content field for the indexed datasource. The operator name can only contain lowercase letters (a-z). The maximum length is 32 characters. + * The URL of the photo. */ - operatorName?: string | null; + url?: string | null; } /** - * The options for date properties. + * Matched range of a snippet [start, end). The "start" and "end" positions are 0 indexed. For example, if the snippet string is "google search" and the string to be matched is "goog", the MatchRange is [0, 4). */ - export interface Schema$DatePropertyOptions { + export interface Schema$CloudsearchMatchRange { /** - * If set, describes how the date should be used as a search operator. + * 1 + index of the ending position of the match in the snippet. */ - operatorOptions?: Schema$DateOperatorOptions; + end?: number | null; + /** + * Index of the starting position of the match in the snippet. + */ + start?: number | null; } /** - * List of date values. + * A person or group's name. */ - export interface Schema$DateValues { - values?: Schema$Date[]; + export interface Schema$CloudsearchName { + /** + * The read-only display name formatted according to the locale specified by the viewer's account or the Accept-Language HTTP header. + */ + displayName?: string | null; + /** + * Specifies the source from where the name is fetched. + */ + source?: string | null; } /** - * Shared request debug options for all cloudsearch RPC methods. + * A person suggestion. */ - export interface Schema$DebugOptions { + export interface Schema$CloudsearchPeopleSuggestion { /** - * If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field. + * This field contains the suggestion information returned by the backend after escaping the HTML in the suggestion string. The areas that we might like to extract from the suggestion string returned by the backend are marked using the match_ranges field inside Snippet. For example, if the snippet string inside email_name_match_info is: "John Doe - johndoe@google.com", and the keyword "doe" should be matched, the match_ranges is: [[5, 8), [15, 18)]. */ - enableDebugging?: boolean | null; + emailNameMatchInfo?: Schema$CloudsearchSnippet; + googleGroup?: Schema$CloudsearchGroup; + person?: Schema$CloudsearchPerson; } /** - * Debug Search Response. + * Object to represent a person. */ - export interface Schema$DebugResponse { + export interface Schema$CloudsearchPerson { /** - * Serialized string of GenericSearchRequest. + * The person's email addresses */ - gsrRequest?: string | null; + emailAddresses?: Schema$CloudsearchEmailAddress[]; /** - * Serialized string of GenericSearchResponse. + * The resource name of the person to provide information about. See People.get from Google People API. */ - gsrResponse?: string | null; + name?: string | null; /** - * Search response. + * Obfuscated GAIA ID of a person. Used by first party Cloud Search client, to build a hangout link. */ - searchResponse?: Schema$SearchResponse; - } - export interface Schema$DeleteQueueItemsRequest { + obfuscatedId?: string | null; /** - * The name of connector making this call. Format: datasources/{source_id\}/connectors/{ID\} + * The person's names */ - connectorName?: string | null; + personNames?: Schema$CloudsearchName[]; /** - * Common debug options. + * A person's read-only photo. A picture shown next to the person's name to help others recognize the person in search results. */ - debugOptions?: Schema$DebugOptions; + photos?: Schema$CloudsearchImage[]; + } + export interface Schema$CloudsearchQuerySuggestion { /** - * The name of a queue to delete items from. + * This field contains the suggestion match information returned by the backend after escaping the HTML in the suggestion string. The areas that we might like to extract from the suggestion string returned by the backend are marked using the match_ranges field inside Snippet. For example, if the snippet string inside suggestion_match_info is: "google search", and the keyword "goog" is supposed to be bolded, the match_ranges is the list of range of indexes in the snippet string where it is bolded: [[0, 4)]. */ - queue?: string | null; + suggestionMatchInfo?: Schema$CloudsearchSnippet; } /** - * A reference to a top-level property within the object that should be displayed in search results. The values of the chosen properties is displayed in the search results along with the display label for that property if one is specified. If a display label is not specified, only the values is shown. + * Snippet of the suggestion, which summarizes the content of the resulting page. */ - export interface Schema$DisplayedProperty { + export interface Schema$CloudsearchSnippet { /** - * The name of the top-level property as defined in a property definition for the object. If the name is not a defined property in the schema, an error is given when attempting to update the schema. + * The matched ranges in the snippet. */ - propertyName?: string | null; - } - /** - * Used to provide a search operator for double properties. This is optional. Search operators let users restrict the query to specific fields relevant to the type of item being searched. - */ - export interface Schema$DoubleOperatorOptions { + matchRanges?: Schema$CloudsearchMatchRange[]; /** - * Indicates the operator name required in the query in order to use the double property in sorting or as a facet. The operator name can only contain lowercase letters (a-z). The maximum length is 32 characters. + * The snippet of the document. */ - operatorName?: string | null; + snippet?: string | null; } /** - * The options for double properties. + * Define a source to query suggest/search APIs. Source is set in the STMixer request params. */ - export interface Schema$DoublePropertyOptions { + export interface Schema$CloudsearchSource { /** - * If set, describes how the double should be used as a search operator. + * If set to true, all 3p sources will be considered */ - operatorOptions?: Schema$DoubleOperatorOptions; + anyThirdPartySource?: boolean | null; + /** + * Source name of contents that indexed by Index API + */ + name?: string | null; + /** + * Predefined source for Google Apps. + */ + predefinedSource?: string | null; } /** - * List of double values. + * Signals that contribute to the final score. */ - export interface Schema$DoubleValues { - values?: number[] | null; + export interface Schema$CloudsearchSuggestionScores { + completeServerInternalScores?: Schema$CloudsearchSuggestionScoresCompleteServerInternalScores; + completeserverInternalScores?: Schema$CloudsearchSuggestionScoresInternalScores; + /** + * How frequent is the suggestion within this user. + */ + personalizedBoost?: number | null; + /** + * How popular is the suggestion among all users. + */ + popularity?: number | null; + /** + * Amount by which a section is boosted based on heuristics. + */ + sectionBoost?: number | null; + /** + * Scale factor of the datasource its coming from. + */ + sourceScaleFactor?: number | null; + starlightInternalScores?: Schema$CloudsearchSuggestionScoresInternalScores; } - /** - * Drive follow-up search restricts (e.g. "followup:suggestions"). - */ - export interface Schema$DriveFollowUpRestrict { - type?: string | null; - } - /** - * Drive location search restricts (e.g. "is:starred"). - */ - export interface Schema$DriveLocationRestrict { - type?: string | null; - } - /** - * Drive mime-type search restricts (e.g. "type:pdf"). - */ - export interface Schema$DriveMimeTypeRestrict { - type?: string | null; - } - /** - * The time span search restrict (e.g. "after:2017-09-11 before:2017-09-12"). - */ - export interface Schema$DriveTimeSpanRestrict { - type?: string | null; - } - /** - * A person's email address. - */ - export interface Schema$EmailAddress { + export interface Schema$CloudsearchSuggestionScoresCompleteServerInternalScores { /** - * If the value of type is custom, this property contains the custom type string. + * Contacts group score (i.e. if the string is a name of a group). */ - customType?: string | null; + contactsGroup?: number | null; /** - * The email address. + * Score for email autocomplete. Corresponds to DAS affinity PERSONAL_SUGGEST_EMAIL_AUTOCOMPLETE_SCORE. */ - emailAddress?: string | null; + emailAutocompleteScore?: number | null; /** - * The URL to send email. + * Outbound email count as read from FBS. */ - emailUrl?: string | null; + focusOutboundEmailCount?: number | null; /** - * Indicates if this is the user's primary email. Only one entry can be marked as primary. + * Frequency based score of a query from the user's gmail search history */ - primary?: boolean | null; + gmailHistory?: number | null; + gmailHistoryMediumTermQueryTime?: number | null; /** - * The type of the email account. Acceptable values are: "custom", "home", "other", "work". + * Both the gmail query_time scores below are based on the time of the last query event. Basically the score is (query_time - (model_time - PERIOD)) / PERIOD Where PERIOD is 1 & 14 days for short and medium term. */ - type?: string | null; - } - export interface Schema$EnterpriseTopazFrontendTeamsLink { + gmailHistoryShortTermQueryTime?: number | null; /** - * The identifying link type + * Gmail label score, as received from Gmail through PbUI. */ - type?: string | null; - url?: Schema$SafeUrlProto; - } - export interface Schema$EnterpriseTopazFrontendTeamsPersonCorePhoneNumber { + gmailLabel?: number | null; /** - * Phone number in no particular format (as comes from the Focus profile). + * Score for gmail operators. */ - phoneNumber?: string | null; + gmailOperator?: number | null; /** - * Phone number URL + * Score for text entities extracted from gmail subjects. */ - phoneUrl?: Schema$SafeUrlProto; - type?: string | null; + gmailText?: number | null; + /** + * The score of the match. The score is in the range [0, num_matching_tokens]. This means that a query with many tokens can have matches with higher score. + */ + matchScore?: number | null; + /** + * Final score from CompleteServer. This either corresponds to Starlight score or Muppet score (for Generic Suggest suggestions) based on the CompleteServer backend. This is a combination of query dependent and independent components. The scores related to suggestion types like email_autocomplete_score & gmail_text are query independent whereas the match_score is query dependent. + */ + score?: number | null; } /** - * An AgendaEntry, e.g., a Calendar Event. + * Internal scores from CompleteServer/Starlight. NOTE: This proto message is also being used for storing scores from calling Starlight directly instead from CompleteServer. */ - export interface Schema$EnterpriseTopazSidekickAgendaEntry { + export interface Schema$CloudsearchSuggestionScoresInternalScores { /** - * URL of the agenda item. + * Contacts group score (i.e. if the string is a name of a group). */ - agendaItemUrl?: string | null; + contactsGroup?: number | null; /** - * The chronology from the present. + * Score for email autocomplete. Corresponds to DAS affinity PERSONAL_SUGGEST_EMAIL_AUTOCOMPLETE_SCORE. */ - chronology?: string | null; + emailAutocompleteScore?: number | null; /** - * Person who created the event. + * Outbound email count as read from FBS. */ - creator?: Schema$EnterpriseTopazSidekickPerson; + focusOutboundEmailCount?: number | null; /** - * Attendance status for the current user making the request. This is a convenience data member in order to avoid figuring out the same by iterating the invitee list above on the caller side. + * Frequency based score of a query from the user's gmail search history */ - currentUserAttendingStatus?: string | null; + gmailHistory?: number | null; + gmailHistoryMediumTermQueryTime?: number | null; /** - * Description of the agenda item (i.e., typically, summary in calendar event). + * Both the gmail query_time scores below are based on the time of the last query event. Basically the score is (query_time - (model_time - PERIOD)) / PERIOD Where PERIOD is 1 & 14 days for short and medium term. */ - description?: string | null; + gmailHistoryShortTermQueryTime?: number | null; /** - * Items related to the current AgendaEntry. E.g., related drive/mail/groups documents. + * Gmail label score, as received from Gmail through PbUI. */ - document?: Schema$EnterpriseTopazSidekickCommonDocument[]; + gmailLabel?: number | null; /** - * End date "Friday, August 26" in the user's timezone. + * Score for gmail operators. */ - endDate?: string | null; + gmailOperator?: number | null; /** - * End time (HH:mm) in the user's timezone. + * Score for text entities extracted from gmail subjects. */ - endTime?: string | null; + gmailText?: number | null; /** - * End time in milliseconds + * The score of the match. The score is in the range [0, num_matching_tokens]. This means that a query with many tokens can have matches with higher score. */ - endTimeMs?: string | null; + matchScore?: number | null; /** - * Event id provided by Calendar API. + * Final score from CompleteServe / Starlight. This either corresponds to Starlight score or Muppet score (for Generic Suggest suggestions) based on the CompleteServer backend. This is a combination of query dependent and independent components. The scores related to suggestion types like email_autocomplete_score & gmail_text are query independent whereas the match_score is query dependent. */ - eventId?: string | null; + score?: number | null; + } + export interface Schema$CloudsearchSuggestResponseDebugInfo { + completeServerInfo?: Schema$CloudsearchSuggestResponseDebugInfoCompleteServerInfo; + starlightInfo?: Schema$CloudsearchSuggestResponseDebugInfoStarlightInfo; + } + export interface Schema$CloudsearchSuggestResponseDebugInfoCompleteServerInfo { + completeserverHostname?: string | null; + psuggestDoNotCache?: boolean | null; + request?: Schema$SuggestSuggestRequest; + results?: Schema$CloudsearchSuggestResponseDebugInfoCompleteServerInfoSuggestResult[]; + starlightHostname?: string | null; + } + export interface Schema$CloudsearchSuggestResponseDebugInfoCompleteServerInfoSuggestResult { + suggestedQuery?: string | null; + suggestionType?: string | null; + } + export interface Schema$CloudsearchSuggestResponseDebugInfoStarlightInfo { /** - * Whether the guests can invite other guests. + * Position-weighted measurement of the difference between the two result sets. See go/search-experiments-glossary - CR Score. */ - guestsCanInviteOthers?: boolean | null; + compareRankingsScore?: number | null; + starlightHostname?: string | null; /** - * Whether the guests can modify the event. + * List of suggestion results returned from Starlight for dark launch. */ - guestsCanModify?: boolean | null; + suggestResults?: Schema$CloudsearchSuggestResult[]; + } + /** + * One suggestion result. next_id: 16 + */ + export interface Schema$CloudsearchSuggestResult { + encryptedResultDebugId?: string | null; + extension?: Schema$MessageSet; + filterSuggestion?: Schema$CloudsearchFilterSuggestion; /** - * Whether the guests of the event can be seen. If false, the user is going to be reported as the only attendee to the meeting, even though there may be more attendees. + * Indicates the matches between the suggestion and the user's query. For example, if the user types "isac xx" and the returned suggestion is "Isaac Elias" then the match is on the token "isaac" after spell correction. Note that "isac" in user's query matched with "isaac" in the suggestion because of spell correction. Also note that spell correction may or may not happen. In this example, matched_text_in_query_info.size() is 1, matched_text_in_query_info(0).snippet() is "isaac", matched_text_in_query_info(0).match_ranges().start() is 0 and matched_text_in_query_info(0).match_ranges().end() is 5. */ - guestsCanSeeGuests?: boolean | null; + matchedTextInQueryInfo?: Schema$CloudsearchSnippet[]; /** - * Hangout meeting identifier. + * The name of the suggestion. This is unique identifier of the suggestion. */ - hangoutId?: string | null; + name?: string | null; + peopleSuggestion?: Schema$CloudsearchPeopleSuggestion; + querySuggestion?: Schema$CloudsearchQuerySuggestion; /** - * Absolute URL for the Hangout meeting. + * Final score returned by superroot for this suggestion. */ - hangoutUrl?: string | null; + score?: number | null; + source?: Schema$CloudsearchSource; + subScores?: Schema$CloudsearchSuggestionScores; + subType?: string | null; /** - * People attending the meeting. + * The suggested query that will be used for search, when the user clicks on the suggestion */ - invitee?: Schema$EnterpriseTopazSidekickPerson[]; + suggestedQuery?: string | null; + suggestionOrigin?: string | null; + type?: string | null; + } + /** + * Definition of a single value with generic type. LINT.IfChange + */ + export interface Schema$CloudsearchValue { + booleanValue?: boolean | null; + dateValue?: Schema$Date; + doubleValue?: number | null; + integerValue?: string | null; + stringValue?: string | null; + timestampValue?: string | null; + } + export interface Schema$CompositeFilter { /** - * Whether the entry lasts all day. + * The logic operator of the sub filter. */ - isAllDay?: boolean | null; + logicOperator?: string | null; /** - * Last time the event was modified. + * Sub filters. */ - lastModificationTimeMs?: string | null; + subFilters?: Schema$Filter[]; + } + export interface Schema$Content { /** - * Agenda item location. + * [Optional] Actions for this card. */ - location?: string | null; + actions?: Schema$Action[]; /** - * Whether this should be notified to the user. + * [Optional] Description of the card. */ - notifyToUser?: boolean | null; + description?: Schema$SafeHtmlProto; /** - * Whether guest list is not returned because number of attendees is too large. + * [Optional] Subtitle of the card. */ - otherAttendeesExcluded?: boolean | null; + subtitle?: Schema$BackgroundColoredText; /** - * Whether the requester is the owner of the agenda entry. + * [Optional] Title of the card. */ - requesterIsOwner?: boolean | null; + title?: Schema$BackgroundColoredText; + } + export interface Schema$Context { /** - * Whether the details of this entry should be displayed to the user. + * [Optional] App where the card should be shown. If missing, the card will be shown in TOPAZ. */ - showFullEventDetailsToUse?: boolean | null; + app?: string[] | null; /** - * Start date "Friday, August 26" in the user's timezone. + * [Optional] Day of week when the card should be shown, where 0 is Monday. */ - startDate?: string | null; + dayOfWeek?: number[] | null; /** - * Start time (HH:mm) in the user's timezone. + * [Optional] Date (in seconds since epoch) when the card should stop being shown. If missing, end_date_sec will be set to Jan 1st, 2100. */ - startTime?: string | null; + endDateSec?: string | null; /** - * Start time in milliseconds. + * [Optional] End time in seconds, within a day, when the card should stop being shown if it's within [start_date_sec, end_date_sec]. If missing, this is set to 86400 (24 hours x 3600 sec/hour), i.e., midnight next day. */ - startTimeMs?: string | null; + endDayOffsetSec?: string | null; /** - * User's calendar timezone; + * [Optional] The locales for which the card should be triggered (e.g., en_US and en_CA). If missing, the card is going to show to clients regardless of their locale. */ - timeZone?: string | null; + locale?: string[] | null; /** - * Title of the agenda item. + * [Optional] Text-free locations where the card should be shown. This is expected to match the user's location in focus. If no location is specified, the card will be shown for any location. */ - title?: string | null; - } - export interface Schema$EnterpriseTopazSidekickAgendaGroupCardProto { - agendaItem?: Schema$EnterpriseTopazSidekickAgendaItem[]; - context?: Schema$EnterpriseTopazSidekickAgendaGroupCardProtoContext; - currentAgendaItem?: Schema$EnterpriseTopazSidekickAgendaItem; - } - /** - * The context that resulted in the generation of the card. - */ - export interface Schema$EnterpriseTopazSidekickAgendaGroupCardProtoContext { + location?: string[] | null; /** - * User friendly free text that describes the context of the card (e.g. "Next meeting with Bob"). This is largely only applicable when the card is generated from a query. + * [Required only for Answer and RHS cards - will be ignored for Homepage] cards. It's the exact case-insensitive queries that will trigger the Answer or RHS card. */ - context?: string | null; + query?: string[] | null; /** - * Localized free text that describes the dates represented by the card. Currently, the card will only represent a single day. + * [Optional] Date (in seconds since epoch) when the card should start being shown. If missing, start_date_sec will be Jan 1st, 1970 UTC. */ - date?: string | null; + startDateSec?: string | null; /** - * Represents restrictions applied to the events requested in the user's query. + * [Optional] Start time in seconds, within a day, when the card should be shown if it's within [start_date_sec, end_date_sec]. If 0, the card will be shown from 12:00am on. */ - eventsRestrict?: string | null; - } - export interface Schema$EnterpriseTopazSidekickAgendaItem { - conflictedGroup?: Schema$EnterpriseTopazSidekickConflictingEventsCardProto; - gapBefore?: Schema$EnterpriseTopazSidekickGap; - meeting?: Schema$EnterpriseTopazSidekickAgendaEntry; + startDayOffsetSec?: string | null; + /** + * [Optional] Surface where the card should be shown in. If missing, the card will be shown in any surface. + */ + surface?: string[] | null; + /** + * [Required] Type of the card (homepage, Answer or RHS). + */ + type?: string[] | null; } /** - * A list of answers represented as free text. + * A named attribute associated with an item which can be used for influencing the ranking of the item based on the context in the request. */ - export interface Schema$EnterpriseTopazSidekickAnswerAnswerList { + export interface Schema$ContextAttribute { /** - * Answers that have a corresponding label. + * The name of the attribute. It should not be empty. The maximum length is 32 characters. The name must start with a letter and can only contain letters (A-Z, a-z) or numbers (0-9). The name will be normalized (lower-cased) before being matched. */ - labeledAnswer?: Schema$EnterpriseTopazSidekickAnswerAnswerListLabeledAnswer[]; + name?: string | null; /** - * Answer type. + * Text values of the attribute. The maximum number of elements is 10. The maximum length of an element in the array is 32 characters. The value will be normalized (lower-cased) before being matched. */ - type?: string | null; + values?: string[] | null; } /** - * An answer with a corresponding label. + * Aggregation of items by status code as of the specified date. */ - export interface Schema$EnterpriseTopazSidekickAnswerAnswerListLabeledAnswer { + export interface Schema$CustomerIndexStats { /** - * The free text answer. + * The date for which statistics were calculated. */ - answer?: string | null; + date?: Schema$Date; /** - * A localized label for the answer (e.g. "Cell phone" vs "Desk phone"). + * Number of items aggregrated by status code. */ - label?: string | null; + itemCountByStatus?: Schema$ItemCountByStatus[]; } - /** - * Contains a list of suggested queries. Allows the user to determine what natural language queries they can ask Cloud Search (e.g. "what can I search for?"). - */ - export interface Schema$EnterpriseTopazSidekickAnswerSuggestedQueryAnswerCard { + export interface Schema$CustomerQueryStats { /** - * A list of queries to suggest. + * The date for which query stats were calculated. Stats calculated on the next day close to midnight are returned. */ - suggestedQueryCategory?: Schema$EnterpriseTopazSidekickAnswerSuggestedQueryCategory[]; + date?: Schema$Date; + queryCountByStatus?: Schema$QueryCountByStatus[]; } /** - * Contains a list of suggested queries for a single category. + * Search application stats for a customer for the given date. */ - export interface Schema$EnterpriseTopazSidekickAnswerSuggestedQueryCategory { + export interface Schema$CustomerSearchApplicationStats { /** - * The query list category. + * The count of search applications for the date. */ - category?: string | null; + count?: string | null; /** - * Whether this category is enabled. + * The date for which search application stats were calculated. */ - isEnabled?: boolean | null; + date?: Schema$Date; + } + export interface Schema$CustomerSessionStats { /** - * List of suggested queries to show the user. + * The date for which session stats were calculated. Stats are calculated on the following day, close to midnight PST, and then returned. */ - query?: string[] | null; + date?: Schema$Date; + /** + * The count of search sessions on the day + */ + searchSessionsCount?: string | null; } /** - * Wrapper proto for the Assist cards. + * Represents settings at a customer level. + */ + export interface Schema$CustomerSettings { + /** + * Audit Logging settings for the customer. If update_mask is empty then this field will be updated based on UpdateCustomerSettings request. + */ + auditLoggingSettings?: Schema$AuditLoggingSettings; + /** + * VPC SC settings for the customer. If update_mask is empty then this field will be updated based on UpdateCustomerSettings request. + */ + vpcSettings?: Schema$VPCSettings; + } + export interface Schema$CustomerUserStats { + /** + * The date for which session stats were calculated. Stats calculated on the next day close to midnight are returned. + */ + date?: Schema$Date; + /** + * The count of unique active users in the past one day + */ + oneDayActiveUsersCount?: string | null; + /** + * The count of unique active users in the past seven days + */ + sevenDaysActiveUsersCount?: string | null; + /** + * The count of unique active users in the past thirty days + */ + thirtyDaysActiveUsersCount?: string | null; + } + /** + * Datasource is a logical namespace for items to be indexed. All items must belong to a datasource. This is the prerequisite before items can be indexed into Cloud Search. + */ + export interface Schema$DataSource { + /** + * If true, sets the datasource to read-only mode. In read-only mode, the Indexing API rejects any requests to index or delete items in this source. Enabling read-only mode does not stop the processing of previously accepted data. + */ + disableModifications?: boolean | null; + /** + * Disable serving any search or assist results. + */ + disableServing?: boolean | null; + /** + * Required. Display name of the datasource The maximum length is 300 characters. + */ + displayName?: string | null; + /** + * List of service accounts that have indexing access. + */ + indexingServiceAccounts?: string[] | null; + /** + * This field restricts visibility to items at the datasource level. Items within the datasource are restricted to the union of users and groups included in this field. Note that, this does not ensure access to a specific item, as users need to have ACL permissions on the contained items. This ensures a high level access on the entire datasource, and that the individual items are not shared outside this visibility. + */ + itemsVisibility?: Schema$GSuitePrincipal[]; + /** + * The name of the datasource resource. Format: datasources/{source_id\}. The name is ignored when creating a datasource. + */ + name?: string | null; + /** + * IDs of the Long Running Operations (LROs) currently running for this schema. + */ + operationIds?: string[] | null; + /** + * Can a user request to get thumbnail URI for Items indexed in this data source. + */ + returnThumbnailUrls?: boolean | null; + /** + * A short name or alias for the source. This value will be used to match the 'source' operator. For example, if the short name is ** then queries like *source:* will only return results for this source. The value must be unique across all datasources. The value must only contain alphanumeric characters (a-zA-Z0-9). The value cannot start with 'google' and cannot be one of the following: mail, gmail, docs, drive, groups, sites, calendar, hangouts, gplus, keep, people, teams. Its maximum length is 32 characters. + */ + shortName?: string | null; + } + /** + * Aggregation of items by status code as of the specified date. + */ + export interface Schema$DataSourceIndexStats { + /** + * The date for which index stats were calculated. If the date of request is not the current date then stats calculated on the next day are returned. Stats are calculated close to mid night in this case. If date of request is current date, then real time stats are returned. + */ + date?: Schema$Date; + /** + * Number of items aggregrated by status code. + */ + itemCountByStatus?: Schema$ItemCountByStatus[]; + } + /** + * Restriction on Datasource. + */ + export interface Schema$DataSourceRestriction { + /** + * Filter options restricting the results. If multiple filters are present, they are grouped by object type before joining. Filters with the same object type are joined conjunctively, then the resulting expressions are joined disjunctively. The maximum number of elements is 20. NOTE: Suggest API supports only few filters at the moment: "objecttype", "type" and "mimetype". For now, schema specific filters cannot be used to filter suggestions. + */ + filterOptions?: Schema$FilterOptions[]; + /** + * The source of restriction. + */ + source?: Schema$Source; + } + /** + * Represents a whole calendar date, for example a date of birth. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the [Proleptic Gregorian Calendar](https://en.wikipedia.org/wiki/Proleptic_Gregorian_calendar). The date must be a valid calendar date between the year 1 and 9999. + */ + export interface Schema$Date { + /** + * Day of month. Must be from 1 to 31 and valid for the year and month. + */ + day?: number | null; + /** + * Month of date. Must be from 1 to 12. + */ + month?: number | null; + /** + * Year of date. Must be from 1 to 9999. + */ + year?: number | null; + } + /** + * Optional. Provides a search operator for date properties. Search operators let users restrict the query to specific fields relevant to the type of item being searched. + */ + export interface Schema$DateOperatorOptions { + /** + * Indicates the operator name required in the query in order to isolate the date property using the greater-than operator. For example, if greaterThanOperatorName is *closedafter* and the property's name is *closeDate*, then queries like *closedafter:* show results only where the value of the property named *closeDate* is later than **. The operator name can only contain lowercase letters (a-z). The maximum length is 32 characters. + */ + greaterThanOperatorName?: string | null; + /** + * Indicates the operator name required in the query in order to isolate the date property using the less-than operator. For example, if lessThanOperatorName is *closedbefore* and the property's name is *closeDate*, then queries like *closedbefore:* show results only where the value of the property named *closeDate* is earlier than **. The operator name can only contain lowercase letters (a-z). The maximum length is 32 characters. + */ + lessThanOperatorName?: string | null; + /** + * Indicates the actual string required in the query in order to isolate the date property. For example, suppose an issue tracking schema object has a property named *closeDate* that specifies an operator with an operatorName of *closedon*. For searches on that data, queries like *closedon:* show results only where the value of the *closeDate* property matches **. By contrast, a search that uses the same ** without an operator returns all items where ** matches the value of any String properties or text within the content field for the indexed datasource. The operator name can only contain lowercase letters (a-z). The maximum length is 32 characters. + */ + operatorName?: string | null; + } + /** + * The options for date properties. + */ + export interface Schema$DatePropertyOptions { + /** + * If set, describes how the date should be used as a search operator. + */ + operatorOptions?: Schema$DateOperatorOptions; + } + /** + * List of date values. + */ + export interface Schema$DateValues { + values?: Schema$Date[]; + } + /** + * Shared request debug options for all cloudsearch RPC methods. + */ + export interface Schema$DebugOptions { + /** + * If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field. + */ + enableDebugging?: boolean | null; + } + /** + * Debug Search Response. + */ + export interface Schema$DebugResponse { + /** + * Serialized string of GenericSearchRequest. + */ + gsrRequest?: string | null; + /** + * Serialized string of GenericSearchResponse. + */ + gsrResponse?: string | null; + /** + * Search response. + */ + searchResponse?: Schema$SearchResponse; + } + /** + * Next ID: 3 + */ + export interface Schema$DefaultBlockingDataProto { + types?: string[] | null; + /** + * Version ID of the current list of blocked countries and sanctions areas, based on which the types field was computed. + */ + version?: number | null; + } + export interface Schema$DeleteQueueItemsRequest { + /** + * The name of connector making this call. Format: datasources/{source_id\}/connectors/{ID\} + */ + connectorName?: string | null; + /** + * Common debug options. + */ + debugOptions?: Schema$DebugOptions; + /** + * The name of a queue to delete items from. + */ + queue?: string | null; + } + export interface Schema$DisabledIcingPackageCorpus { + /** + * The name of an individual corpus within the given app. When unset, this means that all corpora for the given package are disabled. + */ + corpusName?: string | null; + /** + * The package name of an app that the user disabled. This is required. + */ + packageName?: string | null; + } + /** + * A reference to a top-level property within the object that should be displayed in search results. The values of the chosen properties is displayed in the search results along with the display label for that property if one is specified. If a display label is not specified, only the values is shown. + */ + export interface Schema$DisplayedProperty { + /** + * The name of the top-level property as defined in a property definition for the object. If the name is not a defined property in the schema, an error is given when attempting to update the schema. + */ + propertyName?: string | null; + } + /** + * Used to provide a search operator for double properties. This is optional. Search operators let users restrict the query to specific fields relevant to the type of item being searched. + */ + export interface Schema$DoubleOperatorOptions { + /** + * Indicates the operator name required in the query in order to use the double property in sorting or as a facet. The operator name can only contain lowercase letters (a-z). The maximum length is 32 characters. + */ + operatorName?: string | null; + } + /** + * The options for double properties. + */ + export interface Schema$DoublePropertyOptions { + /** + * If set, describes how the double should be used as a search operator. + */ + operatorOptions?: Schema$DoubleOperatorOptions; + } + /** + * List of double values. + */ + export interface Schema$DoubleValues { + values?: number[] | null; + } + /** + * Drive follow-up search restricts (e.g. "followup:suggestions"). + */ + export interface Schema$DriveFollowUpRestrict { + type?: string | null; + } + /** + * Drive location search restricts (e.g. "is:starred"). + */ + export interface Schema$DriveLocationRestrict { + type?: string | null; + } + /** + * Drive mime-type search restricts (e.g. "type:pdf"). + */ + export interface Schema$DriveMimeTypeRestrict { + type?: string | null; + } + /** + * The time span search restrict (e.g. "after:2017-09-11 before:2017-09-12"). + */ + export interface Schema$DriveTimeSpanRestrict { + type?: string | null; + } + /** + * A person's email address. + */ + export interface Schema$EmailAddress { + /** + * If the value of type is custom, this property contains the custom type string. + */ + customType?: string | null; + /** + * The email address. + */ + emailAddress?: string | null; + /** + * The URL to send email. + */ + emailUrl?: string | null; + /** + * Indicates if this is the user's primary email. Only one entry can be marked as primary. + */ + primary?: boolean | null; + /** + * The type of the email account. Acceptable values are: "custom", "home", "other", "work". + */ + type?: string | null; + } + export interface Schema$EnterpriseTopazFrontendTeamsLink { + /** + * The identifying link type + */ + type?: string | null; + url?: Schema$SafeUrlProto; + } + export interface Schema$EnterpriseTopazFrontendTeamsPersonCorePhoneNumber { + /** + * Phone number in no particular format (as comes from the Focus profile). + */ + phoneNumber?: string | null; + /** + * Phone number URL + */ + phoneUrl?: Schema$SafeUrlProto; + type?: string | null; + } + /** + * An AgendaEntry, e.g., a Calendar Event. + */ + export interface Schema$EnterpriseTopazSidekickAgendaEntry { + /** + * URL of the agenda item. + */ + agendaItemUrl?: string | null; + /** + * The chronology from the present. + */ + chronology?: string | null; + /** + * Person who created the event. + */ + creator?: Schema$EnterpriseTopazSidekickPerson; + /** + * Attendance status for the current user making the request. This is a convenience data member in order to avoid figuring out the same by iterating the invitee list above on the caller side. + */ + currentUserAttendingStatus?: string | null; + /** + * Description of the agenda item (i.e., typically, summary in calendar event). + */ + description?: string | null; + /** + * Items related to the current AgendaEntry. E.g., related drive/mail/groups documents. + */ + document?: Schema$EnterpriseTopazSidekickCommonDocument[]; + /** + * End date "Friday, August 26" in the user's timezone. + */ + endDate?: string | null; + /** + * End time (HH:mm) in the user's timezone. + */ + endTime?: string | null; + /** + * End time in milliseconds + */ + endTimeMs?: string | null; + /** + * Event id provided by Calendar API. + */ + eventId?: string | null; + /** + * Whether the guests can invite other guests. + */ + guestsCanInviteOthers?: boolean | null; + /** + * Whether the guests can modify the event. + */ + guestsCanModify?: boolean | null; + /** + * Whether the guests of the event can be seen. If false, the user is going to be reported as the only attendee to the meeting, even though there may be more attendees. + */ + guestsCanSeeGuests?: boolean | null; + /** + * Hangout meeting identifier. + */ + hangoutId?: string | null; + /** + * Absolute URL for the Hangout meeting. + */ + hangoutUrl?: string | null; + /** + * People attending the meeting. + */ + invitee?: Schema$EnterpriseTopazSidekickPerson[]; + /** + * Whether the entry lasts all day. + */ + isAllDay?: boolean | null; + /** + * Last time the event was modified. + */ + lastModificationTimeMs?: string | null; + /** + * Agenda item location. + */ + location?: string | null; + /** + * Whether this should be notified to the user. + */ + notifyToUser?: boolean | null; + /** + * Whether guest list is not returned because number of attendees is too large. + */ + otherAttendeesExcluded?: boolean | null; + /** + * Whether the requester is the owner of the agenda entry. + */ + requesterIsOwner?: boolean | null; + /** + * Whether the details of this entry should be displayed to the user. + */ + showFullEventDetailsToUse?: boolean | null; + /** + * Start date "Friday, August 26" in the user's timezone. + */ + startDate?: string | null; + /** + * Start time (HH:mm) in the user's timezone. + */ + startTime?: string | null; + /** + * Start time in milliseconds. + */ + startTimeMs?: string | null; + /** + * User's calendar timezone; + */ + timeZone?: string | null; + /** + * Title of the agenda item. + */ + title?: string | null; + } + export interface Schema$EnterpriseTopazSidekickAgendaGroupCardProto { + agendaItem?: Schema$EnterpriseTopazSidekickAgendaItem[]; + context?: Schema$EnterpriseTopazSidekickAgendaGroupCardProtoContext; + currentAgendaItem?: Schema$EnterpriseTopazSidekickAgendaItem; + } + /** + * The context that resulted in the generation of the card. + */ + export interface Schema$EnterpriseTopazSidekickAgendaGroupCardProtoContext { + /** + * User friendly free text that describes the context of the card (e.g. "Next meeting with Bob"). This is largely only applicable when the card is generated from a query. + */ + context?: string | null; + /** + * Localized free text that describes the dates represented by the card. Currently, the card will only represent a single day. + */ + date?: string | null; + /** + * Represents restrictions applied to the events requested in the user's query. + */ + eventsRestrict?: string | null; + } + export interface Schema$EnterpriseTopazSidekickAgendaItem { + conflictedGroup?: Schema$EnterpriseTopazSidekickConflictingEventsCardProto; + gapBefore?: Schema$EnterpriseTopazSidekickGap; + meeting?: Schema$EnterpriseTopazSidekickAgendaEntry; + } + /** + * A list of answers represented as free text. + */ + export interface Schema$EnterpriseTopazSidekickAnswerAnswerList { + /** + * Answers that have a corresponding label. + */ + labeledAnswer?: Schema$EnterpriseTopazSidekickAnswerAnswerListLabeledAnswer[]; + /** + * Answer type. + */ + type?: string | null; + } + /** + * An answer with a corresponding label. + */ + export interface Schema$EnterpriseTopazSidekickAnswerAnswerListLabeledAnswer { + /** + * The free text answer. + */ + answer?: string | null; + /** + * A localized label for the answer (e.g. "Cell phone" vs "Desk phone"). + */ + label?: string | null; + } + /** + * Contains a list of suggested queries. Allows the user to determine what natural language queries they can ask Cloud Search (e.g. "what can I search for?"). + */ + export interface Schema$EnterpriseTopazSidekickAnswerSuggestedQueryAnswerCard { + /** + * A list of queries to suggest. + */ + suggestedQueryCategory?: Schema$EnterpriseTopazSidekickAnswerSuggestedQueryCategory[]; + } + /** + * Contains a list of suggested queries for a single category. + */ + export interface Schema$EnterpriseTopazSidekickAnswerSuggestedQueryCategory { + /** + * The query list category. + */ + category?: string | null; + /** + * Whether this category is enabled. + */ + isEnabled?: boolean | null; + /** + * List of suggested queries to show the user. + */ + query?: string[] | null; + } + /** + * Wrapper proto for the Assist cards. */ export interface Schema$EnterpriseTopazSidekickAssistCardProto { /** - * Agenda group card. + * Agenda group card. + */ + agendaGroupCardProto?: Schema$EnterpriseTopazSidekickAgendaGroupCardProto; + /** + * Card metadata such as chronology and render mode of the card. + */ + cardMetadata?: Schema$EnterpriseTopazSidekickCardMetadata; + /** + * Card type. + */ + cardType?: string | null; + /** + * Conflicting events card. + */ + conflictingMeetingsCard?: Schema$EnterpriseTopazSidekickConflictingEventsCardProto; + /** + * Answer card for documents that are applicable to the current query. + */ + documentListCard?: Schema$EnterpriseTopazSidekickDocumentPerCategoryList; + /** + * Documents with mentions. + */ + documentsWithMentions?: Schema$EnterpriseTopazSidekickDocumentPerCategoryList; + /** + * Find meeting time card. + */ + findMeetingTimeCard?: Schema$EnterpriseTopazSidekickFindMeetingTimeCardProto; + /** + * Generic answer card. + */ + genericAnswerCard?: Schema$EnterpriseTopazSidekickGenericAnswerCard; + /** + * Get and keep ahead card. + */ + getAndKeepAheadCard?: Schema$EnterpriseTopazSidekickGetAndKeepAheadCardProto; + /** + * Meeting card. + */ + meeting?: Schema$EnterpriseTopazSidekickAgendaEntry; + /** + * Meeting notes card. + */ + meetingNotesCard?: Schema$EnterpriseTopazSidekickMeetingNotesCardProto; + /** + * Request for meeting notes card. + */ + meetingNotesCardRequest?: Schema$EnterpriseTopazSidekickMeetingNotesCardRequest; + /** + * The people disambiguation card. + */ + peopleDisambiguationCard?: Schema$EnterpriseTopazSidekickPeopleDisambiguationCard; + /** + * People Search promotion card. + */ + peoplePromotionCard?: Schema$PeoplePromotionCard; + /** + * Card with recommended documents for the user. + */ + personalizedDocsCard?: Schema$EnterpriseTopazSidekickPersonalizedDocsCardProto; + /** + * Answer card that represents a single person. + */ + personAnswerCard?: Schema$EnterpriseTopazSidekickPeopleAnswerPersonAnswerCard; + /** + * Full profile card. + */ + personProfileCard?: Schema$EnterpriseTopazSidekickPersonProfileCard; + /** + * Answer card that represents a list of people related to a person. + */ + relatedPeopleAnswerCard?: Schema$EnterpriseTopazSidekickPeopleAnswerRelatedPeopleAnswerCard; + /** + * Shared documents. + */ + sharedDocuments?: Schema$EnterpriseTopazSidekickDocumentPerCategoryList; + /** + * Sahre meeting docs card. + */ + shareMeetingDocsCard?: Schema$EnterpriseTopazSidekickShareMeetingDocsCardProto; + /** + * Answer card for what natural language queries the user can ask. + */ + suggestedQueryAnswerCard?: Schema$EnterpriseTopazSidekickAnswerSuggestedQueryAnswerCard; + /** + * Third party answer cards. + */ + thirdPartyAnswerCard?: Schema$ThirdPartyGenericCard; + /** + * Work In Progress card. + */ + workInProgressCardProto?: Schema$EnterpriseTopazSidekickRecentDocumentsCardProto; + } + /** + * Card metadata. + */ + export interface Schema$EnterpriseTopazSidekickCardMetadata { + /** + * Declares a preference for how this card should be packed in MSCR. All cards in a response must correspond to a single category. As a result, cards may be dropped from the response if this field is set. Any card that does not match the category of the card with the highest priority in the response will be dropped. + */ + cardCategory?: string | null; + /** + * An ID to identify the card and match actions to it. Be thoughtful of new card IDs since actions will be associated to that ID. E.g., if two card IDs collide, the system will think that the actions have been applied to the same card. Similarly, if EAS can return multiple cards of the same type (e.g., Meetings), ensure that the card_id identifies a given instance of the card so that, e.g., dismissals only affect the dismissed card as opposed to affecting all meeting cards. + */ + cardId?: string | null; + /** + * Chronology. + */ + chronology?: string | null; + /** + * Debug info (only reported if request's debug_level \> 0). + */ + debugInfo?: string | null; + /** + * Information about the NLP done to get the card. + */ + nlpMetadata?: Schema$EnterpriseTopazSidekickNlpMetadata; + /** + * Ranking params. + */ + rankingParams?: Schema$EnterpriseTopazSidekickRankingParams; + /** + * Render mode. + */ + renderMode?: string | null; + } + /** + * Container of debugging information in all object levels. Extend as needed. + */ + export interface Schema$EnterpriseTopazSidekickCommonDebugInfo { + /** + * Debug message. + */ + message?: string | null; + } + /** + * Representation of a document. NEXT_TAG: 15 + */ + export interface Schema$EnterpriseTopazSidekickCommonDocument { + /** + * Access type, i.e., whether the user has access to the document or not. + */ + accessType?: string | null; + /** + * Information for debugging. + */ + debugInfo?: Schema$EnterpriseTopazSidekickCommonDebugInfo; + /** + * Document id. + */ + documentId?: string | null; + /** + * Drive document metadata. + */ + driveDocumentMetadata?: Schema$EnterpriseTopazSidekickCommonDocumentDriveDocumentMetadata; + /** + * Generic Drive-based url in the format of drive.google.com/open to be used for deeplink + */ + genericUrl?: string | null; + /** + * Justification on why the document is selected. + */ + justification?: Schema$EnterpriseTopazSidekickCommonDocumentJustification; + /** + * MIME type + */ + mimeType?: string | null; + /** + * Document provenance. + */ + provenance?: string | null; + /** + * Justification of why this document is being returned. + */ + reason?: string | null; + /** + * A sampling of the text from the document. + */ + snippet?: string | null; + /** + * Thumbnail URL. + */ + thumbnailUrl?: string | null; + /** + * Title of the document. + */ + title?: string | null; + /** + * Type of the document. + */ + type?: string | null; + /** + * Absolute URL of the document. + */ + url?: string | null; + } + /** + * Meta data for drive documents. + */ + export interface Schema$EnterpriseTopazSidekickCommonDocumentDriveDocumentMetadata { + /** + * The drive document cosmo id. Client could use the id to build a URL to open a document. Please use Document.document_id. + */ + documentId?: string | null; + /** + * Additional field to identify whether a document is private since scope set to LIMITED can mean both that the doc is private or that it's shared with others. is_private indicates whether the doc is not shared with anyone except for the owner. + */ + isPrivate?: boolean | null; + /** + * Timestamp of the most recent comment added to the document in milliseconds since epoch. + */ + lastCommentTimeMs?: string | null; + /** + * Timestamp of the most recent edit from the current user in milliseconds since epoch. + */ + lastEditTimeMs?: string | null; + /** + * Last modification time of the document (independent of the user that modified it). + */ + lastModificationTimeMillis?: string | null; + /** + * Timestamp of the last updated time of the document in milliseconds since epoch. + */ + lastUpdatedTimeMs?: string | null; + /** + * Timestamp of the most recent view from the current user in milliseconds since epoch. + */ + lastViewTimeMs?: string | null; + /** + * The owner of the document. + */ + owner?: Schema$EnterpriseTopazSidekickCommonPerson; + /** + * ACL scope of the document which identifies the sharing status of the doc (e.g., limited, shared with link, team drive, ...). + */ + scope?: string | null; + } + /** + * Justification of why we are reporting the document. + */ + export interface Schema$EnterpriseTopazSidekickCommonDocumentJustification { + /** + * A locale aware message that explains why this document was selected. + */ + justification?: string | null; + /** + * Reason on why the document is selected. Populate for trending documents. + */ + reason?: string | null; + } + /** + * Common representation of a person. + */ + export interface Schema$EnterpriseTopazSidekickCommonPerson { + /** + * The birthday. + */ + birthday?: Schema$EnterpriseTopazSidekickCommonPersonBirthday; + /** + * Cell phone number. + */ + cellPhone?: string | null; + /** + * The department the person works in (e.g. Engineering). + */ + department?: string | null; + /** + * Desk location (e.g. US-MTV-PR55-5-5B1I). + */ + deskLocation?: string | null; + /** + * Work desk phone number. + */ + deskPhone?: string | null; + /** + * The full name. + */ + displayName?: string | null; + /** + * Email. + */ + email?: string | null; + /** + * The last name. + */ + familyName?: string | null; + /** + * The fully formatted address (e.g. 1255 Pear Avenue, Mountain View 94043, United States). + */ + fullAddress?: string | null; + /** + * This field is deprecated. The obfuscated_id should be used instead. + */ + gaiaId?: string | null; + /** + * The first name. + */ + givenName?: string | null; + /** + * The person's job title (e.g. Software Engineer). + */ + jobTitle?: string | null; + /** + * The manager. + */ + manager?: Schema$EnterpriseTopazSidekickCommonPerson; + /** + * The obfuscated GAIA ID. + */ + obfuscatedId?: string | null; + /** + * The URL for the Focus profile picture. + */ + photoUrl?: string | null; + /** + * The street address (e.g. 1255 Pear Avenue). + */ + streetAddress?: string | null; + } + export interface Schema$EnterpriseTopazSidekickCommonPersonBirthday { + /** + * Unstructured birthday. + */ + value?: string | null; + } + /** + * Conflicting meetings card proto. + */ + export interface Schema$EnterpriseTopazSidekickConflictingEventsCardProto { + /** + * All the events that conflict with main_event. + */ + conflictingEvent?: Schema$EnterpriseTopazSidekickAgendaEntry[]; + /** + * The event identified as being the most important. + */ + mainEvent?: Schema$EnterpriseTopazSidekickAgendaEntry; + } + /** + * Represents a mapping between a document type and its corresponding documents. Use for Work in Progress card in v1 homepage. + */ + export interface Schema$EnterpriseTopazSidekickDocumentGroup { + /** + * Document group type + */ + groupType?: string | null; + /** + * The list of corresponding documents. + */ + personalizedDocument?: Schema$EnterpriseTopazSidekickCommonDocument[]; + } + export interface Schema$EnterpriseTopazSidekickDocumentPerCategoryList { + documents?: Schema$EnterpriseTopazSidekickDocumentPerCategoryListDocumentPerCategoryListEntry[]; + /** + * Localized message explaining how the documents were derived (e.g. from the last 30 days activity). This field is optional. + */ + helpMessage?: string | null; + listType?: string | null; + /** + * Description of the types of documents present in the list. + */ + listTypeDescription?: string | null; + /** + * Response message in case no documents are present in the card. + */ + responseMessage?: string | null; + } + export interface Schema$EnterpriseTopazSidekickDocumentPerCategoryListDocumentPerCategoryListEntry { + category?: string | null; + document?: Schema$EnterpriseTopazSidekickCommonDocument; + /** + * Reason this document was selected. + */ + rationale?: string | null; + } + /** + * Response to find meeting time among a set of people. + */ + export interface Schema$EnterpriseTopazSidekickFindMeetingTimeCardProto { + /** + * Slots when all attendees have availability. + */ + commonAvailableTimeSlots?: Schema$EnterpriseTopazSidekickTimeSlot[]; + /** + * Invitees to the event. + */ + invitees?: Schema$EnterpriseTopazSidekickPerson[]; + /** + * Requester. + */ + requester?: Schema$EnterpriseTopazSidekickPerson; + /** + * Details about the scheduled meeting, if one exists. + */ + scheduledMeeting?: Schema$EnterpriseTopazSidekickScheduledMeeting; + /** + * Invitees that have been skipped in the computation, most likely because they are groups. + */ + skippedInvitees?: Schema$EnterpriseTopazSidekickPerson[]; + /** + * Min and max timestamp used to find a common available timeslot. + */ + timeBoundaries?: Schema$EnterpriseTopazSidekickTimeSlot; + /** + * Timezone ID. + */ + timezoneId?: string | null; + } + export interface Schema$EnterpriseTopazSidekickGap { + /** + * Localized time string in the format: 1 hour 15 minutes + */ + displayRemainingTime?: string | null; + /** + * Localized time string in the format:(Locale CZ) 8:30 odp. + */ + endTime?: string | null; + endTimeMs?: string | null; + remainingTime?: string | null; + /** + * Localized time string in the format:(Locale CZ) 8:30 odp. + */ + startTime?: string | null; + startTimeMs?: string | null; + } + export interface Schema$EnterpriseTopazSidekickGenericAnswerCard { + /** + * The answer. + */ + answer?: string | null; + /** + * Title or header of the card. + */ + title?: string | null; + } + /** + * Get and keep ahead card + */ + export interface Schema$EnterpriseTopazSidekickGetAndKeepAheadCardProto { + declinedEvents?: Schema$EnterpriseTopazSidekickGetAndKeepAheadCardProtoDeclinedEvents; + mentionedDocuments?: Schema$EnterpriseTopazSidekickDocumentPerCategoryList; + sharedDocuments?: Schema$EnterpriseTopazSidekickDocumentPerCategoryList; + } + /** + * A list of events where all guests declined. + */ + export interface Schema$EnterpriseTopazSidekickGetAndKeepAheadCardProtoDeclinedEvents { + events?: Schema$EnterpriseTopazSidekickAgendaEntry[]; + } + /** + * Errors in the creation of meeting notes. + */ + export interface Schema$EnterpriseTopazSidekickMeetingNotesCardError { + /** + * The description of the reason why create-meeting-notes failed. + */ + description?: string | null; + /** + * The event to request meeting notes creation + */ + event?: Schema$EnterpriseTopazSidekickAgendaEntry; + /** + * The reason why create-meeting-notes failed. + */ + reason?: string | null; + } + /** + * Information about the meeting notes created. + */ + export interface Schema$EnterpriseTopazSidekickMeetingNotesCardProto { + /** + * The event to request meeting notes creation. + */ + event?: Schema$EnterpriseTopazSidekickAgendaEntry; + /** + * Google Drive ID (a.k.a. resource ID) of the file. + */ + fileId?: string | null; + /** + * Title we want to show for meeting notes in the answer card + */ + title?: string | null; + /** + * New URL. + */ + url?: string | null; + } + /** + * Meeting notes card request. + */ + export interface Schema$EnterpriseTopazSidekickMeetingNotesCardRequest { + /** + * Who are the meeting notes created for. + */ + canCreateFor?: string[] | null; + /** + * The error and reason if known error occured. + */ + error?: Schema$EnterpriseTopazSidekickMeetingNotesCardError; + /** + * The event to request meeting notes creation + */ + event?: Schema$EnterpriseTopazSidekickAgendaEntry; + } + /** + * Metadata about the NLP interpretation of the query. + */ + export interface Schema$EnterpriseTopazSidekickNlpMetadata { + /** + * Confidence of the interpretation that generated this card. + */ + confidence?: number | null; + } + /** + * Metadata for disambiguation. + */ + export interface Schema$EnterpriseTopazSidekickPeopleAnswerDisambiguationInfo { + /** + * A list of people that also matched the query. This list is not complete. + */ + disambiguation?: Schema$EnterpriseTopazSidekickPeopleAnswerDisambiguationInfoDisambiguationPerson[]; + /** + * The name that was extracted from the query. This may be in the form of the given name, last name, full name, LDAP, or email address. This name can be considered suitable for displaying to the user and can largely be considered to be normalized (e.g. "Bob's" -\> "Bob"). + */ + name?: string | null; + } + /** + * A person that also matches the query, but was not selected due to a lower affinity with the requesting user. + */ + export interface Schema$EnterpriseTopazSidekickPeopleAnswerDisambiguationInfoDisambiguationPerson { + /** + * The profile of this person. + */ + person?: Schema$EnterpriseTopazSidekickCommonPerson; + /** + * The query that can be used to produce an answer card with the same attribute, but for this person. + */ + query?: string | null; + } + /** + * Recommended header to display for the card. + */ + export interface Schema$EnterpriseTopazSidekickPeopleAnswerPeopleAnswerCardHeader { + /** + * The suggested title to display. This defaults to the user's query. + */ + title?: string | null; + } + /** + * An answer card for a single person. + */ + export interface Schema$EnterpriseTopazSidekickPeopleAnswerPersonAnswerCard { + /** + * List of answers. + */ + answer?: Schema$SafeHtmlProto[]; + /** + * List of answers. + */ + answerText?: Schema$EnterpriseTopazSidekickAnswerAnswerList; + /** + * Disambiguation information. + */ + disambiguationInfo?: Schema$EnterpriseTopazSidekickPeopleAnswerDisambiguationInfo; + /** + * The header to display for the card. + */ + header?: Schema$EnterpriseTopazSidekickPeopleAnswerPeopleAnswerCardHeader; + /** + * The response status. + */ + responseStatus?: string | null; + /** + * Localized user friendly message to display to the user in the case of missing data or an error. + */ + statusMessage?: string | null; + /** + * The profile of the person that was the subject of the query. + */ + subject?: Schema$EnterpriseTopazSidekickCommonPerson; + } + /** + * An answer card for a list of people that are related to the subject of the query. + */ + export interface Schema$EnterpriseTopazSidekickPeopleAnswerRelatedPeopleAnswerCard { + /** + * Disambiguation information. + */ + disambiguationInfo?: Schema$EnterpriseTopazSidekickPeopleAnswerDisambiguationInfo; + /** + * The header to display for the card. + */ + header?: Schema$EnterpriseTopazSidekickPeopleAnswerPeopleAnswerCardHeader; + /** + * A list of people that are related to the query subject. + */ + relatedPeople?: Schema$EnterpriseTopazSidekickCommonPerson[]; + /** + * Defines the type of relation the list of people have with the subject of the card. + */ + relationType?: string | null; + /** + * The response status. + */ + responseStatus?: string | null; + /** + * Localized user friendly message to display to the user in the case of missing data or an error. + */ + statusMessage?: string | null; + /** + * The profile of the person that was the subject of the query. + */ + subject?: Schema$EnterpriseTopazSidekickCommonPerson; + } + export interface Schema$EnterpriseTopazSidekickPeopleDisambiguationCard { + /** + * Candidate persons for the query. + */ + person?: Schema$EnterpriseTopazSidekickCommonPerson[]; + } + /** + * Person. + */ + export interface Schema$EnterpriseTopazSidekickPerson { + /** + * The level of affinity this person has with the requesting user. + */ + affinityLevel?: string | null; + /** + * Attendance status of the person when included in a meeting event. + */ + attendingStatus?: string | null; + /** + * Email. + */ + email?: string | null; + /** + * Gaia id. + */ + gaiaId?: string | null; + /** + * Whether the invitee is a group. + */ + isGroup?: boolean | null; + /** + * Name. + */ + name?: string | null; + /** + * Obfuscated Gaia id. + */ + obfuscatedGaiaId?: string | null; + /** + * Absolute URL to the profile photo of the person. + */ + photoUrl?: string | null; + } + /** + * Personalized docs card proto. + */ + export interface Schema$EnterpriseTopazSidekickPersonalizedDocsCardProto { + /** + * Document group. + */ + documentGroup?: Schema$EnterpriseTopazSidekickDocumentGroup[]; + } + export interface Schema$EnterpriseTopazSidekickPersonProfileCard { + relatedPeople?: Schema$EnterpriseTopazSidekickPersonProfileCardRelatedPeople[]; + /** + * The subject of the card. + */ + subject?: Schema$EnterpriseTopazSidekickCommonPerson; + } + export interface Schema$EnterpriseTopazSidekickPersonProfileCardRelatedPeople { + /** + * Related people. + */ + relatedPerson?: Schema$EnterpriseTopazSidekickCommonPerson[]; + /** + * Relation type. + */ + relation?: string | null; + } + /** + * Ranking params. + */ + export interface Schema$EnterpriseTopazSidekickRankingParams { + /** + * The end-time that this object will expect to occur. If the type is marked as FIXED, then this end-time will persist after bidding. If the type is marked as FLEXIBLE, this field is NOT expected to be filled and will be filled in after it has won a bid. Expected to be set when type is set to FIXED. + */ + endTimeMs?: string | null; + /** + * The priority to determine between objects that have the same start_time_ms The lower-value of priority == ranked higher. Max-priority = 0. Expected to be set for all types. + */ + priority?: string | null; + /** + * The score of the card to be used to break priority-ties + */ + score?: number | null; + /** + * The span that this card will take in the stream Expected to be set when type is set to FLEXIBLE. + */ + spanMs?: string | null; + /** + * The start-time that this object will bid-for If the type is marked as FIXED, then this start-time will persist after bidding. If the type is marked as FLEXIBLE, then it will occur at the given time or sometime after the requested time. Expected to be set for all types. + */ + startTimeMs?: string | null; + /** + * The packing type of this object. + */ + type?: string | null; + } + export interface Schema$EnterpriseTopazSidekickRecentDocumentsCardProto { + document?: Schema$EnterpriseTopazSidekickCommonDocument[]; + } + /** + * Details about scheduled meetings. + */ + export interface Schema$EnterpriseTopazSidekickScheduledMeeting { + /** + * The meeting location. + */ + meetingLocation?: string | null; + /** + * The meeting time slot. + */ + meetingTime?: Schema$EnterpriseTopazSidekickTimeSlot; + /** + * The meeting title. + */ + meetingTitle?: string | null; + } + /** + * Share meeting docs card proto. + */ + export interface Schema$EnterpriseTopazSidekickShareMeetingDocsCardProto { + /** + * Documents to share for the given meeting. + */ + document?: Schema$EnterpriseTopazSidekickCommonDocument[]; + /** + * Event. + */ + event?: Schema$EnterpriseTopazSidekickAgendaEntry; + } + /** + * Slot of time. + */ + export interface Schema$EnterpriseTopazSidekickTimeSlot { + /** + * Day end time at the user's timezone. + */ + endTimeDay?: string | null; + /** + * Hour and minute of the end time at the user's timezone. + */ + endTimeHourAndMinute?: string | null; + /** + * End time in milliseconds. + */ + endTimeInMillis?: string | null; + /** + * Day start time at user's timezone. + */ + startTimeDay?: string | null; + /** + * Hour and minute of the start time at the user's timezone. + */ + startTimeHourAndMinute?: string | null; + /** + * Start time in milliseconds. + */ + startTimeInMillis?: string | null; + } + /** + * Used to provide a search operator for enum properties. This is optional. Search operators let users restrict the query to specific fields relevant to the type of item being searched. For example, if you provide no operator for a *priority* enum property with possible values *p0* and *p1*, a query that contains the term *p0* returns items that have *p0* as the value of the *priority* property, as well as any items that contain the string *p0* in other fields. If you provide an operator name for the enum, such as *priority*, then search users can use that operator to refine results to only items that have *p0* as this property's value, with the query *priority:p0*. + */ + export interface Schema$EnumOperatorOptions { + /** + * Indicates the operator name required in the query in order to isolate the enum property. For example, if operatorName is *priority* and the property's name is *priorityVal*, then queries like *priority:* show results only where the value of the property named *priorityVal* matches **. By contrast, a search that uses the same ** without an operator returns all items where ** matches the value of any String properties or text within the content field for the item. The operator name can only contain lowercase letters (a-z). The maximum length is 32 characters. + */ + operatorName?: string | null; + } + /** + * The options for enum properties, which allow you to define a restricted set of strings to match user queries, set rankings for those string values, and define an operator name to be paired with those strings so that users can narrow results to only items with a specific value. For example, for items in a request tracking system with priority information, you could define *p0* as an allowable enum value and tie this enum to the operator name *priority* so that search users could add *priority:p0* to their query to restrict the set of results to only those items indexed with the value *p0*. + */ + export interface Schema$EnumPropertyOptions { + /** + * If set, describes how the enum should be used as a search operator. */ - agendaGroupCardProto?: Schema$EnterpriseTopazSidekickAgendaGroupCardProto; + operatorOptions?: Schema$EnumOperatorOptions; /** - * Card metadata such as chronology and render mode of the card. + * Used to specify the ordered ranking for the enumeration that determines how the integer values provided in the possible EnumValuePairs are used to rank results. If specified, integer values must be provided for all possible EnumValuePair values given for this property. Can only be used if isRepeatable is false. */ - cardMetadata?: Schema$EnterpriseTopazSidekickCardMetadata; + orderedRanking?: string | null; /** - * Card type. + * The list of possible values for the enumeration property. All EnumValuePairs must provide a string value. If you specify an integer value for one EnumValuePair, then all possible EnumValuePairs must provide an integer value. Both the string value and integer value must be unique over all possible values. Once set, possible values cannot be removed or modified. If you supply an ordered ranking and think you might insert additional enum values in the future, leave gaps in the initial integer values to allow adding a value in between previously registered values. The maximum number of elements is 100. */ - cardType?: string | null; + possibleValues?: Schema$EnumValuePair[]; + } + /** + * The enumeration value pair defines two things: a required string value and an optional integer value. The string value defines the necessary query term required to retrieve that item, such as *p0* for a priority item. The integer value determines the ranking of that string value relative to other enumerated values for the same property. For example, you might associate *p0* with *0* and define another enum pair such as *p1* and *1*. You must use the integer value in combination with ordered ranking to set the ranking of a given value relative to other enumerated values for the same property name. Here, a ranking order of DESCENDING for *priority* properties results in a ranking boost for items indexed with a value of *p0* compared to items indexed with a value of *p1*. Without a specified ranking order, the integer value has no effect on item ranking. + */ + export interface Schema$EnumValuePair { /** - * Conflicting events card. + * The integer value of the EnumValuePair which must be non-negative. Optional. */ - conflictingMeetingsCard?: Schema$EnterpriseTopazSidekickConflictingEventsCardProto; + integerValue?: number | null; /** - * Answer card for documents that are applicable to the current query. + * The string value of the EnumValuePair. The maximum length is 32 characters. */ - documentListCard?: Schema$EnterpriseTopazSidekickDocumentPerCategoryList; + stringValue?: string | null; + } + /** + * List of enum values. + */ + export interface Schema$EnumValues { /** - * Documents with mentions. + * The maximum allowable length for string values is 32 characters. */ - documentsWithMentions?: Schema$EnterpriseTopazSidekickDocumentPerCategoryList; + values?: string[] | null; + } + /** + * Error information about the response. + */ + export interface Schema$ErrorInfo { + errorMessages?: Schema$ErrorMessage[]; + } + /** + * Error message per source response. + */ + export interface Schema$ErrorMessage { + errorMessage?: string | null; + source?: Schema$Source; + } + /** + * A bucket in a facet is the basic unit of operation. A bucket can comprise either a single value OR a contiguous range of values, depending on the type of the field bucketed. FacetBucket is currently used only for returning the response object. + */ + export interface Schema$FacetBucket { /** - * Find meeting time card. + * Number of results that match the bucket value. Counts are only returned for searches when count accuracy is ensured. Cloud Search does not guarantee facet counts for any query and facet counts might be present only intermittently, even for identical queries. Do not build dependencies on facet count existence; instead use facet ount percentages which are always returned. */ - findMeetingTimeCard?: Schema$EnterpriseTopazSidekickFindMeetingTimeCardProto; + count?: number | null; /** - * Generic answer card. + * Filter to be passed in the search request if the corresponding bucket is selected. */ - genericAnswerCard?: Schema$EnterpriseTopazSidekickGenericAnswerCard; + filter?: Schema$Filter; /** - * Get and keep ahead card. + * Percent of results that match the bucket value. The returned value is between (0-100], and is rounded down to an integer if fractional. If the value is not explicitly returned, it represents a percentage value that rounds to 0. Percentages are returned for all searches, but are an estimate. Because percentages are always returned, you should render percentages instead of counts. */ - getAndKeepAheadCard?: Schema$EnterpriseTopazSidekickGetAndKeepAheadCardProto; + percentage?: number | null; + value?: Schema$Value; + } + /** + * Specifies operators to return facet results for. There will be one FacetResult for every source_name/object_type/operator_name combination. + */ + export interface Schema$FacetOptions { /** - * Meeting card. + * If set, describes integer faceting options for the given integer property. The corresponding integer property in the schema should be marked isFacetable. The number of buckets returned would be minimum of this and num_facet_buckets. */ - meeting?: Schema$EnterpriseTopazSidekickAgendaEntry; + integerFacetingOptions?: Schema$IntegerFacetingOptions; /** - * Meeting notes card. + * Maximum number of facet buckets that should be returned for this facet. Defaults to 10. Maximum value is 100. */ - meetingNotesCard?: Schema$EnterpriseTopazSidekickMeetingNotesCardProto; + numFacetBuckets?: number | null; /** - * Request for meeting notes card. + * If object_type is set, only those objects of that type will be used to compute facets. If empty, then all objects will be used to compute facets. */ - meetingNotesCardRequest?: Schema$EnterpriseTopazSidekickMeetingNotesCardRequest; + objectType?: string | null; /** - * The people disambiguation card. + * The name of the operator chosen for faceting. @see cloudsearch.SchemaPropertyOptions */ - peopleDisambiguationCard?: Schema$EnterpriseTopazSidekickPeopleDisambiguationCard; + operatorName?: string | null; /** - * People Search promotion card. + * Source name to facet on. Format: datasources/{source_id\} If empty, all data sources will be used. */ - peoplePromotionCard?: Schema$PeoplePromotionCard; + sourceName?: string | null; + } + /** + * Source specific facet response + */ + export interface Schema$FacetResult { /** - * Card with recommended documents for the user. + * FacetBuckets for values in response containing at least a single result with the corresponding filter. */ - personalizedDocsCard?: Schema$EnterpriseTopazSidekickPersonalizedDocsCardProto; + buckets?: Schema$FacetBucket[]; /** - * Answer card that represents a single person. + * Object type for which facet results are returned. Can be empty. */ - personAnswerCard?: Schema$EnterpriseTopazSidekickPeopleAnswerPersonAnswerCard; + objectType?: string | null; /** - * Full profile card. + * The name of the operator chosen for faceting. @see cloudsearch.SchemaPropertyOptions */ - personProfileCard?: Schema$EnterpriseTopazSidekickPersonProfileCard; + operatorName?: string | null; /** - * Answer card that represents a list of people related to a person. + * Source name for which facet results are returned. Will not be empty. */ - relatedPeopleAnswerCard?: Schema$EnterpriseTopazSidekickPeopleAnswerRelatedPeopleAnswerCard; + sourceName?: string | null; + } + export interface Schema$FieldViolation { /** - * Shared documents. + * The description of the error. */ - sharedDocuments?: Schema$EnterpriseTopazSidekickDocumentPerCategoryList; + description?: string | null; /** - * Sahre meeting docs card. + * Path of field with violation. */ - shareMeetingDocsCard?: Schema$EnterpriseTopazSidekickShareMeetingDocsCardProto; + field?: string | null; + } + /** + * A generic way of expressing filters in a query, which supports two approaches: **1. Setting a ValueFilter.** The name must match an operator_name defined in the schema for your data source. **2. Setting a CompositeFilter.** The filters are evaluated using the logical operator. The top-level operators can only be either an AND or a NOT. AND can appear only at the top-most level. OR can appear only under a top-level AND. + */ + export interface Schema$Filter { + compositeFilter?: Schema$CompositeFilter; + valueFilter?: Schema$ValueFilter; + } + /** + * Filter options to be applied on query. + */ + export interface Schema$FilterOptions { /** - * Answer card for what natural language queries the user can ask. + * Generic filter to restrict the search, such as `lang:en`, `site:xyz`. */ - suggestedQueryAnswerCard?: Schema$EnterpriseTopazSidekickAnswerSuggestedQueryAnswerCard; + filter?: Schema$Filter; /** - * Third party answer cards. + * If object_type is set, only objects of that type are returned. This should correspond to the name of the object that was registered within the definition of schema. The maximum length is 256 characters. */ - thirdPartyAnswerCard?: Schema$ThirdPartyGenericCard; + objectType?: string | null; + } + /** + * Indicates which freshness property to use when adjusting search ranking for an item. Fresher, more recent dates indicate higher quality. Use the freshness option property that best works with your data. For fileshare documents, last modified time is most relevant. For calendar event data, the time when the event occurs is a more relevant freshness indicator. In this way, calendar events that occur closer to the time of the search query are considered higher quality and ranked accordingly. + */ + export interface Schema$FreshnessOptions { /** - * Work In Progress card. + * The duration after which an object should be considered stale. The default value is 180 days (in seconds). */ - workInProgressCardProto?: Schema$EnterpriseTopazSidekickRecentDocumentsCardProto; + freshnessDuration?: string | null; + /** + * This property indicates the freshness level of the object in the index. If set, this property must be a top-level property within the property definitions and it must be a timestamp type or date type. Otherwise, the Indexing API uses updateTime as the freshness indicator. The maximum length is 256 characters. When a property is used to calculate freshness, the value defaults to 2 years from the current time. + */ + freshnessProperty?: string | null; } /** - * Card metadata. + * A globally unique identifier associated with each feature. We use 128-bit identifiers so that we have lots of bits available to distinguish between features. The feature id currently consists of a 64-bit "cell id" that **sometimes** corresponds to the approximate centroid of the feature, plus a 64-bit fingerprint of other identifying information. See more on each respective field in its comments. Feature ids are first assigned when the data is created in MapFacts. After initial creation of the feature, they are immutable. This means that the only properties that you should rely on are that they are unique, and that cell_ids often - but not always - preserve spatial locality. The degree of locality varies as the feature undergoes geometry changes, and should not in general be considered a firm guarantee of the location of any particular feature. In fact, some locationless features have randomized cell IDs! Consumers of FeatureProtos from Mapfacts are guaranteed that fprints in the id field of features will be globally unique. Using the fprint allows consumers who don't need the spatial benefit of cell ids to uniquely identify features in a 64-bit address space. This property is not guaranteed for other sources of FeatureProtos. */ - export interface Schema$EnterpriseTopazSidekickCardMetadata { + export interface Schema$GeostoreFeatureIdProto { /** - * Declares a preference for how this card should be packed in MSCR. All cards in a response must correspond to a single category. As a result, cards may be dropped from the response if this field is set. Any card that does not match the category of the card with the highest priority in the response will be dropped. + * The S2CellId corresponding to the approximate location of this feature as of when it was first created. This can be of variable accuracy, ranging from the exact centroid of the feature at creation, a very large S2 Cell, or even being completely randomized for locationless features. Cell ids have the nice property that they follow a space-filling curve over the surface of the earth. (See s2cellid.h for details.) WARNING: Clients should only use cell IDs to perform spatial locality optimizations. There is no strict guarantee that the cell ID of a feature is related to the current geometry of the feature in any way. */ - cardCategory?: string | null; + cellId?: string | null; /** - * An ID to identify the card and match actions to it. Be thoughtful of new card IDs since actions will be associated to that ID. E.g., if two card IDs collide, the system will think that the actions have been applied to the same card. Similarly, if EAS can return multiple cards of the same type (e.g., Meetings), ensure that the card_id identifies a given instance of the card so that, e.g., dismissals only affect the dismissed card as opposed to affecting all meeting cards. + * A 64-bit fingerprint used to identify features. Most clients should rely on MapFacts or OneRing to choose fingerprints. If creating new fprints, the strategy should be chosen so that the chance of collision is remote or non-existent, and the distribution should be reasonably uniform. For example, if the source data assigns unique ids to features, then a fingerprint of the provider name, version, and source id is sufficient. */ - cardId?: string | null; + fprint?: string | null; /** - * Chronology. + * A place for clients to attach arbitrary data to a feature ID. Never set in MapFacts. */ - chronology?: string | null; + temporaryData?: Schema$MessageSet; + } + /** + * Internal field metadata. This part is not exposed to downstream consumers of the repository (read-only clients) but is available to upstream providers to the repository (read-write clients). + */ + export interface Schema$GeostoreFieldMetadataProto { + internal?: Schema$GeostoreInternalFieldMetadataProto; + } + export interface Schema$GeostoreInternalFieldMetadataProto { /** - * Debug info (only reported if request's debug_level \> 0). + * Whether or not the piece of data has been generated automatically (i.e., by a bot/automated process based on heuristics/algorithms rather than coming as a fact set by some human user or data provider based on their knowledge). Note that this does NOT imply that the value was set as a result of a bot operation on the repository, since it is conceivable to use a bot/automated process simply as a way of convenience to ingest large amount of canonical/ground truth data. */ - debugInfo?: string | null; + isAuto?: boolean | null; /** - * Information about the NLP done to get the card. + * Information about the source providing the piece of data this metadata is attached to. */ - nlpMetadata?: Schema$EnterpriseTopazSidekickNlpMetadata; + sourceSummary?: Schema$GeostoreInternalSourceSummaryProto; + } + export interface Schema$GeostoreInternalSourceSummaryProto { /** - * Ranking params. + * Within the above provider, the dataset from which this piece of data was generated. For fields that are auto-generated the "dataset" is likely to be some algorithm's or program's name. Similar to SourceInfoProto.dataset but with the difference that it is required to always be set. Providers that don't have a concept of dataset may use "default". */ - rankingParams?: Schema$EnterpriseTopazSidekickRankingParams; + dataset?: string | null; /** - * Render mode. + * The data provider from which this piece of data was generated. Equivalent to SourceInfoProto.provider in the public schema. */ - renderMode?: string | null; + provider?: string | null; } /** - * Container of debugging information in all object levels. Extend as needed. + * The reference to an entity in the KnowledgeGraph. For details on the KnowledgeGraph see http://goto/kg. */ - export interface Schema$EnterpriseTopazSidekickCommonDebugInfo { + export interface Schema$GeostoreKnowledgeGraphReferenceProto { /** - * Debug message. + * KG Identifier (MID). For details, see http://go/ke-bg-knowledge-graph#mids. */ - message?: string | null; + id?: string | null; } /** - * Representation of a document. NEXT_TAG: 15 + * A name for a Feature (street name, point of interest, city, building, etc). We currently use NameProto for two essentially disjoint purposes: 1. Common names, which can be language-specific, or have other kinds of variations. 2. Opaque IDs, such as postal codes, which only have the `text` field set, and potentially some flags. This includes internal-only features like template ids. Each NameProto representing a common name corresponds to an assertion that a fluent speaker or writer of a language would recognize NameProto.text to name the given feature in that language. As such, NameProtos are stored in a repeated field, often having: 1. multiple names with the same text and varying languages, and 2. multiple names with the same language and varying texts. */ - export interface Schema$EnterpriseTopazSidekickCommonDocument { - /** - * Access type, i.e., whether the user has access to the document or not. - */ - accessType?: string | null; - /** - * Information for debugging. - */ - debugInfo?: Schema$EnterpriseTopazSidekickCommonDebugInfo; + export interface Schema$GeostoreNameProto { /** - * Document id. + * clang-format on The set of flags that apply to this name. */ - documentId?: string | null; + flag?: string[] | null; /** - * Drive document metadata. + * The external form of a Google International Identifiers Initiative (III) LanguageCode object. See google3/i18n/identifiers/languagecode.h for details. These strings should be treated as opaque blobs. You can use LanguageCodeConverter::FromOther to convert the string to a LanguageCode reference. You can then call methods on the LanguageCode class to extract language/script/region subtags (if any). See also http://g3doc/i18n/identifiers/g3doc/using-iii. We place extra restrictions on languages in addition to what the III library requires. See go/geo-schema-reference/feature-properties/languages. This field may be missing if the name does not have a concept of language but should be set if the language is unknown. */ - driveDocumentMetadata?: Schema$EnterpriseTopazSidekickCommonDocumentDriveDocumentMetadata; + language?: string | null; /** - * Generic Drive-based url in the format of drive.google.com/open to be used for deeplink + * Field-level metadata for this name. NOTE: there are multiple NameProto fields in the Geo Schema. Metadata here is only expected to be present on FeatureProto.name[]. */ - genericUrl?: string | null; + metadata?: Schema$GeostoreFieldMetadataProto; /** - * Justification on why the document is selected. + * ** DEPRECATED ** The name text provided in the original source data (UTF-8 encoding). This is the text provided in the source data unmodified with the exception of being converted to UTF-8 and stripping extra leading, trailing and duplicate whitespaces (if necessary). */ - justification?: Schema$EnterpriseTopazSidekickCommonDocumentJustification; + rawText?: string | null; /** - * MIME type + * The short name text (UTF-8 encoding). Acronyms/abbreviations should be consistently used, for example "NE 57th St" rather than "Northeast 57th Street", "N.E 57th St." or some other variant. This field should be populated with the chosen canonical version of the shortened name, based on per-term transformations. For feature specific abbreviations (such as 'CA' for 'California'), one should define a separate name with FLAG_ABBREVIATED set. For other variants of the shortened name that are not the canonical one, devise client based logic (ex: query rewriting rules). */ - mimeType?: string | null; + shortText?: string | null; /** - * Document provenance. + * A place for clients to attach arbitrary data to a name. Never set in MapFacts. */ - provenance?: string | null; + temporaryData?: Schema$MessageSet; /** - * Justification of why this document is being returned. + * The name text (UTF-8 encoding). Acronyms/abbreviations should be fully expanded, for example "Northeast 57th Street" rather than "NE 57th St". They can be shortened at display or geocode time. This decision prevents ambiguity over such issues as whether "St" represents "Street" or "Saint". However, it pushes language-specific knowledge into code. We will have libraries and data files to contract acronyms/abbreviations at run-time. */ - reason?: string | null; + text?: string | null; + } + export interface Schema$GeostorePointProto { + latE7?: number | null; + lngE7?: number | null; /** - * A sampling of the text from the document. + * NOTE: If removing metadata, remove 'option objc_class_prefix = "GS";' together. See cl/189921100. Field-level metadata for this point. NOTE: there are multiple PointProto fields in the Geo Schema. Metadata here is only expected to be present on FeatureProto.point[] and FeatureProto.center. */ - snippet?: string | null; + metadata?: Schema$GeostoreFieldMetadataProto; /** - * Thumbnail URL. + * A place for clients to attach arbitrary data to a point. Never set in MapFacts. */ - thumbnailUrl?: string | null; + temporaryData?: Schema$MessageSet; + } + /** + * A latitude-longitude rectangle, represented as two diagonally opposite points "lo" and "hi". The rectangle is considered to be a closed region, i.e. it includes its boundary. The latitude bounds must be in the range -90 to 90 degrees inclusive, and the longitude bounds must be in the range -180 to 180 degrees inclusive. Various cases include: - If lo == hi, the rectangle consists of a single point. - If lo.longitude \> hi.longitude, the longitude range is "inverted" (the rectangle crosses the 180 degree longitude line). - If lo.longitude == -180 degrees and hi.longitude = 180 degrees, the rectangle includes all longitudes. - If lo.longitude = 180 degrees and hi.longitude = -180 degrees, the longitude range is empty. - If lo.latitude \> hi.latitude, the latitude range is empty. + */ + export interface Schema$GeostoreRectProto { + hi?: Schema$GeostorePointProto; + lo?: Schema$GeostorePointProto; + } + export interface Schema$GetCustomerIndexStatsResponse { /** - * Title of the document. + * Average item count for the given date range for which billing is done. */ - title?: string | null; + averageIndexedItemCount?: string | null; /** - * Type of the document. + * Summary of indexed item counts, one for each day in the requested range. */ - type?: string | null; + stats?: Schema$CustomerIndexStats[]; + } + export interface Schema$GetCustomerQueryStatsResponse { + stats?: Schema$CustomerQueryStats[]; /** - * Absolute URL of the document. + * Total successful query count (status code 200) for the given date range. */ - url?: string | null; + totalQueryCount?: string | null; } /** - * Meta data for drive documents. + * Response format for search application stats for a customer. */ - export interface Schema$EnterpriseTopazSidekickCommonDocumentDriveDocumentMetadata { + export interface Schema$GetCustomerSearchApplicationStatsResponse { /** - * The drive document cosmo id. Client could use the id to build a URL to open a document. Please use Document.document_id. + * Average search application count for the given date range. */ - documentId?: string | null; + averageSearchApplicationCount?: string | null; /** - * Additional field to identify whether a document is private since scope set to LIMITED can mean both that the doc is private or that it's shared with others. is_private indicates whether the doc is not shared with anyone except for the owner. + * Search application stats by date. */ - isPrivate?: boolean | null; + stats?: Schema$CustomerSearchApplicationStats[]; + } + export interface Schema$GetCustomerSessionStatsResponse { + stats?: Schema$CustomerSessionStats[]; + } + export interface Schema$GetCustomerUserStatsResponse { + stats?: Schema$CustomerUserStats[]; + } + export interface Schema$GetDataSourceIndexStatsResponse { /** - * Timestamp of the most recent comment added to the document in milliseconds since epoch. + * Average item count for the given date range for which billing is done. */ - lastCommentTimeMs?: string | null; + averageIndexedItemCount?: string | null; /** - * Timestamp of the most recent edit from the current user in milliseconds since epoch. + * Summary of indexed item counts, one for each day in the requested range. */ - lastEditTimeMs?: string | null; + stats?: Schema$DataSourceIndexStats[]; + } + /** + * Response format for getting query stats for a search application between given dates. + */ + export interface Schema$GetSearchApplicationQueryStatsResponse { /** - * Last modification time of the document (independent of the user that modified it). + * Query stats per date for a search application. */ - lastModificationTimeMillis?: string | null; + stats?: Schema$SearchApplicationQueryStats[]; /** - * Timestamp of the last updated time of the document in milliseconds since epoch. + * Total successful query count (status code 200) for the given date range. */ - lastUpdatedTimeMs?: string | null; + totalQueryCount?: string | null; + } + export interface Schema$GetSearchApplicationSessionStatsResponse { + stats?: Schema$SearchApplicationSessionStats[]; + } + export interface Schema$GetSearchApplicationUserStatsResponse { + stats?: Schema$SearchApplicationUserStats[]; + } + export interface Schema$GSuitePrincipal { /** - * Timestamp of the most recent view from the current user in milliseconds since epoch. + * This principal represents all users of the Google Workspace domain of the customer. */ - lastViewTimeMs?: string | null; + gsuiteDomain?: boolean | null; /** - * The owner of the document. + * This principal references a Google Workspace group name. */ - owner?: Schema$EnterpriseTopazSidekickCommonPerson; + gsuiteGroupEmail?: string | null; /** - * ACL scope of the document which identifies the sharing status of the doc (e.g., limited, shared with link, team drive, ...). + * This principal references a Google Workspace user account. */ - scope?: string | null; + gsuiteUserEmail?: string | null; } /** - * Justification of why we are reporting the document. + * Used to provide a search operator for html properties. This is optional. Search operators let users restrict the query to specific fields relevant to the type of item being searched. */ - export interface Schema$EnterpriseTopazSidekickCommonDocumentJustification { - /** - * A locale aware message that explains why this document was selected. - */ - justification?: string | null; + export interface Schema$HtmlOperatorOptions { /** - * Reason on why the document is selected. Populate for trending documents. + * Indicates the operator name required in the query in order to isolate the html property. For example, if operatorName is *subject* and the property's name is *subjectLine*, then queries like *subject:* show results only where the value of the property named *subjectLine* matches **. By contrast, a search that uses the same ** without an operator return all items where ** matches the value of any html properties or text within the content field for the item. The operator name can only contain lowercase letters (a-z). The maximum length is 32 characters. */ - reason?: string | null; + operatorName?: string | null; } /** - * Common representation of a person. + * The options for html properties. */ - export interface Schema$EnterpriseTopazSidekickCommonPerson { + export interface Schema$HtmlPropertyOptions { /** - * The birthday. + * If set, describes how the property should be used as a search operator. */ - birthday?: Schema$EnterpriseTopazSidekickCommonPersonBirthday; + operatorOptions?: Schema$HtmlOperatorOptions; /** - * Cell phone number. + * Indicates the search quality importance of the tokens within the field when used for retrieval. Can only be set to DEFAULT or NONE. */ - cellPhone?: string | null; + retrievalImportance?: Schema$RetrievalImportance; + } + /** + * List of html values. + */ + export interface Schema$HtmlValues { /** - * The department the person works in (e.g. Engineering). + * The maximum allowable length for html values is 2048 characters. */ - department?: string | null; + values?: string[] | null; + } + export interface Schema$IndexItemOptions { /** - * Desk location (e.g. US-MTV-PR55-5-5B1I). + * Specifies if the index request should allow Google Workspace principals that do not exist or are deleted. */ - deskLocation?: string | null; + allowUnknownGsuitePrincipals?: boolean | null; + } + export interface Schema$IndexItemRequest { /** - * Work desk phone number. + * The name of connector making this call. Format: datasources/{source_id\}/connectors/{ID\} */ - deskPhone?: string | null; + connectorName?: string | null; /** - * The full name. + * Common debug options. */ - displayName?: string | null; + debugOptions?: Schema$DebugOptions; + indexItemOptions?: Schema$IndexItemOptions; /** - * Email. + * The name of the item. Format: datasources/{source_id\}/items/{item_id\} */ - email?: string | null; + item?: Schema$Item; /** - * The last name. + * Required. The RequestMode for this request. */ - familyName?: string | null; + mode?: string | null; + } + /** + * Request message for `InitializeCustomer` method. + */ + export interface Schema$InitializeCustomerRequest {} + /** + * Used to specify integer faceting options. + */ + export interface Schema$IntegerFacetingOptions { /** - * The fully formatted address (e.g. 1255 Pear Avenue, Mountain View 94043, United States). + * Buckets for given integer values should be in strictly ascending order. For example, if values supplied are (1,5,10,100), the following facet buckets will be formed {<1, [1,5), [5-10), [10-100), \>=100\}. */ - fullAddress?: string | null; + integerBuckets?: string[] | null; + } + /** + * Used to provide a search operator for integer properties. This is optional. Search operators let users restrict the query to specific fields relevant to the type of item being searched. + */ + export interface Schema$IntegerOperatorOptions { /** - * This field is deprecated. The obfuscated_id should be used instead. + * Indicates the operator name required in the query in order to isolate the integer property using the greater-than operator. For example, if greaterThanOperatorName is *priorityabove* and the property's name is *priorityVal*, then queries like *priorityabove:* show results only where the value of the property named *priorityVal* is greater than **. The operator name can only contain lowercase letters (a-z). The maximum length is 32 characters. */ - gaiaId?: string | null; + greaterThanOperatorName?: string | null; /** - * The first name. + * Indicates the operator name required in the query in order to isolate the integer property using the less-than operator. For example, if lessThanOperatorName is *prioritybelow* and the property's name is *priorityVal*, then queries like *prioritybelow:* show results only where the value of the property named *priorityVal* is less than **. The operator name can only contain lowercase letters (a-z). The maximum length is 32 characters. */ - givenName?: string | null; + lessThanOperatorName?: string | null; /** - * The person's job title (e.g. Software Engineer). + * Indicates the operator name required in the query in order to isolate the integer property. For example, if operatorName is *priority* and the property's name is *priorityVal*, then queries like *priority:* show results only where the value of the property named *priorityVal* matches **. By contrast, a search that uses the same ** without an operator returns all items where ** matches the value of any String properties or text within the content field for the item. The operator name can only contain lowercase letters (a-z). The maximum length is 32 characters. */ - jobTitle?: string | null; + operatorName?: string | null; + } + /** + * The options for integer properties. + */ + export interface Schema$IntegerPropertyOptions { /** - * The manager. + * If set, describes integer faceting options for the given integer property. The corresponding integer property should be marked isFacetable. */ - manager?: Schema$EnterpriseTopazSidekickCommonPerson; + integerFacetingOptions?: Schema$IntegerFacetingOptions; /** - * The obfuscated GAIA ID. + * The maximum value of the property. The minimum and maximum values for the property are used to rank results according to the ordered ranking. Indexing requests with values greater than the maximum are accepted and ranked with the same weight as items indexed with the maximum value. */ - obfuscatedId?: string | null; + maximumValue?: string | null; /** - * The URL for the Focus profile picture. + * The minimum value of the property. The minimum and maximum values for the property are used to rank results according to the ordered ranking. Indexing requests with values less than the minimum are accepted and ranked with the same weight as items indexed with the minimum value. */ - photoUrl?: string | null; + minimumValue?: string | null; /** - * The street address (e.g. 1255 Pear Avenue). + * If set, describes how the integer should be used as a search operator. */ - streetAddress?: string | null; - } - export interface Schema$EnterpriseTopazSidekickCommonPersonBirthday { + operatorOptions?: Schema$IntegerOperatorOptions; /** - * Unstructured birthday. + * Used to specify the ordered ranking for the integer. Can only be used if isRepeatable is false. */ - value?: string | null; + orderedRanking?: string | null; } /** - * Conflicting meetings card proto. + * List of integer values. */ - export interface Schema$EnterpriseTopazSidekickConflictingEventsCardProto { - /** - * All the events that conflict with main_event. - */ - conflictingEvent?: Schema$EnterpriseTopazSidekickAgendaEntry[]; - /** - * The event identified as being the most important. - */ - mainEvent?: Schema$EnterpriseTopazSidekickAgendaEntry; + export interface Schema$IntegerValues { + values?: string[] | null; } /** - * Represents a mapping between a document type and its corresponding documents. Use for Work in Progress card in v1 homepage. + * Represents an interaction between a user and an item. */ - export interface Schema$EnterpriseTopazSidekickDocumentGroup { + export interface Schema$Interaction { /** - * Document group type + * The time when the user acted on the item. If multiple actions of the same type exist for a single user, only the most recent action is recorded. */ - groupType?: string | null; + interactionTime?: string | null; /** - * The list of corresponding documents. + * The user that acted on the item. */ - personalizedDocument?: Schema$EnterpriseTopazSidekickCommonDocument[]; + principal?: Schema$Principal; + type?: string | null; } - export interface Schema$EnterpriseTopazSidekickDocumentPerCategoryList { - documents?: Schema$EnterpriseTopazSidekickDocumentPerCategoryListDocumentPerCategoryListEntry[]; + export interface Schema$IPBlockInfoProto { /** - * Localized message explaining how the documents were derived (e.g. from the last 30 days activity). This field is optional. + * ASN of the block. Only present when return_organisational is set in the request options. */ - helpMessage?: string | null; - listType?: string | null; + asn?: string | null; + carrierName?: string | null; + cookiePopulation?: number | null; /** - * Description of the types of documents present in the list. + * DNS and organisational info, only present when return_organisational is set in the request options. Currently (November 2010) this data comes from the raw Quova import. */ - listTypeDescription?: string | null; + dnsDomain?: string | null; /** - * Response message in case no documents are present in the card. + * True, if it is a home IP. Data is from Neustar. */ - responseMessage?: string | null; - } - export interface Schema$EnterpriseTopazSidekickDocumentPerCategoryListDocumentPerCategoryListEntry { - category?: string | null; - document?: Schema$EnterpriseTopazSidekickCommonDocument; + homeIndicator?: boolean | null; /** - * Reason this document was selected. + * Day averages for this block of number of .. Currently (May 2011) not filled in. .. active IPs */ - rationale?: string | null; - } - /** - * Response to find meeting time among a set of people. - */ - export interface Schema$EnterpriseTopazSidekickFindMeetingTimeCardProto { + ipsEstimate?: number | null; /** - * Slots when all attendees have availability. + * ISIC code, data from Neustar. */ - commonAvailableTimeSlots?: Schema$EnterpriseTopazSidekickTimeSlot[]; + isicCode?: string | null; /** - * Invitees to the event. + * Seconds since epoch any data constituting this block last changed. Currently (May 2011) not filled in. */ - invitees?: Schema$EnterpriseTopazSidekickPerson[]; + lastChangedS?: number | null; /** - * Requester. + * NAICS code, data from Neustar. */ - requester?: Schema$EnterpriseTopazSidekickPerson; + naicsCode?: string | null; /** - * Details about the scheduled meeting, if one exists. + * Data from the NetDB project, see net/ipmap/..., only present when return_netstats is set in the request options. */ - scheduledMeeting?: Schema$EnterpriseTopazSidekickScheduledMeeting; + netstats?: Schema$NetStatsProto; + organisationName?: string | null; /** - * Invitees that have been skipped in the computation, most likely because they are groups. + * Neustar's organization_type data. */ - skippedInvitees?: Schema$EnterpriseTopazSidekickPerson[]; + organizationType?: string | null; /** - * Min and max timestamp used to find a common available timeslot. + * Proxy classification of the block. Only present when return_proxy_classification is set in the request options. */ - timeBoundaries?: Schema$EnterpriseTopazSidekickTimeSlot; + proxyClassification?: Schema$ProxyClassificationProto; /** - * Timezone ID. + * For historical reasons, the 'ranges' field is repeated, but actually it occurs at most once. If present, the range is a set of consecutive IP addresses to which the IPGeo result (including the information in the IPBlockInfoProto as well as other info in the IPGeoResponseProto / LocationResult) applies. This means that when the netstats are present, this will be the intersection of the range from the ipgeo index with the range from the netstats index; when the proxy classification is present, this will be intersected with the IP range to which the proxy classification applies. Caveat: intersection with HHI (household income) IP range is currently not implemented. */ - timezoneId?: string | null; - } - export interface Schema$EnterpriseTopazSidekickGap { + ranges?: Schema$IPRangeProto[]; /** - * Localized time string in the format: 1 hour 15 minutes + * Estimate of the fraction of IPs that get reallocated per day. Currently (May 2011) not filled in. */ - displayRemainingTime?: string | null; + reallocFracEstimate?: number | null; /** - * Localized time string in the format:(Locale CZ) 8:30 odp. + * Routing type, only present if return_organisational is set in the request options. Currently (June 2012) this data is not filled in. */ - endTime?: string | null; - endTimeMs?: string | null; - remainingTime?: string | null; + routingtype?: string | null; /** - * Localized time string in the format:(Locale CZ) 8:30 odp. + * .. queries */ - startTime?: string | null; - startTimeMs?: string | null; + trafficEstimate?: number | null; } - export interface Schema$EnterpriseTopazSidekickGenericAnswerCard { + export interface Schema$IPRangeProto { /** - * The answer. + * A contiguous range [begin, end] of IPv4 or IPv6 addresses in packed binary form. 4 or 16 bytes, big endian */ - answer?: string | null; + packedIpBegin?: string | null; /** - * Title or header of the card. + * inclusive */ - title?: string | null; - } - /** - * Get and keep ahead card - */ - export interface Schema$EnterpriseTopazSidekickGetAndKeepAheadCardProto { - declinedEvents?: Schema$EnterpriseTopazSidekickGetAndKeepAheadCardProtoDeclinedEvents; - mentionedDocuments?: Schema$EnterpriseTopazSidekickDocumentPerCategoryList; - sharedDocuments?: Schema$EnterpriseTopazSidekickDocumentPerCategoryList; - } - /** - * A list of events where all guests declined. - */ - export interface Schema$EnterpriseTopazSidekickGetAndKeepAheadCardProtoDeclinedEvents { - events?: Schema$EnterpriseTopazSidekickAgendaEntry[]; + packedIpEnd?: string | null; } /** - * Errors in the creation of meeting notes. + * Represents a single object that is an item in the search index, such as a file, folder, or a database record. */ - export interface Schema$EnterpriseTopazSidekickMeetingNotesCardError { + export interface Schema$Item { + /** + * Access control list for this item. + */ + acl?: Schema$ItemAcl; + /** + * Item content to be indexed and made text searchable. + */ + content?: Schema$ItemContent; /** - * The description of the reason why create-meeting-notes failed. + * The type for this item. */ - description?: string | null; + itemType?: string | null; /** - * The event to request meeting notes creation + * The metadata information. */ - event?: Schema$EnterpriseTopazSidekickAgendaEntry; + metadata?: Schema$ItemMetadata; /** - * The reason why create-meeting-notes failed. + * The name of the Item. Format: datasources/{source_id\}/items/{item_id\} This is a required field. The maximum length is 1536 characters. */ - reason?: string | null; - } - /** - * Information about the meeting notes created. - */ - export interface Schema$EnterpriseTopazSidekickMeetingNotesCardProto { + name?: string | null; /** - * The event to request meeting notes creation. + * Additional state connector can store for this item. The maximum length is 10000 bytes. */ - event?: Schema$EnterpriseTopazSidekickAgendaEntry; + payload?: string | null; /** - * Google Drive ID (a.k.a. resource ID) of the file. + * Queue this item belongs to. The maximum length is 100 characters. */ - fileId?: string | null; + queue?: string | null; /** - * Title we want to show for meeting notes in the answer card + * Status of the item. Output only field. */ - title?: string | null; + status?: Schema$ItemStatus; /** - * New URL. + * The structured data for the item that should conform to a registered object definition in the schema for the data source. */ - url?: string | null; + structuredData?: Schema$ItemStructuredData; + /** + * Required. The indexing system stores the version from the datasource as a byte string and compares the Item version in the index to the version of the queued Item using lexical ordering. Cloud Search Indexing won't index or delete any queued item with a version value that is less than or equal to the version of the currently indexed item. The maximum length for this field is 1024 bytes. For information on how item version affects the deletion process, refer to [Handle revisions after manual deletes](https://developers.google.com/cloud-search/docs/guides/operations). + */ + version?: string | null; } /** - * Meeting notes card request. + * Access control list information for the item. For more information see [Map ACLs](https://developers.google.com/cloud-search/docs/guides/acls). */ - export interface Schema$EnterpriseTopazSidekickMeetingNotesCardRequest { + export interface Schema$ItemAcl { /** - * Who are the meeting notes created for. + * Sets the type of access rules to apply when an item inherits its ACL from a parent. This should always be set in tandem with the inheritAclFrom field. Also, when the inheritAclFrom field is set, this field should be set to a valid AclInheritanceType. */ - canCreateFor?: string[] | null; + aclInheritanceType?: string | null; /** - * The error and reason if known error occured. + * List of principals who are explicitly denied access to the item in search results. While principals are denied access by default, use denied readers to handle exceptions and override the list allowed readers. The maximum number of elements is 100. */ - error?: Schema$EnterpriseTopazSidekickMeetingNotesCardError; + deniedReaders?: Schema$Principal[]; /** - * The event to request meeting notes creation + * The name of the item to inherit the Access Permission List (ACL) from. Note: ACL inheritance *only* provides access permissions to child items and does not define structural relationships, nor does it provide convenient ways to delete large groups of items. Deleting an ACL parent from the index only alters the access permissions of child items that reference the parent in the inheritAclFrom field. The item is still in the index, but may not visible in search results. By contrast, deletion of a container item also deletes all items that reference the container via the containerName field. The maximum length for this field is 1536 characters. */ - event?: Schema$EnterpriseTopazSidekickAgendaEntry; - } - /** - * Metadata about the NLP interpretation of the query. - */ - export interface Schema$EnterpriseTopazSidekickNlpMetadata { + inheritAclFrom?: string | null; /** - * Confidence of the interpretation that generated this card. + * Optional. List of owners for the item. This field has no bearing on document access permissions. It does, however, offer a slight ranking boosts items where the querying user is an owner. The maximum number of elements is 5. */ - confidence?: number | null; + owners?: Schema$Principal[]; + /** + * List of principals who are allowed to see the item in search results. Optional if inheriting permissions from another item or if the item is not intended to be visible, such as virtual containers. The maximum number of elements is 1000. + */ + readers?: Schema$Principal[]; } /** - * Metadata for disambiguation. + * Content of an item to be indexed and surfaced by Cloud Search. Only UTF-8 encoded strings are allowed as inlineContent. If the content is uploaded and not binary, it must be UTF-8 encoded. */ - export interface Schema$EnterpriseTopazSidekickPeopleAnswerDisambiguationInfo { + export interface Schema$ItemContent { /** - * A list of people that also matched the query. This list is not complete. + * Upload reference ID of a previously uploaded content via write method. */ - disambiguation?: Schema$EnterpriseTopazSidekickPeopleAnswerDisambiguationInfoDisambiguationPerson[]; + contentDataRef?: Schema$UploadItemRef; + contentFormat?: string | null; /** - * The name that was extracted from the query. This may be in the form of the given name, last name, full name, LDAP, or email address. This name can be considered suitable for displaying to the user and can largely be considered to be normalized (e.g. "Bob's" -\> "Bob"). + * Hashing info calculated and provided by the API client for content. Can be used with the items.push method to calculate modified state. The maximum length is 2048 characters. */ - name?: string | null; + hash?: string | null; + /** + * Content that is supplied inlined within the update method. The maximum length is 102400 bytes (100 KiB). + */ + inlineContent?: string | null; } - /** - * A person that also matches the query, but was not selected due to a lower affinity with the requesting user. - */ - export interface Schema$EnterpriseTopazSidekickPeopleAnswerDisambiguationInfoDisambiguationPerson { + export interface Schema$ItemCountByStatus { /** - * The profile of this person. + * Number of items matching the status code. */ - person?: Schema$EnterpriseTopazSidekickCommonPerson; + count?: string | null; /** - * The query that can be used to produce an answer card with the same attribute, but for this person. + * Number of items matching the status code for which billing is done. This excludes virtual container items from the total count. This count would not be applicable for items with ERROR or NEW_ITEM status code. */ - query?: string | null; - } - /** - * Recommended header to display for the card. - */ - export interface Schema$EnterpriseTopazSidekickPeopleAnswerPeopleAnswerCardHeader { + indexedItemsCount?: string | null; /** - * The suggested title to display. This defaults to the user's query. + * Status of the items. */ - title?: string | null; + statusCode?: string | null; } /** - * An answer card for a single person. + * Available metadata fields for the item. */ - export interface Schema$EnterpriseTopazSidekickPeopleAnswerPersonAnswerCard { + export interface Schema$ItemMetadata { /** - * List of answers. + * The name of the container for this item. Deletion of the container item leads to automatic deletion of this item. Note: ACLs are not inherited from a container item. To provide ACL inheritance for an item, use the inheritAclFrom field. The maximum length is 1536 characters. */ - answer?: Schema$SafeHtmlProto[]; + containerName?: string | null; /** - * List of answers. + * The BCP-47 language code for the item, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. The maximum length is 32 characters. */ - answerText?: Schema$EnterpriseTopazSidekickAnswerAnswerList; + contentLanguage?: string | null; /** - * Disambiguation information. + * A set of named attributes associated with the item. This can be used for influencing the ranking of the item based on the context in the request. The maximum number of elements is 10. */ - disambiguationInfo?: Schema$EnterpriseTopazSidekickPeopleAnswerDisambiguationInfo; + contextAttributes?: Schema$ContextAttribute[]; /** - * The header to display for the card. + * The time when the item was created in the source repository. */ - header?: Schema$EnterpriseTopazSidekickPeopleAnswerPeopleAnswerCardHeader; + createTime?: string | null; /** - * The response status. + * Hashing value provided by the API caller. This can be used with the items.push method to calculate modified state. The maximum length is 2048 characters. */ - responseStatus?: string | null; + hash?: string | null; /** - * Localized user friendly message to display to the user in the case of missing data or an error. + * A list of interactions for the item. Interactions are used to improve Search quality, but are not exposed to end users. The maximum number of elements is 1000. */ - statusMessage?: string | null; + interactions?: Schema$Interaction[]; /** - * The profile of the person that was the subject of the query. + * Additional keywords or phrases that should match the item. Used internally for user generated content. The maximum number of elements is 100. The maximum length is 8192 characters. */ - subject?: Schema$EnterpriseTopazSidekickCommonPerson; - } - /** - * An answer card for a list of people that are related to the subject of the query. - */ - export interface Schema$EnterpriseTopazSidekickPeopleAnswerRelatedPeopleAnswerCard { + keywords?: string[] | null; /** - * Disambiguation information. + * The original mime-type of ItemContent.content in the source repository. The maximum length is 256 characters. */ - disambiguationInfo?: Schema$EnterpriseTopazSidekickPeopleAnswerDisambiguationInfo; + mimeType?: string | null; /** - * The header to display for the card. + * The type of the item. This should correspond to the name of an object definition in the schema registered for the data source. For example, if the schema for the data source contains an object definition with name 'document', then item indexing requests for objects of that type should set objectType to 'document'. The maximum length is 256 characters. */ - header?: Schema$EnterpriseTopazSidekickPeopleAnswerPeopleAnswerCardHeader; + objectType?: string | null; /** - * A list of people that are related to the query subject. + * Additional search quality metadata of the item */ - relatedPeople?: Schema$EnterpriseTopazSidekickCommonPerson[]; + searchQualityMetadata?: Schema$SearchQualityMetadata; /** - * Defines the type of relation the list of people have with the subject of the card. + * Link to the source repository serving the data. Seach results apply this link to the title. Whitespace or special characters may cause Cloud Seach result links to trigger a redirect notice; to avoid this, encode the URL. The maximum length is 2048 characters. */ - relationType?: string | null; + sourceRepositoryUrl?: string | null; /** - * The response status. + * The title of the item. If given, this will be the displayed title of the Search result. The maximum length is 2048 characters. */ - responseStatus?: string | null; + title?: string | null; /** - * Localized user friendly message to display to the user in the case of missing data or an error. + * The time when the item was last modified in the source repository. */ - statusMessage?: string | null; + updateTime?: string | null; + } + /** + * This contains item's status and any errors. + */ + export interface Schema$ItemStatus { /** - * The profile of the person that was the subject of the query. + * Status code. */ - subject?: Schema$EnterpriseTopazSidekickCommonPerson; - } - export interface Schema$EnterpriseTopazSidekickPeopleDisambiguationCard { + code?: string | null; /** - * Candidate persons for the query. + * Error details in case the item is in ERROR state. */ - person?: Schema$EnterpriseTopazSidekickCommonPerson[]; + processingErrors?: Schema$ProcessingError[]; + /** + * Repository error reported by connector. + */ + repositoryErrors?: Schema$RepositoryError[]; } /** - * Person. + * Available structured data fields for the item. */ - export interface Schema$EnterpriseTopazSidekickPerson { - /** - * The level of affinity this person has with the requesting user. - */ - affinityLevel?: string | null; + export interface Schema$ItemStructuredData { /** - * Attendance status of the person when included in a meeting event. + * Hashing value provided by the API caller. This can be used with the items.push method to calculate modified state. The maximum length is 2048 characters. */ - attendingStatus?: string | null; + hash?: string | null; /** - * Email. + * The structured data object that should conform to a registered object definition in the schema for the data source. */ - email?: string | null; + object?: Schema$StructuredDataObject; + } + export interface Schema$ListDataSourceResponse { /** - * Gaia id. + * Token to retrieve the next page of results, or empty if there are no more results in the list. */ - gaiaId?: string | null; + nextPageToken?: string | null; + sources?: Schema$DataSource[]; + } + export interface Schema$ListItemNamesForUnmappedIdentityResponse { + itemNames?: string[] | null; /** - * Whether the invitee is a group. + * Token to retrieve the next page of results, or empty if there are no more results in the list. */ - isGroup?: boolean | null; + nextPageToken?: string | null; + } + export interface Schema$ListItemsResponse { + items?: Schema$Item[]; /** - * Name. + * Token to retrieve the next page of results, or empty if there are no more results in the list. */ - name?: string | null; + nextPageToken?: string | null; + } + /** + * The response message for Operations.ListOperations. + */ + export interface Schema$ListOperationsResponse { /** - * Obfuscated Gaia id. + * The standard List next-page token. */ - obfuscatedGaiaId?: string | null; + nextPageToken?: string | null; /** - * Absolute URL to the profile photo of the person. + * A list of operations that matches the specified filter in the request. */ - photoUrl?: string | null; + operations?: Schema$Operation[]; } /** - * Personalized docs card proto. + * List sources response. */ - export interface Schema$EnterpriseTopazSidekickPersonalizedDocsCardProto { + export interface Schema$ListQuerySourcesResponse { + nextPageToken?: string | null; + sources?: Schema$QuerySource[]; + } + export interface Schema$ListSearchApplicationsResponse { /** - * Document group. + * Token to retrieve the next page of results, or empty if there are no more results in the list. */ - documentGroup?: Schema$EnterpriseTopazSidekickDocumentGroup[]; + nextPageToken?: string | null; + searchApplications?: Schema$SearchApplication[]; } - export interface Schema$EnterpriseTopazSidekickPersonProfileCard { - relatedPeople?: Schema$EnterpriseTopazSidekickPersonProfileCardRelatedPeople[]; + export interface Schema$ListUnmappedIdentitiesResponse { /** - * The subject of the card. + * Token to retrieve the next page of results, or empty if there are no more results in the list. */ - subject?: Schema$EnterpriseTopazSidekickCommonPerson; + nextPageToken?: string | null; + unmappedIdentities?: Schema$UnmappedIdentity[]; } - export interface Schema$EnterpriseTopazSidekickPersonProfileCardRelatedPeople { + /** + * A set of featurelet annotations for an alternate policy. + */ + export interface Schema$LocationExtractorFeatureletAnnotationSet { /** - * Related people. + * The featurelet annotations for the alternate policy. */ - relatedPerson?: Schema$EnterpriseTopazSidekickCommonPerson[]; + annotations?: string[] | null; /** - * Relation type. + * The name of the alternate policy. */ - relation?: string | null; + name?: string | null; } /** - * Ranking params. + * An interpretation is a place on earth, an annotated query s-tree and a 'legend' grouping tokens into terms, and mapping those to the hierarchy of featurelets inside the location. An interpretation is returned as part of the LocationExtractionResponse and not meant to be used directly. Next tag: 15 */ - export interface Schema$EnterpriseTopazSidekickRankingParams { + export interface Schema$LocationExtractorInterpretation { /** - * The end-time that this object will expect to occur. If the type is marked as FIXED, then this end-time will persist after bidding. If the type is marked as FLEXIBLE, this field is NOT expected to be filled and will be filled in after it has won a bid. Expected to be set when type is set to FIXED. + * Location on Earth, containing featurelets ordered from most to least specific. These are referred to in the featurelet_index field below. In case of directions queries, this field contains departure location. */ - endTimeMs?: string | null; + location?: Schema$LocationExtractorLocation; /** - * The priority to determine between objects that have the same start_time_ms The lower-value of priority == ranked higher. Max-priority = 0. Expected to be set for all types. + * serialized s-expr annotated with :loc */ - priority?: string | null; + query?: string | null; + term?: Schema$LocationExtractorInterpretationTerm[]; + } + /** + * This group provides details about what we found in the query as a set of non-overlapping 'terms', each referring to a separate political feature. E.g. query of "Pizza near Mt View CA" would (in one of the geocodes) contain two terms: "Mt View" and "CA". All terms are given in left-to-right order. Note that not all featurelets necessarily occur as a term. Some may have been inferred from the political hierarchy. E.g. in the example above there would be a featurelet for the US after the one for "CA". + */ + export interface Schema$LocationExtractorInterpretationTerm { /** - * The score of the card to be used to break priority-ties + * index into location().featurelet() array (above). */ - score?: number | null; + featureletIndex?: number | null; /** - * The span that this card will take in the stream Expected to be set when type is set to FLEXIBLE. + * 1+last token covered by this term. */ - spanMs?: string | null; + tokenEnd?: number | null; /** - * The start-time that this object will bid-for If the type is marked as FIXED, then this start-time will persist after bidding. If the type is marked as FLEXIBLE, then it will occur at the given time or sometime after the requested time. Expected to be set for all types. + * These token indexes refer to the non-negated tokens of the query returned by the Interpretation. Note: That means you have to parse the query field with the SqueryParser, use QueryTreeUtils::FindOriginalNonNegatedWordNodes to get the original tokens, and use these 1-based indexes to retrieve the appropriate tokens from the result. You can NOT just split the original raw query on whitespace and use this as an offset. first token covered by this term. */ - startTimeMs?: string | null; + tokenStart?: number | null; /** - * The packing type of this object. + * Whether this term matched in a language that is "unexpected". For this purpose, expected languages are: request language, languages spoken in request country, English, unknown languages, and languages of the feature's country. */ - type?: string | null; - } - export interface Schema$EnterpriseTopazSidekickRecentDocumentsCardProto { - document?: Schema$EnterpriseTopazSidekickCommonDocument[]; + unexpectedLanguageMatch?: boolean | null; } /** - * Details about scheduled meetings. + * A Location message represents a geographical feature with an associated confidence level. Within a LocationExtractionServerResponse message, this message is used to specify possible locations of the user, and possible locations the user may be interested in. Next tag: 41 */ - export interface Schema$EnterpriseTopazSidekickScheduledMeeting { + export interface Schema$LocationExtractorLocation { /** - * The meeting location. + * Copy of FeatureProto-\>RankDetailsProto-\>address_rank */ - meetingLocation?: string | null; + addressRank?: number | null; /** - * The meeting time slot. + * Copy of FeatureProto-\>RankDetailsProto-\>area_rank */ - meetingTime?: Schema$EnterpriseTopazSidekickTimeSlot; + areaRank?: number | null; + boundingbox?: Schema$LocationExtractorLocationBoundingBox; + center?: Schema$LocationExtractorLocationCenter; /** - * The meeting title. + * Represents the Location Extraction Server's confidence that this Location is correct. */ - meetingTitle?: string | null; + confidence?: number | null; + featurelet?: Schema$LocationExtractorLocationFeaturelet[]; + /** + * Information about an ip block, like range, speed etc. + */ + ipblockinfo?: Schema$IPBlockInfoProto; + /** + * Copy of FeatureProto-\>RankDetailsProto-\>population_rank + */ + populationRank?: number | null; } /** - * Share meeting docs card proto. + * Defines the bounding box for the area. The values specify a rectangle defined from low to high. Latitude and longitude (in degrees) x 10,000,000. We use sfixed32 (fixed-size int32) because they get transmitted using 4 bytes while int32 gets transmitted using 10 bytes. */ - export interface Schema$EnterpriseTopazSidekickShareMeetingDocsCardProto { + export interface Schema$LocationExtractorLocationBoundingBox { + highLatitudeE7?: number | null; + highLongitudeE7?: number | null; + lowLatitudeE7?: number | null; + lowLongitudeE7?: number | null; + } + /** + * Latitude and longitude of the area center (in degrees) x 10,000,000 + */ + export interface Schema$LocationExtractorLocationCenter { + latitudeE7?: number | null; + longitudeE7?: number | null; + } + /** + * A LocationExtractionResponse message represents a response from the Location Extraction Server. If a location and / or area of interest was found, they will be included in the response. Next tag: 8 + */ + export interface Schema$LocationExtractorLocationExtractionResponse { /** - * Documents to share for the given meeting. + * The request.max_interpretation() most likely interpretations of the input sexpr or raw_query. The ordering of interpretations is determined by request.scorer(). */ - document?: Schema$EnterpriseTopazSidekickCommonDocument[]; + interpretation?: Schema$LocationExtractorInterpretation[]; /** - * Event. + * True if the results are unreliable, for example due to a deadline being broken. */ - event?: Schema$EnterpriseTopazSidekickAgendaEntry; + tainted?: boolean | null; + /** + * Represents the location of the end user, either from the ip or the user_address field in the request. For historical reasons, this is up to 3 separate locations that form a political hierarchy. See location/extractor/client/public/location.h:MergeLocations for a function to merge them into one. NOTE: the user_location does NOT influence the interpretations below. see the remarks about the ip field above. Conversely, this field is the ONLY field that changes depending on ip or user_address input. + */ + userLocation?: Schema$LocationExtractorLocation[]; } /** - * Slot of time. + * A location must have one or more Featurelets, each of which correspond to a single GeoStore Feature. The first Featurelet is considered to be the primary component of the location, and any additional Featurelets should be considered supplementary. For example, the Location "Brooklyn" might have Featurelets: 1) Brooklyn (borough) 2) New York (city) 3) New York (state) 4) United States (country) LINT.IfChange */ - export interface Schema$EnterpriseTopazSidekickTimeSlot { - /** - * Day end time at the user's timezone. - */ - endTimeDay?: string | null; + export interface Schema$LocationExtractorLocationFeaturelet { /** - * Hour and minute of the end time at the user's timezone. + * A field to attach additional data about the feature. For example, the location extraction server uses this field to include the ads criteria id of the featurelet if available. As specified by MessageSet, all types within the set must be unique. Using the changelist number where the message was created is a good method of ensuring uniqueness. */ - endTimeHourAndMinute?: string | null; + additionalData?: Schema$MessageSet; /** - * End time in milliseconds. + * Alternate annotations on this featurelet. */ - endTimeInMillis?: string | null; + alternateAnnotations?: Schema$LocationExtractorFeatureletAnnotationSet[]; /** - * Day start time at user's timezone. + * Annotations applied to this featurelet. This field is modified by the policy store. */ - startTimeDay?: string | null; + annotations?: string[] | null; /** - * Hour and minute of the start time at the user's timezone. + * Copy of FeatureProto-\>RankDetailsProto-\>area_rank */ - startTimeHourAndMinute?: string | null; + areaRank?: number | null; + boundingbox?: Schema$LocationExtractorLocationFeatureletBoundingBox; + center?: Schema$LocationExtractorLocationFeatureletCenter; /** - * Start time in milliseconds. + * Represents the Location Extraction Server's confidence that this featurelet is correct. This is currently not populated by LES. Oolong will parse the LES response for IP addreses and combine multiple locations into a single location with multiple featurelets. This confidence will be populated by Oolong by looking into confidences from each of the locations. */ - startTimeInMillis?: string | null; - } - /** - * Used to provide a search operator for enum properties. This is optional. Search operators let users restrict the query to specific fields relevant to the type of item being searched. For example, if you provide no operator for a *priority* enum property with possible values *p0* and *p1*, a query that contains the term *p0* returns items that have *p0* as the value of the *priority* property, as well as any items that contain the string *p0* in other fields. If you provide an operator name for the enum, such as *priority*, then search users can use that operator to refine results to only items that have *p0* as this property's value, with the query *priority:p0*. - */ - export interface Schema$EnumOperatorOptions { + confidence?: number | null; /** - * Indicates the operator name required in the query in order to isolate the enum property. For example, if operatorName is *priority* and the property's name is *priorityVal*, then queries like *priority:* show results only where the value of the property named *priorityVal* matches **. By contrast, a search that uses the same ** without an operator returns all items where ** matches the value of any String properties or text within the content field for the item. The operator name can only contain lowercase letters (a-z). The maximum length is 32 characters. + * This field contains original feature's establishment type if it had one. */ - operatorName?: string | null; - } - /** - * The options for enum properties, which allow you to define a restricted set of strings to match user queries, set rankings for those string values, and define an operator name to be paired with those strings so that users can narrow results to only items with a specific value. For example, for items in a request tracking system with priority information, you could define *p0* as an allowable enum value and tie this enum to the operator name *priority* so that search users could add *priority:p0* to their query to restrict the set of results to only those items indexed with the value *p0*. - */ - export interface Schema$EnumPropertyOptions { + establishmentType?: string | null; /** - * If set, describes how the enum should be used as a search operator. + * The GeoStore Feature ID for this feature. This field will be present when the featurelet was derived from or maps to an oyster feature. */ - operatorOptions?: Schema$EnumOperatorOptions; + featureId?: Schema$GeostoreFeatureIdProto; /** - * Used to specify the ordered ranking for the enumeration that determines how the integer values provided in the possible EnumValuePairs are used to rank results. If specified, integer values must be provided for all possible EnumValuePair values given for this property. Can only be used if isRepeatable is false. + * The reference to an entity in the KnowledgeGraph. */ - orderedRanking?: string | null; + kgReference?: Schema$GeostoreKnowledgeGraphReferenceProto; /** - * The list of possible values for the enumeration property. All EnumValuePairs must provide a string value. If you specify an integer value for one EnumValuePair, then all possible EnumValuePairs must provide an integer value. Both the string value and integer value must be unique over all possible values. Once set, possible values cannot be removed or modified. If you supply an ordered ranking and think you might insert additional enum values in the future, leave gaps in the initial integer values to allow adding a value in between previously registered values. The maximum number of elements is 100. + * Each Featurelet includes the list of names that are associated with the corresponding GeoStore Feature. */ - possibleValues?: Schema$EnumValuePair[]; - } - /** - * The enumeration value pair defines two things: a required string value and an optional integer value. The string value defines the necessary query term required to retrieve that item, such as *p0* for a priority item. The integer value determines the ranking of that string value relative to other enumerated values for the same property. For example, you might associate *p0* with *0* and define another enum pair such as *p1* and *1*. You must use the integer value in combination with ordered ranking to set the ranking of a given value relative to other enumerated values for the same property name. Here, a ranking order of DESCENDING for *priority* properties results in a ranking boost for items indexed with a value of *p0* compared to items indexed with a value of *p1*. Without a specified ranking order, the integer value has no effect on item ranking. - */ - export interface Schema$EnumValuePair { + name?: Schema$GeostoreNameProto[]; /** - * The integer value of the EnumValuePair which must be non-negative. Optional. + * Copy of FeatureProto-\>RankDetailsProto-\>population_rank */ - integerValue?: number | null; + populationRank?: number | null; /** - * The string value of the EnumValuePair. The maximum length is 32 characters. + * The GeoStore Feature type. */ - stringValue?: string | null; + type?: string | null; } /** - * List of enum values. + * Defines the bounding box for the area. The values specify a rectangle defined from low to high. Latitude and longitude (in degrees) x 10,000,000. We use sfixed32 (fixed size int32) because they get transmitted using 4 bytes while int32 gets transmitted using 10 bytes. This is currently not populated by LES. Oolong will parse the LES response for IP addreses and combine multiple locations into a single location with multiple featurelets. This will be populated by Oolong by looking into bounding boxes from each location. */ - export interface Schema$EnumValues { - /** - * The maximum allowable length for string values is 32 characters. - */ - values?: string[] | null; + export interface Schema$LocationExtractorLocationFeatureletBoundingBox { + highLatitudeE7?: number | null; + highLongitudeE7?: number | null; + lowLatitudeE7?: number | null; + lowLongitudeE7?: number | null; } /** - * Error information about the response. + * Latitude and longitude of the feature center (in degrees) x 10,000,000 */ - export interface Schema$ErrorInfo { - errorMessages?: Schema$ErrorMessage[]; + export interface Schema$LocationExtractorLocationFeatureletCenter { + latitudeE7?: number | null; + longitudeE7?: number | null; } /** - * Error message per source response. + * Represents a detected activity record. Next id 3. */ - export interface Schema$ErrorMessage { - errorMessage?: string | null; - source?: Schema$Source; + export interface Schema$LocationUnifiedActivityRecord { + /** + * The confidence of the detection. Range is [0, 100]. + */ + confidence?: number | null; + /** + * The type of activity. + */ + type?: string | null; } /** - * A bucket in a facet is the basic unit of operation. A bucket can comprise either a single value OR a contiguous range of values, depending on the type of the field bucketed. FacetBucket is currently used only for returning the response object. + * A set of annotations (e.g., those applied by some particular policy). Next tag: 6 */ - export interface Schema$FacetBucket { + export interface Schema$LocationUnifiedAnnotationSet { /** - * Number of results that match the bucket value. Counts are only returned for searches when count accuracy is ensured. Cloud Search does not guarantee facet counts for any query and facet counts might be present only intermittently, even for identical queries. Do not build dependencies on facet count existence; instead use facet ount percentages which are always returned. + * The annotations that have been applied by some policy. */ - count?: number | null; + annotations?: Schema$LocationUnifiedLocationAnnotation[]; /** - * Filter to be passed in the search request if the corresponding bucket is selected. + * If set then this set of annotations are originating from this client id for production use. */ - filter?: Schema$Filter; + clientId?: string | null; /** - * Percent of results that match the bucket value. The returned value is between (0-100], and is rounded down to an integer if fractional. If the value is not explicitly returned, it represents a percentage value that rounds to 0. Percentages are returned for all searches, but are an estimate. Because percentages are always returned, you should render percentages instead of counts. + * The name of this set. */ - percentage?: number | null; - value?: Schema$Value; + name?: string | null; + /** + * The policy result that corresponds to the alternate policy. + */ + policyResult?: Schema$LocationUnifiedPolicyResult; + /** + * The source description for this result in the alternate policy. + */ + sourceDescription?: string | null; + } + export interface Schema$LocationUnifiedExtractorFlags { + gwsJurisdictionCountryExtractorEnabled?: boolean | null; + hostDomainExtractorEnabled?: boolean | null; + ipAlternateExtractorEnabled?: boolean | null; + ipExtractorEnabled?: boolean | null; + /** + * If true, any query found in the request will be included in geocoding and the location context. + */ + queryExtractorEnabled?: boolean | null; + uuleCookieExtractorEnabled?: boolean | null; + xgeoHeaderExtractorEnabled?: boolean | null; } /** - * Specifies operators to return facet results for. There will be one FacetResult for every source_name/object_type/operator_name combination. + * A copy of //geostore/base/proto/featureid.proto. Because Oolong descriptors are intended to be publicly available, we don't want to depend on other protos. This proto is tag-compatible with the original. Note that this could be used for non-Oyster identifiers if distinguished by some appropriate producer. Otherwise, it is assumed to be an Oyster ID. The code in logs/storage/validator/logs_validator_traits.cc treats this type as if it were annotated as ST_LOCATION. */ - export interface Schema$FacetOptions { + export interface Schema$LocationUnifiedFeatureIdProto { /** - * If set, describes integer faceting options for the given integer property. The corresponding integer property in the schema should be marked isFacetable. The number of buckets returned would be minimum of this and num_facet_buckets. + * The S2CellId corresponding to the approximate centroid of this feature. */ - integerFacetingOptions?: Schema$IntegerFacetingOptions; + cellId?: string | null; /** - * Maximum number of facet buckets that should be returned for this facet. Defaults to 10. Maximum value is 100. + * A 64-bit fingerprint used to distinguish between multiple features at the same location. */ - numFacetBuckets?: number | null; + fprint?: string | null; + } + /** + * A featurelet in the location result's hierarchy. This references the feature pool for base data (like names and geometry), and contains additional fields that are set by the policy. + */ + export interface Schema$LocationUnifiedFeatureReference { /** - * If object_type is set, only those objects of that type will be used to compute facets. If empty, then all objects will be used to compute facets. + * Alternate annotations applied to this featurelet. */ - objectType?: string | null; + alternateAnnotations?: Schema$LocationExtractorFeatureletAnnotationSet[]; /** - * The name of the operator chosen for faceting. @see cloudsearch.SchemaPropertyOptions + * Annotations applied to this featurelet by the policy store. */ - operatorName?: string | null; + annotations?: string[] | null; /** - * Source name to facet on. Format: datasources/{source_id\} If empty, all data sources will be used. + * The confidence that this featurelet is correct. */ - sourceName?: string | null; + confidence?: number | null; + /** + * The feature ID, which is used as key for looking up the featurelet from the LocationContext's feature pool. + */ + featureId?: Schema$GeostoreFeatureIdProto; } /** - * Source specific facet response + * A description of the field of view of a camera. Used in conjunction with location and rotation to indicate how much of a scene is being rendered inside the camera. */ - export interface Schema$FacetResult { - /** - * FacetBuckets for values in response containing at least a single result with the corresponding filter. - */ - buckets?: Schema$FacetBucket[]; + export interface Schema$LocationUnifiedFieldOfView { /** - * Object type for which facet results are returned. Can be empty. + * Horizontal degrees of view, i.e. the angle between the left and right clipping planes. */ - objectType?: string | null; + fieldOfViewXDegrees?: number | null; /** - * The name of the operator chosen for faceting. @see cloudsearch.SchemaPropertyOptions + * Vertical degrees of view, i.e. the angle between the top and bottom clipping planes. */ - operatorName?: string | null; + fieldOfViewYDegrees?: number | null; /** - * Source name for which facet results are returned. Will not be empty. + * Pixel dimensions of a device screen. This is currently only used by Tactile and should not be used elsewhere without good reason, at which point we would probably rename the field. Pixels are assumed to be square. */ - sourceName?: string | null; + screenWidthPixels?: number | null; } - export interface Schema$FieldViolation { + export interface Schema$LocationUnifiedInterpretationData { /** - * The description of the error. + * Serialized s-expr annotated with :loc. */ - description?: string | null; + query?: string | null; /** - * Path of field with violation. + * This group provides details about what we found in the query as a set of non-overlapping 'terms', each referring to a separate political feature. E.g. query of "Pizza near Mt View CA" would (in one of the geocodes) contain two terms: "Mt View" and "CA". All terms are given in left-to-right order. Note that not all featurelets necessarily occur as a term. Some may have been inferred from the political hierarchy. E.g. in the example above there would be a featurelet for the US after the one for "CA". */ - field?: string | null; + term?: Schema$LocationExtractorInterpretationTerm[]; } /** - * A generic way of expressing filters in a query, which supports two approaches: **1. Setting a ValueFilter.** The name must match an operator_name defined in the schema for your data source. **2. Setting a CompositeFilter.** The filters are evaluated using the logical operator. The top-level operators can only be either an AND or a NOT. AND can appear only at the top-most level. OR can appear only under a top-level AND. + * A latitude and longitude used to describe a point. Units are degrees x 10^7 and rounded to the nearest integer). When used to describe a point, the latitudes should be in the range +/- 90 degrees and the longitude should be in the range +/- 180 degrees (inclusive). LatLng message was also used to describe a span, but it turns out full longitude span (360 degrees * 10^7) does not fit in signed int32. Thus, using LatLng for a span is deprecated. Please use LatLngRect instead. The code in logs/storage/validator/logs_validator_traits.cc treats this type as if it were annotated as ST_LOCATION. */ - export interface Schema$Filter { - compositeFilter?: Schema$CompositeFilter; - valueFilter?: Schema$ValueFilter; + export interface Schema$LocationUnifiedLatLng { + latitudeE7?: number | null; + longitudeE7?: number | null; } /** - * Filter options to be applied on query. + * A latitude-longitude rectangle, represented as two diagonally opposite points "lo" and "hi". The rectangle is considered to be a closed region, i.e. it includes its boundary. The latitude bounds must be in the range -90 to 90 degrees inclusive, and the longitude bounds must be in the range -180 to 180 degrees inclusive. Both points must be normalized, with lo.latitude <= hi.latitude. If lo.latitude \> hi.latitude, the latitude range is considered empty and there will be a warning the first 100 times Oolong sees such proto. "lo" point is the lower-left corner and "hi" point is the upper-right corner of the resulting rectangle. Various special cases include: - If lo == hi, the rectangle consists of a single point. - If lo.longitude \> hi.longitude, the longitude range is "inverted" (the rectangle crosses the 180 degree longitude line). - If lo.longitude == -180 degrees and hi.longitude = 180 degrees, the rectangle includes all longitudes. - If lo.longitude = 180 degrees and hi.longitude = -180 degrees, the longitude range is empty. The code in logs/storage/validator/logs_validator_traits.cc treats this type as if it were annotated as ST_LOCATION. */ - export interface Schema$FilterOptions { + export interface Schema$LocationUnifiedLatLngRect { + hi?: Schema$LocationUnifiedLatLng; + lo?: Schema$LocationUnifiedLatLng; + } + /** + * Used to distinguish locations within a location context (e.g., indicate those locations selected by a policy). + */ + export interface Schema$LocationUnifiedLocationAnnotation { /** - * Generic filter to restrict the search, such as `lang:en`, `site:xyz`. + * Optional debug information associated with this annotation. For human consumption only. */ - filter?: Schema$Filter; + details?: string | null; /** - * If object_type is set, only objects of that type are returned. This should correspond to the name of the object that was registered within the definition of schema. The maximum length is 256 characters. + * Indicates the purpose of this annotation. */ - objectType?: string | null; + type?: string | null; } /** - * Indicates which freshness property to use when adjusting search ranking for an item. Fresher, more recent dates indicate higher quality. Use the freshness option property that best works with your data. For fileshare documents, last modified time is most relevant. For calendar event data, the time when the event occurs is a more relevant freshness indicator. In this way, calendar events that occur closer to the time of the search query are considered higher quality and ranked accordingly. + * Supplemental attributes for a location that may affect search results. Next Id: 24 */ - export interface Schema$FreshnessOptions { + export interface Schema$LocationUnifiedLocationAttributesProto { /** - * The duration after which an object should be considered stale. The default value is 180 days (in seconds). + * The user detected activity. */ - freshnessDuration?: string | null; + activityRecord?: Schema$LocationUnifiedActivityRecord[]; /** - * This property indicates the freshness level of the object in the index. If set, this property must be a top-level property within the property definitions and it must be a timestamp type or date type. Otherwise, the Indexing API uses updateTime as the freshness indicator. The maximum length is 256 characters. When a property is used to calculate freshness, the value defaults to 2 years from the current time. + * Confidence for use in ads. Might be different from the confidence in the descriptor. Currently only used for locations with producer TRAVEL_STATE_INTENT. */ - freshnessProperty?: string | null; - } - export interface Schema$GetCustomerIndexStatsResponse { + adsConfidence?: number | null; /** - * Average item count for the given date range for which billing is done. + * Altitude in meters, from ground level. */ - averageIndexedItemCount?: string | null; + altitudeMetersFromGround?: number | null; /** - * Summary of indexed item counts, one for each day in the requested range. + * The accuracy of bearing in degrees, based on GMS Core calculations on two latest location points. The actual bearing should be within bearing_degrees ± bearing_accuracy_degrees. */ - stats?: Schema$CustomerIndexStats[]; - } - export interface Schema$GetCustomerQueryStatsResponse { - stats?: Schema$CustomerQueryStats[]; + bearingAccuracyDegrees?: number | null; /** - * Total successful query count (status code 200) for the given date range. + * The direction in degrees in which the client device was moving. Must be in the range 0 to 359. 0 represents north and 90 is east. */ - totalQueryCount?: string | null; - } - /** - * Response format for search application stats for a customer. - */ - export interface Schema$GetCustomerSearchApplicationStatsResponse { + bearingDegrees?: number | null; /** - * Average search application count for the given date range. + * An opaque token to represent a transit vehicle that a user is riding. This field is always server generated and encoding scheme is determined by the server. Currently, Tactile's local encoding (web-safe base64 prefixed by "B") is used. */ - averageSearchApplicationCount?: string | null; + boardedTransitVehicleToken?: string | null; + carrierIpType?: string | null; /** - * Search application stats by date. + * FOR OOLONG INTERNAL USE ONLY! TODO(b/142046202) Migrate this field outside of Location Descriptor. Ratio of device location versus other signals that we have for this user. Note that this is a per-user attribute, not a per-location attribute. */ - stats?: Schema$CustomerSearchApplicationStats[]; - } - export interface Schema$GetCustomerSessionStatsResponse { - stats?: Schema$CustomerSessionStats[]; - } - export interface Schema$GetCustomerUserStatsResponse { - stats?: Schema$CustomerUserStats[]; - } - export interface Schema$GetDataSourceIndexStatsResponse { + deviceLocationRatio?: number | null; /** - * Average item count for the given date range for which billing is done. + * The field of view of a camera. */ - averageIndexedItemCount?: string | null; + fieldOfView?: Schema$LocationUnifiedFieldOfView; /** - * Summary of indexed item counts, one for each day in the requested range. + * The direction in degrees in which the client device was pointed. Must be in the range 0 to 359. 0 represents north and 90 is east. */ - stats?: Schema$DataSourceIndexStats[]; + headingDegrees?: number | null; + inference?: string | null; + ipRangeConfidence?: number | null; + manualEntry?: string | null; + /** + * FOR OOLONG INTERNAL USE ONLY! TODO(b/142046202) Migrate this field outside of Location Descriptor. Additional Oolong-specific attributes of the location. + */ + personalizedLocationAttributes?: Schema$LocationUnifiedPersonalizedLocationAttributes; + /** + * FOR OOLONG INTERNAL USE ONLY! TODO(b/142046202) Migrate this field outside of Location Descriptor. Total number of locations (across all events) used in PLM inference. + */ + plmSourceLocationCount?: number | null; + plmType?: string | null; + /** + * Clockwise rotation around the line of sight (i.e. vector (0, 0, -1) in Eye Coords). Zero means that y points up in Screen Coords; 180 gives an upside down view, where y points down in Screen Coords. Allowed range is [0, 360). For out-of-range values, the behavior is undefined. + */ + rollDegrees?: number | null; + /** + * The accuracy of the speed in kilometers per hour, meaning that the actual speed should be within speed_kph ± speed_accuracy_kph. + */ + speedAccuracyKph?: number | null; + /** + * The speed in kilometers per hour at which the client device was moving. + */ + speedKph?: number | null; + /** + * Rotation where zero points down, 180 points up and 90 points to horizon. Allowed range is [0, 180]. For out-of-range values, the behavior is undefined. + */ + tiltDegrees?: number | null; + viewportSearchOptions?: string | null; + weekSecondConfidence?: number | null; } /** - * Response format for getting query stats for a search application between given dates. + * A container for passing and processing the set of locations associated with a particular request. Next available tag: 11 */ - export interface Schema$GetSearchApplicationQueryStatsResponse { + export interface Schema$LocationUnifiedLocationContext { /** - * Query stats per date for a search application. + * The client ID that was used for annotating this location context (if any). This field is set accordingly by the policy annotation. */ - stats?: Schema$SearchApplicationQueryStats[]; + clientId?: string | null; /** - * Total successful query count (status code 200) for the given date range. + * Flags to customize the extractors used to build this location context. */ - totalQueryCount?: string | null; - } - export interface Schema$GetSearchApplicationSessionStatsResponse { - stats?: Schema$SearchApplicationSessionStats[]; - } - export interface Schema$GetSearchApplicationUserStatsResponse { - stats?: Schema$SearchApplicationUserStats[]; - } - export interface Schema$GSuitePrincipal { + extractorFlags?: Schema$LocationUnifiedExtractorFlags; + /** + * The feature pool used in the location results. This is a map from feature ID to feature data, but since the feature ID is part of the Featurelet data, just a repeated field enumerating them is enough. + */ + featurePool?: Schema$LocationUnifiedOolongFeature[]; + /** + * True if the location context originates from the Hulk Realtime plugin in GWS: go/hulk-realtime-in-search-ads. + */ + fromHulkRealtime?: boolean | null; /** - * This principal represents all users of the Google Workspace domain of the customer. + * If true, only a selected list of descriptors will be added to this context by the standard library functions. This is so that debug parameters can be used to override the context reliably. The descriptors that can be added is determined by the lock_strategy enum. Note that policies may override and ignore this flag altogether. */ - gsuiteDomain?: boolean | null; + lockedForDebug?: boolean | null; /** - * This principal references a Google Workspace group name. + * If true, the location context should be kept as is, no policy should modify it, except for: setting the client id and adding qref location. */ - gsuiteGroupEmail?: string | null; + lockedForPolicy?: boolean | null; /** - * This principal references a Google Workspace user account. + * Defines which roles/producers can be added/edit for the context. This field is used only when locked_for_debug flag is set. */ - gsuiteUserEmail?: string | null; - } - /** - * Used to provide a search operator for html properties. This is optional. Search operators let users restrict the query to specific fields relevant to the type of item being searched. - */ - export interface Schema$HtmlOperatorOptions { + lockStrategy?: string | null; + nonstandardData?: Schema$MessageSet; /** - * Indicates the operator name required in the query in order to isolate the html property. For example, if operatorName is *subject* and the property's name is *subjectLine*, then queries like *subject:* show results only where the value of the property named *subjectLine* matches **. By contrast, a search that uses the same ** without an operator return all items where ** matches the value of any html properties or text within the content field for the item. The operator name can only contain lowercase letters (a-z). The maximum length is 32 characters. + * Information about the origin of the location context. This is used to validate that the location context was created through a valid means, which is Oolong. DO NOT SET THIS FIELD YOURSELF. In fact, do not construct location contexts yourself. */ - operatorName?: string | null; + origin?: Schema$LocationUnifiedLocationContextOrigin; + results?: Schema$LocationUnifiedLocationResult[]; } /** - * The options for html properties. + * This message stores information about how a location context was created. It is restricted in visibility to Oolong code only, so that it provides a way to easily identify location contexts that have been created from external code. (Which should NOT be done ever.) Next ID: 3 */ - export interface Schema$HtmlPropertyOptions { + export interface Schema$LocationUnifiedLocationContextOrigin { /** - * If set, describes how the property should be used as a search operator. + * Sequence of Dejitter modifications applied to the associated LocationContext. For monitoring and debugging use only; it should be safe to remove or change the contents of this field at any time. */ - operatorOptions?: Schema$HtmlOperatorOptions; + dejitterModifications?: string[] | null; /** - * Indicates the search quality importance of the tokens within the field when used for retrieval. Can only be set to DEFAULT or NONE. + * The origin of the LocationContext. May be updated by restricted Oolong libraries that modify the LocationContext after it was returned. Some Apps Framework services use this in their location propagation logic to decide whether a LocationContext is suitable for propagating to backends. */ - retrievalImportance?: Schema$RetrievalImportance; + type?: string | null; } /** - * List of html values. + * A LocationDescriptor is the minimal specification of a location together with its role and producer. The location "payload" can be specified by a variety of means (e.g., an address, an ip address, GPS coordinates, etc.) but only a single means should be used. DO NOT COMBINE MULTIPLE SPECIFICATIONS INTO A SINGLE DESCRIPTOR (e.g., a freeform street address and lat/long together). Next Id: 27 */ - export interface Schema$HtmlValues { - /** - * The maximum allowable length for html values is 2048 characters. - */ - values?: string[] | null; - } - export interface Schema$IndexItemOptions { + export interface Schema$LocationUnifiedLocationDescriptor { /** - * Specifies if the index request should allow Google Workspace principals that do not exist or are deleted. + * A 128-bit feature consisting of an S2Cell and a unique feature identifier. Should be unused outside of the internal applications by the Oolong team. */ - allowUnknownGsuitePrincipals?: boolean | null; - } - export interface Schema$IndexItemRequest { + additionalFeatureId?: Schema$LocationUnifiedFeatureIdProto; /** - * The name of connector making this call. Format: datasources/{source_id\}/connectors/{ID\} + * Supplemental attributes for a location that are not related to geocoding, but still may affect search results. */ - connectorName?: string | null; + attributes?: Schema$LocationUnifiedLocationAttributesProto; /** - * Common debug options. + * A confidence measure. Percentage: must be 0 to 100. */ - debugOptions?: Schema$DebugOptions; - indexItemOptions?: Schema$IndexItemOptions; + confidence?: number | null; /** - * The name of the item. Format: datasources/{source_id\}/items/{item_id\} + * WARNING: Do not use this field without talking to the oolong-team@ first. It should never contain any Personal Identification Information (PII). You can use this field to provide diagnostic information about the location extraction code. Some examples could include the latency of getting the location, the fact that it was retrieved from the cache or not, the reason for not providing the location, software version (if that cannot be used to identify the user). Make sure to prepare a PDD that describes what is stored in this field for your project before using the field. */ - item?: Schema$Item; + diagnosticInfo?: string | null; /** - * Required. The RequestMode for this request. + * A 128-bit feature consisting of an S2Cell and a unique feature identifier. */ - mode?: string | null; - } - /** - * Request message for `InitializeCustomer` method. - */ - export interface Schema$InitializeCustomerRequest {} - /** - * Used to specify integer faceting options. - */ - export interface Schema$IntegerFacetingOptions { + featureId?: Schema$LocationUnifiedFeatureIdProto; /** - * Buckets for given integer values should be in strictly ascending order. For example, if values supplied are (1,5,10,100), the following facet buckets will be formed {<1, [1,5), [5-10), [10-100), \>=100\}. + * This field is intended for recording the producer of a historical location. It will be populated for a descriptor with role HISTORICAL_LOCATION, using the producer of the original descriptor. To enable location history to be sent via an untrusted source to a frontend, you should make sure that the historical_role-historical_producer pair of the descriptor also appears on the untrusted allowlist used by the frontend. */ - integerBuckets?: string[] | null; - } - /** - * Used to provide a search operator for integer properties. This is optional. Search operators let users restrict the query to specific fields relevant to the type of item being searched. - */ - export interface Schema$IntegerOperatorOptions { + historicalProducer?: string | null; /** - * Indicates the operator name required in the query in order to isolate the integer property using the greater-than operator. For example, if greaterThanOperatorName is *priorityabove* and the property's name is *priorityVal*, then queries like *priorityabove:* show results only where the value of the property named *priorityVal* is greater than **. The operator name can only contain lowercase letters (a-z). The maximum length is 32 characters. + * This field is intended for recording frequency of historical location usage. Do not use it unless you know the historical producer intention for this field. DEPRECATED: This is no longer used or populated. */ - greaterThanOperatorName?: string | null; + historicalProminence?: number | null; /** - * Indicates the operator name required in the query in order to isolate the integer property using the less-than operator. For example, if lessThanOperatorName is *prioritybelow* and the property's name is *priorityVal*, then queries like *prioritybelow:* show results only where the value of the property named *priorityVal* is less than **. The operator name can only contain lowercase letters (a-z). The maximum length is 32 characters. + * This field is intended for recording the role of a historical location. It will be populated for a descriptor with role HISTORICAL_LOCATION, using the role of the original descriptor. To enable location history to be sent via an untrusted source to a frontend, you should make sure that the historical_role-historical_producer pair of the descriptor also appears on the untrusted allowlist used by the frontend. */ - lessThanOperatorName?: string | null; + historicalRole?: string | null; /** - * Indicates the operator name required in the query in order to isolate the integer property. For example, if operatorName is *priority* and the property's name is *priorityVal*, then queries like *priority:* show results only where the value of the property named *priorityVal* matches **. By contrast, a search that uses the same ** without an operator returns all items where ** matches the value of any String properties or text within the content field for the item. The operator name can only contain lowercase letters (a-z). The maximum length is 32 characters. + * The language used previously for query geocoding, set to the frontend language of the user during extraction. DO NOT USE THIS TO GET A USER'S LANGUAGE. INSTEAD, GET THE LANGUAGE FROM THE FrontendRequest OR THROUGH ANOTHER API! THIS FIELD WILL GO AWAY. */ - operatorName?: string | null; - } - /** - * The options for integer properties. - */ - export interface Schema$IntegerPropertyOptions { + language?: string | null; /** - * If set, describes integer faceting options for the given integer property. The corresponding integer property should be marked isFacetable. + * A latitude and longitude used to describe this location as a point. */ - integerFacetingOptions?: Schema$IntegerFacetingOptions; + latlng?: Schema$LocationUnifiedLatLng; /** - * The maximum value of the property. The minimum and maximum values for the property are used to rank results according to the ordered ranking. Indexing requests with values greater than the maximum are accepted and ranked with the same weight as items indexed with the maximum value. + * The span of a bounding box whose center is latlng. Specifies the lengths of the sides of the box and is valid only if latlng is present. DEPRECATED(6/6/2012): b/5979511. Use 'rect' instead. */ - maximumValue?: string | null; + latlngSpan?: Schema$LocationUnifiedLatLng; /** - * The minimum value of the property. The minimum and maximum values for the property are used to rank results according to the ordered ranking. Indexing requests with values less than the minimum are accepted and ranked with the same weight as items indexed with the minimum value. + * A 128-bit feature ID for the (indoor) level/floor of this location. If present, the floor supplements other location attributes in this descriptor. For example, in shopping malls it is quite common that one store occupies rooms on multiple levels, connected with escalators. The user can be at the exact same lat/lng and at the same GAP store, but on different levels. */ - minimumValue?: string | null; + levelFeatureId?: Schema$LocationUnifiedFeatureIdProto; /** - * If set, describes how the integer should be used as a search operator. + * The number of this location's level relative to the ground floor. 0 means ground floor; -2 is two levels below ground; +0.5 is a mezzanine. */ - operatorOptions?: Schema$IntegerOperatorOptions; + levelNumber?: number | null; /** - * Used to specify the ordered ranking for the integer. Can only be used if isRepeatable is false. + * A string containing the location payload. The format of this string may depend on the producer but it should be otherwise be treated like a freeform, human-readable string (a query, a street address, city name, postal code, district name, country, etc.). Other, producer-specific formats include IP address, host domain, and squery. time zone. Note that for some producers there is no guarantee that the string contains a valid location (e.g., a query for [pizza]). */ - orderedRanking?: string | null; - } - /** - * List of integer values. - */ - export interface Schema$IntegerValues { - values?: string[] | null; - } - /** - * Represents an interaction between a user and an item. - */ - export interface Schema$Interaction { + loc?: string | null; /** - * The time when the user acted on the item. If multiple actions of the same type exist for a single user, only the most recent action is recorded. + * A 64-bit machine identifier of a geo feature in Freebase. */ - interactionTime?: string | null; + mid?: string | null; /** - * The user that acted on the item. + * The granularity of the location permissions that was present to get the device location that this location descriptor represents. Only relevant for device locations. */ - principal?: Schema$Principal; - type?: string | null; - } - /** - * Represents a single object that is an item in the search index, such as a file, folder, or a database record. - */ - export interface Schema$Item { + permissionGranularity?: string | null; /** - * Access control list for this item. + * The presence intervals associated with the location. Required for FUTURE_LOCATION signals. This field should not be logged anywhere. */ - acl?: Schema$ItemAcl; + presenceInterval?: Schema$LocationUnifiedPresenceInterval[]; /** - * Item content to be indexed and made text searchable. + * The producer of this location. */ - content?: Schema$ItemContent; + producer?: string | null; /** - * The type for this item. + * Extra information about how this descriptor was obtained. Provenance is intended for logging non-semantic details about a descriptor (e.g., whether it was passed using a particular parameter or stored in a particular backend). It should *never* be used as a criterion for selection by a policy or backend (use role/producer instead). This is for bookkeeping only. You don't want this field. Really. */ - itemType?: string | null; + provenance?: string | null; /** - * The metadata information. + * The radius within which one standard deviation (or 68%) of possible locations lie, assuming a normal distribution around latlng. This radius is normally seen in the UI of mobile maps as the blue 'accuracy circle', although the interpretation (e.g. 1sd or 2sd) may vary by platform. Units must be in mm. */ - metadata?: Schema$ItemMetadata; + radius?: number | null; /** - * The name of the Item. Format: datasources/{source_id\}/items/{item_id\} This is a required field. The maximum length is 1536 characters. + * A viewport or bounds depending on role/producer. For example, when role is VIEWPORT this field represents a viewport. 'latlng' and 'rect' are mutually exclusive. */ - name?: string | null; + rect?: Schema$LocationUnifiedLatLngRect; /** - * Additional state connector can store for this item. The maximum length is 10000 bytes. + * The role of this location. */ - payload?: string | null; + role?: string | null; /** - * Queue this item belongs to. The maximum length is 100 characters. + * Some producers may additionally specify semantics explaining the meaning of a location, in particular to differentiate several locations with the same producer. */ - queue?: string | null; + semantic?: string[] | null; /** - * Status of the item. Output only field. + * If there are multiple semantic places, then the first place is the finest, then come the parent hierarchy. This field should not be logged anywhere. */ - status?: Schema$ItemStatus; + semanticPlace?: Schema$LocationUnifiedSemanticPlace[]; /** - * The structured data for the item that should conform to a registered object definition in the schema for the data source. + * A timestamp associated with this location expressed as the number of microseconds since 00:00:00 Jan-1-1970 UTC. If not set, assumed to be "now" or irrelevant. Use this field to indicate when this location has been acquired (e.g. by requesting location from the device). */ - structuredData?: Schema$ItemStructuredData; + timestamp?: string | null; /** - * Required. The indexing system stores the version from the datasource as a byte string and compares the Item version in the index to the version of the queued Item using lexical ordering. Cloud Search Indexing won't index or delete any queued item with a version value that is less than or equal to the version of the currently indexed item. The maximum length for this field is 1024 bytes. For information on how item version affects the deletion process, refer to [Handle revisions after manual deletes](https://developers.google.com/cloud-search/docs/guides/operations). + * A list of visible networks that describe the location and can geocoded by GLS. This field should not be logged anywhere. */ - version?: string | null; + visibleNetwork?: Schema$LocationUnifiedVisibleNetwork[]; } /** - * Access control list information for the item. For more information see [Map ACLs](https://developers.google.com/cloud-search/docs/guides/acls). + * All information about a single location within a context. This includes the descriptor, which can be thought of as a kind of "query" that minimally specifies the location, and rest (i.e., geocoding data, policy annotations, etc.). A LocationResult typically starts with just a descriptor and the rest is added later via lookups. If necessary, persistent locations can be stored as a pre-geocoded LocationResult to avoid the extra work. Next Available Tag: 14 */ - export interface Schema$ItemAcl { + export interface Schema$LocationUnifiedLocationResult { /** - * Sets the type of access rules to apply when an item inherits its ACL from a parent. This should always be set in tandem with the inheritAclFrom field. Also, when the inheritAclFrom field is set, this field should be set to a valid AclInheritanceType. + * Additional sets of annotations from other oolong policies. */ - aclInheritanceType?: string | null; + alternateAnnotations?: Schema$LocationUnifiedAnnotationSet[]; /** - * List of principals who are explicitly denied access to the item in search results. While principals are denied access by default, use denied readers to handle exceptions and override the list allowed readers. The maximum number of elements is 100. + * The annotations that have been applied to this result for use in production. */ - deniedReaders?: Schema$Principal[]; + annotations?: Schema$LocationUnifiedLocationAnnotation[]; /** - * The name of the item to inherit the Access Permission List (ACL) from. Note: ACL inheritance *only* provides access permissions to child items and does not define structural relationships, nor does it provide convenient ways to delete large groups of items. Deleting an ACL parent from the index only alters the access permissions of child items that reference the parent in the inheritAclFrom field. The item is still in the index, but may not visible in search results. By contrast, deletion of a container item also deletes all items that reference the container via the containerName field. The maximum length for this field is 1536 characters. + * Information about whether the feature hierarchy contains default-blocked features. */ - inheritAclFrom?: string | null; + defaultBlockingData?: Schema$DefaultBlockingDataProto; /** - * Optional. List of owners for the item. This field has no bearing on document access permissions. It does, however, offer a slight ranking boosts items where the querying user is an owner. The maximum number of elements is 5. + * The descriptor for this result. Once added, descriptors should be considered immutable. Any additional information should be included elsewhere in the result. */ - owners?: Schema$Principal[]; + desc?: Schema$LocationUnifiedLocationDescriptor; /** - * List of principals who are allowed to see the item in search results. Optional if inheriting permissions from another item or if the item is not intended to be visible, such as virtual containers. The maximum number of elements is 1000. + * Flag to indicate this result has human-readable names for display. */ - readers?: Schema$Principal[]; - } - /** - * Content of an item to be indexed and surfaced by Cloud Search. Only UTF-8 encoded strings are allowed as inlineContent. If the content is uploaded and not binary, it must be UTF-8 encoded. - */ - export interface Schema$ItemContent { + displayable?: boolean | null; + extraData?: Schema$LocationUnifiedLocationResultExtraData; /** - * Upload reference ID of a previously uploaded content via write method. + * The feature hierarchy for this location result, if using the new feature-pool format instead of les_response. */ - contentDataRef?: Schema$UploadItemRef; - contentFormat?: string | null; + featureRefs?: Schema$LocationUnifiedFeatureReference[]; /** - * Hashing info calculated and provided by the API client for content. Can be used with the items.push method to calculate modified state. The maximum length is 2048 characters. + * True indicates that this result has geographical information like a lat/long, bounding box, etc.). The minimum is a lat/long. False only indicates that no such data is present and does NOT explain the reason (e.g., geocoding hasn't been attempted, geocoding timed out, the descriptor does not refer to a location, etc.). */ - hash?: string | null; + geocoded?: boolean | null; /** - * Content that is supplied inlined within the update method. The maximum length is 102400 bytes (100 KiB). + * Explains the specific reason for the value of the geocoded field, if any. This can be used to determine whether a descriptor needs to be geocoded. Used for making runtime decisions about whether to attempt geocoding. */ - inlineContent?: string | null; - } - export interface Schema$ItemCountByStatus { + geocodingReason?: string | null; /** - * Number of items matching the status code. + * WARNING: Do not reference this field directly check go/oolong-usage on how to access the values present in this proto or contact oolong-team@google.com if you don't see what you need. */ - count?: string | null; + lesResponse?: Schema$LocationExtractorLocationExtractionResponse; /** - * Number of items matching the status code for which billing is done. This excludes virtual container items from the total count. This count would not be applicable for items with ERROR or NEW_ITEM status code. + * Allow pipelines to associate arbitrary data (e.g., specialized geo identifiers) with a result. Chiefly intended to pass custom data around backends after standard geocoding and policy execution. Oolong libraries will generally ignore such data but may strip it to guard against cache fragmentation. Using this to pass data from frontends to backends before geocoding is not recommended and at your own risk. This field will carry AnonymizedBounds data which will be used for logging purposes. */ - indexedItemsCount?: string | null; + nonstandardData?: Schema$MessageSet; /** - * Status of the items. + * Result data computed by the policy annotation. */ - statusCode?: string | null; + policyResult?: Schema$LocationUnifiedPolicyResult; + /** + * Enum describing what this result was based on (e.g. location reported by the end user's phone). Present only if the LocationContext was produced by OolongService and this result has the USFUL annotation. + */ + sourceDescription?: string | null; } /** - * Available metadata fields for the item. + * Includes data that is included only for small subset of results. Next Available Tag: 4 */ - export interface Schema$ItemMetadata { + export interface Schema$LocationUnifiedLocationResultExtraData { /** - * The name of the container for this item. Deletion of the container item leads to automatic deletion of this item. Note: ACLs are not inherited from a container item. To provide ACL inheritance for an item, use the inheritAclFrom field. The maximum length is 1536 characters. + * Result caused a feature diff */ - containerName?: string | null; + featureDiff?: boolean | null; /** - * The BCP-47 language code for the item, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. The maximum length is 32 characters. + * For query results. */ - contentLanguage?: string | null; + interpretationData?: Schema$LocationUnifiedInterpretationData; /** - * A set of named attributes associated with the item. This can be used for influencing the ranking of the item based on the context in the request. The maximum number of elements is 10. + * Information about an ip block, like range, speed etc. This could be the only thing present in an empty result. */ - contextAttributes?: Schema$ContextAttribute[]; + ipblockinfo?: Schema$IPBlockInfoProto; + } + /** + * A featurelet corresponds to a single Mapfacts feature. These messages contain only the base data, without anything added by the Oolong policy (like trimming annotations or confidences). Next available tag: 11 LINT.IfChange + */ + export interface Schema$LocationUnifiedOolongFeature { /** - * The time when the item was created in the source repository. + * A field to attach additional data about the feature. For example, the location extraction server uses this field to include the ads criteria id of the featurelet if available. As specified by MessageSet, all types within the set must be unique. Using the changelist number where the message was created is a good method of ensuring uniqueness. */ - createTime?: string | null; + additionalData?: Schema$MessageSet; /** - * Hashing value provided by the API caller. This can be used with the items.push method to calculate modified state. The maximum length is 2048 characters. + * Copy of FeatureProto-\>RankDetailsProto-\>area_rank */ - hash?: string | null; + areaRank?: number | null; /** - * A list of interactions for the item. Interactions are used to improve Search quality, but are not exposed to end users. The maximum number of elements is 1000. + * Latitude and longitude of the feature center. */ - interactions?: Schema$Interaction[]; + center?: Schema$GeostorePointProto; /** - * Additional keywords or phrases that should match the item. Used internally for user generated content. The maximum number of elements is 100. The maximum length is 8192 characters. + * This field contains original feature's establishment type if it had one. */ - keywords?: string[] | null; + establishmentType?: string | null; /** - * The original mime-type of ItemContent.content in the source repository. The maximum length is 256 characters. + * The GeoStore Feature ID for this feature. This value is also used as key into the feature pool from FeatureReference's. */ - mimeType?: string | null; + featureId?: Schema$GeostoreFeatureIdProto; /** - * The type of the item. This should correspond to the name of an object definition in the schema registered for the data source. For example, if the schema for the data source contains an object definition with name 'document', then item indexing requests for objects of that type should set objectType to 'document'. The maximum length is 256 characters. + * The reference to an entity in the KnowledgeGraph. */ - objectType?: string | null; + kgReference?: Schema$GeostoreKnowledgeGraphReferenceProto; /** - * Additional search quality metadata of the item + * Each Featurelet includes the list of names that are associated with the corresponding GeoStore Feature. */ - searchQualityMetadata?: Schema$SearchQualityMetadata; + name?: Schema$GeostoreNameProto[]; /** - * Link to the source repository serving the data. Seach results apply this link to the title. Whitespace or special characters may cause Cloud Seach result links to trigger a redirect notice; to avoid this, encode the URL. The maximum length is 2048 characters. + * Copy of FeatureProto-\>RankDetailsProto-\>population_rank */ - sourceRepositoryUrl?: string | null; + populationRank?: number | null; /** - * The title of the item. If given, this will be the displayed title of the Search result. The maximum length is 2048 characters. + * The bounding box of this feature. */ - title?: string | null; + rect?: Schema$GeostoreRectProto; /** - * The time when the item was last modified in the source repository. + * The GeoStore Feature type. */ - updateTime?: string | null; + type?: string | null; } /** - * This contains item's status and any errors. + * *************************************************************************** PROTO BELOW IS FOR INTERNAL USE ONLY. IT MAY CHANGE WITHOUT NOTICE, SO EVERYONE OUTSIDE OF oolong-team@ IS STRONGLY DISCOURAGED FROM USING IT. CODE STILL DOING SO WILL BE BROKEN WITHOUT NOTICE. *************************************************************************** Internal Oolong-specific personalized location attributes. Next Id: 11. */ - export interface Schema$ItemStatus { + export interface Schema$LocationUnifiedPersonalizedLocationAttributes { /** - * Status code. + * Number of days the location was supported by any 'physical presence'-like or 'explicit-interest'-like location. */ - code?: string | null; + anySupportingDays?: number | null; /** - * Error details in case the item is in ERROR state. + * Binary mask representing "explicit-interest" daily visits in the location. EVAL-ONLY, NEVER POPULATED IN PRODUCTION OR LOGS. */ - processingErrors?: Schema$ProcessingError[]; + eiDailyVisits?: number | null; /** - * Repository error reported by connector. + * Binary mask representing "physical-presence" daily visits in the location. EVAL-ONLY, NEVER POPULATED IN PRODUCTION OR LOGS. */ - repositoryErrors?: Schema$RepositoryError[]; + ppDailyVisits?: number | null; + /** + * Number of days the location was supported by any 'physical presence'-like location. + */ + ppSupportingDays?: number | null; + /** + * Number of weeks the location was supported by any 'physical presence'-like location. + */ + ppSupportingWeeks?: number | null; + /** + * IP ranges that the location was supported by. + */ + supportingPackedIpRanges?: string[] | null; } /** - * Available structured data fields for the item. + * PolicyResult contains all the data that is computed based on the classifier policy for a location. */ - export interface Schema$ItemStructuredData { + export interface Schema$LocationUnifiedPolicyResult { + confidenceRects?: Schema$LocationUnifiedPolicyResultConfidenceRect[]; + } + export interface Schema$LocationUnifiedPolicyResultConfidenceRect { /** - * Hashing value provided by the API caller. This can be used with the items.push method to calculate modified state. The maximum length is 2048 characters. + * Confidence in the range [0, 100]. */ - hash?: string | null; + confidence?: number | null; /** - * The structured data object that should conform to a registered object definition in the schema for the data source. + * The bounding box that we believe is certain with probability given by confidence. */ - object?: Schema$StructuredDataObject; + rect?: Schema$LocationUnifiedLatLngRect; } - export interface Schema$ListDataSourceResponse { + /** + * Next ID: 4. + */ + export interface Schema$LocationUnifiedPresenceInterval { /** - * Token to retrieve the next page of results, or empty if there are no more results in the list. + * Probability of presence as a percentage in [0, 100]. */ - nextPageToken?: string | null; - sources?: Schema$DataSource[]; + confidence?: number | null; + /** + * Interval duration in seconds. + */ + durationSec?: string | null; + /** + * Start of the interval as the number of seconds from the time of the location. + */ + startOffsetSec?: string | null; } - export interface Schema$ListItemNamesForUnmappedIdentityResponse { - itemNames?: string[] | null; + /** + * Semantic location information from HULK Next Id: 6 + */ + export interface Schema$LocationUnifiedSemanticPlace { + confidence?: string | null; /** - * Token to retrieve the next page of results, or empty if there are no more results in the list. + * The feature id of the semantic location POI */ - nextPageToken?: string | null; + featureId?: Schema$LocationUnifiedFeatureIdProto; + /** + * Geo Ontology GConcept Instances of the semantic location + */ + gconceptInstance?: Schema$LocationUnifiedSemanticPlaceGConceptInstanceProto[]; + /** + * The probability the user is at this place in [0 100]. + */ + score?: number | null; + source?: string | null; } - export interface Schema$ListItemsResponse { - items?: Schema$Item[]; + /** + * A GConceptInstance (gcid), copied from geostore.GConceptInstanceProto. Copy is needed because - LocationDescriptor is used publicly, therefore should not have internal dependencies. - GConceptInstanceProto uses js_proto build rules which are incompatible with closure_js_proto_library rules. + */ + export interface Schema$LocationUnifiedSemanticPlaceGConceptInstanceProto { + gconceptId?: string | null; + prominence?: string | null; + } + /** + * VisibleNetwork describes a location by providing the details of one of the networks visible at that location. GLS can be used to geocode a set of VisibleNetworks into a location, as explained in go/gls-in-gws. Currently only WiFi and cell networks are supported, but the message could be extended to support additional network types (e.g. bluetooth beacons, etc) in the future. Next Id: 5 + */ + export interface Schema$LocationUnifiedVisibleNetwork { + cell?: Schema$LocationUnifiedVisibleNetworkCell; /** - * Token to retrieve the next page of results, or empty if there are no more results in the list. + * True if the user's device is currently connected to the network. */ - nextPageToken?: string | null; + connected?: boolean | null; + /** + * The timestamp of this network. That is when this network was detected, expressed as the number of milliseconds since unix epoch. If not set, assumed to be "now" or irrelevant. + */ + timestampMs?: string | null; + wifi?: Schema$LocationUnifiedVisibleNetworkWiFi; } /** - * The response message for Operations.ListOperations. + * Definition derived from https://developers.google.com/maps/documentation/geolocation/intro#cell_tower_object Next Id: 9 */ - export interface Schema$ListOperationsResponse { + export interface Schema$LocationUnifiedVisibleNetworkCell { /** - * The standard List next-page token. + * For GSM, LTE and WCDMA networks, this field holds the cell ID of the network. For CDMA networks, this field holds the base station ID of the network. */ - nextPageToken?: string | null; + cellId?: number | null; + /** + * For GSM and WCDMA networks, this field holds the location area code of the network. For LTE networks, this field used to hold the tracking area code of the network, but this usage has been deprecated, and that value should now be provided through tracking_area_code. For CDMA networks, this field holds the network ID of the network. + */ + locationAreaCode?: number | null; + /** + * The mobile country code of the network. + */ + mobileCountryCode?: number | null; + /** + * The mobile network code of the network. + */ + mobileNetworkCode?: number | null; + /** + * Only set for LTE networks for which this field holds the physical cell ID. + */ + physicalCellId?: number | null; + /** + * Only set for WCDMA networks for which this field holds the primary scrambling code of the network. + */ + primaryScramblingCode?: number | null; /** - * A list of operations that matches the specified filter in the request. + * Only set for LTE networks for which this field holds the tracking area code. */ - operations?: Schema$Operation[]; + trackingAreaCode?: number | null; + type?: string | null; } /** - * List sources response. + * Definition derived from https://developers.google.com/maps/documentation/geolocation/intro#wifi_access_point_object Next Id: 3 */ - export interface Schema$ListQuerySourcesResponse { - nextPageToken?: string | null; - sources?: Schema$QuerySource[]; - } - export interface Schema$ListSearchApplicationsResponse { + export interface Schema$LocationUnifiedVisibleNetworkWiFi { /** - * Token to retrieve the next page of results, or empty if there are no more results in the list. + * The BSSID of the network (i.e. MAC address of the access point). */ - nextPageToken?: string | null; - searchApplications?: Schema$SearchApplication[]; - } - export interface Schema$ListUnmappedIdentitiesResponse { + bssid?: string | null; /** - * Token to retrieve the next page of results, or empty if there are no more results in the list. + * The signal level of the network in dBm (RSSI). */ - nextPageToken?: string | null; - unmappedIdentities?: Schema$UnmappedIdentity[]; + levelDbm?: number | null; } /** * Geo information used for rendering a map that shows the user's work location. @@ -2280,6 +3803,10 @@ export namespace cloudsearch_v1 { */ resourceName?: string | null; } + /** + * This is proto2's version of MessageSet. + */ + export interface Schema$MessageSet {} /** * Metadata of a matched search result. */ @@ -2357,6 +3884,12 @@ export namespace cloudsearch_v1 { textValues?: Schema$TextValues; timestampValues?: Schema$TimestampValues; } + export interface Schema$NetStatsProto { + bandaidBandwidthKbps?: Schema$BandWidthRangeKbps; + bandwidthKbps?: number | null; + gfeBandwidthKbps?: Schema$BandWidthRangeKbps; + videostatsBandwidthKbps?: Schema$BandWidthRangeKbps; + } /** * The definition for an object within a data source. */ @@ -2444,6 +3977,19 @@ export namespace cloudsearch_v1 { */ response?: {[key: string]: any} | null; } + /** + * The status and eligibility information for a single feature. + */ + export interface Schema$OptInStatus { + /** + * If the user is ineligible, they should not be opted in! + */ + eligibility?: string | null; + /** + * If the user is ineligible, they should not be opted in! + */ + optedIn?: boolean | null; + } export interface Schema$PeoplePromotionCard { people?: Schema$PersonCore[]; } @@ -2697,6 +4243,12 @@ export namespace cloudsearch_v1 { */ fieldViolations?: Schema$FieldViolation[]; } + /** + * prominent_entity(ies) field encodes the main subject(entities) which the client wants to bias the query into. For a Mini-App, it'll be the main entities in the current Mini-App page. It provides finer-granularity contexts on top of the “mode” field. Note that when QueryBiasingContext is passed to server through ClientDiscourseContext, the prominent_entity should NOT be set and the corresponding information will be merged from ClientDiscourseContext.entity field at the server side. + */ + export interface Schema$ProminentEntity { + mid?: string | null; + } /** * The definition of a property within an object. */ @@ -2752,6 +4304,26 @@ export namespace cloudsearch_v1 { */ displayLabel?: string | null; } + /** + * The enums in ProxyClassificationProto have the same values as in Neustar's data, plus a NONE value, corresponding to empty value in the Neustar's data. See Neustar's IP Intelligence GeoPoint Data Glossary (https://ipintelligence.neustar.biz/portal/home#downloads) for a more detailed description of the meaning of the values. In the data as of January 2016, if the IP address is classified as a proxy, the four fields anonymizer_status, proxy_type, proxy_level and proxy_last_detected_s are all present and set to a value different from NONE; otherwise the enum fields are not set or set to the corresponding NONE constant and proxy_last_detected_s is not set. + */ + export interface Schema$ProxyClassificationProto { + /** + * WARNING: these fields are coming from a third party. Please consider using only privacy_proxy_operator. Before adding any new usage of this data, please talk to zszami@ and ipgeo-team@. + */ + anonymizerStatus?: string | null; + hostingFacility?: boolean | null; + /** + * Operator of a privacy proxy, e.g. Google One (PPN) or Apple Private Relay. Mapping maintained by Google, does not include data from Neustar. If in doubt, use privacy_proxy_operator == NONE and != NONE to check for privacy proxies. + */ + privacyProxyOperator?: string | null; + /** + * In seconds since the Epoch. + */ + proxyLastDetectedS?: string | null; + proxyLevel?: string | null; + proxyType?: string | null; + } /** * Represents an item to be pushed to the indexing queue. */ @@ -2808,6 +4380,16 @@ export namespace cloudsearch_v1 { */ query?: string | null; } + /** + * The message encapsulates the relevant query biasing contexts from a particular client, e.g. an individual Mini-App or an individual Mini-App page. Next id: 3 + */ + export interface Schema$QueryBiasingContext { + /** + * Specifies the mode to bias the queries from the client into. The mode value should be coming from the Mode enum. + */ + mode?: number | null; + prominentEntity?: Schema$ProminentEntity[]; + } export interface Schema$QueryCountByStatus { count?: string | null; /** @@ -3488,6 +5070,16 @@ export namespace cloudsearch_v1 { */ suggestionType?: string | null; } + export interface Schema$StarlightConsistency { + /** + * Optional, data-source specific, data to help achieve consistency. + */ + consistency?: Schema$MessageSet; + /** + * Timestamp of last write operation. By setting this value, a client requests to trigger a new fresh data acquisition if the fresh model is older than this timestamp. + */ + timestampSec?: number | null; + } /** * Start upload file request. */ @@ -3536,6 +5128,19 @@ export namespace cloudsearch_v1 { */ person?: Schema$Person; } + /** + * Representation of user history for personal reranking. Debug only. Can be used for: 1) Manually entering the field to Suggest http debug GUI. 2) Sending protobuf using stubby tool. 3) Unit tests. 4) Offline analysis. Next ID to use: 3. + */ + export interface Schema$SuggestPersonalRerankDebugInfo { + /** + * Can be used to store additional user history. + */ + additionalInfo?: Schema$MessageSet; + /** + * The first query is considered to be the most recent query. + */ + userHistory?: string[] | null; + } /** * Request of suggest API. */ @@ -3553,6 +5158,40 @@ export namespace cloudsearch_v1 { */ requestOptions?: Schema$RequestOptions; } + /** + * Next ID to use: 13. + */ + export interface Schema$SuggestRequestDebugOptions { + /** + * Whether to add the subtype to the suggestion so it can be displayed in a side-by-side + */ + annotateWithSubtype?: boolean | null; + /** + * Whether to enable debug info in SuggestResults. + */ + debug?: boolean | null; + disableBadwordFiltering?: boolean | null; + /** + * Whether to disable the hybrid cache. + */ + disableHybridCache?: boolean | null; + disableKesemFiltering?: boolean | null; + /** + * Whether to pull personal data from Starlight like Anima profile data for personal SxS eval. + */ + enableGetDataFromStarlightForPersonalSxs?: boolean | null; + /** + * Whether to add the user gaia_id to the request, so it can return personal suggestions. + */ + enablePersonal?: boolean | null; + freshMode?: string | null; + /** + * Number of results to return. If 0, this options is ignored. Is NOT subject to the upper bound limit controlled by num_results_limit_max_override flag + */ + numResults?: number | null; + sxs?: boolean | null; + trace?: string | null; + } /** * Response of the suggest API. */ @@ -3562,6 +5201,16 @@ export namespace cloudsearch_v1 { */ suggestResults?: Schema$SuggestResult[]; } + export interface Schema$SuggestRestrict { + /** + * Name of the restrict, e.g. lang. + */ + name?: string | null; + /** + * Restrict value. + */ + value?: string | null; + } /** * One suggestion result. */ @@ -3583,6 +5232,367 @@ export namespace cloudsearch_v1 { */ suggestedQuery?: string | null; } + /** + * Protos for the stubby interface. Next IDs to use: 37, 38, 39, 40, 43, 44, 46, 47, 48, 71, 77, 100. + */ + export interface Schema$SuggestSuggestRequest { + requestdata?: Schema$SuggestSuggestRequestRequestData[]; + } + /** + * A suggest request can ask for completions for one query only. For multiple request data an error is returned. Next IDs to use: 135. + */ + export interface Schema$SuggestSuggestRequestRequestData { + /** + * Number of sequentially added characters after a sequential deletion. + */ + addedCharacterCount?: number | null; + /** + * Enable calculator. Turning this field on will cause Complete Server to fill the SuggestResults.CalculatorSuggestion string field and it instead disables all the oneboxes (in SuggestResults.CompleteSuggestion.info), including the calculator onebox. Clients that are capable of rendering oneboxes should use the onebox calculator (and should leave this field turned off). When not specified, the default value of this field depends on the client. See suggestflow_state.cc: CommonInit(). + */ + calc?: boolean | null; + /** + * City location ID. + */ + cityId?: number | null; + /** + * The name of the requesting client (firefox, chrome, etc.). + */ + client?: string | null; + /** + * The client instance ID provided by AGSA. See http://go/client-instance-id + */ + clientInstanceId?: string | null; + clientThumbnailDimensions?: Schema$SuggestSuggestRequestRequestDataClientThumbnailDimensions; + /** + * Enable completion. + */ + complete?: boolean | null; + /** + * Allow sending read-after-write consistency data to Starlight. + */ + consistency?: Schema$StarlightConsistency; + /** + * Repeated list of URLs that we use to trigger context based suggestions (currently zero-prefix). + */ + contextUrls?: string[] | null; + /** + * cookie_init_time is typically set by GoogleCookie::initial_time() + */ + cookieInitTime?: number | null; + /** + * Requested country (us, uk, jp, cn, etc.). + */ + country?: string | null; + /** + * Country as determined by GeoIP. + */ + countryByIp?: string | null; + /** + * Cursor position (for result-page requests). + */ + cp?: number | null; + /** + * The dasher domain of the searcher. + */ + dasherDomain?: string | null; + /** + * Enable debug output. + */ + debug?: boolean | null; + debugOptions?: Schema$SuggestRequestDebugOptions; + /** + * Any sequentially deleted characters after the cursor position. + */ + deletedCharacters?: string | null; + /** + * Whether to run in Infinite Suggest mode. + */ + DEPRECATEDInfiniteSuggest?: boolean | null; + deviceOsVersion?: string | null; + /** + * Requested dataset (i, m, yt, etc.). + */ + ds?: string | null; + /** + * Whether to enable Visual Suggest. (Currently used for YouTube Suggest) Clients can opt to disable Visual Suggest based on current device specs and network conditions. + */ + enableVisualSuggest?: boolean | null; + /** + * Experiment ID. + */ + expid?: string | null; + /** + * Define the way to read data from the location context. + */ + forceUserLocation?: boolean | null; + /** + * Parameter frozen_clock in microseconds passed by SXS eval. This will be used as random number generator bit for consistent randomization for SXS tests. + */ + frozenClock?: string | null; + /** + * Gaia ID for personal suggestions. Format is that of http://displayserver.corp.google.com/ Use ParseLeadingHex64Value in numbers.h to convert to an uint64 + */ + gaiaId?: string | null; + /** + * Hour of the week (UTC). + */ + hourOfTheWeek?: number | null; + /** + * For each completion, annotate with: https://cs.corp.google.com/#piper///depot/google3/suggest/base/ answer.proto&l=15&rcl=53295698&pv=1 which is the probability that issuing the completion as a query will result in an answer being displayed to the user (live-result,one-box, etc.) If there is no answer type for which the probability is above zero, the completion will not be annotated. + */ + includeAnswerData?: boolean | null; + includeLocalSignals?: boolean | null; + /** + * Annotate the suggestions with webref data. + */ + includeWebrefAnnotations?: boolean | null; + /** + * The user's ip address. Should NOT be used to override domain. + */ + ipAddress?: string | null; + /** + * True only when using the CS debug console. + */ + isConsole?: boolean | null; + /** + * Set once by the server. Can be used for dog-fooding or tests. + */ + isDebugIp?: boolean | null; + /** + * The following two fields, is_mobile_device and is_mobile_ux are used to denote whether the request comes from a mobile device or a device with mobile user experience. It's possible for a device type to be different than UX type since tablet devices could receive either mobile or desktop UX, as explained in go/ux-tier-logging. + */ + isMobileDevice?: boolean | null; + isMobileUx?: boolean | null; + /** + * For users who are using Google Apps for work (dasher) but are not internal users, we would like to turn off instant apps. + */ + isNonCorpDasherAccount?: boolean | null; + /** + * Indicates whether the request comes from china. + */ + isRequestFromChina?: boolean | null; + /** + * Whether the user's account is a Unicorn child account. + */ + isUnicornAccount?: boolean | null; + /** + * This field should be set to false for requests that are generated due to something other than user interaction. For example: 0-prefix requests could be sent in the background (e.g. periodically) for updating a client side cache. On Android GSA, see http://go/android-0q-cache. Backends, such as Starlight, can then use this signal, e.g. for matters like load-shedding. + */ + isUserInitiatedRequest?: boolean | null; + /** + * Whether the query was from voice search (set by Youtube LR) + */ + isVoiceQuery?: boolean | null; + /** + * Requested language (en, ru, iw, etc.). + */ + lang?: string | null; + /** + * GPS coordinates of the mobile client in degrees, if known. + */ + latitude?: number | null; + /** + * Oolong LocationContext (see http://goto/oolong). + */ + locationContext?: Schema$LocationUnifiedLocationContext; + /** + * Region location ID. + */ + locationId?: number | null; + /** + * If true, will log if there was any flaky backend in SuggestResponse. + */ + logFlakyBackends?: boolean | null; + longitude?: number | null; + /** + * State that overrides whether or not the maps fallback flow should run. + */ + mapsMissPrefix?: string | null; + /** + * Enable navsuggest. + */ + nav?: boolean | null; + /** + * Enable news. + */ + news?: boolean | null; + /** + * Upper limit of the number of navsuggest results to return. + */ + numNavResults?: number | null; + /** + * Number of suggestions to return. * In non Generic-Suggest clients, when set, this overrides the client configuration. Subject to upper bound limit controlled by num_results_limit_max_override flag. * In Generic-Suggest clients, when set, this caps the number of suggestions in addition to the client configuration. Ignores num_results_limit_max_override flag. + */ + numResultsLimit?: number | null; + /** + * Chrome Omnibox focus type. This param is passed in "oft" CGI param. + */ + omniboxFocusType?: string | null; + /** + * Chrome Omnibox input type. This param is passed in "oit" CGI param. + */ + omniboxInputType?: string | null; + /** + * Chrome Omnibox page classification. This param is passed in "pgcl" CGI param. + */ + omniboxPageClassification?: string | null; + /** + * The OPA opaque token provided by OPA. NOTE: Deprecated. Please use consistency.FootprintsVersionInfo.version_info. + */ + opaOpaqueToken?: string | null; + /** + * The opt-in context passed by GSA for App History suggestions. The opt-in context has a list of apps that should be excluded from the personalized App History suggestions. More details at: go/apphistory-suggestions. + */ + optInContext?: Schema$ClientOptInContext; + /** + * Any additional SuggestRequest::RequestData params, like: RequestAndReferenceOverride (see experiments/suggest_experiment.proto): overrides the default client options; useful for enabling a feature on top of existing features defined for a given client. Person: extra params required by the people flow. MapsHeadRequestParams: extra params used by the maps head flow. OnFocusRequestParams: extra params used by on-focus request. SrDataForSuggestContextualizationRequestParams: extra params used by the SR for suggest context flow. MultimodalSuggestImageSignals: extra params used by Multimodal suggest flow. + */ + params?: Schema$MessageSet; + /** + * The user debug info used in testing, offline analysis. + */ + personalRerankDebugInfo?: Schema$SuggestPersonalRerankDebugInfo; + /** + * Deprecated. + */ + prefId?: string | null; + /** + * For result-page requests. + */ + previousQuery?: string | null; + /** + * Seconds since the previous_query was issued. Default value -1 means this field is not set in request. + */ + previousQuerySeconds?: number | null; + /** + * Video id for the most recently watched Youtube Video on Android App. See go/pvideo-suggest for more details. Don't use this directly, instead use request_context-\>video_or_pvideo_id(). + */ + previousVideoId?: string | null; + /** + * Time in seconds since end of watch on the most recently watched Youtube Video on Android App. + */ + previousVideoSeconds?: string | null; + /** + * Ask Google Suggest server for completions for this query. + */ + query?: string | null; + queryBiasingContext?: Schema$QueryBiasingContext; + /** + * The HTTP request's referrer, it will be set for requests coming from web (desktop or mobile). + */ + referrer?: string | null; + /** + * Thirdparty restricted search. + */ + restrict?: Schema$SuggestRestrict[]; + runtimeData?: Schema$SuggestSuggestRequestRequestDataRuntimeData; + /** + * End position of the user's selection (if any). + */ + selectionEnd?: number | null; + /** + * Specifies whether we should personalize Suggest results. Based on whether this field is set or not, we have the following interpretations: (1) this field is not set - we request a Kansas check to be done in PSuggest server (fall back to the user personalization settings) Note: this is the default behavior (2) this field is set to true - this forces personalization regardless Kansas settings (3) this field is set to false - this disables personalization (PSuggest flows are not invoked) Note: Originally, we planned to have Kansas check in GWS, however it turns out that Kansas is not on Suggest path and we were forced to implement this check in PSuggest server. See http://b/5265965 for more details. + */ + shouldPersonalize?: boolean | null; + /** + * Requests suggestions for query restricted to specified site. Should be a sitename (ex: 'youtube.com') + */ + siteRestrict?: string | null; + /** + * The source language for dictionary/translate (en, ru, iw, etc.). + */ + sourceLang?: string | null; + /** + * Enable spell correction. + */ + spell?: boolean | null; + /** + * Deprecated: GWS Experiment Ids that are tagged for Spelling. + */ + spellingExperimentIds?: number[] | null; + /** + * If non-negative, determines the start index (starting at 0) for results: a value of '0' is a no-opt; and e.g. a value of '20' would skip the first 20 suggestions, returning results 21 - ?? (e.g. ?? = 30 if num_results_limit = 10). Currently, this is only used by PSuggest, and will be ignored by all other suggest backends. + */ + startIndex?: number | null; + /** + * Request options, filled in a runtime. + */ + suggestRequestId?: number | null; + /** + * Suppress fragment generation and bolding. + */ + suppressBolding?: boolean | null; + /** + * Disables pluspage suggestions. This overrides client config. Intended for temporary UI state change as it happens when toolbar is activated. + */ + suppressPluspages?: boolean | null; + /** + * The target language for dictionary/translate (en, ru, iw, etc.). + */ + targetLang?: string | null; + /** + * For querynation, this is the psychic completed part of the query. For example if the user has entered [cancun hote] in the searchbox and this completes to [cancun hotels], then text_ahead="ls". + */ + textAhead?: string | null; + /** + * Original query before it was refined or corrected (set by Youtube LR) + */ + uncorrectedOriginalQuery?: string | null; + /** + * The user agent string, to be used temporarily within CompleteServer to accurately compute data volume estimate for additional events added to Sessions for Proxima (namely, go/search-metrics-and-triggering-proxima). + */ + userAgent?: string | null; + /** + * FeatureId associated with user location (from Oolong) as a string + */ + userLocationFeatureId?: string | null; + /** + * Index of the result in location_context.results field that best describes the user location. + */ + userLocationResult?: number | null; + userPrefs?: Schema$SuggestSuggestRequestRequestDataUserPreferences; + /** + * Override the user location. Used for debugging. + */ + uuld?: string | null; + /** + * Video id for the currently watching Youtube Video. Don't use this directly, instead use request_context-\>video_or_pvideo_id(). + */ + videoId?: string | null; + /** + * Encrypted YouTube Visitor Data (see go/visitor-id-suggest). For privacy reasons, visitor_data can only be set in absence of gaia_id. + */ + visitorData?: string | null; + /** + * External YouTube Channel ID for channel scoped suggestions. This ID is is passed through for creator features and is used to fetch channel personalized suggestions. + */ + youtubeExternalChannelId?: string | null; + /** + * zwieback_id is set by GoogleCookie::uid() For SxS we override zwieback_id, please access through SuggestFlowUtils::GetZwiebackId(...). + */ + zwiebackId?: string | null; + } + /** + * The thumbnail dimensions as per client requirements. Next ID: 5 + */ + export interface Schema$SuggestSuggestRequestRequestDataClientThumbnailDimensions { + devicePixelRatio?: number | null; + iconSizeInDp?: number | null; + targetThumbnailHeight?: number | null; + /** + * Currently only used for YouTube Visual Suggest (go/ytandroid-visual-suggest). + */ + targetThumbnailWidth?: number | null; + } + /** + * Next ID: 2 TODO(b/237694378) Move this to ProcessedRequestContext. + */ + export interface Schema$SuggestSuggestRequestRequestDataRuntimeData { + sanitizedRequestLanguage?: string | null; + } + export interface Schema$SuggestSuggestRequestRequestDataUserPreferences { + isTrendsDisabled?: boolean | null; + } /** * Used to provide a search operator for text properties. This is optional. Search operators let users restrict the query to specific fields relevant to the type of item being searched. */ diff --git a/src/apis/compute/alpha.ts b/src/apis/compute/alpha.ts index 5524f4e740..b4b83826e5 100644 --- a/src/apis/compute/alpha.ts +++ b/src/apis/compute/alpha.ts @@ -146,6 +146,7 @@ export namespace compute_alpha { instances: Resource$Instances; instanceSettings: Resource$Instancesettings; instanceTemplates: Resource$Instancetemplates; + instantSnapshotGroups: Resource$Instantsnapshotgroups; instantSnapshots: Resource$Instantsnapshots; interconnectAttachments: Resource$Interconnectattachments; interconnectLocations: Resource$Interconnectlocations; @@ -178,10 +179,12 @@ export namespace compute_alpha { regionDiskTypes: Resource$Regiondisktypes; regionHealthChecks: Resource$Regionhealthchecks; regionHealthCheckServices: Resource$Regionhealthcheckservices; + regionInstanceGroupManagerResizeRequests: Resource$Regioninstancegroupmanagerresizerequests; regionInstanceGroupManagers: Resource$Regioninstancegroupmanagers; regionInstanceGroups: Resource$Regioninstancegroups; regionInstances: Resource$Regioninstances; regionInstanceTemplates: Resource$Regioninstancetemplates; + regionInstantSnapshotGroups: Resource$Regioninstantsnapshotgroups; regionInstantSnapshots: Resource$Regioninstantsnapshots; regionMultiMigs: Resource$Regionmultimigs; regionNetworkEndpointGroups: Resource$Regionnetworkendpointgroups; @@ -271,6 +274,9 @@ export namespace compute_alpha { this.instances = new Resource$Instances(this.context); this.instanceSettings = new Resource$Instancesettings(this.context); this.instanceTemplates = new Resource$Instancetemplates(this.context); + this.instantSnapshotGroups = new Resource$Instantsnapshotgroups( + this.context + ); this.instantSnapshots = new Resource$Instantsnapshots(this.context); this.interconnectAttachments = new Resource$Interconnectattachments( this.context @@ -322,6 +328,8 @@ export namespace compute_alpha { this.regionHealthCheckServices = new Resource$Regionhealthcheckservices( this.context ); + this.regionInstanceGroupManagerResizeRequests = + new Resource$Regioninstancegroupmanagerresizerequests(this.context); this.regionInstanceGroupManagers = new Resource$Regioninstancegroupmanagers(this.context); this.regionInstanceGroups = new Resource$Regioninstancegroups( @@ -331,6 +339,8 @@ export namespace compute_alpha { this.regionInstanceTemplates = new Resource$Regioninstancetemplates( this.context ); + this.regionInstantSnapshotGroups = + new Resource$Regioninstantsnapshotgroups(this.context); this.regionInstantSnapshots = new Resource$Regioninstantsnapshots( this.context ); @@ -867,6 +877,10 @@ export namespace compute_alpha { * ID of the instance template used to populate reservation properties. */ sourceInstanceTemplateId?: string | null; + /** + * Per service utilization breakdown. The Key is the Google Cloud managed service name. + */ + utilizations?: {[key: string]: string} | null; } export interface Schema$AllocationSpecificSKUAllocationAllocatedInstancePropertiesReservedDisk { /** @@ -1520,6 +1534,10 @@ export namespace compute_alpha { * 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. */ capacityScaler?: number | null; + /** + * List of custom metrics that are used for CUSTOM_METRICS BalancingMode and WEIGHTED_ROUND_ROBIN BackendService locality_lb_policy. + */ + customMetrics?: Schema$BackendCustomMetric[]; /** * An optional description of this resource. Provide this property when you create the resource. */ @@ -1747,6 +1765,23 @@ export namespace compute_alpha { message?: string; } | null; } + /** + * Custom Metrics are used for CUSTOM_METRICS balancing_mode and WEIGHTED_ROUND_ROBIN BackendService locality_lb_policy. + */ + export interface Schema$BackendCustomMetric { + /** + * If true, the metric data is collected and reported to Cloud Monitoring, but is not used for load balancing. + */ + dryRun?: boolean | null; + /** + * Optional parameter to define a target utilization for the Custom Metrics balancing mode. The valid range is [0.0, 1.0]. + */ + maxUtilization?: number | null; + /** + * Name of a custom utilization signal. The name must be 1-24 characters long, and comply with RFC1035. Specifically, the name must be 1-24 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be 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 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. + */ + name?: string | null; + } /** * 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/alpha/backendServices) * [Regional](https://cloud.google.com/compute/docs/reference/rest/alpha/regionBackendServices) For more information, see Backend Services. */ @@ -1934,6 +1969,9 @@ export namespace compute_alpha { * 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. */ timeoutSec?: number | null; + /** + * [Output Only] List of resources referencing given backend service. + */ usedBy?: Schema$BackendServiceUsedBy[]; /** * The network scope of the backends that can be added to the backend service. This field can be either GLOBAL_VPC_NETWORK or REGIONAL_VPC_NETWORK. A backend service with the VPC scope set to GLOBAL_VPC_NETWORK is only allowed to have backends in global VPC networks. When the VPC scope is set to REGIONAL_VPC_NETWORK the backend service is only allowed to have backends in regional networks in the same scope as the backend service. Note: if not specified then GLOBAL_VPC_NETWORK will be used. @@ -2340,6 +2378,9 @@ export namespace compute_alpha { } | null; } export interface Schema$BackendServiceUsedBy { + /** + * [Output Only] Server-defined URL for resources referencing given BackendService like UrlMaps, TargetTcpProxies, TargetSslProxies and ForwardingRule. + */ reference?: string | null; } export interface Schema$BfdPacket { @@ -2774,6 +2815,10 @@ export namespace compute_alpha { * [Output Only] Creation timestamp in RFC3339 text format. */ creationTimestamp?: string | null; + /** + * [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. + */ + customEndTimestamp?: string | null; /** * An optional description of this resource. Provide this property when you create the resource. */ @@ -2930,6 +2975,10 @@ export namespace compute_alpha { * [Output Only] An optional, contains all the needed information of cancellation. */ cancellationInformation?: Schema$CommitmentResourceStatusCancellationInformation; + /** + * [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. + */ + customTermEligibilityEndTimestamp?: string | null; } export interface Schema$CommitmentResourceStatusCancellationInformation { /** @@ -6814,7 +6863,7 @@ export namespace compute_alpha { */ autoHealingPolicies?: Schema$InstanceGroupManagerAutoHealingPolicy[]; /** - * The base instance name to use for instances in this group. The value must be 1-58 characters long. Instances are named by appending a hyphen and a random four-character string to the base instance name. The base instance name must comply with RFC1035. + * 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,52\}-#{1,10\}(\\[[0-9]{1,10\}\\])?)) */ baseInstanceName?: string | null; /** @@ -6885,6 +6934,10 @@ export namespace compute_alpha { * [Output Only] The URL of the region where the managed instance group resides (for regional resources). */ region?: string | null; + /** + * Resource policies for this managed instance group. + */ + resourcePolicies?: Schema$InstanceGroupManagerResourcePolicies; /** * [Output Only] Reserved for future use. */ @@ -7322,6 +7375,12 @@ export namespace compute_alpha { }>; } | null; } + export interface Schema$InstanceGroupManagerResourcePolicies { + /** + * 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 + */ + workloadPolicy?: string | null; + } export interface Schema$InstanceGroupManagersAbandonInstancesRequest { /** * 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]. @@ -8427,6 +8486,63 @@ export namespace compute_alpha { message?: string; } | null; } + export interface Schema$InstantSnapshotGroup { + /** + * [Output Only] Creation timestamp in RFC3339 text format. + */ + creationTimestamp?: string | null; + /** + * Optional. An optional description of this resource. Provide this property when you create the resource. + */ + description?: string | null; + /** + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. + */ + id?: string | null; + /** + * [Output Only] Type of the resource. Always compute#instantSnapshotGroup for InstantSnapshotGroup resources. + */ + kind?: string | null; + /** + * Identifier. 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. + */ + name?: string | null; + /** + * [Output Only] URL of the region where the instant snapshot group resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. + */ + region?: string | null; + resourceStatus?: Schema$InstantSnapshotGroupResourceStatus; + /** + * [Output Only] Server-defined URL for the resource. + */ + selfLink?: string | null; + /** + * [Output Only] Server-defined URL for this resource's resource id. + */ + selfLinkWithId?: string | null; + /** + * [Output Only] + */ + status?: string | null; + /** + * [Output Only] URL of the zone where the instant snapshot group resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. + */ + zone?: string | null; + } + export interface Schema$InstantSnapshotGroupResourceStatus { + /** + * [Output Only] + */ + consistencyMembershipResolutionTime?: string | null; + /** + * [Output Only] + */ + sourceInfo?: Schema$InstantSnapshotGroupSourceInfo; + } + export interface Schema$InstantSnapshotGroupSourceInfo { + consistencyGroup?: string | null; + consistencyGroupId?: string | null; + } /** * Contains a list of InstantSnapshot resources. */ @@ -8635,6 +8751,7 @@ export namespace compute_alpha { */ export interface Schema$InterconnectApplicationAwareInterconnect { bandwidthPercentagePolicy?: Schema$InterconnectApplicationAwareInterconnectBandwidthPercentagePolicy; + egressMinBandwidthPercentagePolicy?: Schema$InterconnectApplicationAwareInterconnectBandwidthPercentagePolicy; /** * A description for the AAI profile on this interconnect. */ @@ -9787,6 +9904,44 @@ export namespace compute_alpha { message?: string; } | null; } + /** + * Contains a list of InstantSnapshotGroup resources. + */ + export interface Schema$ListInstantSnapshotGroups { + etag?: string | null; + /** + * [Output Only] Unique identifier for the resource; defined by the server. + */ + id?: string | null; + /** + * A list of InstantSnapshotGroup resources. + */ + items?: Schema$InstantSnapshotGroup[]; + /** + * Type of resource. + */ + kind?: string | null; + /** + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. + */ + nextPageToken?: string | null; + /** + * [Output Only] Server-defined URL for this resource. + */ + selfLink?: string | null; + /** + * [Output Only] Unreachable resources. end_interface: MixerListResponseWithEtagBuilder + */ + unreachables?: string[] | null; + /** + * [Output Only] Informational warning message. + */ + warning?: { + code?: string; + data?: Array<{key?: string; value?: string}>; + message?: string; + } | null; + } export interface Schema$LocalDisk { /** * Specifies the number of such disks. @@ -10445,6 +10600,7 @@ export namespace compute_alpha { * [Output Only] Server-defined URL for this resource with the resource id. */ selfLinkWithId?: string | null; + status?: Schema$MultiMigStatus; } /** * Policy regarding where to create MIGs Initially only zonal MIGs in the same zone are supported. @@ -10512,6 +10668,9 @@ export namespace compute_alpha { message?: string; } | null; } + export interface Schema$MultiMigStatus { + memberInstanceGroupManagers?: string[] | null; + } /** * [Deprecated] Configuration for the mutual Tls mode for peer authentication. Configuration for the mutual Tls mode for peer authentication. */ @@ -10951,10 +11110,6 @@ export namespace compute_alpha { * Represents the port number to which PSC consumer sends packets. Only valid for network endpoint groups created with GCE_VM_IP_PORTMAP endpoint type. */ clientDestinationPort?: number | null; - /** - * Represents the port number to which PSC consumer sends packets. Only valid for network endpoint groups created with CLIENT_PORT_PER_ENDPOINT mapping mode. - */ - clientPort?: number | null; /** * Optional fully qualified domain name of network endpoint. This can only be specified when NetworkEndpointGroup.network_endpoint_type is NON_GCP_FQDN_PORT. */ @@ -10992,10 +11147,6 @@ export namespace compute_alpha { * Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. */ appEngine?: Schema$NetworkEndpointGroupAppEngine; - /** - * Only valid when networkEndpointType is GCE_VM_IP_PORT and the NEG is regional. - */ - clientPortMappingMode?: string | null; /** * Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. */ @@ -15060,6 +15211,7 @@ export namespace compute_alpha { * Resource policy applicable to VMs for infrastructure maintenance. */ vmMaintenancePolicy?: Schema$ResourcePolicyVmMaintenancePolicy; + workloadPolicy?: Schema$ResourcePolicyWorkloadPolicy; } /** * Contains a list of resourcePolicies. @@ -15356,6 +15508,12 @@ export namespace compute_alpha { */ startTime?: string | null; } + /** + * Represents the workload policy. + */ + export interface Schema$ResourcePolicyWorkloadPolicy { + type?: string | null; + } /** * 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. */ @@ -15389,7 +15547,7 @@ export namespace compute_alpha { } export interface Schema$ResourceStatusScheduling { /** - * Specifies the availability domain (AD), which this instance should be scheduled on. The AD belongs to the spread GroupPlacementPolicy resource policy that has been assigned to the instance. Specify a value between 1-max count of availability domains in your GroupPlacementPolicy. See go/placement-policy-extension for more details. + * 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. */ availabilityDomain?: number | null; /** @@ -16608,7 +16766,7 @@ export namespace compute_alpha { */ automaticRestart?: boolean | null; /** - * Specifies the availability domain (AD), which this instance should be scheduled on. The AD belongs to the spread GroupPlacementPolicy resource policy that has been assigned to the instance. Specify a value between 1-max count of availability domains in your GroupPlacementPolicy. See go/placement-policy-extension for more details. + * 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. */ availabilityDomain?: number | null; /** @@ -21365,7 +21523,7 @@ export namespace compute_alpha { */ selfLink?: string | null; /** - * The stack type for this VPN gateway to identify the IP protocols that are enabled. Possible values are: IPV4_ONLY, IPV4_IPV6. If not specified, IPV4_ONLY will be used. + * 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. */ stackType?: string | null; /** @@ -55210,111 +55368,14 @@ export namespace compute_alpha { requestBody?: Schema$TestPermissionsRequest; } - export class Resource$Instantsnapshots { + export class Resource$Instantsnapshotgroups { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * Retrieves an aggregated list of instantSnapshots. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - aggregatedList( - params: Params$Resource$Instantsnapshots$Aggregatedlist, - options: StreamMethodOptions - ): GaxiosPromise; - aggregatedList( - params?: Params$Resource$Instantsnapshots$Aggregatedlist, - options?: MethodOptions - ): GaxiosPromise; - aggregatedList( - params: Params$Resource$Instantsnapshots$Aggregatedlist, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - aggregatedList( - params: Params$Resource$Instantsnapshots$Aggregatedlist, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - aggregatedList( - params: Params$Resource$Instantsnapshots$Aggregatedlist, - callback: BodyResponseCallback - ): void; - aggregatedList( - callback: BodyResponseCallback - ): void; - aggregatedList( - paramsOrCallback?: - | Params$Resource$Instantsnapshots$Aggregatedlist - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Instantsnapshots$Aggregatedlist; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Instantsnapshots$Aggregatedlist; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/compute/alpha/projects/{project}/aggregated/instantSnapshots' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['project'], - pathParams: ['project'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest( - parameters - ); - } - } - - /** - * 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. + * deletes a Zonal InstantSnapshotGroup resource * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -55322,31 +55383,31 @@ export namespace compute_alpha { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Instantsnapshots$Delete, + params: Params$Resource$Instantsnapshotgroups$Delete, options: StreamMethodOptions ): GaxiosPromise; delete( - params?: Params$Resource$Instantsnapshots$Delete, + params?: Params$Resource$Instantsnapshotgroups$Delete, options?: MethodOptions ): GaxiosPromise; delete( - params: Params$Resource$Instantsnapshots$Delete, + params: Params$Resource$Instantsnapshotgroups$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Instantsnapshots$Delete, + params: Params$Resource$Instantsnapshotgroups$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Instantsnapshots$Delete, + params: Params$Resource$Instantsnapshotgroups$Delete, callback: BodyResponseCallback ): void; delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Instantsnapshots$Delete + | Params$Resource$Instantsnapshotgroups$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -55359,12 +55420,12 @@ export namespace compute_alpha { | BodyResponseCallback ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Instantsnapshots$Delete; + {}) as Params$Resource$Instantsnapshotgroups$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Instantsnapshots$Delete; + params = {} as Params$Resource$Instantsnapshotgroups$Delete; options = {}; } @@ -55379,7 +55440,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/zones/{zone}/instantSnapshots/{instantSnapshot}' + '/compute/alpha/projects/{project}/zones/{zone}/instantSnapshotGroups/{instantSnapshotGroup}' ).replace(/([^:]\/)\/+/g, '$1'), method: 'DELETE', apiVersion: '', @@ -55387,8 +55448,8 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project', 'zone', 'instantSnapshot'], - pathParams: ['instantSnapshot', 'project', 'zone'], + requiredParams: ['project', 'zone', 'instantSnapshotGroup'], + pathParams: ['instantSnapshotGroup', 'project', 'zone'], context: this.context, }; if (callback) { @@ -55402,7 +55463,7 @@ export namespace compute_alpha { } /** - * Returns the specified InstantSnapshot resource in the specified zone. + * returns the specified InstantSnapshotGroup resource in the specified zone. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -55410,137 +55471,54 @@ export namespace compute_alpha { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Instantsnapshots$Get, + params: Params$Resource$Instantsnapshotgroups$Get, options: StreamMethodOptions ): GaxiosPromise; get( - params?: Params$Resource$Instantsnapshots$Get, + params?: Params$Resource$Instantsnapshotgroups$Get, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; get( - params: Params$Resource$Instantsnapshots$Get, + params: Params$Resource$Instantsnapshotgroups$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Instantsnapshots$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Instantsnapshotgroups$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Instantsnapshots$Get, - callback: BodyResponseCallback + params: Params$Resource$Instantsnapshotgroups$Get, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; + get(callback: BodyResponseCallback): void; get( paramsOrCallback?: - | Params$Resource$Instantsnapshots$Get - | BodyResponseCallback + | Params$Resource$Instantsnapshotgroups$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Instantsnapshots$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Instantsnapshots$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/compute/alpha/projects/{project}/zones/{zone}/instantSnapshots/{instantSnapshot}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['project', 'zone', 'instantSnapshot'], - pathParams: ['instantSnapshot', 'project', 'zone'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * Gets the access control policy for a resource. May be empty if no such policy or resource exists. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - getIamPolicy( - params: Params$Resource$Instantsnapshots$Getiampolicy, - options: StreamMethodOptions - ): GaxiosPromise; - getIamPolicy( - params?: Params$Resource$Instantsnapshots$Getiampolicy, - options?: MethodOptions - ): GaxiosPromise; - getIamPolicy( - params: Params$Resource$Instantsnapshots$Getiampolicy, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - getIamPolicy( - params: Params$Resource$Instantsnapshots$Getiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - getIamPolicy( - params: Params$Resource$Instantsnapshots$Getiampolicy, - callback: BodyResponseCallback - ): void; - getIamPolicy(callback: BodyResponseCallback): void; - getIamPolicy( - paramsOrCallback?: - | Params$Resource$Instantsnapshots$Getiampolicy - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { + ): + | void + | GaxiosPromise + | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Instantsnapshots$Getiampolicy; + {}) as Params$Resource$Instantsnapshotgroups$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Instantsnapshots$Getiampolicy; + params = {} as Params$Resource$Instantsnapshotgroups$Get; options = {}; } @@ -55555,7 +55533,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/zones/{zone}/instantSnapshots/{resource}/getIamPolicy' + '/compute/alpha/projects/{project}/zones/{zone}/instantSnapshotGroups/{instantSnapshotGroup}' ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', @@ -55563,22 +55541,22 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project', 'zone', 'resource'], - pathParams: ['project', 'resource', 'zone'], + requiredParams: ['project', 'zone', 'instantSnapshotGroup'], + pathParams: ['instantSnapshotGroup', 'project', 'zone'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Creates an instant snapshot in the specified zone. + * inserts a Zonal InstantSnapshotGroup resource * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -55586,31 +55564,31 @@ export namespace compute_alpha { * @returns A promise if used with async/await, or void if used with a callback. */ insert( - params: Params$Resource$Instantsnapshots$Insert, + params: Params$Resource$Instantsnapshotgroups$Insert, options: StreamMethodOptions ): GaxiosPromise; insert( - params?: Params$Resource$Instantsnapshots$Insert, + params?: Params$Resource$Instantsnapshotgroups$Insert, options?: MethodOptions ): GaxiosPromise; insert( - params: Params$Resource$Instantsnapshots$Insert, + params: Params$Resource$Instantsnapshotgroups$Insert, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; insert( - params: Params$Resource$Instantsnapshots$Insert, + params: Params$Resource$Instantsnapshotgroups$Insert, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; insert( - params: Params$Resource$Instantsnapshots$Insert, + params: Params$Resource$Instantsnapshotgroups$Insert, callback: BodyResponseCallback ): void; insert(callback: BodyResponseCallback): void; insert( paramsOrCallback?: - | Params$Resource$Instantsnapshots$Insert + | Params$Resource$Instantsnapshotgroups$Insert | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -55623,12 +55601,12 @@ export namespace compute_alpha { | BodyResponseCallback ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Instantsnapshots$Insert; + {}) as Params$Resource$Instantsnapshotgroups$Insert; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Instantsnapshots$Insert; + params = {} as Params$Resource$Instantsnapshotgroups$Insert; options = {}; } @@ -55643,7 +55621,648 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/zones/{zone}/instantSnapshots' + '/compute/alpha/projects/{project}/zones/{zone}/instantSnapshotGroups' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'zone'], + pathParams: ['project', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * retrieves the list of InstantSnapshotGroup resources contained within the specified zone. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Instantsnapshotgroups$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Instantsnapshotgroups$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Instantsnapshotgroups$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Instantsnapshotgroups$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Instantsnapshotgroups$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Instantsnapshotgroups$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Instantsnapshotgroups$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Instantsnapshotgroups$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/alpha/projects/{project}/zones/{zone}/instantSnapshotGroups' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'zone'], + pathParams: ['project', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Instantsnapshotgroups$Delete + extends StandardParameters { + /** + * Name of the InstantSnapshot resource to delete. + */ + instantSnapshotGroup?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * The name of the zone for this request. + */ + zone?: string; + } + export interface Params$Resource$Instantsnapshotgroups$Get + extends StandardParameters { + /** + * Name of the instantSnapshotGroup resource to return. + */ + instantSnapshotGroup?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the zone for this request. + */ + zone?: string; + } + export interface Params$Resource$Instantsnapshotgroups$Insert + extends StandardParameters { + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * begin_interface: MixerMutationRequestBuilder + */ + sourceConsistencyGroup?: string; + /** + * Name of the zone for this request. + */ + zone?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$InstantSnapshotGroup; + } + export interface Params$Resource$Instantsnapshotgroups$List + extends StandardParameters { + /** + * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. + */ + filter?: string; + /** + * The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) + */ + maxResults?: number; + /** + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. + */ + returnPartialSuccess?: boolean; + /** + * The name of the zone for this request. + */ + zone?: string; + } + + export class Resource$Instantsnapshots { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Retrieves an aggregated list of instantSnapshots. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + aggregatedList( + params: Params$Resource$Instantsnapshots$Aggregatedlist, + options: StreamMethodOptions + ): GaxiosPromise; + aggregatedList( + params?: Params$Resource$Instantsnapshots$Aggregatedlist, + options?: MethodOptions + ): GaxiosPromise; + aggregatedList( + params: Params$Resource$Instantsnapshots$Aggregatedlist, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + aggregatedList( + params: Params$Resource$Instantsnapshots$Aggregatedlist, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + aggregatedList( + params: Params$Resource$Instantsnapshots$Aggregatedlist, + callback: BodyResponseCallback + ): void; + aggregatedList( + callback: BodyResponseCallback + ): void; + aggregatedList( + paramsOrCallback?: + | Params$Resource$Instantsnapshots$Aggregatedlist + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Instantsnapshots$Aggregatedlist; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Instantsnapshots$Aggregatedlist; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/alpha/projects/{project}/aggregated/instantSnapshots' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project'], + pathParams: ['project'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * 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. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Instantsnapshots$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Instantsnapshots$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Instantsnapshots$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Instantsnapshots$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Instantsnapshots$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Instantsnapshots$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Instantsnapshots$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Instantsnapshots$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/alpha/projects/{project}/zones/{zone}/instantSnapshots/{instantSnapshot}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'instantSnapshot'], + pathParams: ['instantSnapshot', 'project', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Returns the specified InstantSnapshot resource in the specified zone. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Instantsnapshots$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Instantsnapshots$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Instantsnapshots$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Instantsnapshots$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Instantsnapshots$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Instantsnapshots$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Instantsnapshots$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Instantsnapshots$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/alpha/projects/{project}/zones/{zone}/instantSnapshots/{instantSnapshot}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'instantSnapshot'], + pathParams: ['instantSnapshot', 'project', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets the access control policy for a resource. May be empty if no such policy or resource exists. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + getIamPolicy( + params: Params$Resource$Instantsnapshots$Getiampolicy, + options: StreamMethodOptions + ): GaxiosPromise; + getIamPolicy( + params?: Params$Resource$Instantsnapshots$Getiampolicy, + options?: MethodOptions + ): GaxiosPromise; + getIamPolicy( + params: Params$Resource$Instantsnapshots$Getiampolicy, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getIamPolicy( + params: Params$Resource$Instantsnapshots$Getiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getIamPolicy( + params: Params$Resource$Instantsnapshots$Getiampolicy, + callback: BodyResponseCallback + ): void; + getIamPolicy(callback: BodyResponseCallback): void; + getIamPolicy( + paramsOrCallback?: + | Params$Resource$Instantsnapshots$Getiampolicy + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Instantsnapshots$Getiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Instantsnapshots$Getiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/alpha/projects/{project}/zones/{zone}/instantSnapshots/{resource}/getIamPolicy' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'resource'], + pathParams: ['project', 'resource', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Creates an instant snapshot in the specified zone. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + insert( + params: Params$Resource$Instantsnapshots$Insert, + options: StreamMethodOptions + ): GaxiosPromise; + insert( + params?: Params$Resource$Instantsnapshots$Insert, + options?: MethodOptions + ): GaxiosPromise; + insert( + params: Params$Resource$Instantsnapshots$Insert, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Instantsnapshots$Insert, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Instantsnapshots$Insert, + callback: BodyResponseCallback + ): void; + insert(callback: BodyResponseCallback): void; + insert( + paramsOrCallback?: + | Params$Resource$Instantsnapshots$Insert + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Instantsnapshots$Insert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Instantsnapshots$Insert; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/alpha/projects/{project}/zones/{zone}/instantSnapshots' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -84356,6 +84975,254 @@ export namespace compute_alpha { requestBody?: Schema$TestPermissionsRequest; } + export class Resource$Regioninstancegroupmanagerresizerequests { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Returns all of the details about the specified resize request. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Regioninstancegroupmanagerresizerequests$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Regioninstancegroupmanagerresizerequests$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Regioninstancegroupmanagerresizerequests$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Regioninstancegroupmanagerresizerequests$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Regioninstancegroupmanagerresizerequests$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Regioninstancegroupmanagerresizerequests$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regioninstancegroupmanagerresizerequests$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Regioninstancegroupmanagerresizerequests$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/alpha/projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/resizeRequests/{resizeRequest}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: [ + 'project', + 'region', + 'instanceGroupManager', + 'resizeRequest', + ], + pathParams: [ + 'instanceGroupManager', + 'project', + 'region', + 'resizeRequest', + ], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Creates a new Resize Request that starts provisioning VMs immediately or queues VM creation. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + insert( + params: Params$Resource$Regioninstancegroupmanagerresizerequests$Insert, + options: StreamMethodOptions + ): GaxiosPromise; + insert( + params?: Params$Resource$Regioninstancegroupmanagerresizerequests$Insert, + options?: MethodOptions + ): GaxiosPromise; + insert( + params: Params$Resource$Regioninstancegroupmanagerresizerequests$Insert, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Regioninstancegroupmanagerresizerequests$Insert, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Regioninstancegroupmanagerresizerequests$Insert, + callback: BodyResponseCallback + ): void; + insert(callback: BodyResponseCallback): void; + insert( + paramsOrCallback?: + | Params$Resource$Regioninstancegroupmanagerresizerequests$Insert + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regioninstancegroupmanagerresizerequests$Insert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Regioninstancegroupmanagerresizerequests$Insert; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/alpha/projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/resizeRequests' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'region', 'instanceGroupManager'], + pathParams: ['instanceGroupManager', 'project', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Regioninstancegroupmanagerresizerequests$Get + extends StandardParameters { + /** + * The name of the managed instance group. Name should conform to RFC1035 or be a resource ID. + */ + instanceGroupManager?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the region scoping this request. Name should conform to RFC1035. + */ + region?: string; + /** + * The name of the resize request. Name should conform to RFC1035 or be a resource ID. + */ + resizeRequest?: string; + } + export interface Params$Resource$Regioninstancegroupmanagerresizerequests$Insert + extends StandardParameters { + /** + * Name of the managed instance group to which the resize request is scoped. Name should conform to RFC1035 or be a resource ID. + */ + instanceGroupManager?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. Name should conform to RFC1035. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$InstanceGroupManagerResizeRequest; + } + export class Resource$Regioninstancegroupmanagers { context: APIRequestContext; constructor(context: APIRequestContext) { @@ -88647,6 +89514,467 @@ export namespace compute_alpha { view?: string; } + export class Resource$Regioninstantsnapshotgroups { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * deletes a Regional InstantSnapshotGroup resource + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Regioninstantsnapshotgroups$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Regioninstantsnapshotgroups$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Regioninstantsnapshotgroups$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Regioninstantsnapshotgroups$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Regioninstantsnapshotgroups$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Regioninstantsnapshotgroups$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regioninstantsnapshotgroups$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regioninstantsnapshotgroups$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/alpha/projects/{project}/regions/{region}/instantSnapshotGroups/{instantSnapshotGroup}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'region', 'instantSnapshotGroup'], + pathParams: ['instantSnapshotGroup', 'project', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * returns the specified InstantSnapshotGroup resource in the specified region. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Regioninstantsnapshotgroups$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Regioninstantsnapshotgroups$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Regioninstantsnapshotgroups$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Regioninstantsnapshotgroups$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Regioninstantsnapshotgroups$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Regioninstantsnapshotgroups$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regioninstantsnapshotgroups$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regioninstantsnapshotgroups$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/alpha/projects/{project}/regions/{region}/instantSnapshotGroups/{instantSnapshot}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'region', 'instantSnapshot'], + pathParams: ['instantSnapshot', 'project', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * creates a Regional InstantSnapshotGroup resource + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + insert( + params: Params$Resource$Regioninstantsnapshotgroups$Insert, + options: StreamMethodOptions + ): GaxiosPromise; + insert( + params?: Params$Resource$Regioninstantsnapshotgroups$Insert, + options?: MethodOptions + ): GaxiosPromise; + insert( + params: Params$Resource$Regioninstantsnapshotgroups$Insert, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Regioninstantsnapshotgroups$Insert, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Regioninstantsnapshotgroups$Insert, + callback: BodyResponseCallback + ): void; + insert(callback: BodyResponseCallback): void; + insert( + paramsOrCallback?: + | Params$Resource$Regioninstantsnapshotgroups$Insert + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regioninstantsnapshotgroups$Insert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regioninstantsnapshotgroups$Insert; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/alpha/projects/{project}/regions/{region}/instantSnapshotGroups' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'region'], + pathParams: ['project', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * retrieves the list of InstantSnapshotGroup resources contained within the specified region. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Regioninstantsnapshotgroups$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Regioninstantsnapshotgroups$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Regioninstantsnapshotgroups$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Regioninstantsnapshotgroups$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Regioninstantsnapshotgroups$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Regioninstantsnapshotgroups$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regioninstantsnapshotgroups$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regioninstantsnapshotgroups$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/alpha/projects/{project}/regions/{region}/instantSnapshotGroups' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'region'], + pathParams: ['project', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Regioninstantsnapshotgroups$Delete + extends StandardParameters { + /** + * Name of the InstantSnapshotGroup resource to delete. + */ + instantSnapshotGroup?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the region for this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + } + export interface Params$Resource$Regioninstantsnapshotgroups$Get + extends StandardParameters { + /** + * Name of the InstantSnapshotGroup resource to return. + */ + instantSnapshot?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the region for this request. + */ + region?: string; + } + export interface Params$Resource$Regioninstantsnapshotgroups$Insert + extends StandardParameters { + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region for this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * begin_interface: MixerMutationRequestBuilder + */ + sourceConsistencyGroup?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$InstantSnapshotGroup; + } + export interface Params$Resource$Regioninstantsnapshotgroups$List + extends StandardParameters { + /** + * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. + */ + filter?: string; + /** + * The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) + */ + maxResults?: number; + /** + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the region for this request. + */ + region?: string; + /** + * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. + */ + returnPartialSuccess?: boolean; + } + export class Resource$Regioninstantsnapshots { context: APIRequestContext; constructor(context: APIRequestContext) { @@ -93981,7 +95309,7 @@ export namespace compute_alpha { } /** - * 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. + * 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. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. diff --git a/src/apis/compute/beta.ts b/src/apis/compute/beta.ts index 3b6366009f..f2ef635068 100644 --- a/src/apis/compute/beta.ts +++ b/src/apis/compute/beta.ts @@ -1803,11 +1803,18 @@ export namespace compute_beta { * 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?: string | null; + /** + * Describes the HTTP cookie used for stateful session affinity. This field is applicable and required if the sessionAffinity is set to STRONG_COOKIE_AFFINITY. + */ + strongSessionAffinityCookie?: Schema$BackendServiceHttpCookie; subsetting?: Schema$Subsetting; /** * 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. */ timeoutSec?: number | null; + /** + * [Output Only] List of resources referencing given backend service. + */ usedBy?: Schema$BackendServiceUsedBy[]; } /** @@ -1974,6 +1981,23 @@ export namespace compute_beta { */ kind?: string | null; } + /** + * The HTTP cookie used for stateful session affinity. + */ + export interface Schema$BackendServiceHttpCookie { + /** + * Name of the cookie. + */ + name?: string | null; + /** + * Path to set for the cookie. + */ + path?: string | null; + /** + * Lifetime of the cookie. + */ + ttl?: Schema$Duration; + } /** * Identity-Aware Proxy */ @@ -2129,6 +2153,9 @@ export namespace compute_beta { } | null; } export interface Schema$BackendServiceUsedBy { + /** + * [Output Only] Server-defined URL for resources referencing given BackendService like UrlMaps, TargetTcpProxies, TargetSslProxies and ForwardingRule. + */ reference?: string | null; } export interface Schema$BfdPacket { @@ -3822,6 +3849,10 @@ export namespace compute_beta { * 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. */ name?: string | null; + /** + * A list of packet mirroring rules that belong to this policy. + */ + packetMirroringRules?: Schema$FirewallPolicyRule[]; /** * [Output Only] The parent of the firewall policy. This field is not applicable to network firewall policies. */ @@ -6252,7 +6283,7 @@ export namespace compute_beta { */ autoHealingPolicies?: Schema$InstanceGroupManagerAutoHealingPolicy[]; /** - * The base instance name to use for instances in this group. The value must be 1-58 characters long. Instances are named by appending a hyphen and a random four-character string to the base instance name. The base instance name must comply with RFC1035. + * 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,52\}-#{1,10\}(\\[[0-9]{1,10\}\\])?)) */ baseInstanceName?: string | null; /** @@ -7400,6 +7431,10 @@ export namespace compute_beta { * [Output Only] The name of the firewall policy. */ name?: string | null; + /** + * [Output only] Priority of firewall policy association. Not applicable for type=HIERARCHY. + */ + priority?: number | null; /** * The rules that apply to the network. */ @@ -9875,10 +9910,6 @@ export namespace compute_beta { * Represents the port number to which PSC consumer sends packets. Only valid for network endpoint groups created with GCE_VM_IP_PORTMAP endpoint type. */ clientDestinationPort?: number | null; - /** - * Represents the port number to which PSC consumer sends packets. Only valid for network endpoint groups created with CLIENT_PORT_PER_ENDPOINT mapping mode. - */ - clientPort?: number | null; /** * Optional fully qualified domain name of network endpoint. This can only be specified when NetworkEndpointGroup.network_endpoint_type is NON_GCP_FQDN_PORT. */ @@ -9912,10 +9943,6 @@ export namespace compute_beta { * Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. */ appEngine?: Schema$NetworkEndpointGroupAppEngine; - /** - * Only valid when networkEndpointType is GCE_VM_IP_PORT and the NEG is regional. - */ - clientPortMappingMode?: string | null; /** * Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. */ @@ -12843,6 +12870,10 @@ export namespace compute_beta { * [Output Only] The name of the firewall policy. */ name?: string | null; + /** + * [Output only] Priority of firewall policy association. Not applicable for type=HIERARCHY. + */ + priority?: number | null; /** * The rules that apply to the network. */ @@ -13449,6 +13480,10 @@ export namespace compute_beta { upcomingMaintenance?: Schema$UpcomingMaintenance; } export interface Schema$ResourceStatusScheduling { + /** + * 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. + */ + availabilityDomain?: number | null; /** * Time in future when the instance will be terminated in RFC3339 text format. */ @@ -14538,6 +14573,10 @@ export namespace compute_beta { * 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. */ automaticRestart?: boolean | null; + /** + * 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. + */ + availabilityDomain?: number | null; /** * 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. */ @@ -18817,7 +18856,7 @@ export namespace compute_beta { */ selfLink?: string | null; /** - * The stack type for this VPN gateway to identify the IP protocols that are enabled. Possible values are: IPV4_ONLY, IPV4_IPV6. If not specified, IPV4_ONLY will be used. + * 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. */ stackType?: string | null; /** @@ -27707,6 +27746,96 @@ export namespace compute_beta { } } + /** + * Inserts a packet mirroring rule into a firewall policy. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + addPacketMirroringRule( + params: Params$Resource$Firewallpolicies$Addpacketmirroringrule, + options: StreamMethodOptions + ): GaxiosPromise; + addPacketMirroringRule( + params?: Params$Resource$Firewallpolicies$Addpacketmirroringrule, + options?: MethodOptions + ): GaxiosPromise; + addPacketMirroringRule( + params: Params$Resource$Firewallpolicies$Addpacketmirroringrule, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + addPacketMirroringRule( + params: Params$Resource$Firewallpolicies$Addpacketmirroringrule, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + addPacketMirroringRule( + params: Params$Resource$Firewallpolicies$Addpacketmirroringrule, + callback: BodyResponseCallback + ): void; + addPacketMirroringRule( + callback: BodyResponseCallback + ): void; + addPacketMirroringRule( + paramsOrCallback?: + | Params$Resource$Firewallpolicies$Addpacketmirroringrule + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Firewallpolicies$Addpacketmirroringrule; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Firewallpolicies$Addpacketmirroringrule; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/beta/locations/global/firewallPolicies/{firewallPolicy}/addPacketMirroringRule' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['firewallPolicy'], + pathParams: ['firewallPolicy'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + /** * Inserts a rule into a firewall policy. * @@ -28242,6 +28371,99 @@ export namespace compute_beta { } } + /** + * Gets a packet mirroring rule of the specified priority. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + getPacketMirroringRule( + params: Params$Resource$Firewallpolicies$Getpacketmirroringrule, + options: StreamMethodOptions + ): GaxiosPromise; + getPacketMirroringRule( + params?: Params$Resource$Firewallpolicies$Getpacketmirroringrule, + options?: MethodOptions + ): GaxiosPromise; + getPacketMirroringRule( + params: Params$Resource$Firewallpolicies$Getpacketmirroringrule, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getPacketMirroringRule( + params: Params$Resource$Firewallpolicies$Getpacketmirroringrule, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getPacketMirroringRule( + params: Params$Resource$Firewallpolicies$Getpacketmirroringrule, + callback: BodyResponseCallback + ): void; + getPacketMirroringRule( + callback: BodyResponseCallback + ): void; + getPacketMirroringRule( + paramsOrCallback?: + | Params$Resource$Firewallpolicies$Getpacketmirroringrule + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Firewallpolicies$Getpacketmirroringrule; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Firewallpolicies$Getpacketmirroringrule; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/beta/locations/global/firewallPolicies/{firewallPolicy}/getPacketMirroringRule' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['firewallPolicy'], + pathParams: ['firewallPolicy'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + /** * Gets a rule of the specified priority. * @@ -28783,6 +29005,97 @@ export namespace compute_beta { } } + /** + * Patches a packet mirroring rule of the specified priority. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + patchPacketMirroringRule( + params: Params$Resource$Firewallpolicies$Patchpacketmirroringrule, + options: StreamMethodOptions + ): GaxiosPromise; + patchPacketMirroringRule( + params?: Params$Resource$Firewallpolicies$Patchpacketmirroringrule, + options?: MethodOptions + ): GaxiosPromise; + patchPacketMirroringRule( + params: Params$Resource$Firewallpolicies$Patchpacketmirroringrule, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patchPacketMirroringRule( + params: Params$Resource$Firewallpolicies$Patchpacketmirroringrule, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patchPacketMirroringRule( + params: Params$Resource$Firewallpolicies$Patchpacketmirroringrule, + callback: BodyResponseCallback + ): void; + patchPacketMirroringRule( + callback: BodyResponseCallback + ): void; + patchPacketMirroringRule( + paramsOrCallback?: + | Params$Resource$Firewallpolicies$Patchpacketmirroringrule + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Firewallpolicies$Patchpacketmirroringrule; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Firewallpolicies$Patchpacketmirroringrule; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/beta/locations/global/firewallPolicies/{firewallPolicy}/patchPacketMirroringRule' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['firewallPolicy'], + pathParams: ['firewallPolicy'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + /** * Patches a rule of the specified priority. * @@ -28959,6 +29272,97 @@ export namespace compute_beta { } } + /** + * Deletes a packet mirroring rule of the specified priority. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + removePacketMirroringRule( + params: Params$Resource$Firewallpolicies$Removepacketmirroringrule, + options: StreamMethodOptions + ): GaxiosPromise; + removePacketMirroringRule( + params?: Params$Resource$Firewallpolicies$Removepacketmirroringrule, + options?: MethodOptions + ): GaxiosPromise; + removePacketMirroringRule( + params: Params$Resource$Firewallpolicies$Removepacketmirroringrule, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + removePacketMirroringRule( + params: Params$Resource$Firewallpolicies$Removepacketmirroringrule, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + removePacketMirroringRule( + params: Params$Resource$Firewallpolicies$Removepacketmirroringrule, + callback: BodyResponseCallback + ): void; + removePacketMirroringRule( + callback: BodyResponseCallback + ): void; + removePacketMirroringRule( + paramsOrCallback?: + | Params$Resource$Firewallpolicies$Removepacketmirroringrule + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Firewallpolicies$Removepacketmirroringrule; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Firewallpolicies$Removepacketmirroringrule; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/beta/locations/global/firewallPolicies/{firewallPolicy}/removePacketMirroringRule' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['firewallPolicy'], + pathParams: ['firewallPolicy'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + /** * Deletes a rule of the specified priority. * @@ -29251,6 +29655,22 @@ export namespace compute_beta { */ requestBody?: Schema$FirewallPolicyAssociation; } + export interface Params$Resource$Firewallpolicies$Addpacketmirroringrule + extends StandardParameters { + /** + * Name of the firewall policy to update. + */ + firewallPolicy?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$FirewallPolicyRule; + } export interface Params$Resource$Firewallpolicies$Addrule extends StandardParameters { /** @@ -29322,6 +29742,17 @@ export namespace compute_beta { */ resource?: string; } + export interface Params$Resource$Firewallpolicies$Getpacketmirroringrule + extends StandardParameters { + /** + * Name of the firewall policy to which the queried rule belongs. + */ + firewallPolicy?: string; + /** + * The priority of the rule to get from the firewall policy. + */ + priority?: number; + } export interface Params$Resource$Firewallpolicies$Getrule extends StandardParameters { /** @@ -29414,6 +29845,26 @@ export namespace compute_beta { */ requestBody?: Schema$FirewallPolicy; } + export interface Params$Resource$Firewallpolicies$Patchpacketmirroringrule + extends StandardParameters { + /** + * Name of the firewall policy to update. + */ + firewallPolicy?: string; + /** + * The priority of the rule to patch. + */ + priority?: number; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$FirewallPolicyRule; + } export interface Params$Resource$Firewallpolicies$Patchrule extends StandardParameters { /** @@ -29449,6 +29900,21 @@ export namespace compute_beta { */ requestId?: string; } + export interface Params$Resource$Firewallpolicies$Removepacketmirroringrule + extends StandardParameters { + /** + * Name of the firewall policy to update. + */ + firewallPolicy?: string; + /** + * The priority of the rule to remove from the firewall policy. + */ + priority?: number; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + } export interface Params$Resource$Firewallpolicies$Removerule extends StandardParameters { /** @@ -59902,6 +60368,97 @@ export namespace compute_beta { } } + /** + * Inserts a packet mirroring rule into a firewall policy. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + addPacketMirroringRule( + params: Params$Resource$Networkfirewallpolicies$Addpacketmirroringrule, + options: StreamMethodOptions + ): GaxiosPromise; + addPacketMirroringRule( + params?: Params$Resource$Networkfirewallpolicies$Addpacketmirroringrule, + options?: MethodOptions + ): GaxiosPromise; + addPacketMirroringRule( + params: Params$Resource$Networkfirewallpolicies$Addpacketmirroringrule, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + addPacketMirroringRule( + params: Params$Resource$Networkfirewallpolicies$Addpacketmirroringrule, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + addPacketMirroringRule( + params: Params$Resource$Networkfirewallpolicies$Addpacketmirroringrule, + callback: BodyResponseCallback + ): void; + addPacketMirroringRule( + callback: BodyResponseCallback + ): void; + addPacketMirroringRule( + paramsOrCallback?: + | Params$Resource$Networkfirewallpolicies$Addpacketmirroringrule + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Networkfirewallpolicies$Addpacketmirroringrule; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Networkfirewallpolicies$Addpacketmirroringrule; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/beta/projects/{project}/global/firewallPolicies/{firewallPolicy}/addPacketMirroringRule' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'firewallPolicy'], + pathParams: ['firewallPolicy', 'project'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + /** * Inserts a rule into a firewall policy. * @@ -60437,6 +60994,100 @@ export namespace compute_beta { } } + /** + * Gets a packet mirroring rule of the specified priority. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + getPacketMirroringRule( + params: Params$Resource$Networkfirewallpolicies$Getpacketmirroringrule, + options: StreamMethodOptions + ): GaxiosPromise; + getPacketMirroringRule( + params?: Params$Resource$Networkfirewallpolicies$Getpacketmirroringrule, + options?: MethodOptions + ): GaxiosPromise; + getPacketMirroringRule( + params: Params$Resource$Networkfirewallpolicies$Getpacketmirroringrule, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getPacketMirroringRule( + params: Params$Resource$Networkfirewallpolicies$Getpacketmirroringrule, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getPacketMirroringRule( + params: Params$Resource$Networkfirewallpolicies$Getpacketmirroringrule, + callback: BodyResponseCallback + ): void; + getPacketMirroringRule( + callback: BodyResponseCallback + ): void; + getPacketMirroringRule( + paramsOrCallback?: + | Params$Resource$Networkfirewallpolicies$Getpacketmirroringrule + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Networkfirewallpolicies$Getpacketmirroringrule; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Networkfirewallpolicies$Getpacketmirroringrule; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/beta/projects/{project}/global/firewallPolicies/{firewallPolicy}/getPacketMirroringRule' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'firewallPolicy'], + pathParams: ['firewallPolicy', 'project'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + /** * Gets a rule of the specified priority. * @@ -60795,6 +61446,97 @@ export namespace compute_beta { } } + /** + * Patches a packet mirroring rule of the specified priority. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + patchPacketMirroringRule( + params: Params$Resource$Networkfirewallpolicies$Patchpacketmirroringrule, + options: StreamMethodOptions + ): GaxiosPromise; + patchPacketMirroringRule( + params?: Params$Resource$Networkfirewallpolicies$Patchpacketmirroringrule, + options?: MethodOptions + ): GaxiosPromise; + patchPacketMirroringRule( + params: Params$Resource$Networkfirewallpolicies$Patchpacketmirroringrule, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patchPacketMirroringRule( + params: Params$Resource$Networkfirewallpolicies$Patchpacketmirroringrule, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patchPacketMirroringRule( + params: Params$Resource$Networkfirewallpolicies$Patchpacketmirroringrule, + callback: BodyResponseCallback + ): void; + patchPacketMirroringRule( + callback: BodyResponseCallback + ): void; + patchPacketMirroringRule( + paramsOrCallback?: + | Params$Resource$Networkfirewallpolicies$Patchpacketmirroringrule + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Networkfirewallpolicies$Patchpacketmirroringrule; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Networkfirewallpolicies$Patchpacketmirroringrule; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/beta/projects/{project}/global/firewallPolicies/{firewallPolicy}/patchPacketMirroringRule' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'firewallPolicy'], + pathParams: ['firewallPolicy', 'project'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + /** * Patches a rule of the specified priority. * @@ -60972,6 +61714,97 @@ export namespace compute_beta { } } + /** + * Deletes a packet mirroring rule of the specified priority. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + removePacketMirroringRule( + params: Params$Resource$Networkfirewallpolicies$Removepacketmirroringrule, + options: StreamMethodOptions + ): GaxiosPromise; + removePacketMirroringRule( + params?: Params$Resource$Networkfirewallpolicies$Removepacketmirroringrule, + options?: MethodOptions + ): GaxiosPromise; + removePacketMirroringRule( + params: Params$Resource$Networkfirewallpolicies$Removepacketmirroringrule, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + removePacketMirroringRule( + params: Params$Resource$Networkfirewallpolicies$Removepacketmirroringrule, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + removePacketMirroringRule( + params: Params$Resource$Networkfirewallpolicies$Removepacketmirroringrule, + callback: BodyResponseCallback + ): void; + removePacketMirroringRule( + callback: BodyResponseCallback + ): void; + removePacketMirroringRule( + paramsOrCallback?: + | Params$Resource$Networkfirewallpolicies$Removepacketmirroringrule + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Networkfirewallpolicies$Removepacketmirroringrule; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Networkfirewallpolicies$Removepacketmirroringrule; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/beta/projects/{project}/global/firewallPolicies/{firewallPolicy}/removePacketMirroringRule' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'firewallPolicy'], + pathParams: ['firewallPolicy', 'project'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + /** * Deletes a rule of the specified priority. * @@ -61269,6 +62102,34 @@ export namespace compute_beta { */ requestBody?: Schema$FirewallPolicyAssociation; } + export interface Params$Resource$Networkfirewallpolicies$Addpacketmirroringrule + extends StandardParameters { + /** + * Name of the firewall policy to update. + */ + firewallPolicy?: string; + /** + * When rule.priority is not specified, auto choose a unused priority between minPriority and maxPriority\>. This field is exclusive with rule.priority. + */ + maxPriority?: number; + /** + * When rule.priority is not specified, auto choose a unused priority between minPriority and maxPriority\>. This field is exclusive with rule.priority. + */ + minPriority?: number; + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$FirewallPolicyRule; + } export interface Params$Resource$Networkfirewallpolicies$Addrule extends StandardParameters { /** @@ -61372,6 +62233,21 @@ export namespace compute_beta { */ resource?: string; } + export interface Params$Resource$Networkfirewallpolicies$Getpacketmirroringrule + extends StandardParameters { + /** + * Name of the firewall policy to which the queried rule belongs. + */ + firewallPolicy?: string; + /** + * The priority of the rule to get from the firewall policy. + */ + priority?: number; + /** + * Project ID for this request. + */ + project?: string; + } export interface Params$Resource$Networkfirewallpolicies$Getrule extends StandardParameters { /** @@ -61450,6 +62326,30 @@ export namespace compute_beta { */ requestBody?: Schema$FirewallPolicy; } + export interface Params$Resource$Networkfirewallpolicies$Patchpacketmirroringrule + extends StandardParameters { + /** + * Name of the firewall policy to update. + */ + firewallPolicy?: string; + /** + * The priority of the rule to patch. + */ + priority?: number; + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$FirewallPolicyRule; + } export interface Params$Resource$Networkfirewallpolicies$Patchrule extends StandardParameters { /** @@ -61493,6 +62393,25 @@ export namespace compute_beta { */ requestId?: string; } + export interface Params$Resource$Networkfirewallpolicies$Removepacketmirroringrule + extends StandardParameters { + /** + * Name of the firewall policy to update. + */ + firewallPolicy?: string; + /** + * The priority of the rule to remove from the firewall policy. + */ + priority?: number; + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + } export interface Params$Resource$Networkfirewallpolicies$Removerule extends StandardParameters { /** @@ -86920,7 +87839,7 @@ export namespace compute_beta { } /** - * 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. + * 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. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. diff --git a/src/apis/compute/v1.ts b/src/apis/compute/v1.ts index a5f20c9eab..35fc1b3801 100644 --- a/src/apis/compute/v1.ts +++ b/src/apis/compute/v1.ts @@ -1757,6 +1757,9 @@ export namespace compute_v1 { * 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. */ timeoutSec?: number | null; + /** + * [Output Only] List of resources referencing given backend service. + */ usedBy?: Schema$BackendServiceUsedBy[]; } /** @@ -2078,6 +2081,9 @@ export namespace compute_v1 { } | null; } export interface Schema$BackendServiceUsedBy { + /** + * [Output Only] Server-defined URL for resources referencing given BackendService like UrlMaps, TargetTcpProxies, TargetSslProxies and ForwardingRule. + */ reference?: string | null; } export interface Schema$BfdPacket { @@ -5775,7 +5781,7 @@ export namespace compute_v1 { */ autoHealingPolicies?: Schema$InstanceGroupManagerAutoHealingPolicy[]; /** - * The base instance name to use for instances in this group. The value must be 1-58 characters long. Instances are named by appending a hyphen and a random four-character string to the base instance name. The base instance name must comply with RFC1035. + * 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,52\}-#{1,10\}(\\[[0-9]{1,10\}\\])?)) */ baseInstanceName?: string | null; /** @@ -13518,6 +13524,10 @@ export namespace compute_v1 { * 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. */ automaticRestart?: boolean | null; + /** + * 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. + */ + availabilityDomain?: number | null; /** * Specifies the termination action for the instance. */ @@ -17540,7 +17550,7 @@ export namespace compute_v1 { */ selfLink?: string | null; /** - * The stack type for this VPN gateway to identify the IP protocols that are enabled. Possible values are: IPV4_ONLY, IPV4_IPV6. If not specified, IPV4_ONLY will be used. + * 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. */ stackType?: string | null; /** @@ -78463,7 +78473,7 @@ export namespace compute_v1 { } /** - * 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. + * 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. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. diff --git a/src/apis/connectors/v1.ts b/src/apis/connectors/v1.ts index 15d7b90c18..769a500723 100644 --- a/src/apis/connectors/v1.ts +++ b/src/apis/connectors/v1.ts @@ -227,7 +227,7 @@ export namespace connectors_v1 { /** * Optional. Omit query params from the redirect URI. */ - omitQueryParams?: string | null; + omitQueryParams?: boolean | null; /** * The scopes for which the user will authorize Google Cloud Connectors on the connector data source. */ @@ -2134,7 +2134,7 @@ export namespace connectors_v1 { */ multipleSelectOptions?: Schema$MultipleSelectOption[]; /** - * Required. Value separator. + * Required. Value separator. Only "," can be used for OAuth auth code flow scope field. */ valueSeparator?: string | null; } @@ -2496,6 +2496,10 @@ export namespace connectors_v1 { * The data type of the field. */ dataType?: string | null; + /** + * The following field specifies the default value of the Parameter provided by the external system if a value is not provided. + */ + defaultValue?: any | null; /** * A brief description of the field. */ @@ -2508,6 +2512,10 @@ export namespace connectors_v1 { * JsonSchema representation of this action's result */ jsonSchema?: Schema$JsonSchema; + /** + * Specifies whether a null value is allowed. + */ + nullable?: boolean | null; } /** * Request message for ConnectorsService.RefreshEventSubscription diff --git a/src/apis/connectors/v2.ts b/src/apis/connectors/v2.ts index fdd3293a54..8861e291d8 100644 --- a/src/apis/connectors/v2.ts +++ b/src/apis/connectors/v2.ts @@ -754,6 +754,10 @@ export namespace connectors_v2 { * The data type of the metadata field */ dataType?: string | null; + /** + * The following field specifies the default value of the Parameter provided by the external system if a value is not provided. + */ + defaultValue?: any | null; /** * A brief description of the metadata field. */ @@ -766,6 +770,10 @@ export namespace connectors_v2 { * Name of the metadata field. */ name?: string | null; + /** + * Specifies whether a null value is allowed. + */ + nullable?: boolean | null; } /** * Configure the schedule. diff --git a/src/apis/contactcenterinsights/v1.ts b/src/apis/contactcenterinsights/v1.ts index 29293368f7..0a36ff1597 100644 --- a/src/apis/contactcenterinsights/v1.ts +++ b/src/apis/contactcenterinsights/v1.ts @@ -1580,6 +1580,10 @@ export namespace contactcenterinsights_v1 { * Query text. Article Search uses this to store the input query used to generate the search results. */ query?: string | null; + /** + * Query source for the answer. + */ + querySource?: string | null; } /** * The data for a sentiment annotation. @@ -3449,6 +3453,10 @@ export namespace contactcenterinsights_v1 { * Query text. Article Search uses this to store the input query used to generate the search results. */ query?: string | null; + /** + * Query source for the answer. + */ + querySource?: string | null; } /** * The data for a sentiment annotation. diff --git a/src/apis/container/v1.ts b/src/apis/container/v1.ts index 7be0c5cdf0..c1332b9a84 100644 --- a/src/apis/container/v1.ts +++ b/src/apis/container/v1.ts @@ -167,15 +167,15 @@ export namespace container_v1 { */ export interface Schema$AdditionalPodNetworkConfig { /** - * The maximum number of pods per node which use this pod network + * The maximum number of pods per node which use this pod network. */ maxPodsPerNode?: Schema$MaxPodsConstraint; /** - * The name of the secondary range on the subnet which provides IP address for this pod range + * The name of the secondary range on the subnet which provides IP address for this pod range. */ secondaryPodRange?: string | null; /** - * Name of the subnetwork where the additional pod network belongs + * Name of the subnetwork where the additional pod network belongs. */ subnetwork?: string | null; } @@ -240,6 +240,10 @@ export namespace container_v1 { * Configuration for NetworkPolicy. This only tracks whether the addon is enabled or not on the Master, it does not track whether network policy is enabled for the nodes. */ networkPolicyConfig?: Schema$NetworkPolicyConfig; + /** + * Optional. Configuration for Ray Operator addon. + */ + rayOperatorConfig?: Schema$RayOperatorConfig; /** * Optional. Configuration for the StatefulHA add-on. */ @@ -2800,6 +2804,41 @@ export namespace container_v1 { */ utilization?: number | null; } + /** + * RayClusterLoggingConfig specifies configuration of Ray logging. + */ + export interface Schema$RayClusterLoggingConfig { + /** + * Enable log collection for Ray clusters. + */ + enabled?: boolean | null; + } + /** + * RayClusterMonitoringConfig specifies monitoring configuration for Ray clusters. + */ + export interface Schema$RayClusterMonitoringConfig { + /** + * Enable metrics collection for Ray clusters. + */ + enabled?: boolean | null; + } + /** + * Configuration options for the Ray Operator add-on. + */ + export interface Schema$RayOperatorConfig { + /** + * Whether the Ray Operator addon is enabled for this cluster. + */ + enabled?: boolean | null; + /** + * Optional. Logging configuration for Ray clusters. + */ + rayClusterLoggingConfig?: Schema$RayClusterLoggingConfig; + /** + * Optional. Monitoring configuration for Ray clusters. + */ + rayClusterMonitoringConfig?: Schema$RayClusterMonitoringConfig; + } /** * Represents an arbitrary window of time that recurs. */ diff --git a/src/apis/container/v1beta1.ts b/src/apis/container/v1beta1.ts index 36d273378a..f1cb54f034 100644 --- a/src/apis/container/v1beta1.ts +++ b/src/apis/container/v1beta1.ts @@ -252,6 +252,10 @@ export namespace container_v1beta1 { * Configuration for NetworkPolicy. This only tracks whether the addon is enabled or not on the Master, it does not track whether network policy is enabled for the nodes. */ networkPolicyConfig?: Schema$NetworkPolicyConfig; + /** + * Optional. Configuration for Ray Operator addon. + */ + rayOperatorConfig?: Schema$RayOperatorConfig; /** * Optional. Configuration for the StatefulHA add-on. */ @@ -3125,6 +3129,41 @@ export namespace container_v1beta1 { */ utilization?: number | null; } + /** + * RayClusterLoggingConfig specifies logging configuration for Ray clusters. + */ + export interface Schema$RayClusterLoggingConfig { + /** + * Enable log collection for Ray clusters. + */ + enabled?: boolean | null; + } + /** + * RayClusterMonitoringConfig specifies monitoring configuration for Ray clusters. + */ + export interface Schema$RayClusterMonitoringConfig { + /** + * Enable metrics collection for Ray clusters. + */ + enabled?: boolean | null; + } + /** + * Configuration options for the Ray Operator add-on. + */ + export interface Schema$RayOperatorConfig { + /** + * Whether the Ray addon is enabled for this cluster. + */ + enabled?: boolean | null; + /** + * Optional. Logging configuration for Ray clusters. + */ + rayClusterLoggingConfig?: Schema$RayClusterLoggingConfig; + /** + * Optional. Monitoring configuration for Ray clusters. + */ + rayClusterMonitoringConfig?: Schema$RayClusterMonitoringConfig; + } /** * Represents an arbitrary window of time that recurs. */ diff --git a/src/apis/containeranalysis/v1.ts b/src/apis/containeranalysis/v1.ts index aecfcb2902..d743136678 100644 --- a/src/apis/containeranalysis/v1.ts +++ b/src/apis/containeranalysis/v1.ts @@ -1113,23 +1113,6 @@ export namespace containeranalysis_v1 { */ fileHash?: Schema$ContaineranalysisGoogleDevtoolsCloudbuildV1Hash[]; } - /** - * Represents a storage location in Cloud Storage - */ - export interface Schema$ContaineranalysisGoogleDevtoolsCloudbuildV1GCSLocation { - /** - * Cloud Storage bucket. See https://cloud.google.com/storage/docs/naming#requirements - */ - bucket?: string | null; - /** - * Cloud Storage generation for the object. If the generation is omitted, the latest generation will be used. - */ - generation?: string | null; - /** - * Cloud Storage object. See https://cloud.google.com/storage/docs/naming#objectnames - */ - object?: string | null; - } /** * GitConfig is a configuration for git operations. */ @@ -1144,13 +1127,9 @@ export namespace containeranalysis_v1 { */ export interface Schema$ContaineranalysisGoogleDevtoolsCloudbuildV1GitConfigHttpConfig { /** - * SecretVersion resource of the HTTP proxy URL. The proxy URL should be in format protocol://@]proxyhost[:port]. + * 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]`. */ proxySecretVersionName?: string | null; - /** - * Optional. Cloud Storage object storing the certificate to use with the HTTP proxy. - */ - proxySslCaInfo?: Schema$ContaineranalysisGoogleDevtoolsCloudbuildV1GCSLocation; } /** * Location of the source in any accessible Git repository. @@ -1696,10 +1675,6 @@ export namespace containeranalysis_v1 { * The status of an SBOM generation. */ sbomStatus?: Schema$SBOMStatus; - /** - * The status of an vulnerability attestation generation. - */ - vulnerabilityAttestation?: Schema$VulnerabilityAttestation; } /** * This represents a particular channel of distribution for a given package. E.g., Debian's jessie-backports dpkg mirror. @@ -3175,23 +3150,6 @@ export namespace containeranalysis_v1 { */ title?: string | null; } - /** - * The status of an vulnerability attestation generation. - */ - export interface Schema$VulnerabilityAttestation { - /** - * If failure, the error reason for why the attestation generation failed. - */ - error?: string | null; - /** - * The last time we attempted to generate an attestation. - */ - lastAttemptTime?: string | null; - /** - * The success/failure state of the latest attestation attempt. - */ - state?: string | null; - } /** * A security vulnerability that can be found in resources. */ diff --git a/src/apis/containeranalysis/v1alpha1.ts b/src/apis/containeranalysis/v1alpha1.ts index 543aa56214..35b902ae01 100644 --- a/src/apis/containeranalysis/v1alpha1.ts +++ b/src/apis/containeranalysis/v1alpha1.ts @@ -1093,23 +1093,6 @@ export namespace containeranalysis_v1alpha1 { */ fileHash?: Schema$ContaineranalysisGoogleDevtoolsCloudbuildV1Hash[]; } - /** - * Represents a storage location in Cloud Storage - */ - export interface Schema$ContaineranalysisGoogleDevtoolsCloudbuildV1GCSLocation { - /** - * Cloud Storage bucket. See https://cloud.google.com/storage/docs/naming#requirements - */ - bucket?: string | null; - /** - * Cloud Storage generation for the object. If the generation is omitted, the latest generation will be used. - */ - generation?: string | null; - /** - * Cloud Storage object. See https://cloud.google.com/storage/docs/naming#objectnames - */ - object?: string | null; - } /** * GitConfig is a configuration for git operations. */ @@ -1124,13 +1107,9 @@ export namespace containeranalysis_v1alpha1 { */ export interface Schema$ContaineranalysisGoogleDevtoolsCloudbuildV1GitConfigHttpConfig { /** - * SecretVersion resource of the HTTP proxy URL. The proxy URL should be in format protocol://@]proxyhost[:port]. + * 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]`. */ proxySecretVersionName?: string | null; - /** - * Optional. Cloud Storage object storing the certificate to use with the HTTP proxy. - */ - proxySslCaInfo?: Schema$ContaineranalysisGoogleDevtoolsCloudbuildV1GCSLocation; } /** * Location of the source in any accessible Git repository. diff --git a/src/apis/containeranalysis/v1beta1.ts b/src/apis/containeranalysis/v1beta1.ts index ab5692d094..c6ed110874 100644 --- a/src/apis/containeranalysis/v1beta1.ts +++ b/src/apis/containeranalysis/v1beta1.ts @@ -1037,23 +1037,6 @@ export namespace containeranalysis_v1beta1 { */ fileHash?: Schema$ContaineranalysisGoogleDevtoolsCloudbuildV1Hash[]; } - /** - * Represents a storage location in Cloud Storage - */ - export interface Schema$ContaineranalysisGoogleDevtoolsCloudbuildV1GCSLocation { - /** - * Cloud Storage bucket. See https://cloud.google.com/storage/docs/naming#requirements - */ - bucket?: string | null; - /** - * Cloud Storage generation for the object. If the generation is omitted, the latest generation will be used. - */ - generation?: string | null; - /** - * Cloud Storage object. See https://cloud.google.com/storage/docs/naming#objectnames - */ - object?: string | null; - } /** * GitConfig is a configuration for git operations. */ @@ -1068,13 +1051,9 @@ export namespace containeranalysis_v1beta1 { */ export interface Schema$ContaineranalysisGoogleDevtoolsCloudbuildV1GitConfigHttpConfig { /** - * SecretVersion resource of the HTTP proxy URL. The proxy URL should be in format protocol://@]proxyhost[:port]. + * 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]`. */ proxySecretVersionName?: string | null; - /** - * Optional. Cloud Storage object storing the certificate to use with the HTTP proxy. - */ - proxySslCaInfo?: Schema$ContaineranalysisGoogleDevtoolsCloudbuildV1GCSLocation; } /** * Location of the source in any accessible Git repository. diff --git a/src/apis/css/README.md b/src/apis/css/README.md new file mode 100644 index 0000000000..3ee0d3d019 --- /dev/null +++ b/src/apis/css/README.md @@ -0,0 +1,28 @@ +Google Inc. logo + +# css + +> Programmatically manage your Comparison Shopping Service (CSS) account data at scale. + +## Installation + +```sh +$ npm install @googleapis/css +``` + +## Usage +All documentation and usage information can be found on [GitHub](https://github.com/googleapis/google-api-nodejs-client). +Information on classes can be found in [Googleapis Documentation](https://googleapis.dev/nodejs/googleapis/latest/css/classes/Css.html). + +## License +This library is licensed under Apache 2.0. Full license text is available in [LICENSE](https://github.com/googleapis/google-api-nodejs-client/blob/main/LICENSE). + +## Contributing +We love contributions! Before submitting a Pull Request, it's always good to start with a new issue first. To learn more, see [CONTRIBUTING](https://github.com/google/google-api-nodejs-client/blob/main/.github/CONTRIBUTING.md). + +## Questions/problems? +* Ask your development related questions on [StackOverflow](http://stackoverflow.com/questions/tagged/google-api-nodejs-client). +* If you've found an bug/issue, please [file it on GitHub](https://github.com/googleapis/google-api-nodejs-client/issues). + + +*Crafted with ❤️ by the Google Node.js team* diff --git a/src/apis/css/index.ts b/src/apis/css/index.ts new file mode 100644 index 0000000000..839020f224 --- /dev/null +++ b/src/apis/css/index.ts @@ -0,0 +1,44 @@ +// Copyright 2020 Google LLC +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +/*! THIS FILE IS AUTO-GENERATED */ + +import {AuthPlus, getAPI, GoogleConfigurable} from 'googleapis-common'; +import {css_v1} from './v1'; + +export const VERSIONS = { + v1: css_v1.Css, +}; + +export function css(version: 'v1'): css_v1.Css; +export function css(options: css_v1.Options): css_v1.Css; +export function css( + this: GoogleConfigurable, + versionOrOptions: 'v1' | css_v1.Options +) { + return getAPI('css', versionOrOptions, VERSIONS, this); +} + +const auth = new AuthPlus(); +export {auth}; +export {css_v1}; +export { + AuthPlus, + GlobalOptions, + APIRequestContext, + GoogleConfigurable, + StreamMethodOptions, + GaxiosPromise, + MethodOptions, + BodyResponseCallback, +} from 'googleapis-common'; diff --git a/src/apis/css/package.json b/src/apis/css/package.json new file mode 100644 index 0000000000..8926e93759 --- /dev/null +++ b/src/apis/css/package.json @@ -0,0 +1,43 @@ +{ + "name": "@googleapis/css", + "version": "0.1.0", + "description": "css", + "main": "build/index.js", + "types": "build/index.d.ts", + "keywords": [ + "google" + ], + "author": "Google LLC", + "license": "Apache-2.0", + "homepage": "https://github.com/googleapis/google-api-nodejs-client", + "bugs": { + "url": "https://github.com/googleapis/google-api-nodejs-client/issues" + }, + "repository": { + "type": "git", + "url": "https://github.com/googleapis/google-api-nodejs-client.git" + }, + "engines": { + "node": ">=12.0.0" + }, + "scripts": { + "fix": "gts fix", + "lint": "gts check", + "compile": "tsc -p .", + "prepare": "npm run compile", + "webpack": "webpack" + }, + "dependencies": { + "googleapis-common": "^7.0.0" + }, + "devDependencies": { + "@microsoft/api-documenter": "^7.8.10", + "@microsoft/api-extractor": "^7.8.10", + "gts": "^5.0.0", + "null-loader": "^4.0.0", + "ts-loader": "^9.0.0", + "typescript": "~4.8.4", + "webpack": "^5.0.0", + "webpack-cli": "^5.0.0" + } +} diff --git a/src/apis/css/tsconfig.json b/src/apis/css/tsconfig.json new file mode 100644 index 0000000000..e081090496 --- /dev/null +++ b/src/apis/css/tsconfig.json @@ -0,0 +1,10 @@ +{ + "extends": "./node_modules/gts/tsconfig-google.json", + "compilerOptions": { + "rootDir": ".", + "outDir": "build" + }, + "include": [ + "*.ts", + ] +} diff --git a/src/apis/css/v1.ts b/src/apis/css/v1.ts new file mode 100644 index 0000000000..a7bad11b32 --- /dev/null +++ b/src/apis/css/v1.ts @@ -0,0 +1,1844 @@ +// Copyright 2020 Google LLC +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +/* eslint-disable @typescript-eslint/no-explicit-any */ +/* eslint-disable @typescript-eslint/no-unused-vars */ +/* eslint-disable @typescript-eslint/no-empty-interface */ +/* eslint-disable @typescript-eslint/no-namespace */ +/* eslint-disable no-irregular-whitespace */ + +import { + OAuth2Client, + JWT, + Compute, + UserRefreshClient, + BaseExternalAccountClient, + GaxiosPromise, + GoogleConfigurable, + createAPIRequest, + MethodOptions, + StreamMethodOptions, + GlobalOptions, + GoogleAuth, + BodyResponseCallback, + APIRequestContext, +} from 'googleapis-common'; +import {Readable} from 'stream'; + +export namespace css_v1 { + export interface Options extends GlobalOptions { + version: 'v1'; + } + + interface StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: + | string + | OAuth2Client + | JWT + | Compute + | UserRefreshClient + | BaseExternalAccountClient + | GoogleAuth; + + /** + * V1 error format. + */ + '$.xgafv'?: string; + /** + * OAuth access token. + */ + access_token?: string; + /** + * Data format for response. + */ + alt?: string; + /** + * JSONP + */ + callback?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * 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. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * 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. + */ + quotaUser?: string; + /** + * Legacy upload protocol for media (e.g. "media", "multipart"). + */ + uploadType?: string; + /** + * Upload protocol for media (e.g. "raw", "multipart"). + */ + upload_protocol?: string; + } + + /** + * CSS API + * + * Programmatically manage your Comparison Shopping Service (CSS) account data at scale. + * + * @example + * ```js + * const {google} = require('googleapis'); + * const css = google.css('v1'); + * ``` + */ + export class Css { + context: APIRequestContext; + accounts: Resource$Accounts; + + constructor(options: GlobalOptions, google?: GoogleConfigurable) { + this.context = { + _options: options || {}, + google, + }; + + this.accounts = new Resource$Accounts(this.context); + } + } + + /** + * Information about CSS/MC account. + */ + export interface Schema$Account { + /** + * Output only. The type of this account. + */ + accountType?: string | null; + /** + * Automatically created label IDs assigned to the MC account by CSS Center. + */ + automaticLabelIds?: string[] | null; + /** + * The CSS/MC account's short display name. + */ + displayName?: string | null; + /** + * Output only. Immutable. The CSS/MC account's full name. + */ + fullName?: string | null; + /** + * Output only. Immutable. The CSS/MC account's homepage. + */ + homepageUri?: string | null; + /** + * Manually created label IDs assigned to the CSS/MC account by a CSS parent account. + */ + labelIds?: string[] | null; + /** + * The label resource name. Format: accounts/{account\} + */ + name?: string | null; + /** + * The CSS/MC account's parent resource. CSS group for CSS domains; CSS domain for MC accounts. Returned only if the user has access to the parent account. + */ + parent?: string | null; + } + /** + * Label assigned by CSS domain or CSS group to one of its sub-accounts. + */ + export interface Schema$AccountLabel { + /** + * Output only. The ID of account this label belongs to. + */ + accountId?: string | null; + /** + * The description of this label. + */ + description?: string | null; + /** + * The display name of this label. + */ + displayName?: string | null; + /** + * Output only. The ID of the label. + */ + labelId?: string | null; + /** + * Output only. The type of this label. + */ + labelType?: string | null; + /** + * The resource name of the label. Format: accounts/{account\}/labels/{label\} + */ + name?: string | null; + } + /** + * Attributes for CSS Product. + */ + export interface Schema$Attributes { + /** + * Additional URL of images of the item. + */ + additionalImageLinks?: string[] | null; + /** + * Set to true if the item is targeted towards adults. + */ + adult?: boolean | null; + /** + * Target age group of the item. + */ + ageGroup?: string | null; + /** + * Product Related Attributes.[14-36] Brand of the item. + */ + brand?: string | null; + /** + * A list of certificates claimed by the CSS for the given product. + */ + certifications?: Schema$Certification[]; + /** + * Color of the item. + */ + color?: string | null; + /** + * Allows advertisers to override the item URL when the product is shown within the context of Product Ads. + */ + cppAdsRedirect?: string | null; + /** + * URL directly linking to your the Product Detail Page of the CSS. + */ + cppLink?: string | null; + /** + * URL for the mobile-optimized version of the Product Detail Page of the CSS. + */ + cppMobileLink?: string | null; + /** + * Custom label 0 for custom grouping of items in a Shopping campaign. + */ + customLabel0?: string | null; + /** + * Custom label 1 for custom grouping of items in a Shopping campaign. + */ + customLabel1?: string | null; + /** + * Custom label 2 for custom grouping of items in a Shopping campaign. + */ + customLabel2?: string | null; + /** + * Custom label 3 for custom grouping of items in a Shopping campaign. + */ + customLabel3?: string | null; + /** + * Custom label 4 for custom grouping of items in a Shopping campaign. + */ + customLabel4?: string | null; + /** + * Description of the item. + */ + description?: string | null; + /** + * The list of destinations to exclude for this target (corresponds to unchecked check boxes in Merchant Center). + */ + excludedDestinations?: string[] | null; + /** + * Date on which the item should expire, as specified upon insertion, in [ISO 8601](http://en.wikipedia.org/wiki/ISO_8601) format. The actual expiration date is exposed in `productstatuses` as [googleExpirationDate](https://support.google.com/merchants/answer/6324499) and might be earlier if `expirationDate` is too far in the future. Note: It may take 2+ days from the expiration date for the item to actually get deleted. + */ + expirationDate?: string | null; + /** + * Target gender of the item. + */ + gender?: string | null; + /** + * Google's category of the item (see [Google product taxonomy](https://support.google.com/merchants/answer/1705911)). When querying products, this field will contain the user provided value. There is currently no way to get back the auto assigned google product categories through the API. + */ + googleProductCategory?: string | null; + /** + * Global Trade Item Number ([GTIN](https://support.google.com/merchants/answer/188494#gtin)) of the item. + */ + gtin?: string | null; + /** + * Condition of the headline offer. + */ + headlineOfferCondition?: string | null; + /** + * Link to the headline offer. + */ + headlineOfferLink?: string | null; + /** + * Mobile Link to the headline offer. + */ + headlineOfferMobileLink?: string | null; + /** + * Headline Price of the aggregate offer. + */ + headlineOfferPrice?: Schema$Price; + /** + * Headline Price of the aggregate offer. + */ + headlineOfferShippingPrice?: Schema$Price; + /** + * High Price of the aggregate offer. + */ + highPrice?: Schema$Price; + /** + * URL of an image of the item. + */ + imageLink?: string | null; + /** + * The list of destinations to include for this target (corresponds to checked check boxes in Merchant Center). Default destinations are always included unless provided in `excludedDestinations`. + */ + includedDestinations?: string[] | null; + /** + * Whether the item is a merchant-defined bundle. A bundle is a custom grouping of different products sold by a merchant for a single price. + */ + isBundle?: boolean | null; + /** + * Shared identifier for all variants of the same product. + */ + itemGroupId?: string | null; + /** + * Low Price of the aggregate offer. + */ + lowPrice?: Schema$Price; + /** + * The material of which the item is made. + */ + material?: string | null; + /** + * Manufacturer Part Number ([MPN](https://support.google.com/merchants/answer/188494#mpn)) of the item. + */ + mpn?: string | null; + /** + * The number of identical products in a merchant-defined multipack. + */ + multipack?: string | null; + /** + * The number of aggregate offers. + */ + numberOfOffers?: string | null; + /** + * The item's pattern (e.g. polka dots). + */ + pattern?: string | null; + /** + * Publication of this item will be temporarily paused. + */ + pause?: string | null; + /** + * Technical specification or additional product details. + */ + productDetails?: Schema$ProductDetail[]; + /** + * The height of the product in the units provided. The value must be between 0 (exclusive) and 3000 (inclusive). + */ + productHeight?: Schema$ProductDimension; + /** + * Bullet points describing the most relevant highlights of a product. + */ + productHighlights?: string[] | null; + /** + * The length of the product in the units provided. The value must be between 0 (exclusive) and 3000 (inclusive). + */ + productLength?: Schema$ProductDimension; + /** + * Categories of the item (formatted as in [products data specification](https://support.google.com/merchants/answer/6324406)). + */ + productTypes?: string[] | null; + /** + * The weight of the product in the units provided. The value must be between 0 (exclusive) and 2000 (inclusive). + */ + productWeight?: Schema$ProductWeight; + /** + * The width of the product in the units provided. The value must be between 0 (exclusive) and 3000 (inclusive). + */ + productWidth?: Schema$ProductDimension; + /** + * Size of the item. Only one value is allowed. For variants with different sizes, insert a separate product for each size with the same `itemGroupId` value (see [https://support.google.com/merchants/answer/6324492](size definition)). + */ + size?: string | null; + /** + * System in which the size is specified. Recommended for apparel items. + */ + sizeSystem?: string | null; + /** + * The cut of the item. It can be used to represent combined size types for apparel items. Maximum two of size types can be provided (see [https://support.google.com/merchants/answer/6324497](size type)). + */ + sizeTypes?: string[] | null; + /** + * Title of the item. + */ + title?: string | null; + } + /** + * The certification for the product. + */ + export interface Schema$Certification { + /** + * Name of the certification body. + */ + authority?: string | null; + /** + * A unique code to identify the certification. + */ + code?: string | null; + /** + * Name of the certification. + */ + name?: string | null; + } + /** + * The processed CSS Product(a.k.a Aggregate Offer internally). + */ + export interface Schema$CssProduct { + /** + * Output only. A list of product attributes. + */ + attributes?: Schema$Attributes; + /** + * Output only. The two-letter [ISO 639-1](http://en.wikipedia.org/wiki/ISO_639-1) language code for the product. + */ + contentLanguage?: string | null; + /** + * Output only. The status of a product, data validation issues, that is, information about a product computed asynchronously. + */ + cssProductStatus?: Schema$CssProductStatus; + /** + * Output only. A list of custom (CSS-provided) attributes. It can also be used to submit any attribute of the feed specification in its generic form (for example, `{ "name": "size type", "value": "regular" \}`). This is useful for submitting attributes not explicitly exposed by the API, such as additional attributes used for Buy on Google. + */ + customAttributes?: Schema$CustomAttribute[]; + /** + * Output only. The feed label for the product. + */ + feedLabel?: string | null; + /** + * The name of the CSS Product. Format: `"accounts/{account\}/cssProducts/{css_product\}"` + */ + name?: string | null; + /** + * Output only. Your unique raw identifier for the product. + */ + rawProvidedId?: string | null; + } + /** + * This resource represents input data you submit for a CSS Product, not the processed CSS Product that you see in CSS Center, in Shopping Ads, or across Google surfaces. + */ + export interface Schema$CssProductInput { + /** + * A list of CSS Product attributes. + */ + attributes?: Schema$Attributes; + /** + * Required. The two-letter [ISO 639-1](http://en.wikipedia.org/wiki/ISO_639-1) language code for the CSS Product. + */ + contentLanguage?: string | null; + /** + * A list of custom (CSS-provided) attributes. It can also be used for submitting any attribute of the feed specification in its generic form (for example: `{ "name": "size type", "value": "regular" \}`). This is useful for submitting attributes not explicitly exposed by the API, such as additional attributes used for Buy on Google. + */ + customAttributes?: Schema$CustomAttribute[]; + /** + * Required. The [feed label](https://developers.google.com/shopping-content/guides/products/feed-labels) for the CSS Product. Feed Label is synonymous to "target country" and hence should always be a valid region code. For example: 'DE' for Germany, 'FR' for France. + */ + feedLabel?: string | null; + /** + * Output only. The name of the processed CSS Product. Format: `accounts/{account\}/cssProducts/{css_product\}` " + */ + finalName?: string | null; + /** + * Represents the existing version (freshness) of the CSS Product, which can be used to preserve the right order when multiple updates are done at the same time. This field must not be set to the future time. If set, the update is prevented if a newer version of the item already exists in our system (that is the last update time of the existing CSS products is later than the freshness time set in the update). If the update happens, the last update time is then set to this freshness time. If not set, the update will not be prevented and the last update time will default to when this request was received by the CSS API. If the operation is prevented, the aborted exception will be thrown. + */ + freshnessTime?: string | null; + /** + * The name of the CSS Product input. Format: `accounts/{account\}/cssProductInputs/{css_product_input\}` + */ + name?: string | null; + /** + * Required. Your unique identifier for the CSS Product. This is the same for the CSS Product input and processed CSS Product. We only allow ids with alphanumerics, underscores and dashes. See the [products feed specification](https://support.google.com/merchants/answer/188494#id) for details. + */ + rawProvidedId?: string | null; + } + /** + * The status of the Css Product, data validation issues, that is, information about the Css Product computed asynchronously. + */ + export interface Schema$CssProductStatus { + /** + * Date on which the item has been created, in [ISO 8601](http://en.wikipedia.org/wiki/ISO_8601) format. + */ + creationDate?: string | null; + /** + * The intended destinations for the product. + */ + destinationStatuses?: Schema$DestinationStatus[]; + /** + * Date on which the item expires, in [ISO 8601](http://en.wikipedia.org/wiki/ISO_8601) format. + */ + googleExpirationDate?: string | null; + /** + * A list of all issues associated with the product. + */ + itemLevelIssues?: Schema$ItemLevelIssue[]; + /** + * Date on which the item has been last updated, in [ISO 8601](http://en.wikipedia.org/wiki/ISO_8601) format. + */ + lastUpdateDate?: string | null; + } + /** + * A message that represents custom attributes. Exactly one of `value` or `group_values` must not be empty. + */ + export interface Schema$CustomAttribute { + /** + * Subattributes within this attribute group. If `group_values` is not empty, `value` must be empty. + */ + groupValues?: Schema$CustomAttribute[]; + /** + * The name of the attribute. + */ + name?: string | null; + /** + * The value of the attribute. If `value` is not empty, `group_values` must be empty. + */ + value?: string | null; + } + /** + * The destination status of the product status. + */ + export interface Schema$DestinationStatus { + /** + * List of country codes (ISO 3166-1 alpha-2) where the aggregate offer is approved. + */ + approvedCountries?: string[] | null; + /** + * The name of the destination + */ + destination?: string | null; + /** + * List of country codes (ISO 3166-1 alpha-2) where the aggregate offer is disapproved. + */ + disapprovedCountries?: string[] | null; + /** + * List of country codes (ISO 3166-1 alpha-2) where the aggregate offer is pending approval. + */ + pendingCountries?: string[] | null; + } + /** + * 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); \} + */ + export interface Schema$Empty {} + /** + * The ItemLevelIssue of the product status. + */ + export interface Schema$ItemLevelIssue { + /** + * List of country codes (ISO 3166-1 alpha-2) where issue applies to the aggregate offer. + */ + applicableCountries?: string[] | null; + /** + * The attribute's name, if the issue is caused by a single attribute. + */ + attribute?: string | null; + /** + * The error code of the issue. + */ + code?: string | null; + /** + * A short issue description in English. + */ + description?: string | null; + /** + * The destination the issue applies to. + */ + destination?: string | null; + /** + * A detailed issue description in English. + */ + detail?: string | null; + /** + * The URL of a web page to help with resolving this issue. + */ + documentation?: string | null; + /** + * Whether the issue can be resolved by the merchant. + */ + resolution?: string | null; + /** + * How this issue affects serving of the aggregate offer. + */ + servability?: string | null; + } + /** + * Response message for the `ListAccountLabels` method. + */ + export interface Schema$ListAccountLabelsResponse { + /** + * The labels from the specified account. + */ + accountLabels?: Schema$AccountLabel[]; + /** + * A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. + */ + nextPageToken?: string | null; + } + /** + * Response message for the `ListChildAccounts` method. + */ + export interface Schema$ListChildAccountsResponse { + /** + * The CSS/MC accounts returned for the specified CSS parent account. + */ + accounts?: Schema$Account[]; + /** + * A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. + */ + nextPageToken?: string | null; + } + /** + * Response message for the ListCssProducts method. + */ + export interface Schema$ListCssProductsResponse { + /** + * The processed CSS products from the specified account. These are your processed CSS products after applying rules and supplemental feeds. + */ + cssProducts?: Schema$CssProduct[]; + /** + * A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. + */ + nextPageToken?: string | null; + } + /** + * The price represented as a number and currency. + */ + export interface Schema$Price { + /** + * The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros). + */ + amountMicros?: string | null; + /** + * The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217). + */ + currencyCode?: string | null; + } + /** + * The product details. + */ + export interface Schema$ProductDetail { + /** + * The name of the product detail. + */ + attributeName?: string | null; + /** + * The value of the product detail. + */ + attributeValue?: string | null; + /** + * The section header used to group a set of product details. + */ + sectionName?: string | null; + } + /** + * The dimension of the product. + */ + export interface Schema$ProductDimension { + /** + * Required. The dimension units. Acceptable values are: * "`in`" * "`cm`" + */ + unit?: string | null; + /** + * Required. The dimension value represented as a number. The value can have a maximum precision of four decimal places. + */ + value?: number | null; + } + /** + * The weight of the product. + */ + export interface Schema$ProductWeight { + /** + * Required. The weight unit. Acceptable values are: * "`g`" * "`kg`" * "`oz`" * "`lb`" + */ + unit?: string | null; + /** + * Required. The weight represented as a number. The weight can have a maximum precision of four decimal places. + */ + value?: number | null; + } + /** + * The request message for the `UpdateLabels` method. + */ + export interface Schema$UpdateAccountLabelsRequest { + /** + * The list of label IDs to overwrite the existing account label IDs. If the list is empty, all currently assigned label IDs will be deleted. + */ + labelIds?: string[] | null; + /** + * Optional. Only required when updating MC account labels. The CSS domain that is the parent resource of the MC account. Format: accounts/{account\} + */ + parent?: string | null; + } + + export class Resource$Accounts { + context: APIRequestContext; + cssProductInputs: Resource$Accounts$Cssproductinputs; + cssProducts: Resource$Accounts$Cssproducts; + labels: Resource$Accounts$Labels; + constructor(context: APIRequestContext) { + this.context = context; + this.cssProductInputs = new Resource$Accounts$Cssproductinputs( + this.context + ); + this.cssProducts = new Resource$Accounts$Cssproducts(this.context); + this.labels = new Resource$Accounts$Labels(this.context); + } + + /** + * Retrieves a single CSS/MC account by ID. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Accounts$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Accounts$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Accounts$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Accounts$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Accounts$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Accounts$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Accounts$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Accounts$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://css.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists all the accounts under the specified CSS account ID, and optionally filters by label ID and account name. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + listChildAccounts( + params: Params$Resource$Accounts$Listchildaccounts, + options: StreamMethodOptions + ): GaxiosPromise; + listChildAccounts( + params?: Params$Resource$Accounts$Listchildaccounts, + options?: MethodOptions + ): GaxiosPromise; + listChildAccounts( + params: Params$Resource$Accounts$Listchildaccounts, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + listChildAccounts( + params: Params$Resource$Accounts$Listchildaccounts, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + listChildAccounts( + params: Params$Resource$Accounts$Listchildaccounts, + callback: BodyResponseCallback + ): void; + listChildAccounts( + callback: BodyResponseCallback + ): void; + listChildAccounts( + paramsOrCallback?: + | Params$Resource$Accounts$Listchildaccounts + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Accounts$Listchildaccounts; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Accounts$Listchildaccounts; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://css.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}:listChildAccounts').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Updates labels assigned to CSS/MC accounts by a CSS domain. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + updateLabels( + params: Params$Resource$Accounts$Updatelabels, + options: StreamMethodOptions + ): GaxiosPromise; + updateLabels( + params?: Params$Resource$Accounts$Updatelabels, + options?: MethodOptions + ): GaxiosPromise; + updateLabels( + params: Params$Resource$Accounts$Updatelabels, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + updateLabels( + params: Params$Resource$Accounts$Updatelabels, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + updateLabels( + params: Params$Resource$Accounts$Updatelabels, + callback: BodyResponseCallback + ): void; + updateLabels(callback: BodyResponseCallback): void; + updateLabels( + paramsOrCallback?: + | Params$Resource$Accounts$Updatelabels + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Accounts$Updatelabels; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Accounts$Updatelabels; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://css.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:updateLabels').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Accounts$Get extends StandardParameters { + /** + * Required. The name of the managed CSS/MC account. Format: accounts/{account\} + */ + name?: string; + /** + * Optional. Only required when retrieving MC account information. The CSS domain that is the parent resource of the MC account. Format: accounts/{account\} + */ + parent?: string; + } + export interface Params$Resource$Accounts$Listchildaccounts + extends StandardParameters { + /** + * If set, only the MC accounts with the given name (case sensitive) will be returned. + */ + fullName?: string; + /** + * If set, only the MC accounts with the given label ID will be returned. + */ + labelId?: string; + /** + * Optional. The maximum number of accounts to return. The service may return fewer than this value. If unspecified, at most 50 accounts will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. + */ + pageSize?: number; + /** + * Optional. A page token, received from a previous `ListChildAccounts` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListChildAccounts` must match the call that provided the page token. + */ + pageToken?: string; + /** + * Required. The parent account. Must be a CSS group or domain. Format: accounts/{account\} + */ + parent?: string; + } + export interface Params$Resource$Accounts$Updatelabels + extends StandardParameters { + /** + * Required. The label resource name. Format: accounts/{account\} + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$UpdateAccountLabelsRequest; + } + + export class Resource$Accounts$Cssproductinputs { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Deletes a CSS Product input from your CSS Center account. After a delete it may take several minutes until the input is no longer available. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Accounts$Cssproductinputs$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Accounts$Cssproductinputs$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Accounts$Cssproductinputs$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Accounts$Cssproductinputs$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Accounts$Cssproductinputs$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Accounts$Cssproductinputs$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Accounts$Cssproductinputs$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Accounts$Cssproductinputs$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://css.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Uploads a CssProductInput to your CSS Center account. If an input with the same contentLanguage, identity, feedLabel and feedId already exists, this method replaces that entry. After inserting, updating, or deleting a CSS Product input, it may take several minutes before the processed CSS Product can be retrieved. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + insert( + params: Params$Resource$Accounts$Cssproductinputs$Insert, + options: StreamMethodOptions + ): GaxiosPromise; + insert( + params?: Params$Resource$Accounts$Cssproductinputs$Insert, + options?: MethodOptions + ): GaxiosPromise; + insert( + params: Params$Resource$Accounts$Cssproductinputs$Insert, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Accounts$Cssproductinputs$Insert, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Accounts$Cssproductinputs$Insert, + callback: BodyResponseCallback + ): void; + insert(callback: BodyResponseCallback): void; + insert( + paramsOrCallback?: + | Params$Resource$Accounts$Cssproductinputs$Insert + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Accounts$Cssproductinputs$Insert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Accounts$Cssproductinputs$Insert; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://css.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/cssProductInputs:insert').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Accounts$Cssproductinputs$Delete + extends StandardParameters { + /** + * Required. The name of the CSS product input resource to delete. Format: accounts/{account\}/cssProductInputs/{css_product_input\} + */ + name?: string; + /** + * The Content API Supplemental Feed ID. The field must not be set if the action applies to a primary feed. If the field is set, then product action applies to a supplemental feed instead of primary Content API feed. + */ + supplementalFeedId?: string; + } + export interface Params$Resource$Accounts$Cssproductinputs$Insert + extends StandardParameters { + /** + * Required. The primary or supplemental feed id. If CSS Product already exists and feed id provided is different, then the CSS Product will be moved to a new feed. Note: For now, CSSs do not need to provide feed ids as we create feeds on the fly. We do not have supplemental feed support for CSS Products yet. + */ + feedId?: string; + /** + * Required. The account where this CSS Product will be inserted. Format: accounts/{account\} + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$CssProductInput; + } + + export class Resource$Accounts$Cssproducts { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Retrieves the processed CSS Product from your CSS Center account. After inserting, updating, or deleting a product input, it may take several minutes before the updated final product can be retrieved. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Accounts$Cssproducts$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Accounts$Cssproducts$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Accounts$Cssproducts$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Accounts$Cssproducts$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Accounts$Cssproducts$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Accounts$Cssproducts$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Accounts$Cssproducts$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Accounts$Cssproducts$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://css.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists the processed CSS Products in your CSS Center account. The response might contain fewer items than specified by pageSize. Rely on pageToken to determine if there are more items to be requested. After inserting, updating, or deleting a CSS product input, it may take several minutes before the updated processed CSS product can be retrieved. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Accounts$Cssproducts$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Accounts$Cssproducts$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Accounts$Cssproducts$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Accounts$Cssproducts$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Accounts$Cssproducts$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Accounts$Cssproducts$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Accounts$Cssproducts$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Accounts$Cssproducts$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://css.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/cssProducts').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Accounts$Cssproducts$Get + extends StandardParameters { + /** + * Required. The name of the CSS product to retrieve. + */ + name?: string; + } + export interface Params$Resource$Accounts$Cssproducts$List + extends StandardParameters { + /** + * The maximum number of CSS Products to return. The service may return fewer than this value. The maximum value is 1000; values above 1000 will be coerced to 1000. If unspecified, the maximum number of CSS products will be returned. + */ + pageSize?: number; + /** + * A page token, received from a previous `ListCssProducts` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListCssProducts` must match the call that provided the page token. + */ + pageToken?: string; + /** + * Required. The account/domain to list processed CSS Products for. Format: accounts/{account\} + */ + parent?: string; + } + + export class Resource$Accounts$Labels { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Creates a new label, not assigned to any account. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + create( + params: Params$Resource$Accounts$Labels$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Accounts$Labels$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Accounts$Labels$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Accounts$Labels$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Accounts$Labels$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Accounts$Labels$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Accounts$Labels$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Accounts$Labels$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://css.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/labels').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Deletes a label and removes it from all accounts to which it was assigned. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Accounts$Labels$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Accounts$Labels$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Accounts$Labels$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Accounts$Labels$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Accounts$Labels$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Accounts$Labels$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Accounts$Labels$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Accounts$Labels$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://css.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists the labels assigned to an account. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Accounts$Labels$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Accounts$Labels$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Accounts$Labels$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Accounts$Labels$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Accounts$Labels$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Accounts$Labels$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Accounts$Labels$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Accounts$Labels$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://css.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/labels').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Updates a label. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + patch( + params: Params$Resource$Accounts$Labels$Patch, + options: StreamMethodOptions + ): GaxiosPromise; + patch( + params?: Params$Resource$Accounts$Labels$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Accounts$Labels$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Accounts$Labels$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Accounts$Labels$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Accounts$Labels$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Accounts$Labels$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Accounts$Labels$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://css.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Accounts$Labels$Create + extends StandardParameters { + /** + * Required. The parent account. Format: accounts/{account\} + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$AccountLabel; + } + export interface Params$Resource$Accounts$Labels$Delete + extends StandardParameters { + /** + * Required. The name of the label to delete. Format: accounts/{account\}/labels/{label\} + */ + name?: string; + } + export interface Params$Resource$Accounts$Labels$List + extends StandardParameters { + /** + * The maximum number of labels to return. The service may return fewer than this value. If unspecified, at most 50 labels will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. + */ + pageSize?: number; + /** + * A page token, received from a previous `ListAccountLabels` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAccountLabels` must match the call that provided the page token. + */ + pageToken?: string; + /** + * Required. The parent account. Format: accounts/{account\} + */ + parent?: string; + } + export interface Params$Resource$Accounts$Labels$Patch + extends StandardParameters { + /** + * The resource name of the label. Format: accounts/{account\}/labels/{label\} + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$AccountLabel; + } +} diff --git a/src/apis/css/webpack.config.js b/src/apis/css/webpack.config.js new file mode 100644 index 0000000000..625b3a2497 --- /dev/null +++ b/src/apis/css/webpack.config.js @@ -0,0 +1,79 @@ +// Copyright 2019 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +// Use `npm run webpack` to produce Webpack bundle for this library. + +const path = require('path'); + +module.exports = { + entry: './index.ts', + resolve: { + extensions: ['.ts', '.js', '.json'], + fallback: { + crypto: false, + child_process: false, + fs: false, + http2: false, + buffer: 'browserify', + process: false, + os: false, + querystring: false, + path: false, + stream: 'stream-browserify', + url: false, + util: false, + zlib: false, + }, + }, + output: { + library: 'Css', + filename: 'css.min.js', + path: path.resolve(__dirname, 'dist'), + }, + module: { + rules: [ + { + test: /node_modules[\\/]google-auth-library[\\/]src[\\/]crypto[\\/]node[\\/]crypto/, + use: 'null-loader', + }, + { + test: /node_modules[\\/]https-proxy-agent[\\/]/, + use: 'null-loader', + }, + { + test: /node_modules[\\/]gcp-metadata[\\/]/, + use: 'null-loader', + }, + { + test: /node_modules[\\/]gtoken[\\/]/, + use: 'null-loader', + }, + { + test: /node_modules[\\/]pkginfo[\\/]/, + use: 'null-loader', + }, + { + test: /node_modules[\\/]semver[\\/]/, + use: 'null-loader', + }, + { + test: /\.ts$/, + use: 'ts-loader', + exclude: /node_modules/, + }, + ], + }, + mode: 'production', + plugins: [], +}; diff --git a/src/apis/dataform/v1beta1.ts b/src/apis/dataform/v1beta1.ts index f80f6c9e40..f19b6be436 100644 --- a/src/apis/dataform/v1beta1.ts +++ b/src/apis/dataform/v1beta1.ts @@ -365,6 +365,10 @@ export namespace dataform_v1beta1 { * Output only. Errors encountered during project compilation. */ compilationErrors?: Schema$CompilationError[]; + /** + * Output only. The timestamp of when the compilation result was created. + */ + createTime?: string | null; /** * Output only. Only set if the repository has a KMS Key. */ @@ -1429,6 +1433,10 @@ export namespace dataform_v1beta1 { * Represents a Dataform workflow configuration. */ export interface Schema$WorkflowConfig { + /** + * Output only. The timestamp of when the WorkflowConfig was created. + */ + createTime?: string | null; /** * Optional. Optional schedule (in cron format) for automatic execution of this workflow config. */ @@ -1453,6 +1461,10 @@ export namespace dataform_v1beta1 { * 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). If left unspecified, the default is UTC. */ timeZone?: string | null; + /** + * Output only. The timestamp of when the WorkflowConfig was last updated. + */ + updateTime?: string | null; } /** * Represents a single invocation of a compilation result. diff --git a/src/apis/datafusion/v1.ts b/src/apis/datafusion/v1.ts index aa1bb6667c..de8f95523d 100644 --- a/src/apis/datafusion/v1.ts +++ b/src/apis/datafusion/v1.ts @@ -137,6 +137,27 @@ export namespace datafusion_v1 { */ state?: string | null; } + /** + * Provides the mapping of a cloud asset to a direct physical location or to a proxy that defines the location on its behalf. + */ + export interface Schema$AssetLocation { + /** + * Defines the customer expectation around ZI/ZS for this asset and ZI/ZS state of the region at the time of asset creation. + */ + expected?: Schema$IsolationExpectations; + /** + * Defines extra parameters required for specific asset types. + */ + extraParameters?: Schema$ExtraParameter[]; + /** + * Contains all kinds of physical location definitions for this asset. + */ + locationData?: Schema$LocationData[]; + /** + * Defines parents assets if any in order to allow later generation of child_asset_location data via child assets. + */ + parentAsset?: Schema$CloudAsset[]; + } /** * 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. */ @@ -180,10 +201,23 @@ export namespace datafusion_v1 { */ role?: string | null; } + /** + * Policy ID that identified data placement in Blobstore as per go/blobstore-user-guide#data-metadata-placement-and-failure-domains + */ + export interface Schema$BlobstoreLocation { + policyId?: string[] | null; + } /** * The request message for Operations.CancelOperation. */ export interface Schema$CancelOperationRequest {} + export interface Schema$CloudAsset { + assetName?: string | null; + assetType?: string | null; + } + export interface Schema$CloudAssetComposition { + childAsset?: Schema$CloudAsset[]; + } /** * The crypto key configuration. This field is used by the Customer-managed encryption keys (CMEK) feature. */ @@ -193,6 +227,9 @@ export namespace datafusion_v1 { */ keyReference?: string | null; } + export interface Schema$DirectLocationAssignment { + location?: Schema$LocationAssignment[]; + } /** * DNS peering configuration. These configurations are used to create DNS peering with the customer Cloud DNS. */ @@ -256,6 +293,15 @@ export namespace datafusion_v1 { */ title?: string | null; } + /** + * Defines parameters that should only be used for specific asset types. + */ + export interface Schema$ExtraParameter { + /** + * Details about zones used by regional compute.googleapis.com/InstanceGroupManager to create instances. + */ + regionalMigDistributionPolicy?: Schema$RegionalMigDistributionPolicy; + } /** * Represents a Data Fusion instance. */ @@ -401,6 +447,21 @@ export namespace datafusion_v1 { */ zone?: string | null; } + export interface Schema$IsolationExpectations { + ziOrgPolicy?: string | null; + ziRegionPolicy?: string | null; + ziRegionState?: string | null; + /** + * Deprecated: use zi_org_policy, zi_region_policy and zi_region_state instead for setting ZI expectations as per go/zicy-publish-physical-location. + */ + zoneIsolation?: string | null; + /** + * Deprecated: use zs_org_policy, and zs_region_stateinstead for setting Zs expectations as per go/zicy-publish-physical-location. + */ + zoneSeparation?: string | null; + zsOrgPolicy?: string | null; + zsRegionState?: string | null; + } /** * Response message for the list available versions request. */ @@ -495,6 +556,18 @@ export namespace datafusion_v1 { */ name?: string | null; } + export interface Schema$LocationAssignment { + location?: string | null; + locationType?: string | null; + } + export interface Schema$LocationData { + blobstoreLocation?: Schema$BlobstoreLocation; + childAssetLocation?: Schema$CloudAssetComposition; + directLocation?: Schema$DirectLocationAssignment; + gcpProjectProxy?: Schema$TenantProjectProxy; + placerLocation?: Schema$PlacerLocation; + spannerLocation?: Schema$SpannerLocation; + } /** * Maintenance policy of the instance. */ @@ -600,6 +673,15 @@ export namespace datafusion_v1 { */ verb?: string | null; } + /** + * Message describing that the location of the customer resource is tied to placer allocations + */ + export interface Schema$PlacerLocation { + /** + * Directory with a config related to it in placer (e.g. "/placer/prod/home/my-root/my-dir") + */ + placerConfig?: string | null; + } /** * 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/). */ @@ -651,6 +733,19 @@ export namespace datafusion_v1 { */ window?: Schema$TimeWindow; } + /** + * To be used for specifying the intended distribution of regional compute.googleapis.com/InstanceGroupManager instances + */ + export interface Schema$RegionalMigDistributionPolicy { + /** + * The shape in which the group converges around distribution of resources. Instance of proto2 enum + */ + targetShape?: number | null; + /** + * Cloud zones used by regional MIG to create instances. + */ + zones?: Schema$ZoneConfiguration[]; + } /** * Request message for restarting a Data Fusion instance. */ @@ -668,6 +763,16 @@ export namespace datafusion_v1 { */ updateMask?: string | null; } + export interface Schema$SpannerLocation { + /** + * Set of backups used by the resource with name in the same format as what is available at http://table/spanner_automon.backup_metadata + */ + backupName?: string[] | null; + /** + * Set of databases used by the resource in format /span// + */ + dbName?: string[] | null; + } /** * 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). */ @@ -685,6 +790,9 @@ export namespace datafusion_v1 { */ message?: string | null; } + export interface Schema$TenantProjectProxy { + projectNumbers?: string[] | null; + } /** * Request message for `TestIamPermissions` method. */ @@ -737,6 +845,9 @@ export namespace datafusion_v1 { */ versionNumber?: string | null; } + export interface Schema$ZoneConfiguration { + zone?: string | null; + } export class Resource$Projects { context: APIRequestContext; diff --git a/src/apis/datafusion/v1beta1.ts b/src/apis/datafusion/v1beta1.ts index 832e1b62af..68c644122e 100644 --- a/src/apis/datafusion/v1beta1.ts +++ b/src/apis/datafusion/v1beta1.ts @@ -137,6 +137,27 @@ export namespace datafusion_v1beta1 { */ state?: string | null; } + /** + * Provides the mapping of a cloud asset to a direct physical location or to a proxy that defines the location on its behalf. + */ + export interface Schema$AssetLocation { + /** + * Defines the customer expectation around ZI/ZS for this asset and ZI/ZS state of the region at the time of asset creation. + */ + expected?: Schema$IsolationExpectations; + /** + * Defines extra parameters required for specific asset types. + */ + extraParameters?: Schema$ExtraParameter[]; + /** + * Contains all kinds of physical location definitions for this asset. + */ + locationData?: Schema$LocationData[]; + /** + * Defines parents assets if any in order to allow later generation of child_asset_location data via child assets. + */ + parentAsset?: Schema$CloudAsset[]; + } /** * 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. */ @@ -180,10 +201,23 @@ export namespace datafusion_v1beta1 { */ role?: string | null; } + /** + * Policy ID that identified data placement in Blobstore as per go/blobstore-user-guide#data-metadata-placement-and-failure-domains + */ + export interface Schema$BlobstoreLocation { + policyId?: string[] | null; + } /** * The request message for Operations.CancelOperation. */ export interface Schema$CancelOperationRequest {} + export interface Schema$CloudAsset { + assetName?: string | null; + assetType?: string | null; + } + export interface Schema$CloudAssetComposition { + childAsset?: Schema$CloudAsset[]; + } /** * The crypto key configuration. This field is used by the Customer-managed encryption keys (CMEK) feature. */ @@ -193,6 +227,9 @@ export namespace datafusion_v1beta1 { */ keyReference?: string | null; } + export interface Schema$DirectLocationAssignment { + location?: Schema$LocationAssignment[]; + } /** * DNS peering configuration. These configurations are used to create DNS peering with the customer Cloud DNS. */ @@ -256,6 +293,15 @@ export namespace datafusion_v1beta1 { */ title?: string | null; } + /** + * Defines parameters that should only be used for specific asset types. + */ + export interface Schema$ExtraParameter { + /** + * Details about zones used by regional compute.googleapis.com/InstanceGroupManager to create instances. + */ + regionalMigDistributionPolicy?: Schema$RegionalMigDistributionPolicy; + } /** * IAMPolicy encapsulates the IAM policy name, definition and status of policy fetching. */ @@ -414,6 +460,21 @@ export namespace datafusion_v1beta1 { */ zone?: string | null; } + export interface Schema$IsolationExpectations { + ziOrgPolicy?: string | null; + ziRegionPolicy?: string | null; + ziRegionState?: string | null; + /** + * Deprecated: use zi_org_policy, zi_region_policy and zi_region_state instead for setting ZI expectations as per go/zicy-publish-physical-location. + */ + zoneIsolation?: string | null; + /** + * Deprecated: use zs_org_policy, and zs_region_stateinstead for setting Zs expectations as per go/zicy-publish-physical-location. + */ + zoneSeparation?: string | null; + zsOrgPolicy?: string | null; + zsRegionState?: string | null; + } /** * Response message for the list available versions request. */ @@ -521,6 +582,18 @@ export namespace datafusion_v1beta1 { */ name?: string | null; } + export interface Schema$LocationAssignment { + location?: string | null; + locationType?: string | null; + } + export interface Schema$LocationData { + blobstoreLocation?: Schema$BlobstoreLocation; + childAssetLocation?: Schema$CloudAssetComposition; + directLocation?: Schema$DirectLocationAssignment; + gcpProjectProxy?: Schema$TenantProjectProxy; + placerLocation?: Schema$PlacerLocation; + spannerLocation?: Schema$SpannerLocation; + } /** * Maintenance policy of the instance. */ @@ -639,6 +712,15 @@ export namespace datafusion_v1beta1 { */ verb?: string | null; } + /** + * Message describing that the location of the customer resource is tied to placer allocations + */ + export interface Schema$PlacerLocation { + /** + * Directory with a config related to it in placer (e.g. "/placer/prod/home/my-root/my-dir") + */ + placerConfig?: string | null; + } /** * 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/). */ @@ -690,6 +772,19 @@ export namespace datafusion_v1beta1 { */ window?: Schema$TimeWindow; } + /** + * To be used for specifying the intended distribution of regional compute.googleapis.com/InstanceGroupManager instances + */ + export interface Schema$RegionalMigDistributionPolicy { + /** + * The shape in which the group converges around distribution of resources. Instance of proto2 enum + */ + targetShape?: number | null; + /** + * Cloud zones used by regional MIG to create instances. + */ + zones?: Schema$ZoneConfiguration[]; + } /** * Request message for RemoveIamPolicy method. */ @@ -715,6 +810,16 @@ export namespace datafusion_v1beta1 { */ updateMask?: string | null; } + export interface Schema$SpannerLocation { + /** + * Set of backups used by the resource with name in the same format as what is available at http://table/spanner_automon.backup_metadata + */ + backupName?: string[] | null; + /** + * Set of databases used by the resource in format /span// + */ + dbName?: string[] | null; + } /** * 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). */ @@ -732,6 +837,9 @@ export namespace datafusion_v1beta1 { */ message?: string | null; } + export interface Schema$TenantProjectProxy { + projectNumbers?: string[] | null; + } /** * Request message for `TestIamPermissions` method. */ @@ -788,6 +896,9 @@ export namespace datafusion_v1beta1 { */ versionNumber?: string | null; } + export interface Schema$ZoneConfiguration { + zone?: string | null; + } export class Resource$Projects { context: APIRequestContext; diff --git a/src/apis/dataplex/v1.ts b/src/apis/dataplex/v1.ts index bd2eca6908..300ba031d3 100644 --- a/src/apis/dataplex/v1.ts +++ b/src/apis/dataplex/v1.ts @@ -287,7 +287,7 @@ export namespace dataplex_v1 { */ createTime?: string | null; /** - * Required. The content of the aspect, according to its aspect type schema. This will replace content. The maximum size of the field is 120KB (encoded as UTF-8). + * Required. The content of the aspect, according to its aspect type schema. The maximum size of the field is 120KB (encoded as UTF-8). */ data?: {[key: string]: any} | null; /** @@ -300,7 +300,7 @@ export namespace dataplex_v1 { updateTime?: string | null; } /** - * AspectSource contains source system related information for the aspect. + * AspectSource contains information related to the source system of the Aspect. */ export interface Schema$GoogleCloudDataplexV1AspectSource { /** @@ -313,11 +313,11 @@ export namespace dataplex_v1 { updateTime?: string | null; } /** - * Aspect Type is a template for creating Aspects, and represents the JSON-schema for a given Entry, e.g., BigQuery Table Schema. + * AspectType is a template for creating Aspects, and represents the JSON-schema for a given Entry, for example, BigQuery Table Schema. */ export interface Schema$GoogleCloudDataplexV1AspectType { /** - * Immutable. Authorization defined for this type. + * Immutable. Defines the Authorization for this type. */ authorization?: Schema$GoogleCloudDataplexV1AspectTypeAuthorization; /** @@ -333,7 +333,7 @@ export namespace dataplex_v1 { */ displayName?: string | null; /** - * 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. + * The service computes this checksum. The client may send it on update and delete requests to ensure it has an up-to-date value before proceeding. */ etag?: string | null; /** @@ -349,11 +349,7 @@ export namespace dataplex_v1 { */ name?: string | null; /** - * Output only. Denotes the transfer status of the Aspect Type. It is unspecified for Aspect Types created from Dataplex API. - */ - transferStatus?: string | null; - /** - * Output only. System generated globally unique ID for the AspectType. This ID will be different if the AspectType is deleted and re-created with the same name. + * Output only. System generated globally unique ID for the AspectType. If you delete and recreate the AspectType with the same name, then this ID will be different. */ uid?: string | null; /** @@ -362,16 +358,16 @@ export namespace dataplex_v1 { updateTime?: string | null; } /** - * Autorization for an Aspect Type. + * Autorization for an AspectType. */ export interface Schema$GoogleCloudDataplexV1AspectTypeAuthorization { /** - * Immutable. The IAM permission grantable on the Entry Group to allow access to instantiate Aspects of Dataplex owned Aspect Types, only settable for Dataplex owned Types. + * Immutable. The IAM permission grantable on the EntryGroup to allow access to instantiate Aspects of Dataplex owned AspectTypes, only settable for Dataplex owned Types. */ alternateUsePermission?: string | null; } /** - * MetadataTemplate definition for AspectType + * MetadataTemplate definition for an AspectType. */ export interface Schema$GoogleCloudDataplexV1AspectTypeMetadataTemplate { /** @@ -379,7 +375,7 @@ export namespace dataplex_v1 { */ annotations?: Schema$GoogleCloudDataplexV1AspectTypeMetadataTemplateAnnotations; /** - * Optional. array_items needs to be set if the type is array. array_items can refer to a primitive field or a complex (record only) field. To specify a primitive field, just name and type needs to be set in the nested MetadataTemplate. The recommended value for the name field is item, as this is not used in the actual payload. + * Optional. If the type is array, set array_items. array_items can refer to a primitive field or a complex (record only) field. To specify a primitive field, you only need to set name and type in the nested MetadataTemplate. The recommended value for the name field is item, as this isn't used in the actual payload. */ arrayItems?: Schema$GoogleCloudDataplexV1AspectTypeMetadataTemplate; /** @@ -387,7 +383,7 @@ export namespace dataplex_v1 { */ constraints?: Schema$GoogleCloudDataplexV1AspectTypeMetadataTemplateConstraints; /** - * Optional. The list of values for an enum type. Needs to be defined if the type is enum. + * Optional. The list of values for an enum type. You must define it if the type is enum. */ enumValues?: Schema$GoogleCloudDataplexV1AspectTypeMetadataTemplateEnumValue[]; /** @@ -395,7 +391,7 @@ export namespace dataplex_v1 { */ index?: number | null; /** - * Optional. map_items needs to be set if the type is map. map_items can refer to a primitive field or a complex (record only) field. To specify a primitive field, just name and type needs to be set in the nested MetadataTemplate. The recommended value for the name field is item, as this is not used in the actual payload. + * Optional. If the type is map, set map_items. map_items can refer to a primitive field or a complex (record only) field. To specify a primitive field, you only need to set name and type in the nested MetadataTemplate. The recommended value for the name field is item, as this isn't used in the actual payload. */ mapItems?: Schema$GoogleCloudDataplexV1AspectTypeMetadataTemplate; /** @@ -403,74 +399,74 @@ export namespace dataplex_v1 { */ name?: string | null; /** - * Optional. Field definition, needs to be specified if the type is record. Defines the nested fields. + * Optional. Field definition. You must specify it if the type is record. It defines the nested fields. */ recordFields?: Schema$GoogleCloudDataplexV1AspectTypeMetadataTemplate[]; /** - * Required. The datatype of this field. The following values are supported: Primitive types (string, integer, boolean, double, datetime); 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). + * 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 */ type?: string | null; /** - * Optional. Id can be used if this definition of the field needs to be reused later. Id needs to be unique across the entire template. Id can only be specified if the field type is record. + * Optional. You can use type id if this definition of the field needs to be reused later. The type id must be unique across the entire template. You can only specify it if the field type is record. */ typeId?: string | null; /** - * Optional. A reference to another field definition (instead of an inline definition). The value must be equal to the value of an id field defined elsewhere in the MetadataTemplate. Only fields with type as record can refer to other fields. + * Optional. A reference to another field definition (not an inline definition). The value must be equal to the value of an id field defined elsewhere in the MetadataTemplate. Only fields with record type can refer to other fields. */ typeRef?: string | null; } /** - * Definition of the annotations of a field + * Definition of the annotations of a field. */ export interface Schema$GoogleCloudDataplexV1AspectTypeMetadataTemplateAnnotations { /** - * Optional. Marks a field as deprecated, a deprecation message can be included. + * Optional. Marks a field as deprecated. You can include a deprecation message. */ deprecated?: string | null; /** - * Optional. Specify a description for a field + * Optional. Description for a field. */ description?: string | null; /** - * Optional. Specify a displayname for a field. + * Optional. Display name for a field. */ displayName?: string | null; /** - * Optional. Specify a display order for a field. Display order can be used to reorder where a field is rendered + * Optional. Display order for a field. You can use this to reorder where a field is rendered. */ displayOrder?: number | null; /** - * Optional. String Type annotations can be used to specify special meaning to string fields. The following values are supported: richText: The field must be interpreted as a rich text field. url: A fully qualified url link. resource: A service qualified resource reference. + * Optional. You can use String Type annotations to specify special meaning to string fields. The following values are supported: richText: The field must be interpreted as a rich text field. url: A fully qualified URL link. resource: A service qualified resource reference. */ stringType?: string | null; /** - * Optional. Suggested hints for string fields. These can be used to suggest values to users, through an UI for example. + * Optional. Suggested hints for string fields. You can use them to suggest values to users through console. */ stringValues?: string[] | null; } /** - * Definition of the constraints of a field + * Definition of the constraints of a field. */ export interface Schema$GoogleCloudDataplexV1AspectTypeMetadataTemplateConstraints { /** - * Optional. Marks this as an optional/required field. + * Optional. Marks this field as optional or required. */ required?: boolean | null; } /** - * Definition of Enumvalue (to be used by enum fields) + * Definition of Enumvalue, to be used for enum fields. */ export interface Schema$GoogleCloudDataplexV1AspectTypeMetadataTemplateEnumValue { /** - * Optional. Optional deprecation message to be set if an enum value needs to be deprecated. + * Optional. You can set this message if you need to deprecate an enum value. */ deprecated?: string | null; /** - * Required. Index for the enum. Cannot be modified. + * Required. Index for the enum value. It can't be modified. */ index?: number | null; /** - * Required. Name of the enumvalue. This is the actual value that the aspect will contain. + * Required. Name of the enumvalue. This is the actual value that the aspect can contain. */ name?: string | null; } @@ -1853,6 +1849,10 @@ export namespace dataplex_v1 { * A DataScanJob represents an instance of DataScan execution. */ export interface Schema$GoogleCloudDataplexV1DataScanJob { + /** + * Output only. The time when the DataScanJob was created. + */ + createTime?: string | null; /** * Output only. The result of the data profile scan. */ @@ -2161,7 +2161,7 @@ export namespace dataplex_v1 { */ export interface Schema$GoogleCloudDataplexV1Entry { /** - * Optional. The Aspects attached to the Entry. The format for the key can be one of the following: 1. {projectId\}.{locationId\}.{aspectTypeId\} (if the aspect is attached directly to the entry) 2. {projectId\}.{locationId\}.{aspectTypeId\}@{path\} (if the aspect is attached to an entry's path) + * Optional. The Aspects attached to the Entry. The format for the key can be one of the following: {projectId\}.{locationId\}.{aspectTypeId\} (if the aspect is attached directly to the entry) {projectId\}.{locationId\}.{aspectTypeId\}@{path\} (if the aspect is attached to an entry's path) */ aspects?: {[key: string]: Schema$GoogleCloudDataplexV1Aspect} | null; /** @@ -2169,7 +2169,7 @@ export namespace dataplex_v1 { */ createTime?: string | null; /** - * Optional. Source system related information for an entry. + * Optional. Information related to the source system for an entry. */ entrySource?: Schema$GoogleCloudDataplexV1EntrySource; /** @@ -2210,7 +2210,7 @@ export namespace dataplex_v1 { */ displayName?: string | null; /** - * 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. + * This checksum is computed by the service, and might be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. */ etag?: string | null; /** @@ -2222,11 +2222,7 @@ export namespace dataplex_v1 { */ name?: string | null; /** - * Output only. Denotes the transfer status of the Entry Group. It is unspecified for Entry Group created from Dataplex API. - */ - transferStatus?: string | null; - /** - * Output only. System generated globally unique ID for the EntryGroup. This ID will be different if the EntryGroup is deleted and re-created with the same name. + * Output only. System generated globally unique ID for the EntryGroup. If you delete and recreate the EntryGroup with the same name, this ID will be different. */ uid?: string | null; /** @@ -2235,7 +2231,7 @@ export namespace dataplex_v1 { updateTime?: string | null; } /** - * EntrySource contains source system related information for the entry. + * EntrySource contains information related to the source system of the Entry. */ export interface Schema$GoogleCloudDataplexV1EntrySource { /** @@ -2259,7 +2255,7 @@ export namespace dataplex_v1 { */ labels?: {[key: string]: string} | null; /** - * Output only. Location of the resource in the source system. Entry will be searchable by this location. By default, this should match the location of the EntryGroup containing this entry. A different value allows capturing source location for data external to GCP. + * Output only. Location of the resource in the source system. You can search the Entry by this location. By default, this should match the location of the EntryGroup containing this entry. A different value allows capturing the source location for data external to Google Cloud. */ location?: string | null; /** @@ -2313,7 +2309,7 @@ export namespace dataplex_v1 { */ displayName?: string | null; /** - * 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. + * Optional. This checksum is computed by the service, and might be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. */ etag?: string | null; /** @@ -2337,7 +2333,7 @@ export namespace dataplex_v1 { */ system?: string | null; /** - * Optional. Indicates the class this Entry Type belongs to, for example, TABLE, DATABASE, MODEL. + * Optional. Indicates the classes this Entry Type belongs to, for example, TABLE, DATABASE, MODEL. */ typeAliases?: string[] | null; /** @@ -2741,11 +2737,11 @@ export namespace dataplex_v1 { nextPageToken?: string | null; } /** - * List AspectTypes response + * List AspectTypes response. */ export interface Schema$GoogleCloudDataplexV1ListAspectTypesResponse { /** - * ListAspectTypes under the given parent location. + * AspectTypes under the given parent location. */ aspectTypes?: Schema$GoogleCloudDataplexV1AspectType[]; /** @@ -2753,7 +2749,7 @@ export namespace dataplex_v1 { */ nextPageToken?: string | null; /** - * Locations that could not be reached. + * Locations that the service couldn't reach. */ unreachableLocations?: string[] | null; } @@ -2877,22 +2873,25 @@ export namespace dataplex_v1 { */ nextPageToken?: string | null; } + /** + * List Entries response. + */ export interface Schema$GoogleCloudDataplexV1ListEntriesResponse { /** - * The list of entries. + * The list of entries under the given parent location. */ entries?: Schema$GoogleCloudDataplexV1Entry[]; /** - * Pagination token. + * Token to retrieve the next page of results, or empty if there are no more results in the list. */ nextPageToken?: string | null; } /** - * List ListEntryGroups response. + * List entry groups response. */ export interface Schema$GoogleCloudDataplexV1ListEntryGroupsResponse { /** - * ListEntryGroups under the given parent location. + * Entry groups under the given parent location. */ entryGroups?: Schema$GoogleCloudDataplexV1EntryGroup[]; /** @@ -2900,16 +2899,16 @@ export namespace dataplex_v1 { */ nextPageToken?: string | null; /** - * Locations that could not be reached. + * Locations that the service couldn't reach. */ unreachableLocations?: string[] | null; } /** - * List EntryTypes response + * List EntryTypes response. */ export interface Schema$GoogleCloudDataplexV1ListEntryTypesResponse { /** - * ListEntryTypes under the given parent location. + * EntryTypes under the given parent location. */ entryTypes?: Schema$GoogleCloudDataplexV1EntryType[]; /** @@ -2917,7 +2916,7 @@ export namespace dataplex_v1 { */ nextPageToken?: string | null; /** - * Locations that could not be reached. + * Locations that the service couldn't reach. */ unreachableLocations?: string[] | null; } @@ -3207,7 +3206,7 @@ export namespace dataplex_v1 { } export interface Schema$GoogleCloudDataplexV1SearchEntriesResponse { /** - * Pagination token. + * Token to retrieve the next page of results, or empty if there are no more results in the list. */ nextPageToken?: string | null; /** @@ -3215,11 +3214,11 @@ export namespace dataplex_v1 { */ results?: Schema$GoogleCloudDataplexV1SearchEntriesResult[]; /** - * The estimated total number of matching entries. Not guaranteed to be accurate. + * The estimated total number of matching entries. This number isn't guaranteed to be accurate. */ totalSize?: number | null; /** - * Unreachable locations. Search results don't include data from those locations. + * Locations that the service couldn't reach. Search results don't include data from these locations. */ unreachable?: string[] | null; } @@ -4257,7 +4256,7 @@ export namespace dataplex_v1 { } /** - * Looks up a single entry. + * Looks up a single Entry by name using the permission on the source system. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -4352,7 +4351,7 @@ export namespace dataplex_v1 { } /** - * Searches for entries matching given query and scope. + * Searches for Entries matching the given query and scope. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -4478,7 +4477,7 @@ export namespace dataplex_v1 { export interface Params$Resource$Projects$Locations$Lookupentry extends StandardParameters { /** - * Optional. Limits the aspects returned to the provided aspect types. Only works if the CUSTOM view is selected. + * Optional. Limits the aspects returned to the provided aspect types. It only works for CUSTOM view. */ aspectTypes?: string[]; /** @@ -4490,11 +4489,11 @@ export namespace dataplex_v1 { */ name?: string; /** - * Optional. Limits the aspects returned to those associated with the provided paths within the Entry. Only works if the CUSTOM view is selected. + * Optional. Limits the aspects returned to those associated with the provided paths within the Entry. It only works for CUSTOM view. */ paths?: string[]; /** - * Optional. View for controlling which parts of an entry are to be returned. + * Optional. View to control which parts of an entry the service should return. */ view?: string; } @@ -4505,15 +4504,15 @@ export namespace dataplex_v1 { */ name?: string; /** - * Optional. Ordering of the results. Supported options to be added later. + * Optional. Specifies the ordering of results. */ orderBy?: string; /** - * Optional. Pagination. + * Optional. Number of results in the search page. If <=0, then defaults to 10. Max limit for page_size is 1000. Throws an invalid argument for page_size \> 1000. */ pageSize?: number; /** - * + * Optional. Page token received from a previous SearchEntries call. Provide this to retrieve the subsequent page. */ pageToken?: string; /** @@ -4521,7 +4520,7 @@ export namespace dataplex_v1 { */ query?: string; /** - * Optional. The scope under which the search should be operating. Should either be organizations/ or projects/. If left unspecified, it will default to the organization where the project provided in name is located. + * Optional. The scope under which the search should be operating. It must either be organizations/ or projects/. If it is unspecified, it defaults to the organization where the project provided in name is located. */ scope?: string; } @@ -4533,7 +4532,7 @@ export namespace dataplex_v1 { } /** - * Creates an AspectType + * Creates an AspectType. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -4628,7 +4627,7 @@ export namespace dataplex_v1 { } /** - * Deletes a AspectType resource. + * Deletes an AspectType. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -4720,7 +4719,7 @@ export namespace dataplex_v1 { } /** - * Retrieves a AspectType resource. + * Gets an AspectType. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -5005,7 +5004,7 @@ export namespace dataplex_v1 { } /** - * Updates a AspectType resource. + * Updates an AspectType. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -5296,11 +5295,11 @@ export namespace dataplex_v1 { */ aspectTypeId?: string; /** - * Required. The resource name of the AspectType, of the form: projects/{project_number\}/locations/{location_id\} where location_id refers to a GCP region. + * Required. The resource name of the AspectType, of the form: projects/{project_number\}/locations/{location_id\} where location_id refers to a Google Cloud region. */ parent?: string; /** - * Optional. Only validate the request, but do not perform mutations. The default is false. + * Optional. The service validates the request without performing any mutations. The default is false. */ validateOnly?: boolean; @@ -5312,7 +5311,7 @@ export namespace dataplex_v1 { export interface Params$Resource$Projects$Locations$Aspecttypes$Delete extends StandardParameters { /** - * Optional. If the client provided etag value does not match the current etag value, the DeleteAspectTypeRequest method returns an ABORTED error response + * Optional. If the client provided etag value does not match the current etag value, the DeleteAspectTypeRequest method returns an ABORTED error response. */ etag?: string; /** @@ -5341,23 +5340,23 @@ export namespace dataplex_v1 { export interface Params$Resource$Projects$Locations$Aspecttypes$List extends StandardParameters { /** - * Optional. Filter request. Filters are case-sensitive. The following formats are supported:labels.key1 = "value1" labels:key1 name = "value" These restrictions can be coinjoined with AND, OR and NOT conjunctions. + * Optional. Filter request. Filters are case-sensitive. The service supports the following formats: labels.key1 = "value1" labels:key1 name = "value"These restrictions can be conjoined with AND, OR, and NOT conjunctions. */ filter?: string; /** - * Optional. Order by fields (name or create_time) for the result. If not specified, the ordering is undefined. + * Optional. Orders the result by name or create_time fields. If not specified, the ordering is undefined. */ orderBy?: string; /** - * Optional. Maximum number of AspectTypes to return. The service may return fewer than this value. If unspecified, at most 10 AspectTypes will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. + * Optional. Maximum number of AspectTypes to return. The service may return fewer than this value. If unspecified, the service returns at most 10 AspectTypes. The maximum value is 1000; values above 1000 will be coerced to 1000. */ pageSize?: number; /** - * Optional. Page token received from a previous ListAspectTypes call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListAspectTypes must match the call that provided the page token. + * Optional. Page token received from a previous ListAspectTypes call. Provide this to retrieve the subsequent page. When paginating, all other parameters you provide to ListAspectTypes must match the call that provided the page token. */ pageToken?: string; /** - * Required. The resource name of the AspectType location, of the form: projects/{project_number\}/locations/{location_id\} where location_id refers to a GCP region. + * Required. The resource name of the AspectType location, of the form: projects/{project_number\}/locations/{location_id\} where location_id refers to a Google Cloud region. */ parent?: string; } @@ -9504,7 +9503,7 @@ export namespace dataplex_v1 { } /** - * Creates an EntryGroup + * Creates an EntryGroup. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -9599,7 +9598,7 @@ export namespace dataplex_v1 { } /** - * Deletes a EntryGroup resource. + * Deletes an EntryGroup. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -9691,7 +9690,7 @@ export namespace dataplex_v1 { } /** - * Retrieves a EntryGroup resource. + * Gets an EntryGroup. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -9976,7 +9975,7 @@ export namespace dataplex_v1 { } /** - * Updates a EntryGroup resource. + * Updates an EntryGroup. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -10271,7 +10270,7 @@ export namespace dataplex_v1 { */ parent?: string; /** - * Optional. Only validate the request, but do not perform mutations. The default is false. + * Optional. The service validates the request without performing any mutations. The default is false. */ validateOnly?: boolean; @@ -10283,7 +10282,7 @@ export namespace dataplex_v1 { export interface Params$Resource$Projects$Locations$Entrygroups$Delete extends StandardParameters { /** - * Optional. If the client provided etag value does not match the current etag value, the DeleteEntryGroupRequest method returns an ABORTED error response + * Optional. If the client provided etag value does not match the current etag value, the DeleteEntryGroupRequest method returns an ABORTED error response. */ etag?: string; /** @@ -10320,15 +10319,15 @@ export namespace dataplex_v1 { */ orderBy?: string; /** - * Optional. Maximum number of EntryGroups to return. The service may return fewer than this value. If unspecified, at most 10 EntryGroups will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. + * Optional. Maximum number of EntryGroups to return. The service may return fewer than this value. If unspecified, the service returns at most 10 EntryGroups. The maximum value is 1000; values above 1000 will be coerced to 1000. */ pageSize?: number; /** - * Optional. Page token received from a previous ListEntryGroups call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListEntryGroups must match the call that provided the page token. + * Optional. Page token received from a previous ListEntryGroups call. Provide this to retrieve the subsequent page. When paginating, all other parameters you provide to ListEntryGroups must match the call that provided the page token. */ pageToken?: string; /** - * Required. The resource name of the entryGroup location, of the form: projects/{project_number\}/locations/{location_id\} where location_id refers to a GCP region. + * Required. The resource name of the entryGroup location, of the form: projects/{project_number\}/locations/{location_id\} where location_id refers to a Google Cloud region. */ parent?: string; } @@ -10343,7 +10342,7 @@ export namespace dataplex_v1 { */ updateMask?: string; /** - * Optional. Only validate the request, but do not perform mutations. The default is false. + * Optional. The service validates the request, without performing any mutations. The default is false. */ validateOnly?: boolean; @@ -10573,7 +10572,7 @@ export namespace dataplex_v1 { } /** - * Gets a single entry. + * Gets an Entry. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -10666,7 +10665,7 @@ export namespace dataplex_v1 { } /** - * Lists entries within an entry group. + * Lists Entries within an EntryGroup. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -10860,7 +10859,7 @@ export namespace dataplex_v1 { export interface Params$Resource$Projects$Locations$Entrygroups$Entries$Create extends StandardParameters { /** - * Required. Entry identifier. It has to be unique within an Entry Group.Entries corresponding to Google Cloud resources use Entry ID format based on Full Resource Names (https://cloud.google.com/apis/design/resource_names#full_resource_name). The format is a Full Resource Name of the resource without the prefix double slashes in the API Service Name part of Full Resource Name. This allows retrieval of entries using their associated resource name.For example if the Full Resource Name of a resource is //library.googleapis.com/shelves/shelf1/books/book2, then the suggested entry_id is library.googleapis.com/shelves/shelf1/books/book2.It is also suggested to follow the same convention for entries corresponding to resources from other providers or systems than Google Cloud.The maximum size of the field is 4000 characters. + * Required. Entry identifier. It has to be unique within an Entry Group.Entries corresponding to Google Cloud resources use an Entry ID format based on full resource names (https://cloud.google.com/apis/design/resource_names#full_resource_name). The format is a full resource name of the resource without the prefix double slashes in the API service name part of the full resource name. This allows retrieval of entries using their associated resource name.For example, if the full resource name of a resource is //library.googleapis.com/shelves/shelf1/books/book2, then the suggested entry_id is library.googleapis.com/shelves/shelf1/books/book2.It is also suggested to follow the same convention for entries corresponding to resources from providers or systems other than Google Cloud.The maximum size of the field is 4000 characters. */ entryId?: string; /** @@ -10883,7 +10882,7 @@ export namespace dataplex_v1 { export interface Params$Resource$Projects$Locations$Entrygroups$Entries$Get extends StandardParameters { /** - * Optional. Limits the aspects returned to the provided aspect types. Only works if the CUSTOM view is selected. + * Optional. Limits the aspects returned to the provided aspect types. It only works for CUSTOM view. */ aspectTypes?: string[]; /** @@ -10891,26 +10890,26 @@ export namespace dataplex_v1 { */ name?: string; /** - * Optional. Limits the aspects returned to those associated with the provided paths within the Entry. Only works if the CUSTOM view is selected. + * Optional. Limits the aspects returned to those associated with the provided paths within the Entry. It only works for CUSTOM view. */ paths?: string[]; /** - * Optional. View for controlling which parts of an entry are to be returned. + * Optional. View to control which parts of an entry the service should return. */ view?: string; } export interface Params$Resource$Projects$Locations$Entrygroups$Entries$List extends StandardParameters { /** - * Optional. A filter on the entries to return. Filters are case-sensitive. The request can be filtered by the following fields: entry_type, entry_source.display_name. The comparison operators are =, !=, <, \>, <=, \>= (strings are compared according to lexical order) The logical operators AND, OR, NOT can be used in the filter. Wildcard "*" can be used, but for entry_type the full project id or number needs to be provided. Example filter expressions: "entry_source.display_name=AnExampleDisplayName" "entry_type=projects/example-project/locations/global/entryTypes/example-entry_type" "entry_type=projects/example-project/locations/us/entryTypes/a* OR entry_type=projects/another-project/locations/x" "NOT entry_source.display_name=AnotherExampleDisplayName" + * Optional. A filter on the entries to return. Filters are case-sensitive. You can filter the request by the following fields: entry_type entry_source.display_nameThe comparison operators are =, !=, <, \>, <=, \>=. The service compares strings according to lexical order.You can use the logical operators AND, OR, NOT in the filter.You can use Wildcard "*", but for entry_type you need to provide the full project id or number.Example filter expressions: "entry_source.display_name=AnExampleDisplayName" "entry_type=projects/example-project/locations/global/entryTypes/example-entry_type" "entry_type=projects/example-project/locations/us/entryTypes/a* OR entry_type=projects/another-project/locations/x" "NOT entry_source.display_name=AnotherExampleDisplayName" */ filter?: string; /** - * + * Optional. Number of items to return per page. If there are remaining results, the service returns a next_page_token. If unspecified, the service returns at most 10 Entries. The maximum value is 100; values above 100 will be coerced to 100. */ pageSize?: number; /** - * Optional. The pagination token returned by a previous request. + * Optional. Page token received from a previous ListEntries call. Provide this to retrieve the subsequent page. */ pageToken?: string; /** @@ -10921,15 +10920,15 @@ export namespace dataplex_v1 { export interface Params$Resource$Projects$Locations$Entrygroups$Entries$Patch extends StandardParameters { /** - * Optional. If set to true and the entry does not exist, it will be created. + * Optional. If set to true and the entry doesn't exist, the service will create it. */ allowMissing?: boolean; /** - * Optional. The map keys of the Aspects which should be modified. Supports the following syntaxes: * - matches aspect on given type and empty path * @path - matches aspect on given type and specified path * * - matches aspects on given type for all paths * *@path - matches aspects of all types on the given pathExisting aspects matching the syntax will not be removed unless delete_missing_aspects is set to true.If this field is left empty, it will be treated as specifying exactly those Aspects present in the request. + * Optional. The map keys of the Aspects which the service should modify. It supports the following syntaxes: - matches an aspect of the given type and empty path. @path - matches an aspect of the given type and specified path. * - matches aspects of the given type for all paths. *@path - matches aspects of all types on the given path.The service will not remove existing aspects matching the syntax unless delete_missing_aspects is set to true.If this field is left empty, the service treats it as specifying exactly those Aspects present in the request. */ aspectKeys?: string[]; /** - * Optional. If set to true and the aspect_keys specify aspect ranges, any existing aspects from that range not provided in the request will be deleted. + * Optional. If set to true and the aspect_keys specify aspect ranges, the service deletes any existing aspects from that range that weren't provided in the request. */ deleteMissingAspects?: boolean; /** @@ -10937,7 +10936,7 @@ export namespace dataplex_v1 { */ name?: string; /** - * Optional. Mask of fields to update. To update Aspects, the update_mask must contain the value "aspects".If the update_mask is empty, all modifiable fields present in the request will be updated. + * Optional. Mask of fields to update. To update Aspects, the update_mask must contain the value "aspects".If the update_mask is empty, the service will update all modifiable fields present in the request. */ updateMask?: string; @@ -10954,7 +10953,7 @@ export namespace dataplex_v1 { } /** - * Creates an EntryType + * Creates an EntryType. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -11049,7 +11048,7 @@ export namespace dataplex_v1 { } /** - * Deletes a EntryType resource. + * Deletes an EntryType. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -11141,7 +11140,7 @@ export namespace dataplex_v1 { } /** - * Retrieves a EntryType resource. + * Gets an EntryType. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -11426,7 +11425,7 @@ export namespace dataplex_v1 { } /** - * Updates a EntryType resource. + * Updates an EntryType. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -11717,11 +11716,11 @@ export namespace dataplex_v1 { */ entryTypeId?: string; /** - * Required. The resource name of the EntryType, of the form: projects/{project_number\}/locations/{location_id\} where location_id refers to a GCP region. + * Required. The resource name of the EntryType, of the form: projects/{project_number\}/locations/{location_id\} where location_id refers to a Google Cloud region. */ parent?: string; /** - * Optional. Only validate the request, but do not perform mutations. The default is false. + * Optional. The service validates the request without performing any mutations. The default is false. */ validateOnly?: boolean; @@ -11733,7 +11732,7 @@ export namespace dataplex_v1 { export interface Params$Resource$Projects$Locations$Entrytypes$Delete extends StandardParameters { /** - * Optional. If the client provided etag value does not match the current etag value, the DeleteEntryTypeRequest method returns an ABORTED error response + * Optional. If the client provided etag value does not match the current etag value, the DeleteEntryTypeRequest method returns an ABORTED error response. */ etag?: string; /** @@ -11762,23 +11761,23 @@ export namespace dataplex_v1 { export interface Params$Resource$Projects$Locations$Entrytypes$List extends StandardParameters { /** - * Optional. Filter request. Filters are case-sensitive. The following formats are supported:labels.key1 = "value1" labels:key1 name = "value" These restrictions can be coinjoined with AND, OR and NOT conjunctions. + * Optional. Filter request. Filters are case-sensitive. The service supports the following formats: labels.key1 = "value1" labels:key1 name = "value"These restrictions can be conjoined with AND, OR, and NOT conjunctions. */ filter?: string; /** - * Optional. Order by fields (name or create_time) for the result. If not specified, the ordering is undefined. + * Optional. Orders the result by name or create_time fields. If not specified, the ordering is undefined. */ orderBy?: string; /** - * Optional. Maximum number of EntryTypes to return. The service may return fewer than this value. If unspecified, at most 10 EntryTypes will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. + * Optional. Maximum number of EntryTypes to return. The service may return fewer than this value. If unspecified, the service returns at most 10 EntryTypes. The maximum value is 1000; values above 1000 will be coerced to 1000. */ pageSize?: number; /** - * Optional. Page token received from a previous ListEntryTypes call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListEntryTypes must match the call that provided the page token. + * Optional. Page token received from a previous ListEntryTypes call. Provide this to retrieve the subsequent page. When paginating, all other parameters you provided to ListEntryTypes must match the call that provided the page token. */ pageToken?: string; /** - * Required. The resource name of the EntryType location, of the form: projects/{project_number\}/locations/{location_id\} where location_id refers to a GCP region. + * Required. The resource name of the EntryType location, of the form: projects/{project_number\}/locations/{location_id\} where location_id refers to a Google Cloud region. */ parent?: string; } @@ -11793,7 +11792,7 @@ export namespace dataplex_v1 { */ updateMask?: string; /** - * Optional. Only validate the request, but do not perform mutations. The default is false. + * Optional. The service validates the request without performing any mutations. The default is false. */ validateOnly?: boolean; diff --git a/src/apis/dialogflow/v2.ts b/src/apis/dialogflow/v2.ts index 689fec9fed..b7506de591 100644 --- a/src/apis/dialogflow/v2.ts +++ b/src/apis/dialogflow/v2.ts @@ -632,6 +632,10 @@ export namespace dialogflow_v2 { * The target page to transition to. Format: `projects//locations//agents//flows//pages/`. */ targetPage?: string | null; + /** + * The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. + */ + targetPlaybook?: string | null; /** * 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. */ @@ -1602,11 +1606,11 @@ export namespace dialogflow_v2 { */ export interface Schema$GoogleCloudDialogflowCxV3beta1TestConfig { /** - * 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 both are set, `page` takes precedence over `flow`. If neither is set, the test case will start with start page on the default start flow. + * 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. */ flow?: string | null; /** - * 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 both are set, `page` takes precedence over `flow`. If neither is set, the test case will start with start page on the default start flow. + * 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. */ page?: string | null; /** @@ -2326,6 +2330,10 @@ export namespace dialogflow_v2 { * The target page to transition to. Format: `projects//locations//agents//flows//pages/`. */ targetPage?: string | null; + /** + * The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. + */ + targetPlaybook?: string | null; /** * 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. */ @@ -3292,11 +3300,11 @@ export namespace dialogflow_v2 { */ export interface Schema$GoogleCloudDialogflowCxV3TestConfig { /** - * 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 both are set, `page` takes precedence over `flow`. If neither is set, the test case will start with start page on the default start flow. + * 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. */ flow?: string | null; /** - * 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 both are set, `page` takes precedence over `flow`. If neither is set, the test case will start with start page on the default start flow. + * 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. */ page?: string | null; /** @@ -4327,6 +4335,19 @@ export namespace dialogflow_v2 { */ queryResult?: Schema$GoogleCloudDialogflowV2beta1QueryResult; } + /** + * A customer-managed encryption key specification that can be applied to all created resources (e.g. Conversation). + */ + export interface Schema$GoogleCloudDialogflowV2beta1EncryptionSpec { + /** + * 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\}` + */ + kmsKey?: string | null; + /** + * Immutable. The resource name of the encryption key specification resource. Format: projects/{project\}/locations/{location\}/encryptionSpec + */ + name?: string | null; + } /** * 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). */ @@ -4472,6 +4493,24 @@ export namespace dialogflow_v2 { */ warnings?: Schema$GoogleRpcStatus[]; } + /** + * Metadata for initializing a location-level encryption specification. + */ + export interface Schema$GoogleCloudDialogflowV2beta1InitializeEncryptionSpecMetadata { + /** + * Output only. The original request for initialization. + */ + request?: Schema$GoogleCloudDialogflowV2beta1InitializeEncryptionSpecRequest; + } + /** + * The request to initialize a location-level encryption specification. + */ + export interface Schema$GoogleCloudDialogflowV2beta1InitializeEncryptionSpecRequest { + /** + * 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. + */ + encryptionSpec?: Schema$GoogleCloudDialogflowV2beta1EncryptionSpec; + } /** * 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). */ @@ -5512,6 +5551,10 @@ export namespace dialogflow_v2 { * Output only. The role of the participant. */ participantRole?: string | null; + /** + * Optional. Automated agent responses. + */ + responseMessages?: Schema$GoogleCloudDialogflowV2beta1ResponseMessage[]; /** * Optional. The time when the message was sent. */ @@ -5624,6 +5667,96 @@ export namespace dialogflow_v2 { */ webhookSource?: string | null; } + /** + * Response messages from an automated agent. + */ + export interface Schema$GoogleCloudDialogflowV2beta1ResponseMessage { + /** + * A signal that indicates the interaction with the Dialogflow agent has ended. + */ + endInteraction?: Schema$GoogleCloudDialogflowV2beta1ResponseMessageEndInteraction; + /** + * Hands off conversation to a live agent. + */ + liveAgentHandoff?: Schema$GoogleCloudDialogflowV2beta1ResponseMessageLiveAgentHandoff; + /** + * An audio response message composed of both the synthesized Dialogflow agent responses and the audios hosted in places known to the client. + */ + mixedAudio?: Schema$GoogleCloudDialogflowV2beta1ResponseMessageMixedAudio; + /** + * Returns a response containing a custom, platform-specific payload. + */ + payload?: {[key: string]: any} | null; + /** + * A signal that the client should transfer the phone call connected to this agent to a third-party endpoint. + */ + telephonyTransferCall?: Schema$GoogleCloudDialogflowV2beta1ResponseMessageTelephonyTransferCall; + /** + * Returns a text response. + */ + text?: Schema$GoogleCloudDialogflowV2beta1ResponseMessageText; + } + /** + * Indicates that interaction with the Dialogflow agent has ended. + */ + export interface Schema$GoogleCloudDialogflowV2beta1ResponseMessageEndInteraction {} + /** + * 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. + */ + export interface Schema$GoogleCloudDialogflowV2beta1ResponseMessageLiveAgentHandoff { + /** + * Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. + */ + metadata?: {[key: string]: any} | null; + } + /** + * Represents an audio message that is composed of both segments synthesized from the Dialogflow agent prompts and ones hosted externally at the specified URIs. + */ + export interface Schema$GoogleCloudDialogflowV2beta1ResponseMessageMixedAudio { + /** + * Segments this audio response is composed of. + */ + segments?: Schema$GoogleCloudDialogflowV2beta1ResponseMessageMixedAudioSegment[]; + } + /** + * Represents one segment of audio. + */ + export interface Schema$GoogleCloudDialogflowV2beta1ResponseMessageMixedAudioSegment { + /** + * 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. + */ + allowPlaybackInterruption?: boolean | null; + /** + * Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. + */ + audio?: string | null; + /** + * Client-specific URI that points to an audio clip accessible to the client. + */ + uri?: string | null; + } + /** + * Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. + */ + export interface Schema$GoogleCloudDialogflowV2beta1ResponseMessageTelephonyTransferCall { + /** + * Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164). + */ + phoneNumber?: string | null; + /** + * Transfer the call to a SIP endpoint. + */ + sipUri?: string | null; + } + /** + * The text response message. + */ + export interface Schema$GoogleCloudDialogflowV2beta1ResponseMessageText { + /** + * A collection of text responses. + */ + text?: string[] | null; + } /** * 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. */ @@ -6409,6 +6542,19 @@ export namespace dialogflow_v2 { */ acceptsDtmfInput?: boolean | null; } + /** + * A customer-managed encryption key specification that can be applied to all created resources (e.g. Conversation). + */ + export interface Schema$GoogleCloudDialogflowV2EncryptionSpec { + /** + * 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\}` + */ + kmsKey?: string | null; + /** + * Immutable. The resource name of the encryption key specification resource. Format: projects/{project\}/locations/{location\}/encryptionSpec + */ + name?: string | null; + } /** * 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). */ @@ -7308,6 +7454,24 @@ export namespace dialogflow_v2 { */ topP?: number | null; } + /** + * Metadata for initializing a location-level encryption specification. + */ + export interface Schema$GoogleCloudDialogflowV2InitializeEncryptionSpecMetadata { + /** + * Output only. The original request for initialization. + */ + request?: Schema$GoogleCloudDialogflowV2InitializeEncryptionSpecRequest; + } + /** + * The request to initialize a location-level encryption specification. + */ + export interface Schema$GoogleCloudDialogflowV2InitializeEncryptionSpecRequest { + /** + * 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. + */ + encryptionSpec?: Schema$GoogleCloudDialogflowV2EncryptionSpec; + } /** * Instructs the speech recognizer how to process the audio content. */ @@ -8961,10 +9125,30 @@ export namespace dialogflow_v2 { * Configures speech transcription for ConversationProfile. */ export interface Schema$GoogleCloudDialogflowV2SpeechToTextConfig { + /** + * Defines the list of other language codes in addition to the one provided by the conversation profile that may be detected as the language code for the utterances over the conversation. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. + */ + alternativeLanguageCodes?: string[] | null; + /** + * Audio encoding of the audio content to process. + */ + audioEncoding?: string | null; + /** + * 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. + */ + enableWordInfo?: boolean | null; + /** + * The language of the supplied audio. Dialogflow does not do translations. 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. + */ + languageCode?: string | null; /** * Which Speech model to select. Select the model best suited to your domain to get best results. If a model is not explicitly specified, then Dialogflow auto-selects a model based on other parameters in the SpeechToTextConfig and Agent settings. If enhanced speech model is enabled for the agent and an enhanced version of the specified model for the language does not exist, then the speech is recognized using the standard version of the specified model. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics#select-model) for more details. If you specify a model, the following models typically have the best performance: - phone_call (best for Agent Assist and telephony) - latest_short (best for Dialogflow non-telephony) - command_and_search Leave this field unspecified to use [Agent Speech settings](https://cloud.google.com/dialogflow/cx/docs/concept/agent#settings-speech) for model selection. */ model?: string | null; + /** + * 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. + */ + sampleRateHertz?: number | null; /** * The speech model used in speech to text. `SPEECH_MODEL_VARIANT_UNSPECIFIED`, `USE_BEST_AVAILABLE` will be treated as `USE_ENHANCED`. It can be overridden in AnalyzeContentRequest and StreamingAnalyzeContentRequest request. If enhanced model variant is specified and an enhanced version of the specified model for the language does not exist, then it would emit an error. */ @@ -23596,6 +23780,7 @@ export namespace dialogflow_v2 { conversationModels: Resource$Projects$Locations$Conversationmodels; conversationProfiles: Resource$Projects$Locations$Conversationprofiles; conversations: Resource$Projects$Locations$Conversations; + encryptionSpec: Resource$Projects$Locations$Encryptionspec; generators: Resource$Projects$Locations$Generators; knowledgeBases: Resource$Projects$Locations$Knowledgebases; operations: Resource$Projects$Locations$Operations; @@ -23616,6 +23801,9 @@ export namespace dialogflow_v2 { this.conversations = new Resource$Projects$Locations$Conversations( this.context ); + this.encryptionSpec = new Resource$Projects$Locations$Encryptionspec( + this.context + ); this.generators = new Resource$Projects$Locations$Generators( this.context ); @@ -23914,6 +24102,100 @@ export namespace dialogflow_v2 { } } + /** + * Gets location-level encryption key specification. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + getEncryptionSpec( + params: Params$Resource$Projects$Locations$Getencryptionspec, + options: StreamMethodOptions + ): GaxiosPromise; + getEncryptionSpec( + params?: Params$Resource$Projects$Locations$Getencryptionspec, + options?: MethodOptions + ): GaxiosPromise; + getEncryptionSpec( + params: Params$Resource$Projects$Locations$Getencryptionspec, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getEncryptionSpec( + params: Params$Resource$Projects$Locations$Getencryptionspec, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getEncryptionSpec( + params: Params$Resource$Projects$Locations$Getencryptionspec, + callback: BodyResponseCallback + ): void; + getEncryptionSpec( + callback: BodyResponseCallback + ): void; + getEncryptionSpec( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Getencryptionspec + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Getencryptionspec; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Getencryptionspec; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dialogflow.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + /** * Lists information about the supported locations for this service. * @@ -24130,6 +24412,13 @@ export namespace dialogflow_v2 { */ parent?: string; } + export interface Params$Resource$Projects$Locations$Getencryptionspec + extends StandardParameters { + /** + * Required. The name of the encryption spec resource to get. + */ + name?: string; + } export interface Params$Resource$Projects$Locations$List extends StandardParameters { /** @@ -35231,6 +35520,122 @@ export namespace dialogflow_v2 { requestBody?: Schema$GoogleCloudDialogflowV2SuggestConversationSummaryRequest; } + export class Resource$Projects$Locations$Encryptionspec { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Initializes a location-level encryption key specification. An error will be thrown if the location has resources already created before the initialization. Once 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. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + initialize( + params: Params$Resource$Projects$Locations$Encryptionspec$Initialize, + options: StreamMethodOptions + ): GaxiosPromise; + initialize( + params?: Params$Resource$Projects$Locations$Encryptionspec$Initialize, + options?: MethodOptions + ): GaxiosPromise; + initialize( + params: Params$Resource$Projects$Locations$Encryptionspec$Initialize, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + initialize( + params: Params$Resource$Projects$Locations$Encryptionspec$Initialize, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + initialize( + params: Params$Resource$Projects$Locations$Encryptionspec$Initialize, + callback: BodyResponseCallback + ): void; + initialize( + callback: BodyResponseCallback + ): void; + initialize( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Encryptionspec$Initialize + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Encryptionspec$Initialize; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Encryptionspec$Initialize; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dialogflow.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2/{+name}:initialize').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Encryptionspec$Initialize + extends StandardParameters { + /** + * Immutable. The resource name of the encryption key specification resource. Format: projects/{project\}/locations/{location\}/encryptionSpec + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDialogflowV2InitializeEncryptionSpecRequest; + } + export class Resource$Projects$Locations$Generators { context: APIRequestContext; constructor(context: APIRequestContext) { diff --git a/src/apis/dialogflow/v2beta1.ts b/src/apis/dialogflow/v2beta1.ts index 2beff5da0d..c84c9dad25 100644 --- a/src/apis/dialogflow/v2beta1.ts +++ b/src/apis/dialogflow/v2beta1.ts @@ -632,6 +632,10 @@ export namespace dialogflow_v2beta1 { * The target page to transition to. Format: `projects//locations//agents//flows//pages/`. */ targetPage?: string | null; + /** + * The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. + */ + targetPlaybook?: string | null; /** * 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. */ @@ -1602,11 +1606,11 @@ export namespace dialogflow_v2beta1 { */ export interface Schema$GoogleCloudDialogflowCxV3beta1TestConfig { /** - * 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 both are set, `page` takes precedence over `flow`. If neither is set, the test case will start with start page on the default start flow. + * 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. */ flow?: string | null; /** - * 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 both are set, `page` takes precedence over `flow`. If neither is set, the test case will start with start page on the default start flow. + * 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. */ page?: string | null; /** @@ -2326,6 +2330,10 @@ export namespace dialogflow_v2beta1 { * The target page to transition to. Format: `projects//locations//agents//flows//pages/`. */ targetPage?: string | null; + /** + * The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. + */ + targetPlaybook?: string | null; /** * 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. */ @@ -3292,11 +3300,11 @@ export namespace dialogflow_v2beta1 { */ export interface Schema$GoogleCloudDialogflowCxV3TestConfig { /** - * 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 both are set, `page` takes precedence over `flow`. If neither is set, the test case will start with start page on the default start flow. + * 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. */ flow?: string | null; /** - * 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 both are set, `page` takes precedence over `flow`. If neither is set, the test case will start with start page on the default start flow. + * 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. */ page?: string | null; /** @@ -4719,6 +4727,19 @@ export namespace dialogflow_v2beta1 { */ acceptsDtmfInput?: boolean | null; } + /** + * A customer-managed encryption key specification that can be applied to all created resources (e.g. Conversation). + */ + export interface Schema$GoogleCloudDialogflowV2beta1EncryptionSpec { + /** + * 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\}` + */ + kmsKey?: string | null; + /** + * Immutable. The resource name of the encryption key specification resource. Format: projects/{project\}/locations/{location\}/encryptionSpec + */ + name?: string | null; + } /** * 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). */ @@ -5528,6 +5549,24 @@ export namespace dialogflow_v2beta1 { */ topP?: number | null; } + /** + * Metadata for initializing a location-level encryption specification. + */ + export interface Schema$GoogleCloudDialogflowV2beta1InitializeEncryptionSpecMetadata { + /** + * Output only. The original request for initialization. + */ + request?: Schema$GoogleCloudDialogflowV2beta1InitializeEncryptionSpecRequest; + } + /** + * The request to initialize a location-level encryption specification. + */ + export interface Schema$GoogleCloudDialogflowV2beta1InitializeEncryptionSpecRequest { + /** + * 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. + */ + encryptionSpec?: Schema$GoogleCloudDialogflowV2beta1EncryptionSpec; + } /** * Instructs the speech recognizer on how to process the audio content. */ @@ -6872,6 +6911,10 @@ export namespace dialogflow_v2beta1 { * Output only. The role of the participant. */ participantRole?: string | null; + /** + * Optional. Automated agent responses. + */ + responseMessages?: Schema$GoogleCloudDialogflowV2beta1ResponseMessage[]; /** * Optional. The time when the message was sent. */ @@ -7464,10 +7507,30 @@ export namespace dialogflow_v2beta1 { * Configures speech transcription for ConversationProfile. */ export interface Schema$GoogleCloudDialogflowV2beta1SpeechToTextConfig { + /** + * Defines the list of other language codes in addition to the one provided by the conversation profile that may be detected as the language code for the utterances over the conversation. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. + */ + alternativeLanguageCodes?: string[] | null; + /** + * Audio encoding of the audio content to process. + */ + audioEncoding?: string | null; + /** + * 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. + */ + enableWordInfo?: boolean | null; + /** + * The language of the supplied audio. Dialogflow does not do translations. 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. + */ + languageCode?: string | null; /** * Which Speech model to select. Select the model best suited to your domain to get best results. If a model is not explicitly specified, then Dialogflow auto-selects a model based on other parameters in the SpeechToTextConfig and Agent settings. If enhanced speech model is enabled for the agent and an enhanced version of the specified model for the language does not exist, then the speech is recognized using the standard version of the specified model. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics#select-model) for more details. If you specify a model, the following models typically have the best performance: - phone_call (best for Agent Assist and telephony) - latest_short (best for Dialogflow non-telephony) - command_and_search Leave this field unspecified to use [Agent Speech settings](https://cloud.google.com/dialogflow/cx/docs/concept/agent#settings-speech) for model selection. */ model?: string | null; + /** + * 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. + */ + sampleRateHertz?: number | null; /** * The speech model used in speech to text. `SPEECH_MODEL_VARIANT_UNSPECIFIED`, `USE_BEST_AVAILABLE` will be treated as `USE_ENHANCED`. It can be overridden in AnalyzeContentRequest and StreamingAnalyzeContentRequest request. If enhanced model variant is specified and an enhanced version of the specified model for the language does not exist, then it would emit an error. */ @@ -8286,6 +8349,19 @@ export namespace dialogflow_v2beta1 { */ createTime?: string | null; } + /** + * A customer-managed encryption key specification that can be applied to all created resources (e.g. Conversation). + */ + export interface Schema$GoogleCloudDialogflowV2EncryptionSpec { + /** + * 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\}` + */ + kmsKey?: string | null; + /** + * Immutable. The resource name of the encryption key specification resource. Format: projects/{project\}/locations/{location\}/encryptionSpec + */ + name?: string | null; + } /** * 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). */ @@ -8461,6 +8537,24 @@ export namespace dialogflow_v2beta1 { */ warnings?: Schema$GoogleRpcStatus[]; } + /** + * Metadata for initializing a location-level encryption specification. + */ + export interface Schema$GoogleCloudDialogflowV2InitializeEncryptionSpecMetadata { + /** + * Output only. The original request for initialization. + */ + request?: Schema$GoogleCloudDialogflowV2InitializeEncryptionSpecRequest; + } + /** + * The request to initialize a location-level encryption specification. + */ + export interface Schema$GoogleCloudDialogflowV2InitializeEncryptionSpecRequest { + /** + * 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. + */ + encryptionSpec?: Schema$GoogleCloudDialogflowV2EncryptionSpec; + } /** * InputDataset used to create model or do evaluation. NextID:5 */ @@ -22861,6 +22955,7 @@ export namespace dialogflow_v2beta1 { answerRecords: Resource$Projects$Locations$Answerrecords; conversationProfiles: Resource$Projects$Locations$Conversationprofiles; conversations: Resource$Projects$Locations$Conversations; + encryptionSpec: Resource$Projects$Locations$Encryptionspec; generators: Resource$Projects$Locations$Generators; knowledgeBases: Resource$Projects$Locations$Knowledgebases; operations: Resource$Projects$Locations$Operations; @@ -22877,6 +22972,9 @@ export namespace dialogflow_v2beta1 { this.conversations = new Resource$Projects$Locations$Conversations( this.context ); + this.encryptionSpec = new Resource$Projects$Locations$Encryptionspec( + this.context + ); this.generators = new Resource$Projects$Locations$Generators( this.context ); @@ -23175,6 +23273,100 @@ export namespace dialogflow_v2beta1 { } } + /** + * Gets location-level encryption key specification. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + getEncryptionSpec( + params: Params$Resource$Projects$Locations$Getencryptionspec, + options: StreamMethodOptions + ): GaxiosPromise; + getEncryptionSpec( + params?: Params$Resource$Projects$Locations$Getencryptionspec, + options?: MethodOptions + ): GaxiosPromise; + getEncryptionSpec( + params: Params$Resource$Projects$Locations$Getencryptionspec, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getEncryptionSpec( + params: Params$Resource$Projects$Locations$Getencryptionspec, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getEncryptionSpec( + params: Params$Resource$Projects$Locations$Getencryptionspec, + callback: BodyResponseCallback + ): void; + getEncryptionSpec( + callback: BodyResponseCallback + ): void; + getEncryptionSpec( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Getencryptionspec + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Getencryptionspec; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Getencryptionspec; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dialogflow.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + /** * Lists information about the supported locations for this service. * @@ -23391,6 +23583,13 @@ export namespace dialogflow_v2beta1 { */ parent?: string; } + export interface Params$Resource$Projects$Locations$Getencryptionspec + extends StandardParameters { + /** + * Required. The name of the encryption spec resource to get. + */ + name?: string; + } export interface Params$Resource$Projects$Locations$List extends StandardParameters { /** @@ -33182,6 +33381,122 @@ export namespace dialogflow_v2beta1 { requestBody?: Schema$GoogleCloudDialogflowV2beta1SuggestConversationSummaryRequest; } + export class Resource$Projects$Locations$Encryptionspec { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Initializes a location-level encryption key specification. An error will be thrown if the location has resources already created before the initialization. Once 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. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + initialize( + params: Params$Resource$Projects$Locations$Encryptionspec$Initialize, + options: StreamMethodOptions + ): GaxiosPromise; + initialize( + params?: Params$Resource$Projects$Locations$Encryptionspec$Initialize, + options?: MethodOptions + ): GaxiosPromise; + initialize( + params: Params$Resource$Projects$Locations$Encryptionspec$Initialize, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + initialize( + params: Params$Resource$Projects$Locations$Encryptionspec$Initialize, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + initialize( + params: Params$Resource$Projects$Locations$Encryptionspec$Initialize, + callback: BodyResponseCallback + ): void; + initialize( + callback: BodyResponseCallback + ): void; + initialize( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Encryptionspec$Initialize + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Encryptionspec$Initialize; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Encryptionspec$Initialize; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dialogflow.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2beta1/{+name}:initialize').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Encryptionspec$Initialize + extends StandardParameters { + /** + * Immutable. The resource name of the encryption key specification resource. Format: projects/{project\}/locations/{location\}/encryptionSpec + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDialogflowV2beta1InitializeEncryptionSpecRequest; + } + export class Resource$Projects$Locations$Generators { context: APIRequestContext; constructor(context: APIRequestContext) { diff --git a/src/apis/dialogflow/v3.ts b/src/apis/dialogflow/v3.ts index 16ea0dfd70..01ad16d6e6 100644 --- a/src/apis/dialogflow/v3.ts +++ b/src/apis/dialogflow/v3.ts @@ -843,6 +843,10 @@ export namespace dialogflow_v3 { * The target page to transition to. Format: `projects//locations//agents//flows//pages/`. */ targetPage?: string | null; + /** + * The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. + */ + targetPlaybook?: string | null; /** * 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. */ @@ -1813,11 +1817,11 @@ export namespace dialogflow_v3 { */ export interface Schema$GoogleCloudDialogflowCxV3beta1TestConfig { /** - * 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 both are set, `page` takes precedence over `flow`. If neither is set, the test case will start with start page on the default start flow. + * 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. */ flow?: string | null; /** - * 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 both are set, `page` takes precedence over `flow`. If neither is set, the test case will start with start page on the default start flow. + * 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. */ page?: string | null; /** @@ -2573,6 +2577,10 @@ export namespace dialogflow_v3 { * Diagnostic info related to the answer generation model call. */ export interface Schema$GoogleCloudDialogflowCxV3DataStoreConnectionSignalsAnswerGenerationModelCallSignals { + /** + * Name of the generative model. For example, "gemini-ultra", "gemini-pro", "gemini-1.5-flash" etc. Defaults to "Other" if the model is unknown. + */ + model?: string | null; /** * Output of the generative model. */ @@ -2625,6 +2633,10 @@ export namespace dialogflow_v3 { * Diagnostic info related to the rewriter model call. */ export interface Schema$GoogleCloudDialogflowCxV3DataStoreConnectionSignalsRewriterModelCallSignals { + /** + * Name of the generative model. For example, "gemini-ultra", "gemini-pro", "gemini-1.5-flash" etc. Defaults to "Other" if the model is unknown. + */ + model?: string | null; /** * Output of the generative model. */ @@ -2956,6 +2968,10 @@ export namespace dialogflow_v3 { * The target page to transition to. Format: `projects//locations//agents//flows//pages/`. */ targetPage?: string | null; + /** + * The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. + */ + targetPlaybook?: string | null; /** * 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. */ @@ -5384,11 +5400,11 @@ export namespace dialogflow_v3 { */ export interface Schema$GoogleCloudDialogflowCxV3TestConfig { /** - * 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 both are set, `page` takes precedence over `flow`. If neither is set, the test case will start with start page on the default start flow. + * 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. */ flow?: string | null; /** - * 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 both are set, `page` takes precedence over `flow`. If neither is set, the test case will start with start page on the default start flow. + * 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. */ page?: string | null; /** @@ -6264,6 +6280,19 @@ export namespace dialogflow_v3 { */ queryResult?: Schema$GoogleCloudDialogflowV2beta1QueryResult; } + /** + * A customer-managed encryption key specification that can be applied to all created resources (e.g. Conversation). + */ + export interface Schema$GoogleCloudDialogflowV2beta1EncryptionSpec { + /** + * 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\}` + */ + kmsKey?: string | null; + /** + * Immutable. The resource name of the encryption key specification resource. Format: projects/{project\}/locations/{location\}/encryptionSpec + */ + name?: string | null; + } /** * 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). */ @@ -6409,6 +6438,24 @@ export namespace dialogflow_v3 { */ warnings?: Schema$GoogleRpcStatus[]; } + /** + * Metadata for initializing a location-level encryption specification. + */ + export interface Schema$GoogleCloudDialogflowV2beta1InitializeEncryptionSpecMetadata { + /** + * Output only. The original request for initialization. + */ + request?: Schema$GoogleCloudDialogflowV2beta1InitializeEncryptionSpecRequest; + } + /** + * The request to initialize a location-level encryption specification. + */ + export interface Schema$GoogleCloudDialogflowV2beta1InitializeEncryptionSpecRequest { + /** + * 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. + */ + encryptionSpec?: Schema$GoogleCloudDialogflowV2beta1EncryptionSpec; + } /** * 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). */ @@ -7449,6 +7496,10 @@ export namespace dialogflow_v3 { * Output only. The role of the participant. */ participantRole?: string | null; + /** + * Optional. Automated agent responses. + */ + responseMessages?: Schema$GoogleCloudDialogflowV2beta1ResponseMessage[]; /** * Optional. The time when the message was sent. */ @@ -7561,6 +7612,96 @@ export namespace dialogflow_v3 { */ webhookSource?: string | null; } + /** + * Response messages from an automated agent. + */ + export interface Schema$GoogleCloudDialogflowV2beta1ResponseMessage { + /** + * A signal that indicates the interaction with the Dialogflow agent has ended. + */ + endInteraction?: Schema$GoogleCloudDialogflowV2beta1ResponseMessageEndInteraction; + /** + * Hands off conversation to a live agent. + */ + liveAgentHandoff?: Schema$GoogleCloudDialogflowV2beta1ResponseMessageLiveAgentHandoff; + /** + * An audio response message composed of both the synthesized Dialogflow agent responses and the audios hosted in places known to the client. + */ + mixedAudio?: Schema$GoogleCloudDialogflowV2beta1ResponseMessageMixedAudio; + /** + * Returns a response containing a custom, platform-specific payload. + */ + payload?: {[key: string]: any} | null; + /** + * A signal that the client should transfer the phone call connected to this agent to a third-party endpoint. + */ + telephonyTransferCall?: Schema$GoogleCloudDialogflowV2beta1ResponseMessageTelephonyTransferCall; + /** + * Returns a text response. + */ + text?: Schema$GoogleCloudDialogflowV2beta1ResponseMessageText; + } + /** + * Indicates that interaction with the Dialogflow agent has ended. + */ + export interface Schema$GoogleCloudDialogflowV2beta1ResponseMessageEndInteraction {} + /** + * 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. + */ + export interface Schema$GoogleCloudDialogflowV2beta1ResponseMessageLiveAgentHandoff { + /** + * Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. + */ + metadata?: {[key: string]: any} | null; + } + /** + * Represents an audio message that is composed of both segments synthesized from the Dialogflow agent prompts and ones hosted externally at the specified URIs. + */ + export interface Schema$GoogleCloudDialogflowV2beta1ResponseMessageMixedAudio { + /** + * Segments this audio response is composed of. + */ + segments?: Schema$GoogleCloudDialogflowV2beta1ResponseMessageMixedAudioSegment[]; + } + /** + * Represents one segment of audio. + */ + export interface Schema$GoogleCloudDialogflowV2beta1ResponseMessageMixedAudioSegment { + /** + * 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. + */ + allowPlaybackInterruption?: boolean | null; + /** + * Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. + */ + audio?: string | null; + /** + * Client-specific URI that points to an audio clip accessible to the client. + */ + uri?: string | null; + } + /** + * Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. + */ + export interface Schema$GoogleCloudDialogflowV2beta1ResponseMessageTelephonyTransferCall { + /** + * Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164). + */ + phoneNumber?: string | null; + /** + * Transfer the call to a SIP endpoint. + */ + sipUri?: string | null; + } + /** + * The text response message. + */ + export interface Schema$GoogleCloudDialogflowV2beta1ResponseMessageText { + /** + * A collection of text responses. + */ + text?: string[] | null; + } /** * 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. */ @@ -7995,6 +8136,19 @@ export namespace dialogflow_v3 { */ createTime?: string | null; } + /** + * A customer-managed encryption key specification that can be applied to all created resources (e.g. Conversation). + */ + export interface Schema$GoogleCloudDialogflowV2EncryptionSpec { + /** + * 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\}` + */ + kmsKey?: string | null; + /** + * Immutable. The resource name of the encryption key specification resource. Format: projects/{project\}/locations/{location\}/encryptionSpec + */ + name?: string | null; + } /** * 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). */ @@ -8170,6 +8324,24 @@ export namespace dialogflow_v3 { */ warnings?: Schema$GoogleRpcStatus[]; } + /** + * Metadata for initializing a location-level encryption specification. + */ + export interface Schema$GoogleCloudDialogflowV2InitializeEncryptionSpecMetadata { + /** + * Output only. The original request for initialization. + */ + request?: Schema$GoogleCloudDialogflowV2InitializeEncryptionSpecRequest; + } + /** + * The request to initialize a location-level encryption specification. + */ + export interface Schema$GoogleCloudDialogflowV2InitializeEncryptionSpecRequest { + /** + * 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. + */ + encryptionSpec?: Schema$GoogleCloudDialogflowV2EncryptionSpec; + } /** * InputDataset used to create model or do evaluation. NextID:5 */ diff --git a/src/apis/dialogflow/v3beta1.ts b/src/apis/dialogflow/v3beta1.ts index 95df81fe7a..80cc13034c 100644 --- a/src/apis/dialogflow/v3beta1.ts +++ b/src/apis/dialogflow/v3beta1.ts @@ -1115,6 +1115,10 @@ export namespace dialogflow_v3beta1 { * Diagnostic info related to the answer generation model call. */ export interface Schema$GoogleCloudDialogflowCxV3beta1DataStoreConnectionSignalsAnswerGenerationModelCallSignals { + /** + * Name of the generative model. For example, "gemini-ultra", "gemini-pro", "gemini-1.5-flash" etc. Defaults to "Other" if the model is unknown. + */ + model?: string | null; /** * Output of the generative model. */ @@ -1167,6 +1171,10 @@ export namespace dialogflow_v3beta1 { * Diagnostic info related to the rewriter model call. */ export interface Schema$GoogleCloudDialogflowCxV3beta1DataStoreConnectionSignalsRewriterModelCallSignals { + /** + * Name of the generative model. For example, "gemini-ultra", "gemini-pro", "gemini-1.5-flash" etc. Defaults to "Other" if the model is unknown. + */ + model?: string | null; /** * Output of the generative model. */ @@ -1502,6 +1510,10 @@ export namespace dialogflow_v3beta1 { * The target page to transition to. Format: `projects//locations//agents//flows//pages/`. */ targetPage?: string | null; + /** + * The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. + */ + targetPlaybook?: string | null; /** * 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. */ @@ -4324,11 +4336,11 @@ export namespace dialogflow_v3beta1 { */ export interface Schema$GoogleCloudDialogflowCxV3beta1TestConfig { /** - * 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 both are set, `page` takes precedence over `flow`. If neither is set, the test case will start with start page on the default start flow. + * 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. */ flow?: string | null; /** - * 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 both are set, `page` takes precedence over `flow`. If neither is set, the test case will start with start page on the default start flow. + * 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. */ page?: string | null; /** @@ -5508,6 +5520,10 @@ export namespace dialogflow_v3beta1 { * The target page to transition to. Format: `projects//locations//agents//flows//pages/`. */ targetPage?: string | null; + /** + * The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. + */ + targetPlaybook?: string | null; /** * 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. */ @@ -6474,11 +6490,11 @@ export namespace dialogflow_v3beta1 { */ export interface Schema$GoogleCloudDialogflowCxV3TestConfig { /** - * 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 both are set, `page` takes precedence over `flow`. If neither is set, the test case will start with start page on the default start flow. + * 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. */ flow?: string | null; /** - * 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 both are set, `page` takes precedence over `flow`. If neither is set, the test case will start with start page on the default start flow. + * 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. */ page?: string | null; /** @@ -7100,6 +7116,19 @@ export namespace dialogflow_v3beta1 { */ queryResult?: Schema$GoogleCloudDialogflowV2beta1QueryResult; } + /** + * A customer-managed encryption key specification that can be applied to all created resources (e.g. Conversation). + */ + export interface Schema$GoogleCloudDialogflowV2beta1EncryptionSpec { + /** + * 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\}` + */ + kmsKey?: string | null; + /** + * Immutable. The resource name of the encryption key specification resource. Format: projects/{project\}/locations/{location\}/encryptionSpec + */ + name?: string | null; + } /** * 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). */ @@ -7245,6 +7274,24 @@ export namespace dialogflow_v3beta1 { */ warnings?: Schema$GoogleRpcStatus[]; } + /** + * Metadata for initializing a location-level encryption specification. + */ + export interface Schema$GoogleCloudDialogflowV2beta1InitializeEncryptionSpecMetadata { + /** + * Output only. The original request for initialization. + */ + request?: Schema$GoogleCloudDialogflowV2beta1InitializeEncryptionSpecRequest; + } + /** + * The request to initialize a location-level encryption specification. + */ + export interface Schema$GoogleCloudDialogflowV2beta1InitializeEncryptionSpecRequest { + /** + * 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. + */ + encryptionSpec?: Schema$GoogleCloudDialogflowV2beta1EncryptionSpec; + } /** * 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). */ @@ -8285,6 +8332,10 @@ export namespace dialogflow_v3beta1 { * Output only. The role of the participant. */ participantRole?: string | null; + /** + * Optional. Automated agent responses. + */ + responseMessages?: Schema$GoogleCloudDialogflowV2beta1ResponseMessage[]; /** * Optional. The time when the message was sent. */ @@ -8397,6 +8448,96 @@ export namespace dialogflow_v3beta1 { */ webhookSource?: string | null; } + /** + * Response messages from an automated agent. + */ + export interface Schema$GoogleCloudDialogflowV2beta1ResponseMessage { + /** + * A signal that indicates the interaction with the Dialogflow agent has ended. + */ + endInteraction?: Schema$GoogleCloudDialogflowV2beta1ResponseMessageEndInteraction; + /** + * Hands off conversation to a live agent. + */ + liveAgentHandoff?: Schema$GoogleCloudDialogflowV2beta1ResponseMessageLiveAgentHandoff; + /** + * An audio response message composed of both the synthesized Dialogflow agent responses and the audios hosted in places known to the client. + */ + mixedAudio?: Schema$GoogleCloudDialogflowV2beta1ResponseMessageMixedAudio; + /** + * Returns a response containing a custom, platform-specific payload. + */ + payload?: {[key: string]: any} | null; + /** + * A signal that the client should transfer the phone call connected to this agent to a third-party endpoint. + */ + telephonyTransferCall?: Schema$GoogleCloudDialogflowV2beta1ResponseMessageTelephonyTransferCall; + /** + * Returns a text response. + */ + text?: Schema$GoogleCloudDialogflowV2beta1ResponseMessageText; + } + /** + * Indicates that interaction with the Dialogflow agent has ended. + */ + export interface Schema$GoogleCloudDialogflowV2beta1ResponseMessageEndInteraction {} + /** + * 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. + */ + export interface Schema$GoogleCloudDialogflowV2beta1ResponseMessageLiveAgentHandoff { + /** + * Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. + */ + metadata?: {[key: string]: any} | null; + } + /** + * Represents an audio message that is composed of both segments synthesized from the Dialogflow agent prompts and ones hosted externally at the specified URIs. + */ + export interface Schema$GoogleCloudDialogflowV2beta1ResponseMessageMixedAudio { + /** + * Segments this audio response is composed of. + */ + segments?: Schema$GoogleCloudDialogflowV2beta1ResponseMessageMixedAudioSegment[]; + } + /** + * Represents one segment of audio. + */ + export interface Schema$GoogleCloudDialogflowV2beta1ResponseMessageMixedAudioSegment { + /** + * 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. + */ + allowPlaybackInterruption?: boolean | null; + /** + * Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. + */ + audio?: string | null; + /** + * Client-specific URI that points to an audio clip accessible to the client. + */ + uri?: string | null; + } + /** + * Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. + */ + export interface Schema$GoogleCloudDialogflowV2beta1ResponseMessageTelephonyTransferCall { + /** + * Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164). + */ + phoneNumber?: string | null; + /** + * Transfer the call to a SIP endpoint. + */ + sipUri?: string | null; + } + /** + * The text response message. + */ + export interface Schema$GoogleCloudDialogflowV2beta1ResponseMessageText { + /** + * A collection of text responses. + */ + text?: string[] | null; + } /** * 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. */ @@ -8831,6 +8972,19 @@ export namespace dialogflow_v3beta1 { */ createTime?: string | null; } + /** + * A customer-managed encryption key specification that can be applied to all created resources (e.g. Conversation). + */ + export interface Schema$GoogleCloudDialogflowV2EncryptionSpec { + /** + * 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\}` + */ + kmsKey?: string | null; + /** + * Immutable. The resource name of the encryption key specification resource. Format: projects/{project\}/locations/{location\}/encryptionSpec + */ + name?: string | null; + } /** * 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). */ @@ -9006,6 +9160,24 @@ export namespace dialogflow_v3beta1 { */ warnings?: Schema$GoogleRpcStatus[]; } + /** + * Metadata for initializing a location-level encryption specification. + */ + export interface Schema$GoogleCloudDialogflowV2InitializeEncryptionSpecMetadata { + /** + * Output only. The original request for initialization. + */ + request?: Schema$GoogleCloudDialogflowV2InitializeEncryptionSpecRequest; + } + /** + * The request to initialize a location-level encryption specification. + */ + export interface Schema$GoogleCloudDialogflowV2InitializeEncryptionSpecRequest { + /** + * 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. + */ + encryptionSpec?: Schema$GoogleCloudDialogflowV2EncryptionSpec; + } /** * InputDataset used to create model or do evaluation. NextID:5 */ diff --git a/src/apis/discoveryengine/v1.ts b/src/apis/discoveryengine/v1.ts index c9192db6cb..1b7083ae31 100644 --- a/src/apis/discoveryengine/v1.ts +++ b/src/apis/discoveryengine/v1.ts @@ -531,6 +531,10 @@ export namespace discoveryengine_v1 { * If citation_type is DOCUMENT_LEVEL_CITATION, populate document level snippets. */ snippetInfo?: Schema$GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultSnippetInfo[]; + /** + * 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 . + */ + structData?: {[key: string]: any} | null; /** * Title. */ @@ -759,6 +763,10 @@ export namespace discoveryengine_v1 { */ updateTime?: string | null; } + /** + * Metadata for EvaluationService.CreateEvaluation method. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaCreateEvaluationMetadata {} /** * Metadata for Create Schema LRO. */ @@ -785,6 +793,15 @@ export namespace discoveryengine_v1 { */ updateTime?: string | null; } + /** + * Defines custom fine tuning spec. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec { + /** + * Whether or not to enable and include custom fine tuned search adaptor model. + */ + enableSearchAdaptor?: boolean | null; + } /** * Metadata that describes a custom tuned model. */ @@ -797,6 +814,10 @@ export namespace discoveryengine_v1 { * The display name of the model. */ displayName?: string | null; + /** + * The metrics of the trained model. + */ + metrics?: {[key: string]: number} | null; /** * The state that the model is in (e.g.`TRAINING` or `TRAINING_FAILED`). */ @@ -953,7 +974,7 @@ export namespace discoveryengine_v1 { */ name?: string | null; /** - * 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 or layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and or layout parsing are supported. + * 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. */ parsingConfigOverrides?: { [ @@ -1245,6 +1266,91 @@ export namespace discoveryengine_v1 { */ documentCount?: string | null; } + /** + * An evaluation is a single execution (or run) of an evaluation process. It encapsulates the state of the evaluation and the resulting data. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaEvaluation { + /** + * Output only. Timestamp the Evaluation was created at. + */ + createTime?: string | null; + /** + * Output only. Timestamp the Evaluation was completed at. + */ + endTime?: string | null; + /** + * Output only. The error that occurred during evaluation. Only populated when the evaluation's state is FAILED. + */ + error?: Schema$GoogleRpcStatus; + /** + * Output only. A sample of errors encountered while processing the request. + */ + errorSamples?: Schema$GoogleRpcStatus[]; + /** + * Required. The specification of the evaluation. + */ + evaluationSpec?: Schema$GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpec; + /** + * Immutable. 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. + */ + name?: string | null; + /** + * Output only. The metrics produced by the evaluation, averaged across all SampleQuerys in the SampleQuerySet. Only populated when the evaluation's state is SUCCEEDED. + */ + qualityMetrics?: Schema$GoogleCloudDiscoveryengineV1alphaQualityMetrics; + /** + * Output only. The state of the evaluation. + */ + state?: string | null; + } + /** + * Describes the specification of the evaluation. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpec { + /** + * Required. The specification of the query set. + */ + querySetSpec?: Schema$GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpecQuerySetSpec; + /** + * 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 + */ + searchRequest?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequest; + } + /** + * Describes the specification of the query set. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpecQuerySetSpec { + /** + * Required. The full resource name of the SampleQuerySet used for the evaluation, in the format of `projects/{project\}/locations/{location\}/sampleQuerySets/{sampleQuerySet\}`. + */ + sampleQuerySet?: string | null; + } + /** + * Metadata related to the progress of the Export operation. This is returned by the google.longrunning.Operation.metadata field. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaExportUserEventsMetadata { + /** + * Operation create time. + */ + createTime?: string | null; + /** + * Operation last update time. If the operation is done, this is also the finish time. + */ + updateTime?: string | null; + } + /** + * Response of the ExportUserEventsRequest. If the long running operation was successful, then this message is returned by the google.longrunning.Operations.response field. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaExportUserEventsResponse { + /** + * Output result indicating where the data were exported to. + */ + outputResult?: Schema$GoogleCloudDiscoveryengineV1alphaOutputResult; + /** + * The status of the export operation. + */ + status?: Schema$GoogleRpcStatus; + } /** * Configurations for fields of a schema. For example, configuring a field is indexable, or searchable. */ @@ -1294,6 +1400,15 @@ export namespace discoveryengine_v1 { */ searchableOption?: string | null; } + /** + * Response message for SiteSearchEngineService.GetUriPatternDocumentData method. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaGetUriPatternDocumentDataResponse { + /** + * Document data keyed by URI pattern. For example: document_data_map = { "www.url1.com/x": { "Categories": ["category1", "category2"] \}, "www.url2.com/x": { "Categories": ["category3"] \} \} + */ + documentDataMap?: {[key: string]: {[key: string]: any}} | null; + } /** * Identity Provider Config. */ @@ -1397,6 +1512,44 @@ export namespace discoveryengine_v1 { */ gcsPrefix?: string | null; } + /** + * Metadata related to the progress of the ImportSampleQueries operation. This will be returned by the google.longrunning.Operation.metadata field. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaImportSampleQueriesMetadata { + /** + * ImportSampleQueries operation create time. + */ + createTime?: string | null; + /** + * Count of SampleQuerys that failed to be imported. + */ + failureCount?: string | null; + /** + * Count of SampleQuerys successfully imported. + */ + successCount?: string | null; + /** + * Total count of SampleQuerys that were processed. + */ + totalCount?: string | null; + /** + * ImportSampleQueries operation last update time. If the operation is done, this is also the finish time. + */ + updateTime?: string | null; + } + /** + * 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. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaImportSampleQueriesResponse { + /** + * The desired location of errors incurred during the Import. + */ + errorConfig?: Schema$GoogleCloudDiscoveryengineV1alphaImportErrorConfig; + /** + * A sample of errors encountered while processing the request. + */ + errorSamples?: Schema$GoogleRpcStatus[]; + } /** * Metadata related to the progress of the ImportSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field. */ @@ -1469,6 +1622,27 @@ export namespace discoveryengine_v1 { */ unjoinedEventsCount?: string | null; } + /** + * A floating point interval. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaInterval { + /** + * Exclusive upper bound. + */ + exclusiveMaximum?: number | null; + /** + * Exclusive lower bound. + */ + exclusiveMinimum?: number | null; + /** + * Inclusive upper bound. + */ + maximum?: number | null; + /** + * Inclusive lower bound. + */ + minimum?: number | null; + } /** * Language info for DataStore. */ @@ -1499,6 +1673,28 @@ export namespace discoveryengine_v1 { */ models?: Schema$GoogleCloudDiscoveryengineV1alphaCustomTuningModel[]; } + /** + * Output result that stores the information about where the exported data is stored. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaOutputResult { + /** + * The BigQuery location where the result is stored. + */ + bigqueryResult?: Schema$GoogleCloudDiscoveryengineV1alphaOutputResultBigQueryOutputResult; + } + /** + * A BigQuery output result. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaOutputResultBigQueryOutputResult { + /** + * The ID of a BigQuery Dataset. + */ + datasetId?: string | null; + /** + * The ID of a BigQuery Table. + */ + tableId?: string | null; + } /** * Metadata and configurations for a Google Cloud project in the service. */ @@ -1673,6 +1869,52 @@ export namespace discoveryengine_v1 { */ purgeCount?: string | null; } + /** + * Describes the metrics produced by the evaluation. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaQualityMetrics { + /** + * 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 + */ + docNdcg?: Schema$GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics; + /** + * 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 + */ + docPrecision?: Schema$GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics; + /** + * 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 + */ + docRecall?: Schema$GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics; + /** + * 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 + */ + pageNdcg?: Schema$GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics; + /** + * 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 + */ + pageRecall?: Schema$GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics; + } + /** + * Stores the metric values at specific top-k levels. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics { + /** + * The top-1 value. + */ + top1?: number | null; + /** + * The top-10 value. + */ + top10?: number | null; + /** + * The top-3 value. + */ + top3?: number | null; + /** + * The top-5 value. + */ + top5?: number | null; + } /** * Defines a user inputed query. */ @@ -1780,998 +2022,2108 @@ export namespace discoveryengine_v1 { structSchema?: {[key: string]: any} | null; } /** - * External session proto definition. + * Request message for SearchService.Search method. */ - export interface Schema$GoogleCloudDiscoveryengineV1alphaSession { + export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchRequest { /** - * Output only. The time the session finished. + * 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) */ - endTime?: string | null; + boostSpec?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpec; /** - * Immutable. Fully qualified name `projects/{project\}/locations/global/collections/{collection\}/engines/{engine\}/sessions/x` + * The branch resource name, such as `projects/x/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. */ - name?: string | null; + branch?: string | null; /** - * Output only. The time the session started. + * 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. */ - startTime?: string | null; + canonicalFilter?: string | null; /** - * The state of the session. + * A specification for configuring the behavior of content search. */ - state?: string | null; + contentSearchSpec?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpec; /** - * Turns. + * Custom fine tuning configs. If set, it has higher priority than the configs set in ServingConfig.custom_fine_tuning_spec. */ - turns?: Schema$GoogleCloudDiscoveryengineV1alphaSessionTurn[]; + customFineTuningSpec?: Schema$GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec; /** - * A unique identifier for tracking users. + * 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. */ - userPseudoId?: string | null; - } - /** - * Represents a turn, including a query from the user and a answer from service. - */ - export interface Schema$GoogleCloudDiscoveryengineV1alphaSessionTurn { + dataStoreSpecs?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec[]; /** - * The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn. + * 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. */ - answer?: string | null; + embeddingSpec?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpec; /** - * The user query. + * 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. */ - query?: Schema$GoogleCloudDiscoveryengineV1alphaQuery; - } - /** - * Verification information for target sites in advanced site search. - */ - export interface Schema$GoogleCloudDiscoveryengineV1alphaSiteVerificationInfo { + facetSpecs?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpec[]; /** - * Site verification state indicating the ownership and validity. + * 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) */ - siteVerificationState?: string | null; + filter?: string | null; /** - * Latest site verification time. + * Raw image query. */ - verifyTime?: string | null; - } - /** - * A target site for the SiteSearchEngine. - */ - export interface Schema$GoogleCloudDiscoveryengineV1alphaTargetSite { + imageQuery?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestImageQuery; /** - * 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. + * 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. */ - exactMatch?: boolean | null; + languageCode?: string | null; /** - * Output only. Failure reason. + * If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done. */ - failureReason?: Schema$GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReason; + naturalLanguageQueryUnderstandingSpec?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestNaturalLanguageQueryUnderstandingSpec; /** - * Output only. This is system-generated based on the provided_uri_pattern. + * 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. */ - generatedUriPattern?: string | null; + offset?: number | null; /** - * Output only. Indexing status. + * 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 for retail search, see [Ordering](https://cloud.google.com/retail/docs/filter-and-order#order) If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. */ - indexingStatus?: string | null; + orderBy?: string | null; /** - * 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. + * 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. */ - name?: string | null; + pageSize?: number | null; /** - * Required. Input only. The user provided URI pattern from which the `generated_uri_pattern` is generated. + * 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. */ - providedUriPattern?: string | null; + pageToken?: string | null; /** - * Output only. Root domain of the provided_uri_pattern. + * 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` */ - rootDomainUri?: string | null; + params?: {[key: string]: any} | null; /** - * Output only. Site ownership and validity verification status. + * Raw search query. */ - siteVerificationInfo?: Schema$GoogleCloudDiscoveryengineV1alphaSiteVerificationInfo; + query?: string | null; /** - * The type of the target site, e.g., whether the site is to be included or excluded. + * The query expansion specification that specifies the conditions under which query expansion occurs. */ - type?: string | null; + queryExpansionSpec?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestQueryExpansionSpec; /** - * Output only. The target site's last updated time. + * 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)`. */ - updateTime?: string | null; - } - /** - * Site search indexing failure reasons. - */ - export interface Schema$GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReason { + rankingExpression?: string | null; /** - * Failed due to insufficient quota. + * 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. */ - quotaFailure?: Schema$GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReasonQuotaFailure; - } - /** - * Failed due to insufficient quota. - */ - export interface Schema$GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReasonQuotaFailure { + regionCode?: string | null; /** - * This number is an estimation on how much total quota this project needs to successfully complete indexing. + * 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. */ - totalRequiredQuota?: string | null; - } - /** - * Metadata related to the progress of the TrainCustomModel operation. This is returned by the google.longrunning.Operation.metadata field. - */ - export interface Schema$GoogleCloudDiscoveryengineV1alphaTrainCustomModelMetadata { + relevanceThreshold?: string | null; /** - * Operation create time. + * Whether to turn on safe search. This is only supported for website search. */ - createTime?: string | null; + safeSearch?: boolean | null; /** - * Operation last update time. If the operation is done, this is also the finish time. + * Search as you type configuration. Only supported for the IndustryVertical.MEDIA vertical. */ - updateTime?: string | null; - } - /** - * Response of the TrainCustomModelRequest. This message is returned by the google.longrunning.Operations.response field. - */ - export interface Schema$GoogleCloudDiscoveryengineV1alphaTrainCustomModelResponse { + searchAsYouTypeSpec?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAsYouTypeSpec; /** - * Echoes the destination for the complete errors in the request if set. + * Required. The resource name of the Search serving config, such as `projects/x/locations/global/collections/default_collection/engines/x/servingConfigs/default_serving_config`, or `projects/x/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. */ - errorConfig?: Schema$GoogleCloudDiscoveryengineV1alphaImportErrorConfig; + servingConfig?: string | null; /** - * A sample of errors encountered while processing the data. + * 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. */ - errorSamples?: Schema$GoogleRpcStatus[]; + session?: string | null; /** - * The metrics of the trained model. + * Session specification. Can be used only when `session` is set. */ - metrics?: {[key: string]: number} | null; + sessionSpec?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestSessionSpec; /** - * Fully qualified name of the CustomTuningModel. + * The spell correction specification that specifies the mode under which spell correction takes effect. */ - modelName?: string | null; + spellCorrectionSpec?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestSpellCorrectionSpec; /** - * 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. + * Information about the end user. Highly recommended for analytics. UserInfo.user_agent is used to deduce `device_type` for analytics. */ - modelStatus?: string | null; - } - /** - * Metadata associated with a tune operation. - */ - export interface Schema$GoogleCloudDiscoveryengineV1alphaTuneEngineMetadata { + userInfo?: Schema$GoogleCloudDiscoveryengineV1alphaUserInfo; /** - * Required. The resource name of the engine that this tune applies to. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/engines/{engine_id\}` + * 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. */ - engine?: string | null; + userLabels?: {[key: string]: string} | null; + /** + * 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. + */ + userPseudoId?: string | null; } /** - * Response associated with a tune operation. - */ - export interface Schema$GoogleCloudDiscoveryengineV1alphaTuneEngineResponse {} - /** - * Metadata for UpdateSchema LRO. + * Boost specification to boost certain documents. */ - export interface Schema$GoogleCloudDiscoveryengineV1alphaUpdateSchemaMetadata { - /** - * Operation create time. - */ - createTime?: string | null; + export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpec { /** - * Operation last update time. If the operation is done, this is also the finish time. + * 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. */ - updateTime?: string | null; + conditionBoostSpecs?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpec[]; } /** - * Metadata related to the progress of the SiteSearchEngineService.UpdateTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field. + * Boost applies to documents which match a condition. */ - export interface Schema$GoogleCloudDiscoveryengineV1alphaUpdateTargetSiteMetadata { + export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpec { /** - * Operation create time. + * 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. */ - createTime?: string | null; + boost?: number | null; /** - * Operation last update time. If the operation is done, this is also the finish time. + * Complex specification for custom ranking based on customer defined attribute value. */ - updateTime?: string | null; + boostControlSpec?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpecBoostControlSpec; + /** + * 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"))` + */ + condition?: string | null; } /** - * Defines an answer. + * Specification for custom ranking based on customer specified attribute value. It provides more controls for customized ranking than the simple (condition, boost) combination above. */ - export interface Schema$GoogleCloudDiscoveryengineV1Answer { + export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpecBoostControlSpec { /** - * Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set. + * 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). */ - answerSkippedReasons?: string[] | null; + attributeType?: string | null; /** - * The textual answer. + * The control points used to define the curve. The monotonic function (defined through the interpolation_type above) passes through the control points listed here. */ - answerText?: string | null; + controlPoints?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpecBoostControlSpecControlPoint[]; /** - * Citations. + * The name of the field whose value will be used to determine the boost amount. */ - citations?: Schema$GoogleCloudDiscoveryengineV1AnswerCitation[]; + fieldName?: string | null; /** - * Output only. Answer completed timestamp. + * The interpolation type to be applied to connect the control points listed below. */ - completeTime?: string | null; + interpolationType?: string | null; + } + /** + * 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). + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpecBoostControlSpecControlPoint { /** - * Output only. Answer creation timestamp. + * 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]`. */ - createTime?: string | null; + attributeValue?: string | null; /** - * Immutable. Fully qualified name `projects/{project\}/locations/global/collections/{collection\}/engines/{engine\}/sessions/x/answers/x` + * The value between -1 to 1 by which to boost the score if the attribute_value evaluates to the value specified above. */ - name?: string | null; + boostAmount?: number | null; + } + /** + * A specification for configuring the behavior of content search. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpec { /** - * Query understanding information. + * Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS */ - queryUnderstandingInfo?: Schema$GoogleCloudDiscoveryengineV1AnswerQueryUnderstandingInfo; + chunkSpec?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecChunkSpec; /** - * References. + * If there is no extractive_content_spec provided, there will be no extractive answer in the search response. */ - references?: Schema$GoogleCloudDiscoveryengineV1AnswerReference[]; + extractiveContentSpec?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecExtractiveContentSpec; /** - * Suggested related questions. + * Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`. */ - relatedQuestions?: string[] | null; + searchResultMode?: string | null; /** - * The state of the answer generation. + * If `snippetSpec` is not specified, snippets are not included in the search response. */ - state?: string | null; + snippetSpec?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSnippetSpec; /** - * Answer generation steps. + * If `summarySpec` is not specified, summaries are not included in the search response. */ - steps?: Schema$GoogleCloudDiscoveryengineV1AnswerStep[]; + summarySpec?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpec; } /** - * Citation info for a segment. + * Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS */ - export interface Schema$GoogleCloudDiscoveryengineV1AnswerCitation { - /** - * End of the attributed segment, exclusive. - */ - endIndex?: string | null; - /** - * Citation sources for the attributed segment. - */ - sources?: Schema$GoogleCloudDiscoveryengineV1AnswerCitationSource[]; + export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecChunkSpec { /** - * Index indicates the start of the segment, measured in bytes (UTF-8 unicode). + * 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. */ - startIndex?: string | null; - } - /** - * Citation source. - */ - export interface Schema$GoogleCloudDiscoveryengineV1AnswerCitationSource { + numNextChunks?: number | null; /** - * ID of the citation source. + * 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. */ - referenceId?: string | null; + numPreviousChunks?: number | null; } /** - * Request message for ConversationalSearchService.AnswerQuery method. + * A specification for configuring the extractive content in a search response. */ - export interface Schema$GoogleCloudDiscoveryengineV1AnswerQueryRequest { - /** - * Answer generation specification. - */ - answerGenerationSpec?: Schema$GoogleCloudDiscoveryengineV1AnswerQueryRequestAnswerGenerationSpec; - /** - * 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. - */ - asynchronousMode?: boolean | null; + export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecExtractiveContentSpec { /** - * Required. Current user query. + * 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. */ - query?: Schema$GoogleCloudDiscoveryengineV1Query; + maxExtractiveAnswerCount?: number | null; /** - * Query understanding specification. + * 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`. */ - queryUnderstandingSpec?: Schema$GoogleCloudDiscoveryengineV1AnswerQueryRequestQueryUnderstandingSpec; + maxExtractiveSegmentCount?: number | null; /** - * Related questions specification. + * Return at most `num_next_segments` segments after each selected segments. */ - relatedQuestionsSpec?: Schema$GoogleCloudDiscoveryengineV1AnswerQueryRequestRelatedQuestionsSpec; + numNextSegments?: number | null; /** - * Model specification. + * Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments. */ - safetySpec?: Schema$GoogleCloudDiscoveryengineV1AnswerQueryRequestSafetySpec; + numPreviousSegments?: number | null; /** - * Search specification. + * 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`. */ - searchSpec?: Schema$GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpec; + returnExtractiveSegmentScore?: boolean | null; + } + /** + * A specification for configuring snippets in a search response. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSnippetSpec { /** - * 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. + * [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. */ - session?: string | null; + maxSnippetCount?: number | null; /** - * 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. + * [DEPRECATED] This field is deprecated and will have no affect on the snippet. */ - userLabels?: {[key: string]: string} | null; + referenceOnly?: boolean | null; /** - * 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. + * 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. */ - userPseudoId?: string | null; + returnSnippet?: boolean | null; } /** - * Answer generation specification. + * A specification for configuring a summary returned in a search response. */ - export interface Schema$GoogleCloudDiscoveryengineV1AnswerQueryRequestAnswerGenerationSpec { + export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpec { /** - * 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. + * 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. */ - answerLanguageCode?: string | null; + ignoreAdversarialQuery?: boolean | null; /** - * 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. + * 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. */ - ignoreAdversarialQuery?: boolean | null; + ignoreNonSummarySeekingQuery?: boolean | null; /** - * 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. + * 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. */ - ignoreLowRelevantContent?: boolean | null; + includeCitations?: boolean | null; /** - * 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. + * 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. */ - ignoreNonAnswerSeekingQuery?: boolean | null; + languageCode?: string | null; /** - * Specifies whether to include citation metadata in the answer. The default value is `false`. + * If specified, the spec will be used to modify the prompt provided to the LLM. */ - includeCitations?: boolean | null; + modelPromptSpec?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelPromptSpec; /** - * Answer generation model specification. + * If specified, the spec will be used to modify the model specification provided to the LLM. */ - modelSpec?: Schema$GoogleCloudDiscoveryengineV1AnswerQueryRequestAnswerGenerationSpecModelSpec; + modelSpec?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelSpec; /** - * Answer generation prompt specification. + * 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. */ - promptSpec?: Schema$GoogleCloudDiscoveryengineV1AnswerQueryRequestAnswerGenerationSpecPromptSpec; - } - /** - * Answer Generation Model specification. - */ - export interface Schema$GoogleCloudDiscoveryengineV1AnswerQueryRequestAnswerGenerationSpecModelSpec { + summaryResultCount?: number | null; /** - * Model version. If not set, it will use the default stable model. Allowed values are: stable, preview. + * 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. */ - modelVersion?: string | null; + useSemanticChunks?: boolean | null; } /** - * Answer generation prompt specification. + * Specification of the prompt to use with the model. */ - export interface Schema$GoogleCloudDiscoveryengineV1AnswerQueryRequestAnswerGenerationSpecPromptSpec { + export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelPromptSpec { /** - * Customized preamble. + * Text at the beginning of the prompt that instructs the assistant. Examples are available in the user guide. */ preamble?: string | null; } /** - * Query understanding specification. + * Specification of the model. */ - export interface Schema$GoogleCloudDiscoveryengineV1AnswerQueryRequestQueryUnderstandingSpec { - /** - * Query classification specification. - */ - queryClassificationSpec?: Schema$GoogleCloudDiscoveryengineV1AnswerQueryRequestQueryUnderstandingSpecQueryClassificationSpec; + export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelSpec { /** - * Query rephraser specification. + * 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). */ - queryRephraserSpec?: Schema$GoogleCloudDiscoveryengineV1AnswerQueryRequestQueryUnderstandingSpecQueryRephraserSpec; + version?: string | null; } /** - * Query classification specification. + * 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. */ - export interface Schema$GoogleCloudDiscoveryengineV1AnswerQueryRequestQueryUnderstandingSpecQueryClassificationSpec { + export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec { /** - * Enabled query classification types. + * Required. Full resource name of DataStore, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}`. */ - types?: string[] | null; + dataStore?: string | null; } /** - * Query rephraser specification. + * The specification that uses customized query embedding vector to do semantic document retrieval. */ - export interface Schema$GoogleCloudDiscoveryengineV1AnswerQueryRequestQueryUnderstandingSpecQueryRephraserSpec { + export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpec { /** - * Disable query rephraser. + * The embedding vector used for retrieval. Limit to 1. */ - disable?: boolean | null; + embeddingVectors?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpecEmbeddingVector[]; } /** - * Related questions specification. + * Embedding vector. */ - export interface Schema$GoogleCloudDiscoveryengineV1AnswerQueryRequestRelatedQuestionsSpec { + export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpecEmbeddingVector { /** - * Enable related questions feature if true. + * Embedding field path in schema. */ - enable?: boolean | null; + fieldPath?: string | null; + /** + * Query embedding vector. + */ + vector?: number[] | null; } /** - * Safety specification. + * A facet specification to perform faceted search. */ - export interface Schema$GoogleCloudDiscoveryengineV1AnswerQueryRequestSafetySpec { + export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpec { /** - * Enable the safety filtering on the answer response. It is false by default. + * 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. */ - enable?: boolean | null; - } - /** - * Search specification. - */ - export interface Schema$GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpec { + enableDynamicPosition?: boolean | null; /** - * Search parameters. + * 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. */ - searchParams?: Schema$GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchParams; + excludedFilterKeys?: string[] | null; /** - * Search result list. + * Required. The facet key specification. */ - searchResultList?: Schema$GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchResultList; + facetKey?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpecFacetKey; + /** + * 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. + */ + limit?: number | null; } /** - * Search parameters. + * Specifies how a facet is computed. */ - export interface Schema$GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchParams { + export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpecFacetKey { /** - * 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) + * True to make facet keys case insensitive when getting faceting values with prefixes or contains; false otherwise. */ - boostSpec?: Schema$GoogleCloudDiscoveryengineV1SearchRequestBoostSpec; + caseInsensitive?: boolean | null; /** - * 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. + * 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. */ - dataStoreSpecs?: Schema$GoogleCloudDiscoveryengineV1SearchRequestDataStoreSpec[]; + contains?: string[] | null; /** - * 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) + * 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. */ - filter?: string | null; + intervals?: Schema$GoogleCloudDiscoveryengineV1alphaInterval[]; /** - * Number of search results to return. The default value is 10. + * Required. Supported textual and numerical facet keys in Document object, over which the facet values are computed. Facet key is case-sensitive. */ - maxReturnResults?: number | null; + key?: string | null; /** - * 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. + * 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. */ orderBy?: string | null; /** - * Specifies the search result mode. If unspecified, the search result mode is based on DataStore.DocumentProcessingConfig.chunking_config: * If DataStore.DocumentProcessingConfig.chunking_config is specified, it defaults to `CHUNKS`. * Otherwise, it defaults to `DOCUMENTS`. See [parse and chunk documents](https://cloud.google.com/generative-ai-app-builder/docs/parse-chunk-documents) + * 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. */ - searchResultMode?: string | null; + prefixes?: string[] | null; + /** + * 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. + */ + restrictedValues?: string[] | null; } /** - * Search result list. + * Specifies the image query input. */ - export interface Schema$GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchResultList { + export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestImageQuery { /** - * Search results. + * Base64 encoded image bytes. Supported image formats: JPEG, PNG, and BMP. */ - searchResults?: Schema$GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchResultListSearchResult[]; + imageBytes?: string | null; } /** - * Search result. + * Specification to enable natural language understanding capabilities for search requests. */ - export interface Schema$GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchResultListSearchResult { + export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestNaturalLanguageQueryUnderstandingSpec { /** - * Chunk information. + * The condition under which filter extraction should occur. Default to Condition.DISABLED. */ - chunkInfo?: Schema$GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchResultListSearchResultChunkInfo; + filterExtractionCondition?: string | null; /** - * Unstructured document information. + * 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. */ - unstructuredDocumentInfo?: Schema$GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfo; + geoSearchQueryDetectionFieldNames?: string[] | null; } /** - * Chunk information. + * Specification to determine under which conditions query expansion should occur. */ - export interface Schema$GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchResultListSearchResultChunkInfo { + export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestQueryExpansionSpec { /** - * Chunk resource name. + * The condition under which query expansion should occur. Default to Condition.DISABLED. */ - chunk?: string | null; + condition?: string | null; /** - * Chunk textual content. + * 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. */ - content?: string | null; + pinUnexpandedResults?: boolean | null; } /** - * Unstructured document information. + * Specification for search as you type in search requests. */ - export interface Schema$GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfo { - /** - * Document resource name. - */ - document?: string | null; - /** - * List of document contexts. - */ - documentContexts?: Schema$GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoDocumentContext[]; - /** - * List of extractive answers. - */ - extractiveAnswers?: Schema$GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoExtractiveAnswer[]; - /** - * List of extractive segments. - */ - extractiveSegments?: Schema$GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoExtractiveSegment[]; - /** - * Title. - */ - title?: string | null; + export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAsYouTypeSpec { /** - * URI for the document. + * The condition under which search as you type should occur. Default to Condition.DISABLED. */ - uri?: string | null; + condition?: string | null; } /** - * Document context. + * 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. */ - export interface Schema$GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoDocumentContext { + export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestSessionSpec { /** - * Document content. + * 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. */ - content?: string | null; + queryId?: string | null; /** - * Page identifier. + * 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. */ - pageIdentifier?: string | null; + searchResultPersistenceCount?: number | null; } /** - * Extractive answer. [Guide](https://cloud.google.com/generative-ai-app-builder/docs/snippets#get-answers) + * The specification for query spell correction. */ - export interface Schema$GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoExtractiveAnswer { - /** - * Extractive answer content. - */ - content?: string | null; + export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestSpellCorrectionSpec { /** - * Page identifier. + * The mode under which spell correction replaces the original search query. Defaults to Mode.AUTO. */ - pageIdentifier?: string | null; + mode?: string | null; } /** - * Extractive segment. [Guide](https://cloud.google.com/generative-ai-app-builder/docs/snippets#extractive-segments) + * External session proto definition. */ - export interface Schema$GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoExtractiveSegment { + export interface Schema$GoogleCloudDiscoveryengineV1alphaSession { /** - * Extractive segment content. + * Output only. The time the session finished. */ - content?: string | null; + endTime?: string | null; /** - * Page identifier. + * Immutable. Fully qualified name `projects/{project\}/locations/global/collections/{collection\}/engines/{engine\}/sessions/x` */ - pageIdentifier?: string | null; - } - /** - * Response message for ConversationalSearchService.AnswerQuery method. - */ - export interface Schema$GoogleCloudDiscoveryengineV1AnswerQueryResponse { + name?: string | null; /** - * Answer resource object. If AnswerQueryRequest.StepSpec.max_step_count is greater than 1, use Answer.name to fetch answer information using ConversationalSearchService.GetAnswer API. + * Output only. The time the session started. */ - answer?: Schema$GoogleCloudDiscoveryengineV1Answer; + startTime?: string | null; /** - * A global unique ID used for logging. + * The state of the session. */ - answerQueryToken?: string | null; + state?: string | null; /** - * Session resource object. It will be only available when session field is set and valid in the AnswerQueryRequest request. + * Turns. */ - session?: Schema$GoogleCloudDiscoveryengineV1Session; - } - /** - * Query understanding information. - */ - export interface Schema$GoogleCloudDiscoveryengineV1AnswerQueryUnderstandingInfo { + turns?: Schema$GoogleCloudDiscoveryengineV1alphaSessionTurn[]; /** - * Query classification information. + * A unique identifier for tracking users. */ - queryClassificationInfo?: Schema$GoogleCloudDiscoveryengineV1AnswerQueryUnderstandingInfoQueryClassificationInfo[]; + userPseudoId?: string | null; } /** - * Query classification information. + * Represents a turn, including a query from the user and a answer from service. */ - export interface Schema$GoogleCloudDiscoveryengineV1AnswerQueryUnderstandingInfoQueryClassificationInfo { + export interface Schema$GoogleCloudDiscoveryengineV1alphaSessionTurn { /** - * Classification output. + * The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn. */ - positive?: boolean | null; + answer?: string | null; /** - * Query classification type. + * The user query. */ - type?: string | null; + query?: Schema$GoogleCloudDiscoveryengineV1alphaQuery; } /** - * Reference. + * Metadata related to the progress of the SiteSearchEngineService.SetUriPatternDocumentData operation. This will be returned by the google.longrunning.Operation.metadata field. */ - export interface Schema$GoogleCloudDiscoveryengineV1AnswerReference { + export interface Schema$GoogleCloudDiscoveryengineV1alphaSetUriPatternDocumentDataMetadata { /** - * Chunk information. + * Operation create time. */ - chunkInfo?: Schema$GoogleCloudDiscoveryengineV1AnswerReferenceChunkInfo; + createTime?: string | null; /** - * Unstructured document information. + * Operation last update time. If the operation is done, this is also the finish time. */ - unstructuredDocumentInfo?: Schema$GoogleCloudDiscoveryengineV1AnswerReferenceUnstructuredDocumentInfo; + updateTime?: string | null; } /** - * Chunk information. + * Response message for SiteSearchEngineService.SetUriPatternDocumentData method. */ - export interface Schema$GoogleCloudDiscoveryengineV1AnswerReferenceChunkInfo { - /** - * Chunk resource name. - */ - chunk?: string | null; - /** - * Chunk textual content. - */ - content?: string | null; + export interface Schema$GoogleCloudDiscoveryengineV1alphaSetUriPatternDocumentDataResponse {} + /** + * Verification information for target sites in advanced site search. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaSiteVerificationInfo { /** - * Document metadata. + * Site verification state indicating the ownership and validity. */ - documentMetadata?: Schema$GoogleCloudDiscoveryengineV1AnswerReferenceChunkInfoDocumentMetadata; + siteVerificationState?: string | null; /** - * Relevance score. + * Latest site verification time. */ - relevanceScore?: number | null; + verifyTime?: string | null; } /** - * Document metadata. + * A target site for the SiteSearchEngine. */ - export interface Schema$GoogleCloudDiscoveryengineV1AnswerReferenceChunkInfoDocumentMetadata { + export interface Schema$GoogleCloudDiscoveryengineV1alphaTargetSite { /** - * Document resource name. + * 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. */ - document?: string | null; + exactMatch?: boolean | null; /** - * Page identifier. + * Output only. Failure reason. */ - pageIdentifier?: string | null; + failureReason?: Schema$GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReason; /** - * The structured JSON metadata for the document. It is populated from the struct data from the Chunk in search result. + * Output only. This is system-generated based on the provided_uri_pattern. */ - structData?: {[key: string]: any} | null; + generatedUriPattern?: string | null; /** - * Title. + * Output only. Indexing status. */ - title?: string | null; + indexingStatus?: string | null; /** - * URI for the document. + * 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. */ - uri?: string | null; - } - /** - * Unstructured document information. - */ - export interface Schema$GoogleCloudDiscoveryengineV1AnswerReferenceUnstructuredDocumentInfo { + name?: string | null; /** - * List of cited chunk contents derived from document content. + * Required. Input only. The user provided URI pattern from which the `generated_uri_pattern` is generated. */ - chunkContents?: Schema$GoogleCloudDiscoveryengineV1AnswerReferenceUnstructuredDocumentInfoChunkContent[]; + providedUriPattern?: string | null; /** - * Document resource name. + * Output only. Root domain of the provided_uri_pattern. */ - document?: string | null; + rootDomainUri?: string | null; /** - * The structured JSON metadata for the document. It is populated from the struct data from the Chunk in search result. + * Output only. Site ownership and validity verification status. */ - structData?: {[key: string]: any} | null; + siteVerificationInfo?: Schema$GoogleCloudDiscoveryengineV1alphaSiteVerificationInfo; /** - * Title. + * The type of the target site, e.g., whether the site is to be included or excluded. */ - title?: string | null; + type?: string | null; /** - * URI for the document. + * Output only. The target site's last updated time. */ - uri?: string | null; + updateTime?: string | null; } /** - * Chunk content. + * Site search indexing failure reasons. */ - export interface Schema$GoogleCloudDiscoveryengineV1AnswerReferenceUnstructuredDocumentInfoChunkContent { - /** - * Chunk textual content. - */ - content?: string | null; + export interface Schema$GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReason { /** - * Page identifier. + * Failed due to insufficient quota. */ - pageIdentifier?: string | null; + quotaFailure?: Schema$GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReasonQuotaFailure; + } + /** + * Failed due to insufficient quota. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReasonQuotaFailure { + /** + * This number is an estimation on how much total quota this project needs to successfully complete indexing. + */ + totalRequiredQuota?: string | null; + } + /** + * Metadata related to the progress of the TrainCustomModel operation. This is returned by the google.longrunning.Operation.metadata field. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaTrainCustomModelMetadata { + /** + * Operation create time. + */ + createTime?: string | null; + /** + * Operation last update time. If the operation is done, this is also the finish time. + */ + updateTime?: string | null; + } + /** + * Response of the TrainCustomModelRequest. This message is returned by the google.longrunning.Operations.response field. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaTrainCustomModelResponse { + /** + * Echoes the destination for the complete errors in the request if set. + */ + errorConfig?: Schema$GoogleCloudDiscoveryengineV1alphaImportErrorConfig; + /** + * A sample of errors encountered while processing the data. + */ + errorSamples?: Schema$GoogleRpcStatus[]; + /** + * The metrics of the trained model. + */ + metrics?: {[key: string]: number} | null; + /** + * Fully qualified name of the CustomTuningModel. + */ + modelName?: string | null; + /** + * 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. + */ + modelStatus?: string | null; + } + /** + * Metadata associated with a tune operation. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaTuneEngineMetadata { + /** + * Required. The resource name of the engine that this tune applies to. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/engines/{engine_id\}` + */ + engine?: string | null; + } + /** + * Response associated with a tune operation. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaTuneEngineResponse {} + /** + * Metadata for UpdateSchema LRO. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaUpdateSchemaMetadata { + /** + * Operation create time. + */ + createTime?: string | null; + /** + * Operation last update time. If the operation is done, this is also the finish time. + */ + updateTime?: string | null; + } + /** + * Metadata related to the progress of the SiteSearchEngineService.UpdateTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaUpdateTargetSiteMetadata { + /** + * Operation create time. + */ + createTime?: string | null; + /** + * Operation last update time. If the operation is done, this is also the finish time. + */ + updateTime?: string | null; + } + /** + * Information of an end user. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaUserInfo { + /** + * 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. + */ + userAgent?: string | null; + /** + * 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. + */ + userId?: string | null; + } + /** + * Defines an answer. + */ + export interface Schema$GoogleCloudDiscoveryengineV1Answer { + /** + * Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set. + */ + answerSkippedReasons?: string[] | null; + /** + * The textual answer. + */ + answerText?: string | null; + /** + * Citations. + */ + citations?: Schema$GoogleCloudDiscoveryengineV1AnswerCitation[]; + /** + * Output only. Answer completed timestamp. + */ + completeTime?: string | null; + /** + * Output only. Answer creation timestamp. + */ + createTime?: string | null; + /** + * Immutable. Fully qualified name `projects/{project\}/locations/global/collections/{collection\}/engines/{engine\}/sessions/x/answers/x` + */ + name?: string | null; + /** + * Query understanding information. + */ + queryUnderstandingInfo?: Schema$GoogleCloudDiscoveryengineV1AnswerQueryUnderstandingInfo; + /** + * References. + */ + references?: Schema$GoogleCloudDiscoveryengineV1AnswerReference[]; + /** + * Suggested related questions. + */ + relatedQuestions?: string[] | null; + /** + * The state of the answer generation. + */ + state?: string | null; + /** + * Answer generation steps. + */ + steps?: Schema$GoogleCloudDiscoveryengineV1AnswerStep[]; + } + /** + * Citation info for a segment. + */ + export interface Schema$GoogleCloudDiscoveryengineV1AnswerCitation { + /** + * End of the attributed segment, exclusive. + */ + endIndex?: string | null; + /** + * Citation sources for the attributed segment. + */ + sources?: Schema$GoogleCloudDiscoveryengineV1AnswerCitationSource[]; + /** + * Index indicates the start of the segment, measured in bytes (UTF-8 unicode). + */ + startIndex?: string | null; + } + /** + * Citation source. + */ + export interface Schema$GoogleCloudDiscoveryengineV1AnswerCitationSource { + /** + * ID of the citation source. + */ + referenceId?: string | null; + } + /** + * Request message for ConversationalSearchService.AnswerQuery method. + */ + export interface Schema$GoogleCloudDiscoveryengineV1AnswerQueryRequest { + /** + * Answer generation specification. + */ + answerGenerationSpec?: Schema$GoogleCloudDiscoveryengineV1AnswerQueryRequestAnswerGenerationSpec; + /** + * 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. + */ + asynchronousMode?: boolean | null; + /** + * Required. Current user query. + */ + query?: Schema$GoogleCloudDiscoveryengineV1Query; + /** + * Query understanding specification. + */ + queryUnderstandingSpec?: Schema$GoogleCloudDiscoveryengineV1AnswerQueryRequestQueryUnderstandingSpec; + /** + * Related questions specification. + */ + relatedQuestionsSpec?: Schema$GoogleCloudDiscoveryengineV1AnswerQueryRequestRelatedQuestionsSpec; + /** + * Model specification. + */ + safetySpec?: Schema$GoogleCloudDiscoveryengineV1AnswerQueryRequestSafetySpec; + /** + * Search specification. + */ + searchSpec?: Schema$GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpec; + /** + * 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. + */ + session?: string | null; + /** + * 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. + */ + userLabels?: {[key: string]: string} | null; + /** + * 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. + */ + userPseudoId?: string | null; + } + /** + * Answer generation specification. + */ + export interface Schema$GoogleCloudDiscoveryengineV1AnswerQueryRequestAnswerGenerationSpec { + /** + * 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. + */ + answerLanguageCode?: string | null; + /** + * 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. + */ + ignoreAdversarialQuery?: boolean | null; + /** + * 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. + */ + ignoreLowRelevantContent?: boolean | null; + /** + * 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. + */ + ignoreNonAnswerSeekingQuery?: boolean | null; + /** + * Specifies whether to include citation metadata in the answer. The default value is `false`. + */ + includeCitations?: boolean | null; + /** + * Answer generation model specification. + */ + modelSpec?: Schema$GoogleCloudDiscoveryengineV1AnswerQueryRequestAnswerGenerationSpecModelSpec; + /** + * Answer generation prompt specification. + */ + promptSpec?: Schema$GoogleCloudDiscoveryengineV1AnswerQueryRequestAnswerGenerationSpecPromptSpec; + } + /** + * Answer Generation Model specification. + */ + export interface Schema$GoogleCloudDiscoveryengineV1AnswerQueryRequestAnswerGenerationSpecModelSpec { + /** + * Model version. If not set, it will use the default stable model. Allowed values are: stable, preview. + */ + modelVersion?: string | null; + } + /** + * Answer generation prompt specification. + */ + export interface Schema$GoogleCloudDiscoveryengineV1AnswerQueryRequestAnswerGenerationSpecPromptSpec { + /** + * Customized preamble. + */ + preamble?: string | null; + } + /** + * Query understanding specification. + */ + export interface Schema$GoogleCloudDiscoveryengineV1AnswerQueryRequestQueryUnderstandingSpec { + /** + * Query classification specification. + */ + queryClassificationSpec?: Schema$GoogleCloudDiscoveryengineV1AnswerQueryRequestQueryUnderstandingSpecQueryClassificationSpec; + /** + * Query rephraser specification. + */ + queryRephraserSpec?: Schema$GoogleCloudDiscoveryengineV1AnswerQueryRequestQueryUnderstandingSpecQueryRephraserSpec; + } + /** + * Query classification specification. + */ + export interface Schema$GoogleCloudDiscoveryengineV1AnswerQueryRequestQueryUnderstandingSpecQueryClassificationSpec { + /** + * Enabled query classification types. + */ + types?: string[] | null; + } + /** + * Query rephraser specification. + */ + export interface Schema$GoogleCloudDiscoveryengineV1AnswerQueryRequestQueryUnderstandingSpecQueryRephraserSpec { + /** + * Disable query rephraser. + */ + disable?: boolean | null; + /** + * Max rephrase steps. The max number is 5 steps. If not set or set to < 1, it will be set to 1 by default. + */ + maxRephraseSteps?: number | null; + } + /** + * Related questions specification. + */ + export interface Schema$GoogleCloudDiscoveryengineV1AnswerQueryRequestRelatedQuestionsSpec { + /** + * Enable related questions feature if true. + */ + enable?: boolean | null; + } + /** + * Safety specification. + */ + export interface Schema$GoogleCloudDiscoveryengineV1AnswerQueryRequestSafetySpec { + /** + * Enable the safety filtering on the answer response. It is false by default. + */ + enable?: boolean | null; + } + /** + * Search specification. + */ + export interface Schema$GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpec { + /** + * Search parameters. + */ + searchParams?: Schema$GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchParams; + /** + * Search result list. + */ + searchResultList?: Schema$GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchResultList; + } + /** + * Search parameters. + */ + export interface Schema$GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchParams { + /** + * 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) + */ + boostSpec?: Schema$GoogleCloudDiscoveryengineV1SearchRequestBoostSpec; + /** + * 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. + */ + dataStoreSpecs?: Schema$GoogleCloudDiscoveryengineV1SearchRequestDataStoreSpec[]; + /** + * 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) + */ + filter?: string | null; + /** + * Number of search results to return. The default value is 10. + */ + maxReturnResults?: number | null; + /** + * 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. + */ + orderBy?: string | null; + /** + * 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) + */ + searchResultMode?: string | null; + } + /** + * Search result list. + */ + export interface Schema$GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchResultList { + /** + * Search results. + */ + searchResults?: Schema$GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchResultListSearchResult[]; + } + /** + * Search result. + */ + export interface Schema$GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchResultListSearchResult { + /** + * Chunk information. + */ + chunkInfo?: Schema$GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchResultListSearchResultChunkInfo; + /** + * Unstructured document information. + */ + unstructuredDocumentInfo?: Schema$GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfo; + } + /** + * Chunk information. + */ + export interface Schema$GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchResultListSearchResultChunkInfo { + /** + * Chunk resource name. + */ + chunk?: string | null; + /** + * Chunk textual content. + */ + content?: string | null; + } + /** + * Unstructured document information. + */ + export interface Schema$GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfo { + /** + * Document resource name. + */ + document?: string | null; + /** + * List of document contexts. + */ + documentContexts?: Schema$GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoDocumentContext[]; + /** + * List of extractive answers. + */ + extractiveAnswers?: Schema$GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoExtractiveAnswer[]; + /** + * List of extractive segments. + */ + extractiveSegments?: Schema$GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoExtractiveSegment[]; + /** + * Title. + */ + title?: string | null; + /** + * URI for the document. + */ + uri?: string | null; + } + /** + * Document context. + */ + export interface Schema$GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoDocumentContext { + /** + * Document content. + */ + content?: string | null; + /** + * Page identifier. + */ + pageIdentifier?: string | null; + } + /** + * Extractive answer. [Guide](https://cloud.google.com/generative-ai-app-builder/docs/snippets#get-answers) + */ + export interface Schema$GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoExtractiveAnswer { + /** + * Extractive answer content. + */ + content?: string | null; + /** + * Page identifier. + */ + pageIdentifier?: string | null; + } + /** + * Extractive segment. [Guide](https://cloud.google.com/generative-ai-app-builder/docs/snippets#extractive-segments) + */ + export interface Schema$GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoExtractiveSegment { + /** + * Extractive segment content. + */ + content?: string | null; + /** + * Page identifier. + */ + pageIdentifier?: string | null; + } + /** + * Response message for ConversationalSearchService.AnswerQuery method. + */ + export interface Schema$GoogleCloudDiscoveryengineV1AnswerQueryResponse { + /** + * 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. + */ + answer?: Schema$GoogleCloudDiscoveryengineV1Answer; + /** + * A global unique ID used for logging. + */ + answerQueryToken?: string | null; + /** + * Session resource object. It will be only available when session field is set and valid in the AnswerQueryRequest request. + */ + session?: Schema$GoogleCloudDiscoveryengineV1Session; + } + /** + * Query understanding information. + */ + export interface Schema$GoogleCloudDiscoveryengineV1AnswerQueryUnderstandingInfo { + /** + * Query classification information. + */ + queryClassificationInfo?: Schema$GoogleCloudDiscoveryengineV1AnswerQueryUnderstandingInfoQueryClassificationInfo[]; + } + /** + * Query classification information. + */ + export interface Schema$GoogleCloudDiscoveryengineV1AnswerQueryUnderstandingInfoQueryClassificationInfo { + /** + * Classification output. + */ + positive?: boolean | null; + /** + * Query classification type. + */ + type?: string | null; + } + /** + * Reference. + */ + export interface Schema$GoogleCloudDiscoveryengineV1AnswerReference { + /** + * Chunk information. + */ + chunkInfo?: Schema$GoogleCloudDiscoveryengineV1AnswerReferenceChunkInfo; + /** + * Unstructured document information. + */ + unstructuredDocumentInfo?: Schema$GoogleCloudDiscoveryengineV1AnswerReferenceUnstructuredDocumentInfo; + } + /** + * Chunk information. + */ + export interface Schema$GoogleCloudDiscoveryengineV1AnswerReferenceChunkInfo { + /** + * Chunk resource name. + */ + chunk?: string | null; + /** + * Chunk textual content. + */ + content?: string | null; + /** + * Document metadata. + */ + documentMetadata?: Schema$GoogleCloudDiscoveryengineV1AnswerReferenceChunkInfoDocumentMetadata; + /** + * Relevance score. + */ + relevanceScore?: number | null; + } + /** + * Document metadata. + */ + export interface Schema$GoogleCloudDiscoveryengineV1AnswerReferenceChunkInfoDocumentMetadata { + /** + * Document resource name. + */ + document?: string | null; + /** + * Page identifier. + */ + pageIdentifier?: string | null; + /** + * The structured JSON metadata for the document. It is populated from the struct data from the Chunk in search result. + */ + structData?: {[key: string]: any} | null; + /** + * Title. + */ + title?: string | null; + /** + * URI for the document. + */ + uri?: string | null; + } + /** + * Unstructured document information. + */ + export interface Schema$GoogleCloudDiscoveryengineV1AnswerReferenceUnstructuredDocumentInfo { + /** + * List of cited chunk contents derived from document content. + */ + chunkContents?: Schema$GoogleCloudDiscoveryengineV1AnswerReferenceUnstructuredDocumentInfoChunkContent[]; + /** + * Document resource name. + */ + document?: string | null; + /** + * The structured JSON metadata for the document. It is populated from the struct data from the Chunk in search result. + */ + structData?: {[key: string]: any} | null; + /** + * Title. + */ + title?: string | null; + /** + * URI for the document. + */ + uri?: string | null; + } + /** + * Chunk content. + */ + export interface Schema$GoogleCloudDiscoveryengineV1AnswerReferenceUnstructuredDocumentInfoChunkContent { + /** + * Chunk textual content. + */ + content?: string | null; + /** + * Page identifier. + */ + pageIdentifier?: string | null; + } + /** + * Step information. + */ + export interface Schema$GoogleCloudDiscoveryengineV1AnswerStep { + /** + * Actions. + */ + actions?: Schema$GoogleCloudDiscoveryengineV1AnswerStepAction[]; + /** + * The description of the step. + */ + description?: string | null; + /** + * The state of the step. + */ + state?: string | null; + /** + * The thought of the step. + */ + thought?: string | null; + } + /** + * Action. + */ + export interface Schema$GoogleCloudDiscoveryengineV1AnswerStepAction { + /** + * Observation. + */ + observation?: Schema$GoogleCloudDiscoveryengineV1AnswerStepActionObservation; + /** + * Search action. + */ + searchAction?: Schema$GoogleCloudDiscoveryengineV1AnswerStepActionSearchAction; + } + /** + * Observation. + */ + export interface Schema$GoogleCloudDiscoveryengineV1AnswerStepActionObservation { + /** + * Search results observed by the search action, it can be snippets info or chunk info, depending on the citation type set by the user. + */ + searchResults?: Schema$GoogleCloudDiscoveryengineV1AnswerStepActionObservationSearchResult[]; + } + export interface Schema$GoogleCloudDiscoveryengineV1AnswerStepActionObservationSearchResult { + /** + * If citation_type is CHUNK_LEVEL_CITATION and chunk mode is on, populate chunk info. + */ + chunkInfo?: Schema$GoogleCloudDiscoveryengineV1AnswerStepActionObservationSearchResultChunkInfo[]; + /** + * Document resource name. + */ + document?: string | null; + /** + * If citation_type is DOCUMENT_LEVEL_CITATION, populate document level snippets. + */ + snippetInfo?: Schema$GoogleCloudDiscoveryengineV1AnswerStepActionObservationSearchResultSnippetInfo[]; + /** + * 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 . + */ + structData?: {[key: string]: any} | null; + /** + * Title. + */ + title?: string | null; + /** + * URI for the document. + */ + uri?: string | null; + } + /** + * Chunk information. + */ + export interface Schema$GoogleCloudDiscoveryengineV1AnswerStepActionObservationSearchResultChunkInfo { + /** + * Chunk resource name. + */ + chunk?: string | null; + /** + * Chunk textual content. + */ + content?: string | null; + /** + * Relevance score. + */ + relevanceScore?: number | null; + } + /** + * Snippet information. + */ + export interface Schema$GoogleCloudDiscoveryengineV1AnswerStepActionObservationSearchResultSnippetInfo { + /** + * Snippet content. + */ + snippet?: string | null; + /** + * Status of the snippet defined by the search team. + */ + snippetStatus?: string | null; + } + /** + * Search action. + */ + export interface Schema$GoogleCloudDiscoveryengineV1AnswerStepActionSearchAction { + /** + * The query to search. + */ + query?: string | null; + } + /** + * Metadata related to the progress of the SiteSearchEngineService.BatchCreateTargetSites operation. This will be returned by the google.longrunning.Operation.metadata field. + */ + export interface Schema$GoogleCloudDiscoveryengineV1BatchCreateTargetSiteMetadata { + /** + * Operation create time. + */ + createTime?: string | null; + /** + * Operation last update time. If the operation is done, this is also the finish time. + */ + updateTime?: string | null; + } + /** + * Request message for SiteSearchEngineService.BatchCreateTargetSites method. + */ + export interface Schema$GoogleCloudDiscoveryengineV1BatchCreateTargetSitesRequest { + /** + * Required. The request message specifying the resources to create. A maximum of 20 TargetSites can be created in a batch. + */ + requests?: Schema$GoogleCloudDiscoveryengineV1CreateTargetSiteRequest[]; + } + /** + * Response message for SiteSearchEngineService.BatchCreateTargetSites method. + */ + export interface Schema$GoogleCloudDiscoveryengineV1BatchCreateTargetSitesResponse { + /** + * TargetSites created. + */ + targetSites?: Schema$GoogleCloudDiscoveryengineV1TargetSite[]; + } + /** + * Request message for SiteSearchEngineService.BatchVerifyTargetSites method. + */ + export interface Schema$GoogleCloudDiscoveryengineV1BatchVerifyTargetSitesRequest {} + /** + * Metadata related to the progress of the SiteSearchEngineService.BatchCreateTargetSites operation. This will be returned by the google.longrunning.Operation.metadata field. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaBatchCreateTargetSiteMetadata { + /** + * Operation create time. + */ + createTime?: string | null; + /** + * Operation last update time. If the operation is done, this is also the finish time. + */ + updateTime?: string | null; + } + /** + * Response message for SiteSearchEngineService.BatchCreateTargetSites method. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaBatchCreateTargetSitesResponse { + /** + * TargetSites created. + */ + targetSites?: Schema$GoogleCloudDiscoveryengineV1betaTargetSite[]; + } + /** + * Defines circumstances to be checked before allowing a behavior + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaCondition { + /** + * Range of time(s) specifying when condition is active. Maximum of 10 time ranges. + */ + activeTimeRange?: Schema$GoogleCloudDiscoveryengineV1betaConditionTimeRange[]; + /** + * Search only A list of terms to match the query on. Maximum of 10 query terms. + */ + queryTerms?: Schema$GoogleCloudDiscoveryengineV1betaConditionQueryTerm[]; + } + /** + * Matcher for search request query + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaConditionQueryTerm { + /** + * Whether the search query needs to exactly match the query term. + */ + fullMatch?: boolean | null; + /** + * 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. + */ + value?: string | null; + } + /** + * Used for time-dependent conditions. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaConditionTimeRange { + /** + * End of time range. Range is inclusive. Must be in the future. + */ + endTime?: string | null; + /** + * Start of time range. Range is inclusive. + */ + startTime?: string | null; + } + /** + * 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`. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaControl { + /** + * Output only. List of all ServingConfig ids this control is attached to. May take up to 10 minutes to update after changes. + */ + associatedServingConfigIds?: string[] | null; + /** + * Defines a boost-type control + */ + boostAction?: Schema$GoogleCloudDiscoveryengineV1betaControlBoostAction; + /** + * 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. + */ + conditions?: Schema$GoogleCloudDiscoveryengineV1betaCondition[]; + /** + * 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. + */ + displayName?: string | null; + /** + * Defines a filter-type control Currently not supported by Recommendation + */ + filterAction?: Schema$GoogleCloudDiscoveryengineV1betaControlFilterAction; + /** + * Immutable. Fully qualified name `projects/x/locations/global/dataStore/x/controls/x` + */ + name?: string | null; + /** + * Defines a redirect-type control. + */ + redirectAction?: Schema$GoogleCloudDiscoveryengineV1betaControlRedirectAction; + /** + * Required. Immutable. What solution the control belongs to. Must be compatible with vertical of resource. Otherwise an INVALID ARGUMENT error is thrown. + */ + solutionType?: string | null; + /** + * Treats a group of terms as synonyms of one another. + */ + synonymsAction?: Schema$GoogleCloudDiscoveryengineV1betaControlSynonymsAction; + /** + * 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. + */ + useCases?: string[] | null; + } + /** + * Adjusts order of products in returned list. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaControlBoostAction { + /** + * Required. Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0 (No-op). + */ + boost?: number | null; + /** + * 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 + */ + dataStore?: string | null; + /** + * 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. + */ + filter?: string | null; + } + /** + * Specified which products may be included in results. Uses same filter as boost. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaControlFilterAction { + /** + * 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 + */ + dataStore?: string | null; + /** + * 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. + */ + filter?: string | null; + } + /** + * Redirects a shopper to the provided URI. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaControlRedirectAction { + /** + * 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. + */ + redirectUri?: string | null; + } + /** + * 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". + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaControlSynonymsAction { + /** + * Defines a set of synonyms. Can specify up to 100 synonyms. Must specify at least 2 synonyms. Otherwise an INVALID ARGUMENT error is thrown. + */ + synonyms?: string[] | null; + } + /** + * Metadata related to the progress of the DataStoreService.CreateDataStore operation. This will be returned by the google.longrunning.Operation.metadata field. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaCreateDataStoreMetadata { + /** + * Operation create time. + */ + createTime?: string | null; + /** + * Operation last update time. If the operation is done, this is also the finish time. + */ + updateTime?: string | null; + } + /** + * Metadata related to the progress of the EngineService.CreateEngine operation. This will be returned by the google.longrunning.Operation.metadata field. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaCreateEngineMetadata { + /** + * Operation create time. + */ + createTime?: string | null; + /** + * Operation last update time. If the operation is done, this is also the finish time. + */ + updateTime?: string | null; + } + /** + * Metadata for EvaluationService.CreateEvaluation method. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaCreateEvaluationMetadata {} + /** + * Metadata for Create Schema LRO. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaCreateSchemaMetadata { + /** + * Operation create time. + */ + createTime?: string | null; + /** + * Operation last update time. If the operation is done, this is also the finish time. + */ + updateTime?: string | null; + } + /** + * Metadata related to the progress of the SiteSearchEngineService.CreateTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaCreateTargetSiteMetadata { + /** + * Operation create time. + */ + createTime?: string | null; + /** + * Operation last update time. If the operation is done, this is also the finish time. + */ + updateTime?: string | null; + } + /** + * Metadata that describes a custom tuned model. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaCustomTuningModel { + /** + * Timestamp the Model was created at. + */ + createTime?: string | null; + /** + * The display name of the model. + */ + displayName?: string | null; + /** + * The metrics of the trained model. + */ + metrics?: {[key: string]: number} | null; + /** + * The state that the model is in (e.g.`TRAINING` or `TRAINING_FAILED`). + */ + modelState?: string | null; + /** + * The version of the model. + */ + modelVersion?: string | null; + /** + * Required. The fully qualified resource name of the model. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/customTuningModels/{custom_tuning_model\}` model must be an alpha-numerical string with limit of 40 characters. + */ + name?: string | null; + /** + * Timestamp the model training was initiated. + */ + trainingStartTime?: string | null; + } + /** + * DataStore captures global settings and configs at the DataStore level. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaDataStore { + /** + * Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT. + */ + contentConfig?: string | null; + /** + * Output only. Timestamp the DataStore was created at. + */ + createTime?: string | null; + /** + * Output only. The id of the default Schema asscociated to this data store. + */ + defaultSchemaId?: string | null; + /** + * 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. + */ + displayName?: string | null; + /** + * Configuration for Document understanding and enrichment. + */ + documentProcessingConfig?: Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfig; + /** + * Immutable. The industry vertical that the data store registers. + */ + industryVertical?: string | null; + /** + * Language info for DataStore. + */ + languageInfo?: Schema$GoogleCloudDiscoveryengineV1betaLanguageInfo; + /** + * 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. + */ + name?: string | null; + /** + * 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. + */ + solutionTypes?: string[] | null; + /** + * 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). + */ + startingSchema?: Schema$GoogleCloudDiscoveryengineV1betaSchema; + } + /** + * Metadata related to the progress of the DataStoreService.DeleteDataStore operation. This will be returned by the google.longrunning.Operation.metadata field. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaDeleteDataStoreMetadata { + /** + * Operation create time. + */ + createTime?: string | null; + /** + * Operation last update time. If the operation is done, this is also the finish time. + */ + updateTime?: string | null; + } + /** + * Metadata related to the progress of the EngineService.DeleteEngine operation. This will be returned by the google.longrunning.Operation.metadata field. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaDeleteEngineMetadata { + /** + * Operation create time. + */ + createTime?: string | null; + /** + * Operation last update time. If the operation is done, this is also the finish time. + */ + updateTime?: string | null; + } + /** + * Metadata for DeleteSchema LRO. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaDeleteSchemaMetadata { + /** + * Operation create time. + */ + createTime?: string | null; + /** + * Operation last update time. If the operation is done, this is also the finish time. + */ + updateTime?: string | null; + } + /** + * Metadata related to the progress of the SiteSearchEngineService.DeleteTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaDeleteTargetSiteMetadata { + /** + * Operation create time. + */ + createTime?: string | null; + /** + * Operation last update time. If the operation is done, this is also the finish time. + */ + updateTime?: string | null; + } + /** + * Metadata related to the progress of the SiteSearchEngineService.DisableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaDisableAdvancedSiteSearchMetadata { + /** + * Operation create time. + */ + createTime?: string | null; + /** + * Operation last update time. If the operation is done, this is also the finish time. + */ + updateTime?: string | null; + } + /** + * Response message for SiteSearchEngineService.DisableAdvancedSiteSearch method. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaDisableAdvancedSiteSearchResponse {} + /** + * A singleton resource of DataStore. It's empty when DataStore is created, which defaults to digital parser. The first call to DataStoreService.UpdateDocumentProcessingConfig method will initialize the config. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfig { + /** + * Whether chunking mode is enabled. + */ + chunkingConfig?: Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfig; + /** + * 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. + */ + defaultParsingConfig?: Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig; + /** + * The full resource name of the Document Processing Config. Format: `projects/x/locations/x/collections/x/dataStores/x/documentProcessingConfig`. + */ + name?: string | null; + /** + * 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. + */ + parsingConfigOverrides?: { + [ + key: string + ]: Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig; + } | null; + } + /** + * Configuration for chunking config. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfig { + /** + * Configuration for the layout based chunking. + */ + layoutBasedChunkingConfig?: Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig; + } + /** + * Configuration for the layout based chunking. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig { + /** + * The token size limit for each chunk. Supported values: 100-500 (inclusive). Default value: 500. + */ + chunkSize?: number | null; + /** + * Whether to include appending different levels of headings to chunks from the middle of the document to prevent context loss. Default value: False. + */ + includeAncestorHeadings?: boolean | null; } /** - * Step information. + * Related configurations applied to a specific type of document parser. */ - export interface Schema$GoogleCloudDiscoveryengineV1AnswerStep { + export interface Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig { /** - * Actions. + * Configurations applied to digital parser. */ - actions?: Schema$GoogleCloudDiscoveryengineV1AnswerStepAction[]; + digitalParsingConfig?: Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigDigitalParsingConfig; /** - * The description of the step. + * Configurations applied to layout parser. */ - description?: string | null; + layoutParsingConfig?: Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigLayoutParsingConfig; /** - * The state of the step. + * Configurations applied to OCR parser. Currently it only applies to PDFs. */ - state?: string | null; + ocrParsingConfig?: Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsingConfig; + } + /** + * The digital parsing configurations for documents. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigDigitalParsingConfig {} + /** + * The layout parsing configurations for documents. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigLayoutParsingConfig {} + /** + * The OCR parsing configurations for documents. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsingConfig { /** - * The thought of the step. + * [DEPRECATED] This field is deprecated. To use the additional enhanced document elements processing, please switch to `layout_parsing_config`. */ - thought?: string | null; + enhancedDocumentElements?: string[] | null; + /** + * If true, will use native text instead of OCR text on pages containing native text. + */ + useNativeText?: boolean | null; } /** - * Action. + * Metadata related to the progress of the SiteSearchEngineService.EnableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field. */ - export interface Schema$GoogleCloudDiscoveryengineV1AnswerStepAction { + export interface Schema$GoogleCloudDiscoveryengineV1betaEnableAdvancedSiteSearchMetadata { /** - * Observation. + * Operation create time. */ - observation?: Schema$GoogleCloudDiscoveryengineV1AnswerStepActionObservation; + createTime?: string | null; /** - * Search action. + * Operation last update time. If the operation is done, this is also the finish time. */ - searchAction?: Schema$GoogleCloudDiscoveryengineV1AnswerStepActionSearchAction; + updateTime?: string | null; } /** - * Observation. + * Response message for SiteSearchEngineService.EnableAdvancedSiteSearch method. */ - export interface Schema$GoogleCloudDiscoveryengineV1AnswerStepActionObservation { + export interface Schema$GoogleCloudDiscoveryengineV1betaEnableAdvancedSiteSearchResponse {} + /** + * Metadata that describes the training and serving parameters of an Engine. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaEngine { /** - * Search results observed by the search action, it can be snippets info or chunk info, depending on the citation type set by the user. + * Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT. */ - searchResults?: Schema$GoogleCloudDiscoveryengineV1AnswerStepActionObservationSearchResult[]; - } - export interface Schema$GoogleCloudDiscoveryengineV1AnswerStepActionObservationSearchResult { + chatEngineConfig?: Schema$GoogleCloudDiscoveryengineV1betaEngineChatEngineConfig; /** - * If citation_type is CHUNK_LEVEL_CITATION and chunk mode is on, populate chunk info. + * Output only. Additional information of the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT. */ - chunkInfo?: Schema$GoogleCloudDiscoveryengineV1AnswerStepActionObservationSearchResultChunkInfo[]; + chatEngineMetadata?: Schema$GoogleCloudDiscoveryengineV1betaEngineChatEngineMetadata; /** - * Document resource name. + * Common config spec that specifies the metadata of the engine. */ - document?: string | null; + commonConfig?: Schema$GoogleCloudDiscoveryengineV1betaEngineCommonConfig; /** - * If citation_type is DOCUMENT_LEVEL_CITATION, populate document level snippets. + * Output only. Timestamp the Recommendation Engine was created at. */ - snippetInfo?: Schema$GoogleCloudDiscoveryengineV1AnswerStepActionObservationSearchResultSnippetInfo[]; + createTime?: string | null; /** - * Title. + * 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. */ - title?: string | null; + dataStoreIds?: string[] | null; /** - * URI for the document. + * Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. */ - uri?: string | null; - } - /** - * Chunk information. - */ - export interface Schema$GoogleCloudDiscoveryengineV1AnswerStepActionObservationSearchResultChunkInfo { + displayName?: string | null; /** - * Chunk resource name. + * 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. */ - chunk?: string | null; + industryVertical?: string | null; /** - * Chunk textual content. + * 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_number\}/locations/{location\}/collections/{collection\}/engines/{engine\}` engine should be 1-63 characters, and valid characters are /a-z0-9x/. Otherwise, an INVALID_ARGUMENT error is returned. */ - content?: string | null; + name?: string | null; /** - * Relevance score. + * Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH. */ - relevanceScore?: number | null; - } - /** - * Snippet information. - */ - export interface Schema$GoogleCloudDiscoveryengineV1AnswerStepActionObservationSearchResultSnippetInfo { + searchEngineConfig?: Schema$GoogleCloudDiscoveryengineV1betaEngineSearchEngineConfig; /** - * Snippet content. + * Required. The solutions of the engine. */ - snippet?: string | null; + solutionType?: string | null; /** - * Status of the snippet defined by the search team. + * Output only. Timestamp the Recommendation Engine was last updated. */ - snippetStatus?: string | null; + updateTime?: string | null; } /** - * Search action. + * Configurations for a Chat Engine. */ - export interface Schema$GoogleCloudDiscoveryengineV1AnswerStepActionSearchAction { + export interface Schema$GoogleCloudDiscoveryengineV1betaEngineChatEngineConfig { /** - * The query to search. + * 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. */ - query?: string | null; + agentCreationConfig?: Schema$GoogleCloudDiscoveryengineV1betaEngineChatEngineConfigAgentCreationConfig; + /** + * 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. + */ + dialogflowAgentToLink?: string | null; } /** - * Metadata related to the progress of the SiteSearchEngineService.BatchCreateTargetSites 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. */ - export interface Schema$GoogleCloudDiscoveryengineV1BatchCreateTargetSiteMetadata { + export interface Schema$GoogleCloudDiscoveryengineV1betaEngineChatEngineConfigAgentCreationConfig { /** - * Operation create time. + * Name of the company, organization or other entity that the agent represents. Used for knowledge connector LLM prompt and for knowledge search. */ - createTime?: string | null; + business?: string | null; /** - * 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. */ - updateTime?: string | null; + defaultLanguageCode?: string | null; + /** + * 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. + */ + location?: string | null; + /** + * 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. + */ + timeZone?: string | null; } /** - * Request message for SiteSearchEngineService.BatchCreateTargetSites method. + * Additional information of a Chat Engine. Fields in this message are output only. */ - export interface Schema$GoogleCloudDiscoveryengineV1BatchCreateTargetSitesRequest { + export interface Schema$GoogleCloudDiscoveryengineV1betaEngineChatEngineMetadata { /** - * Required. The request message specifying the resources to create. A maximum of 20 TargetSites can be created in a batch. + * The resource name of a Dialogflow agent, that this Chat Engine refers to. Format: `projects//locations//agents/`. */ - requests?: Schema$GoogleCloudDiscoveryengineV1CreateTargetSiteRequest[]; + dialogflowAgent?: string | null; } /** - * Response message for SiteSearchEngineService.BatchCreateTargetSites method. + * Common configurations for an Engine. */ - export interface Schema$GoogleCloudDiscoveryengineV1BatchCreateTargetSitesResponse { + export interface Schema$GoogleCloudDiscoveryengineV1betaEngineCommonConfig { /** - * TargetSites created. + * The name of the company, business or entity that is associated with the engine. Setting this may help improve LLM related features. */ - targetSites?: Schema$GoogleCloudDiscoveryengineV1TargetSite[]; + companyName?: string | null; } /** - * Request message for SiteSearchEngineService.BatchVerifyTargetSites method. - */ - export interface Schema$GoogleCloudDiscoveryengineV1BatchVerifyTargetSitesRequest {} - /** - * Metadata related to the progress of the SiteSearchEngineService.BatchCreateTargetSites operation. This will be returned by the google.longrunning.Operation.metadata field. + * Configurations for a Search Engine. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaBatchCreateTargetSiteMetadata { + export interface Schema$GoogleCloudDiscoveryengineV1betaEngineSearchEngineConfig { /** - * Operation create time. + * The add-on that this search engine enables. */ - createTime?: string | null; + searchAddOns?: string[] | null; /** - * 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. */ - updateTime?: string | null; + searchTier?: string | null; } /** - * Response message for SiteSearchEngineService.BatchCreateTargetSites method. + * An evaluation is a single execution (or run) of an evaluation process. It encapsulates the state of the evaluation and the resulting data. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaBatchCreateTargetSitesResponse { + export interface Schema$GoogleCloudDiscoveryengineV1betaEvaluation { /** - * TargetSites created. + * Output only. Timestamp the Evaluation was created at. */ - targetSites?: Schema$GoogleCloudDiscoveryengineV1betaTargetSite[]; + createTime?: string | null; + /** + * Output only. Timestamp the Evaluation was completed at. + */ + endTime?: string | null; + /** + * Output only. The error that occurred during evaluation. Only populated when the evaluation's state is FAILED. + */ + error?: Schema$GoogleRpcStatus; + /** + * Output only. A sample of errors encountered while processing the request. + */ + errorSamples?: Schema$GoogleRpcStatus[]; + /** + * Required. The specification of the evaluation. + */ + evaluationSpec?: Schema$GoogleCloudDiscoveryengineV1betaEvaluationEvaluationSpec; + /** + * Immutable. 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. + */ + name?: string | null; + /** + * Output only. The metrics produced by the evaluation, averaged across all SampleQuerys in the SampleQuerySet. Only populated when the evaluation's state is SUCCEEDED. + */ + qualityMetrics?: Schema$GoogleCloudDiscoveryengineV1betaQualityMetrics; + /** + * Output only. The state of the evaluation. + */ + state?: string | null; } /** - * Defines circumstances to be checked before allowing a behavior + * Describes the specification of the evaluation. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaCondition { + export interface Schema$GoogleCloudDiscoveryengineV1betaEvaluationEvaluationSpec { /** - * Range of time(s) specifying when condition is active. Maximum of 10 time ranges. + * Required. The specification of the query set. */ - activeTimeRange?: Schema$GoogleCloudDiscoveryengineV1betaConditionTimeRange[]; + querySetSpec?: Schema$GoogleCloudDiscoveryengineV1betaEvaluationEvaluationSpecQuerySetSpec; /** - * Search only A list of terms to match the query on. Maximum of 10 query terms. + * 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 */ - queryTerms?: Schema$GoogleCloudDiscoveryengineV1betaConditionQueryTerm[]; + searchRequest?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequest; } /** - * Matcher for search request query + * Describes the specification of the query set. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaConditionQueryTerm { - /** - * Whether the search query needs to exactly match the query term. - */ - fullMatch?: boolean | null; + export interface Schema$GoogleCloudDiscoveryengineV1betaEvaluationEvaluationSpecQuerySetSpec { /** - * 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. + * Required. The full resource name of the SampleQuerySet used for the evaluation, in the format of `projects/{project\}/locations/{location\}/sampleQuerySets/{sampleQuerySet\}`. */ - value?: string | null; + sampleQuerySet?: string | null; } /** - * Used for time-dependent conditions. + * Metadata related to the progress of the ImportCompletionSuggestions operation. This will be returned by the google.longrunning.Operation.metadata field. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaConditionTimeRange { + export interface Schema$GoogleCloudDiscoveryengineV1betaImportCompletionSuggestionsMetadata { /** - * End of time range. Range is inclusive. Must be in the future. + * Operation create time. */ - endTime?: string | null; + createTime?: string | null; /** - * Start of time range. Range is inclusive. + * Count of CompletionSuggestions that failed to be imported. */ - startTime?: string | null; + failureCount?: string | null; + /** + * Count of CompletionSuggestions successfully imported. + */ + successCount?: string | null; + /** + * Operation last update time. If the operation is done, this is also the finish time. + */ + updateTime?: string | null; } /** - * 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`. + * 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. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaControl { + export interface Schema$GoogleCloudDiscoveryengineV1betaImportCompletionSuggestionsResponse { /** - * Output only. List of all ServingConfig ids this control is attached to. May take up to 10 minutes to update after changes. + * The desired location of errors incurred during the Import. */ - associatedServingConfigIds?: string[] | null; + errorConfig?: Schema$GoogleCloudDiscoveryengineV1betaImportErrorConfig; /** - * Defines a boost-type control + * A sample of errors encountered while processing the request. */ - boostAction?: Schema$GoogleCloudDiscoveryengineV1betaControlBoostAction; + errorSamples?: Schema$GoogleRpcStatus[]; + } + /** + * Metadata related to the progress of the ImportDocuments operation. This is returned by the google.longrunning.Operation.metadata field. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaImportDocumentsMetadata { /** - * 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. + * Operation create time. */ - conditions?: Schema$GoogleCloudDiscoveryengineV1betaCondition[]; + createTime?: string | null; /** - * 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. + * Count of entries that encountered errors while processing. */ - displayName?: string | null; + failureCount?: string | null; /** - * Defines a filter-type control Currently not supported by Recommendation + * Count of entries that were processed successfully. */ - filterAction?: Schema$GoogleCloudDiscoveryengineV1betaControlFilterAction; + successCount?: string | null; /** - * Immutable. Fully qualified name `projects/x/locations/global/dataStore/x/controls/x` + * Total count of entries that were processed. */ - name?: string | null; + totalCount?: string | null; /** - * Defines a redirect-type control. + * Operation last update time. If the operation is done, this is also the finish time. */ - redirectAction?: Schema$GoogleCloudDiscoveryengineV1betaControlRedirectAction; + updateTime?: string | null; + } + /** + * 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. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaImportDocumentsResponse { /** - * Required. Immutable. What solution the control belongs to. Must be compatible with vertical of resource. Otherwise an INVALID ARGUMENT error is thrown. + * Echoes the destination for the complete errors in the request if set. */ - solutionType?: string | null; + errorConfig?: Schema$GoogleCloudDiscoveryengineV1betaImportErrorConfig; /** - * Treats a group of terms as synonyms of one another. + * A sample of errors encountered while processing the request. */ - synonymsAction?: Schema$GoogleCloudDiscoveryengineV1betaControlSynonymsAction; + errorSamples?: Schema$GoogleRpcStatus[]; + } + /** + * Configuration of destination for Import related errors. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaImportErrorConfig { /** - * 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. + * 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. */ - useCases?: string[] | null; + gcsPrefix?: string | null; } /** - * Adjusts order of products in returned list. + * Metadata related to the progress of the ImportSampleQueries operation. This will be returned by the google.longrunning.Operation.metadata field. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaControlBoostAction { + export interface Schema$GoogleCloudDiscoveryengineV1betaImportSampleQueriesMetadata { /** - * Required. Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0 (No-op). + * ImportSampleQueries operation create time. */ - boost?: number | null; + createTime?: string | null; /** - * 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 + * Count of SampleQuerys that failed to be imported. */ - dataStore?: string | null; + failureCount?: string | null; /** - * 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. + * Count of SampleQuerys successfully imported. */ - filter?: string | null; - } - /** - * Specified which products may be included in results. Uses same filter as boost. - */ - export interface Schema$GoogleCloudDiscoveryengineV1betaControlFilterAction { + successCount?: string | null; /** - * 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 + * Total count of SampleQuerys that were processed. */ - dataStore?: string | null; + totalCount?: string | null; /** - * 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. + * ImportSampleQueries operation last update time. If the operation is done, this is also the finish time. */ - filter?: string | null; + updateTime?: string | null; } /** - * Redirects a shopper to the provided URI. + * 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. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaControlRedirectAction { + export interface Schema$GoogleCloudDiscoveryengineV1betaImportSampleQueriesResponse { /** - * 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 desired location of errors incurred during the Import. */ - redirectUri?: string | null; - } - /** - * 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". - */ - export interface Schema$GoogleCloudDiscoveryengineV1betaControlSynonymsAction { + errorConfig?: Schema$GoogleCloudDiscoveryengineV1betaImportErrorConfig; /** - * Defines a set of synonyms. Can specify up to 100 synonyms. Must specify at least 2 synonyms. Otherwise an INVALID ARGUMENT error is thrown. + * A sample of errors encountered while processing the request. */ - synonyms?: string[] | null; + errorSamples?: Schema$GoogleRpcStatus[]; } /** - * Metadata related to the progress of the DataStoreService.CreateDataStore operation. This will be returned by the google.longrunning.Operation.metadata field. + * Metadata related to the progress of the ImportSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaCreateDataStoreMetadata { + export interface Schema$GoogleCloudDiscoveryengineV1betaImportSuggestionDenyListEntriesMetadata { /** * Operation create time. */ @@ -2782,161 +4134,209 @@ export namespace discoveryengine_v1 { updateTime?: string | null; } /** - * Metadata related to the progress of the EngineService.CreateEngine operation. This will be returned by the google.longrunning.Operation.metadata field. + * Response message for CompletionService.ImportSuggestionDenyListEntries method. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaCreateEngineMetadata { + export interface Schema$GoogleCloudDiscoveryengineV1betaImportSuggestionDenyListEntriesResponse { /** - * Operation create time. + * A sample of errors encountered while processing the request. */ - createTime?: string | null; + errorSamples?: Schema$GoogleRpcStatus[]; /** - * Operation last update time. If the operation is done, this is also the finish time. + * Count of deny list entries that failed to be imported. */ - updateTime?: string | null; + failedEntriesCount?: string | null; + /** + * Count of deny list entries successfully imported. + */ + importedEntriesCount?: string | null; } /** - * Metadata for Create Schema LRO. + * Metadata related to the progress of the Import operation. This is returned by the google.longrunning.Operation.metadata field. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaCreateSchemaMetadata { + export interface Schema$GoogleCloudDiscoveryengineV1betaImportUserEventsMetadata { /** * Operation create time. */ createTime?: string | null; + /** + * Count of entries that encountered errors while processing. + */ + failureCount?: string | null; + /** + * Count of entries that were processed successfully. + */ + successCount?: string | null; /** * Operation last update time. If the operation is done, this is also the finish time. */ updateTime?: string | null; } /** - * Metadata related to the progress of the SiteSearchEngineService.CreateTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field. + * 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. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaCreateTargetSiteMetadata { + export interface Schema$GoogleCloudDiscoveryengineV1betaImportUserEventsResponse { /** - * Operation create time. + * Echoes the destination for the complete errors if this field was set in the request. */ - createTime?: string | null; + errorConfig?: Schema$GoogleCloudDiscoveryengineV1betaImportErrorConfig; /** - * Operation last update time. If the operation is done, this is also the finish time. + * A sample of errors encountered while processing the request. */ - updateTime?: string | null; + errorSamples?: Schema$GoogleRpcStatus[]; + /** + * Count of user events imported with complete existing Documents. + */ + joinedEventsCount?: string | null; + /** + * Count of user events imported, but with Document information not found in the existing Branch. + */ + unjoinedEventsCount?: string | null; } /** - * Metadata that describes a custom tuned model. + * A floating point interval. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaCustomTuningModel { + export interface Schema$GoogleCloudDiscoveryengineV1betaInterval { /** - * Timestamp the Model was created at. + * Exclusive upper bound. */ - createTime?: string | null; + exclusiveMaximum?: number | null; /** - * The display name of the model. + * Exclusive lower bound. */ - displayName?: string | null; + exclusiveMinimum?: number | null; /** - * The state that the model is in (e.g.`TRAINING` or `TRAINING_FAILED`). + * Inclusive upper bound. */ - modelState?: string | null; + maximum?: number | null; /** - * The version of the model. + * Inclusive lower bound. */ - modelVersion?: string | null; + minimum?: number | null; + } + /** + * Language info for DataStore. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaLanguageInfo { /** - * Required. The fully qualified resource name of the model. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/customTuningModels/{custom_tuning_model\}` model must be an alpha-numerical string with limit of 40 characters. + * Output only. Language part of normalized_language_code. E.g.: `en-US` -\> `en`, `zh-Hans-HK` -\> `zh`, `en` -\> `en`. */ - name?: string | null; + language?: string | null; /** - * Timestamp the model training was initiated. + * The language code for the DataStore. */ - trainingStartTime?: string | null; + languageCode?: string | null; + /** + * 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`. + */ + normalizedLanguageCode?: string | null; + /** + * Output only. Region part of normalized_language_code, if present. E.g.: `en-US` -\> `US`, `zh-Hans-HK` -\> `HK`, `en` -\> ``. + */ + region?: string | null; } /** - * DataStore captures global settings and configs at the DataStore level. + * Response message for SearchTuningService.ListCustomModels method. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaDataStore { + export interface Schema$GoogleCloudDiscoveryengineV1betaListCustomModelsResponse { /** - * Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT. + * List of custom tuning models. */ - contentConfig?: string | null; + models?: Schema$GoogleCloudDiscoveryengineV1betaCustomTuningModel[]; + } + /** + * Metadata and configurations for a Google Cloud project in the service. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaProject { /** - * Output only. Timestamp the DataStore was created at. + * Output only. The timestamp when this project is created. */ createTime?: string | null; /** - * Output only. The id of the default Schema asscociated to this data store. + * Output only. Full resource name of the project, for example `projects/{project_number\}`. Note that when making requests, project number and project id are both acceptable, but the server will always respond in project number. */ - defaultSchemaId?: string | null; + name?: string | null; /** - * 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. + * Output only. The timestamp when this project is successfully provisioned. Empty value means this project is still provisioning and is not ready for use. */ - displayName?: string | null; + provisionCompletionTime?: string | null; /** - * Configuration for Document understanding and enrichment. + * Output only. A map of terms of services. The key is the `id` of ServiceTerms. */ - documentProcessingConfig?: Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfig; + serviceTermsMap?: { + [key: string]: Schema$GoogleCloudDiscoveryengineV1betaProjectServiceTerms; + } | null; + } + /** + * Metadata about the terms of service. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaProjectServiceTerms { /** - * Immutable. The industry vertical that the data store registers. + * The last time when the project agreed to the terms of service. */ - industryVertical?: string | null; + acceptTime?: string | null; /** - * Language info for DataStore. + * The last time when the project declined or revoked the agreement to terms of service. */ - languageInfo?: Schema$GoogleCloudDiscoveryengineV1betaLanguageInfo; + declineTime?: string | null; /** - * 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. + * 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`. */ - name?: string | null; + id?: string | null; /** - * 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. + * Whether the project has accepted/rejected the service terms or it is still pending. */ - solutionTypes?: string[] | null; + state?: string | null; /** - * 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). + * The version string of the terms of service. For acceptable values, see the comments for id above. */ - startingSchema?: Schema$GoogleCloudDiscoveryengineV1betaSchema; + version?: string | null; } /** - * Metadata related to the progress of the DataStoreService.DeleteDataStore operation. This will be returned by the google.longrunning.Operation.metadata field. + * Metadata associated with a project provision operation. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaDeleteDataStoreMetadata { + export interface Schema$GoogleCloudDiscoveryengineV1betaProvisionProjectMetadata {} + /** + * Metadata related to the progress of the PurgeDocuments operation. This will be returned by the google.longrunning.Operation.metadata field. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaPurgeDocumentsMetadata { /** * Operation create time. */ createTime?: string | null; /** - * Operation last update time. If the operation is done, this is also the finish time. + * Count of entries that encountered errors while processing. */ - updateTime?: string | null; - } - /** - * Metadata related to the progress of the EngineService.DeleteEngine operation. This will be returned by the google.longrunning.Operation.metadata field. - */ - export interface Schema$GoogleCloudDiscoveryengineV1betaDeleteEngineMetadata { + failureCount?: string | null; /** - * Operation create time. + * Count of entries that were ignored as entries were not found. */ - createTime?: string | null; + ignoredCount?: string | null; + /** + * Count of entries that were deleted successfully. + */ + successCount?: string | null; /** * Operation last update time. If the operation is done, this is also the finish time. */ updateTime?: string | null; } /** - * Metadata for DeleteSchema LRO. + * 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. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaDeleteSchemaMetadata { + export interface Schema$GoogleCloudDiscoveryengineV1betaPurgeDocumentsResponse { /** - * Operation create time. + * The total count of documents purged as a result of the operation. */ - createTime?: string | null; + purgeCount?: string | null; /** - * Operation last update time. If the operation is done, this is also the finish time. + * 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. */ - updateTime?: string | null; + purgeSample?: string[] | null; } /** - * Metadata related to the progress of the SiteSearchEngineService.DeleteTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field. + * Metadata related to the progress of the PurgeSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaDeleteTargetSiteMetadata { + export interface Schema$GoogleCloudDiscoveryengineV1betaPurgeSuggestionDenyListEntriesMetadata { /** * Operation create time. */ @@ -2947,553 +4347,547 @@ export namespace discoveryengine_v1 { updateTime?: string | null; } /** - * Metadata related to the progress of the SiteSearchEngineService.DisableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field. + * Response message for CompletionService.PurgeSuggestionDenyListEntries method. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaDisableAdvancedSiteSearchMetadata { + export interface Schema$GoogleCloudDiscoveryengineV1betaPurgeSuggestionDenyListEntriesResponse { /** - * Operation create time. + * A sample of errors encountered while processing the request. */ - createTime?: string | null; + errorSamples?: Schema$GoogleRpcStatus[]; /** - * Operation last update time. If the operation is done, this is also the finish time. + * Number of suggestion deny list entries purged. */ - updateTime?: string | null; + purgeCount?: string | null; } /** - * Response message for SiteSearchEngineService.DisableAdvancedSiteSearch method. - */ - export interface Schema$GoogleCloudDiscoveryengineV1betaDisableAdvancedSiteSearchResponse {} - /** - * A singleton resource of DataStore. It's empty when DataStore is created, which defaults to digital parser. The first call to DataStoreService.UpdateDocumentProcessingConfig method will initialize the config. + * Describes the metrics produced by the evaluation. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfig { + export interface Schema$GoogleCloudDiscoveryengineV1betaQualityMetrics { /** - * Whether chunking mode is enabled. + * 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 */ - chunkingConfig?: Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfig; + docNdcg?: Schema$GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics; /** - * 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. + * 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 */ - defaultParsingConfig?: Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig; + docPrecision?: Schema$GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics; /** - * The full resource name of the Document Processing Config. Format: `projects/x/locations/x/collections/x/dataStores/x/documentProcessingConfig`. + * 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 */ - name?: string | null; + docRecall?: Schema$GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics; /** - * 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 or layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and or layout parsing are supported. + * 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 */ - parsingConfigOverrides?: { - [ - key: string - ]: Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig; - } | null; - } - /** - * Configuration for chunking config. - */ - export interface Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfig { + pageNdcg?: Schema$GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics; /** - * Configuration for the layout based chunking. + * 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 */ - layoutBasedChunkingConfig?: Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig; + pageRecall?: Schema$GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics; } /** - * Configuration for the layout based chunking. + * Stores the metric values at specific top-k levels. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig { + export interface Schema$GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics { /** - * The token size limit for each chunk. Supported values: 100-500 (inclusive). Default value: 500. + * The top-1 value. */ - chunkSize?: number | null; + top1?: number | null; /** - * Whether to include appending different levels of headings to chunks from the middle of the document to prevent context loss. Default value: False. + * The top-10 value. */ - includeAncestorHeadings?: boolean | null; + top10?: number | null; + /** + * The top-3 value. + */ + top3?: number | null; + /** + * The top-5 value. + */ + top5?: number | null; } /** - * Related configurations applied to a specific type of document parser. + * Defines the structure and layout of a type of document data. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig { + export interface Schema$GoogleCloudDiscoveryengineV1betaSchema { /** - * Configurations applied to digital parser. + * The JSON representation of the schema. */ - digitalParsingConfig?: Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigDigitalParsingConfig; + jsonSchema?: string | null; /** - * Configurations applied to layout parser. + * 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. */ - layoutParsingConfig?: Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigLayoutParsingConfig; + name?: string | null; /** - * Configurations applied to OCR parser. Currently it only applies to PDFs. + * The structured representation of the schema. */ - ocrParsingConfig?: Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsingConfig; + structSchema?: {[key: string]: any} | null; } /** - * The digital parsing configurations for documents. - */ - export interface Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigDigitalParsingConfig {} - /** - * The layout parsing configurations for documents. - */ - export interface Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigLayoutParsingConfig {} - /** - * The OCR parsing configurations for documents. + * Request message for SearchService.Search method. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsingConfig { + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequest { /** - * [DEPRECATED] This field is deprecated. To use the additional enhanced document elements processing, please switch to `layout_parsing_config`. + * 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) */ - enhancedDocumentElements?: string[] | null; + boostSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpec; /** - * If true, will use native text instead of OCR text on pages containing native text. + * The branch resource name, such as `projects/x/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. */ - useNativeText?: boolean | null; - } - /** - * Metadata related to the progress of the SiteSearchEngineService.EnableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field. - */ - export interface Schema$GoogleCloudDiscoveryengineV1betaEnableAdvancedSiteSearchMetadata { + branch?: string | null; /** - * Operation create time. + * 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. */ - createTime?: string | null; + canonicalFilter?: string | null; /** - * Operation last update time. If the operation is done, this is also the finish time. + * A specification for configuring the behavior of content search. */ - updateTime?: string | null; - } - /** - * Response message for SiteSearchEngineService.EnableAdvancedSiteSearch method. - */ - export interface Schema$GoogleCloudDiscoveryengineV1betaEnableAdvancedSiteSearchResponse {} - /** - * Metadata that describes the training and serving parameters of an Engine. - */ - export interface Schema$GoogleCloudDiscoveryengineV1betaEngine { + contentSearchSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpec; /** - * Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT. + * 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. */ - chatEngineConfig?: Schema$GoogleCloudDiscoveryengineV1betaEngineChatEngineConfig; + dataStoreSpecs?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec[]; /** - * Output only. Additional information of the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT. + * 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. */ - chatEngineMetadata?: Schema$GoogleCloudDiscoveryengineV1betaEngineChatEngineMetadata; + embeddingSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpec; /** - * Common config spec that specifies the metadata of the engine. + * 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. */ - commonConfig?: Schema$GoogleCloudDiscoveryengineV1betaEngineCommonConfig; + facetSpecs?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestFacetSpec[]; /** - * Output only. Timestamp the Recommendation Engine was created at. + * 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) */ - createTime?: string | null; + filter?: string | null; /** - * 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. + * Raw image query. */ - dataStoreIds?: string[] | null; + imageQuery?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestImageQuery; /** - * Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. + * 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. */ - displayName?: string | null; + languageCode?: string | null; /** - * 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. + * If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done. */ - industryVertical?: string | null; + naturalLanguageQueryUnderstandingSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestNaturalLanguageQueryUnderstandingSpec; /** - * 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_number\}/locations/{location\}/collections/{collection\}/engines/{engine\}` engine should be 1-63 characters, and valid characters are /a-z0-9x/. Otherwise, an INVALID_ARGUMENT error is returned. + * 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. */ - name?: string | null; + offset?: number | null; /** - * Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH. + * 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 for retail search, see [Ordering](https://cloud.google.com/retail/docs/filter-and-order#order) If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. */ - searchEngineConfig?: Schema$GoogleCloudDiscoveryengineV1betaEngineSearchEngineConfig; + orderBy?: string | null; /** - * Required. The solutions of the engine. + * 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. */ - solutionType?: string | null; + pageSize?: number | null; /** - * Output only. Timestamp the Recommendation Engine was last updated. + * 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. */ - updateTime?: string | null; - } - /** - * Configurations for a Chat Engine. - */ - export interface Schema$GoogleCloudDiscoveryengineV1betaEngineChatEngineConfig { + pageToken?: string | null; /** - * 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. + * 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` */ - agentCreationConfig?: Schema$GoogleCloudDiscoveryengineV1betaEngineChatEngineConfigAgentCreationConfig; + params?: {[key: string]: any} | null; /** - * 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. + * Raw search query. */ - dialogflowAgentToLink?: string | null; - } - /** - * 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. - */ - export interface Schema$GoogleCloudDiscoveryengineV1betaEngineChatEngineConfigAgentCreationConfig { + query?: string | null; /** - * Name of the company, organization or other entity that the agent represents. Used for knowledge connector LLM prompt and for knowledge search. + * The query expansion specification that specifies the conditions under which query expansion occurs. */ - business?: string | null; + queryExpansionSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestQueryExpansionSpec; /** - * 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. + * 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)`. */ - defaultLanguageCode?: string | null; + rankingExpression?: string | null; /** - * 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. + * 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. */ - location?: string | null; + regionCode?: string | null; /** - * 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. + * Whether to turn on safe search. This is only supported for website search. */ - timeZone?: string | null; - } - /** - * Additional information of a Chat Engine. Fields in this message are output only. - */ - export interface Schema$GoogleCloudDiscoveryengineV1betaEngineChatEngineMetadata { + safeSearch?: boolean | null; /** - * The resource name of a Dialogflow agent, that this Chat Engine refers to. Format: `projects//locations//agents/`. + * Search as you type configuration. Only supported for the IndustryVertical.MEDIA vertical. */ - dialogflowAgent?: string | null; + searchAsYouTypeSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestSearchAsYouTypeSpec; + /** + * Required. The resource name of the Search serving config, such as `projects/x/locations/global/collections/default_collection/engines/x/servingConfigs/default_serving_config`, or `projects/x/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. + */ + servingConfig?: string | null; + /** + * 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. + */ + session?: string | null; + /** + * Session specification. Can be used only when `session` is set. + */ + sessionSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestSessionSpec; + /** + * The spell correction specification that specifies the mode under which spell correction takes effect. + */ + spellCorrectionSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestSpellCorrectionSpec; + /** + * Information about the end user. Highly recommended for analytics. UserInfo.user_agent is used to deduce `device_type` for analytics. + */ + userInfo?: Schema$GoogleCloudDiscoveryengineV1betaUserInfo; + /** + * 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. + */ + userLabels?: {[key: string]: string} | null; + /** + * 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. + */ + userPseudoId?: string | null; } /** - * Common configurations for an Engine. + * Boost specification to boost certain documents. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaEngineCommonConfig { + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpec { /** - * The name of the company, business or entity that is associated with the engine. Setting this may help improve LLM related features. + * 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. */ - companyName?: string | null; + conditionBoostSpecs?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpec[]; } /** - * Configurations for a Search Engine. + * Boost applies to documents which match a condition. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaEngineSearchEngineConfig { + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpec { /** - * The add-on that this search engine enables. + * 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. */ - searchAddOns?: string[] | null; + boost?: number | null; /** - * 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. + * Complex specification for custom ranking based on customer defined attribute value. */ - searchTier?: string | null; + boostControlSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpecBoostControlSpec; + /** + * 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"))` + */ + condition?: string | null; } /** - * Metadata related to the progress of the ImportCompletionSuggestions operation. This will be returned by the google.longrunning.Operation.metadata field. + * Specification for custom ranking based on customer specified attribute value. It provides more controls for customized ranking than the simple (condition, boost) combination above. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaImportCompletionSuggestionsMetadata { + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpecBoostControlSpec { /** - * Operation create time. + * 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). */ - createTime?: string | null; + attributeType?: string | null; /** - * Count of CompletionSuggestions that failed to be imported. + * The control points used to define the curve. The monotonic function (defined through the interpolation_type above) passes through the control points listed here. */ - failureCount?: string | null; + controlPoints?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpecBoostControlSpecControlPoint[]; /** - * Count of CompletionSuggestions successfully imported. + * The name of the field whose value will be used to determine the boost amount. */ - successCount?: string | null; + fieldName?: string | null; /** - * Operation last update time. If the operation is done, this is also the finish time. + * The interpolation type to be applied to connect the control points listed below. */ - updateTime?: string | null; + interpolationType?: string | null; } /** - * 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. + * 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). */ - export interface Schema$GoogleCloudDiscoveryengineV1betaImportCompletionSuggestionsResponse { + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpecBoostControlSpecControlPoint { /** - * The desired location of errors incurred during the Import. + * 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]`. */ - errorConfig?: Schema$GoogleCloudDiscoveryengineV1betaImportErrorConfig; + attributeValue?: string | null; /** - * A sample of errors encountered while processing the request. + * The value between -1 to 1 by which to boost the score if the attribute_value evaluates to the value specified above. */ - errorSamples?: Schema$GoogleRpcStatus[]; + boostAmount?: number | null; } /** - * Metadata related to the progress of the ImportDocuments operation. This is returned by the google.longrunning.Operation.metadata field. + * A specification for configuring the behavior of content search. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaImportDocumentsMetadata { + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpec { /** - * Operation create time. + * Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS */ - createTime?: string | null; + chunkSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecChunkSpec; /** - * Count of entries that encountered errors while processing. + * If there is no extractive_content_spec provided, there will be no extractive answer in the search response. */ - failureCount?: string | null; + extractiveContentSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecExtractiveContentSpec; /** - * Count of entries that were processed successfully. + * Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`. */ - successCount?: string | null; + searchResultMode?: string | null; /** - * Total count of entries that were processed. + * If `snippetSpec` is not specified, snippets are not included in the search response. */ - totalCount?: string | null; + snippetSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSnippetSpec; /** - * Operation last update time. If the operation is done, this is also the finish time. + * If `summarySpec` is not specified, summaries are not included in the search response. */ - updateTime?: string | null; + summarySpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpec; } /** - * 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. + * Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS */ - export interface Schema$GoogleCloudDiscoveryengineV1betaImportDocumentsResponse { + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecChunkSpec { /** - * Echoes the destination for the complete errors in the request if set. + * 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. */ - errorConfig?: Schema$GoogleCloudDiscoveryengineV1betaImportErrorConfig; + numNextChunks?: number | null; /** - * A sample of errors encountered while processing the request. + * 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. */ - errorSamples?: Schema$GoogleRpcStatus[]; + numPreviousChunks?: number | null; } /** - * Configuration of destination for Import related errors. + * A specification for configuring the extractive content in a search response. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaImportErrorConfig { + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecExtractiveContentSpec { /** - * 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. + * 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. */ - gcsPrefix?: string | null; - } - /** - * Metadata related to the progress of the ImportSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field. - */ - export interface Schema$GoogleCloudDiscoveryengineV1betaImportSuggestionDenyListEntriesMetadata { + maxExtractiveAnswerCount?: number | null; /** - * Operation create time. + * 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`. */ - createTime?: string | null; + maxExtractiveSegmentCount?: number | null; /** - * Operation last update time. If the operation is done, this is also the finish time. + * Return at most `num_next_segments` segments after each selected segments. */ - updateTime?: string | null; + numNextSegments?: number | null; + /** + * Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments. + */ + numPreviousSegments?: number | null; + /** + * 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`. + */ + returnExtractiveSegmentScore?: boolean | null; } /** - * Response message for CompletionService.ImportSuggestionDenyListEntries method. + * A specification for configuring snippets in a search response. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaImportSuggestionDenyListEntriesResponse { + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSnippetSpec { /** - * A sample of errors encountered while processing the request. + * [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. */ - errorSamples?: Schema$GoogleRpcStatus[]; + maxSnippetCount?: number | null; /** - * Count of deny list entries that failed to be imported. + * [DEPRECATED] This field is deprecated and will have no affect on the snippet. */ - failedEntriesCount?: string | null; + referenceOnly?: boolean | null; /** - * Count of deny list entries successfully imported. + * 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. */ - importedEntriesCount?: string | null; + returnSnippet?: boolean | null; } /** - * Metadata related to the progress of the Import operation. This is returned by the google.longrunning.Operation.metadata field. + * A specification for configuring a summary returned in a search response. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaImportUserEventsMetadata { + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpec { /** - * Operation create time. + * 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. */ - createTime?: string | null; + ignoreAdversarialQuery?: boolean | null; /** - * Count of entries that encountered errors while processing. + * 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. */ - failureCount?: string | null; + ignoreNonSummarySeekingQuery?: boolean | null; /** - * Count of entries that were processed successfully. + * 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. */ - successCount?: string | null; + includeCitations?: boolean | null; /** - * Operation last update time. If the operation is done, this is also the finish time. + * 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. */ - updateTime?: string | null; - } - /** - * 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. - */ - export interface Schema$GoogleCloudDiscoveryengineV1betaImportUserEventsResponse { + languageCode?: string | null; /** - * Echoes the destination for the complete errors if this field was set in the request. + * If specified, the spec will be used to modify the prompt provided to the LLM. */ - errorConfig?: Schema$GoogleCloudDiscoveryengineV1betaImportErrorConfig; + modelPromptSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelPromptSpec; /** - * A sample of errors encountered while processing the request. + * If specified, the spec will be used to modify the model specification provided to the LLM. */ - errorSamples?: Schema$GoogleRpcStatus[]; + modelSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelSpec; /** - * Count of user events imported with complete existing Documents. + * 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. */ - joinedEventsCount?: string | null; + summaryResultCount?: number | null; /** - * Count of user events imported, but with Document information not found in the existing Branch. + * 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. */ - unjoinedEventsCount?: string | null; + useSemanticChunks?: boolean | null; } /** - * Language info for DataStore. + * Specification of the prompt to use with the model. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaLanguageInfo { + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelPromptSpec { /** - * Output only. Language part of normalized_language_code. E.g.: `en-US` -\> `en`, `zh-Hans-HK` -\> `zh`, `en` -\> `en`. + * Text at the beginning of the prompt that instructs the assistant. Examples are available in the user guide. */ - language?: string | null; + preamble?: string | null; + } + /** + * Specification of the model. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelSpec { /** - * The language code for the DataStore. + * 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). */ - languageCode?: string | null; + version?: string | null; + } + /** + * 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. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec { /** - * 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`. + * Required. Full resource name of DataStore, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}`. */ - normalizedLanguageCode?: string | null; + dataStore?: string | null; + } + /** + * The specification that uses customized query embedding vector to do semantic document retrieval. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpec { /** - * Output only. Region part of normalized_language_code, if present. E.g.: `en-US` -\> `US`, `zh-Hans-HK` -\> `HK`, `en` -\> ``. + * The embedding vector used for retrieval. Limit to 1. */ - region?: string | null; + embeddingVectors?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpecEmbeddingVector[]; } /** - * Response message for SearchTuningService.ListCustomModels method. + * Embedding vector. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaListCustomModelsResponse { + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpecEmbeddingVector { /** - * List of custom tuning models. + * Embedding field path in schema. */ - models?: Schema$GoogleCloudDiscoveryengineV1betaCustomTuningModel[]; + fieldPath?: string | null; + /** + * Query embedding vector. + */ + vector?: number[] | null; } /** - * Metadata and configurations for a Google Cloud project in the service. + * A facet specification to perform faceted search. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaProject { + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestFacetSpec { /** - * Output only. The timestamp when this project is created. + * 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. */ - createTime?: string | null; + enableDynamicPosition?: boolean | null; /** - * Output only. Full resource name of the project, for example `projects/{project_number\}`. Note that when making requests, project number and project id are both acceptable, but the server will always respond in project number. + * 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. */ - name?: string | null; + excludedFilterKeys?: string[] | null; /** - * Output only. The timestamp when this project is successfully provisioned. Empty value means this project is still provisioning and is not ready for use. + * Required. The facet key specification. */ - provisionCompletionTime?: string | null; + facetKey?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestFacetSpecFacetKey; /** - * Output only. A map of terms of services. The key is the `id` of ServiceTerms. + * 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. */ - serviceTermsMap?: { - [key: string]: Schema$GoogleCloudDiscoveryengineV1betaProjectServiceTerms; - } | null; + limit?: number | null; } /** - * Metadata about the terms of service. + * Specifies how a facet is computed. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaProjectServiceTerms { - /** - * The last time when the project agreed to the terms of service. - */ - acceptTime?: string | null; - /** - * The last time when the project declined or revoked the agreement to terms of service. - */ - declineTime?: string | null; + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestFacetSpecFacetKey { /** - * 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`. + * True to make facet keys case insensitive when getting faceting values with prefixes or contains; false otherwise. */ - id?: string | null; + caseInsensitive?: boolean | null; /** - * Whether the project has accepted/rejected the service terms or it is still pending. + * 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. */ - state?: string | null; + contains?: string[] | null; /** - * The version string of the terms of service. For acceptable values, see the comments for id above. + * 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. */ - version?: string | null; - } - /** - * Metadata associated with a project provision operation. - */ - export interface Schema$GoogleCloudDiscoveryengineV1betaProvisionProjectMetadata {} - /** - * Metadata related to the progress of the PurgeDocuments operation. This will be returned by the google.longrunning.Operation.metadata field. - */ - export interface Schema$GoogleCloudDiscoveryengineV1betaPurgeDocumentsMetadata { + intervals?: Schema$GoogleCloudDiscoveryengineV1betaInterval[]; /** - * Operation create time. + * Required. Supported textual and numerical facet keys in Document object, over which the facet values are computed. Facet key is case-sensitive. */ - createTime?: string | null; + key?: string | null; /** - * Count of entries that encountered errors while processing. + * 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. */ - failureCount?: string | null; + orderBy?: string | null; /** - * Count of entries that were ignored as entries were not found. + * 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. */ - ignoredCount?: string | null; + prefixes?: string[] | null; /** - * Count of entries that were deleted successfully. + * 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. */ - successCount?: string | null; + restrictedValues?: string[] | null; + } + /** + * Specifies the image query input. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestImageQuery { /** - * Operation last update time. If the operation is done, this is also the finish time. + * Base64 encoded image bytes. Supported image formats: JPEG, PNG, and BMP. */ - updateTime?: string | null; + imageBytes?: string | null; } /** - * 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. + * Specification to enable natural language understanding capabilities for search requests. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaPurgeDocumentsResponse { + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestNaturalLanguageQueryUnderstandingSpec { /** - * The total count of documents purged as a result of the operation. + * The condition under which filter extraction should occur. Default to Condition.DISABLED. */ - purgeCount?: string | null; + filterExtractionCondition?: string | null; /** - * 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. + * 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. */ - purgeSample?: string[] | null; + geoSearchQueryDetectionFieldNames?: string[] | null; } /** - * Metadata related to the progress of the PurgeSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field. + * Specification to determine under which conditions query expansion should occur. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaPurgeSuggestionDenyListEntriesMetadata { + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestQueryExpansionSpec { /** - * Operation create time. + * The condition under which query expansion should occur. Default to Condition.DISABLED. */ - createTime?: string | null; + condition?: string | null; /** - * Operation last update time. If the operation is done, this is also the finish time. + * 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. */ - updateTime?: string | null; + pinUnexpandedResults?: boolean | null; } /** - * Response message for CompletionService.PurgeSuggestionDenyListEntries method. + * Specification for search as you type in search requests. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaPurgeSuggestionDenyListEntriesResponse { - /** - * A sample of errors encountered while processing the request. - */ - errorSamples?: Schema$GoogleRpcStatus[]; + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestSearchAsYouTypeSpec { /** - * Number of suggestion deny list entries purged. + * The condition under which search as you type should occur. Default to Condition.DISABLED. */ - purgeCount?: string | null; + condition?: string | null; } /** - * Defines the structure and layout of a type of document data. + * 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. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaSchema { + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestSessionSpec { /** - * The JSON representation of the schema. + * 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. */ - jsonSchema?: string | null; + queryId?: string | null; /** - * 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 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. */ - name?: string | null; + searchResultPersistenceCount?: number | null; + } + /** + * The specification for query spell correction. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestSpellCorrectionSpec { /** - * The structured representation of the schema. + * The mode under which spell correction replaces the original search query. Defaults to Mode.AUTO. */ - structSchema?: {[key: string]: any} | null; + mode?: string | null; } /** * Verification information for target sites in advanced site search. @@ -3642,11 +5036,24 @@ export namespace discoveryengine_v1 { /** * Operation create time. */ - createTime?: string | null; + createTime?: string | null; + /** + * Operation last update time. If the operation is done, this is also the finish time. + */ + updateTime?: string | null; + } + /** + * Information of an end user. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaUserInfo { + /** + * 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. + */ + userAgent?: string | null; /** - * Operation last update time. If the operation is done, this is also the finish time. + * 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. */ - updateTime?: string | null; + userId?: string | null; } /** * BigQuery source import data from. @@ -4547,7 +5954,7 @@ export namespace discoveryengine_v1 { */ name?: string | null; /** - * 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 or layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and or layout parsing are supported. + * 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. */ parsingConfigOverrides?: { [ @@ -5776,6 +7183,18 @@ export namespace discoveryengine_v1 { * Whether to turn on safe search. This is only supported for website search. */ safeSearch?: boolean | null; + /** + * Search as you type configuration. Only supported for the IndustryVertical.MEDIA vertical. + */ + searchAsYouTypeSpec?: Schema$GoogleCloudDiscoveryengineV1SearchRequestSearchAsYouTypeSpec; + /** + * 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. + */ + session?: string | null; + /** + * Session specification. Can be used only when `session` is set. + */ + sessionSpec?: Schema$GoogleCloudDiscoveryengineV1SearchRequestSessionSpec; /** * The spell correction specification that specifies the mode under which spell correction takes effect. */ @@ -5828,7 +7247,7 @@ export namespace discoveryengine_v1 { */ extractiveContentSpec?: Schema$GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecExtractiveContentSpec; /** - * Specifies the search result mode. If unspecified, the search result mode is based on DataStore.DocumentProcessingConfig.chunking_config: * If DataStore.DocumentProcessingConfig.chunking_config is specified, it defaults to `CHUNKS`. * Otherwise, it defaults to `DOCUMENTS`. + * Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`. */ searchResultMode?: string | null; /** @@ -5951,7 +7370,7 @@ export namespace discoveryengine_v1 { version?: string | null; } /** - * A struct to define data stores to filter on in a search call and configurations for those data stores. A maximum of 1 DataStoreSpec per data_store is allowed. Otherwise, an `INVALID_ARGUMENT` error is returned. + * 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. */ export interface Schema$GoogleCloudDiscoveryengineV1SearchRequestDataStoreSpec { /** @@ -6035,6 +7454,28 @@ export namespace discoveryengine_v1 { */ pinUnexpandedResults?: boolean | null; } + /** + * Specification for search as you type in search requests. + */ + export interface Schema$GoogleCloudDiscoveryengineV1SearchRequestSearchAsYouTypeSpec { + /** + * The condition under which search as you type should occur. Default to Condition.DISABLED. + */ + condition?: string | null; + } + /** + * 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. + */ + export interface Schema$GoogleCloudDiscoveryengineV1SearchRequestSessionSpec { + /** + * 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. + */ + queryId?: string | null; + /** + * 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. + */ + searchResultPersistenceCount?: number | null; + } /** * The specification for query spell correction. */ @@ -6076,6 +7517,10 @@ export namespace discoveryengine_v1 { * A list of matched documents. The order represents the ranking. */ results?: Schema$GoogleCloudDiscoveryengineV1SearchResponseSearchResult[]; + /** + * Session information. Only set if SearchRequest.session is provided. See its description for more details. + */ + sessionInfo?: Schema$GoogleCloudDiscoveryengineV1SearchResponseSessionInfo; /** * A summary as part of the search results. This field is only returned if SearchRequest.ContentSearchSpec.summary_spec is set. */ @@ -6149,6 +7594,19 @@ export namespace discoveryengine_v1 { */ id?: string | null; } + /** + * Information about the session. + */ + export interface Schema$GoogleCloudDiscoveryengineV1SearchResponseSessionInfo { + /** + * Name of the session. If the auto-session mode is used (when SearchRequest.session ends with "-"), this field holds the newly generated session name. + */ + name?: string | null; + /** + * 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. + */ + queryId?: string | null; + } /** * Summary of the top N search results specified by the summary spec. */ @@ -6808,6 +8266,7 @@ export namespace discoveryengine_v1 { collections: Resource$Projects$Locations$Collections; dataStores: Resource$Projects$Locations$Datastores; groundingConfigs: Resource$Projects$Locations$Groundingconfigs; + identity_mapping_stores: Resource$Projects$Locations$Identity_mapping_stores; operations: Resource$Projects$Locations$Operations; rankingConfigs: Resource$Projects$Locations$Rankingconfigs; userEvents: Resource$Projects$Locations$Userevents; @@ -6822,6 +8281,8 @@ export namespace discoveryengine_v1 { this.groundingConfigs = new Resource$Projects$Locations$Groundingconfigs( this.context ); + this.identity_mapping_stores = + new Resource$Projects$Locations$Identity_mapping_stores(this.context); this.operations = new Resource$Projects$Locations$Operations( this.context ); @@ -25343,6 +26804,245 @@ export namespace discoveryengine_v1 { requestBody?: Schema$GoogleCloudDiscoveryengineV1CheckGroundingRequest; } + export class Resource$Projects$Locations$Identity_mapping_stores { + context: APIRequestContext; + operations: Resource$Projects$Locations$Identity_mapping_stores$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.operations = + new Resource$Projects$Locations$Identity_mapping_stores$Operations( + this.context + ); + } + } + + export class Resource$Projects$Locations$Identity_mapping_stores$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * 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. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Projects$Locations$Identity_mapping_stores$Operations$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Identity_mapping_stores$Operations$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Identity_mapping_stores$Operations$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Identity_mapping_stores$Operations$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Identity_mapping_stores$Operations$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Identity_mapping_stores$Operations$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Identity_mapping_stores$Operations$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Identity_mapping_stores$Operations$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Locations$Identity_mapping_stores$Operations$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Identity_mapping_stores$Operations$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Identity_mapping_stores$Operations$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Identity_mapping_stores$Operations$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Identity_mapping_stores$Operations$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Identity_mapping_stores$Operations$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Identity_mapping_stores$Operations$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Identity_mapping_stores$Operations$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}/operations').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Projects$Locations$Identity_mapping_stores$Operations$Get + extends StandardParameters { + /** + * The name of the operation resource. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Identity_mapping_stores$Operations$List + extends StandardParameters { + /** + * The standard list filter. + */ + filter?: string; + /** + * The name of the operation's parent resource. + */ + name?: string; + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. + */ + pageToken?: string; + } + export class Resource$Projects$Locations$Operations { context: APIRequestContext; constructor(context: APIRequestContext) { diff --git a/src/apis/discoveryengine/v1alpha.ts b/src/apis/discoveryengine/v1alpha.ts index b22e3d126e..ac50500fe7 100644 --- a/src/apis/discoveryengine/v1alpha.ts +++ b/src/apis/discoveryengine/v1alpha.ts @@ -683,7 +683,7 @@ export namespace discoveryengine_v1alpha { */ orderBy?: string | null; /** - * Specifies the search result mode. If unspecified, the search result mode is based on DataStore.DocumentProcessingConfig.chunking_config: * If DataStore.DocumentProcessingConfig.chunking_config is specified, it defaults to `CHUNKS`. * Otherwise, it defaults to `DOCUMENTS`. See [parse and chunk documents](https://cloud.google.com/generative-ai-app-builder/docs/parse-chunk-documents) + * 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) */ searchResultMode?: string | null; } @@ -795,7 +795,7 @@ export namespace discoveryengine_v1alpha { */ export interface Schema$GoogleCloudDiscoveryengineV1alphaAnswerQueryResponse { /** - * Answer resource object. If AnswerQueryRequest.StepSpec.max_step_count is greater than 1, use Answer.name to fetch answer information using ConversationalSearchService.GetAnswer API. + * 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. */ answer?: Schema$GoogleCloudDiscoveryengineV1alphaAnswer; /** @@ -982,6 +982,10 @@ export namespace discoveryengine_v1alpha { * If citation_type is DOCUMENT_LEVEL_CITATION, populate document level snippets. */ snippetInfo?: Schema$GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultSnippetInfo[]; + /** + * 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 . + */ + structData?: {[key: string]: any} | null; /** * Title. */ @@ -1255,7 +1259,7 @@ export namespace discoveryengine_v1alpha { */ requirementType?: string | null; /** - * The type needed for the monitored resources: * `discoveryengine.googleapis.com/Branch`. * The labels needed for this resource: * `project_number` * `location_id` * `collection_id` * `datastore_id` * `branch_id` * `discoveryengine.googleapis.com/DataStore` * The labels needed for this resource: * `project_number` * `location_id` * `collection_id` * `datastore_id` + * The type needed for the monitored resources: * `discoveryengine.googleapis.com/Branch`. * The labels needed for this resource: * `project`_`number` * `location`_`id` * `collection`_`id` * `datastore`_`id` * `branch`_`id` * `discoveryengine.googleapis.com/DataStore` * The labels needed for this resource: * `project`_`number` * `location`_`id` * `collection`_`id` * `datastore`_`id` */ resources?: Schema$GoogleApiMonitoredResource[]; } @@ -1765,6 +1769,10 @@ export namespace discoveryengine_v1alpha { */ updateTime?: string | null; } + /** + * Metadata for EvaluationService.CreateEvaluation method. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaCreateEvaluationMetadata {} /** * Metadata for Create Schema LRO. */ @@ -1838,6 +1846,10 @@ export namespace discoveryengine_v1alpha { * The display name of the model. */ displayName?: string | null; + /** + * The metrics of the trained model. + */ + metrics?: {[key: string]: number} | null; /** * The state that the model is in (e.g.`TRAINING` or `TRAINING_FAILED`). */ @@ -2103,7 +2115,7 @@ export namespace discoveryengine_v1alpha { */ name?: string | null; /** - * 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 or layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and or layout parsing are supported. + * 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. */ parsingConfigOverrides?: { [ @@ -2469,6 +2481,91 @@ export namespace discoveryengine_v1alpha { */ documentCount?: string | null; } + /** + * An evaluation is a single execution (or run) of an evaluation process. It encapsulates the state of the evaluation and the resulting data. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaEvaluation { + /** + * Output only. Timestamp the Evaluation was created at. + */ + createTime?: string | null; + /** + * Output only. Timestamp the Evaluation was completed at. + */ + endTime?: string | null; + /** + * Output only. The error that occurred during evaluation. Only populated when the evaluation's state is FAILED. + */ + error?: Schema$GoogleRpcStatus; + /** + * Output only. A sample of errors encountered while processing the request. + */ + errorSamples?: Schema$GoogleRpcStatus[]; + /** + * Required. The specification of the evaluation. + */ + evaluationSpec?: Schema$GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpec; + /** + * Immutable. 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. + */ + name?: string | null; + /** + * Output only. The metrics produced by the evaluation, averaged across all SampleQuerys in the SampleQuerySet. Only populated when the evaluation's state is SUCCEEDED. + */ + qualityMetrics?: Schema$GoogleCloudDiscoveryengineV1alphaQualityMetrics; + /** + * Output only. The state of the evaluation. + */ + state?: string | null; + } + /** + * Describes the specification of the evaluation. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpec { + /** + * Required. The specification of the query set. + */ + querySetSpec?: Schema$GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpecQuerySetSpec; + /** + * 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 + */ + searchRequest?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequest; + } + /** + * Describes the specification of the query set. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpecQuerySetSpec { + /** + * Required. The full resource name of the SampleQuerySet used for the evaluation, in the format of `projects/{project\}/locations/{location\}/sampleQuerySets/{sampleQuerySet\}`. + */ + sampleQuerySet?: string | null; + } + /** + * Metadata related to the progress of the Export operation. This is returned by the google.longrunning.Operation.metadata field. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaExportUserEventsMetadata { + /** + * Operation create time. + */ + createTime?: string | null; + /** + * Operation last update time. If the operation is done, this is also the finish time. + */ + updateTime?: string | null; + } + /** + * Response of the ExportUserEventsRequest. If the long running operation was successful, then this message is returned by the google.longrunning.Operations.response field. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaExportUserEventsResponse { + /** + * Output result indicating where the data were exported to. + */ + outputResult?: Schema$GoogleCloudDiscoveryengineV1alphaOutputResult; + /** + * The status of the export operation. + */ + status?: Schema$GoogleRpcStatus; + } /** * Fact Chunk. */ @@ -2603,6 +2700,15 @@ export namespace discoveryengine_v1alpha { */ inputUris?: string[] | null; } + /** + * Response message for SiteSearchEngineService.GetUriPatternDocumentData method. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaGetUriPatternDocumentDataResponse { + /** + * Document data keyed by URI pattern. For example: document_data_map = { "www.url1.com/x": { "Categories": ["category1", "category2"] \}, "www.url2.com/x": { "Categories": ["category3"] \} \} + */ + documentDataMap?: {[key: string]: {[key: string]: any}} | null; + } /** * Grounding Fact. */ @@ -2836,6 +2942,74 @@ export namespace discoveryengine_v1alpha { */ gcsPrefix?: string | null; } + /** + * Metadata related to the progress of the ImportSampleQueries operation. This will be returned by the google.longrunning.Operation.metadata field. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaImportSampleQueriesMetadata { + /** + * ImportSampleQueries operation create time. + */ + createTime?: string | null; + /** + * Count of SampleQuerys that failed to be imported. + */ + failureCount?: string | null; + /** + * Count of SampleQuerys successfully imported. + */ + successCount?: string | null; + /** + * Total count of SampleQuerys that were processed. + */ + totalCount?: string | null; + /** + * ImportSampleQueries operation last update time. If the operation is done, this is also the finish time. + */ + updateTime?: string | null; + } + /** + * Request message for SampleQueryService.ImportSampleQueries method. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaImportSampleQueriesRequest { + /** + * BigQuery input source. + */ + bigquerySource?: Schema$GoogleCloudDiscoveryengineV1alphaBigQuerySource; + /** + * The desired location of errors incurred during the Import. + */ + errorConfig?: Schema$GoogleCloudDiscoveryengineV1alphaImportErrorConfig; + /** + * Cloud Storage location for the input content. + */ + gcsSource?: Schema$GoogleCloudDiscoveryengineV1alphaGcsSource; + /** + * The Inline source for sample query entries. + */ + inlineSource?: Schema$GoogleCloudDiscoveryengineV1alphaImportSampleQueriesRequestInlineSource; + } + /** + * The inline source for SampleQuerys. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaImportSampleQueriesRequestInlineSource { + /** + * Required. A list of SampleQuerys to import. Max of 1000 items. + */ + sampleQueries?: Schema$GoogleCloudDiscoveryengineV1alphaSampleQuery[]; + } + /** + * 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. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaImportSampleQueriesResponse { + /** + * The desired location of errors incurred during the Import. + */ + errorConfig?: Schema$GoogleCloudDiscoveryengineV1alphaImportErrorConfig; + /** + * A sample of errors encountered while processing the request. + */ + errorSamples?: Schema$GoogleRpcStatus[]; + } /** * Metadata related to the progress of the ImportSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field. */ @@ -3089,6 +3263,71 @@ export namespace discoveryengine_v1alpha { */ nextPageToken?: string | null; } + /** + * Response message for EvaluationService.ListEvaluationResults method. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaListEvaluationResultsResponse { + /** + * The EvaluationResults. + */ + evaluationResults?: Schema$GoogleCloudDiscoveryengineV1alphaListEvaluationResultsResponseEvaluationResult[]; + /** + * A token that can be sent as ListEvaluationResultsRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages. + */ + nextPageToken?: string | null; + } + /** + * Represents the results of an evaluation for a single SampleQuery. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaListEvaluationResultsResponseEvaluationResult { + /** + * Output only. The metrics produced by the evaluation, for a given SampleQuery. + */ + qualityMetrics?: Schema$GoogleCloudDiscoveryengineV1alphaQualityMetrics; + /** + * Output only. The SampleQuery that was evaluated. + */ + sampleQuery?: Schema$GoogleCloudDiscoveryengineV1alphaSampleQuery; + } + /** + * Response message for EvaluationService.ListEvaluations method. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaListEvaluationsResponse { + /** + * The Evaluations. + */ + evaluations?: Schema$GoogleCloudDiscoveryengineV1alphaEvaluation[]; + /** + * A token that can be sent as ListEvaluationsRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages. + */ + nextPageToken?: string | null; + } + /** + * Response message for SampleQueryService.ListSampleQueries method. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaListSampleQueriesResponse { + /** + * A token that can be sent as ListSampleQueriesRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages. + */ + nextPageToken?: string | null; + /** + * The SampleQuerys. + */ + sampleQueries?: Schema$GoogleCloudDiscoveryengineV1alphaSampleQuery[]; + } + /** + * Response message for SampleQuerySetService.ListSampleQuerySets method. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaListSampleQuerySetsResponse { + /** + * A token that can be sent as ListSampleQuerySetsRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages. + */ + nextPageToken?: string | null; + /** + * The SampleQuerySets. + */ + sampleQuerySets?: Schema$GoogleCloudDiscoveryengineV1alphaSampleQuerySet[]; + } /** * Response message for SchemaService.ListSchemas method. */ @@ -3158,6 +3397,28 @@ export namespace discoveryengine_v1alpha { */ mediaProgressPercentage?: number | null; } + /** + * Output result that stores the information about where the exported data is stored. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaOutputResult { + /** + * The BigQuery location where the result is stored. + */ + bigqueryResult?: Schema$GoogleCloudDiscoveryengineV1alphaOutputResultBigQueryOutputResult; + } + /** + * A BigQuery output result. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaOutputResultBigQueryOutputResult { + /** + * The ID of a BigQuery Dataset. + */ + datasetId?: string | null; + /** + * The ID of a BigQuery Table. + */ + tableId?: string | null; + } /** * Detailed page information. */ @@ -3468,6 +3729,52 @@ export namespace discoveryengine_v1alpha { */ purgeCount?: string | null; } + /** + * Describes the metrics produced by the evaluation. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaQualityMetrics { + /** + * 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 + */ + docNdcg?: Schema$GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics; + /** + * 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 + */ + docPrecision?: Schema$GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics; + /** + * 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 + */ + docRecall?: Schema$GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics; + /** + * 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 + */ + pageNdcg?: Schema$GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics; + /** + * 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 + */ + pageRecall?: Schema$GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics; + } + /** + * Stores the metric values at specific top-k levels. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics { + /** + * The top-1 value. + */ + top1?: number | null; + /** + * The top-10 value. + */ + top10?: number | null; + /** + * The top-3 value. + */ + top3?: number | null; + /** + * The top-5 value. + */ + top5?: number | null; + } /** * Defines a user inputed query. */ @@ -3843,6 +4150,74 @@ export namespace discoveryengine_v1alpha { * Request for resuming training of an engine. */ export interface Schema$GoogleCloudDiscoveryengineV1alphaResumeEngineRequest {} + /** + * Sample Query captures metadata to be used for evaluation. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaSampleQuery { + /** + * Output only. Timestamp the SampleQuery was created at. + */ + createTime?: string | null; + /** + * Immutable. The full resource name of the sample query, in the format of `projects/{project\}/locations/{location\}/sampleQuerySets/{sampleQuerySet\}/sampleQueries/{sampleQuery\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. + */ + name?: string | null; + /** + * The query entry. + */ + queryEntry?: Schema$GoogleCloudDiscoveryengineV1alphaSampleQueryQueryEntry; + } + /** + * Query Entry captures metadata to be used for search evaluation. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaSampleQueryQueryEntry { + /** + * Required. The query. + */ + query?: string | null; + /** + * List of targets for the query. + */ + targets?: Schema$GoogleCloudDiscoveryengineV1alphaSampleQueryQueryEntryTarget[]; + } + /** + * Defines the parameters of the query's expected outcome. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaSampleQueryQueryEntryTarget { + /** + * Expected page numbers of the target. Each page number must be non negative. + */ + pageNumbers?: number[] | null; + /** + * Relevance score of the target. + */ + score?: number | null; + /** + * Expected uri of the target. This field must be a UTF-8 encoded string with a length limit of 2048 characters. Example of valid uris: `https://example.com/abc`, `gcs://example/example.pdf`. + */ + uri?: string | null; + } + /** + * A SampleQuerySet is the parent resource of SampleQuery, and contains the configurations shared by all SampleQuery under it. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaSampleQuerySet { + /** + * Output only. Timestamp the SampleQuerySet was created at. + */ + createTime?: string | null; + /** + * The description of the SampleQuerySet. + */ + description?: string | null; + /** + * Required. The sample query set display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. + */ + displayName?: string | null; + /** + * Immutable. The full resource name of the SampleQuerySet, in the format of `projects/{project\}/locations/{location\}/sampleQuerySets/{sampleQuerySet\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. + */ + name?: string | null; + } /** * Defines the structure and layout of a type of document data. */ @@ -3902,7 +4277,7 @@ export namespace discoveryengine_v1alpha { */ contentSearchSpec?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpec; /** - * Custom fine tuning configs. + * Custom fine tuning configs. If set, it has higher priority than the configs set in ServingConfig.custom_fine_tuning_spec. */ customFineTuningSpec?: Schema$GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec; /** @@ -3929,6 +4304,10 @@ export namespace discoveryengine_v1alpha { * 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. */ languageCode?: string | null; + /** + * If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done. + */ + naturalLanguageQueryUnderstandingSpec?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestNaturalLanguageQueryUnderstandingSpec; /** * 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. */ @@ -3958,7 +4337,7 @@ export namespace discoveryengine_v1alpha { */ queryExpansionSpec?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestQueryExpansionSpec; /** - * 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 joint 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 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)`. */ rankingExpression?: string | null; /** @@ -3977,6 +4356,18 @@ export namespace discoveryengine_v1alpha { * Search as you type configuration. Only supported for the IndustryVertical.MEDIA vertical. */ searchAsYouTypeSpec?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAsYouTypeSpec; + /** + * Required. The resource name of the Search serving config, such as `projects/x/locations/global/collections/default_collection/engines/x/servingConfigs/default_serving_config`, or `projects/x/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. + */ + servingConfig?: string | null; + /** + * 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. + */ + session?: string | null; + /** + * Session specification. Can be used only when `session` is set. + */ + sessionSpec?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestSessionSpec; /** * The spell correction specification that specifies the mode under which spell correction takes effect. */ @@ -4067,7 +4458,7 @@ export namespace discoveryengine_v1alpha { */ extractiveContentSpec?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecExtractiveContentSpec; /** - * Specifies the search result mode. If unspecified, the search result mode is based on DataStore.DocumentProcessingConfig.chunking_config: * If DataStore.DocumentProcessingConfig.chunking_config is specified, it defaults to `CHUNKS`. * Otherwise, it defaults to `DOCUMENTS`. + * Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`. */ searchResultMode?: string | null; /** @@ -4190,7 +4581,7 @@ export namespace discoveryengine_v1alpha { version?: string | null; } /** - * A struct to define data stores to filter on in a search call and configurations for those data stores. A maximum of 1 DataStoreSpec per data_store is allowed. Otherwise, an `INVALID_ARGUMENT` error is returned. + * 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. */ export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec { /** @@ -4284,7 +4675,20 @@ export namespace discoveryengine_v1alpha { imageBytes?: string | null; } /** - * Specification to determine under which conditions query expansion should occur. + * Specification to enable natural language understanding capabilities for search requests. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestNaturalLanguageQueryUnderstandingSpec { + /** + * The condition under which filter extraction should occur. Default to Condition.DISABLED. + */ + filterExtractionCondition?: string | null; + /** + * 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. + */ + geoSearchQueryDetectionFieldNames?: string[] | null; + } + /** + * Specification to determine under which conditions query expansion should occur. */ export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestQueryExpansionSpec { /** @@ -4305,6 +4709,19 @@ export namespace discoveryengine_v1alpha { */ condition?: string | null; } + /** + * 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. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestSessionSpec { + /** + * 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. + */ + queryId?: string | null; + /** + * 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. + */ + searchResultPersistenceCount?: number | null; + } /** * The specification for query spell correction. */ @@ -4339,6 +4756,10 @@ export namespace discoveryengine_v1alpha { * Guided search result. */ guidedSearchResult?: Schema$GoogleCloudDiscoveryengineV1alphaSearchResponseGuidedSearchResult; + /** + * Natural language query understanding information for the returned results. + */ + naturalLanguageQueryUnderstandingInfo?: Schema$GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfo; /** * 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. */ @@ -4355,6 +4776,10 @@ export namespace discoveryengine_v1alpha { * A list of matched documents. The order represents the ranking. */ results?: Schema$GoogleCloudDiscoveryengineV1alphaSearchResponseSearchResult[]; + /** + * Session information. Only set if SearchRequest.session is provided. See its description for more details. + */ + sessionInfo?: Schema$GoogleCloudDiscoveryengineV1alphaSearchResponseSessionInfo; /** * A summary as part of the search results. This field is only returned if SearchRequest.ContentSearchSpec.summary_spec is set. */ @@ -4437,6 +4862,122 @@ export namespace discoveryengine_v1alpha { */ attributeValue?: string | null; } + /** + * Information describing what natural language understanding was done on the input query. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfo { + /** + * The filters that were extracted from the input query. + */ + extractedFilters?: string | null; + /** + * Rewritten input query minus the extracted filters. + */ + rewrittenQuery?: string | null; + /** + * The filters that were extracted from the input query represented in a structured form. + */ + structuredExtractedFilter?: Schema$GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilter; + } + /** + * The filters that were extracted from the input query represented in a structured form. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilter { + /** + * The expression denoting the filter that was extracted from the input query in a structured form. It can be a simple expression denoting a single string, numerical or geolocation constraint or a compound expression which is a combination of multiple expressions connected using logical (OR and AND) operators. + */ + expression?: Schema$GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterExpression; + } + /** + * Logical `And` operator. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterAndExpression { + /** + * The expressions that were ANDed together. + */ + expressions?: Schema$GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterExpression[]; + } + /** + * The expression denoting the filter that was extracted from the input query. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterExpression { + /** + * Logical "And" compound operator connecting multiple expressions. + */ + andExpr?: Schema$GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterAndExpression; + /** + * Geolocation constraint expression. + */ + geolocationConstraint?: Schema$GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterGeolocationConstraint; + /** + * Numerical constraint expression. + */ + numberConstraint?: Schema$GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterNumberConstraint; + /** + * Logical "Or" compound operator connecting multiple expressions. + */ + orExpr?: Schema$GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterOrExpression; + /** + * String constraint expression. + */ + stringConstraint?: Schema$GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterStringConstraint; + } + /** + * Constraint of a geolocation field. Name of the geolocation field as defined in the schema. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterGeolocationConstraint { + /** + * The reference address that was inferred from the input query. The proximity of the reference address to the geolocation field will be used to filter the results. + */ + address?: string | null; + /** + * The name of the geolocation field as defined in the schema. + */ + fieldName?: string | null; + /** + * The radius in meters around the address. The record is returned if the location of the geolocation field is within the radius. + */ + radiusInMeters?: number | null; + } + /** + * Constraint expression of a number field. Example: price < 100. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterNumberConstraint { + /** + * The comparison operation performed between the field value and the value specified in the constraint. + */ + comparison?: string | null; + /** + * Name of the numerical field as defined in the schema. + */ + fieldName?: string | null; + /** + * The value specified in the numerical constraint. + */ + value?: number | null; + } + /** + * Logical `Or` operator. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterOrExpression { + /** + * The expressions that were ORed together. + */ + expressions?: Schema$GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterExpression[]; + } + /** + * Constraint expression of a string field. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterStringConstraint { + /** + * Name of the string field as defined in the schema. + */ + fieldName?: string | null; + /** + * Values of the string field. The record will only be returned if the field value matches one of the values specified here. + */ + values?: string[] | null; + } /** * Information describing query expansion including whether expansion has occurred. */ @@ -4473,6 +5014,19 @@ export namespace discoveryengine_v1alpha { [key: string]: Schema$GoogleCloudDiscoveryengineV1alphaDoubleList; } | null; } + /** + * Information about the session. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchResponseSessionInfo { + /** + * Name of the session. If the auto-session mode is used (when SearchRequest.session ends with "-"), this field holds the newly generated session name. + */ + name?: string | null; + /** + * 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. + */ + queryId?: string | null; + } /** * Summary of the top N search results specified by the summary spec. */ @@ -4606,7 +5160,7 @@ export namespace discoveryengine_v1alpha { */ createTime?: string | null; /** - * Custom fine tuning configs. + * Custom fine tuning configs. If SearchRequest.custom_fine_tuning_spec is set, it has higher priority than the configs set here. */ customFineTuningSpec?: Schema$GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec; /** @@ -4658,7 +5212,7 @@ export namespace discoveryengine_v1alpha { */ onewaySynonymsControlIds?: string[] | null; /** - * 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). + * 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)`. */ rankingExpression?: string | null; /** @@ -4754,6 +5308,40 @@ export namespace discoveryengine_v1alpha { */ query?: Schema$GoogleCloudDiscoveryengineV1alphaQuery; } + /** + * Metadata related to the progress of the SiteSearchEngineService.SetUriPatternDocumentData operation. This will be returned by the google.longrunning.Operation.metadata field. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaSetUriPatternDocumentDataMetadata { + /** + * Operation create time. + */ + createTime?: string | null; + /** + * Operation last update time. If the operation is done, this is also the finish time. + */ + updateTime?: string | null; + } + /** + * Request message for SiteSearchEngineService.SetUriPatternDocumentData method. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaSetUriPatternDocumentDataRequest { + /** + * Document data keyed by URI pattern. Each entry must be consistent with the Schema. For example: Schema = { "type": "object", "properties": { "Categories": { "type": "array", "items": { "retrievable": true, "type": "string" \} \} \} document_data_map = { "www.url1.com/x": { "Categories": ["category1", "category2"] \}, "www.url2.com/x": { "Categories": ["category3"] \} \} + */ + documentDataMap?: {[key: string]: {[key: string]: any}} | null; + /** + * If true, clears the document data map. If true, SetUriPatternDocumentDataRequest.document_data_map must be empty. + */ + emptyDocumentDataMap?: boolean | null; + /** + * Optional. If not provided, the current Schema is used. If provided, validates and updates the Schema. If validation fails, an error is returned. + */ + schema?: {[key: string]: any} | null; + } + /** + * Response message for SiteSearchEngineService.SetUriPatternDocumentData method. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaSetUriPatternDocumentDataResponse {} /** * SiteSearchEngine captures DataStore level site search persisting configurations. It is a singleton value per data store. */ @@ -5344,6 +5932,10 @@ export namespace discoveryengine_v1alpha { */ updateTime?: string | null; } + /** + * Metadata for EvaluationService.CreateEvaluation method. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaCreateEvaluationMetadata {} /** * Metadata for Create Schema LRO. */ @@ -5382,6 +5974,10 @@ export namespace discoveryengine_v1alpha { * The display name of the model. */ displayName?: string | null; + /** + * The metrics of the trained model. + */ + metrics?: {[key: string]: number} | null; /** * The state that the model is in (e.g.`TRAINING` or `TRAINING_FAILED`). */ @@ -5530,7 +6126,7 @@ export namespace discoveryengine_v1alpha { */ name?: string | null; /** - * 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 or layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and or layout parsing are supported. + * 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. */ parsingConfigOverrides?: { [ @@ -5729,6 +6325,65 @@ export namespace discoveryengine_v1alpha { */ searchTier?: string | null; } + /** + * An evaluation is a single execution (or run) of an evaluation process. It encapsulates the state of the evaluation and the resulting data. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaEvaluation { + /** + * Output only. Timestamp the Evaluation was created at. + */ + createTime?: string | null; + /** + * Output only. Timestamp the Evaluation was completed at. + */ + endTime?: string | null; + /** + * Output only. The error that occurred during evaluation. Only populated when the evaluation's state is FAILED. + */ + error?: Schema$GoogleRpcStatus; + /** + * Output only. A sample of errors encountered while processing the request. + */ + errorSamples?: Schema$GoogleRpcStatus[]; + /** + * Required. The specification of the evaluation. + */ + evaluationSpec?: Schema$GoogleCloudDiscoveryengineV1betaEvaluationEvaluationSpec; + /** + * Immutable. 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. + */ + name?: string | null; + /** + * Output only. The metrics produced by the evaluation, averaged across all SampleQuerys in the SampleQuerySet. Only populated when the evaluation's state is SUCCEEDED. + */ + qualityMetrics?: Schema$GoogleCloudDiscoveryengineV1betaQualityMetrics; + /** + * Output only. The state of the evaluation. + */ + state?: string | null; + } + /** + * Describes the specification of the evaluation. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaEvaluationEvaluationSpec { + /** + * Required. The specification of the query set. + */ + querySetSpec?: Schema$GoogleCloudDiscoveryengineV1betaEvaluationEvaluationSpecQuerySetSpec; + /** + * 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 + */ + searchRequest?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequest; + } + /** + * Describes the specification of the query set. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaEvaluationEvaluationSpecQuerySetSpec { + /** + * Required. The full resource name of the SampleQuerySet used for the evaluation, in the format of `projects/{project\}/locations/{location\}/sampleQuerySets/{sampleQuerySet\}`. + */ + sampleQuerySet?: string | null; + } /** * Metadata related to the progress of the ImportCompletionSuggestions operation. This will be returned by the google.longrunning.Operation.metadata field. */ @@ -5810,6 +6465,44 @@ export namespace discoveryengine_v1alpha { */ gcsPrefix?: string | null; } + /** + * Metadata related to the progress of the ImportSampleQueries operation. This will be returned by the google.longrunning.Operation.metadata field. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaImportSampleQueriesMetadata { + /** + * ImportSampleQueries operation create time. + */ + createTime?: string | null; + /** + * Count of SampleQuerys that failed to be imported. + */ + failureCount?: string | null; + /** + * Count of SampleQuerys successfully imported. + */ + successCount?: string | null; + /** + * Total count of SampleQuerys that were processed. + */ + totalCount?: string | null; + /** + * ImportSampleQueries operation last update time. If the operation is done, this is also the finish time. + */ + updateTime?: string | null; + } + /** + * 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. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaImportSampleQueriesResponse { + /** + * The desired location of errors incurred during the Import. + */ + errorConfig?: Schema$GoogleCloudDiscoveryengineV1betaImportErrorConfig; + /** + * A sample of errors encountered while processing the request. + */ + errorSamples?: Schema$GoogleRpcStatus[]; + } /** * Metadata related to the progress of the ImportSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field. */ @@ -5882,6 +6575,27 @@ export namespace discoveryengine_v1alpha { */ unjoinedEventsCount?: string | null; } + /** + * A floating point interval. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaInterval { + /** + * Exclusive upper bound. + */ + exclusiveMaximum?: number | null; + /** + * Exclusive lower bound. + */ + exclusiveMinimum?: number | null; + /** + * Inclusive upper bound. + */ + maximum?: number | null; + /** + * Inclusive lower bound. + */ + minimum?: number | null; + } /** * Language info for DataStore. */ @@ -6029,958 +6743,850 @@ export namespace discoveryengine_v1alpha { purgeCount?: string | null; } /** - * Defines the structure and layout of a type of document data. + * Describes the metrics produced by the evaluation. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaSchema { + export interface Schema$GoogleCloudDiscoveryengineV1betaQualityMetrics { /** - * The JSON representation of the schema. + * 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 */ - jsonSchema?: string | null; + docNdcg?: Schema$GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics; /** - * 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. + * 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 */ - name?: string | null; + docPrecision?: Schema$GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics; /** - * The structured representation of the schema. + * 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 */ - structSchema?: {[key: string]: any} | null; - } - /** - * Verification information for target sites in advanced site search. - */ - export interface Schema$GoogleCloudDiscoveryengineV1betaSiteVerificationInfo { + docRecall?: Schema$GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics; /** - * Site verification state indicating the ownership and validity. + * 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 */ - siteVerificationState?: string | null; + pageNdcg?: Schema$GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics; /** - * Latest site verification time. + * 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 */ - verifyTime?: string | null; + pageRecall?: Schema$GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics; } /** - * A target site for the SiteSearchEngine. + * Stores the metric values at specific top-k levels. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaTargetSite { - /** - * 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. - */ - exactMatch?: boolean | null; + export interface Schema$GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics { /** - * Output only. Failure reason. + * The top-1 value. */ - failureReason?: Schema$GoogleCloudDiscoveryengineV1betaTargetSiteFailureReason; + top1?: number | null; /** - * Output only. This is system-generated based on the provided_uri_pattern. + * The top-10 value. */ - generatedUriPattern?: string | null; + top10?: number | null; /** - * Output only. Indexing status. + * The top-3 value. */ - indexingStatus?: string | null; + top3?: number | null; /** - * 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. + * The top-5 value. */ - name?: string | null; + top5?: number | null; + } + /** + * Defines the structure and layout of a type of document data. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaSchema { /** - * Required. Input only. The user provided URI pattern from which the `generated_uri_pattern` is generated. + * The JSON representation of the schema. */ - providedUriPattern?: string | null; + jsonSchema?: string | null; /** - * Output only. Root domain of the provided_uri_pattern. + * 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. */ - rootDomainUri?: string | null; + name?: string | null; /** - * Output only. Site ownership and validity verification status. + * The structured representation of the schema. */ - siteVerificationInfo?: Schema$GoogleCloudDiscoveryengineV1betaSiteVerificationInfo; - /** - * The type of the target site, e.g., whether the site is to be included or excluded. - */ - type?: string | null; - /** - * Output only. The target site's last updated time. - */ - updateTime?: string | null; + structSchema?: {[key: string]: any} | null; } /** - * Site search indexing failure reasons. + * Request message for SearchService.Search method. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaTargetSiteFailureReason { + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequest { /** - * Failed due to insufficient quota. + * 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) */ - quotaFailure?: Schema$GoogleCloudDiscoveryengineV1betaTargetSiteFailureReasonQuotaFailure; - } - /** - * Failed due to insufficient quota. - */ - export interface Schema$GoogleCloudDiscoveryengineV1betaTargetSiteFailureReasonQuotaFailure { + boostSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpec; /** - * This number is an estimation on how much total quota this project needs to successfully complete indexing. + * The branch resource name, such as `projects/x/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. */ - totalRequiredQuota?: string | null; - } - /** - * Metadata related to the progress of the TrainCustomModel operation. This is returned by the google.longrunning.Operation.metadata field. - */ - export interface Schema$GoogleCloudDiscoveryengineV1betaTrainCustomModelMetadata { + branch?: string | null; /** - * Operation create time. + * 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. */ - createTime?: string | null; + canonicalFilter?: string | null; /** - * Operation last update time. If the operation is done, this is also the finish time. + * A specification for configuring the behavior of content search. */ - updateTime?: string | null; - } - /** - * Response of the TrainCustomModelRequest. This message is returned by the google.longrunning.Operations.response field. - */ - export interface Schema$GoogleCloudDiscoveryengineV1betaTrainCustomModelResponse { + contentSearchSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpec; /** - * Echoes the destination for the complete errors in the request if set. + * 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. */ - errorConfig?: Schema$GoogleCloudDiscoveryengineV1betaImportErrorConfig; + dataStoreSpecs?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec[]; /** - * A sample of errors encountered while processing the data. + * 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. */ - errorSamples?: Schema$GoogleRpcStatus[]; + embeddingSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpec; /** - * The metrics of the trained model. + * 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. */ - metrics?: {[key: string]: number} | null; + facetSpecs?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestFacetSpec[]; /** - * Fully qualified name of the CustomTuningModel. + * 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) */ - modelName?: string | null; + filter?: string | null; /** - * 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. + * Raw image query. */ - modelStatus?: string | null; - } - /** - * Metadata associated with a tune operation. - */ - export interface Schema$GoogleCloudDiscoveryengineV1betaTuneEngineMetadata { + imageQuery?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestImageQuery; /** - * Required. The resource name of the engine that this tune applies to. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/engines/{engine_id\}` + * 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. */ - engine?: string | null; - } - /** - * Response associated with a tune operation. - */ - export interface Schema$GoogleCloudDiscoveryengineV1betaTuneEngineResponse {} - /** - * Metadata for UpdateSchema LRO. - */ - export interface Schema$GoogleCloudDiscoveryengineV1betaUpdateSchemaMetadata { + languageCode?: string | null; /** - * Operation create time. + * If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done. */ - createTime?: string | null; + naturalLanguageQueryUnderstandingSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestNaturalLanguageQueryUnderstandingSpec; /** - * Operation last update time. If the operation is done, this is also the finish time. + * 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. */ - updateTime?: string | null; - } - /** - * Metadata related to the progress of the SiteSearchEngineService.UpdateTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field. - */ - export interface Schema$GoogleCloudDiscoveryengineV1betaUpdateTargetSiteMetadata { + offset?: number | null; /** - * Operation create time. + * 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 for retail search, see [Ordering](https://cloud.google.com/retail/docs/filter-and-order#order) If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. */ - createTime?: string | null; + orderBy?: string | null; /** - * Operation last update time. If the operation is done, this is also the finish time. + * 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. */ - updateTime?: string | null; - } - /** - * Defines circumstances to be checked before allowing a behavior - */ - export interface Schema$GoogleCloudDiscoveryengineV1Condition { + pageSize?: number | null; /** - * Range of time(s) specifying when condition is active. Maximum of 10 time ranges. + * 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. */ - activeTimeRange?: Schema$GoogleCloudDiscoveryengineV1ConditionTimeRange[]; + pageToken?: string | null; /** - * Search only A list of terms to match the query on. Maximum of 10 query terms. + * 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` */ - queryTerms?: Schema$GoogleCloudDiscoveryengineV1ConditionQueryTerm[]; - } - /** - * Matcher for search request query - */ - export interface Schema$GoogleCloudDiscoveryengineV1ConditionQueryTerm { + params?: {[key: string]: any} | null; /** - * Whether the search query needs to exactly match the query term. + * Raw search query. */ - fullMatch?: boolean | null; + query?: string | null; /** - * 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. + * The query expansion specification that specifies the conditions under which query expansion occurs. */ - value?: string | null; - } - /** - * Used for time-dependent conditions. - */ - export interface Schema$GoogleCloudDiscoveryengineV1ConditionTimeRange { + queryExpansionSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestQueryExpansionSpec; /** - * End of time range. Range is inclusive. Must be in the future. + * 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)`. */ - endTime?: string | null; + rankingExpression?: string | null; /** - * Start of time range. Range is inclusive. + * 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. */ - startTime?: string | null; - } - /** - * 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`. - */ - export interface Schema$GoogleCloudDiscoveryengineV1Control { + regionCode?: string | null; /** - * Output only. List of all ServingConfig ids this control is attached to. May take up to 10 minutes to update after changes. + * Whether to turn on safe search. This is only supported for website search. */ - associatedServingConfigIds?: string[] | null; + safeSearch?: boolean | null; /** - * Defines a boost-type control + * Search as you type configuration. Only supported for the IndustryVertical.MEDIA vertical. */ - boostAction?: Schema$GoogleCloudDiscoveryengineV1ControlBoostAction; + searchAsYouTypeSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestSearchAsYouTypeSpec; /** - * 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. + * Required. The resource name of the Search serving config, such as `projects/x/locations/global/collections/default_collection/engines/x/servingConfigs/default_serving_config`, or `projects/x/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. */ - conditions?: Schema$GoogleCloudDiscoveryengineV1Condition[]; + servingConfig?: string | null; /** - * 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. + * 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. */ - displayName?: string | null; + session?: string | null; /** - * Defines a filter-type control Currently not supported by Recommendation + * Session specification. Can be used only when `session` is set. */ - filterAction?: Schema$GoogleCloudDiscoveryengineV1ControlFilterAction; + sessionSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestSessionSpec; /** - * Immutable. Fully qualified name `projects/x/locations/global/dataStore/x/controls/x` + * The spell correction specification that specifies the mode under which spell correction takes effect. */ - name?: string | null; + spellCorrectionSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestSpellCorrectionSpec; /** - * Defines a redirect-type control. + * Information about the end user. Highly recommended for analytics. UserInfo.user_agent is used to deduce `device_type` for analytics. */ - redirectAction?: Schema$GoogleCloudDiscoveryengineV1ControlRedirectAction; + userInfo?: Schema$GoogleCloudDiscoveryengineV1betaUserInfo; /** - * Required. Immutable. What solution the control belongs to. Must be compatible with vertical of resource. Otherwise an INVALID ARGUMENT error is thrown. + * 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. */ - solutionType?: string | null; + userLabels?: {[key: string]: string} | null; /** - * Treats a group of terms as synonyms of one another. + * 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. */ - synonymsAction?: Schema$GoogleCloudDiscoveryengineV1ControlSynonymsAction; + userPseudoId?: string | null; + } + /** + * Boost specification to boost certain documents. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpec { /** - * 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. + * 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. */ - useCases?: string[] | null; + conditionBoostSpecs?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpec[]; } /** - * Adjusts order of products in returned list. + * Boost applies to documents which match a condition. */ - export interface Schema$GoogleCloudDiscoveryengineV1ControlBoostAction { + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpec { /** - * Required. Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0 (No-op). + * 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. */ boost?: number | null; /** - * 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 + * Complex specification for custom ranking based on customer defined attribute value. */ - dataStore?: string | null; + boostControlSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpecBoostControlSpec; /** - * 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. + * 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"))` */ - filter?: string | null; + condition?: string | null; } /** - * Specified which products may be included in results. Uses same filter as boost. + * Specification for custom ranking based on customer specified attribute value. It provides more controls for customized ranking than the simple (condition, boost) combination above. */ - export interface Schema$GoogleCloudDiscoveryengineV1ControlFilterAction { + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpecBoostControlSpec { /** - * 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 + * 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). */ - dataStore?: string | null; + attributeType?: string | null; /** - * 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 control points used to define the curve. The monotonic function (defined through the interpolation_type above) passes through the control points listed here. */ - filter?: string | null; - } - /** - * Redirects a shopper to the provided URI. - */ - export interface Schema$GoogleCloudDiscoveryengineV1ControlRedirectAction { + controlPoints?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpecBoostControlSpecControlPoint[]; /** - * 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 name of the field whose value will be used to determine the boost amount. */ - redirectUri?: string | null; - } - /** - * 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". - */ - export interface Schema$GoogleCloudDiscoveryengineV1ControlSynonymsAction { + fieldName?: string | null; /** - * Defines a set of synonyms. Can specify up to 100 synonyms. Must specify at least 2 synonyms. Otherwise an INVALID ARGUMENT error is thrown. + * The interpolation type to be applied to connect the control points listed below. */ - synonyms?: string[] | null; + interpolationType?: string | null; } /** - * Metadata related to the progress of the DataStoreService.CreateDataStore operation. This will be returned by the google.longrunning.Operation.metadata field. + * 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). */ - export interface Schema$GoogleCloudDiscoveryengineV1CreateDataStoreMetadata { + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpecBoostControlSpecControlPoint { /** - * Operation create time. + * 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]`. */ - createTime?: string | null; + attributeValue?: string | null; /** - * Operation last update time. If the operation is done, this is also the finish time. + * The value between -1 to 1 by which to boost the score if the attribute_value evaluates to the value specified above. */ - updateTime?: string | null; + boostAmount?: number | null; } /** - * Metadata related to the progress of the EngineService.CreateEngine operation. This will be returned by the google.longrunning.Operation.metadata field. + * A specification for configuring the behavior of content search. */ - export interface Schema$GoogleCloudDiscoveryengineV1CreateEngineMetadata { + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpec { /** - * Operation create time. + * Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS */ - createTime?: string | null; + chunkSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecChunkSpec; /** - * Operation last update time. If the operation is done, this is also the finish time. + * If there is no extractive_content_spec provided, there will be no extractive answer in the search response. */ - updateTime?: string | null; - } - /** - * Metadata for Create Schema LRO. - */ - export interface Schema$GoogleCloudDiscoveryengineV1CreateSchemaMetadata { + extractiveContentSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecExtractiveContentSpec; /** - * Operation create time. + * Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`. */ - createTime?: string | null; + searchResultMode?: string | null; /** - * Operation last update time. If the operation is done, this is also the finish time. + * If `snippetSpec` is not specified, snippets are not included in the search response. */ - updateTime?: string | null; + snippetSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSnippetSpec; + /** + * If `summarySpec` is not specified, summaries are not included in the search response. + */ + summarySpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpec; } /** - * Metadata related to the progress of the SiteSearchEngineService.CreateTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field. + * Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS */ - export interface Schema$GoogleCloudDiscoveryengineV1CreateTargetSiteMetadata { + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecChunkSpec { /** - * Operation create time. + * 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. */ - createTime?: string | null; + numNextChunks?: number | null; /** - * Operation last update time. If the operation is done, this is also the finish time. + * 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. */ - updateTime?: string | null; + numPreviousChunks?: number | null; } /** - * DataStore captures global settings and configs at the DataStore level. + * A specification for configuring the extractive content in a search response. */ - export interface Schema$GoogleCloudDiscoveryengineV1DataStore { - /** - * Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT. - */ - contentConfig?: string | null; + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecExtractiveContentSpec { /** - * Output only. Timestamp the DataStore was created at. + * 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. */ - createTime?: string | null; + maxExtractiveAnswerCount?: number | null; /** - * Output only. The id of the default Schema asscociated to this data store. + * 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`. */ - defaultSchemaId?: string | null; + maxExtractiveSegmentCount?: number | null; /** - * 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. + * Return at most `num_next_segments` segments after each selected segments. */ - displayName?: string | null; + numNextSegments?: number | null; /** - * Configuration for Document understanding and enrichment. + * Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments. */ - documentProcessingConfig?: Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfig; + numPreviousSegments?: number | null; /** - * Immutable. The industry vertical that the data store registers. + * 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`. */ - industryVertical?: string | null; + returnExtractiveSegmentScore?: boolean | null; + } + /** + * A specification for configuring snippets in a search response. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSnippetSpec { /** - * 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. + * [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. */ - name?: string | null; + maxSnippetCount?: number | null; /** - * 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. + * [DEPRECATED] This field is deprecated and will have no affect on the snippet. */ - solutionTypes?: string[] | null; + referenceOnly?: boolean | null; /** - * 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). + * 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. */ - startingSchema?: Schema$GoogleCloudDiscoveryengineV1Schema; + returnSnippet?: boolean | null; } /** - * Metadata related to the progress of the DataStoreService.DeleteDataStore operation. This will be returned by the google.longrunning.Operation.metadata field. + * A specification for configuring a summary returned in a search response. */ - export interface Schema$GoogleCloudDiscoveryengineV1DeleteDataStoreMetadata { + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpec { /** - * Operation create time. + * 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. */ - createTime?: string | null; + ignoreAdversarialQuery?: boolean | null; /** - * Operation last update time. If the operation is done, this is also the finish time. + * 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. */ - updateTime?: string | null; - } - /** - * Metadata related to the progress of the EngineService.DeleteEngine operation. This will be returned by the google.longrunning.Operation.metadata field. - */ - export interface Schema$GoogleCloudDiscoveryengineV1DeleteEngineMetadata { + ignoreNonSummarySeekingQuery?: boolean | null; /** - * Operation create time. + * 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. */ - createTime?: string | null; + includeCitations?: boolean | null; /** - * Operation last update time. If the operation is done, this is also the finish time. + * 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. */ - updateTime?: string | null; + languageCode?: string | null; + /** + * If specified, the spec will be used to modify the prompt provided to the LLM. + */ + modelPromptSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelPromptSpec; + /** + * If specified, the spec will be used to modify the model specification provided to the LLM. + */ + modelSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelSpec; + /** + * 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. + */ + summaryResultCount?: number | null; + /** + * 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. + */ + useSemanticChunks?: boolean | null; } /** - * Metadata for DeleteSchema LRO. + * Specification of the prompt to use with the model. */ - export interface Schema$GoogleCloudDiscoveryengineV1DeleteSchemaMetadata { + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelPromptSpec { /** - * Operation create time. + * Text at the beginning of the prompt that instructs the assistant. Examples are available in the user guide. */ - createTime?: string | null; + preamble?: string | null; + } + /** + * Specification of the model. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelSpec { /** - * Operation last update time. If the operation is done, this is also the finish time. + * 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). */ - updateTime?: string | null; + version?: string | null; } /** - * Metadata related to the progress of the SiteSearchEngineService.DeleteTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field. + * 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. */ - export interface Schema$GoogleCloudDiscoveryengineV1DeleteTargetSiteMetadata { + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec { /** - * Operation create time. + * Required. Full resource name of DataStore, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}`. */ - createTime?: string | null; + dataStore?: string | null; + } + /** + * The specification that uses customized query embedding vector to do semantic document retrieval. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpec { /** - * Operation last update time. If the operation is done, this is also the finish time. + * The embedding vector used for retrieval. Limit to 1. */ - updateTime?: string | null; + embeddingVectors?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpecEmbeddingVector[]; } /** - * Metadata related to the progress of the SiteSearchEngineService.DisableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field. + * Embedding vector. */ - export interface Schema$GoogleCloudDiscoveryengineV1DisableAdvancedSiteSearchMetadata { + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpecEmbeddingVector { /** - * Operation create time. + * Embedding field path in schema. */ - createTime?: string | null; + fieldPath?: string | null; /** - * Operation last update time. If the operation is done, this is also the finish time. + * Query embedding vector. */ - updateTime?: string | null; + vector?: number[] | null; } /** - * Response message for SiteSearchEngineService.DisableAdvancedSiteSearch method. - */ - export interface Schema$GoogleCloudDiscoveryengineV1DisableAdvancedSiteSearchResponse {} - /** - * A singleton resource of DataStore. It's empty when DataStore is created, which defaults to digital parser. The first call to DataStoreService.UpdateDocumentProcessingConfig method will initialize the config. + * A facet specification to perform faceted search. */ - export interface Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfig { + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestFacetSpec { /** - * Whether chunking mode is enabled. + * 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. */ - chunkingConfig?: Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfig; + enableDynamicPosition?: boolean | null; /** - * 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. + * 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. */ - defaultParsingConfig?: Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig; + excludedFilterKeys?: string[] | null; /** - * The full resource name of the Document Processing Config. Format: `projects/x/locations/x/collections/x/dataStores/x/documentProcessingConfig`. + * Required. The facet key specification. */ - name?: string | null; + facetKey?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestFacetSpecFacetKey; /** - * 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 or layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and or layout parsing are supported. + * 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. */ - parsingConfigOverrides?: { - [ - key: string - ]: Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig; - } | null; + limit?: number | null; } /** - * Configuration for chunking config. + * Specifies how a facet is computed. */ - export interface Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfig { + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestFacetSpecFacetKey { /** - * Configuration for the layout based chunking. + * True to make facet keys case insensitive when getting faceting values with prefixes or contains; false otherwise. */ - layoutBasedChunkingConfig?: Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig; - } - /** - * Configuration for the layout based chunking. - */ - export interface Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig { + caseInsensitive?: boolean | null; /** - * The token size limit for each chunk. Supported values: 100-500 (inclusive). Default value: 500. + * 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. */ - chunkSize?: number | null; + contains?: string[] | null; /** - * Whether to include appending different levels of headings to chunks from the middle of the document to prevent context loss. Default value: False. + * 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. */ - includeAncestorHeadings?: boolean | null; - } - /** - * Related configurations applied to a specific type of document parser. - */ - export interface Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig { + intervals?: Schema$GoogleCloudDiscoveryengineV1betaInterval[]; /** - * Configurations applied to digital parser. + * Required. Supported textual and numerical facet keys in Document object, over which the facet values are computed. Facet key is case-sensitive. */ - digitalParsingConfig?: Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigDigitalParsingConfig; + key?: string | null; /** - * Configurations applied to layout parser. + * 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. */ - layoutParsingConfig?: Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigLayoutParsingConfig; + orderBy?: string | null; /** - * Configurations applied to OCR parser. Currently it only applies to PDFs. + * 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. */ - ocrParsingConfig?: Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigOcrParsingConfig; + prefixes?: string[] | null; + /** + * 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. + */ + restrictedValues?: string[] | null; } /** - * The digital parsing configurations for documents. - */ - export interface Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigDigitalParsingConfig {} - /** - * The layout parsing configurations for documents. + * Specifies the image query input. */ - export interface Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigLayoutParsingConfig {} + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestImageQuery { + /** + * Base64 encoded image bytes. Supported image formats: JPEG, PNG, and BMP. + */ + imageBytes?: string | null; + } /** - * The OCR parsing configurations for documents. + * Specification to enable natural language understanding capabilities for search requests. */ - export interface Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigOcrParsingConfig { + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestNaturalLanguageQueryUnderstandingSpec { /** - * [DEPRECATED] This field is deprecated. To use the additional enhanced document elements processing, please switch to `layout_parsing_config`. + * The condition under which filter extraction should occur. Default to Condition.DISABLED. */ - enhancedDocumentElements?: string[] | null; + filterExtractionCondition?: string | null; /** - * If true, will use native text instead of OCR text on pages containing native text. + * 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. */ - useNativeText?: boolean | null; + geoSearchQueryDetectionFieldNames?: string[] | null; } /** - * Metadata related to the progress of the SiteSearchEngineService.EnableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field. + * Specification to determine under which conditions query expansion should occur. */ - export interface Schema$GoogleCloudDiscoveryengineV1EnableAdvancedSiteSearchMetadata { + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestQueryExpansionSpec { /** - * Operation create time. + * The condition under which query expansion should occur. Default to Condition.DISABLED. */ - createTime?: string | null; + condition?: string | null; /** - * Operation last update time. If the operation is done, this is also the finish time. + * 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. */ - updateTime?: string | null; + pinUnexpandedResults?: boolean | null; } /** - * Response message for SiteSearchEngineService.EnableAdvancedSiteSearch method. - */ - export interface Schema$GoogleCloudDiscoveryengineV1EnableAdvancedSiteSearchResponse {} - /** - * Metadata that describes the training and serving parameters of an Engine. + * Specification for search as you type in search requests. */ - export interface Schema$GoogleCloudDiscoveryengineV1Engine { + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestSearchAsYouTypeSpec { /** - * Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT. + * The condition under which search as you type should occur. Default to Condition.DISABLED. */ - chatEngineConfig?: Schema$GoogleCloudDiscoveryengineV1EngineChatEngineConfig; + condition?: string | null; + } + /** + * 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. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestSessionSpec { /** - * Output only. Additional information of the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT. + * 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. */ - chatEngineMetadata?: Schema$GoogleCloudDiscoveryengineV1EngineChatEngineMetadata; + queryId?: string | null; /** - * Common config spec that specifies the metadata of the engine. + * 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. */ - commonConfig?: Schema$GoogleCloudDiscoveryengineV1EngineCommonConfig; + searchResultPersistenceCount?: number | null; + } + /** + * The specification for query spell correction. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestSpellCorrectionSpec { /** - * Output only. Timestamp the Recommendation Engine was created at. + * The mode under which spell correction replaces the original search query. Defaults to Mode.AUTO. */ - createTime?: string | null; + mode?: string | null; + } + /** + * Verification information for target sites in advanced site search. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaSiteVerificationInfo { /** - * 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. + * Site verification state indicating the ownership and validity. */ - dataStoreIds?: string[] | null; + siteVerificationState?: string | null; /** - * Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. + * Latest site verification time. */ - displayName?: string | null; - /** - * 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. - */ - industryVertical?: string | null; + verifyTime?: string | null; + } + /** + * A target site for the SiteSearchEngine. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaTargetSite { /** - * 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_number\}/locations/{location\}/collections/{collection\}/engines/{engine\}` engine should be 1-63 characters, and valid characters are /a-z0-9x/. Otherwise, an INVALID_ARGUMENT error is returned. + * 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. */ - name?: string | null; + exactMatch?: boolean | null; /** - * Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH. + * Output only. Failure reason. */ - searchEngineConfig?: Schema$GoogleCloudDiscoveryengineV1EngineSearchEngineConfig; + failureReason?: Schema$GoogleCloudDiscoveryengineV1betaTargetSiteFailureReason; /** - * Required. The solutions of the engine. + * Output only. This is system-generated based on the provided_uri_pattern. */ - solutionType?: string | null; + generatedUriPattern?: string | null; /** - * Output only. Timestamp the Recommendation Engine was last updated. + * Output only. Indexing status. */ - updateTime?: string | null; - } - /** - * Configurations for a Chat Engine. - */ - export interface Schema$GoogleCloudDiscoveryengineV1EngineChatEngineConfig { + indexingStatus?: string | null; /** - * 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. + * 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. */ - agentCreationConfig?: Schema$GoogleCloudDiscoveryengineV1EngineChatEngineConfigAgentCreationConfig; + name?: string | null; /** - * 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. + * Required. Input only. The user provided URI pattern from which the `generated_uri_pattern` is generated. */ - dialogflowAgentToLink?: string | null; - } - /** - * 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. - */ - export interface Schema$GoogleCloudDiscoveryengineV1EngineChatEngineConfigAgentCreationConfig { + providedUriPattern?: string | null; /** - * Name of the company, organization or other entity that the agent represents. Used for knowledge connector LLM prompt and for knowledge search. + * Output only. Root domain of the provided_uri_pattern. */ - business?: string | null; + rootDomainUri?: string | null; /** - * 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. + * Output only. Site ownership and validity verification status. */ - defaultLanguageCode?: string | null; + siteVerificationInfo?: Schema$GoogleCloudDiscoveryengineV1betaSiteVerificationInfo; /** - * 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. + * The type of the target site, e.g., whether the site is to be included or excluded. */ - location?: string | null; + type?: string | null; /** - * 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. + * Output only. The target site's last updated time. */ - timeZone?: string | null; + updateTime?: string | null; } /** - * Additional information of a Chat Engine. Fields in this message are output only. + * Site search indexing failure reasons. */ - export interface Schema$GoogleCloudDiscoveryengineV1EngineChatEngineMetadata { + export interface Schema$GoogleCloudDiscoveryengineV1betaTargetSiteFailureReason { /** - * The resource name of a Dialogflow agent, that this Chat Engine refers to. Format: `projects//locations//agents/`. + * Failed due to insufficient quota. */ - dialogflowAgent?: string | null; + quotaFailure?: Schema$GoogleCloudDiscoveryengineV1betaTargetSiteFailureReasonQuotaFailure; } /** - * Common configurations for an Engine. + * Failed due to insufficient quota. */ - export interface Schema$GoogleCloudDiscoveryengineV1EngineCommonConfig { + export interface Schema$GoogleCloudDiscoveryengineV1betaTargetSiteFailureReasonQuotaFailure { /** - * The name of the company, business or entity that is associated with the engine. Setting this may help improve LLM related features. + * This number is an estimation on how much total quota this project needs to successfully complete indexing. */ - companyName?: string | null; + totalRequiredQuota?: string | null; } /** - * Configurations for a Search Engine. + * Metadata related to the progress of the TrainCustomModel operation. This is returned by the google.longrunning.Operation.metadata field. */ - export interface Schema$GoogleCloudDiscoveryengineV1EngineSearchEngineConfig { + export interface Schema$GoogleCloudDiscoveryengineV1betaTrainCustomModelMetadata { /** - * The add-on that this search engine enables. + * Operation create time. */ - searchAddOns?: string[] | null; + createTime?: string | null; /** - * 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. */ - searchTier?: string | null; + updateTime?: string | null; } /** - * Metadata related to the progress of the ImportCompletionSuggestions operation. This will be returned by the google.longrunning.Operation.metadata field. + * Response of the TrainCustomModelRequest. This message is returned by the google.longrunning.Operations.response field. */ - export interface Schema$GoogleCloudDiscoveryengineV1ImportCompletionSuggestionsMetadata { + export interface Schema$GoogleCloudDiscoveryengineV1betaTrainCustomModelResponse { /** - * Operation create time. + * Echoes the destination for the complete errors in the request if set. */ - createTime?: string | null; + errorConfig?: Schema$GoogleCloudDiscoveryengineV1betaImportErrorConfig; /** - * Count of CompletionSuggestions that failed to be imported. + * A sample of errors encountered while processing the data. */ - failureCount?: string | null; + errorSamples?: Schema$GoogleRpcStatus[]; /** - * Count of CompletionSuggestions successfully imported. + * The metrics of the trained model. */ - successCount?: string | null; + metrics?: {[key: string]: number} | null; /** - * Operation last update time. If the operation is done, this is also the finish time. + * Fully qualified name of the CustomTuningModel. */ - updateTime?: string | null; + modelName?: string | null; + /** + * 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. + */ + modelStatus?: string | null; } /** - * 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. + * Metadata associated with a tune operation. */ - export interface Schema$GoogleCloudDiscoveryengineV1ImportCompletionSuggestionsResponse { - /** - * The desired location of errors incurred during the Import. - */ - errorConfig?: Schema$GoogleCloudDiscoveryengineV1ImportErrorConfig; + export interface Schema$GoogleCloudDiscoveryengineV1betaTuneEngineMetadata { /** - * A sample of errors encountered while processing the request. + * Required. The resource name of the engine that this tune applies to. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/engines/{engine_id\}` */ - errorSamples?: Schema$GoogleRpcStatus[]; + engine?: string | null; } /** - * Metadata related to the progress of the ImportDocuments operation. This is returned by the google.longrunning.Operation.metadata field. + * Response associated with a tune operation. */ - export interface Schema$GoogleCloudDiscoveryengineV1ImportDocumentsMetadata { + export interface Schema$GoogleCloudDiscoveryengineV1betaTuneEngineResponse {} + /** + * Metadata for UpdateSchema LRO. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaUpdateSchemaMetadata { /** * Operation create time. */ createTime?: string | null; /** - * Count of entries that encountered errors while processing. - */ - failureCount?: string | null; - /** - * Count of entries that were processed successfully. + * Operation last update time. If the operation is done, this is also the finish time. */ - successCount?: string | null; + updateTime?: string | null; + } + /** + * Metadata related to the progress of the SiteSearchEngineService.UpdateTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaUpdateTargetSiteMetadata { /** - * Total count of entries that were processed. + * Operation create time. */ - totalCount?: string | null; + createTime?: string | null; /** * Operation last update time. If the operation is done, this is also the finish time. */ updateTime?: string | null; } /** - * 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. + * Information of an end user. */ - export interface Schema$GoogleCloudDiscoveryengineV1ImportDocumentsResponse { + export interface Schema$GoogleCloudDiscoveryengineV1betaUserInfo { /** - * Echoes the destination for the complete errors in the request if set. + * 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. */ - errorConfig?: Schema$GoogleCloudDiscoveryengineV1ImportErrorConfig; + userAgent?: string | null; /** - * A sample of errors encountered while processing the request. + * 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. */ - errorSamples?: Schema$GoogleRpcStatus[]; + userId?: string | null; } /** - * Configuration of destination for Import related errors. + * Defines circumstances to be checked before allowing a behavior */ - export interface Schema$GoogleCloudDiscoveryengineV1ImportErrorConfig { + export interface Schema$GoogleCloudDiscoveryengineV1Condition { /** - * 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. + * Range of time(s) specifying when condition is active. Maximum of 10 time ranges. */ - gcsPrefix?: string | null; + activeTimeRange?: Schema$GoogleCloudDiscoveryengineV1ConditionTimeRange[]; + /** + * Search only A list of terms to match the query on. Maximum of 10 query terms. + */ + queryTerms?: Schema$GoogleCloudDiscoveryengineV1ConditionQueryTerm[]; } /** - * Metadata related to the progress of the ImportSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field. + * Matcher for search request query */ - export interface Schema$GoogleCloudDiscoveryengineV1ImportSuggestionDenyListEntriesMetadata { + export interface Schema$GoogleCloudDiscoveryengineV1ConditionQueryTerm { /** - * Operation create time. + * Whether the search query needs to exactly match the query term. */ - createTime?: string | null; + fullMatch?: boolean | null; /** - * Operation last update time. If the operation is done, this is also the finish time. + * 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. */ - updateTime?: string | null; + value?: string | null; } /** - * Response message for CompletionService.ImportSuggestionDenyListEntries method. + * Used for time-dependent conditions. */ - export interface Schema$GoogleCloudDiscoveryengineV1ImportSuggestionDenyListEntriesResponse { - /** - * A sample of errors encountered while processing the request. - */ - errorSamples?: Schema$GoogleRpcStatus[]; + export interface Schema$GoogleCloudDiscoveryengineV1ConditionTimeRange { /** - * Count of deny list entries that failed to be imported. + * End of time range. Range is inclusive. Must be in the future. */ - failedEntriesCount?: string | null; + endTime?: string | null; /** - * Count of deny list entries successfully imported. + * Start of time range. Range is inclusive. */ - importedEntriesCount?: string | null; + startTime?: string | null; } /** - * Metadata related to the progress of the Import operation. This is 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`. */ - export interface Schema$GoogleCloudDiscoveryengineV1ImportUserEventsMetadata { + export interface Schema$GoogleCloudDiscoveryengineV1Control { /** - * Operation create time. + * Output only. List of all ServingConfig ids this control is attached to. May take up to 10 minutes to update after changes. */ - createTime?: string | null; + associatedServingConfigIds?: string[] | null; /** - * Count of entries that encountered errors while processing. + * Defines a boost-type control */ - failureCount?: string | null; + boostAction?: Schema$GoogleCloudDiscoveryengineV1ControlBoostAction; /** - * Count of entries that were processed successfully. + * 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. */ - successCount?: string | null; + conditions?: Schema$GoogleCloudDiscoveryengineV1Condition[]; /** - * Operation last update time. If the operation is done, this is also the finish time. + * 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. */ - updateTime?: string | null; - } - /** - * 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. - */ - export interface Schema$GoogleCloudDiscoveryengineV1ImportUserEventsResponse { + displayName?: string | null; /** - * Echoes the destination for the complete errors if this field was set in the request. + * Defines a filter-type control Currently not supported by Recommendation */ - errorConfig?: Schema$GoogleCloudDiscoveryengineV1ImportErrorConfig; + filterAction?: Schema$GoogleCloudDiscoveryengineV1ControlFilterAction; /** - * A sample of errors encountered while processing the request. + * Immutable. Fully qualified name `projects/x/locations/global/dataStore/x/controls/x` */ - errorSamples?: Schema$GoogleRpcStatus[]; + name?: string | null; /** - * Count of user events imported with complete existing Documents. + * Defines a redirect-type control. */ - joinedEventsCount?: string | null; + redirectAction?: Schema$GoogleCloudDiscoveryengineV1ControlRedirectAction; /** - * Count of user events imported, but with Document information not found in the existing Branch. + * Required. Immutable. What solution the control belongs to. Must be compatible with vertical of resource. Otherwise an INVALID ARGUMENT error is thrown. */ - unjoinedEventsCount?: string | null; + solutionType?: string | null; + /** + * Treats a group of terms as synonyms of one another. + */ + synonymsAction?: Schema$GoogleCloudDiscoveryengineV1ControlSynonymsAction; + /** + * 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. + */ + useCases?: string[] | null; } /** - * Metadata and configurations for a Google Cloud project in the service. + * Adjusts order of products in returned list. */ - export interface Schema$GoogleCloudDiscoveryengineV1Project { + export interface Schema$GoogleCloudDiscoveryengineV1ControlBoostAction { /** - * Output only. The timestamp when this project is created. + * Required. Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0 (No-op). */ - createTime?: string | null; - /** - * Output only. Full resource name of the project, for example `projects/{project_number\}`. Note that when making requests, project number and project id are both acceptable, but the server will always respond in project number. - */ - name?: string | null; + boost?: number | null; /** - * Output only. The timestamp when this project is successfully provisioned. Empty value means this project is still provisioning and is not ready for use. + * 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 */ - provisionCompletionTime?: string | null; + dataStore?: string | null; /** - * Output only. A map of terms of services. The key is the `id` of ServiceTerms. + * 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. */ - serviceTermsMap?: { - [key: string]: Schema$GoogleCloudDiscoveryengineV1ProjectServiceTerms; - } | null; + filter?: string | null; } /** - * Metadata about the terms of service. + * Specified which products may be included in results. Uses same filter as boost. */ - export interface Schema$GoogleCloudDiscoveryengineV1ProjectServiceTerms { - /** - * The last time when the project agreed to the terms of service. - */ - acceptTime?: string | null; - /** - * The last time when the project declined or revoked the agreement to terms of service. - */ - declineTime?: string | null; - /** - * 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`. - */ - id?: string | null; + export interface Schema$GoogleCloudDiscoveryengineV1ControlFilterAction { /** - * Whether the project has accepted/rejected the service terms or it is still pending. + * 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 */ - state?: string | null; + dataStore?: string | null; /** - * The version string of the terms of service. For acceptable values, see the comments for id above. + * 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. */ - version?: string | null; + filter?: string | null; } /** - * Metadata associated with a project provision operation. - */ - export interface Schema$GoogleCloudDiscoveryengineV1ProvisionProjectMetadata {} - /** - * Metadata related to the progress of the PurgeCompletionSuggestions operation. This is returned by the google.longrunning.Operation.metadata field. + * Redirects a shopper to the provided URI. */ - export interface Schema$GoogleCloudDiscoveryengineV1PurgeCompletionSuggestionsMetadata { - /** - * Operation create time. - */ - createTime?: string | null; + export interface Schema$GoogleCloudDiscoveryengineV1ControlRedirectAction { /** - * Operation last update time. If the operation is done, this is also the finish time. + * 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. */ - updateTime?: string | null; + redirectUri?: string | null; } /** - * Response message for CompletionService.PurgeCompletionSuggestions 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". */ - export interface Schema$GoogleCloudDiscoveryengineV1PurgeCompletionSuggestionsResponse { - /** - * A sample of errors encountered while processing the request. - */ - errorSamples?: Schema$GoogleRpcStatus[]; + export interface Schema$GoogleCloudDiscoveryengineV1ControlSynonymsAction { /** - * Whether the completion suggestions were successfully purged. + * Defines a set of synonyms. Can specify up to 100 synonyms. Must specify at least 2 synonyms. Otherwise an INVALID ARGUMENT error is thrown. */ - purgeSucceeded?: boolean | null; + synonyms?: string[] | null; } /** - * Metadata related to the progress of the PurgeDocuments 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. */ - export interface Schema$GoogleCloudDiscoveryengineV1PurgeDocumentsMetadata { + export interface Schema$GoogleCloudDiscoveryengineV1CreateDataStoreMetadata { /** * Operation create time. */ createTime?: string | null; - /** - * Count of entries that encountered errors while processing. - */ - failureCount?: string | null; - /** - * Count of entries that were ignored as entries were not found. - */ - ignoredCount?: string | null; - /** - * Count of entries that were deleted successfully. - */ - successCount?: string | null; /** * Operation last update time. If the operation is done, this is also the finish time. */ updateTime?: string | null; } /** - * 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. - */ - export interface Schema$GoogleCloudDiscoveryengineV1PurgeDocumentsResponse { - /** - * The total count of documents purged as a result of the operation. - */ - purgeCount?: string | null; - /** - * 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. - */ - purgeSample?: string[] | null; - } - /** - * Metadata related to the progress of the PurgeSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field. + * Metadata related to the progress of the EngineService.CreateEngine operation. This will be returned by the google.longrunning.Operation.metadata field. */ - export interface Schema$GoogleCloudDiscoveryengineV1PurgeSuggestionDenyListEntriesMetadata { + export interface Schema$GoogleCloudDiscoveryengineV1CreateEngineMetadata { /** * Operation create time. */ @@ -6991,115 +7597,102 @@ export namespace discoveryengine_v1alpha { updateTime?: string | null; } /** - * Response message for CompletionService.PurgeSuggestionDenyListEntries method. + * Metadata for Create Schema LRO. */ - export interface Schema$GoogleCloudDiscoveryengineV1PurgeSuggestionDenyListEntriesResponse { + export interface Schema$GoogleCloudDiscoveryengineV1CreateSchemaMetadata { /** - * A sample of errors encountered while processing the request. + * Operation create time. */ - errorSamples?: Schema$GoogleRpcStatus[]; + createTime?: string | null; /** - * Number of suggestion deny list entries purged. + * Operation last update time. If the operation is done, this is also the finish time. */ - purgeCount?: string | null; + updateTime?: string | null; } /** - * Defines the structure and layout of a type of document data. + * Metadata related to the progress of the SiteSearchEngineService.CreateTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field. */ - export interface Schema$GoogleCloudDiscoveryengineV1Schema { - /** - * The JSON representation of the schema. - */ - jsonSchema?: string | null; + export interface Schema$GoogleCloudDiscoveryengineV1CreateTargetSiteMetadata { /** - * 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. + * Operation create time. */ - name?: string | null; + createTime?: string | null; /** - * The structured representation of the schema. + * Operation last update time. If the operation is done, this is also the finish time. */ - structSchema?: {[key: string]: any} | null; + updateTime?: string | null; } /** - * Verification information for target sites in advanced site search. + * DataStore captures global settings and configs at the DataStore level. */ - export interface Schema$GoogleCloudDiscoveryengineV1SiteVerificationInfo { + export interface Schema$GoogleCloudDiscoveryengineV1DataStore { /** - * Site verification state indicating the ownership and validity. + * Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT. */ - siteVerificationState?: string | null; + contentConfig?: string | null; /** - * Latest site verification time. + * Output only. Timestamp the DataStore was created at. */ - verifyTime?: string | null; - } - /** - * A target site for the SiteSearchEngine. - */ - export interface Schema$GoogleCloudDiscoveryengineV1TargetSite { + createTime?: string | null; /** - * 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. + * Output only. The id of the default Schema asscociated to this data store. */ - exactMatch?: boolean | null; + defaultSchemaId?: string | null; /** - * Output only. Failure reason. + * 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. */ - failureReason?: Schema$GoogleCloudDiscoveryengineV1TargetSiteFailureReason; + displayName?: string | null; /** - * Output only. This is system-generated based on the provided_uri_pattern. + * Configuration for Document understanding and enrichment. */ - generatedUriPattern?: string | null; + documentProcessingConfig?: Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfig; /** - * Output only. Indexing status. + * Immutable. The industry vertical that the data store registers. */ - indexingStatus?: string | null; + industryVertical?: string | null; /** - * 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. + * 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. */ name?: string | null; /** - * Required. Input only. The user provided URI pattern from which the `generated_uri_pattern` is generated. - */ - providedUriPattern?: string | null; - /** - * Output only. Root domain of the provided_uri_pattern. + * 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. */ - rootDomainUri?: string | null; + solutionTypes?: string[] | null; /** - * Output only. Site ownership and validity verification status. + * 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). */ - siteVerificationInfo?: Schema$GoogleCloudDiscoveryengineV1SiteVerificationInfo; + startingSchema?: Schema$GoogleCloudDiscoveryengineV1Schema; + } + /** + * Metadata related to the progress of the DataStoreService.DeleteDataStore operation. This will be returned by the google.longrunning.Operation.metadata field. + */ + export interface Schema$GoogleCloudDiscoveryengineV1DeleteDataStoreMetadata { /** - * The type of the target site, e.g., whether the site is to be included or excluded. + * Operation create time. */ - type?: string | null; + createTime?: string | null; /** - * Output only. The target site's last updated time. + * Operation last update time. If the operation is done, this is also the finish time. */ updateTime?: string | null; } /** - * Site search indexing failure reasons. + * Metadata related to the progress of the EngineService.DeleteEngine operation. This will be returned by the google.longrunning.Operation.metadata field. */ - export interface Schema$GoogleCloudDiscoveryengineV1TargetSiteFailureReason { + export interface Schema$GoogleCloudDiscoveryengineV1DeleteEngineMetadata { /** - * Failed due to insufficient quota. + * Operation create time. */ - quotaFailure?: Schema$GoogleCloudDiscoveryengineV1TargetSiteFailureReasonQuotaFailure; - } - /** - * Failed due to insufficient quota. - */ - export interface Schema$GoogleCloudDiscoveryengineV1TargetSiteFailureReasonQuotaFailure { + createTime?: string | null; /** - * This number is an estimation on how much total quota this project needs to successfully complete indexing. + * Operation last update time. If the operation is done, this is also the finish time. */ - totalRequiredQuota?: string | null; + updateTime?: string | null; } /** - * Metadata for UpdateSchema LRO. + * Metadata for DeleteSchema LRO. */ - export interface Schema$GoogleCloudDiscoveryengineV1UpdateSchemaMetadata { + export interface Schema$GoogleCloudDiscoveryengineV1DeleteSchemaMetadata { /** * Operation create time. */ @@ -7110,9 +7703,9 @@ export namespace discoveryengine_v1alpha { updateTime?: string | null; } /** - * Metadata related to the progress of the SiteSearchEngineService.UpdateTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field. + * Metadata related to the progress of the SiteSearchEngineService.DeleteTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field. */ - export interface Schema$GoogleCloudDiscoveryengineV1UpdateTargetSiteMetadata { + export interface Schema$GoogleCloudDiscoveryengineV1DeleteTargetSiteMetadata { /** * Operation create time. */ @@ -7123,144 +7716,2097 @@ export namespace discoveryengine_v1alpha { updateTime?: string | null; } /** - * The request message for Operations.CancelOperation. - */ - export interface Schema$GoogleLongrunningCancelOperationRequest {} - /** - * The response message for Operations.ListOperations. + * Metadata related to the progress of the SiteSearchEngineService.DisableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field. */ - export interface Schema$GoogleLongrunningListOperationsResponse { + export interface Schema$GoogleCloudDiscoveryengineV1DisableAdvancedSiteSearchMetadata { /** - * The standard List next-page token. + * Operation create time. */ - nextPageToken?: string | null; + createTime?: string | null; /** - * A list of operations that matches the specified filter in the request. + * Operation last update time. If the operation is done, this is also the finish time. */ - operations?: Schema$GoogleLongrunningOperation[]; + updateTime?: string | null; } /** - * This resource represents a long-running operation that is the result of a network API call. + * Response message for SiteSearchEngineService.DisableAdvancedSiteSearch method. */ - export interface Schema$GoogleLongrunningOperation { - /** - * 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. - */ - done?: boolean | null; + export interface Schema$GoogleCloudDiscoveryengineV1DisableAdvancedSiteSearchResponse {} + /** + * A singleton resource of DataStore. It's empty when DataStore is created, which defaults to digital parser. The first call to DataStoreService.UpdateDocumentProcessingConfig method will initialize the config. + */ + export interface Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfig { /** - * The error result of the operation in case of failure or cancellation. + * Whether chunking mode is enabled. */ - error?: Schema$GoogleRpcStatus; + chunkingConfig?: Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfig; /** - * 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. + * 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. */ - metadata?: {[key: string]: any} | null; + defaultParsingConfig?: Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig; /** - * 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\}`. + * The full resource name of the Document Processing Config. Format: `projects/x/locations/x/collections/x/dataStores/x/documentProcessingConfig`. */ name?: string | null; /** - * 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`. + * 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. */ - response?: {[key: string]: any} | null; + parsingConfigOverrides?: { + [ + key: string + ]: Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig; + } | null; } /** - * A single strongly-typed value. + * Configuration for chunking config. */ - export interface Schema$GoogleMonitoringV3TypedValue { + export interface Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfig { /** - * A Boolean value: `true` or `false`. + * Configuration for the layout based chunking. */ - boolValue?: boolean | null; + layoutBasedChunkingConfig?: Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig; + } + /** + * Configuration for the layout based chunking. + */ + export interface Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig { /** - * A distribution value. + * The token size limit for each chunk. Supported values: 100-500 (inclusive). Default value: 500. */ - distributionValue?: Schema$GoogleApiDistribution; + chunkSize?: number | null; /** - * A 64-bit double-precision floating-point number. Its magnitude is approximately ±10±300 and it has 16 significant digits of precision. + * Whether to include appending different levels of headings to chunks from the middle of the document to prevent context loss. Default value: False. */ - doubleValue?: number | null; + includeAncestorHeadings?: boolean | null; + } + /** + * Related configurations applied to a specific type of document parser. + */ + export interface Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig { /** - * A 64-bit integer. Its range is approximately ±9.2x1018. + * Configurations applied to digital parser. */ - int64Value?: string | null; + digitalParsingConfig?: Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigDigitalParsingConfig; /** - * A variable-length string value. + * Configurations applied to layout parser. */ - stringValue?: string | null; + layoutParsingConfig?: Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigLayoutParsingConfig; + /** + * Configurations applied to OCR parser. Currently it only applies to PDFs. + */ + ocrParsingConfig?: Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigOcrParsingConfig; } /** - * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); \} + * The digital parsing configurations for documents. */ - export interface Schema$GoogleProtobufEmpty {} + export interface Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigDigitalParsingConfig {} /** - * The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). + * The layout parsing configurations for documents. */ - export interface Schema$GoogleRpcStatus { + export interface Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigLayoutParsingConfig {} + /** + * The OCR parsing configurations for documents. + */ + export interface Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigOcrParsingConfig { /** - * The status code, which should be an enum value of google.rpc.Code. + * [DEPRECATED] This field is deprecated. To use the additional enhanced document elements processing, please switch to `layout_parsing_config`. */ - code?: number | null; + enhancedDocumentElements?: string[] | null; /** - * A list of messages that carry the error details. There is a common set of message types for APIs to use. + * If true, will use native text instead of OCR text on pages containing native text. */ - details?: Array<{[key: string]: any}> | null; + useNativeText?: boolean | null; + } + /** + * Metadata related to the progress of the SiteSearchEngineService.EnableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field. + */ + export interface Schema$GoogleCloudDiscoveryengineV1EnableAdvancedSiteSearchMetadata { /** - * 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. + * Operation create time. */ - message?: string | null; + createTime?: string | null; + /** + * Operation last update time. If the operation is done, this is also the finish time. + */ + updateTime?: string | null; } /** - * 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 + * Response message for SiteSearchEngineService.EnableAdvancedSiteSearch method. */ - export interface Schema$GoogleTypeDate { + export interface Schema$GoogleCloudDiscoveryengineV1EnableAdvancedSiteSearchResponse {} + /** + * Metadata that describes the training and serving parameters of an Engine. + */ + export interface Schema$GoogleCloudDiscoveryengineV1Engine { /** - * 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. + * Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT. */ - day?: number | null; + chatEngineConfig?: Schema$GoogleCloudDiscoveryengineV1EngineChatEngineConfig; /** - * Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + * Output only. Additional information of the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT. */ - month?: number | null; + chatEngineMetadata?: Schema$GoogleCloudDiscoveryengineV1EngineChatEngineMetadata; /** - * Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + * Common config spec that specifies the metadata of the engine. */ - year?: number | null; + commonConfig?: Schema$GoogleCloudDiscoveryengineV1EngineCommonConfig; + /** + * Output only. Timestamp the Recommendation Engine was created at. + */ + createTime?: string | null; + /** + * 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. + */ + dataStoreIds?: string[] | null; + /** + * Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. + */ + displayName?: string | null; + /** + * 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. + */ + industryVertical?: string | null; + /** + * 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_number\}/locations/{location\}/collections/{collection\}/engines/{engine\}` engine should be 1-63 characters, and valid characters are /a-z0-9x/. Otherwise, an INVALID_ARGUMENT error is returned. + */ + name?: string | null; + /** + * Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH. + */ + searchEngineConfig?: Schema$GoogleCloudDiscoveryengineV1EngineSearchEngineConfig; + /** + * Required. The solutions of the engine. + */ + solutionType?: string | null; + /** + * Output only. Timestamp the Recommendation Engine was last updated. + */ + updateTime?: string | null; } /** - * 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. + * Configurations for a Chat Engine. */ - export interface Schema$GoogleTypeExpr { + export interface Schema$GoogleCloudDiscoveryengineV1EngineChatEngineConfig { /** - * Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. + * 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. */ - description?: string | null; + agentCreationConfig?: Schema$GoogleCloudDiscoveryengineV1EngineChatEngineConfigAgentCreationConfig; /** - * Textual representation of an expression in Common Expression Language syntax. + * 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. */ - expression?: string | null; + dialogflowAgentToLink?: string | null; + } + /** + * 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. + */ + export interface Schema$GoogleCloudDiscoveryengineV1EngineChatEngineConfigAgentCreationConfig { /** - * Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. + * Name of the company, organization or other entity that the agent represents. Used for knowledge connector LLM prompt and for knowledge search. + */ + business?: string | null; + /** + * 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. + */ + defaultLanguageCode?: string | null; + /** + * 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. */ location?: string | null; /** - * 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. The time zone of the agent from the [time zone database](https://www.iana.org/time-zones), e.g., America/New_York, Europe/Paris. + */ + timeZone?: string | null; + } + /** + * Additional information of a Chat Engine. Fields in this message are output only. + */ + export interface Schema$GoogleCloudDiscoveryengineV1EngineChatEngineMetadata { + /** + * The resource name of a Dialogflow agent, that this Chat Engine refers to. Format: `projects//locations//agents/`. + */ + dialogflowAgent?: string | null; + } + /** + * Common configurations for an Engine. + */ + export interface Schema$GoogleCloudDiscoveryengineV1EngineCommonConfig { + /** + * The name of the company, business or entity that is associated with the engine. Setting this may help improve LLM related features. + */ + companyName?: string | null; + } + /** + * Configurations for a Search Engine. + */ + export interface Schema$GoogleCloudDiscoveryengineV1EngineSearchEngineConfig { + /** + * The add-on that this search engine enables. + */ + searchAddOns?: string[] | null; + /** + * 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. + */ + searchTier?: string | null; + } + /** + * Metadata related to the progress of the ImportCompletionSuggestions operation. This will be returned by the google.longrunning.Operation.metadata field. + */ + export interface Schema$GoogleCloudDiscoveryengineV1ImportCompletionSuggestionsMetadata { + /** + * Operation create time. + */ + createTime?: string | null; + /** + * Count of CompletionSuggestions that failed to be imported. + */ + failureCount?: string | null; + /** + * Count of CompletionSuggestions successfully imported. + */ + successCount?: string | null; + /** + * Operation last update time. If the operation is done, this is also the finish time. + */ + updateTime?: string | null; + } + /** + * 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. + */ + export interface Schema$GoogleCloudDiscoveryengineV1ImportCompletionSuggestionsResponse { + /** + * The desired location of errors incurred during the Import. + */ + errorConfig?: Schema$GoogleCloudDiscoveryengineV1ImportErrorConfig; + /** + * A sample of errors encountered while processing the request. + */ + errorSamples?: Schema$GoogleRpcStatus[]; + } + /** + * Metadata related to the progress of the ImportDocuments operation. This is returned by the google.longrunning.Operation.metadata field. + */ + export interface Schema$GoogleCloudDiscoveryengineV1ImportDocumentsMetadata { + /** + * Operation create time. + */ + createTime?: string | null; + /** + * Count of entries that encountered errors while processing. + */ + failureCount?: string | null; + /** + * Count of entries that were processed successfully. + */ + successCount?: string | null; + /** + * Total count of entries that were processed. + */ + totalCount?: string | null; + /** + * Operation last update time. If the operation is done, this is also the finish time. + */ + updateTime?: string | null; + } + /** + * 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. + */ + export interface Schema$GoogleCloudDiscoveryengineV1ImportDocumentsResponse { + /** + * Echoes the destination for the complete errors in the request if set. + */ + errorConfig?: Schema$GoogleCloudDiscoveryengineV1ImportErrorConfig; + /** + * A sample of errors encountered while processing the request. + */ + errorSamples?: Schema$GoogleRpcStatus[]; + } + /** + * Configuration of destination for Import related errors. + */ + export interface Schema$GoogleCloudDiscoveryengineV1ImportErrorConfig { + /** + * 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. + */ + gcsPrefix?: string | null; + } + /** + * Metadata related to the progress of the ImportSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field. + */ + export interface Schema$GoogleCloudDiscoveryengineV1ImportSuggestionDenyListEntriesMetadata { + /** + * Operation create time. + */ + createTime?: string | null; + /** + * Operation last update time. If the operation is done, this is also the finish time. + */ + updateTime?: string | null; + } + /** + * Response message for CompletionService.ImportSuggestionDenyListEntries method. + */ + export interface Schema$GoogleCloudDiscoveryengineV1ImportSuggestionDenyListEntriesResponse { + /** + * A sample of errors encountered while processing the request. + */ + errorSamples?: Schema$GoogleRpcStatus[]; + /** + * Count of deny list entries that failed to be imported. + */ + failedEntriesCount?: string | null; + /** + * Count of deny list entries successfully imported. + */ + importedEntriesCount?: string | null; + } + /** + * Metadata related to the progress of the Import operation. This is returned by the google.longrunning.Operation.metadata field. + */ + export interface Schema$GoogleCloudDiscoveryengineV1ImportUserEventsMetadata { + /** + * Operation create time. + */ + createTime?: string | null; + /** + * Count of entries that encountered errors while processing. + */ + failureCount?: string | null; + /** + * Count of entries that were processed successfully. + */ + successCount?: string | null; + /** + * Operation last update time. If the operation is done, this is also the finish time. + */ + updateTime?: string | null; + } + /** + * 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. + */ + export interface Schema$GoogleCloudDiscoveryengineV1ImportUserEventsResponse { + /** + * Echoes the destination for the complete errors if this field was set in the request. + */ + errorConfig?: Schema$GoogleCloudDiscoveryengineV1ImportErrorConfig; + /** + * A sample of errors encountered while processing the request. + */ + errorSamples?: Schema$GoogleRpcStatus[]; + /** + * Count of user events imported with complete existing Documents. + */ + joinedEventsCount?: string | null; + /** + * Count of user events imported, but with Document information not found in the existing Branch. + */ + unjoinedEventsCount?: string | null; + } + /** + * Metadata and configurations for a Google Cloud project in the service. + */ + export interface Schema$GoogleCloudDiscoveryengineV1Project { + /** + * Output only. The timestamp when this project is created. + */ + createTime?: string | null; + /** + * Output only. Full resource name of the project, for example `projects/{project_number\}`. Note that when making requests, project number and project id are both acceptable, but the server will always respond in project number. + */ + name?: string | null; + /** + * Output only. The timestamp when this project is successfully provisioned. Empty value means this project is still provisioning and is not ready for use. + */ + provisionCompletionTime?: string | null; + /** + * Output only. A map of terms of services. The key is the `id` of ServiceTerms. + */ + serviceTermsMap?: { + [key: string]: Schema$GoogleCloudDiscoveryengineV1ProjectServiceTerms; + } | null; + } + /** + * Metadata about the terms of service. + */ + export interface Schema$GoogleCloudDiscoveryengineV1ProjectServiceTerms { + /** + * The last time when the project agreed to the terms of service. + */ + acceptTime?: string | null; + /** + * The last time when the project declined or revoked the agreement to terms of service. + */ + declineTime?: string | null; + /** + * 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`. + */ + id?: string | null; + /** + * Whether the project has accepted/rejected the service terms or it is still pending. + */ + state?: string | null; + /** + * The version string of the terms of service. For acceptable values, see the comments for id above. + */ + version?: string | null; + } + /** + * Metadata associated with a project provision operation. + */ + export interface Schema$GoogleCloudDiscoveryengineV1ProvisionProjectMetadata {} + /** + * Metadata related to the progress of the PurgeCompletionSuggestions operation. This is returned by the google.longrunning.Operation.metadata field. + */ + export interface Schema$GoogleCloudDiscoveryengineV1PurgeCompletionSuggestionsMetadata { + /** + * Operation create time. + */ + createTime?: string | null; + /** + * Operation last update time. If the operation is done, this is also the finish time. + */ + updateTime?: string | null; + } + /** + * Response message for CompletionService.PurgeCompletionSuggestions method. + */ + export interface Schema$GoogleCloudDiscoveryengineV1PurgeCompletionSuggestionsResponse { + /** + * A sample of errors encountered while processing the request. + */ + errorSamples?: Schema$GoogleRpcStatus[]; + /** + * Whether the completion suggestions were successfully purged. + */ + purgeSucceeded?: boolean | null; + } + /** + * Metadata related to the progress of the PurgeDocuments operation. This will be returned by the google.longrunning.Operation.metadata field. + */ + export interface Schema$GoogleCloudDiscoveryengineV1PurgeDocumentsMetadata { + /** + * Operation create time. + */ + createTime?: string | null; + /** + * Count of entries that encountered errors while processing. + */ + failureCount?: string | null; + /** + * Count of entries that were ignored as entries were not found. + */ + ignoredCount?: string | null; + /** + * Count of entries that were deleted successfully. + */ + successCount?: string | null; + /** + * Operation last update time. If the operation is done, this is also the finish time. + */ + updateTime?: string | null; + } + /** + * 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. + */ + export interface Schema$GoogleCloudDiscoveryengineV1PurgeDocumentsResponse { + /** + * The total count of documents purged as a result of the operation. + */ + purgeCount?: string | null; + /** + * 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. + */ + purgeSample?: string[] | null; + } + /** + * Metadata related to the progress of the PurgeSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field. + */ + export interface Schema$GoogleCloudDiscoveryengineV1PurgeSuggestionDenyListEntriesMetadata { + /** + * Operation create time. + */ + createTime?: string | null; + /** + * Operation last update time. If the operation is done, this is also the finish time. + */ + updateTime?: string | null; + } + /** + * Response message for CompletionService.PurgeSuggestionDenyListEntries method. + */ + export interface Schema$GoogleCloudDiscoveryengineV1PurgeSuggestionDenyListEntriesResponse { + /** + * A sample of errors encountered while processing the request. + */ + errorSamples?: Schema$GoogleRpcStatus[]; + /** + * Number of suggestion deny list entries purged. + */ + purgeCount?: string | null; + } + /** + * Defines the structure and layout of a type of document data. + */ + export interface Schema$GoogleCloudDiscoveryengineV1Schema { + /** + * The JSON representation of the schema. + */ + jsonSchema?: string | null; + /** + * 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. + */ + name?: string | null; + /** + * The structured representation of the schema. + */ + structSchema?: {[key: string]: any} | null; + } + /** + * Verification information for target sites in advanced site search. + */ + export interface Schema$GoogleCloudDiscoveryengineV1SiteVerificationInfo { + /** + * Site verification state indicating the ownership and validity. + */ + siteVerificationState?: string | null; + /** + * Latest site verification time. + */ + verifyTime?: string | null; + } + /** + * A target site for the SiteSearchEngine. + */ + export interface Schema$GoogleCloudDiscoveryengineV1TargetSite { + /** + * 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. + */ + exactMatch?: boolean | null; + /** + * Output only. Failure reason. + */ + failureReason?: Schema$GoogleCloudDiscoveryengineV1TargetSiteFailureReason; + /** + * Output only. This is system-generated based on the provided_uri_pattern. + */ + generatedUriPattern?: string | null; + /** + * Output only. Indexing status. + */ + indexingStatus?: string | null; + /** + * 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. + */ + name?: string | null; + /** + * Required. Input only. The user provided URI pattern from which the `generated_uri_pattern` is generated. + */ + providedUriPattern?: string | null; + /** + * Output only. Root domain of the provided_uri_pattern. + */ + rootDomainUri?: string | null; + /** + * Output only. Site ownership and validity verification status. + */ + siteVerificationInfo?: Schema$GoogleCloudDiscoveryengineV1SiteVerificationInfo; + /** + * The type of the target site, e.g., whether the site is to be included or excluded. + */ + type?: string | null; + /** + * Output only. The target site's last updated time. + */ + updateTime?: string | null; + } + /** + * Site search indexing failure reasons. + */ + export interface Schema$GoogleCloudDiscoveryengineV1TargetSiteFailureReason { + /** + * Failed due to insufficient quota. + */ + quotaFailure?: Schema$GoogleCloudDiscoveryengineV1TargetSiteFailureReasonQuotaFailure; + } + /** + * Failed due to insufficient quota. + */ + export interface Schema$GoogleCloudDiscoveryengineV1TargetSiteFailureReasonQuotaFailure { + /** + * This number is an estimation on how much total quota this project needs to successfully complete indexing. + */ + totalRequiredQuota?: string | null; + } + /** + * Metadata for UpdateSchema LRO. + */ + export interface Schema$GoogleCloudDiscoveryengineV1UpdateSchemaMetadata { + /** + * Operation create time. + */ + createTime?: string | null; + /** + * Operation last update time. If the operation is done, this is also the finish time. + */ + updateTime?: string | null; + } + /** + * Metadata related to the progress of the SiteSearchEngineService.UpdateTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field. + */ + export interface Schema$GoogleCloudDiscoveryengineV1UpdateTargetSiteMetadata { + /** + * Operation create time. + */ + createTime?: string | null; + /** + * Operation last update time. If the operation is done, this is also the finish time. + */ + updateTime?: string | null; + } + /** + * The request message for Operations.CancelOperation. + */ + export interface Schema$GoogleLongrunningCancelOperationRequest {} + /** + * The response message for Operations.ListOperations. + */ + export interface Schema$GoogleLongrunningListOperationsResponse { + /** + * The standard List next-page token. + */ + nextPageToken?: string | null; + /** + * A list of operations that matches the specified filter in the request. + */ + operations?: Schema$GoogleLongrunningOperation[]; + } + /** + * This resource represents a long-running operation that is the result of a network API call. + */ + export interface Schema$GoogleLongrunningOperation { + /** + * 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. + */ + done?: boolean | null; + /** + * The error result of the operation in case of failure or cancellation. + */ + error?: Schema$GoogleRpcStatus; + /** + * 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. + */ + metadata?: {[key: string]: any} | null; + /** + * 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\}`. + */ + name?: string | null; + /** + * 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`. + */ + response?: {[key: string]: any} | null; + } + /** + * A single strongly-typed value. + */ + export interface Schema$GoogleMonitoringV3TypedValue { + /** + * A Boolean value: `true` or `false`. + */ + boolValue?: boolean | null; + /** + * A distribution value. + */ + distributionValue?: Schema$GoogleApiDistribution; + /** + * A 64-bit double-precision floating-point number. Its magnitude is approximately ±10±300 and it has 16 significant digits of precision. + */ + doubleValue?: number | null; + /** + * A 64-bit integer. Its range is approximately ±9.2x1018. + */ + int64Value?: string | null; + /** + * A variable-length string value. + */ + stringValue?: string | null; + } + /** + * 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); \} + */ + export interface Schema$GoogleProtobufEmpty {} + /** + * 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). + */ + export interface Schema$GoogleRpcStatus { + /** + * The status code, which should be an enum value of google.rpc.Code. + */ + code?: number | null; + /** + * A list of messages that carry the error details. There is a common set of message types for APIs to use. + */ + details?: Array<{[key: string]: any}> | null; + /** + * 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. + */ + message?: string | null; + } + /** + * 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 + */ + export interface Schema$GoogleTypeDate { + /** + * 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. + */ + day?: number | null; + /** + * Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + */ + month?: number | null; + /** + * Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + */ + year?: number | null; + } + /** + * 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. + */ + export interface Schema$GoogleTypeExpr { + /** + * Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. + */ + description?: string | null; + /** + * Textual representation of an expression in Common Expression Language syntax. + */ + expression?: string | null; + /** + * Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. + */ + location?: string | null; + /** + * 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. + */ + title?: string | null; + } + + export class Resource$Projects { + context: APIRequestContext; + locations: Resource$Projects$Locations; + operations: Resource$Projects$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.locations = new Resource$Projects$Locations(this.context); + this.operations = new Resource$Projects$Operations(this.context); + } + + /** + * Gets a Project. Returns NOT_FOUND when the project is not yet created. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Projects$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Projects$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * 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. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + provision( + params: Params$Resource$Projects$Provision, + options: StreamMethodOptions + ): GaxiosPromise; + provision( + params?: Params$Resource$Projects$Provision, + options?: MethodOptions + ): GaxiosPromise; + provision( + params: Params$Resource$Projects$Provision, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + provision( + params: Params$Resource$Projects$Provision, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + provision( + params: Params$Resource$Projects$Provision, + callback: BodyResponseCallback + ): void; + provision( + callback: BodyResponseCallback + ): void; + provision( + paramsOrCallback?: + | Params$Resource$Projects$Provision + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Provision; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Provision; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}:provision').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Updates service terms for this project. This method can be used to retroactively accept the latest terms. Terms available for update: * [Terms for data use](https://cloud.google.com/retail/data-use-terms) + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + reportConsentChange( + params: Params$Resource$Projects$Reportconsentchange, + options: StreamMethodOptions + ): GaxiosPromise; + reportConsentChange( + params?: Params$Resource$Projects$Reportconsentchange, + options?: MethodOptions + ): GaxiosPromise; + reportConsentChange( + params: Params$Resource$Projects$Reportconsentchange, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + reportConsentChange( + params: Params$Resource$Projects$Reportconsentchange, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + reportConsentChange( + params: Params$Resource$Projects$Reportconsentchange, + callback: BodyResponseCallback + ): void; + reportConsentChange( + callback: BodyResponseCallback + ): void; + reportConsentChange( + paramsOrCallback?: + | Params$Resource$Projects$Reportconsentchange + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Reportconsentchange; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Reportconsentchange; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+project}:reportConsentChange').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project'], + pathParams: ['project'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Projects$Get extends StandardParameters { + /** + * Required. Full resource name of a Project, such as `projects/{project_id_or_number\}`. + */ + name?: string; + } + export interface Params$Resource$Projects$Provision + extends StandardParameters { + /** + * Required. Full resource name of a Project, such as `projects/{project_id_or_number\}`. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaProvisionProjectRequest; + } + export interface Params$Resource$Projects$Reportconsentchange + extends StandardParameters { + /** + * Required. Full resource name of a Project, such as `projects/{project_id_or_number\}`. + */ + project?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaReportConsentChangeRequest; + } + + export class Resource$Projects$Locations { + context: APIRequestContext; + collections: Resource$Projects$Locations$Collections; + dataStores: Resource$Projects$Locations$Datastores; + evaluations: Resource$Projects$Locations$Evaluations; + groundingConfigs: Resource$Projects$Locations$Groundingconfigs; + identity_mapping_stores: Resource$Projects$Locations$Identity_mapping_stores; + operations: Resource$Projects$Locations$Operations; + rankingConfigs: Resource$Projects$Locations$Rankingconfigs; + requirements: Resource$Projects$Locations$Requirements; + sampleQuerySets: Resource$Projects$Locations$Samplequerysets; + userEvents: Resource$Projects$Locations$Userevents; + constructor(context: APIRequestContext) { + this.context = context; + this.collections = new Resource$Projects$Locations$Collections( + this.context + ); + this.dataStores = new Resource$Projects$Locations$Datastores( + this.context + ); + this.evaluations = new Resource$Projects$Locations$Evaluations( + this.context + ); + this.groundingConfigs = new Resource$Projects$Locations$Groundingconfigs( + this.context + ); + this.identity_mapping_stores = + new Resource$Projects$Locations$Identity_mapping_stores(this.context); + this.operations = new Resource$Projects$Locations$Operations( + this.context + ); + this.rankingConfigs = new Resource$Projects$Locations$Rankingconfigs( + this.context + ); + this.requirements = new Resource$Projects$Locations$Requirements( + this.context + ); + this.sampleQuerySets = new Resource$Projects$Locations$Samplequerysets( + this.context + ); + this.userEvents = new Resource$Projects$Locations$Userevents( + this.context + ); + } + + /** + * Estimates the data size to be used by a customer. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + estimateDataSize( + params: Params$Resource$Projects$Locations$Estimatedatasize, + options: StreamMethodOptions + ): GaxiosPromise; + estimateDataSize( + params?: Params$Resource$Projects$Locations$Estimatedatasize, + options?: MethodOptions + ): GaxiosPromise; + estimateDataSize( + params: Params$Resource$Projects$Locations$Estimatedatasize, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + estimateDataSize( + params: Params$Resource$Projects$Locations$Estimatedatasize, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + estimateDataSize( + params: Params$Resource$Projects$Locations$Estimatedatasize, + callback: BodyResponseCallback + ): void; + estimateDataSize( + callback: BodyResponseCallback + ): void; + estimateDataSize( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Estimatedatasize + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Estimatedatasize; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Estimatedatasize; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+location}:estimateDataSize').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['location'], + pathParams: ['location'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets the AclConfig. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + getAclConfig( + params: Params$Resource$Projects$Locations$Getaclconfig, + options: StreamMethodOptions + ): GaxiosPromise; + getAclConfig( + params?: Params$Resource$Projects$Locations$Getaclconfig, + options?: MethodOptions + ): GaxiosPromise; + getAclConfig( + params: Params$Resource$Projects$Locations$Getaclconfig, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getAclConfig( + params: Params$Resource$Projects$Locations$Getaclconfig, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getAclConfig( + params: Params$Resource$Projects$Locations$Getaclconfig, + callback: BodyResponseCallback + ): void; + getAclConfig( + callback: BodyResponseCallback + ): void; + getAclConfig( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Getaclconfig + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Getaclconfig; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Getaclconfig; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Default Acl Configuration for use in a location of a customer's project. Updates will only reflect to new data stores. Existing data stores will still use the old value. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + updateAclConfig( + params: Params$Resource$Projects$Locations$Updateaclconfig, + options: StreamMethodOptions + ): GaxiosPromise; + updateAclConfig( + params?: Params$Resource$Projects$Locations$Updateaclconfig, + options?: MethodOptions + ): GaxiosPromise; + updateAclConfig( + params: Params$Resource$Projects$Locations$Updateaclconfig, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + updateAclConfig( + params: Params$Resource$Projects$Locations$Updateaclconfig, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + updateAclConfig( + params: Params$Resource$Projects$Locations$Updateaclconfig, + callback: BodyResponseCallback + ): void; + updateAclConfig( + callback: BodyResponseCallback + ): void; + updateAclConfig( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Updateaclconfig + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Updateaclconfig; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Updateaclconfig; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Projects$Locations$Estimatedatasize + extends StandardParameters { + /** + * Required. Full resource name of the location, such as `projects/{project\}/locations/{location\}`. + */ + location?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaEstimateDataSizeRequest; + } + export interface Params$Resource$Projects$Locations$Getaclconfig + extends StandardParameters { + /** + * Required. Resource name of AclConfig, such as `projects/x/locations/x/aclConfig`. If the caller does not have permission to access the AclConfig, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Updateaclconfig + extends StandardParameters { + /** + * 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. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaAclConfig; + } + + export class Resource$Projects$Locations$Collections { + context: APIRequestContext; + dataConnector: Resource$Projects$Locations$Collections$Dataconnector; + dataStores: Resource$Projects$Locations$Collections$Datastores; + engines: Resource$Projects$Locations$Collections$Engines; + operations: Resource$Projects$Locations$Collections$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.dataConnector = + new Resource$Projects$Locations$Collections$Dataconnector(this.context); + this.dataStores = new Resource$Projects$Locations$Collections$Datastores( + this.context + ); + this.engines = new Resource$Projects$Locations$Collections$Engines( + this.context + ); + this.operations = new Resource$Projects$Locations$Collections$Operations( + this.context + ); + } + } + + export class Resource$Projects$Locations$Collections$Dataconnector { + context: APIRequestContext; + operations: Resource$Projects$Locations$Collections$Dataconnector$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.operations = + new Resource$Projects$Locations$Collections$Dataconnector$Operations( + this.context + ); + } + } + + export class Resource$Projects$Locations$Collections$Dataconnector$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * 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. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}/operations').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$Get + extends StandardParameters { + /** + * The name of the operation resource. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$List + extends StandardParameters { + /** + * The standard list filter. + */ + filter?: string; + /** + * The name of the operation's parent resource. + */ + name?: string; + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. + */ + pageToken?: string; + } + + export class Resource$Projects$Locations$Collections$Datastores { + context: APIRequestContext; + branches: Resource$Projects$Locations$Collections$Datastores$Branches; + completionSuggestions: Resource$Projects$Locations$Collections$Datastores$Completionsuggestions; + controls: Resource$Projects$Locations$Collections$Datastores$Controls; + conversations: Resource$Projects$Locations$Collections$Datastores$Conversations; + customModels: Resource$Projects$Locations$Collections$Datastores$Custommodels; + models: Resource$Projects$Locations$Collections$Datastores$Models; + operations: Resource$Projects$Locations$Collections$Datastores$Operations; + schemas: Resource$Projects$Locations$Collections$Datastores$Schemas; + servingConfigs: Resource$Projects$Locations$Collections$Datastores$Servingconfigs; + sessions: Resource$Projects$Locations$Collections$Datastores$Sessions; + siteSearchEngine: Resource$Projects$Locations$Collections$Datastores$Sitesearchengine; + suggestionDenyListEntries: Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries; + userEvents: Resource$Projects$Locations$Collections$Datastores$Userevents; + constructor(context: APIRequestContext) { + this.context = context; + this.branches = + new Resource$Projects$Locations$Collections$Datastores$Branches( + this.context + ); + this.completionSuggestions = + new Resource$Projects$Locations$Collections$Datastores$Completionsuggestions( + this.context + ); + this.controls = + new Resource$Projects$Locations$Collections$Datastores$Controls( + this.context + ); + this.conversations = + new Resource$Projects$Locations$Collections$Datastores$Conversations( + this.context + ); + this.customModels = + new Resource$Projects$Locations$Collections$Datastores$Custommodels( + this.context + ); + this.models = + new Resource$Projects$Locations$Collections$Datastores$Models( + this.context + ); + this.operations = + new Resource$Projects$Locations$Collections$Datastores$Operations( + this.context + ); + this.schemas = + new Resource$Projects$Locations$Collections$Datastores$Schemas( + this.context + ); + this.servingConfigs = + new Resource$Projects$Locations$Collections$Datastores$Servingconfigs( + this.context + ); + this.sessions = + new Resource$Projects$Locations$Collections$Datastores$Sessions( + this.context + ); + this.siteSearchEngine = + new Resource$Projects$Locations$Collections$Datastores$Sitesearchengine( + this.context + ); + this.suggestionDenyListEntries = + new Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries( + this.context + ); + this.userEvents = + new Resource$Projects$Locations$Collections$Datastores$Userevents( + this.context + ); + } + + /** + * Completes the specified user input with keyword suggestions. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + completeQuery( + params: Params$Resource$Projects$Locations$Collections$Datastores$Completequery, + options: StreamMethodOptions + ): GaxiosPromise; + completeQuery( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Completequery, + options?: MethodOptions + ): GaxiosPromise; + completeQuery( + params: Params$Resource$Projects$Locations$Collections$Datastores$Completequery, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + completeQuery( + params: Params$Resource$Projects$Locations$Collections$Datastores$Completequery, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + completeQuery( + params: Params$Resource$Projects$Locations$Collections$Datastores$Completequery, + callback: BodyResponseCallback + ): void; + completeQuery( + callback: BodyResponseCallback + ): void; + completeQuery( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Collections$Datastores$Completequery + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Completequery; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Collections$Datastores$Completequery; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+dataStore}:completeQuery').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['dataStore'], + pathParams: ['dataStore'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * 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. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + create( + params: Params$Resource$Projects$Locations$Collections$Datastores$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Collections$Datastores$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Collections$Datastores$Create, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Collections$Datastores$Create, + callback: BodyResponseCallback + ): void; + create( + callback: BodyResponseCallback + ): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Collections$Datastores$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Collections$Datastores$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+parent}/dataStores').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Deletes a DataStore. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. */ - title?: string | null; - } + delete( + params: Params$Resource$Projects$Locations$Collections$Datastores$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Collections$Datastores$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Collections$Datastores$Delete, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Collections$Datastores$Delete, + callback: BodyResponseCallback + ): void; + delete( + callback: BodyResponseCallback + ): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Collections$Datastores$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; - export class Resource$Projects { - context: APIRequestContext; - locations: Resource$Projects$Locations; - operations: Resource$Projects$Operations; - constructor(context: APIRequestContext) { - this.context = context; - this.locations = new Resource$Projects$Locations(this.context); - this.operations = new Resource$Projects$Operations(this.context); + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Collections$Datastores$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } } /** - * Gets a Project. Returns NOT_FOUND when the project is not yet created. + * Gets a DataStore. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -7268,55 +9814,57 @@ export namespace discoveryengine_v1alpha { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Get, + params: Params$Resource$Projects$Locations$Collections$Datastores$Get, options: StreamMethodOptions ): GaxiosPromise; get( - params?: Params$Resource$Projects$Get, + params?: Params$Resource$Projects$Locations$Collections$Datastores$Get, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; get( - params: Params$Resource$Projects$Get, + params: Params$Resource$Projects$Locations$Collections$Datastores$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Get, + params: Params$Resource$Projects$Locations$Collections$Datastores$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Get, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Collections$Datastores$Get, + callback: BodyResponseCallback ): void; get( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Projects$Get; + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Get; + params = + {} as Params$Resource$Projects$Locations$Collections$Datastores$Get; options = {}; } @@ -7342,76 +9890,173 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * 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. + * Gets a DocumentProcessingConfig. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - provision( - params: Params$Resource$Projects$Provision, + getDocumentProcessingConfig( + params: Params$Resource$Projects$Locations$Collections$Datastores$Getdocumentprocessingconfig, + options: StreamMethodOptions + ): GaxiosPromise; + getDocumentProcessingConfig( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Getdocumentprocessingconfig, + options?: MethodOptions + ): GaxiosPromise; + getDocumentProcessingConfig( + params: Params$Resource$Projects$Locations$Collections$Datastores$Getdocumentprocessingconfig, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getDocumentProcessingConfig( + params: Params$Resource$Projects$Locations$Collections$Datastores$Getdocumentprocessingconfig, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getDocumentProcessingConfig( + params: Params$Resource$Projects$Locations$Collections$Datastores$Getdocumentprocessingconfig, + callback: BodyResponseCallback + ): void; + getDocumentProcessingConfig( + callback: BodyResponseCallback + ): void; + getDocumentProcessingConfig( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Collections$Datastores$Getdocumentprocessingconfig + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Getdocumentprocessingconfig; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Collections$Datastores$Getdocumentprocessingconfig; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Gets the SiteSearchEngine. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + getSiteSearchEngine( + params: Params$Resource$Projects$Locations$Collections$Datastores$Getsitesearchengine, options: StreamMethodOptions ): GaxiosPromise; - provision( - params?: Params$Resource$Projects$Provision, + getSiteSearchEngine( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Getsitesearchengine, options?: MethodOptions - ): GaxiosPromise; - provision( - params: Params$Resource$Projects$Provision, + ): GaxiosPromise; + getSiteSearchEngine( + params: Params$Resource$Projects$Locations$Collections$Datastores$Getsitesearchengine, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - provision( - params: Params$Resource$Projects$Provision, + getSiteSearchEngine( + params: Params$Resource$Projects$Locations$Collections$Datastores$Getsitesearchengine, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - provision( - params: Params$Resource$Projects$Provision, - callback: BodyResponseCallback + getSiteSearchEngine( + params: Params$Resource$Projects$Locations$Collections$Datastores$Getsitesearchengine, + callback: BodyResponseCallback ): void; - provision( - callback: BodyResponseCallback + getSiteSearchEngine( + callback: BodyResponseCallback ): void; - provision( + getSiteSearchEngine( paramsOrCallback?: - | Params$Resource$Projects$Provision - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Getsitesearchengine + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Provision; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Getsitesearchengine; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Provision; + params = + {} as Params$Resource$Projects$Locations$Collections$Datastores$Getsitesearchengine; options = {}; } @@ -7425,11 +10070,8 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}:provision').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options @@ -7440,74 +10082,77 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Updates service terms for this project. This method can be used to retroactively accept the latest terms. Terms available for update: * [Terms for data use](https://cloud.google.com/retail/data-use-terms) + * Lists all the DataStores associated with the project. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - reportConsentChange( - params: Params$Resource$Projects$Reportconsentchange, + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$List, options: StreamMethodOptions ): GaxiosPromise; - reportConsentChange( - params?: Params$Resource$Projects$Reportconsentchange, + list( + params?: Params$Resource$Projects$Locations$Collections$Datastores$List, options?: MethodOptions - ): GaxiosPromise; - reportConsentChange( - params: Params$Resource$Projects$Reportconsentchange, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - reportConsentChange( - params: Params$Resource$Projects$Reportconsentchange, + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - reportConsentChange( - params: Params$Resource$Projects$Reportconsentchange, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$List, + callback: BodyResponseCallback ): void; - reportConsentChange( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - reportConsentChange( + list( paramsOrCallback?: - | Params$Resource$Projects$Reportconsentchange - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Reportconsentchange; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Reportconsentchange; + params = + {} as Params$Resource$Projects$Locations$Collections$Datastores$List; options = {}; } @@ -7521,165 +10166,92 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+project}:reportConsentChange').replace( + url: (rootUrl + '/v1alpha/{+parent}/dataStores').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['project'], - pathParams: ['project'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } - } - - export interface Params$Resource$Projects$Get extends StandardParameters { - /** - * Required. Full resource name of a Project, such as `projects/{project_id_or_number\}`. - */ - name?: string; - } - export interface Params$Resource$Projects$Provision - extends StandardParameters { - /** - * Required. Full resource name of a Project, such as `projects/{project_id_or_number\}`. - */ - name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaProvisionProjectRequest; - } - export interface Params$Resource$Projects$Reportconsentchange - extends StandardParameters { - /** - * Required. Full resource name of a Project, such as `projects/{project_id_or_number\}`. - */ - project?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaReportConsentChangeRequest; - } - - export class Resource$Projects$Locations { - context: APIRequestContext; - collections: Resource$Projects$Locations$Collections; - dataStores: Resource$Projects$Locations$Datastores; - evaluations: Resource$Projects$Locations$Evaluations; - groundingConfigs: Resource$Projects$Locations$Groundingconfigs; - operations: Resource$Projects$Locations$Operations; - rankingConfigs: Resource$Projects$Locations$Rankingconfigs; - requirements: Resource$Projects$Locations$Requirements; - sampleQuerySets: Resource$Projects$Locations$Samplequerysets; - userEvents: Resource$Projects$Locations$Userevents; - constructor(context: APIRequestContext) { - this.context = context; - this.collections = new Resource$Projects$Locations$Collections( - this.context - ); - this.dataStores = new Resource$Projects$Locations$Datastores( - this.context - ); - this.evaluations = new Resource$Projects$Locations$Evaluations( - this.context - ); - this.groundingConfigs = new Resource$Projects$Locations$Groundingconfigs( - this.context - ); - this.operations = new Resource$Projects$Locations$Operations( - this.context - ); - this.rankingConfigs = new Resource$Projects$Locations$Rankingconfigs( - this.context - ); - this.requirements = new Resource$Projects$Locations$Requirements( - this.context - ); - this.sampleQuerySets = new Resource$Projects$Locations$Samplequerysets( - this.context - ); - this.userEvents = new Resource$Projects$Locations$Userevents( - this.context - ); - } /** - * Estimates the data size to be used by a customer. + * Updates a DataStore * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - estimateDataSize( - params: Params$Resource$Projects$Locations$Estimatedatasize, + patch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Patch, options: StreamMethodOptions ): GaxiosPromise; - estimateDataSize( - params?: Params$Resource$Projects$Locations$Estimatedatasize, + patch( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Patch, options?: MethodOptions - ): GaxiosPromise; - estimateDataSize( - params: Params$Resource$Projects$Locations$Estimatedatasize, + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - estimateDataSize( - params: Params$Resource$Projects$Locations$Estimatedatasize, + patch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Patch, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - estimateDataSize( - params: Params$Resource$Projects$Locations$Estimatedatasize, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Patch, + callback: BodyResponseCallback ): void; - estimateDataSize( - callback: BodyResponseCallback + patch( + callback: BodyResponseCallback ): void; - estimateDataSize( + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Estimatedatasize - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Estimatedatasize; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Estimatedatasize; + params = + {} as Params$Resource$Projects$Locations$Collections$Datastores$Patch; options = {}; } @@ -7691,91 +10263,91 @@ export namespace discoveryengine_v1alpha { const rootUrl = options.rootUrl || 'https://discoveryengine.googleapis.com/'; const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha/{+location}:estimateDataSize').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', apiVersion: '', }, options ), params, - requiredParams: ['location'], - pathParams: ['location'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Gets the AclConfig. + * Trains a custom model. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - getAclConfig( - params: Params$Resource$Projects$Locations$Getaclconfig, + trainCustomModel( + params: Params$Resource$Projects$Locations$Collections$Datastores$Traincustommodel, options: StreamMethodOptions ): GaxiosPromise; - getAclConfig( - params?: Params$Resource$Projects$Locations$Getaclconfig, + trainCustomModel( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Traincustommodel, options?: MethodOptions - ): GaxiosPromise; - getAclConfig( - params: Params$Resource$Projects$Locations$Getaclconfig, + ): GaxiosPromise; + trainCustomModel( + params: Params$Resource$Projects$Locations$Collections$Datastores$Traincustommodel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - getAclConfig( - params: Params$Resource$Projects$Locations$Getaclconfig, + trainCustomModel( + params: Params$Resource$Projects$Locations$Collections$Datastores$Traincustommodel, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - getAclConfig( - params: Params$Resource$Projects$Locations$Getaclconfig, - callback: BodyResponseCallback + trainCustomModel( + params: Params$Resource$Projects$Locations$Collections$Datastores$Traincustommodel, + callback: BodyResponseCallback ): void; - getAclConfig( - callback: BodyResponseCallback + trainCustomModel( + callback: BodyResponseCallback ): void; - getAclConfig( + trainCustomModel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Getaclconfig - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Traincustommodel + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Getaclconfig; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Traincustommodel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Getaclconfig; + params = + {} as Params$Resource$Projects$Locations$Collections$Datastores$Traincustommodel; options = {}; } @@ -7789,88 +10361,90 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1alpha/{+dataStore}:trainCustomModel').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['dataStore'], + pathParams: ['dataStore'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Default Acl Configuration for use in a location of a customer's project. Updates will only reflect to new data stores. Existing data stores will still use the old value. + * Updates the DocumentProcessingConfig. DocumentProcessingConfig is a singleon resource of DataStore. It's empty when DataStore is created. The first call to this method will set up DocumentProcessingConfig. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - updateAclConfig( - params: Params$Resource$Projects$Locations$Updateaclconfig, + updateDocumentProcessingConfig( + params: Params$Resource$Projects$Locations$Collections$Datastores$Updatedocumentprocessingconfig, options: StreamMethodOptions ): GaxiosPromise; - updateAclConfig( - params?: Params$Resource$Projects$Locations$Updateaclconfig, + updateDocumentProcessingConfig( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Updatedocumentprocessingconfig, options?: MethodOptions - ): GaxiosPromise; - updateAclConfig( - params: Params$Resource$Projects$Locations$Updateaclconfig, + ): GaxiosPromise; + updateDocumentProcessingConfig( + params: Params$Resource$Projects$Locations$Collections$Datastores$Updatedocumentprocessingconfig, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - updateAclConfig( - params: Params$Resource$Projects$Locations$Updateaclconfig, + updateDocumentProcessingConfig( + params: Params$Resource$Projects$Locations$Collections$Datastores$Updatedocumentprocessingconfig, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - updateAclConfig( - params: Params$Resource$Projects$Locations$Updateaclconfig, - callback: BodyResponseCallback + updateDocumentProcessingConfig( + params: Params$Resource$Projects$Locations$Collections$Datastores$Updatedocumentprocessingconfig, + callback: BodyResponseCallback ): void; - updateAclConfig( - callback: BodyResponseCallback + updateDocumentProcessingConfig( + callback: BodyResponseCallback ): void; - updateAclConfig( + updateDocumentProcessingConfig( paramsOrCallback?: - | Params$Resource$Projects$Locations$Updateaclconfig - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Updatedocumentprocessingconfig + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Updateaclconfig; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Updatedocumentprocessingconfig; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Updateaclconfig; + params = + {} as Params$Resource$Projects$Locations$Collections$Datastores$Updatedocumentprocessingconfig; options = {}; } @@ -7896,150 +10470,241 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } } - export interface Params$Resource$Projects$Locations$Estimatedatasize + export interface Params$Resource$Projects$Locations$Collections$Datastores$Completequery extends StandardParameters { /** - * Required. Full resource name of the location, such as `projects/{project\}/locations/{location\}`. + * Required. The parent data store resource name for which the completion is performed, such as `projects/x/locations/global/collections/default_collection/dataStores/default_data_store`. */ - location?: string; + dataStore?: string; + /** + * 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. + */ + includeTailSuggestions?: boolean; + /** + * Required. The typeahead input used to fetch suggestions. Maximum length is 128 characters. + */ + query?: string; + /** + * Specifies the autocomplete data model. 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. + */ + queryModel?: string; + /** + * 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 SearchRequest.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. + */ + userPseudoId?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Create + extends StandardParameters { + /** + * A boolean flag indicating whether user want to directly create an advanced data store for site search. If the data store is not configured as site search (GENERIC vertical and PUBLIC_WEBSITE content_config), this flag will be ignored. + */ + createAdvancedSiteSearch?: boolean; + /** + * Required. The ID to use for the DataStore, which will become the final component of the DataStore's resource name. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned. + */ + dataStoreId?: string; + /** + * Required. The parent resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}`. + */ + parent?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaEstimateDataSizeRequest; + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaDataStore; } - export interface Params$Resource$Projects$Locations$Getaclconfig + export interface Params$Resource$Projects$Locations$Collections$Datastores$Delete extends StandardParameters { /** - * Required. Resource name of AclConfig, such as `projects/x/locations/x/aclConfig`. If the caller does not have permission to access the AclConfig, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. + * Required. Full resource name of DataStore, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}`. If the caller does not have permission to delete the DataStore, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the DataStore to delete does not exist, a NOT_FOUND error is returned. */ name?: string; } - export interface Params$Resource$Projects$Locations$Updateaclconfig + export interface Params$Resource$Projects$Locations$Collections$Datastores$Get extends StandardParameters { /** - * 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. + * Required. Full resource name of DataStore, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}`. If the caller does not have permission to access the DataStore, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested DataStore does not exist, a NOT_FOUND error is returned. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Getdocumentprocessingconfig + extends StandardParameters { + /** + * Required. Full DocumentProcessingConfig resource name. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/dataStores/{data_store_id\}/documentProcessingConfig` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Getsitesearchengine + extends StandardParameters { + /** + * Required. Resource name of SiteSearchEngine, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine`. If the caller does not have permission to access the [SiteSearchEngine], regardless of whether or not it exists, a PERMISSION_DENIED error is returned. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$List + extends StandardParameters { + /** + * Filter by solution type . For example: `filter = 'solution_type:SOLUTION_TYPE_SEARCH'` + */ + filter?: string; + /** + * Maximum number of DataStores to return. If unspecified, defaults to 10. The maximum allowed value is 50. Values above 50 will be coerced to 50. If this field is negative, an INVALID_ARGUMENT is returned. + */ + pageSize?: number; + /** + * A page token ListDataStoresResponse.next_page_token, received from a previous DataStoreService.ListDataStores call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to DataStoreService.ListDataStores must match the call that provided the page token. Otherwise, an INVALID_ARGUMENT error is returned. + */ + pageToken?: string; + /** + * Required. The parent branch resource name, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}`. If the caller does not have permission to list DataStores under this location, regardless of whether or not this data store exists, a PERMISSION_DENIED error is returned. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Patch + extends StandardParameters { + /** + * 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. */ name?: string; + /** + * Indicates which fields in the provided DataStore to update. If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned. + */ + updateMask?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaAclConfig; + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaDataStore; } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Traincustommodel + extends StandardParameters { + /** + * Required. The resource name of the Data Store, such as `projects/x/locations/global/collections/default_collection/dataStores/default_data_store`. This field is used to identify the data store where to train the models. + */ + dataStore?: string; - export class Resource$Projects$Locations$Collections { - context: APIRequestContext; - dataConnector: Resource$Projects$Locations$Collections$Dataconnector; - dataStores: Resource$Projects$Locations$Collections$Datastores; - engines: Resource$Projects$Locations$Collections$Engines; - operations: Resource$Projects$Locations$Collections$Operations; - constructor(context: APIRequestContext) { - this.context = context; - this.dataConnector = - new Resource$Projects$Locations$Collections$Dataconnector(this.context); - this.dataStores = new Resource$Projects$Locations$Collections$Datastores( - this.context - ); - this.engines = new Resource$Projects$Locations$Collections$Engines( - this.context - ); - this.operations = new Resource$Projects$Locations$Collections$Operations( - this.context - ); - } + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaTrainCustomModelRequest; } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Updatedocumentprocessingconfig + extends StandardParameters { + /** + * The full resource name of the Document Processing Config. Format: `projects/x/locations/x/collections/x/dataStores/x/documentProcessingConfig`. + */ + name?: string; + /** + * Indicates which fields in the provided DocumentProcessingConfig to update. The following are the only supported fields: * DocumentProcessingConfig.ocr_config If not set, all supported fields are updated. + */ + updateMask?: string; - export class Resource$Projects$Locations$Collections$Dataconnector { + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig; + } + + export class Resource$Projects$Locations$Collections$Datastores$Branches { context: APIRequestContext; - operations: Resource$Projects$Locations$Collections$Dataconnector$Operations; + documents: Resource$Projects$Locations$Collections$Datastores$Branches$Documents; + operations: Resource$Projects$Locations$Collections$Datastores$Branches$Operations; constructor(context: APIRequestContext) { this.context = context; + this.documents = + new Resource$Projects$Locations$Collections$Datastores$Branches$Documents( + this.context + ); this.operations = - new Resource$Projects$Locations$Collections$Dataconnector$Operations( + new Resource$Projects$Locations$Collections$Datastores$Branches$Operations( this.context ); } } - export class Resource$Projects$Locations$Collections$Dataconnector$Operations { + export class Resource$Projects$Locations$Collections$Datastores$Branches$Documents { context: APIRequestContext; + chunks: Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Chunks; constructor(context: APIRequestContext) { this.context = context; + this.chunks = + new Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Chunks( + this.context + ); } /** - * 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 Document. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$Get, + create( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Create, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$Get, + create( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Create, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$Get, + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$Get, + create( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Create, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$Get, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Create, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + create( + callback: BodyResponseCallback ): void; - get( + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$Get; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$Get; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Create; options = {}; } @@ -8053,87 +10718,88 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1alpha/{+parent}/documents').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + * Deletes a Document. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$List, + delete( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Delete, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$List, + delete( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Delete, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$List, + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$List, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Delete, + callback: BodyResponseCallback ): void; - list( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$List; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$List; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Delete; options = {}; } @@ -8147,11 +10813,8 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}/operations').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options @@ -8162,176 +10825,171 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } - } - export interface Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$Get - extends StandardParameters { - /** - * The name of the operation resource. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$List - extends StandardParameters { - /** - * The standard list filter. - */ - filter?: string; - /** - * The name of the operation's parent resource. - */ - name?: string; - /** - * The standard list page size. - */ - pageSize?: number; /** - * The standard list page token. + * Gets a Document. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. */ - pageToken?: string; - } + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } - export class Resource$Projects$Locations$Collections$Datastores { - context: APIRequestContext; - branches: Resource$Projects$Locations$Collections$Datastores$Branches; - completionSuggestions: Resource$Projects$Locations$Collections$Datastores$Completionsuggestions; - controls: Resource$Projects$Locations$Collections$Datastores$Controls; - conversations: Resource$Projects$Locations$Collections$Datastores$Conversations; - customModels: Resource$Projects$Locations$Collections$Datastores$Custommodels; - models: Resource$Projects$Locations$Collections$Datastores$Models; - operations: Resource$Projects$Locations$Collections$Datastores$Operations; - schemas: Resource$Projects$Locations$Collections$Datastores$Schemas; - servingConfigs: Resource$Projects$Locations$Collections$Datastores$Servingconfigs; - sessions: Resource$Projects$Locations$Collections$Datastores$Sessions; - siteSearchEngine: Resource$Projects$Locations$Collections$Datastores$Sitesearchengine; - suggestionDenyListEntries: Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries; - userEvents: Resource$Projects$Locations$Collections$Datastores$Userevents; - constructor(context: APIRequestContext) { - this.context = context; - this.branches = - new Resource$Projects$Locations$Collections$Datastores$Branches( - this.context - ); - this.completionSuggestions = - new Resource$Projects$Locations$Collections$Datastores$Completionsuggestions( - this.context - ); - this.controls = - new Resource$Projects$Locations$Collections$Datastores$Controls( - this.context - ); - this.conversations = - new Resource$Projects$Locations$Collections$Datastores$Conversations( - this.context - ); - this.customModels = - new Resource$Projects$Locations$Collections$Datastores$Custommodels( - this.context - ); - this.models = - new Resource$Projects$Locations$Collections$Datastores$Models( - this.context - ); - this.operations = - new Resource$Projects$Locations$Collections$Datastores$Operations( - this.context - ); - this.schemas = - new Resource$Projects$Locations$Collections$Datastores$Schemas( - this.context - ); - this.servingConfigs = - new Resource$Projects$Locations$Collections$Datastores$Servingconfigs( - this.context - ); - this.sessions = - new Resource$Projects$Locations$Collections$Datastores$Sessions( - this.context - ); - this.siteSearchEngine = - new Resource$Projects$Locations$Collections$Datastores$Sitesearchengine( - this.context - ); - this.suggestionDenyListEntries = - new Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries( - this.context + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback ); - this.userEvents = - new Resource$Projects$Locations$Collections$Datastores$Userevents( - this.context + } else { + return createAPIRequest( + parameters ); + } } /** - * Completes the specified user input with keyword suggestions. + * Gets the parsed layout information for a Document. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - completeQuery( - params: Params$Resource$Projects$Locations$Collections$Datastores$Completequery, + getProcessedDocument( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Getprocesseddocument, options: StreamMethodOptions ): GaxiosPromise; - completeQuery( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Completequery, + getProcessedDocument( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Getprocesseddocument, options?: MethodOptions - ): GaxiosPromise; - completeQuery( - params: Params$Resource$Projects$Locations$Collections$Datastores$Completequery, + ): GaxiosPromise; + getProcessedDocument( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Getprocesseddocument, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - completeQuery( - params: Params$Resource$Projects$Locations$Collections$Datastores$Completequery, + getProcessedDocument( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Getprocesseddocument, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - completeQuery( - params: Params$Resource$Projects$Locations$Collections$Datastores$Completequery, - callback: BodyResponseCallback + getProcessedDocument( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Getprocesseddocument, + callback: BodyResponseCallback ): void; - completeQuery( - callback: BodyResponseCallback + getProcessedDocument( + callback: BodyResponseCallback ): void; - completeQuery( + getProcessedDocument( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Completequery - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Getprocesseddocument + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Completequery; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Getprocesseddocument; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Completequery; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Getprocesseddocument; options = {}; } @@ -8345,7 +11003,7 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+dataStore}:completeQuery').replace( + url: (rootUrl + '/v1alpha/{+name}:getProcessedDocument').replace( /([^:]\/)\/+/g, '$1' ), @@ -8355,60 +11013,60 @@ export namespace discoveryengine_v1alpha { options ), params, - requiredParams: ['dataStore'], - pathParams: ['dataStore'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * 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. + * 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. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - create( - params: Params$Resource$Projects$Locations$Collections$Datastores$Create, + import( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Import, options: StreamMethodOptions ): GaxiosPromise; - create( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Create, + import( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Import, options?: MethodOptions ): GaxiosPromise; - create( - params: Params$Resource$Projects$Locations$Collections$Datastores$Create, + import( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Import, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Collections$Datastores$Create, + import( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Import, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Collections$Datastores$Create, + import( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Import, callback: BodyResponseCallback ): void; - create( + import( callback: BodyResponseCallback ): void; - create( + import( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Create + | Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Import | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -8424,13 +11082,13 @@ export namespace discoveryengine_v1alpha { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Create; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Import; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Create; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Import; options = {}; } @@ -8444,7 +11102,7 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/dataStores').replace( + url: (rootUrl + '/v1alpha/{+parent}/documents:import').replace( /([^:]\/)\/+/g, '$1' ), @@ -8469,65 +11127,65 @@ export namespace discoveryengine_v1alpha { } /** - * Deletes a DataStore. + * Gets a list of Documents. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - delete( - params: Params$Resource$Projects$Locations$Collections$Datastores$Delete, + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$List, options: StreamMethodOptions ): GaxiosPromise; - delete( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Delete, + list( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$List, options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Projects$Locations$Collections$Datastores$Delete, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Collections$Datastores$Delete, + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Collections$Datastores$Delete, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$List, + callback: BodyResponseCallback ): void; - delete( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - delete( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Delete; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Delete; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$List; options = {}; } @@ -8541,87 +11199,92 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1alpha/{+parent}/documents').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); - } else { - return createAPIRequest(parameters); + } else { + return createAPIRequest( + parameters + ); } } /** - * Gets a DataStore. + * Updates a Document. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Get, + patch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Patch, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Get, + patch( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Patch, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Get, + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Get, + patch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Patch, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Get, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Patch, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + patch( + callback: BodyResponseCallback ): void; - get( + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Get; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Get; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Patch; options = {}; } @@ -8636,7 +11299,7 @@ export namespace discoveryengine_v1alpha { options: Object.assign( { url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'PATCH', apiVersion: '', }, options @@ -8647,77 +11310,77 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Gets a DocumentProcessingConfig. + * 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. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - getDocumentProcessingConfig( - params: Params$Resource$Projects$Locations$Collections$Datastores$Getdocumentprocessingconfig, + purge( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Purge, options: StreamMethodOptions ): GaxiosPromise; - getDocumentProcessingConfig( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Getdocumentprocessingconfig, + purge( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Purge, options?: MethodOptions - ): GaxiosPromise; - getDocumentProcessingConfig( - params: Params$Resource$Projects$Locations$Collections$Datastores$Getdocumentprocessingconfig, + ): GaxiosPromise; + purge( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Purge, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - getDocumentProcessingConfig( - params: Params$Resource$Projects$Locations$Collections$Datastores$Getdocumentprocessingconfig, + purge( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Purge, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - getDocumentProcessingConfig( - params: Params$Resource$Projects$Locations$Collections$Datastores$Getdocumentprocessingconfig, - callback: BodyResponseCallback + purge( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Purge, + callback: BodyResponseCallback ): void; - getDocumentProcessingConfig( - callback: BodyResponseCallback + purge( + callback: BodyResponseCallback ): void; - getDocumentProcessingConfig( + purge( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Getdocumentprocessingconfig - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Purge + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Getdocumentprocessingconfig; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Purge; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Getdocumentprocessingconfig; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Purge; options = {}; } @@ -8731,89 +11394,202 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1alpha/{+parent}/documents:purge').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } + } + + export interface Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Create + extends StandardParameters { + /** + * Required. The ID to use for the Document, which becomes the final component of the Document.name. If the caller does not have permission to create the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. This field must be unique among all Documents with the same parent. Otherwise, an `ALREADY_EXISTS` error is returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. + */ + documentId?: string; + /** + * Required. The parent resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}`. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaDocument; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Delete + extends StandardParameters { + /** + * Required. Full resource name of Document, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}/documents/{document\}`. If the caller does not have permission to delete the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the Document to delete does not exist, a `NOT_FOUND` error is returned. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Get + extends StandardParameters { + /** + * Required. Full resource name of Document, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}/documents/{document\}`. If the caller does not have permission to access the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the requested Document does not exist, a `NOT_FOUND` error is returned. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Getprocesseddocument + extends StandardParameters { + /** + * Required. Full resource name of Document, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}/documents/{document\}`. If the caller does not have permission to access the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the requested Document does not exist, a `NOT_FOUND` error is returned. + */ + name?: string; + /** + * What format output should be. If unspecified, defaults to JSON. + */ + processedDocumentFormat?: string; + /** + * Required. What type of processing to return. + */ + processedDocumentType?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Import + extends StandardParameters { + /** + * Required. The parent branch resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}`. Requires create/update permission. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaImportDocumentsRequest; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$List + extends StandardParameters { + /** + * Maximum number of Documents to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 are set to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned. + */ + pageSize?: number; + /** + * A page token ListDocumentsResponse.next_page_token, received from a previous DocumentService.ListDocuments call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to DocumentService.ListDocuments must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned. + */ + pageToken?: string; + /** + * Required. The parent branch resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}`. Use `default_branch` as the branch ID, to list documents under the default branch. If the caller does not have permission to list Documents under this branch, regardless of whether or not this branch exists, a `PERMISSION_DENIED` error is returned. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Patch + extends StandardParameters { + /** + * If set to `true` and the Document is not found, a new Document is be created. + */ + allowMissing?: boolean; + /** + * 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?: string; + /** + * Indicates which fields in the provided imported 'document' to update. If not set, by default updates all fields. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaDocument; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Purge + extends StandardParameters { + /** + * Required. The parent resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}`. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaPurgeDocumentsRequest; + } + + export class Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Chunks { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } /** - * Gets the SiteSearchEngine. + * Gets a Document. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - getSiteSearchEngine( - params: Params$Resource$Projects$Locations$Collections$Datastores$Getsitesearchengine, + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Chunks$Get, options: StreamMethodOptions ): GaxiosPromise; - getSiteSearchEngine( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Getsitesearchengine, + get( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Chunks$Get, options?: MethodOptions - ): GaxiosPromise; - getSiteSearchEngine( - params: Params$Resource$Projects$Locations$Collections$Datastores$Getsitesearchengine, + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Chunks$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback - ): void; - getSiteSearchEngine( - params: Params$Resource$Projects$Locations$Collections$Datastores$Getsitesearchengine, + ): void; + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Chunks$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - getSiteSearchEngine( - params: Params$Resource$Projects$Locations$Collections$Datastores$Getsitesearchengine, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Chunks$Get, + callback: BodyResponseCallback ): void; - getSiteSearchEngine( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - getSiteSearchEngine( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Getsitesearchengine - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Chunks$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Getsitesearchengine; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Chunks$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Getsitesearchengine; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Chunks$Get; options = {}; } @@ -8839,19 +11615,19 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Lists all the DataStores associated with the project. + * Gets a list of Chunks. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -8859,57 +11635,57 @@ export namespace discoveryengine_v1alpha { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Collections$Datastores$List, + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Chunks$List, options: StreamMethodOptions ): GaxiosPromise; list( - params?: Params$Resource$Projects$Locations$Collections$Datastores$List, + params?: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Chunks$List, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; list( - params: Params$Resource$Projects$Locations$Collections$Datastores$List, + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Chunks$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Collections$Datastores$List, + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Chunks$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Collections$Datastores$List, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Chunks$List, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Chunks$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$List; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Chunks$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$List; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Chunks$List; options = {}; } @@ -8923,7 +11699,7 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/dataStores').replace( + url: (rootUrl + '/v1alpha/{+parent}/chunks').replace( /([^:]\/)\/+/g, '$1' ), @@ -8938,173 +11714,103 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Chunks$Get + extends StandardParameters { /** - * Updates a DataStore - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. + * Required. Full resource name of Chunk, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}/documents/{document\}/chunks/{chunk\}`. If the caller does not have permission to access the Chunk, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the requested Chunk does not exist, a `NOT_FOUND` error is returned. */ - patch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Patch, - options: StreamMethodOptions - ): GaxiosPromise; - patch( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Patch, - options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Patch, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - patch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Patch, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - patch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Patch, - callback: BodyResponseCallback - ): void; - patch( - callback: BodyResponseCallback - ): void; - patch( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Patch - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Patch; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Patch; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } + name?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Chunks$List + extends StandardParameters { + /** + * Maximum number of Chunks to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned. + */ + pageSize?: number; + /** + * A page token ListChunksResponse.next_page_token, received from a previous ChunkService.ListChunks call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ChunkService.ListChunks must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned. + */ + pageToken?: string; + /** + * Required. The parent document resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}/documents/{document\}`. If the caller does not have permission to list Chunks under this document, regardless of whether or not this document exists, a `PERMISSION_DENIED` error is returned. + */ + parent?: string; + } - const rootUrl = - options.rootUrl || 'https://discoveryengine.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest( - parameters - ); - } + export class Resource$Projects$Locations$Collections$Datastores$Branches$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; } /** - * Trains a custom model. + * 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`. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - trainCustomModel( - params: Params$Resource$Projects$Locations$Collections$Datastores$Traincustommodel, + cancel( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$Cancel, options: StreamMethodOptions ): GaxiosPromise; - trainCustomModel( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Traincustommodel, + cancel( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$Cancel, options?: MethodOptions - ): GaxiosPromise; - trainCustomModel( - params: Params$Resource$Projects$Locations$Collections$Datastores$Traincustommodel, + ): GaxiosPromise; + cancel( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - trainCustomModel( - params: Params$Resource$Projects$Locations$Collections$Datastores$Traincustommodel, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - trainCustomModel( - params: Params$Resource$Projects$Locations$Collections$Datastores$Traincustommodel, - callback: BodyResponseCallback + cancel( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - trainCustomModel( - callback: BodyResponseCallback + cancel( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$Cancel, + callback: BodyResponseCallback ): void; - trainCustomModel( + cancel(callback: BodyResponseCallback): void; + cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Traincustommodel - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$Cancel + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Traincustommodel; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Traincustommodel; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$Cancel; options = {}; } @@ -9118,7 +11824,7 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+dataStore}:trainCustomModel').replace( + url: (rootUrl + '/v1alpha/{+name}:cancel').replace( /([^:]\/)\/+/g, '$1' ), @@ -9128,80 +11834,80 @@ export namespace discoveryengine_v1alpha { options ), params, - requiredParams: ['dataStore'], - pathParams: ['dataStore'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Updates the DocumentProcessingConfig. DocumentProcessingConfig is a singleon resource of DataStore. It's empty when DataStore is created. The first call to this method will set up DocumentProcessingConfig. + * 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. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - updateDocumentProcessingConfig( - params: Params$Resource$Projects$Locations$Collections$Datastores$Updatedocumentprocessingconfig, + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$Get, options: StreamMethodOptions ): GaxiosPromise; - updateDocumentProcessingConfig( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Updatedocumentprocessingconfig, + get( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$Get, options?: MethodOptions - ): GaxiosPromise; - updateDocumentProcessingConfig( - params: Params$Resource$Projects$Locations$Collections$Datastores$Updatedocumentprocessingconfig, + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - updateDocumentProcessingConfig( - params: Params$Resource$Projects$Locations$Collections$Datastores$Updatedocumentprocessingconfig, + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - updateDocumentProcessingConfig( - params: Params$Resource$Projects$Locations$Collections$Datastores$Updatedocumentprocessingconfig, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$Get, + callback: BodyResponseCallback ): void; - updateDocumentProcessingConfig( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - updateDocumentProcessingConfig( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Updatedocumentprocessingconfig - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Updatedocumentprocessingconfig; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Updatedocumentprocessingconfig; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$Get; options = {}; } @@ -9216,7 +11922,7 @@ export namespace discoveryengine_v1alpha { options: Object.assign( { url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + method: 'GET', apiVersion: '', }, options @@ -9227,241 +11933,75 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Projects$Locations$Collections$Datastores$Completequery - extends StandardParameters { - /** - * Required. The parent data store resource name for which the completion is performed, such as `projects/x/locations/global/collections/default_collection/dataStores/default_data_store`. - */ - dataStore?: string; - /** - * 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. - */ - includeTailSuggestions?: boolean; - /** - * Required. The typeahead input used to fetch suggestions. Maximum length is 128 characters. - */ - query?: string; - /** - * Specifies the autocomplete data model. 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. - */ - queryModel?: string; - /** - * 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 SearchRequest.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. - */ - userPseudoId?: string; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Create - extends StandardParameters { - /** - * A boolean flag indicating whether user want to directly create an advanced data store for site search. If the data store is not configured as site search (GENERIC vertical and PUBLIC_WEBSITE content_config), this flag will be ignored. - */ - createAdvancedSiteSearch?: boolean; - /** - * Required. The ID to use for the DataStore, which will become the final component of the DataStore's resource name. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned. - */ - dataStoreId?: string; - /** - * Required. The parent resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}`. - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaDataStore; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Delete - extends StandardParameters { - /** - * Required. Full resource name of DataStore, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}`. If the caller does not have permission to delete the DataStore, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the DataStore to delete does not exist, a NOT_FOUND error is returned. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Get - extends StandardParameters { - /** - * Required. Full resource name of DataStore, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}`. If the caller does not have permission to access the DataStore, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested DataStore does not exist, a NOT_FOUND error is returned. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Getdocumentprocessingconfig - extends StandardParameters { - /** - * Required. Full DocumentProcessingConfig resource name. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/dataStores/{data_store_id\}/documentProcessingConfig` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Getsitesearchengine - extends StandardParameters { - /** - * Required. Resource name of SiteSearchEngine, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine`. If the caller does not have permission to access the [SiteSearchEngine], regardless of whether or not it exists, a PERMISSION_DENIED error is returned. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$List - extends StandardParameters { - /** - * Filter by solution type . For example: `filter = 'solution_type:SOLUTION_TYPE_SEARCH'` - */ - filter?: string; - /** - * Maximum number of DataStores to return. If unspecified, defaults to 10. The maximum allowed value is 50. Values above 50 will be coerced to 50. If this field is negative, an INVALID_ARGUMENT is returned. - */ - pageSize?: number; - /** - * A page token ListDataStoresResponse.next_page_token, received from a previous DataStoreService.ListDataStores call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to DataStoreService.ListDataStores must match the call that provided the page token. Otherwise, an INVALID_ARGUMENT error is returned. - */ - pageToken?: string; - /** - * Required. The parent branch resource name, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}`. If the caller does not have permission to list DataStores under this location, regardless of whether or not this data store exists, a PERMISSION_DENIED error is returned. - */ - parent?: string; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Patch - extends StandardParameters { - /** - * 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. - */ - name?: string; - /** - * Indicates which fields in the provided DataStore to update. If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned. - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaDataStore; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Traincustommodel - extends StandardParameters { - /** - * Required. The resource name of the Data Store, such as `projects/x/locations/global/collections/default_collection/dataStores/default_data_store`. This field is used to identify the data store where to train the models. - */ - dataStore?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaTrainCustomModelRequest; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Updatedocumentprocessingconfig - extends StandardParameters { - /** - * The full resource name of the Document Processing Config. Format: `projects/x/locations/x/collections/x/dataStores/x/documentProcessingConfig`. - */ - name?: string; - /** - * Indicates which fields in the provided DocumentProcessingConfig to update. The following are the only supported fields: * DocumentProcessingConfig.ocr_config If not set, all supported fields are updated. - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig; - } - - export class Resource$Projects$Locations$Collections$Datastores$Branches { - context: APIRequestContext; - documents: Resource$Projects$Locations$Collections$Datastores$Branches$Documents; - operations: Resource$Projects$Locations$Collections$Datastores$Branches$Operations; - constructor(context: APIRequestContext) { - this.context = context; - this.documents = - new Resource$Projects$Locations$Collections$Datastores$Branches$Documents( - this.context - ); - this.operations = - new Resource$Projects$Locations$Collections$Datastores$Branches$Operations( - this.context - ); - } - } - - export class Resource$Projects$Locations$Collections$Datastores$Branches$Documents { - context: APIRequestContext; - chunks: Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Chunks; - constructor(context: APIRequestContext) { - this.context = context; - this.chunks = - new Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Chunks( - this.context - ); - } /** - * Creates a Document. + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - create( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Create, + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$List, options: StreamMethodOptions ): GaxiosPromise; - create( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Create, + list( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$List, options?: MethodOptions - ): GaxiosPromise; - create( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Create, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Create, + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - create( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Create, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$List, + callback: BodyResponseCallback ): void; - create( + list( + callback: BodyResponseCallback + ): void; + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Create; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Create; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$List; options = {}; } @@ -9475,88 +12015,138 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/documents').replace( + url: (rootUrl + '/v1alpha/{+name}/operations').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$Cancel + extends StandardParameters { /** - * Deletes a Document. + * The name of the operation resource to be cancelled. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleLongrunningCancelOperationRequest; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$Get + extends StandardParameters { + /** + * The name of the operation resource. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$List + extends StandardParameters { + /** + * The standard list filter. + */ + filter?: string; + /** + * The name of the operation's parent resource. + */ + name?: string; + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. + */ + pageToken?: string; + } + + export class Resource$Projects$Locations$Collections$Datastores$Completionsuggestions { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Imports CompletionSuggestions for a DataStore. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - delete( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Delete, + import( + params: Params$Resource$Projects$Locations$Collections$Datastores$Completionsuggestions$Import, options: StreamMethodOptions ): GaxiosPromise; - delete( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Delete, + import( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Completionsuggestions$Import, options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Delete, + ): GaxiosPromise; + import( + params: Params$Resource$Projects$Locations$Collections$Datastores$Completionsuggestions$Import, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + import( + params: Params$Resource$Projects$Locations$Collections$Datastores$Completionsuggestions$Import, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Delete, - callback: BodyResponseCallback + import( + params: Params$Resource$Projects$Locations$Collections$Datastores$Completionsuggestions$Import, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + import( + callback: BodyResponseCallback + ): void; + import( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Completionsuggestions$Import + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Delete; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Completionsuggestions$Import; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Delete; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Completionsuggestions$Import; options = {}; } @@ -9570,87 +12160,89 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: ( + rootUrl + '/v1alpha/{+parent}/completionSuggestions:import' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Gets a Document. + * Permanently deletes all CompletionSuggestions for a DataStore. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Get, + purge( + params: Params$Resource$Projects$Locations$Collections$Datastores$Completionsuggestions$Purge, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Get, + purge( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Completionsuggestions$Purge, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Get, + ): GaxiosPromise; + purge( + params: Params$Resource$Projects$Locations$Collections$Datastores$Completionsuggestions$Purge, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Get, + purge( + params: Params$Resource$Projects$Locations$Collections$Datastores$Completionsuggestions$Purge, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Get, - callback: BodyResponseCallback + purge( + params: Params$Resource$Projects$Locations$Collections$Datastores$Completionsuggestions$Purge, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + purge( + callback: BodyResponseCallback ): void; - get( + purge( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Completionsuggestions$Purge + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Get; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Completionsuggestions$Purge; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Get; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Completionsuggestions$Purge; options = {}; } @@ -9664,89 +12256,121 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: ( + rootUrl + '/v1alpha/{+parent}/completionSuggestions:purge' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Completionsuggestions$Import + extends StandardParameters { /** - * Gets the parsed layout information for a Document. + * Required. The parent data store resource name for which to import customer autocomplete suggestions. Follows pattern `projects/x/locations/x/collections/x/dataStores/x` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaImportCompletionSuggestionsRequest; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Completionsuggestions$Purge + extends StandardParameters { + /** + * Required. The parent data store resource name for which to purge completion suggestions. Follows pattern projects/x/locations/x/collections/x/dataStores/x. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaPurgeCompletionSuggestionsRequest; + } + + export class Resource$Projects$Locations$Collections$Datastores$Controls { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * 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. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - getProcessedDocument( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Getprocesseddocument, + create( + params: Params$Resource$Projects$Locations$Collections$Datastores$Controls$Create, options: StreamMethodOptions ): GaxiosPromise; - getProcessedDocument( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Getprocesseddocument, + create( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Controls$Create, options?: MethodOptions - ): GaxiosPromise; - getProcessedDocument( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Getprocesseddocument, + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Collections$Datastores$Controls$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - getProcessedDocument( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Getprocesseddocument, + create( + params: Params$Resource$Projects$Locations$Collections$Datastores$Controls$Create, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - getProcessedDocument( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Getprocesseddocument, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Collections$Datastores$Controls$Create, + callback: BodyResponseCallback ): void; - getProcessedDocument( - callback: BodyResponseCallback + create( + callback: BodyResponseCallback ): void; - getProcessedDocument( + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Getprocesseddocument - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Controls$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Getprocesseddocument; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Controls$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Getprocesseddocument; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Controls$Create; options = {}; } @@ -9760,92 +12384,88 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}:getProcessedDocument').replace( + url: (rootUrl + '/v1alpha/{+parent}/controls').replace( /([^:]\/)\/+/g, '$1' ), - method: 'GET', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * 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. + * Deletes a Control. If the Control to delete does not exist, a NOT_FOUND error is returned. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - import( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Import, + delete( + params: Params$Resource$Projects$Locations$Collections$Datastores$Controls$Delete, options: StreamMethodOptions ): GaxiosPromise; - import( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Import, + delete( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Controls$Delete, options?: MethodOptions - ): GaxiosPromise; - import( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Import, + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Collections$Datastores$Controls$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - import( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Import, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - import( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Import, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Collections$Datastores$Controls$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - import( - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Collections$Datastores$Controls$Delete, + callback: BodyResponseCallback ): void; - import( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Import - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Controls$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Import; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Controls$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Import; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Controls$Delete; options = {}; } @@ -9859,90 +12479,87 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/documents:import').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Gets a list of Documents. + * Gets a Control. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$List, + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Controls$Get, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$List, + get( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Controls$Get, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$List, + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Controls$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$List, + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Controls$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$List, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Controls$Get, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - list( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Controls$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$List; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Controls$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$List; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Controls$Get; options = {}; } @@ -9956,92 +12573,89 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/documents').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Updates a Document. + * Lists all Controls by their parent DataStore. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - patch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Patch, + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Controls$List, options: StreamMethodOptions ): GaxiosPromise; - patch( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Patch, + list( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Controls$List, options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Patch, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Controls$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Patch, + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Controls$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Patch, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Controls$List, + callback: BodyResponseCallback ): void; - patch( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - patch( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Patch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Controls$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Patch; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Controls$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Patch; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Controls$List; options = {}; } @@ -10055,89 +12669,92 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + url: (rootUrl + '/v1alpha/{+parent}/controls').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * 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. + * Updates a Control. Control action type cannot be changed. If the Control to update does not exist, a NOT_FOUND error is returned. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - purge( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Purge, + patch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Controls$Patch, options: StreamMethodOptions ): GaxiosPromise; - purge( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Purge, - options?: MethodOptions - ): GaxiosPromise; - purge( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Purge, + patch( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Controls$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Controls$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - purge( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Purge, + patch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Controls$Patch, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - purge( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Purge, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Controls$Patch, + callback: BodyResponseCallback ): void; - purge( - callback: BodyResponseCallback + patch( + callback: BodyResponseCallback ): void; - purge( + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Purge - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Controls$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Purge; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Controls$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Purge; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Controls$Patch; options = {}; } @@ -10151,202 +12768,261 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/documents:purge').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Create + export interface Params$Resource$Projects$Locations$Collections$Datastores$Controls$Create extends StandardParameters { /** - * Required. The ID to use for the Document, which becomes the final component of the Document.name. If the caller does not have permission to create the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. This field must be unique among all Documents with the same parent. Otherwise, an `ALREADY_EXISTS` error is returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. + * Required. The ID to use for the Control, which will become the final component of the Control's resource name. This value must be within 1-63 characters. Valid characters are /a-z-_/. */ - documentId?: string; + controlId?: string; /** - * Required. The parent resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}`. + * Required. Full resource name of parent data store. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/dataStores/{data_store_id\}` or `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/engines/{engine_id\}`. */ parent?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaDocument; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Delete - extends StandardParameters { - /** - * Required. Full resource name of Document, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}/documents/{document\}`. If the caller does not have permission to delete the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the Document to delete does not exist, a `NOT_FOUND` error is returned. - */ - name?: string; + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaControl; } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Get + export interface Params$Resource$Projects$Locations$Collections$Datastores$Controls$Delete extends StandardParameters { /** - * Required. Full resource name of Document, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}/documents/{document\}`. If the caller does not have permission to access the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the requested Document does not exist, a `NOT_FOUND` error is returned. + * Required. The resource name of the Control to delete. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/dataStores/{data_store_id\}/controls/{control_id\}` */ name?: string; } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Getprocesseddocument + export interface Params$Resource$Projects$Locations$Collections$Datastores$Controls$Get extends StandardParameters { /** - * Required. Full resource name of Document, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}/documents/{document\}`. If the caller does not have permission to access the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the requested Document does not exist, a `NOT_FOUND` error is returned. + * Required. The resource name of the Control to get. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/dataStores/{data_store_id\}/controls/{control_id\}` */ name?: string; - /** - * What format output should be. If unspecified, defaults to JSON. - */ - processedDocumentFormat?: string; - /** - * Required. What type of processing to return. - */ - processedDocumentType?: string; } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Import + export interface Params$Resource$Projects$Locations$Collections$Datastores$Controls$List extends StandardParameters { /** - * Required. The parent branch resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}`. Requires create/update permission. - */ - parent?: string; - - /** - * Request body metadata + * Optional. A filter to apply on the list results. Supported features: * List all the products under the parent branch if filter is unset. Currently this field is unsupported. */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaImportDocumentsRequest; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$List - extends StandardParameters { + filter?: string; /** - * Maximum number of Documents to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 are set to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned. + * Optional. Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000. */ pageSize?: number; /** - * A page token ListDocumentsResponse.next_page_token, received from a previous DocumentService.ListDocuments call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to DocumentService.ListDocuments must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned. + * Optional. A page token, received from a previous `ListControls` call. Provide this to retrieve the subsequent page. */ pageToken?: string; /** - * Required. The parent branch resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}`. Use `default_branch` as the branch ID, to list documents under the default branch. If the caller does not have permission to list Documents under this branch, regardless of whether or not this branch exists, a `PERMISSION_DENIED` error is returned. + * Required. The data store resource name. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/dataStores/{data_store_id\}` or `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/engines/{engine_id\}`. */ parent?: string; } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Patch + export interface Params$Resource$Projects$Locations$Collections$Datastores$Controls$Patch extends StandardParameters { /** - * If set to `true` and the Document is not found, a new Document is be created. - */ - allowMissing?: boolean; - /** - * 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. + * Immutable. Fully qualified name `projects/x/locations/global/dataStore/x/controls/x` */ name?: string; /** - * Indicates which fields in the provided imported 'document' to update. If not set, by default updates all fields. + * Optional. Indicates which fields in the provided Control to update. The following are NOT supported: * Control.name * Control.solution_type If not set or empty, all supported fields are updated. */ updateMask?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaDocument; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Purge - extends StandardParameters { - /** - * Required. The parent resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}`. - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaPurgeDocumentsRequest; + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaControl; } - export class Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Chunks { + export class Resource$Projects$Locations$Collections$Datastores$Conversations { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * Gets a Document. + * Converses a conversation. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Chunks$Get, + converse( + params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Converse, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Chunks$Get, + converse( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Converse, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Chunks$Get, + ): GaxiosPromise; + converse( + params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Converse, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Chunks$Get, + converse( + params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Converse, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + converse( + params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Converse, + callback: BodyResponseCallback + ): void; + converse( + callback: BodyResponseCallback + ): void; + converse( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Converse + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Converse; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Converse; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}:converse').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Creates a Conversation. If the Conversation to create already exists, an ALREADY_EXISTS error is returned. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + create( + params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Create, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Chunks$Get, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Create, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + create( + callback: BodyResponseCallback ): void; - get( + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Chunks$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Chunks$Get; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Chunks$Get; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Create; options = {}; } @@ -10360,89 +13036,88 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1alpha/{+parent}/conversations').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Gets a list of Chunks. + * Deletes a Conversation. If the Conversation to delete does not exist, a NOT_FOUND error is returned. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Chunks$List, + delete( + params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Delete, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Chunks$List, + delete( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Delete, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Chunks$List, + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Chunks$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Chunks$List, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Delete, + callback: BodyResponseCallback ): void; - list( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Chunks$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Chunks$List; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Chunks$List; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Delete; options = {}; } @@ -10456,118 +13131,87 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/chunks').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Chunks$Get - extends StandardParameters { - /** - * Required. Full resource name of Chunk, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}/documents/{document\}/chunks/{chunk\}`. If the caller does not have permission to access the Chunk, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the requested Chunk does not exist, a `NOT_FOUND` error is returned. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Chunks$List - extends StandardParameters { - /** - * Maximum number of Chunks to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned. - */ - pageSize?: number; - /** - * A page token ListChunksResponse.next_page_token, received from a previous ChunkService.ListChunks call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ChunkService.ListChunks must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned. - */ - pageToken?: string; - /** - * Required. The parent document resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}/documents/{document\}`. If the caller does not have permission to list Chunks under this document, regardless of whether or not this document exists, a `PERMISSION_DENIED` error is returned. - */ - parent?: string; - } - - export class Resource$Projects$Locations$Collections$Datastores$Branches$Operations { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * 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`. + * Gets a Conversation. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - cancel( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$Cancel, + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Get, options: StreamMethodOptions ): GaxiosPromise; - cancel( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$Cancel, + get( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Get, options?: MethodOptions - ): GaxiosPromise; - cancel( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$Cancel, + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$Cancel, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$Cancel, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Get, + callback: BodyResponseCallback ): void; - cancel(callback: BodyResponseCallback): void; - cancel( + get( + callback: BodyResponseCallback + ): void; + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$Cancel - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$Cancel; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$Cancel; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Get; options = {}; } @@ -10581,11 +13225,8 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}:cancel').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options @@ -10596,75 +13237,77 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * 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. + * Lists all Conversations by their parent DataStore. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$Get, + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$List, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$Get, + list( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$List, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$Get, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$Get, + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$Get, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$List, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - get( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Conversations$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$Get; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Conversations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$Get; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Conversations$List; options = {}; } @@ -10678,87 +13321,92 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1alpha/{+parent}/conversations').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + * Updates a Conversation. Conversation action type cannot be changed. If the Conversation to update does not exist, a NOT_FOUND error is returned. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$List, + patch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Patch, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$List, + patch( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Patch, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$List, + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$List, + patch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Patch, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$List, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Patch, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + patch( + callback: BodyResponseCallback ): void; - list( + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$List; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$List; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Patch; options = {}; } @@ -10772,11 +13420,8 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}/operations').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', apiVersion: '', }, options @@ -10787,123 +13432,162 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$Cancel + export interface Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Converse extends StandardParameters { /** - * The name of the operation resource to be cancelled. + * Required. The resource name of the Conversation to get. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/{conversation_id\}`. Use `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/-` to activate auto session mode, which automatically creates a new conversation inside a ConverseConversation session. */ name?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleLongrunningCancelOperationRequest; + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaConverseConversationRequest; } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$Get + export interface Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Create extends StandardParameters { /** - * The name of the operation resource. + * Required. Full resource name of parent data store. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaConversation; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Delete + extends StandardParameters { + /** + * Required. The resource name of the Conversation to delete. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/{conversation_id\}` */ name?: string; } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$List + export interface Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Get extends StandardParameters { /** - * The standard list filter. + * Required. The resource name of the Conversation to get. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/{conversation_id\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Conversations$List + extends StandardParameters { + /** + * A filter to apply on the list results. The supported features are: user_pseudo_id, state. Example: "user_pseudo_id = some_id" */ filter?: string; /** - * The name of the operation's parent resource. + * 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` * `conversation_name` Example: "update_time desc" "create_time" */ - name?: string; + orderBy?: string; /** - * The standard list page size. + * Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000. */ pageSize?: number; /** - * The standard list page token. + * A page token, received from a previous `ListConversations` call. Provide this to retrieve the subsequent page. */ pageToken?: string; + /** + * Required. The data store resource name. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}` + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Patch + extends StandardParameters { + /** + * Immutable. Fully qualified name `projects/{project\}/locations/global/collections/{collection\}/dataStore/x/conversations/x` or `projects/{project\}/locations/global/collections/{collection\}/engines/x/conversations/x`. + */ + name?: string; + /** + * Indicates which fields in the provided Conversation to update. The following are NOT supported: * Conversation.name If not set or empty, all supported fields are updated. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaConversation; } - export class Resource$Projects$Locations$Collections$Datastores$Completionsuggestions { + export class Resource$Projects$Locations$Collections$Datastores$Custommodels { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * Imports CompletionSuggestions for a DataStore. + * Gets a list of all the custom models. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - import( - params: Params$Resource$Projects$Locations$Collections$Datastores$Completionsuggestions$Import, + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Custommodels$List, options: StreamMethodOptions ): GaxiosPromise; - import( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Completionsuggestions$Import, + list( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Custommodels$List, options?: MethodOptions - ): GaxiosPromise; - import( - params: Params$Resource$Projects$Locations$Collections$Datastores$Completionsuggestions$Import, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Custommodels$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - import( - params: Params$Resource$Projects$Locations$Collections$Datastores$Completionsuggestions$Import, + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Custommodels$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - import( - params: Params$Resource$Projects$Locations$Collections$Datastores$Completionsuggestions$Import, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Custommodels$List, + callback: BodyResponseCallback ): void; - import( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - import( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Completionsuggestions$Import - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Custommodels$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Completionsuggestions$Import; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Custommodels$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Completionsuggestions$Import; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Custommodels$List; options = {}; } @@ -10917,67 +13601,97 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: ( - rootUrl + '/v1alpha/{+parent}/completionSuggestions:import' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + url: (rootUrl + '/v1alpha/{+dataStore}/customModels').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['dataStore'], + pathParams: ['dataStore'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Custommodels$List + extends StandardParameters { /** - * Permanently deletes all CompletionSuggestions for a DataStore. + * Required. The resource name of the parent Data Store, such as `projects/x/locations/global/collections/default_collection/dataStores/default_data_store`. This field is used to identify the data store where to fetch the models from. + */ + dataStore?: string; + } + + export class Resource$Projects$Locations$Collections$Datastores$Models { + context: APIRequestContext; + operations: Resource$Projects$Locations$Collections$Datastores$Models$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.operations = + new Resource$Projects$Locations$Collections$Datastores$Models$Operations( + this.context + ); + } + } + + export class Resource$Projects$Locations$Collections$Datastores$Models$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * 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. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - purge( - params: Params$Resource$Projects$Locations$Collections$Datastores$Completionsuggestions$Purge, + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Models$Operations$Get, options: StreamMethodOptions ): GaxiosPromise; - purge( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Completionsuggestions$Purge, + get( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Models$Operations$Get, options?: MethodOptions ): GaxiosPromise; - purge( - params: Params$Resource$Projects$Locations$Collections$Datastores$Completionsuggestions$Purge, + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Models$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - purge( - params: Params$Resource$Projects$Locations$Collections$Datastores$Completionsuggestions$Purge, + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Models$Operations$Get, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback - ): void; - purge( - params: Params$Resource$Projects$Locations$Collections$Datastores$Completionsuggestions$Purge, + ): void; + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Models$Operations$Get, callback: BodyResponseCallback ): void; - purge( + get( callback: BodyResponseCallback ): void; - purge( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Completionsuggestions$Purge + | Params$Resource$Projects$Locations$Collections$Datastores$Models$Operations$Get | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -10993,13 +13707,13 @@ export namespace discoveryengine_v1alpha { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Completionsuggestions$Purge; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Models$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Completionsuggestions$Purge; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Models$Operations$Get; options = {}; } @@ -11013,17 +13727,15 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: ( - rootUrl + '/v1alpha/{+parent}/completionSuggestions:purge' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { @@ -11035,99 +13747,67 @@ export namespace discoveryengine_v1alpha { return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Projects$Locations$Collections$Datastores$Completionsuggestions$Import - extends StandardParameters { - /** - * Required. The parent data store resource name for which to import customer autocomplete suggestions. Follows pattern `projects/x/locations/x/collections/x/dataStores/x` - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaImportCompletionSuggestionsRequest; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Completionsuggestions$Purge - extends StandardParameters { - /** - * Required. The parent data store resource name for which to purge completion suggestions. Follows pattern projects/x/locations/x/collections/x/dataStores/x. - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaPurgeCompletionSuggestionsRequest; - } - - export class Resource$Projects$Locations$Collections$Datastores$Controls { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * 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. + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - create( - params: Params$Resource$Projects$Locations$Collections$Datastores$Controls$Create, + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Models$Operations$List, options: StreamMethodOptions ): GaxiosPromise; - create( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Controls$Create, + list( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Models$Operations$List, options?: MethodOptions - ): GaxiosPromise; - create( - params: Params$Resource$Projects$Locations$Collections$Datastores$Controls$Create, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Models$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Collections$Datastores$Controls$Create, + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Models$Operations$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Collections$Datastores$Controls$Create, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Models$Operations$List, + callback: BodyResponseCallback ): void; - create( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - create( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Controls$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Models$Operations$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Controls$Create; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Models$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Controls$Create; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Models$Operations$List; options = {}; } @@ -11141,88 +13821,126 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/controls').replace( + url: (rootUrl + '/v1alpha/{+name}/operations').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Models$Operations$Get + extends StandardParameters { /** - * Deletes a Control. If the Control to delete does not exist, a NOT_FOUND error is returned. + * The name of the operation resource. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Models$Operations$List + extends StandardParameters { + /** + * The standard list filter. + */ + filter?: string; + /** + * The name of the operation's parent resource. + */ + name?: string; + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. + */ + pageToken?: string; + } + + export class Resource$Projects$Locations$Collections$Datastores$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * 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. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - delete( - params: Params$Resource$Projects$Locations$Collections$Datastores$Controls$Delete, + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Operations$Get, options: StreamMethodOptions ): GaxiosPromise; - delete( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Controls$Delete, + get( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Operations$Get, options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Projects$Locations$Collections$Datastores$Controls$Delete, + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Collections$Datastores$Controls$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Operations$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Collections$Datastores$Controls$Delete, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Operations$Get, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + get( + callback: BodyResponseCallback + ): void; + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Controls$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Operations$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Controls$Delete; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Controls$Delete; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Operations$Get; options = {}; } @@ -11237,7 +13955,7 @@ export namespace discoveryengine_v1alpha { options: Object.assign( { url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + method: 'GET', apiVersion: '', }, options @@ -11248,75 +13966,75 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Gets a Control. + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Controls$Get, + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Operations$List, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Controls$Get, + list( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Operations$List, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Controls$Get, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Controls$Get, + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Operations$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Controls$Get, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Operations$List, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - get( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Controls$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Operations$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Controls$Get; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Controls$Get; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Operations$List; options = {}; } @@ -11330,7 +14048,10 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1alpha/{+name}/operations').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'GET', apiVersion: '', }, @@ -11342,77 +14063,116 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Operations$Get + extends StandardParameters { /** - * Lists all Controls by their parent DataStore. + * The name of the operation resource. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Operations$List + extends StandardParameters { + /** + * The standard list filter. + */ + filter?: string; + /** + * The name of the operation's parent resource. + */ + name?: string; + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. + */ + pageToken?: string; + } + + export class Resource$Projects$Locations$Collections$Datastores$Schemas { + context: APIRequestContext; + operations: Resource$Projects$Locations$Collections$Datastores$Schemas$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.operations = + new Resource$Projects$Locations$Collections$Datastores$Schemas$Operations( + this.context + ); + } + + /** + * Creates a Schema. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Controls$List, + create( + params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Create, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Controls$List, + create( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Create, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Controls$List, + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Controls$List, + create( + params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Create, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Controls$List, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Create, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + create( + callback: BodyResponseCallback ): void; - list( + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Controls$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Controls$List; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Controls$List; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Create; options = {}; } @@ -11426,11 +14186,11 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/controls').replace( + url: (rootUrl + '/v1alpha/{+parent}/schemas').replace( /([^:]\/)\/+/g, '$1' ), - method: 'GET', + method: 'POST', apiVersion: '', }, options @@ -11441,77 +14201,75 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Updates a Control. Control action type cannot be changed. If the Control to update does not exist, a NOT_FOUND error is returned. + * Deletes a Schema. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - patch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Controls$Patch, + delete( + params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Delete, options: StreamMethodOptions ): GaxiosPromise; - patch( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Controls$Patch, + delete( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Delete, options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Controls$Patch, + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Controls$Patch, + delete( + params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Delete, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Controls$Patch, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Delete, + callback: BodyResponseCallback ): void; - patch( - callback: BodyResponseCallback + delete( + callback: BodyResponseCallback ): void; - patch( + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Controls$Patch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Controls$Patch; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Controls$Patch; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Delete; options = {}; } @@ -11526,7 +14284,7 @@ export namespace discoveryengine_v1alpha { options: Object.assign( { url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + method: 'DELETE', apiVersion: '', }, options @@ -11537,150 +14295,75 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Projects$Locations$Collections$Datastores$Controls$Create - extends StandardParameters { - /** - * Required. The ID to use for the Control, which will become the final component of the Control's resource name. This value must be within 1-63 characters. Valid characters are /a-z-_/. - */ - controlId?: string; - /** - * Required. Full resource name of parent data store. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/dataStores/{data_store_id\}` or `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/engines/{engine_id\}`. - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaControl; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Controls$Delete - extends StandardParameters { - /** - * Required. The resource name of the Control to delete. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/dataStores/{data_store_id\}/controls/{control_id\}` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Controls$Get - extends StandardParameters { - /** - * Required. The resource name of the Control to get. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/dataStores/{data_store_id\}/controls/{control_id\}` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Controls$List - extends StandardParameters { - /** - * Optional. A filter to apply on the list results. Supported features: * List all the products under the parent branch if filter is unset. Currently this field is unsupported. - */ - filter?: string; - /** - * Optional. Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000. - */ - pageSize?: number; - /** - * Optional. A page token, received from a previous `ListControls` call. Provide this to retrieve the subsequent page. - */ - pageToken?: string; - /** - * Required. The data store resource name. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/dataStores/{data_store_id\}` or `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/engines/{engine_id\}`. - */ - parent?: string; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Controls$Patch - extends StandardParameters { - /** - * Immutable. Fully qualified name `projects/x/locations/global/dataStore/x/controls/x` - */ - name?: string; - /** - * Optional. Indicates which fields in the provided Control to update. The following are NOT supported: * Control.name * Control.solution_type If not set or empty, all supported fields are updated. - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaControl; - } - - export class Resource$Projects$Locations$Collections$Datastores$Conversations { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Converses a conversation. + * Gets a Schema. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - converse( - params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Converse, + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Get, options: StreamMethodOptions ): GaxiosPromise; - converse( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Converse, + get( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Get, options?: MethodOptions - ): GaxiosPromise; - converse( - params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Converse, + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - converse( - params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Converse, + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - converse( - params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Converse, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Get, + callback: BodyResponseCallback ): void; - converse( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - converse( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Converse - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Converse; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Converse; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Get; options = {}; } @@ -11694,11 +14377,8 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}:converse').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options @@ -11709,77 +14389,77 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Creates a Conversation. If the Conversation to create already exists, an ALREADY_EXISTS error is returned. + * Gets a list of Schemas. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - create( - params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Create, + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$List, options: StreamMethodOptions ): GaxiosPromise; - create( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Create, + list( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$List, options?: MethodOptions - ): GaxiosPromise; - create( - params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Create, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Create, + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Create, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$List, + callback: BodyResponseCallback ): void; - create( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - create( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Schemas$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Create; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Schemas$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Create; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Schemas$List; options = {}; } @@ -11793,11 +14473,11 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/conversations').replace( + url: (rootUrl + '/v1alpha/{+parent}/schemas').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', apiVersion: '', }, options @@ -11808,73 +14488,77 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Deletes a Conversation. If the Conversation to delete does not exist, a NOT_FOUND error is returned. + * Updates a Schema. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - delete( - params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Delete, + patch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Patch, options: StreamMethodOptions ): GaxiosPromise; - delete( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Delete, + patch( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Patch, options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Delete, + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Patch, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Delete, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Patch, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + patch( + callback: BodyResponseCallback + ): void; + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Delete; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Delete; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Patch; options = {}; } @@ -11889,7 +14573,7 @@ export namespace discoveryengine_v1alpha { options: Object.assign( { url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + method: 'PATCH', apiVersion: '', }, options @@ -11900,17 +14584,86 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Create + extends StandardParameters { /** - * Gets a Conversation. + * Required. The parent data store resource name, in the format of `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}`. + */ + parent?: string; + /** + * Required. The ID to use for the Schema, which becomes the final component of the Schema.name. This field should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. + */ + schemaId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaSchema; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Delete + extends StandardParameters { + /** + * Required. The full resource name of the schema, in the format of `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/schemas/{schema\}`. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Get + extends StandardParameters { + /** + * Required. The full resource name of the schema, in the format of `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/schemas/{schema\}`. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Schemas$List + extends StandardParameters { + /** + * The maximum number of Schemas to return. The service may return fewer than this value. If unspecified, at most 100 Schemas are returned. The maximum value is 1000; values above 1000 are set to 1000. + */ + pageSize?: number; + /** + * A page token, received from a previous SchemaService.ListSchemas call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SchemaService.ListSchemas must match the call that provided the page token. + */ + pageToken?: string; + /** + * Required. The parent data store resource name, in the format of `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}`. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Patch + extends StandardParameters { + /** + * If set to true, and the Schema is not found, a new Schema is created. In this situation, `update_mask` is ignored. + */ + allowMissing?: boolean; + /** + * 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. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaSchema; + } + + export class Resource$Projects$Locations$Collections$Datastores$Schemas$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * 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. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -11918,57 +14671,57 @@ export namespace discoveryengine_v1alpha { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Get, + params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Operations$Get, options: StreamMethodOptions ): GaxiosPromise; get( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Get, + params?: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Operations$Get, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Get, + params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Get, + params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Operations$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Get, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Operations$Get, + callback: BodyResponseCallback ): void; get( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Operations$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Get; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Get; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Operations$Get; options = {}; } @@ -11994,19 +14747,17 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Lists all Conversations by their parent DataStore. + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -12014,57 +14765,57 @@ export namespace discoveryengine_v1alpha { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$List, + params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Operations$List, options: StreamMethodOptions ): GaxiosPromise; list( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$List, + params?: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Operations$List, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$List, + params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$List, + params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Operations$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$List, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Operations$List, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Conversations$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Operations$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Conversations$List; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Conversations$List; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Operations$List; options = {}; } @@ -12078,7 +14829,7 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/conversations').replace( + url: (rootUrl + '/v1alpha/{+name}/operations').replace( /([^:]\/)\/+/g, '$1' ), @@ -12088,82 +14839,116 @@ export namespace discoveryengine_v1alpha { options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Operations$Get + extends StandardParameters { /** - * Updates a Conversation. Conversation action type cannot be changed. If the Conversation to update does not exist, a NOT_FOUND error is returned. + * The name of the operation resource. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Operations$List + extends StandardParameters { + /** + * The standard list filter. + */ + filter?: string; + /** + * The name of the operation's parent resource. + */ + name?: string; + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. + */ + pageToken?: string; + } + + export class Resource$Projects$Locations$Collections$Datastores$Servingconfigs { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Answer query method. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - patch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Patch, + answer( + params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Answer, options: StreamMethodOptions ): GaxiosPromise; - patch( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Patch, + answer( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Answer, options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Patch, + ): GaxiosPromise; + answer( + params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Answer, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Patch, + answer( + params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Answer, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Patch, - callback: BodyResponseCallback + answer( + params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Answer, + callback: BodyResponseCallback ): void; - patch( - callback: BodyResponseCallback + answer( + callback: BodyResponseCallback ): void; - patch( + answer( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Patch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Answer + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Patch; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Answer; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Patch; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Answer; options = {}; } @@ -12177,174 +14962,92 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + url: (rootUrl + '/v1alpha/{+servingConfig}:answer').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['servingConfig'], + pathParams: ['servingConfig'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } - } - - export interface Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Converse - extends StandardParameters { - /** - * Required. The resource name of the Conversation to get. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/{conversation_id\}`. Use `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/-` to activate auto session mode, which automatically creates a new conversation inside a ConverseConversation session. - */ - name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaConverseConversationRequest; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Create - extends StandardParameters { - /** - * Required. Full resource name of parent data store. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}` - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaConversation; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Delete - extends StandardParameters { - /** - * Required. The resource name of the Conversation to delete. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/{conversation_id\}` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Get - extends StandardParameters { - /** - * Required. The resource name of the Conversation to get. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/{conversation_id\}` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Conversations$List - extends StandardParameters { - /** - * A filter to apply on the list results. The supported features are: user_pseudo_id, state. Example: "user_pseudo_id = some_id" - */ - filter?: string; - /** - * 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` * `conversation_name` Example: "update_time desc" "create_time" - */ - orderBy?: string; - /** - * Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000. - */ - pageSize?: number; - /** - * A page token, received from a previous `ListConversations` call. Provide this to retrieve the subsequent page. - */ - pageToken?: string; - /** - * Required. The data store resource name. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}` - */ - parent?: string; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Patch - extends StandardParameters { - /** - * Immutable. Fully qualified name `projects/{project\}/locations/global/collections/{collection\}/dataStore/x/conversations/x` or `projects/{project\}/locations/global/collections/{collection\}/engines/x/conversations/x`. - */ - name?: string; - /** - * Indicates which fields in the provided Conversation to update. The following are NOT supported: * Conversation.name If not set or empty, all supported fields are updated. - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaConversation; - } - - export class Resource$Projects$Locations$Collections$Datastores$Custommodels { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Gets a list of all the custom models. + * Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not exist. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Custommodels$List, + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Custommodels$List, + get( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Custommodels$List, + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Custommodels$List, + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Custommodels$List, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - list( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Custommodels$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Custommodels$List; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Custommodels$List; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get; options = {}; } @@ -12358,119 +15061,89 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+dataStore}/customModels').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['dataStore'], - pathParams: ['dataStore'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } - } - - export interface Params$Resource$Projects$Locations$Collections$Datastores$Custommodels$List - extends StandardParameters { - /** - * Required. The resource name of the parent Data Store, such as `projects/x/locations/global/collections/default_collection/dataStores/default_data_store`. This field is used to identify the data store where to fetch the models from. - */ - dataStore?: string; - } - - export class Resource$Projects$Locations$Collections$Datastores$Models { - context: APIRequestContext; - operations: Resource$Projects$Locations$Collections$Datastores$Models$Operations; - constructor(context: APIRequestContext) { - this.context = context; - this.operations = - new Resource$Projects$Locations$Collections$Datastores$Models$Operations( - this.context - ); - } - } - - export class Resource$Projects$Locations$Collections$Datastores$Models$Operations { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * 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. + * Lists all ServingConfigs linked to this dataStore. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Models$Operations$Get, + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Models$Operations$Get, + list( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Models$Operations$Get, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Models$Operations$Get, + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Models$Operations$Get, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - get( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Models$Operations$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Models$Operations$Get; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Models$Operations$Get; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List; options = {}; } @@ -12484,87 +15157,92 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1alpha/{+parent}/servingConfigs').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + * Updates a ServingConfig. Returns a NOT_FOUND error if the ServingConfig does not exist. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Models$Operations$List, + patch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Models$Operations$List, + patch( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Models$Operations$List, + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Models$Operations$List, + patch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Models$Operations$List, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + patch( + callback: BodyResponseCallback ): void; - list( + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Models$Operations$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Models$Operations$List; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Models$Operations$List; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch; options = {}; } @@ -12578,11 +15256,8 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}/operations').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', apiVersion: '', }, options @@ -12593,111 +15268,77 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } - } - - export interface Params$Resource$Projects$Locations$Collections$Datastores$Models$Operations$Get - extends StandardParameters { - /** - * The name of the operation resource. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Models$Operations$List - extends StandardParameters { - /** - * The standard list filter. - */ - filter?: string; - /** - * The name of the operation's parent resource. - */ - name?: string; - /** - * The standard list page size. - */ - pageSize?: number; - /** - * The standard list page token. - */ - pageToken?: string; - } - - export class Resource$Projects$Locations$Collections$Datastores$Operations { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * 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. + * Makes a recommendation, which requires a contextual user event. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Operations$Get, + recommend( + params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Operations$Get, - options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Operations$Get, + recommend( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend, + options?: MethodOptions + ): GaxiosPromise; + recommend( + params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Operations$Get, + recommend( + params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Operations$Get, - callback: BodyResponseCallback + recommend( + params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + recommend( + callback: BodyResponseCallback ): void; - get( + recommend( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Operations$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Operations$Get; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Operations$Get; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend; options = {}; } @@ -12711,87 +15352,92 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1alpha/{+servingConfig}:recommend').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['servingConfig'], + pathParams: ['servingConfig'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + * Performs a search. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Operations$List, + search( + params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Search, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Operations$List, + search( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Search, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Operations$List, + ): GaxiosPromise; + search( + params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Search, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Operations$List, + search( + params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Search, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Operations$List, - callback: BodyResponseCallback + search( + params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Search, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + search( + callback: BodyResponseCallback ): void; - list( + search( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Operations$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Search + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Operations$List; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Search; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Operations$List; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Search; options = {}; } @@ -12805,73 +15451,121 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}/operations').replace( + url: (rootUrl + '/v1alpha/{+servingConfig}:search').replace( /([^:]\/)\/+/g, '$1' ), - method: 'GET', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['servingConfig'], + pathParams: ['servingConfig'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Operations$Get + export interface Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Answer extends StandardParameters { /** - * The name of the operation resource. + * Required. The resource name of the Search serving config, such as `projects/x/locations/global/collections/default_collection/engines/x/servingConfigs/default_serving_config`, or `projects/x/locations/global/collections/default_collection/dataStores/x/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. + */ + servingConfig?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaAnswerQueryRequest; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get + extends StandardParameters { + /** + * Required. The resource name of the ServingConfig to get. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/engines/{engine\}/servingConfigs/{serving_config_id\}` */ name?: string; } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Operations$List + export interface Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List extends StandardParameters { /** - * The standard list filter. + * Optional. Maximum number of results to return. If unspecified, defaults to 100. If a value greater than 100 is provided, at most 100 results are returned. */ - filter?: string; + pageSize?: number; /** - * The name of the operation's parent resource. + * Optional. A page token, received from a previous `ListServingConfigs` call. Provide this to retrieve the subsequent page. + */ + pageToken?: string; + /** + * Required. Full resource name of the parent resource. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/engines/{engine\}` + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch + extends StandardParameters { + /** + * Immutable. Fully qualified name `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}/servingConfigs/{serving_config_id\}` */ name?: string; /** - * The standard list page size. + * Indicates which fields in the provided ServingConfig to update. The following are NOT supported: * ServingConfig.name If not set, all supported fields are updated. */ - pageSize?: number; + updateMask?: string; + /** - * The standard list page token. + * Request body metadata */ - pageToken?: string; + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaServingConfig; } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend + extends StandardParameters { + /** + * Required. Full resource name of a ServingConfig: `projects/x/locations/global/collections/x/engines/x/servingConfigs/x`, or `projects/x/locations/global/collections/x/dataStores/x/servingConfigs/x` One default serving config is created along with your recommendation engine creation. The engine ID is used as the ID of the default serving config. For example, for Engine `projects/x/locations/global/collections/x/engines/my-engine`, you can use `projects/x/locations/global/collections/x/engines/my-engine/servingConfigs/my-engine` for your RecommendationService.Recommend requests. + */ + servingConfig?: string; - export class Resource$Projects$Locations$Collections$Datastores$Schemas { + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaRecommendRequest; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Search + extends StandardParameters { + /** + * Required. The resource name of the Search serving config, such as `projects/x/locations/global/collections/default_collection/engines/x/servingConfigs/default_serving_config`, or `projects/x/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. + */ + servingConfig?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequest; + } + + export class Resource$Projects$Locations$Collections$Datastores$Sessions { context: APIRequestContext; - operations: Resource$Projects$Locations$Collections$Datastores$Schemas$Operations; + answers: Resource$Projects$Locations$Collections$Datastores$Sessions$Answers; constructor(context: APIRequestContext) { this.context = context; - this.operations = - new Resource$Projects$Locations$Collections$Datastores$Schemas$Operations( + this.answers = + new Resource$Projects$Locations$Collections$Datastores$Sessions$Answers( this.context ); } /** - * Creates a Schema. + * Creates a Session. If the Session to create already exists, an ALREADY_EXISTS error is returned. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -12879,57 +15573,57 @@ export namespace discoveryengine_v1alpha { * @returns A promise if used with async/await, or void if used with a callback. */ create( - params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Create, + params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Create, options: StreamMethodOptions ): GaxiosPromise; create( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Create, + params?: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Create, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; create( - params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Create, + params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; create( - params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Create, + params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Create, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; create( - params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Create, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Create, + callback: BodyResponseCallback ): void; create( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Create; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Create; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Create; options = {}; } @@ -12943,7 +15637,7 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/schemas').replace( + url: (rootUrl + '/v1alpha/{+parent}/sessions').replace( /([^:]\/)\/+/g, '$1' ), @@ -12958,17 +15652,19 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Deletes a Schema. + * Deletes a Session. If the Session to delete does not exist, a NOT_FOUND error is returned. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -12976,57 +15672,53 @@ export namespace discoveryengine_v1alpha { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Delete, + params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Delete, options: StreamMethodOptions ): GaxiosPromise; delete( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Delete, + params?: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Delete, options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Delete, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Delete, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Delete, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; delete( - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Delete, + callback: BodyResponseCallback ): void; + delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Delete; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Delete; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Delete; options = {}; } @@ -13052,17 +15744,17 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Gets a Schema. + * Gets a Session. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -13070,57 +15762,57 @@ export namespace discoveryengine_v1alpha { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Get, + params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Get, options: StreamMethodOptions ): GaxiosPromise; get( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Get, + params?: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Get, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Get, + params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Get, + params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Get, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Get, + callback: BodyResponseCallback ): void; get( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Get; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Get; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Get; options = {}; } @@ -13146,19 +15838,19 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Gets a list of Schemas. + * Lists all Sessions by their parent DataStore. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -13166,57 +15858,57 @@ export namespace discoveryengine_v1alpha { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$List, + params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$List, options: StreamMethodOptions ): GaxiosPromise; list( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$List, + params?: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$List, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$List, + params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$List, + params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$List, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$List, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Schemas$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Sessions$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Schemas$List; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sessions$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Schemas$List; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Sessions$List; options = {}; } @@ -13230,7 +15922,7 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/schemas').replace( + url: (rootUrl + '/v1alpha/{+parent}/sessions').replace( /([^:]\/)\/+/g, '$1' ), @@ -13245,19 +15937,19 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Updates a Schema. + * Updates a Session. Session action type cannot be changed. If the Session to update does not exist, a NOT_FOUND error is returned. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -13265,57 +15957,57 @@ export namespace discoveryengine_v1alpha { * @returns A promise if used with async/await, or void if used with a callback. */ patch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Patch, + params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Patch, options: StreamMethodOptions ): GaxiosPromise; patch( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Patch, + params?: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Patch, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; patch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Patch, + params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; patch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Patch, + params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Patch, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; patch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Patch, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Patch, + callback: BodyResponseCallback ): void; patch( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Patch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Patch; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Patch; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Patch; options = {}; } @@ -13341,86 +16033,92 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Create + export interface Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Create extends StandardParameters { /** - * Required. The parent data store resource name, in the format of `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}`. + * Required. Full resource name of parent data store. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}` */ parent?: string; - /** - * Required. The ID to use for the Schema, which becomes the final component of the Schema.name. This field should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. - */ - schemaId?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaSchema; + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaSession; } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Delete + export interface Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Delete extends StandardParameters { /** - * Required. The full resource name of the schema, in the format of `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/schemas/{schema\}`. + * Required. The resource name of the Session to delete. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/sessions/{session_id\}` */ name?: string; } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Get + export interface Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Get extends StandardParameters { /** - * Required. The full resource name of the schema, in the format of `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/schemas/{schema\}`. + * Required. The resource name of the Session to get. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/sessions/{session_id\}` */ name?: string; } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Schemas$List + export interface Params$Resource$Projects$Locations$Collections$Datastores$Sessions$List extends StandardParameters { /** - * The maximum number of Schemas to return. The service may return fewer than this value. If unspecified, at most 100 Schemas are returned. The maximum value is 1000; values above 1000 are set to 1000. + * A filter to apply on the list results. The supported features are: user_pseudo_id, state. Example: "user_pseudo_id = some_id" + */ + filter?: string; + /** + * 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` Example: "update_time desc" "create_time" + */ + orderBy?: string; + /** + * Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000. */ pageSize?: number; /** - * A page token, received from a previous SchemaService.ListSchemas call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SchemaService.ListSchemas must match the call that provided the page token. + * A page token, received from a previous `ListSessions` call. Provide this to retrieve the subsequent page. */ pageToken?: string; /** - * Required. The parent data store resource name, in the format of `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}`. + * Required. The data store resource name. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}` */ parent?: string; } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Patch + export interface Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Patch extends StandardParameters { /** - * If set to true, and the Schema is not found, a new Schema is created. In this situation, `update_mask` is ignored. + * Immutable. Fully qualified name `projects/{project\}/locations/global/collections/{collection\}/engines/{engine\}/sessions/x` */ - allowMissing?: boolean; + name?: string; /** - * 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. + * 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. */ - name?: string; + updateMask?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaSchema; + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaSession; } - export class Resource$Projects$Locations$Collections$Datastores$Schemas$Operations { + export class Resource$Projects$Locations$Collections$Datastores$Sessions$Answers { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * 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. + * Gets a Answer. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -13428,57 +16126,57 @@ export namespace discoveryengine_v1alpha { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Operations$Get, + params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Answers$Get, options: StreamMethodOptions ): GaxiosPromise; get( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Operations$Get, + params?: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Answers$Get, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Operations$Get, + params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Answers$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Operations$Get, + params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Answers$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Operations$Get, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Answers$Get, + callback: BodyResponseCallback ): void; get( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Operations$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Answers$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Operations$Get; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Answers$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Operations$Get; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Answers$Get; options = {}; } @@ -13504,75 +16202,102 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); - } else { - return createAPIRequest(parameters); - } + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Answers$Get + extends StandardParameters { + /** + * Required. The resource name of the Answer to get. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/engines/{engine_id\}/sessions/{session_id\}/answers/{answer_id\}` + */ + name?: string; + } + + export class Resource$Projects$Locations$Collections$Datastores$Sitesearchengine { + context: APIRequestContext; + operations: Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations; + targetSites: Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites; + constructor(context: APIRequestContext) { + this.context = context; + this.operations = + new Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations( + this.context + ); + this.targetSites = + new Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites( + this.context + ); } /** - * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + * Verify target sites' ownership and validity. This API sends all the target sites under site search engine for verification. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Operations$List, + batchVerifyTargetSites( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Batchverifytargetsites, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Operations$List, + batchVerifyTargetSites( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Batchverifytargetsites, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Operations$List, + ): GaxiosPromise; + batchVerifyTargetSites( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Batchverifytargetsites, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Operations$List, + batchVerifyTargetSites( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Batchverifytargetsites, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Operations$List, - callback: BodyResponseCallback + batchVerifyTargetSites( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Batchverifytargetsites, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + batchVerifyTargetSites( + callback: BodyResponseCallback ): void; - list( + batchVerifyTargetSites( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Operations$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Batchverifytargetsites + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Operations$List; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Batchverifytargetsites; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Operations$List; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Batchverifytargetsites; options = {}; } @@ -13586,126 +16311,89 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}/operations').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: ( + rootUrl + '/v1alpha/{+parent}:batchVerifyTargetSites' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Operations$Get - extends StandardParameters { - /** - * The name of the operation resource. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Operations$List - extends StandardParameters { - /** - * The standard list filter. - */ - filter?: string; - /** - * The name of the operation's parent resource. - */ - name?: string; - /** - * The standard list page size. - */ - pageSize?: number; - /** - * The standard list page token. - */ - pageToken?: string; - } - - export class Resource$Projects$Locations$Collections$Datastores$Servingconfigs { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Answer query method. + * Downgrade from advanced site search to basic site search. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - answer( - params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Answer, + disableAdvancedSiteSearch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Disableadvancedsitesearch, options: StreamMethodOptions ): GaxiosPromise; - answer( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Answer, + disableAdvancedSiteSearch( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Disableadvancedsitesearch, options?: MethodOptions - ): GaxiosPromise; - answer( - params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Answer, + ): GaxiosPromise; + disableAdvancedSiteSearch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Disableadvancedsitesearch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - answer( - params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Answer, + disableAdvancedSiteSearch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Disableadvancedsitesearch, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - answer( - params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Answer, - callback: BodyResponseCallback + disableAdvancedSiteSearch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Disableadvancedsitesearch, + callback: BodyResponseCallback ): void; - answer( - callback: BodyResponseCallback + disableAdvancedSiteSearch( + callback: BodyResponseCallback ): void; - answer( + disableAdvancedSiteSearch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Answer - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Disableadvancedsitesearch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Answer; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Disableadvancedsitesearch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Answer; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Disableadvancedsitesearch; options = {}; } @@ -13719,92 +16407,89 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+servingConfig}:answer').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: ( + rootUrl + '/v1alpha/{+siteSearchEngine}:disableAdvancedSiteSearch' + ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['servingConfig'], - pathParams: ['servingConfig'], + requiredParams: ['siteSearchEngine'], + pathParams: ['siteSearchEngine'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not exist. + * Upgrade from basic site search to advanced site search. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get, + enableAdvancedSiteSearch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Enableadvancedsitesearch, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get, + enableAdvancedSiteSearch( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Enableadvancedsitesearch, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get, + ): GaxiosPromise; + enableAdvancedSiteSearch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Enableadvancedsitesearch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get, + enableAdvancedSiteSearch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Enableadvancedsitesearch, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get, - callback: BodyResponseCallback + enableAdvancedSiteSearch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Enableadvancedsitesearch, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + enableAdvancedSiteSearch( + callback: BodyResponseCallback ): void; - get( + enableAdvancedSiteSearch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Enableadvancedsitesearch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Enableadvancedsitesearch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Enableadvancedsitesearch; options = {}; } @@ -13818,89 +16503,89 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: ( + rootUrl + '/v1alpha/{+siteSearchEngine}:enableAdvancedSiteSearch' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['siteSearchEngine'], + pathParams: ['siteSearchEngine'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Lists all ServingConfigs linked to this dataStore. + * 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. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List, + fetchDomainVerificationStatus( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Fetchdomainverificationstatus, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List, + fetchDomainVerificationStatus( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Fetchdomainverificationstatus, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List, + ): GaxiosPromise; + fetchDomainVerificationStatus( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Fetchdomainverificationstatus, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List, + fetchDomainVerificationStatus( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Fetchdomainverificationstatus, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List, - callback: BodyResponseCallback + fetchDomainVerificationStatus( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Fetchdomainverificationstatus, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + fetchDomainVerificationStatus( + callback: BodyResponseCallback ): void; - list( + fetchDomainVerificationStatus( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Fetchdomainverificationstatus + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Fetchdomainverificationstatus; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Fetchdomainverificationstatus; options = {}; } @@ -13914,92 +16599,92 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/servingConfigs').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: ( + rootUrl + + '/v1alpha/{+siteSearchEngine}:fetchDomainVerificationStatus' + ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['siteSearchEngine'], + pathParams: ['siteSearchEngine'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Updates a ServingConfig. Returns a NOT_FOUND error if the ServingConfig does not exist. + * Gets the URI Pattern to Document data mapping for an Advanced Site Search DataStore. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - patch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch, + getUriPatternDocumentData( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Geturipatterndocumentdata, options: StreamMethodOptions ): GaxiosPromise; - patch( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch, + getUriPatternDocumentData( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Geturipatterndocumentdata, options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch, + ): GaxiosPromise; + getUriPatternDocumentData( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Geturipatterndocumentdata, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch, + getUriPatternDocumentData( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Geturipatterndocumentdata, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch, - callback: BodyResponseCallback + getUriPatternDocumentData( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Geturipatterndocumentdata, + callback: BodyResponseCallback ): void; - patch( - callback: BodyResponseCallback + getUriPatternDocumentData( + callback: BodyResponseCallback ): void; - patch( + getUriPatternDocumentData( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Geturipatterndocumentdata + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Geturipatterndocumentdata; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Geturipatterndocumentdata; options = {}; } @@ -14013,89 +16698,91 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + url: ( + rootUrl + '/v1alpha/{+siteSearchEngine}:getUriPatternDocumentData' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['siteSearchEngine'], + pathParams: ['siteSearchEngine'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Makes a recommendation, which requires a contextual user event. + * Request on-demand recrawl for a list of URIs. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - recommend( - params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend, + recrawlUris( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Recrawluris, options: StreamMethodOptions ): GaxiosPromise; - recommend( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend, + recrawlUris( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Recrawluris, options?: MethodOptions - ): GaxiosPromise; - recommend( - params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend, + ): GaxiosPromise; + recrawlUris( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Recrawluris, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - recommend( - params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend, + recrawlUris( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Recrawluris, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - recommend( - params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend, - callback: BodyResponseCallback + recrawlUris( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Recrawluris, + callback: BodyResponseCallback ): void; - recommend( - callback: BodyResponseCallback + recrawlUris( + callback: BodyResponseCallback ): void; - recommend( + recrawlUris( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Recrawluris + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Recrawluris; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Recrawluris; options = {}; } @@ -14109,7 +16796,7 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+servingConfig}:recommend').replace( + url: (rootUrl + '/v1alpha/{+siteSearchEngine}:recrawlUris').replace( /([^:]\/)\/+/g, '$1' ), @@ -14119,82 +16806,80 @@ export namespace discoveryengine_v1alpha { options ), params, - requiredParams: ['servingConfig'], - pathParams: ['servingConfig'], + requiredParams: ['siteSearchEngine'], + pathParams: ['siteSearchEngine'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Performs a search. + * Sets the URI Pattern to Document data mapping for an Advanced Site Search DataStore. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - search( - params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Search, + setUriPatternDocumentData( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Seturipatterndocumentdata, options: StreamMethodOptions ): GaxiosPromise; - search( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Search, + setUriPatternDocumentData( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Seturipatterndocumentdata, options?: MethodOptions - ): GaxiosPromise; - search( - params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Search, + ): GaxiosPromise; + setUriPatternDocumentData( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Seturipatterndocumentdata, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - search( - params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Search, + setUriPatternDocumentData( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Seturipatterndocumentdata, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - search( - params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Search, - callback: BodyResponseCallback + setUriPatternDocumentData( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Seturipatterndocumentdata, + callback: BodyResponseCallback ): void; - search( - callback: BodyResponseCallback + setUriPatternDocumentData( + callback: BodyResponseCallback ): void; - search( + setUriPatternDocumentData( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Search - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Seturipatterndocumentdata + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Search; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Seturipatterndocumentdata; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Search; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Seturipatterndocumentdata; options = {}; } @@ -14208,179 +16893,179 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+servingConfig}:search').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: ( + rootUrl + '/v1alpha/{+siteSearchEngine}:setUriPatternDocumentData' + ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['servingConfig'], - pathParams: ['servingConfig'], + requiredParams: ['siteSearchEngine'], + pathParams: ['siteSearchEngine'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Answer + export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Batchverifytargetsites extends StandardParameters { /** - * Required. The resource name of the Search serving config, such as `projects/x/locations/global/collections/default_collection/engines/x/servingConfigs/default_serving_config`, or `projects/x/locations/global/collections/default_collection/dataStores/x/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. + * Required. The parent resource shared by all TargetSites being verified. `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine`. */ - servingConfig?: string; + parent?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaAnswerQueryRequest; + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaBatchVerifyTargetSitesRequest; } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get + export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Disableadvancedsitesearch extends StandardParameters { /** - * Required. The resource name of the ServingConfig to get. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/engines/{engine\}/servingConfigs/{serving_config_id\}` + * Required. Full resource name of the SiteSearchEngine, such as `projects/{project\}/locations/{location\}/dataStores/{data_store_id\}/siteSearchEngine`. */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List - extends StandardParameters { + siteSearchEngine?: string; + /** - * Optional. Maximum number of results to return. If unspecified, defaults to 100. If a value greater than 100 is provided, at most 100 results are returned. + * Request body metadata */ - pageSize?: number; + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaDisableAdvancedSiteSearchRequest; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Enableadvancedsitesearch + extends StandardParameters { /** - * Optional. A page token, received from a previous `ListServingConfigs` call. Provide this to retrieve the subsequent page. + * Required. Full resource name of the SiteSearchEngine, such as `projects/{project\}/locations/{location\}/dataStores/{data_store_id\}/siteSearchEngine`. */ - pageToken?: string; + siteSearchEngine?: string; + /** - * Required. Full resource name of the parent resource. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/engines/{engine\}` + * Request body metadata */ - parent?: string; + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaEnableAdvancedSiteSearchRequest; } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch + export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Fetchdomainverificationstatus extends StandardParameters { /** - * Immutable. Fully qualified name `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}/servingConfigs/{serving_config_id\}` + * Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. The maximum value is 1000; values above 1000 will be coerced to 1000. If this field is negative, an INVALID_ARGUMENT error is returned. */ - name?: string; + pageSize?: number; + /** + * A page token, received from a previous `FetchDomainVerificationStatus` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `FetchDomainVerificationStatus` must match the call that provided the page token. + */ + pageToken?: string; /** - * Indicates which fields in the provided ServingConfig to update. The following are NOT supported: * ServingConfig.name If not set, all supported fields are updated. + * Required. The site search engine resource under which we fetch all the domain verification status. `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine`. */ - updateMask?: string; - + siteSearchEngine?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Geturipatterndocumentdata + extends StandardParameters { /** - * Request body metadata + * Required. Full resource name of the SiteSearchEngine, such as `projects/x/locations/x/collections/x/dataStores/x/siteSearchEngine`. */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaServingConfig; + siteSearchEngine?: string; } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend + export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Recrawluris extends StandardParameters { /** - * Required. Full resource name of a ServingConfig: `projects/x/locations/global/collections/x/engines/x/servingConfigs/x`, or `projects/x/locations/global/collections/x/dataStores/x/servingConfigs/x` One default serving config is created along with your recommendation engine creation. The engine ID is used as the ID of the default serving config. For example, for Engine `projects/x/locations/global/collections/x/engines/my-engine`, you can use `projects/x/locations/global/collections/x/engines/my-engine/servingConfigs/my-engine` for your RecommendationService.Recommend requests. + * Required. Full resource name of the SiteSearchEngine, such as `projects/x/locations/x/collections/x/dataStores/x/siteSearchEngine`. */ - servingConfig?: string; + siteSearchEngine?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaRecommendRequest; + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaRecrawlUrisRequest; } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Search + export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Seturipatterndocumentdata extends StandardParameters { /** - * Required. The resource name of the Search serving config, such as `projects/x/locations/global/collections/default_collection/engines/x/servingConfigs/default_serving_config`, or `projects/x/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. + * Required. Full resource name of the SiteSearchEngine, such as `projects/x/locations/x/collections/x/dataStores/x/siteSearchEngine`. */ - servingConfig?: string; + siteSearchEngine?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequest; + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaSetUriPatternDocumentDataRequest; } - export class Resource$Projects$Locations$Collections$Datastores$Sessions { + export class Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations { context: APIRequestContext; - answers: Resource$Projects$Locations$Collections$Datastores$Sessions$Answers; constructor(context: APIRequestContext) { this.context = context; - this.answers = - new Resource$Projects$Locations$Collections$Datastores$Sessions$Answers( - this.context - ); } /** - * Creates a Session. If the Session to create already exists, an ALREADY_EXISTS error is returned. + * 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. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - create( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Create, + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations$Get, options: StreamMethodOptions ): GaxiosPromise; - create( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Create, + get( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations$Get, options?: MethodOptions - ): GaxiosPromise; - create( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Create, + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Create, + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Create, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations$Get, + callback: BodyResponseCallback ): void; - create( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - create( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Create; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Create; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations$Get; options = {}; } @@ -14394,88 +17079,87 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/sessions').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Deletes a Session. If the Session to delete does not exist, a NOT_FOUND error is returned. + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - delete( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Delete, + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations$List, options: StreamMethodOptions ): GaxiosPromise; - delete( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Delete, + list( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations$List, options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Delete, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Delete, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations$List, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + list( + callback: BodyResponseCallback + ): void; + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Delete; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Delete; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations$List; options = {}; } @@ -14489,8 +17173,11 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1alpha/{+name}/operations').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', apiVersion: '', }, options @@ -14501,75 +17188,116 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations$Get + extends StandardParameters { /** - * Gets a Session. + * The name of the operation resource. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations$List + extends StandardParameters { + /** + * The standard list filter. + */ + filter?: string; + /** + * The name of the operation's parent resource. + */ + name?: string; + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. + */ + pageToken?: string; + } + + export class Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites { + context: APIRequestContext; + operations: Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.operations = + new Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations( + this.context + ); + } + + /** + * Creates TargetSite in a batch. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Get, + batchCreate( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Batchcreate, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Get, + batchCreate( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Batchcreate, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Get, + ): GaxiosPromise; + batchCreate( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Batchcreate, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Get, + batchCreate( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Batchcreate, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Get, - callback: BodyResponseCallback + batchCreate( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Batchcreate, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + batchCreate( + callback: BodyResponseCallback ): void; - get( + batchCreate( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Batchcreate + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Get; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Batchcreate; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Get; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Batchcreate; options = {}; } @@ -14583,89 +17311,89 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: ( + rootUrl + '/v1alpha/{+parent}/targetSites:batchCreate' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Lists all Sessions by their parent DataStore. + * Creates a TargetSite. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$List, + create( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Create, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$List, + create( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Create, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$List, + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$List, + create( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Create, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$List, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Create, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + create( + callback: BodyResponseCallback ): void; - list( + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Sessions$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sessions$List; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Sessions$List; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Create; options = {}; } @@ -14679,11 +17407,11 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/sessions').replace( + url: (rootUrl + '/v1alpha/{+parent}/targetSites').replace( /([^:]\/)\/+/g, '$1' ), - method: 'GET', + method: 'POST', apiVersion: '', }, options @@ -14694,77 +17422,75 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Updates a Session. Session action type cannot be changed. If the Session to update does not exist, a NOT_FOUND error is returned. + * Deletes a TargetSite. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - patch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Patch, + delete( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Delete, options: StreamMethodOptions ): GaxiosPromise; - patch( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Patch, + delete( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Delete, options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Patch, + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Patch, + delete( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Delete, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Patch, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Delete, + callback: BodyResponseCallback ): void; - patch( - callback: BodyResponseCallback + delete( + callback: BodyResponseCallback ): void; - patch( + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Patch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Patch; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Patch; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Delete; options = {}; } @@ -14779,7 +17505,7 @@ export namespace discoveryengine_v1alpha { options: Object.assign( { url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + method: 'DELETE', apiVersion: '', }, options @@ -14790,150 +17516,171 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Create - extends StandardParameters { /** - * Required. Full resource name of parent data store. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}` + * Gets a TargetSite. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. */ - parent?: string; + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Get; + let options = (optionsOrCallback || {}) as MethodOptions; - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaSession; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Delete - extends StandardParameters { - /** - * Required. The resource name of the Session to delete. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/sessions/{session_id\}` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Get - extends StandardParameters { - /** - * Required. The resource name of the Session to get. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/sessions/{session_id\}` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Sessions$List - extends StandardParameters { - /** - * A filter to apply on the list results. The supported features are: user_pseudo_id, state. Example: "user_pseudo_id = some_id" - */ - filter?: string; - /** - * 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` Example: "update_time desc" "create_time" - */ - orderBy?: string; - /** - * Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000. - */ - pageSize?: number; - /** - * A page token, received from a previous `ListSessions` call. Provide this to retrieve the subsequent page. - */ - pageToken?: string; - /** - * Required. The data store resource name. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}` - */ - parent?: string; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Patch - extends StandardParameters { - /** - * Immutable. Fully qualified name `projects/{project\}/locations/global/collections/{collection\}/engines/{engine\}/sessions/x` - */ - name?: string; - /** - * 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. - */ - updateMask?: string; + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Get; + options = {}; + } - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaSession; - } + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } - export class Resource$Projects$Locations$Collections$Datastores$Sessions$Answers { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } } /** - * Gets a Answer. + * Gets a list of TargetSites. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Answers$Get, + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$List, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Answers$Get, + list( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$List, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Answers$Get, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Answers$Get, + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Answers$Get, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$List, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - get( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Answers$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Answers$Get; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Answers$Get; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$List; options = {}; } @@ -14947,92 +17694,70 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1alpha/{+parent}/targetSites').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } - } - - export interface Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Answers$Get - extends StandardParameters { - /** - * Required. The resource name of the Answer to get. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/engines/{engine_id\}/sessions/{session_id\}/answers/{answer_id\}` - */ - name?: string; - } - - export class Resource$Projects$Locations$Collections$Datastores$Sitesearchengine { - context: APIRequestContext; - operations: Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations; - targetSites: Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites; - constructor(context: APIRequestContext) { - this.context = context; - this.operations = - new Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations( - this.context - ); - this.targetSites = - new Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites( - this.context - ); - } /** - * Verify target sites' ownership and validity. This API sends all the target sites under site search engine for verification. + * Updates a TargetSite. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - batchVerifyTargetSites( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Batchverifytargetsites, + patch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Patch, options: StreamMethodOptions ): GaxiosPromise; - batchVerifyTargetSites( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Batchverifytargetsites, + patch( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Patch, options?: MethodOptions ): GaxiosPromise; - batchVerifyTargetSites( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Batchverifytargetsites, + patch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - batchVerifyTargetSites( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Batchverifytargetsites, + patch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Patch, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - batchVerifyTargetSites( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Batchverifytargetsites, + patch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Patch, callback: BodyResponseCallback ): void; - batchVerifyTargetSites( + patch( callback: BodyResponseCallback ): void; - batchVerifyTargetSites( + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Batchverifytargetsites + | Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Patch | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -15048,13 +17773,13 @@ export namespace discoveryengine_v1alpha { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Batchverifytargetsites; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Batchverifytargetsites; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Patch; options = {}; } @@ -15068,17 +17793,15 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: ( - rootUrl + '/v1alpha/{+parent}:batchVerifyTargetSites' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { @@ -15090,45 +17813,118 @@ export namespace discoveryengine_v1alpha { return createAPIRequest(parameters); } } + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Batchcreate + extends StandardParameters { /** - * Downgrade from advanced site search to basic site search. + * Required. The parent resource shared by all TargetSites being created. `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine`. The parent field in the CreateBookRequest messages must either be empty or match this field. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSitesRequest; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Create + extends StandardParameters { + /** + * Required. Parent resource name of TargetSite, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine`. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaTargetSite; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Delete + extends StandardParameters { + /** + * Required. Full resource name of TargetSite, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine/targetSites/{target_site\}`. If the caller does not have permission to access the TargetSite, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested TargetSite does not exist, a NOT_FOUND error is returned. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Get + extends StandardParameters { + /** + * Required. Full resource name of TargetSite, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine/targetSites/{target_site\}`. If the caller does not have permission to access the TargetSite, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested TargetSite does not exist, a NOT_FOUND error is returned. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$List + extends StandardParameters { + /** + * Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. The maximum value is 1000; values above 1000 will be coerced to 1000. If this field is negative, an INVALID_ARGUMENT error is returned. + */ + pageSize?: number; + /** + * A page token, received from a previous `ListTargetSites` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListTargetSites` must match the call that provided the page token. + */ + pageToken?: string; + /** + * Required. The parent site search engine resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine`. If the caller does not have permission to list TargetSites under this site search engine, regardless of whether or not this branch exists, a PERMISSION_DENIED error is returned. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Patch + extends StandardParameters { + /** + * 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. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaTargetSite; + } + + export class Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * 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. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - disableAdvancedSiteSearch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Disableadvancedsitesearch, + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$Get, options: StreamMethodOptions ): GaxiosPromise; - disableAdvancedSiteSearch( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Disableadvancedsitesearch, + get( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$Get, options?: MethodOptions ): GaxiosPromise; - disableAdvancedSiteSearch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Disableadvancedsitesearch, + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - disableAdvancedSiteSearch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Disableadvancedsitesearch, + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$Get, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - disableAdvancedSiteSearch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Disableadvancedsitesearch, + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$Get, callback: BodyResponseCallback ): void; - disableAdvancedSiteSearch( + get( callback: BodyResponseCallback ): void; - disableAdvancedSiteSearch( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Disableadvancedsitesearch + | Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$Get | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -15144,13 +17940,13 @@ export namespace discoveryengine_v1alpha { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Disableadvancedsitesearch; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Disableadvancedsitesearch; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$Get; options = {}; } @@ -15164,17 +17960,15 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: ( - rootUrl + '/v1alpha/{+siteSearchEngine}:disableAdvancedSiteSearch' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['siteSearchEngine'], - pathParams: ['siteSearchEngine'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { @@ -15188,65 +17982,65 @@ export namespace discoveryengine_v1alpha { } /** - * Upgrade from basic site search to advanced site search. + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - enableAdvancedSiteSearch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Enableadvancedsitesearch, + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$List, options: StreamMethodOptions ): GaxiosPromise; - enableAdvancedSiteSearch( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Enableadvancedsitesearch, + list( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$List, options?: MethodOptions - ): GaxiosPromise; - enableAdvancedSiteSearch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Enableadvancedsitesearch, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - enableAdvancedSiteSearch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Enableadvancedsitesearch, + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - enableAdvancedSiteSearch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Enableadvancedsitesearch, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$List, + callback: BodyResponseCallback ): void; - enableAdvancedSiteSearch( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - enableAdvancedSiteSearch( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Enableadvancedsitesearch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Enableadvancedsitesearch; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Enableadvancedsitesearch; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$List; options = {}; } @@ -15260,89 +18054,126 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: ( - rootUrl + '/v1alpha/{+siteSearchEngine}:enableAdvancedSiteSearch' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + url: (rootUrl + '/v1alpha/{+name}/operations').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['siteSearchEngine'], - pathParams: ['siteSearchEngine'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$Get + extends StandardParameters { /** - * 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. + * The name of the operation resource. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$List + extends StandardParameters { + /** + * The standard list filter. + */ + filter?: string; + /** + * The name of the operation's parent resource. + */ + name?: string; + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. + */ + pageToken?: string; + } + + export class Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Imports all SuggestionDenyListEntry for a DataStore. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - fetchDomainVerificationStatus( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Fetchdomainverificationstatus, + import( + params: Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Import, options: StreamMethodOptions ): GaxiosPromise; - fetchDomainVerificationStatus( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Fetchdomainverificationstatus, + import( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Import, options?: MethodOptions - ): GaxiosPromise; - fetchDomainVerificationStatus( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Fetchdomainverificationstatus, + ): GaxiosPromise; + import( + params: Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Import, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - fetchDomainVerificationStatus( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Fetchdomainverificationstatus, + import( + params: Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Import, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - fetchDomainVerificationStatus( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Fetchdomainverificationstatus, - callback: BodyResponseCallback + import( + params: Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Import, + callback: BodyResponseCallback ): void; - fetchDomainVerificationStatus( - callback: BodyResponseCallback + import( + callback: BodyResponseCallback ): void; - fetchDomainVerificationStatus( + import( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Fetchdomainverificationstatus - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Import + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Fetchdomainverificationstatus; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Import; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Fetchdomainverificationstatus; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Import; options = {}; } @@ -15357,69 +18188,66 @@ export namespace discoveryengine_v1alpha { options: Object.assign( { url: ( - rootUrl + - '/v1alpha/{+siteSearchEngine}:fetchDomainVerificationStatus' + rootUrl + '/v1alpha/{+parent}/suggestionDenyListEntries:import' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['siteSearchEngine'], - pathParams: ['siteSearchEngine'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Request on-demand recrawl for a list of URIs. + * Permanently deletes all SuggestionDenyListEntry for a DataStore. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - recrawlUris( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Recrawluris, + purge( + params: Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Purge, options: StreamMethodOptions ): GaxiosPromise; - recrawlUris( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Recrawluris, + purge( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Purge, options?: MethodOptions ): GaxiosPromise; - recrawlUris( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Recrawluris, + purge( + params: Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Purge, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - recrawlUris( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Recrawluris, + purge( + params: Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Purge, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - recrawlUris( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Recrawluris, + purge( + params: Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Purge, callback: BodyResponseCallback ): void; - recrawlUris( + purge( callback: BodyResponseCallback ): void; - recrawlUris( + purge( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Recrawluris + | Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Purge | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -15435,13 +18263,13 @@ export namespace discoveryengine_v1alpha { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Recrawluris; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Purge; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Recrawluris; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Purge; options = {}; } @@ -15455,18 +18283,17 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+siteSearchEngine}:recrawlUris').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: ( + rootUrl + '/v1alpha/{+parent}/suggestionDenyListEntries:purge' + ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['siteSearchEngine'], - pathParams: ['siteSearchEngine'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { @@ -15477,139 +18304,96 @@ export namespace discoveryengine_v1alpha { } else { return createAPIRequest(parameters); } - } - } - - export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Batchverifytargetsites - extends StandardParameters { - /** - * Required. The parent resource shared by all TargetSites being verified. `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine`. - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaBatchVerifyTargetSitesRequest; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Disableadvancedsitesearch - extends StandardParameters { - /** - * Required. Full resource name of the SiteSearchEngine, such as `projects/{project\}/locations/{location\}/dataStores/{data_store_id\}/siteSearchEngine`. - */ - siteSearchEngine?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaDisableAdvancedSiteSearchRequest; + } } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Enableadvancedsitesearch + + export interface Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Import extends StandardParameters { /** - * Required. Full resource name of the SiteSearchEngine, such as `projects/{project\}/locations/{location\}/dataStores/{data_store_id\}/siteSearchEngine`. + * Required. The parent data store resource name for which to import denylist entries. Follows pattern projects/x/locations/x/collections/x/dataStores/x. */ - siteSearchEngine?: string; + parent?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaEnableAdvancedSiteSearchRequest; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Fetchdomainverificationstatus - extends StandardParameters { - /** - * Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. The maximum value is 1000; values above 1000 will be coerced to 1000. If this field is negative, an INVALID_ARGUMENT error is returned. - */ - pageSize?: number; - /** - * A page token, received from a previous `FetchDomainVerificationStatus` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `FetchDomainVerificationStatus` must match the call that provided the page token. - */ - pageToken?: string; - /** - * Required. The site search engine resource under which we fetch all the domain verification status. `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine`. - */ - siteSearchEngine?: string; + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesRequest; } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Recrawluris + export interface Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Purge extends StandardParameters { /** - * Required. Full resource name of the SiteSearchEngine, such as `projects/x/locations/x/collections/x/dataStores/x/siteSearchEngine`. + * Required. The parent data store resource name for which to import denylist entries. Follows pattern projects/x/locations/x/collections/x/dataStores/x. */ - siteSearchEngine?: string; + parent?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaRecrawlUrisRequest; + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaPurgeSuggestionDenyListEntriesRequest; } - export class Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations { + export class Resource$Projects$Locations$Collections$Datastores$Userevents { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * 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. + * 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. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations$Get, + collect( + params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Collect, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations$Get, + collect( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Collect, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations$Get, + ): GaxiosPromise; + collect( + params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Collect, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations$Get, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations$Get, - callback: BodyResponseCallback + collect( + params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Collect, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + collect( + params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Collect, + callback: BodyResponseCallback ): void; - get( + collect(callback: BodyResponseCallback): void; + collect( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Collect + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations$Get; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Collect; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations$Get; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Collect; options = {}; } @@ -15623,87 +18407,90 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1alpha/{+parent}/userEvents:collect').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + * 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. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations$List, + import( + params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Import, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations$List, + import( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Import, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations$List, + ): GaxiosPromise; + import( + params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Import, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations$List, + import( + params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Import, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations$List, - callback: BodyResponseCallback + import( + params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Import, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + import( + callback: BodyResponseCallback ): void; - list( + import( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Import + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations$List; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Import; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations$List; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Import; options = {}; } @@ -15717,131 +18504,187 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}/operations').replace( + url: (rootUrl + '/v1alpha/{+parent}/userEvents:import').replace( /([^:]\/)\/+/g, '$1' ), - method: 'GET', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations$Get - extends StandardParameters { - /** - * The name of the operation resource. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations$List - extends StandardParameters { - /** - * The standard list filter. - */ - filter?: string; - /** - * The name of the operation's parent resource. - */ - name?: string; - /** - * The standard list page size. - */ - pageSize?: number; /** - * The standard list page token. + * 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. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. */ - pageToken?: string; - } + purge( + params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Purge, + options: StreamMethodOptions + ): GaxiosPromise; + purge( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Purge, + options?: MethodOptions + ): GaxiosPromise; + purge( + params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Purge, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + purge( + params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Purge, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + purge( + params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Purge, + callback: BodyResponseCallback + ): void; + purge( + callback: BodyResponseCallback + ): void; + purge( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Purge + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Purge; + let options = (optionsOrCallback || {}) as MethodOptions; - export class Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites { - context: APIRequestContext; - operations: Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations; - constructor(context: APIRequestContext) { - this.context = context; - this.operations = - new Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations( - this.context + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Purge; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+parent}/userEvents:purge').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback ); + } else { + return createAPIRequest(parameters); + } } /** - * Creates TargetSite in a batch. + * Writes a single user event. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - batchCreate( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Batchcreate, + write( + params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Write, options: StreamMethodOptions ): GaxiosPromise; - batchCreate( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Batchcreate, + write( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Write, options?: MethodOptions - ): GaxiosPromise; - batchCreate( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Batchcreate, + ): GaxiosPromise; + write( + params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Write, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - batchCreate( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Batchcreate, + write( + params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Write, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - batchCreate( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Batchcreate, - callback: BodyResponseCallback + write( + params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Write, + callback: BodyResponseCallback ): void; - batchCreate( - callback: BodyResponseCallback + write( + callback: BodyResponseCallback ): void; - batchCreate( + write( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Batchcreate - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Write + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Batchcreate; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Write; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Batchcreate; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Write; options = {}; } @@ -15855,9 +18698,10 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: ( - rootUrl + '/v1alpha/{+parent}/targetSites:batchCreate' - ).replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1alpha/{+parent}/userEvents:write').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'POST', apiVersion: '', }, @@ -15869,17 +18713,111 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Collect + extends StandardParameters { /** - * Creates a TargetSite. + * The event timestamp in milliseconds. This prevents browser caching of otherwise identical get requests. The name is abbreviated to reduce the payload bytes. + */ + ets?: string; + /** + * Required. The parent DataStore resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}`. + */ + parent?: string; + /** + * 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 third-party requests. + */ + uri?: string; + /** + * Required. URL encoded UserEvent proto with a length limit of 2,000,000 characters. + */ + userEvent?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Import + extends StandardParameters { + /** + * Required. Parent DataStore resource name, of the form `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaImportUserEventsRequest; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Purge + extends StandardParameters { + /** + * Required. The resource name of the catalog under which the events are created. The format is `projects/${projectId\}/locations/global/collections/{$collectionId\}/dataStores/${dataStoreId\}` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaPurgeUserEventsRequest; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Write + extends StandardParameters { + /** + * Required. The parent resource name. If the write user event action is applied in DataStore level, the format is: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}`. If the write user event action is applied in Location level, for example, the event with Document across multiple DataStore, the format is: `projects/{project\}/locations/{location\}`. + */ + parent?: string; + /** + * If set to true, the user event is written asynchronously after validation, and the API responds without waiting for the write. + */ + writeAsync?: boolean; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaUserEvent; + } + + export class Resource$Projects$Locations$Collections$Engines { + context: APIRequestContext; + controls: Resource$Projects$Locations$Collections$Engines$Controls; + conversations: Resource$Projects$Locations$Collections$Engines$Conversations; + operations: Resource$Projects$Locations$Collections$Engines$Operations; + servingConfigs: Resource$Projects$Locations$Collections$Engines$Servingconfigs; + sessions: Resource$Projects$Locations$Collections$Engines$Sessions; + constructor(context: APIRequestContext) { + this.context = context; + this.controls = + new Resource$Projects$Locations$Collections$Engines$Controls( + this.context + ); + this.conversations = + new Resource$Projects$Locations$Collections$Engines$Conversations( + this.context + ); + this.operations = + new Resource$Projects$Locations$Collections$Engines$Operations( + this.context + ); + this.servingConfigs = + new Resource$Projects$Locations$Collections$Engines$Servingconfigs( + this.context + ); + this.sessions = + new Resource$Projects$Locations$Collections$Engines$Sessions( + this.context + ); + } + + /** + * Creates a Engine. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -15887,27 +18825,27 @@ export namespace discoveryengine_v1alpha { * @returns A promise if used with async/await, or void if used with a callback. */ create( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Create, + params: Params$Resource$Projects$Locations$Collections$Engines$Create, options: StreamMethodOptions ): GaxiosPromise; create( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Create, + params?: Params$Resource$Projects$Locations$Collections$Engines$Create, options?: MethodOptions ): GaxiosPromise; create( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Create, + params: Params$Resource$Projects$Locations$Collections$Engines$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; create( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Create, + params: Params$Resource$Projects$Locations$Collections$Engines$Create, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; create( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Create, + params: Params$Resource$Projects$Locations$Collections$Engines$Create, callback: BodyResponseCallback ): void; create( @@ -15915,7 +18853,7 @@ export namespace discoveryengine_v1alpha { ): void; create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Create + | Params$Resource$Projects$Locations$Collections$Engines$Create | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -15931,13 +18869,13 @@ export namespace discoveryengine_v1alpha { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Create; + {}) as Params$Resource$Projects$Locations$Collections$Engines$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Create; + {} as Params$Resource$Projects$Locations$Collections$Engines$Create; options = {}; } @@ -15951,7 +18889,7 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/targetSites').replace( + url: (rootUrl + '/v1alpha/{+parent}/engines').replace( /([^:]\/)\/+/g, '$1' ), @@ -15976,7 +18914,7 @@ export namespace discoveryengine_v1alpha { } /** - * Deletes a TargetSite. + * Deletes a Engine. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -15984,27 +18922,27 @@ export namespace discoveryengine_v1alpha { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Delete, + params: Params$Resource$Projects$Locations$Collections$Engines$Delete, options: StreamMethodOptions ): GaxiosPromise; delete( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Delete, + params?: Params$Resource$Projects$Locations$Collections$Engines$Delete, options?: MethodOptions ): GaxiosPromise; delete( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Delete, + params: Params$Resource$Projects$Locations$Collections$Engines$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Delete, + params: Params$Resource$Projects$Locations$Collections$Engines$Delete, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Delete, + params: Params$Resource$Projects$Locations$Collections$Engines$Delete, callback: BodyResponseCallback ): void; delete( @@ -16012,7 +18950,7 @@ export namespace discoveryengine_v1alpha { ): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Delete + | Params$Resource$Projects$Locations$Collections$Engines$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -16028,13 +18966,13 @@ export namespace discoveryengine_v1alpha { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Delete; + {}) as Params$Resource$Projects$Locations$Collections$Engines$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Delete; + {} as Params$Resource$Projects$Locations$Collections$Engines$Delete; options = {}; } @@ -16070,7 +19008,7 @@ export namespace discoveryengine_v1alpha { } /** - * Gets a TargetSite. + * Gets a Engine. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -16078,57 +19016,57 @@ export namespace discoveryengine_v1alpha { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Get, + params: Params$Resource$Projects$Locations$Collections$Engines$Get, options: StreamMethodOptions ): GaxiosPromise; get( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Get, + params?: Params$Resource$Projects$Locations$Collections$Engines$Get, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Get, + params: Params$Resource$Projects$Locations$Collections$Engines$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Get, + params: Params$Resource$Projects$Locations$Collections$Engines$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Get, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Collections$Engines$Get, + callback: BodyResponseCallback ): void; get( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Engines$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Get; + {}) as Params$Resource$Projects$Locations$Collections$Engines$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Get; + {} as Params$Resource$Projects$Locations$Collections$Engines$Get; options = {}; } @@ -16154,19 +19092,19 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Gets a list of TargetSites. + * Lists all the Engines associated with the project. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -16174,57 +19112,57 @@ export namespace discoveryengine_v1alpha { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$List, + params: Params$Resource$Projects$Locations$Collections$Engines$List, options: StreamMethodOptions ): GaxiosPromise; list( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$List, + params?: Params$Resource$Projects$Locations$Collections$Engines$List, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$List, + params: Params$Resource$Projects$Locations$Collections$Engines$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$List, + params: Params$Resource$Projects$Locations$Collections$Engines$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$List, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Collections$Engines$List, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Engines$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$List; + {}) as Params$Resource$Projects$Locations$Collections$Engines$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$List; + {} as Params$Resource$Projects$Locations$Collections$Engines$List; options = {}; } @@ -16238,7 +19176,7 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/targetSites').replace( + url: (rootUrl + '/v1alpha/{+parent}/engines').replace( /([^:]\/)\/+/g, '$1' ), @@ -16253,19 +19191,19 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Updates a TargetSite. + * Updates an Engine * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -16273,57 +19211,57 @@ export namespace discoveryengine_v1alpha { * @returns A promise if used with async/await, or void if used with a callback. */ patch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Patch, + params: Params$Resource$Projects$Locations$Collections$Engines$Patch, options: StreamMethodOptions ): GaxiosPromise; patch( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Patch, + params?: Params$Resource$Projects$Locations$Collections$Engines$Patch, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; patch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Patch, + params: Params$Resource$Projects$Locations$Collections$Engines$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; patch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Patch, + params: Params$Resource$Projects$Locations$Collections$Engines$Patch, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; patch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Patch, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Collections$Engines$Patch, + callback: BodyResponseCallback ): void; patch( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Patch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Engines$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Patch; + {}) as Params$Resource$Projects$Locations$Collections$Engines$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Patch; + {} as Params$Resource$Projects$Locations$Collections$Engines$Patch; options = {}; } @@ -16349,148 +19287,176 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } - } - - export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Batchcreate - extends StandardParameters { - /** - * Required. The parent resource shared by all TargetSites being created. `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine`. The parent field in the CreateBookRequest messages must either be empty or match this field. - */ - parent?: string; /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSitesRequest; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Create - extends StandardParameters { - /** - * Required. Parent resource name of TargetSite, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine`. + * Pauses the training of an existing engine. Only applicable if SolutionType is SOLUTION_TYPE_RECOMMENDATION. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. */ - parent?: string; + pause( + params: Params$Resource$Projects$Locations$Collections$Engines$Pause, + options: StreamMethodOptions + ): GaxiosPromise; + pause( + params?: Params$Resource$Projects$Locations$Collections$Engines$Pause, + options?: MethodOptions + ): GaxiosPromise; + pause( + params: Params$Resource$Projects$Locations$Collections$Engines$Pause, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + pause( + params: Params$Resource$Projects$Locations$Collections$Engines$Pause, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + pause( + params: Params$Resource$Projects$Locations$Collections$Engines$Pause, + callback: BodyResponseCallback + ): void; + pause( + callback: BodyResponseCallback + ): void; + pause( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Collections$Engines$Pause + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Collections$Engines$Pause; + let options = (optionsOrCallback || {}) as MethodOptions; - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaTargetSite; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Delete - extends StandardParameters { - /** - * Required. Full resource name of TargetSite, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine/targetSites/{target_site\}`. If the caller does not have permission to access the TargetSite, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested TargetSite does not exist, a NOT_FOUND error is returned. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Get - extends StandardParameters { - /** - * Required. Full resource name of TargetSite, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine/targetSites/{target_site\}`. If the caller does not have permission to access the TargetSite, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested TargetSite does not exist, a NOT_FOUND error is returned. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$List - extends StandardParameters { - /** - * Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. The maximum value is 1000; values above 1000 will be coerced to 1000. If this field is negative, an INVALID_ARGUMENT error is returned. - */ - pageSize?: number; - /** - * A page token, received from a previous `ListTargetSites` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListTargetSites` must match the call that provided the page token. - */ - pageToken?: string; - /** - * Required. The parent site search engine resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine`. If the caller does not have permission to list TargetSites under this site search engine, regardless of whether or not this branch exists, a PERMISSION_DENIED error is returned. - */ - parent?: string; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Patch - extends StandardParameters { - /** - * 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. - */ - name?: string; + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Collections$Engines$Pause; + options = {}; + } - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaTargetSite; - } + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } - export class Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}:pause').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } } /** - * 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. + * Resumes the training of an existing engine. Only applicable if SolutionType is SOLUTION_TYPE_RECOMMENDATION. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. - */ - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$Get, + */ + resume( + params: Params$Resource$Projects$Locations$Collections$Engines$Resume, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$Get, + resume( + params?: Params$Resource$Projects$Locations$Collections$Engines$Resume, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$Get, + ): GaxiosPromise; + resume( + params: Params$Resource$Projects$Locations$Collections$Engines$Resume, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$Get, + resume( + params: Params$Resource$Projects$Locations$Collections$Engines$Resume, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$Get, - callback: BodyResponseCallback + resume( + params: Params$Resource$Projects$Locations$Collections$Engines$Resume, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + resume( + callback: BodyResponseCallback ): void; - get( + resume( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Engines$Resume + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$Get; + {}) as Params$Resource$Projects$Locations$Collections$Engines$Resume; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$Get; + {} as Params$Resource$Projects$Locations$Collections$Engines$Resume; options = {}; } @@ -16504,8 +19470,11 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1alpha/{+name}:resume').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options @@ -16516,75 +19485,77 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + * Tunes an existing engine. Only applicable if SolutionType is SOLUTION_TYPE_RECOMMENDATION. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$List, + tune( + params: Params$Resource$Projects$Locations$Collections$Engines$Tune, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$List, + tune( + params?: Params$Resource$Projects$Locations$Collections$Engines$Tune, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$List, + ): GaxiosPromise; + tune( + params: Params$Resource$Projects$Locations$Collections$Engines$Tune, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$List, + tune( + params: Params$Resource$Projects$Locations$Collections$Engines$Tune, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$List, - callback: BodyResponseCallback + tune( + params: Params$Resource$Projects$Locations$Collections$Engines$Tune, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + tune( + callback: BodyResponseCallback ): void; - list( + tune( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Engines$Tune + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$List; + {}) as Params$Resource$Projects$Locations$Collections$Engines$Tune; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$List; + {} as Params$Resource$Projects$Locations$Collections$Engines$Tune; options = {}; } @@ -16598,11 +19569,11 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}/operations').replace( + url: (rootUrl + '/v1alpha/{+name}:tune').replace( /([^:]\/)\/+/g, '$1' ), - method: 'GET', + method: 'POST', apiVersion: '', }, options @@ -16613,207 +19584,184 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$Get + export interface Params$Resource$Projects$Locations$Collections$Engines$Create extends StandardParameters { /** - * The name of the operation resource. + * Required. The ID to use for the Engine, which will become the final component of the Engine's resource name. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned. */ - name?: string; + engineId?: string; + /** + * Required. The parent resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}`. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaEngine; } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$List + export interface Params$Resource$Projects$Locations$Collections$Engines$Delete extends StandardParameters { /** - * The standard list filter. + * Required. Full resource name of Engine, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}`. If the caller does not have permission to delete the Engine, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the Engine to delete does not exist, a NOT_FOUND error is returned. */ - filter?: string; + name?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Engines$Get + extends StandardParameters { /** - * The name of the operation's parent resource. + * Required. Full resource name of Engine, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}`. */ name?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Engines$List + extends StandardParameters { /** - * The standard list page size. + * Optional. Filter by solution type. For example: solution_type=SOLUTION_TYPE_SEARCH + */ + filter?: string; + /** + * Optional. Not supported. */ pageSize?: number; /** - * The standard list page token. + * Optional. Not supported. */ pageToken?: string; + /** + * Required. The parent resource name, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}`. + */ + parent?: string; } + export interface Params$Resource$Projects$Locations$Collections$Engines$Patch + extends StandardParameters { + /** + * 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_number\}/locations/{location\}/collections/{collection\}/engines/{engine\}` engine should be 1-63 characters, and valid characters are /a-z0-9x/. Otherwise, an INVALID_ARGUMENT error is returned. + */ + name?: string; + /** + * Indicates which fields in the provided Engine to update. If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned. + */ + updateMask?: string; - export class Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaEngine; + } + export interface Params$Resource$Projects$Locations$Collections$Engines$Pause + extends StandardParameters { + /** + * Required. The name of the engine to pause. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/engines/{engine_id\}` + */ + name?: string; /** - * Imports all SuggestionDenyListEntry for a DataStore. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. + * Request body metadata */ - import( - params: Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Import, - options: StreamMethodOptions - ): GaxiosPromise; - import( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Import, - options?: MethodOptions - ): GaxiosPromise; - import( - params: Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Import, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - import( - params: Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Import, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - import( - params: Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Import, - callback: BodyResponseCallback - ): void; - import( - callback: BodyResponseCallback - ): void; - import( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Import - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Import; - let options = (optionsOrCallback || {}) as MethodOptions; + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaPauseEngineRequest; + } + export interface Params$Resource$Projects$Locations$Collections$Engines$Resume + extends StandardParameters { + /** + * Required. The name of the engine to resume. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/engines/{engine_id\}` + */ + name?: string; - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Import; - options = {}; - } + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaResumeEngineRequest; + } + export interface Params$Resource$Projects$Locations$Collections$Engines$Tune + extends StandardParameters { + /** + * Required. The resource name of the engine to tune. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/engines/{engine_id\}` + */ + name?: string; - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaTuneEngineRequest; + } - const rootUrl = - options.rootUrl || 'https://discoveryengine.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/v1alpha/{+parent}/suggestionDenyListEntries:import' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['parent'], - pathParams: ['parent'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } + export class Resource$Projects$Locations$Collections$Engines$Controls { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; } /** - * Permanently deletes all SuggestionDenyListEntry for a DataStore. + * 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. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - purge( - params: Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Purge, + create( + params: Params$Resource$Projects$Locations$Collections$Engines$Controls$Create, options: StreamMethodOptions ): GaxiosPromise; - purge( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Purge, + create( + params?: Params$Resource$Projects$Locations$Collections$Engines$Controls$Create, options?: MethodOptions - ): GaxiosPromise; - purge( - params: Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Purge, + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Collections$Engines$Controls$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - purge( - params: Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Purge, + create( + params: Params$Resource$Projects$Locations$Collections$Engines$Controls$Create, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - purge( - params: Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Purge, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Collections$Engines$Controls$Create, + callback: BodyResponseCallback ): void; - purge( - callback: BodyResponseCallback + create( + callback: BodyResponseCallback ): void; - purge( + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Purge - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Engines$Controls$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Purge; + {}) as Params$Resource$Projects$Locations$Collections$Engines$Controls$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Purge; + {} as Params$Resource$Projects$Locations$Collections$Engines$Controls$Create; options = {}; } @@ -16827,9 +19775,10 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: ( - rootUrl + '/v1alpha/{+parent}/suggestionDenyListEntries:purge' - ).replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1alpha/{+parent}/controls').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'POST', apiVersion: '', }, @@ -16841,103 +19790,73 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } - } - - export interface Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Import - extends StandardParameters { - /** - * Required. The parent data store resource name for which to import denylist entries. Follows pattern projects/x/locations/x/collections/x/dataStores/x. - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesRequest; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Purge - extends StandardParameters { - /** - * Required. The parent data store resource name for which to import denylist entries. Follows pattern projects/x/locations/x/collections/x/dataStores/x. - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaPurgeSuggestionDenyListEntriesRequest; - } - - export class Resource$Projects$Locations$Collections$Datastores$Userevents { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * 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. + * Deletes a Control. If the Control to delete does not exist, a NOT_FOUND error is returned. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - collect( - params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Collect, + delete( + params: Params$Resource$Projects$Locations$Collections$Engines$Controls$Delete, options: StreamMethodOptions ): GaxiosPromise; - collect( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Collect, + delete( + params?: Params$Resource$Projects$Locations$Collections$Engines$Controls$Delete, options?: MethodOptions - ): GaxiosPromise; - collect( - params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Collect, + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Collections$Engines$Controls$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - collect( - params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Collect, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Collections$Engines$Controls$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - collect( - params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Collect, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Collections$Engines$Controls$Delete, + callback: BodyResponseCallback ): void; - collect(callback: BodyResponseCallback): void; - collect( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Collect - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Engines$Controls$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Collect; + {}) as Params$Resource$Projects$Locations$Collections$Engines$Controls$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Collect; + {} as Params$Resource$Projects$Locations$Collections$Engines$Controls$Delete; options = {}; } @@ -16951,90 +19870,87 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/userEvents:collect').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * 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. + * Gets a Control. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - import( - params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Import, + get( + params: Params$Resource$Projects$Locations$Collections$Engines$Controls$Get, options: StreamMethodOptions ): GaxiosPromise; - import( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Import, + get( + params?: Params$Resource$Projects$Locations$Collections$Engines$Controls$Get, options?: MethodOptions - ): GaxiosPromise; - import( - params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Import, + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Collections$Engines$Controls$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - import( - params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Import, + get( + params: Params$Resource$Projects$Locations$Collections$Engines$Controls$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - import( - params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Import, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Collections$Engines$Controls$Get, + callback: BodyResponseCallback ): void; - import( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - import( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Import - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Engines$Controls$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Import; + {}) as Params$Resource$Projects$Locations$Collections$Engines$Controls$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Import; + {} as Params$Resource$Projects$Locations$Collections$Engines$Controls$Get; options = {}; } @@ -17048,90 +19964,89 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/userEvents:import').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * 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. + * Lists all Controls by their parent DataStore. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - purge( - params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Purge, + list( + params: Params$Resource$Projects$Locations$Collections$Engines$Controls$List, options: StreamMethodOptions ): GaxiosPromise; - purge( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Purge, + list( + params?: Params$Resource$Projects$Locations$Collections$Engines$Controls$List, options?: MethodOptions - ): GaxiosPromise; - purge( - params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Purge, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Collections$Engines$Controls$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - purge( - params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Purge, + list( + params: Params$Resource$Projects$Locations$Collections$Engines$Controls$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - purge( - params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Purge, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Collections$Engines$Controls$List, + callback: BodyResponseCallback ): void; - purge( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - purge( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Purge - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Engines$Controls$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Purge; + {}) as Params$Resource$Projects$Locations$Collections$Engines$Controls$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Purge; + {} as Params$Resource$Projects$Locations$Collections$Engines$Controls$List; options = {}; } @@ -17145,11 +20060,11 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/userEvents:purge').replace( + url: (rootUrl + '/v1alpha/{+parent}/controls').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', apiVersion: '', }, options @@ -17160,75 +20075,77 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Writes a single user event. + * Updates a Control. Control action type cannot be changed. If the Control to update does not exist, a NOT_FOUND error is returned. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - write( - params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Write, + patch( + params: Params$Resource$Projects$Locations$Collections$Engines$Controls$Patch, options: StreamMethodOptions ): GaxiosPromise; - write( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Write, + patch( + params?: Params$Resource$Projects$Locations$Collections$Engines$Controls$Patch, options?: MethodOptions - ): GaxiosPromise; - write( - params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Write, + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Collections$Engines$Controls$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - write( - params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Write, + patch( + params: Params$Resource$Projects$Locations$Collections$Engines$Controls$Patch, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - write( - params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Write, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Collections$Engines$Controls$Patch, + callback: BodyResponseCallback ): void; - write( - callback: BodyResponseCallback + patch( + callback: BodyResponseCallback ): void; - write( + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Write - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Engines$Controls$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Write; + {}) as Params$Resource$Projects$Locations$Collections$Engines$Controls$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Write; + {} as Params$Resource$Projects$Locations$Collections$Engines$Controls$Patch; options = {}; } @@ -17242,126 +20159,203 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/userEvents:write').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Collect + export interface Params$Resource$Projects$Locations$Collections$Engines$Controls$Create extends StandardParameters { /** - * The event timestamp in milliseconds. This prevents browser caching of otherwise identical get requests. The name is abbreviated to reduce the payload bytes. + * Required. The ID to use for the Control, which will become the final component of the Control's resource name. This value must be within 1-63 characters. Valid characters are /a-z-_/. */ - ets?: string; + controlId?: string; /** - * Required. The parent DataStore resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}`. + * Required. Full resource name of parent data store. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/dataStores/{data_store_id\}` or `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/engines/{engine_id\}`. */ parent?: string; + /** - * 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 third-party requests. + * Request body metadata */ - uri?: string; + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaControl; + } + export interface Params$Resource$Projects$Locations$Collections$Engines$Controls$Delete + extends StandardParameters { /** - * Required. URL encoded UserEvent proto with a length limit of 2,000,000 characters. + * Required. The resource name of the Control to delete. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/dataStores/{data_store_id\}/controls/{control_id\}` */ - userEvent?: string; + name?: string; } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Import + export interface Params$Resource$Projects$Locations$Collections$Engines$Controls$Get extends StandardParameters { /** - * Required. Parent DataStore resource name, of the form `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}` + * Required. The resource name of the Control to get. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/dataStores/{data_store_id\}/controls/{control_id\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Engines$Controls$List + extends StandardParameters { + /** + * Optional. A filter to apply on the list results. Supported features: * List all the products under the parent branch if filter is unset. Currently this field is unsupported. + */ + filter?: string; + /** + * Optional. Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000. + */ + pageSize?: number; + /** + * Optional. A page token, received from a previous `ListControls` call. Provide this to retrieve the subsequent page. + */ + pageToken?: string; + /** + * Required. The data store resource name. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/dataStores/{data_store_id\}` or `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/engines/{engine_id\}`. */ parent?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Engines$Controls$Patch + extends StandardParameters { + /** + * Immutable. Fully qualified name `projects/x/locations/global/dataStore/x/controls/x` + */ + name?: string; + /** + * Optional. Indicates which fields in the provided Control to update. The following are NOT supported: * Control.name * Control.solution_type If not set or empty, all supported fields are updated. + */ + updateMask?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaImportUserEventsRequest; + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaControl; } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Purge - extends StandardParameters { + + export class Resource$Projects$Locations$Collections$Engines$Conversations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + /** - * Required. The resource name of the catalog under which the events are created. The format is `projects/${projectId\}/locations/global/collections/{$collectionId\}/dataStores/${dataStoreId\}` + * Converses a conversation. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. */ - parent?: string; + converse( + params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Converse, + options: StreamMethodOptions + ): GaxiosPromise; + converse( + params?: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Converse, + options?: MethodOptions + ): GaxiosPromise; + converse( + params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Converse, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + converse( + params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Converse, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + converse( + params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Converse, + callback: BodyResponseCallback + ): void; + converse( + callback: BodyResponseCallback + ): void; + converse( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Collections$Engines$Conversations$Converse + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Collections$Engines$Conversations$Converse; + let options = (optionsOrCallback || {}) as MethodOptions; - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaPurgeUserEventsRequest; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Write - extends StandardParameters { - /** - * Required. The parent resource name. If the write user event action is applied in DataStore level, the format is: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}`. If the write user event action is applied in Location level, for example, the event with Document across multiple DataStore, the format is: `projects/{project\}/locations/{location\}`. - */ - parent?: string; - /** - * If set to true, the user event is written asynchronously after validation, and the API responds without waiting for the write. - */ - writeAsync?: boolean; + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Collections$Engines$Conversations$Converse; + options = {}; + } - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaUserEvent; - } + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } - export class Resource$Projects$Locations$Collections$Engines { - context: APIRequestContext; - controls: Resource$Projects$Locations$Collections$Engines$Controls; - conversations: Resource$Projects$Locations$Collections$Engines$Conversations; - operations: Resource$Projects$Locations$Collections$Engines$Operations; - servingConfigs: Resource$Projects$Locations$Collections$Engines$Servingconfigs; - sessions: Resource$Projects$Locations$Collections$Engines$Sessions; - constructor(context: APIRequestContext) { - this.context = context; - this.controls = - new Resource$Projects$Locations$Collections$Engines$Controls( - this.context - ); - this.conversations = - new Resource$Projects$Locations$Collections$Engines$Conversations( - this.context - ); - this.operations = - new Resource$Projects$Locations$Collections$Engines$Operations( - this.context - ); - this.servingConfigs = - new Resource$Projects$Locations$Collections$Engines$Servingconfigs( - this.context + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}:converse').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback ); - this.sessions = - new Resource$Projects$Locations$Collections$Engines$Sessions( - this.context + } else { + return createAPIRequest( + parameters ); + } } /** - * Creates a Engine. + * Creates a Conversation. If the Conversation to create already exists, an ALREADY_EXISTS error is returned. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -17369,57 +20363,57 @@ export namespace discoveryengine_v1alpha { * @returns A promise if used with async/await, or void if used with a callback. */ create( - params: Params$Resource$Projects$Locations$Collections$Engines$Create, + params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Create, options: StreamMethodOptions ): GaxiosPromise; create( - params?: Params$Resource$Projects$Locations$Collections$Engines$Create, + params?: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Create, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; create( - params: Params$Resource$Projects$Locations$Collections$Engines$Create, + params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; create( - params: Params$Resource$Projects$Locations$Collections$Engines$Create, + params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Create, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; create( - params: Params$Resource$Projects$Locations$Collections$Engines$Create, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Create, + callback: BodyResponseCallback ): void; create( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Engines$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Engines$Conversations$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Engines$Create; + {}) as Params$Resource$Projects$Locations$Collections$Engines$Conversations$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Engines$Create; + {} as Params$Resource$Projects$Locations$Collections$Engines$Conversations$Create; options = {}; } @@ -17433,7 +20427,7 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/engines').replace( + url: (rootUrl + '/v1alpha/{+parent}/conversations').replace( /([^:]\/)\/+/g, '$1' ), @@ -17448,17 +20442,19 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Deletes a Engine. + * Deletes a Conversation. If the Conversation to delete does not exist, a NOT_FOUND error is returned. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -17466,57 +20462,53 @@ export namespace discoveryengine_v1alpha { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Collections$Engines$Delete, + params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Delete, options: StreamMethodOptions ): GaxiosPromise; delete( - params?: Params$Resource$Projects$Locations$Collections$Engines$Delete, + params?: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Delete, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; delete( - params: Params$Resource$Projects$Locations$Collections$Engines$Delete, + params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Collections$Engines$Delete, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Projects$Locations$Collections$Engines$Delete, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; delete( - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Delete, + callback: BodyResponseCallback ): void; + delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Engines$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Engines$Conversations$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Engines$Delete; + {}) as Params$Resource$Projects$Locations$Collections$Engines$Conversations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Engines$Delete; + {} as Params$Resource$Projects$Locations$Collections$Engines$Conversations$Delete; options = {}; } @@ -17542,17 +20534,17 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Gets a Engine. + * Gets a Conversation. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -17560,57 +20552,57 @@ export namespace discoveryengine_v1alpha { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Collections$Engines$Get, + params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Get, options: StreamMethodOptions ): GaxiosPromise; get( - params?: Params$Resource$Projects$Locations$Collections$Engines$Get, + params?: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Get, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; get( - params: Params$Resource$Projects$Locations$Collections$Engines$Get, + params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Collections$Engines$Get, + params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Collections$Engines$Get, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Get, + callback: BodyResponseCallback ): void; get( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Engines$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Engines$Conversations$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Engines$Get; + {}) as Params$Resource$Projects$Locations$Collections$Engines$Conversations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Engines$Get; + {} as Params$Resource$Projects$Locations$Collections$Engines$Conversations$Get; options = {}; } @@ -17636,19 +20628,19 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Lists all the Engines associated with the project. + * Lists all Conversations by their parent DataStore. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -17656,57 +20648,57 @@ export namespace discoveryengine_v1alpha { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Collections$Engines$List, + params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$List, options: StreamMethodOptions ): GaxiosPromise; list( - params?: Params$Resource$Projects$Locations$Collections$Engines$List, + params?: Params$Resource$Projects$Locations$Collections$Engines$Conversations$List, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; list( - params: Params$Resource$Projects$Locations$Collections$Engines$List, + params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Collections$Engines$List, + params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Collections$Engines$List, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$List, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Engines$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Engines$Conversations$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Engines$List; + {}) as Params$Resource$Projects$Locations$Collections$Engines$Conversations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Engines$List; + {} as Params$Resource$Projects$Locations$Collections$Engines$Conversations$List; options = {}; } @@ -17720,7 +20712,7 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/engines').replace( + url: (rootUrl + '/v1alpha/{+parent}/conversations').replace( /([^:]\/)\/+/g, '$1' ), @@ -17735,19 +20727,19 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Updates an Engine + * Updates a Conversation. Conversation action type cannot be changed. If the Conversation to update does not exist, a NOT_FOUND error is returned. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -17755,57 +20747,57 @@ export namespace discoveryengine_v1alpha { * @returns A promise if used with async/await, or void if used with a callback. */ patch( - params: Params$Resource$Projects$Locations$Collections$Engines$Patch, + params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Patch, options: StreamMethodOptions ): GaxiosPromise; patch( - params?: Params$Resource$Projects$Locations$Collections$Engines$Patch, + params?: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Patch, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; patch( - params: Params$Resource$Projects$Locations$Collections$Engines$Patch, + params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; patch( - params: Params$Resource$Projects$Locations$Collections$Engines$Patch, + params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Patch, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; patch( - params: Params$Resource$Projects$Locations$Collections$Engines$Patch, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Patch, + callback: BodyResponseCallback ): void; patch( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Engines$Patch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Engines$Conversations$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Engines$Patch; + {}) as Params$Resource$Projects$Locations$Collections$Engines$Conversations$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Engines$Patch; + {} as Params$Resource$Projects$Locations$Collections$Engines$Conversations$Patch; options = {}; } @@ -17831,77 +20823,162 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } + } + + export interface Params$Resource$Projects$Locations$Collections$Engines$Conversations$Converse + extends StandardParameters { + /** + * Required. The resource name of the Conversation to get. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/{conversation_id\}`. Use `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/-` to activate auto session mode, which automatically creates a new conversation inside a ConverseConversation session. + */ + name?: string; /** - * Pauses the training of an existing engine. Only applicable if SolutionType is SOLUTION_TYPE_RECOMMENDATION. + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaConverseConversationRequest; + } + export interface Params$Resource$Projects$Locations$Collections$Engines$Conversations$Create + extends StandardParameters { + /** + * Required. Full resource name of parent data store. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaConversation; + } + export interface Params$Resource$Projects$Locations$Collections$Engines$Conversations$Delete + extends StandardParameters { + /** + * Required. The resource name of the Conversation to delete. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/{conversation_id\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Engines$Conversations$Get + extends StandardParameters { + /** + * Required. The resource name of the Conversation to get. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/{conversation_id\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Engines$Conversations$List + extends StandardParameters { + /** + * A filter to apply on the list results. The supported features are: user_pseudo_id, state. Example: "user_pseudo_id = some_id" + */ + filter?: string; + /** + * 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` * `conversation_name` Example: "update_time desc" "create_time" + */ + orderBy?: string; + /** + * Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000. + */ + pageSize?: number; + /** + * A page token, received from a previous `ListConversations` call. Provide this to retrieve the subsequent page. + */ + pageToken?: string; + /** + * Required. The data store resource name. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}` + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Engines$Conversations$Patch + extends StandardParameters { + /** + * Immutable. Fully qualified name `projects/{project\}/locations/global/collections/{collection\}/dataStore/x/conversations/x` or `projects/{project\}/locations/global/collections/{collection\}/engines/x/conversations/x`. + */ + name?: string; + /** + * Indicates which fields in the provided Conversation to update. The following are NOT supported: * Conversation.name If not set or empty, all supported fields are updated. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaConversation; + } + + export class Resource$Projects$Locations$Collections$Engines$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * 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. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - pause( - params: Params$Resource$Projects$Locations$Collections$Engines$Pause, + get( + params: Params$Resource$Projects$Locations$Collections$Engines$Operations$Get, options: StreamMethodOptions ): GaxiosPromise; - pause( - params?: Params$Resource$Projects$Locations$Collections$Engines$Pause, + get( + params?: Params$Resource$Projects$Locations$Collections$Engines$Operations$Get, options?: MethodOptions - ): GaxiosPromise; - pause( - params: Params$Resource$Projects$Locations$Collections$Engines$Pause, + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Collections$Engines$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - pause( - params: Params$Resource$Projects$Locations$Collections$Engines$Pause, + get( + params: Params$Resource$Projects$Locations$Collections$Engines$Operations$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - pause( - params: Params$Resource$Projects$Locations$Collections$Engines$Pause, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Collections$Engines$Operations$Get, + callback: BodyResponseCallback ): void; - pause( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - pause( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Engines$Pause - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Engines$Operations$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Engines$Pause; + {}) as Params$Resource$Projects$Locations$Collections$Engines$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Engines$Pause; + {} as Params$Resource$Projects$Locations$Collections$Engines$Operations$Get; options = {}; } @@ -17915,11 +20992,8 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}:pause').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options @@ -17930,77 +21004,75 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Resumes the training of an existing engine. Only applicable if SolutionType is SOLUTION_TYPE_RECOMMENDATION. + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - resume( - params: Params$Resource$Projects$Locations$Collections$Engines$Resume, + list( + params: Params$Resource$Projects$Locations$Collections$Engines$Operations$List, options: StreamMethodOptions ): GaxiosPromise; - resume( - params?: Params$Resource$Projects$Locations$Collections$Engines$Resume, + list( + params?: Params$Resource$Projects$Locations$Collections$Engines$Operations$List, options?: MethodOptions - ): GaxiosPromise; - resume( - params: Params$Resource$Projects$Locations$Collections$Engines$Resume, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Collections$Engines$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - resume( - params: Params$Resource$Projects$Locations$Collections$Engines$Resume, + list( + params: Params$Resource$Projects$Locations$Collections$Engines$Operations$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - resume( - params: Params$Resource$Projects$Locations$Collections$Engines$Resume, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Collections$Engines$Operations$List, + callback: BodyResponseCallback ): void; - resume( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - resume( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Engines$Resume - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Engines$Operations$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Engines$Resume; + {}) as Params$Resource$Projects$Locations$Collections$Engines$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Engines$Resume; + {} as Params$Resource$Projects$Locations$Collections$Engines$Operations$List; options = {}; } @@ -18014,11 +21086,11 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}:resume').replace( + url: (rootUrl + '/v1alpha/{+name}/operations').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', apiVersion: '', }, options @@ -18029,77 +21101,111 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } + } + + export interface Params$Resource$Projects$Locations$Collections$Engines$Operations$Get + extends StandardParameters { + /** + * The name of the operation resource. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Engines$Operations$List + extends StandardParameters { + /** + * The standard list filter. + */ + filter?: string; + /** + * The name of the operation's parent resource. + */ + name?: string; + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. + */ + pageToken?: string; + } + + export class Resource$Projects$Locations$Collections$Engines$Servingconfigs { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } /** - * Tunes an existing engine. Only applicable if SolutionType is SOLUTION_TYPE_RECOMMENDATION. + * Answer query method. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - tune( - params: Params$Resource$Projects$Locations$Collections$Engines$Tune, + answer( + params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Answer, options: StreamMethodOptions ): GaxiosPromise; - tune( - params?: Params$Resource$Projects$Locations$Collections$Engines$Tune, + answer( + params?: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Answer, options?: MethodOptions - ): GaxiosPromise; - tune( - params: Params$Resource$Projects$Locations$Collections$Engines$Tune, + ): GaxiosPromise; + answer( + params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Answer, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - tune( - params: Params$Resource$Projects$Locations$Collections$Engines$Tune, + answer( + params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Answer, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - tune( - params: Params$Resource$Projects$Locations$Collections$Engines$Tune, - callback: BodyResponseCallback + answer( + params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Answer, + callback: BodyResponseCallback ): void; - tune( - callback: BodyResponseCallback + answer( + callback: BodyResponseCallback ): void; - tune( + answer( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Engines$Tune - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Answer + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Engines$Tune; + {}) as Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Answer; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Engines$Tune; + {} as Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Answer; options = {}; } @@ -18113,7 +21219,7 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}:tune').replace( + url: (rootUrl + '/v1alpha/{+servingConfig}:answer').replace( /([^:]\/)\/+/g, '$1' ), @@ -18123,189 +21229,82 @@ export namespace discoveryengine_v1alpha { options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['servingConfig'], + pathParams: ['servingConfig'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } - } - - export interface Params$Resource$Projects$Locations$Collections$Engines$Create - extends StandardParameters { - /** - * Required. The ID to use for the Engine, which will become the final component of the Engine's resource name. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned. - */ - engineId?: string; - /** - * Required. The parent resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}`. - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaEngine; - } - export interface Params$Resource$Projects$Locations$Collections$Engines$Delete - extends StandardParameters { - /** - * Required. Full resource name of Engine, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}`. If the caller does not have permission to delete the Engine, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the Engine to delete does not exist, a NOT_FOUND error is returned. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Collections$Engines$Get - extends StandardParameters { - /** - * Required. Full resource name of Engine, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}`. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Collections$Engines$List - extends StandardParameters { - /** - * Optional. Filter by solution type. For example: solution_type=SOLUTION_TYPE_SEARCH - */ - filter?: string; - /** - * Optional. Not supported. - */ - pageSize?: number; - /** - * Optional. Not supported. - */ - pageToken?: string; - /** - * Required. The parent resource name, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}`. - */ - parent?: string; - } - export interface Params$Resource$Projects$Locations$Collections$Engines$Patch - extends StandardParameters { - /** - * 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_number\}/locations/{location\}/collections/{collection\}/engines/{engine\}` engine should be 1-63 characters, and valid characters are /a-z0-9x/. Otherwise, an INVALID_ARGUMENT error is returned. - */ - name?: string; - /** - * Indicates which fields in the provided Engine to update. If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned. - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaEngine; - } - export interface Params$Resource$Projects$Locations$Collections$Engines$Pause - extends StandardParameters { - /** - * Required. The name of the engine to pause. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/engines/{engine_id\}` - */ - name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaPauseEngineRequest; - } - export interface Params$Resource$Projects$Locations$Collections$Engines$Resume - extends StandardParameters { - /** - * Required. The name of the engine to resume. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/engines/{engine_id\}` - */ - name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaResumeEngineRequest; - } - export interface Params$Resource$Projects$Locations$Collections$Engines$Tune - extends StandardParameters { - /** - * Required. The resource name of the engine to tune. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/engines/{engine_id\}` - */ - name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaTuneEngineRequest; - } - - export class Resource$Projects$Locations$Collections$Engines$Controls { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * 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. + * Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not exist. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - create( - params: Params$Resource$Projects$Locations$Collections$Engines$Controls$Create, + get( + params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get, options: StreamMethodOptions ): GaxiosPromise; - create( - params?: Params$Resource$Projects$Locations$Collections$Engines$Controls$Create, + get( + params?: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get, options?: MethodOptions - ): GaxiosPromise; - create( - params: Params$Resource$Projects$Locations$Collections$Engines$Controls$Create, + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Collections$Engines$Controls$Create, + get( + params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Collections$Engines$Controls$Create, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get, + callback: BodyResponseCallback ): void; - create( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - create( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Engines$Controls$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Engines$Controls$Create; + {}) as Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Engines$Controls$Create; + {} as Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get; options = {}; } @@ -18319,88 +21318,89 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/controls').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Deletes a Control. If the Control to delete does not exist, a NOT_FOUND error is returned. + * Lists all ServingConfigs linked to this dataStore. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - delete( - params: Params$Resource$Projects$Locations$Collections$Engines$Controls$Delete, + list( + params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$List, options: StreamMethodOptions ): GaxiosPromise; - delete( - params?: Params$Resource$Projects$Locations$Collections$Engines$Controls$Delete, + list( + params?: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$List, options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Projects$Locations$Collections$Engines$Controls$Delete, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Collections$Engines$Controls$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Collections$Engines$Controls$Delete, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$List, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + list( + callback: BodyResponseCallback + ): void; + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Engines$Controls$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Engines$Controls$Delete; + {}) as Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Engines$Controls$Delete; + {} as Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$List; options = {}; } @@ -18414,87 +21414,92 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1alpha/{+parent}/servingConfigs').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Gets a Control. + * Updates a ServingConfig. Returns a NOT_FOUND error if the ServingConfig does not exist. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Collections$Engines$Controls$Get, + patch( + params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Patch, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Collections$Engines$Controls$Get, + patch( + params?: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Patch, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Collections$Engines$Controls$Get, + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Collections$Engines$Controls$Get, + patch( + params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Patch, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Collections$Engines$Controls$Get, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Patch, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + patch( + callback: BodyResponseCallback ): void; - get( + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Engines$Controls$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Engines$Controls$Get; + {}) as Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Engines$Controls$Get; + {} as Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Patch; options = {}; } @@ -18509,7 +21514,7 @@ export namespace discoveryengine_v1alpha { options: Object.assign( { url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'PATCH', apiVersion: '', }, options @@ -18520,77 +21525,77 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Lists all Controls by their parent DataStore. + * Makes a recommendation, which requires a contextual user event. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Collections$Engines$Controls$List, + recommend( + params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Recommend, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Collections$Engines$Controls$List, + recommend( + params?: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Recommend, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Collections$Engines$Controls$List, + ): GaxiosPromise; + recommend( + params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Recommend, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Collections$Engines$Controls$List, + recommend( + params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Recommend, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Collections$Engines$Controls$List, - callback: BodyResponseCallback + recommend( + params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Recommend, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + recommend( + callback: BodyResponseCallback ): void; - list( + recommend( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Engines$Controls$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Recommend + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Engines$Controls$List; + {}) as Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Recommend; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Engines$Controls$List; + {} as Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Recommend; options = {}; } @@ -18604,92 +21609,92 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/controls').replace( + url: (rootUrl + '/v1alpha/{+servingConfig}:recommend').replace( /([^:]\/)\/+/g, '$1' ), - method: 'GET', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['servingConfig'], + pathParams: ['servingConfig'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Updates a Control. Control action type cannot be changed. If the Control to update does not exist, a NOT_FOUND error is returned. + * Performs a search. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - patch( - params: Params$Resource$Projects$Locations$Collections$Engines$Controls$Patch, + search( + params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Search, options: StreamMethodOptions ): GaxiosPromise; - patch( - params?: Params$Resource$Projects$Locations$Collections$Engines$Controls$Patch, + search( + params?: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Search, options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Projects$Locations$Collections$Engines$Controls$Patch, + ): GaxiosPromise; + search( + params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Search, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Collections$Engines$Controls$Patch, + search( + params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Search, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Collections$Engines$Controls$Patch, - callback: BodyResponseCallback + search( + params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Search, + callback: BodyResponseCallback ): void; - patch( - callback: BodyResponseCallback + search( + callback: BodyResponseCallback ): void; - patch( + search( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Engines$Controls$Patch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Search + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Engines$Controls$Patch; + {}) as Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Search; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Engines$Controls$Patch; + {} as Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Search; options = {}; } @@ -18703,162 +21708,179 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + url: (rootUrl + '/v1alpha/{+servingConfig}:search').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['servingConfig'], + pathParams: ['servingConfig'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } } - export interface Params$Resource$Projects$Locations$Collections$Engines$Controls$Create + export interface Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Answer extends StandardParameters { /** - * Required. The ID to use for the Control, which will become the final component of the Control's resource name. This value must be within 1-63 characters. Valid characters are /a-z-_/. - */ - controlId?: string; - /** - * Required. Full resource name of parent data store. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/dataStores/{data_store_id\}` or `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/engines/{engine_id\}`. + * Required. The resource name of the Search serving config, such as `projects/x/locations/global/collections/default_collection/engines/x/servingConfigs/default_serving_config`, or `projects/x/locations/global/collections/default_collection/dataStores/x/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. */ - parent?: string; + servingConfig?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaControl; - } - export interface Params$Resource$Projects$Locations$Collections$Engines$Controls$Delete - extends StandardParameters { - /** - * Required. The resource name of the Control to delete. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/dataStores/{data_store_id\}/controls/{control_id\}` - */ - name?: string; + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaAnswerQueryRequest; } - export interface Params$Resource$Projects$Locations$Collections$Engines$Controls$Get + export interface Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get extends StandardParameters { /** - * Required. The resource name of the Control to get. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/dataStores/{data_store_id\}/controls/{control_id\}` + * Required. The resource name of the ServingConfig to get. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/engines/{engine\}/servingConfigs/{serving_config_id\}` */ name?: string; } - export interface Params$Resource$Projects$Locations$Collections$Engines$Controls$List + export interface Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$List extends StandardParameters { /** - * Optional. A filter to apply on the list results. Supported features: * List all the products under the parent branch if filter is unset. Currently this field is unsupported. - */ - filter?: string; - /** - * Optional. Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000. + * Optional. Maximum number of results to return. If unspecified, defaults to 100. If a value greater than 100 is provided, at most 100 results are returned. */ pageSize?: number; /** - * Optional. A page token, received from a previous `ListControls` call. Provide this to retrieve the subsequent page. + * Optional. A page token, received from a previous `ListServingConfigs` call. Provide this to retrieve the subsequent page. */ pageToken?: string; /** - * Required. The data store resource name. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/dataStores/{data_store_id\}` or `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/engines/{engine_id\}`. + * Required. Full resource name of the parent resource. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/engines/{engine\}` */ parent?: string; } - export interface Params$Resource$Projects$Locations$Collections$Engines$Controls$Patch + export interface Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Patch extends StandardParameters { /** - * Immutable. Fully qualified name `projects/x/locations/global/dataStore/x/controls/x` + * Immutable. Fully qualified name `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}/servingConfigs/{serving_config_id\}` */ name?: string; /** - * Optional. Indicates which fields in the provided Control to update. The following are NOT supported: * Control.name * Control.solution_type If not set or empty, all supported fields are updated. + * Indicates which fields in the provided ServingConfig to update. The following are NOT supported: * ServingConfig.name If not set, all supported fields are updated. */ updateMask?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaControl; + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaServingConfig; } + export interface Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Recommend + extends StandardParameters { + /** + * Required. Full resource name of a ServingConfig: `projects/x/locations/global/collections/x/engines/x/servingConfigs/x`, or `projects/x/locations/global/collections/x/dataStores/x/servingConfigs/x` One default serving config is created along with your recommendation engine creation. The engine ID is used as the ID of the default serving config. For example, for Engine `projects/x/locations/global/collections/x/engines/my-engine`, you can use `projects/x/locations/global/collections/x/engines/my-engine/servingConfigs/my-engine` for your RecommendationService.Recommend requests. + */ + servingConfig?: string; - export class Resource$Projects$Locations$Collections$Engines$Conversations { + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaRecommendRequest; + } + export interface Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Search + extends StandardParameters { + /** + * Required. The resource name of the Search serving config, such as `projects/x/locations/global/collections/default_collection/engines/x/servingConfigs/default_serving_config`, or `projects/x/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. + */ + servingConfig?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequest; + } + + export class Resource$Projects$Locations$Collections$Engines$Sessions { context: APIRequestContext; + answers: Resource$Projects$Locations$Collections$Engines$Sessions$Answers; constructor(context: APIRequestContext) { this.context = context; + this.answers = + new Resource$Projects$Locations$Collections$Engines$Sessions$Answers( + this.context + ); } /** - * Converses a conversation. + * Creates a Session. If the Session to create already exists, an ALREADY_EXISTS error is returned. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - converse( - params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Converse, + create( + params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Create, options: StreamMethodOptions ): GaxiosPromise; - converse( - params?: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Converse, + create( + params?: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Create, options?: MethodOptions - ): GaxiosPromise; - converse( - params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Converse, + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - converse( - params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Converse, + create( + params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Create, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - converse( - params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Converse, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Create, + callback: BodyResponseCallback ): void; - converse( - callback: BodyResponseCallback + create( + callback: BodyResponseCallback ): void; - converse( + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Engines$Conversations$Converse - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Engines$Sessions$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Engines$Conversations$Converse; + {}) as Params$Resource$Projects$Locations$Collections$Engines$Sessions$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Engines$Conversations$Converse; + {} as Params$Resource$Projects$Locations$Collections$Engines$Sessions$Create; options = {}; } @@ -18872,7 +21894,7 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}:converse').replace( + url: (rootUrl + '/v1alpha/{+parent}/sessions').replace( /([^:]\/)\/+/g, '$1' ), @@ -18882,82 +21904,78 @@ export namespace discoveryengine_v1alpha { options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Creates a Conversation. If the Conversation to create already exists, an ALREADY_EXISTS error is returned. + * Deletes a Session. If the Session to delete does not exist, a NOT_FOUND error is returned. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - create( - params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Create, + delete( + params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Delete, options: StreamMethodOptions ): GaxiosPromise; - create( - params?: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Create, + delete( + params?: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Delete, options?: MethodOptions - ): GaxiosPromise; - create( - params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Create, + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Create, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - create( - params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Create, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Delete, + callback: BodyResponseCallback ): void; - create( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Engines$Conversations$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Engines$Sessions$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Engines$Conversations$Create; + {}) as Params$Resource$Projects$Locations$Collections$Engines$Sessions$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Engines$Conversations$Create; + {} as Params$Resource$Projects$Locations$Collections$Engines$Sessions$Delete; options = {}; } @@ -18971,88 +21989,87 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/conversations').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Deletes a Conversation. If the Conversation to delete does not exist, a NOT_FOUND error is returned. + * Gets a Session. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - delete( - params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Delete, + get( + params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Get, options: StreamMethodOptions ): GaxiosPromise; - delete( - params?: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Delete, + get( + params?: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Get, options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Delete, + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Delete, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Get, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + get( + callback: BodyResponseCallback + ): void; + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Engines$Conversations$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Engines$Sessions$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Engines$Conversations$Delete; + {}) as Params$Resource$Projects$Locations$Collections$Engines$Sessions$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Engines$Conversations$Delete; + {} as Params$Resource$Projects$Locations$Collections$Engines$Sessions$Get; options = {}; } @@ -19067,7 +22084,7 @@ export namespace discoveryengine_v1alpha { options: Object.assign( { url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + method: 'GET', apiVersion: '', }, options @@ -19078,75 +22095,77 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Gets a Conversation. + * Lists all Sessions by their parent DataStore. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Get, + list( + params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$List, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Get, + list( + params?: Params$Resource$Projects$Locations$Collections$Engines$Sessions$List, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Get, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Get, + list( + params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Get, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$List, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - get( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Engines$Conversations$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Engines$Sessions$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Engines$Conversations$Get; + {}) as Params$Resource$Projects$Locations$Collections$Engines$Sessions$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Engines$Conversations$Get; + {} as Params$Resource$Projects$Locations$Collections$Engines$Sessions$List; options = {}; } @@ -19160,89 +22179,92 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1alpha/{+parent}/sessions').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Lists all Conversations by their parent DataStore. + * Updates a Session. Session action type cannot be changed. If the Session to update does not exist, a NOT_FOUND error is returned. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$List, + patch( + params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Patch, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Collections$Engines$Conversations$List, + patch( + params?: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Patch, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$List, + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$List, + patch( + params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Patch, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$List, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Patch, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + patch( + callback: BodyResponseCallback ): void; - list( + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Engines$Conversations$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Engines$Sessions$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Engines$Conversations$List; + {}) as Params$Resource$Projects$Locations$Collections$Engines$Sessions$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Engines$Conversations$List; + {} as Params$Resource$Projects$Locations$Collections$Engines$Sessions$Patch; options = {}; } @@ -19256,92 +22278,162 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/conversations').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } + } + export interface Params$Resource$Projects$Locations$Collections$Engines$Sessions$Create + extends StandardParameters { /** - * Updates a Conversation. Conversation action type cannot be changed. If the Conversation to update does not exist, a NOT_FOUND error is returned. + * Required. Full resource name of parent data store. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaSession; + } + export interface Params$Resource$Projects$Locations$Collections$Engines$Sessions$Delete + extends StandardParameters { + /** + * Required. The resource name of the Session to delete. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/sessions/{session_id\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Engines$Sessions$Get + extends StandardParameters { + /** + * Required. The resource name of the Session to get. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/sessions/{session_id\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Engines$Sessions$List + extends StandardParameters { + /** + * A filter to apply on the list results. The supported features are: user_pseudo_id, state. Example: "user_pseudo_id = some_id" + */ + filter?: string; + /** + * 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` Example: "update_time desc" "create_time" + */ + orderBy?: string; + /** + * Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000. + */ + pageSize?: number; + /** + * A page token, received from a previous `ListSessions` call. Provide this to retrieve the subsequent page. + */ + pageToken?: string; + /** + * Required. The data store resource name. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}` + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Engines$Sessions$Patch + extends StandardParameters { + /** + * Immutable. Fully qualified name `projects/{project\}/locations/global/collections/{collection\}/engines/{engine\}/sessions/x` + */ + name?: string; + /** + * 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. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaSession; + } + + export class Resource$Projects$Locations$Collections$Engines$Sessions$Answers { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Gets a Answer. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - patch( - params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Patch, + get( + params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Answers$Get, options: StreamMethodOptions ): GaxiosPromise; - patch( - params?: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Patch, + get( + params?: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Answers$Get, options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Patch, + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Answers$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Patch, + get( + params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Answers$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Patch, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Answers$Get, + callback: BodyResponseCallback ): void; - patch( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - patch( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Engines$Conversations$Patch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Engines$Sessions$Answers$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Engines$Conversations$Patch; + {}) as Params$Resource$Projects$Locations$Collections$Engines$Sessions$Answers$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Engines$Conversations$Patch; + {} as Params$Resource$Projects$Locations$Collections$Engines$Sessions$Answers$Get; options = {}; } @@ -19356,7 +22448,7 @@ export namespace discoveryengine_v1alpha { options: Object.assign( { url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + method: 'GET', apiVersion: '', }, options @@ -19367,97 +22459,27 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } } - export interface Params$Resource$Projects$Locations$Collections$Engines$Conversations$Converse - extends StandardParameters { - /** - * Required. The resource name of the Conversation to get. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/{conversation_id\}`. Use `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/-` to activate auto session mode, which automatically creates a new conversation inside a ConverseConversation session. - */ - name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaConverseConversationRequest; - } - export interface Params$Resource$Projects$Locations$Collections$Engines$Conversations$Create - extends StandardParameters { - /** - * Required. Full resource name of parent data store. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}` - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaConversation; - } - export interface Params$Resource$Projects$Locations$Collections$Engines$Conversations$Delete - extends StandardParameters { - /** - * Required. The resource name of the Conversation to delete. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/{conversation_id\}` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Collections$Engines$Conversations$Get - extends StandardParameters { - /** - * Required. The resource name of the Conversation to get. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/{conversation_id\}` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Collections$Engines$Conversations$List - extends StandardParameters { - /** - * A filter to apply on the list results. The supported features are: user_pseudo_id, state. Example: "user_pseudo_id = some_id" - */ - filter?: string; - /** - * 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` * `conversation_name` Example: "update_time desc" "create_time" - */ - orderBy?: string; - /** - * Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000. - */ - pageSize?: number; - /** - * A page token, received from a previous `ListConversations` call. Provide this to retrieve the subsequent page. - */ - pageToken?: string; - /** - * Required. The data store resource name. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}` - */ - parent?: string; - } - export interface Params$Resource$Projects$Locations$Collections$Engines$Conversations$Patch + export interface Params$Resource$Projects$Locations$Collections$Engines$Sessions$Answers$Get extends StandardParameters { /** - * Immutable. Fully qualified name `projects/{project\}/locations/global/collections/{collection\}/dataStore/x/conversations/x` or `projects/{project\}/locations/global/collections/{collection\}/engines/x/conversations/x`. + * Required. The resource name of the Answer to get. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/engines/{engine_id\}/sessions/{session_id\}/answers/{answer_id\}` */ name?: string; - /** - * Indicates which fields in the provided Conversation to update. The following are NOT supported: * Conversation.name If not set or empty, all supported fields are updated. - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaConversation; } - export class Resource$Projects$Locations$Collections$Engines$Operations { + export class Resource$Projects$Locations$Collections$Operations { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; @@ -19472,27 +22494,27 @@ export namespace discoveryengine_v1alpha { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Collections$Engines$Operations$Get, + params: Params$Resource$Projects$Locations$Collections$Operations$Get, options: StreamMethodOptions ): GaxiosPromise; get( - params?: Params$Resource$Projects$Locations$Collections$Engines$Operations$Get, + params?: Params$Resource$Projects$Locations$Collections$Operations$Get, options?: MethodOptions ): GaxiosPromise; get( - params: Params$Resource$Projects$Locations$Collections$Engines$Operations$Get, + params: Params$Resource$Projects$Locations$Collections$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Collections$Engines$Operations$Get, + params: Params$Resource$Projects$Locations$Collections$Operations$Get, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Collections$Engines$Operations$Get, + params: Params$Resource$Projects$Locations$Collections$Operations$Get, callback: BodyResponseCallback ): void; get( @@ -19500,7 +22522,7 @@ export namespace discoveryengine_v1alpha { ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Engines$Operations$Get + | Params$Resource$Projects$Locations$Collections$Operations$Get | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -19516,13 +22538,13 @@ export namespace discoveryengine_v1alpha { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Engines$Operations$Get; + {}) as Params$Resource$Projects$Locations$Collections$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Engines$Operations$Get; + {} as Params$Resource$Projects$Locations$Collections$Operations$Get; options = {}; } @@ -19566,27 +22588,27 @@ export namespace discoveryengine_v1alpha { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Collections$Engines$Operations$List, + params: Params$Resource$Projects$Locations$Collections$Operations$List, options: StreamMethodOptions ): GaxiosPromise; list( - params?: Params$Resource$Projects$Locations$Collections$Engines$Operations$List, + params?: Params$Resource$Projects$Locations$Collections$Operations$List, options?: MethodOptions ): GaxiosPromise; list( - params: Params$Resource$Projects$Locations$Collections$Engines$Operations$List, + params: Params$Resource$Projects$Locations$Collections$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Collections$Engines$Operations$List, + params: Params$Resource$Projects$Locations$Collections$Operations$List, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Collections$Engines$Operations$List, + params: Params$Resource$Projects$Locations$Collections$Operations$List, callback: BodyResponseCallback ): void; list( @@ -19594,7 +22616,7 @@ export namespace discoveryengine_v1alpha { ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Engines$Operations$List + | Params$Resource$Projects$Locations$Collections$Operations$List | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -19610,13 +22632,13 @@ export namespace discoveryengine_v1alpha { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Engines$Operations$List; + {}) as Params$Resource$Projects$Locations$Collections$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Engines$Operations$List; + {} as Params$Resource$Projects$Locations$Collections$Operations$List; options = {}; } @@ -19657,14 +22679,14 @@ export namespace discoveryengine_v1alpha { } } - export interface Params$Resource$Projects$Locations$Collections$Engines$Operations$Get + export interface Params$Resource$Projects$Locations$Collections$Operations$Get extends StandardParameters { /** * The name of the operation resource. */ name?: string; } - export interface Params$Resource$Projects$Locations$Collections$Engines$Operations$List + export interface Params$Resource$Projects$Locations$Collections$Operations$List extends StandardParameters { /** * The standard list filter. @@ -19684,72 +22706,219 @@ export namespace discoveryengine_v1alpha { pageToken?: string; } - export class Resource$Projects$Locations$Collections$Engines$Servingconfigs { + export class Resource$Projects$Locations$Datastores { context: APIRequestContext; + branches: Resource$Projects$Locations$Datastores$Branches; + completionSuggestions: Resource$Projects$Locations$Datastores$Completionsuggestions; + controls: Resource$Projects$Locations$Datastores$Controls; + conversations: Resource$Projects$Locations$Datastores$Conversations; + models: Resource$Projects$Locations$Datastores$Models; + operations: Resource$Projects$Locations$Datastores$Operations; + schemas: Resource$Projects$Locations$Datastores$Schemas; + servingConfigs: Resource$Projects$Locations$Datastores$Servingconfigs; + sessions: Resource$Projects$Locations$Datastores$Sessions; + siteSearchEngine: Resource$Projects$Locations$Datastores$Sitesearchengine; + suggestionDenyListEntries: Resource$Projects$Locations$Datastores$Suggestiondenylistentries; + userEvents: Resource$Projects$Locations$Datastores$Userevents; constructor(context: APIRequestContext) { this.context = context; + this.branches = new Resource$Projects$Locations$Datastores$Branches( + this.context + ); + this.completionSuggestions = + new Resource$Projects$Locations$Datastores$Completionsuggestions( + this.context + ); + this.controls = new Resource$Projects$Locations$Datastores$Controls( + this.context + ); + this.conversations = + new Resource$Projects$Locations$Datastores$Conversations(this.context); + this.models = new Resource$Projects$Locations$Datastores$Models( + this.context + ); + this.operations = new Resource$Projects$Locations$Datastores$Operations( + this.context + ); + this.schemas = new Resource$Projects$Locations$Datastores$Schemas( + this.context + ); + this.servingConfigs = + new Resource$Projects$Locations$Datastores$Servingconfigs(this.context); + this.sessions = new Resource$Projects$Locations$Datastores$Sessions( + this.context + ); + this.siteSearchEngine = + new Resource$Projects$Locations$Datastores$Sitesearchengine( + this.context + ); + this.suggestionDenyListEntries = + new Resource$Projects$Locations$Datastores$Suggestiondenylistentries( + this.context + ); + this.userEvents = new Resource$Projects$Locations$Datastores$Userevents( + this.context + ); + } + + /** + * Completes the specified user input with keyword suggestions. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + completeQuery( + params: Params$Resource$Projects$Locations$Datastores$Completequery, + options: StreamMethodOptions + ): GaxiosPromise; + completeQuery( + params?: Params$Resource$Projects$Locations$Datastores$Completequery, + options?: MethodOptions + ): GaxiosPromise; + completeQuery( + params: Params$Resource$Projects$Locations$Datastores$Completequery, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + completeQuery( + params: Params$Resource$Projects$Locations$Datastores$Completequery, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + completeQuery( + params: Params$Resource$Projects$Locations$Datastores$Completequery, + callback: BodyResponseCallback + ): void; + completeQuery( + callback: BodyResponseCallback + ): void; + completeQuery( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Datastores$Completequery + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Datastores$Completequery; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Datastores$Completequery; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+dataStore}:completeQuery').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['dataStore'], + pathParams: ['dataStore'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } } /** - * Answer query method. + * 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. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - answer( - params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Answer, + create( + params: Params$Resource$Projects$Locations$Datastores$Create, options: StreamMethodOptions ): GaxiosPromise; - answer( - params?: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Answer, + create( + params?: Params$Resource$Projects$Locations$Datastores$Create, options?: MethodOptions - ): GaxiosPromise; - answer( - params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Answer, + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Datastores$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - answer( - params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Answer, + create( + params: Params$Resource$Projects$Locations$Datastores$Create, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - answer( - params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Answer, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Datastores$Create, + callback: BodyResponseCallback ): void; - answer( - callback: BodyResponseCallback + create( + callback: BodyResponseCallback ): void; - answer( + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Answer - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Answer; + {}) as Params$Resource$Projects$Locations$Datastores$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Answer; + params = {} as Params$Resource$Projects$Locations$Datastores$Create; options = {}; } @@ -19763,7 +22932,7 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+servingConfig}:answer').replace( + url: (rootUrl + '/v1alpha/{+parent}/dataStores').replace( /([^:]\/)\/+/g, '$1' ), @@ -19773,82 +22942,79 @@ export namespace discoveryengine_v1alpha { options ), params, - requiredParams: ['servingConfig'], - pathParams: ['servingConfig'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not exist. + * Deletes a DataStore. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get, + delete( + params: Params$Resource$Projects$Locations$Datastores$Delete, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get, + delete( + params?: Params$Resource$Projects$Locations$Datastores$Delete, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get, + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Datastores$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get, + delete( + params: Params$Resource$Projects$Locations$Datastores$Delete, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Datastores$Delete, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + delete( + callback: BodyResponseCallback ): void; - get( + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get; + {}) as Params$Resource$Projects$Locations$Datastores$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get; + params = {} as Params$Resource$Projects$Locations$Datastores$Delete; options = {}; } @@ -19863,7 +23029,7 @@ export namespace discoveryengine_v1alpha { options: Object.assign( { url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'DELETE', apiVersion: '', }, options @@ -19874,77 +23040,74 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Lists all ServingConfigs linked to this dataStore. + * Gets a DataStore. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$List, + get( + params: Params$Resource$Projects$Locations$Datastores$Get, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$List, + get( + params?: Params$Resource$Projects$Locations$Datastores$Get, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$List, + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Datastores$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$List, + get( + params: Params$Resource$Projects$Locations$Datastores$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$List, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Datastores$Get, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - list( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$List; + {}) as Params$Resource$Projects$Locations$Datastores$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$List; + params = {} as Params$Resource$Projects$Locations$Datastores$Get; options = {}; } @@ -19958,92 +23121,89 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/servingConfigs').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Updates a ServingConfig. Returns a NOT_FOUND error if the ServingConfig does not exist. + * Gets a DocumentProcessingConfig. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - patch( - params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Patch, + getDocumentProcessingConfig( + params: Params$Resource$Projects$Locations$Datastores$Getdocumentprocessingconfig, options: StreamMethodOptions ): GaxiosPromise; - patch( - params?: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Patch, + getDocumentProcessingConfig( + params?: Params$Resource$Projects$Locations$Datastores$Getdocumentprocessingconfig, options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Patch, + ): GaxiosPromise; + getDocumentProcessingConfig( + params: Params$Resource$Projects$Locations$Datastores$Getdocumentprocessingconfig, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Patch, + getDocumentProcessingConfig( + params: Params$Resource$Projects$Locations$Datastores$Getdocumentprocessingconfig, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Patch, - callback: BodyResponseCallback + getDocumentProcessingConfig( + params: Params$Resource$Projects$Locations$Datastores$Getdocumentprocessingconfig, + callback: BodyResponseCallback ): void; - patch( - callback: BodyResponseCallback + getDocumentProcessingConfig( + callback: BodyResponseCallback ): void; - patch( + getDocumentProcessingConfig( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Patch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Getdocumentprocessingconfig + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Patch; + {}) as Params$Resource$Projects$Locations$Datastores$Getdocumentprocessingconfig; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Patch; + {} as Params$Resource$Projects$Locations$Datastores$Getdocumentprocessingconfig; options = {}; } @@ -20058,7 +23218,7 @@ export namespace discoveryengine_v1alpha { options: Object.assign( { url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + method: 'GET', apiVersion: '', }, options @@ -20069,77 +23229,77 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Makes a recommendation, which requires a contextual user event. + * Gets the SiteSearchEngine. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - recommend( - params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Recommend, + getSiteSearchEngine( + params: Params$Resource$Projects$Locations$Datastores$Getsitesearchengine, options: StreamMethodOptions ): GaxiosPromise; - recommend( - params?: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Recommend, + getSiteSearchEngine( + params?: Params$Resource$Projects$Locations$Datastores$Getsitesearchengine, options?: MethodOptions - ): GaxiosPromise; - recommend( - params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Recommend, + ): GaxiosPromise; + getSiteSearchEngine( + params: Params$Resource$Projects$Locations$Datastores$Getsitesearchengine, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - recommend( - params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Recommend, + getSiteSearchEngine( + params: Params$Resource$Projects$Locations$Datastores$Getsitesearchengine, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - recommend( - params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Recommend, - callback: BodyResponseCallback + getSiteSearchEngine( + params: Params$Resource$Projects$Locations$Datastores$Getsitesearchengine, + callback: BodyResponseCallback ): void; - recommend( - callback: BodyResponseCallback + getSiteSearchEngine( + callback: BodyResponseCallback ): void; - recommend( + getSiteSearchEngine( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Recommend - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Getsitesearchengine + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Recommend; + {}) as Params$Resource$Projects$Locations$Datastores$Getsitesearchengine; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Recommend; + {} as Params$Resource$Projects$Locations$Datastores$Getsitesearchengine; options = {}; } @@ -20153,92 +23313,88 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+servingConfig}:recommend').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['servingConfig'], - pathParams: ['servingConfig'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Performs a search. + * Lists all the DataStores associated with the project. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - search( - params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Search, + list( + params: Params$Resource$Projects$Locations$Datastores$List, options: StreamMethodOptions ): GaxiosPromise; - search( - params?: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Search, + list( + params?: Params$Resource$Projects$Locations$Datastores$List, options?: MethodOptions - ): GaxiosPromise; - search( - params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Search, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Datastores$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - search( - params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Search, + list( + params: Params$Resource$Projects$Locations$Datastores$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - search( - params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Search, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Datastores$List, + callback: BodyResponseCallback ): void; - search( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - search( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Search - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Search; + {}) as Params$Resource$Projects$Locations$Datastores$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Search; + params = {} as Params$Resource$Projects$Locations$Datastores$List; options = {}; } @@ -20252,179 +23408,91 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+servingConfig}:search').replace( + url: (rootUrl + '/v1alpha/{+parent}/dataStores').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['servingConfig'], - pathParams: ['servingConfig'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } - } - - export interface Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Answer - extends StandardParameters { - /** - * Required. The resource name of the Search serving config, such as `projects/x/locations/global/collections/default_collection/engines/x/servingConfigs/default_serving_config`, or `projects/x/locations/global/collections/default_collection/dataStores/x/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. - */ - servingConfig?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaAnswerQueryRequest; - } - export interface Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get - extends StandardParameters { - /** - * Required. The resource name of the ServingConfig to get. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/engines/{engine\}/servingConfigs/{serving_config_id\}` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$List - extends StandardParameters { - /** - * Optional. Maximum number of results to return. If unspecified, defaults to 100. If a value greater than 100 is provided, at most 100 results are returned. - */ - pageSize?: number; - /** - * Optional. A page token, received from a previous `ListServingConfigs` call. Provide this to retrieve the subsequent page. - */ - pageToken?: string; - /** - * Required. Full resource name of the parent resource. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/engines/{engine\}` - */ - parent?: string; - } - export interface Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Patch - extends StandardParameters { - /** - * Immutable. Fully qualified name `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}/servingConfigs/{serving_config_id\}` - */ - name?: string; - /** - * Indicates which fields in the provided ServingConfig to update. The following are NOT supported: * ServingConfig.name If not set, all supported fields are updated. - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaServingConfig; - } - export interface Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Recommend - extends StandardParameters { - /** - * Required. Full resource name of a ServingConfig: `projects/x/locations/global/collections/x/engines/x/servingConfigs/x`, or `projects/x/locations/global/collections/x/dataStores/x/servingConfigs/x` One default serving config is created along with your recommendation engine creation. The engine ID is used as the ID of the default serving config. For example, for Engine `projects/x/locations/global/collections/x/engines/my-engine`, you can use `projects/x/locations/global/collections/x/engines/my-engine/servingConfigs/my-engine` for your RecommendationService.Recommend requests. - */ - servingConfig?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaRecommendRequest; - } - export interface Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Search - extends StandardParameters { - /** - * Required. The resource name of the Search serving config, such as `projects/x/locations/global/collections/default_collection/engines/x/servingConfigs/default_serving_config`, or `projects/x/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. - */ - servingConfig?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequest; - } - - export class Resource$Projects$Locations$Collections$Engines$Sessions { - context: APIRequestContext; - answers: Resource$Projects$Locations$Collections$Engines$Sessions$Answers; - constructor(context: APIRequestContext) { - this.context = context; - this.answers = - new Resource$Projects$Locations$Collections$Engines$Sessions$Answers( - this.context - ); - } /** - * Creates a Session. If the Session to create already exists, an ALREADY_EXISTS error is returned. + * Updates a DataStore * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - create( - params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Create, + patch( + params: Params$Resource$Projects$Locations$Datastores$Patch, options: StreamMethodOptions ): GaxiosPromise; - create( - params?: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Create, + patch( + params?: Params$Resource$Projects$Locations$Datastores$Patch, options?: MethodOptions - ): GaxiosPromise; - create( - params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Create, + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Datastores$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Create, + patch( + params: Params$Resource$Projects$Locations$Datastores$Patch, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Create, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Datastores$Patch, + callback: BodyResponseCallback ): void; - create( - callback: BodyResponseCallback + patch( + callback: BodyResponseCallback ): void; - create( + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Engines$Sessions$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Engines$Sessions$Create; + {}) as Params$Resource$Projects$Locations$Datastores$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Collections$Engines$Sessions$Create; + params = {} as Params$Resource$Projects$Locations$Datastores$Patch; options = {}; } @@ -20438,88 +23506,89 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/sessions').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Deletes a Session. If the Session to delete does not exist, a NOT_FOUND error is returned. + * Updates the DocumentProcessingConfig. DocumentProcessingConfig is a singleon resource of DataStore. It's empty when DataStore is created. The first call to this method will set up DocumentProcessingConfig. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - delete( - params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Delete, + updateDocumentProcessingConfig( + params: Params$Resource$Projects$Locations$Datastores$Updatedocumentprocessingconfig, options: StreamMethodOptions ): GaxiosPromise; - delete( - params?: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Delete, + updateDocumentProcessingConfig( + params?: Params$Resource$Projects$Locations$Datastores$Updatedocumentprocessingconfig, options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Delete, + ): GaxiosPromise; + updateDocumentProcessingConfig( + params: Params$Resource$Projects$Locations$Datastores$Updatedocumentprocessingconfig, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + updateDocumentProcessingConfig( + params: Params$Resource$Projects$Locations$Datastores$Updatedocumentprocessingconfig, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Delete, - callback: BodyResponseCallback + updateDocumentProcessingConfig( + params: Params$Resource$Projects$Locations$Datastores$Updatedocumentprocessingconfig, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + updateDocumentProcessingConfig( + callback: BodyResponseCallback + ): void; + updateDocumentProcessingConfig( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Engines$Sessions$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Updatedocumentprocessingconfig + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Engines$Sessions$Delete; + {}) as Params$Resource$Projects$Locations$Datastores$Updatedocumentprocessingconfig; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Engines$Sessions$Delete; + {} as Params$Resource$Projects$Locations$Datastores$Updatedocumentprocessingconfig; options = {}; } @@ -20534,7 +23603,7 @@ export namespace discoveryengine_v1alpha { options: Object.assign( { url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + method: 'PATCH', apiVersion: '', }, options @@ -20545,75 +23614,229 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } + } + export interface Params$Resource$Projects$Locations$Datastores$Completequery + extends StandardParameters { /** - * Gets a Session. + * Required. The parent data store resource name for which the completion is performed, such as `projects/x/locations/global/collections/default_collection/dataStores/default_data_store`. + */ + dataStore?: string; + /** + * 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. + */ + includeTailSuggestions?: boolean; + /** + * Required. The typeahead input used to fetch suggestions. Maximum length is 128 characters. + */ + query?: string; + /** + * Specifies the autocomplete data model. 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. + */ + queryModel?: string; + /** + * 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 SearchRequest.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. + */ + userPseudoId?: string; + } + export interface Params$Resource$Projects$Locations$Datastores$Create + extends StandardParameters { + /** + * A boolean flag indicating whether user want to directly create an advanced data store for site search. If the data store is not configured as site search (GENERIC vertical and PUBLIC_WEBSITE content_config), this flag will be ignored. + */ + createAdvancedSiteSearch?: boolean; + /** + * Required. The ID to use for the DataStore, which will become the final component of the DataStore's resource name. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned. + */ + dataStoreId?: string; + /** + * Required. The parent resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}`. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaDataStore; + } + export interface Params$Resource$Projects$Locations$Datastores$Delete + extends StandardParameters { + /** + * Required. Full resource name of DataStore, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}`. If the caller does not have permission to delete the DataStore, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the DataStore to delete does not exist, a NOT_FOUND error is returned. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Datastores$Get + extends StandardParameters { + /** + * Required. Full resource name of DataStore, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}`. If the caller does not have permission to access the DataStore, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested DataStore does not exist, a NOT_FOUND error is returned. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Datastores$Getdocumentprocessingconfig + extends StandardParameters { + /** + * Required. Full DocumentProcessingConfig resource name. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/dataStores/{data_store_id\}/documentProcessingConfig` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Datastores$Getsitesearchengine + extends StandardParameters { + /** + * Required. Resource name of SiteSearchEngine, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine`. If the caller does not have permission to access the [SiteSearchEngine], regardless of whether or not it exists, a PERMISSION_DENIED error is returned. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Datastores$List + extends StandardParameters { + /** + * Filter by solution type . For example: `filter = 'solution_type:SOLUTION_TYPE_SEARCH'` + */ + filter?: string; + /** + * Maximum number of DataStores to return. If unspecified, defaults to 10. The maximum allowed value is 50. Values above 50 will be coerced to 50. If this field is negative, an INVALID_ARGUMENT is returned. + */ + pageSize?: number; + /** + * A page token ListDataStoresResponse.next_page_token, received from a previous DataStoreService.ListDataStores call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to DataStoreService.ListDataStores must match the call that provided the page token. Otherwise, an INVALID_ARGUMENT error is returned. + */ + pageToken?: string; + /** + * Required. The parent branch resource name, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}`. If the caller does not have permission to list DataStores under this location, regardless of whether or not this data store exists, a PERMISSION_DENIED error is returned. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Datastores$Patch + extends StandardParameters { + /** + * 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. + */ + name?: string; + /** + * Indicates which fields in the provided DataStore to update. If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaDataStore; + } + export interface Params$Resource$Projects$Locations$Datastores$Updatedocumentprocessingconfig + extends StandardParameters { + /** + * The full resource name of the Document Processing Config. Format: `projects/x/locations/x/collections/x/dataStores/x/documentProcessingConfig`. + */ + name?: string; + /** + * Indicates which fields in the provided DocumentProcessingConfig to update. The following are the only supported fields: * DocumentProcessingConfig.ocr_config If not set, all supported fields are updated. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig; + } + + export class Resource$Projects$Locations$Datastores$Branches { + context: APIRequestContext; + documents: Resource$Projects$Locations$Datastores$Branches$Documents; + operations: Resource$Projects$Locations$Datastores$Branches$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.documents = + new Resource$Projects$Locations$Datastores$Branches$Documents( + this.context + ); + this.operations = + new Resource$Projects$Locations$Datastores$Branches$Operations( + this.context + ); + } + } + + export class Resource$Projects$Locations$Datastores$Branches$Documents { + context: APIRequestContext; + chunks: Resource$Projects$Locations$Datastores$Branches$Documents$Chunks; + constructor(context: APIRequestContext) { + this.context = context; + this.chunks = + new Resource$Projects$Locations$Datastores$Branches$Documents$Chunks( + this.context + ); + } + + /** + * Creates a Document. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Get, + create( + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Create, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Get, - options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Get, + create( + params?: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Get, + create( + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Create, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Get, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Create, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + create( + callback: BodyResponseCallback ): void; - get( + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Engines$Sessions$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Branches$Documents$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Engines$Sessions$Get; + {}) as Params$Resource$Projects$Locations$Datastores$Branches$Documents$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Engines$Sessions$Get; + {} as Params$Resource$Projects$Locations$Datastores$Branches$Documents$Create; options = {}; } @@ -20627,89 +23850,88 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1alpha/{+parent}/documents').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Lists all Sessions by their parent DataStore. + * Deletes a Document. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$List, + delete( + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Delete, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Collections$Engines$Sessions$List, + delete( + params?: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Delete, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$List, + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$List, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Delete, + callback: BodyResponseCallback ): void; - list( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Engines$Sessions$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Branches$Documents$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Engines$Sessions$List; + {}) as Params$Resource$Projects$Locations$Datastores$Branches$Documents$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Engines$Sessions$List; + {} as Params$Resource$Projects$Locations$Datastores$Branches$Documents$Delete; options = {}; } @@ -20723,92 +23945,87 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/sessions').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Updates a Session. Session action type cannot be changed. If the Session to update does not exist, a NOT_FOUND error is returned. + * Gets a Document. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - patch( - params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Patch, + get( + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Get, options: StreamMethodOptions ): GaxiosPromise; - patch( - params?: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Patch, + get( + params?: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Get, options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Patch, + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Patch, + get( + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Patch, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Get, + callback: BodyResponseCallback ): void; - patch( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - patch( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Engines$Sessions$Patch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Branches$Documents$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Engines$Sessions$Patch; + {}) as Params$Resource$Projects$Locations$Datastores$Branches$Documents$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Engines$Sessions$Patch; + {} as Params$Resource$Projects$Locations$Datastores$Branches$Documents$Get; options = {}; } @@ -20823,7 +24040,7 @@ export namespace discoveryengine_v1alpha { options: Object.assign( { url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + method: 'GET', apiVersion: '', }, options @@ -20834,150 +24051,77 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest( - parameters - ); - } - } - } - - export interface Params$Resource$Projects$Locations$Collections$Engines$Sessions$Create - extends StandardParameters { - /** - * Required. Full resource name of parent data store. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}` - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaSession; - } - export interface Params$Resource$Projects$Locations$Collections$Engines$Sessions$Delete - extends StandardParameters { - /** - * Required. The resource name of the Session to delete. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/sessions/{session_id\}` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Collections$Engines$Sessions$Get - extends StandardParameters { - /** - * Required. The resource name of the Session to get. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/sessions/{session_id\}` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Collections$Engines$Sessions$List - extends StandardParameters { - /** - * A filter to apply on the list results. The supported features are: user_pseudo_id, state. Example: "user_pseudo_id = some_id" - */ - filter?: string; - /** - * 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` Example: "update_time desc" "create_time" - */ - orderBy?: string; - /** - * Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000. - */ - pageSize?: number; - /** - * A page token, received from a previous `ListSessions` call. Provide this to retrieve the subsequent page. - */ - pageToken?: string; - /** - * Required. The data store resource name. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}` - */ - parent?: string; - } - export interface Params$Resource$Projects$Locations$Collections$Engines$Sessions$Patch - extends StandardParameters { - /** - * Immutable. Fully qualified name `projects/{project\}/locations/global/collections/{collection\}/engines/{engine\}/sessions/x` - */ - name?: string; - /** - * 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. - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaSession; - } - - export class Resource$Projects$Locations$Collections$Engines$Sessions$Answers { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } } /** - * Gets a Answer. + * Gets the parsed layout information for a Document. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Answers$Get, + getProcessedDocument( + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Getprocesseddocument, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Answers$Get, + getProcessedDocument( + params?: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Getprocesseddocument, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Answers$Get, + ): GaxiosPromise; + getProcessedDocument( + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Getprocesseddocument, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Answers$Get, + getProcessedDocument( + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Getprocesseddocument, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Answers$Get, - callback: BodyResponseCallback + getProcessedDocument( + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Getprocesseddocument, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + getProcessedDocument( + callback: BodyResponseCallback ): void; - get( + getProcessedDocument( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Engines$Sessions$Answers$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Branches$Documents$Getprocesseddocument + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Engines$Sessions$Answers$Get; + {}) as Params$Resource$Projects$Locations$Datastores$Branches$Documents$Getprocesseddocument; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Engines$Sessions$Answers$Get; + {} as Params$Resource$Projects$Locations$Datastores$Branches$Documents$Getprocesseddocument; options = {}; } @@ -20991,7 +24135,10 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1alpha/{+name}:getProcessedDocument').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'GET', apiVersion: '', }, @@ -21003,70 +24150,55 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } - } - - export interface Params$Resource$Projects$Locations$Collections$Engines$Sessions$Answers$Get - extends StandardParameters { - /** - * Required. The resource name of the Answer to get. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/engines/{engine_id\}/sessions/{session_id\}/answers/{answer_id\}` - */ - name?: string; - } - - export class Resource$Projects$Locations$Collections$Operations { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * 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. + * 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. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Collections$Operations$Get, + import( + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Import, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Collections$Operations$Get, + import( + params?: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Import, options?: MethodOptions ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Collections$Operations$Get, + import( + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Import, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Collections$Operations$Get, + import( + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Import, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Collections$Operations$Get, + import( + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Import, callback: BodyResponseCallback ): void; - get( + import( callback: BodyResponseCallback ): void; - get( + import( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Operations$Get + | Params$Resource$Projects$Locations$Datastores$Branches$Documents$Import | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -21082,13 +24214,13 @@ export namespace discoveryengine_v1alpha { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Operations$Get; + {}) as Params$Resource$Projects$Locations$Datastores$Branches$Documents$Import; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Operations$Get; + {} as Params$Resource$Projects$Locations$Datastores$Branches$Documents$Import; options = {}; } @@ -21102,15 +24234,18 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1alpha/{+parent}/documents:import').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { @@ -21124,7 +24259,7 @@ export namespace discoveryengine_v1alpha { } /** - * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + * Gets a list of Documents. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -21132,57 +24267,57 @@ export namespace discoveryengine_v1alpha { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Collections$Operations$List, + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$List, options: StreamMethodOptions ): GaxiosPromise; list( - params?: Params$Resource$Projects$Locations$Collections$Operations$List, + params?: Params$Resource$Projects$Locations$Datastores$Branches$Documents$List, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; list( - params: Params$Resource$Projects$Locations$Collections$Operations$List, + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Collections$Operations$List, + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Collections$Operations$List, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$List, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Operations$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Branches$Documents$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Operations$List; + {}) as Params$Resource$Projects$Locations$Datastores$Branches$Documents$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Operations$List; + {} as Params$Resource$Projects$Locations$Datastores$Branches$Documents$List; options = {}; } @@ -21196,7 +24331,7 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}/operations').replace( + url: (rootUrl + '/v1alpha/{+parent}/documents').replace( /([^:]\/)\/+/g, '$1' ), @@ -21206,165 +24341,82 @@ export namespace discoveryengine_v1alpha { options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); - } - } - } - - export interface Params$Resource$Projects$Locations$Collections$Operations$Get - extends StandardParameters { - /** - * The name of the operation resource. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Collections$Operations$List - extends StandardParameters { - /** - * The standard list filter. - */ - filter?: string; - /** - * The name of the operation's parent resource. - */ - name?: string; - /** - * The standard list page size. - */ - pageSize?: number; - /** - * The standard list page token. - */ - pageToken?: string; - } - - export class Resource$Projects$Locations$Datastores { - context: APIRequestContext; - branches: Resource$Projects$Locations$Datastores$Branches; - completionSuggestions: Resource$Projects$Locations$Datastores$Completionsuggestions; - controls: Resource$Projects$Locations$Datastores$Controls; - conversations: Resource$Projects$Locations$Datastores$Conversations; - models: Resource$Projects$Locations$Datastores$Models; - operations: Resource$Projects$Locations$Datastores$Operations; - schemas: Resource$Projects$Locations$Datastores$Schemas; - servingConfigs: Resource$Projects$Locations$Datastores$Servingconfigs; - sessions: Resource$Projects$Locations$Datastores$Sessions; - siteSearchEngine: Resource$Projects$Locations$Datastores$Sitesearchengine; - suggestionDenyListEntries: Resource$Projects$Locations$Datastores$Suggestiondenylistentries; - userEvents: Resource$Projects$Locations$Datastores$Userevents; - constructor(context: APIRequestContext) { - this.context = context; - this.branches = new Resource$Projects$Locations$Datastores$Branches( - this.context - ); - this.completionSuggestions = - new Resource$Projects$Locations$Datastores$Completionsuggestions( - this.context - ); - this.controls = new Resource$Projects$Locations$Datastores$Controls( - this.context - ); - this.conversations = - new Resource$Projects$Locations$Datastores$Conversations(this.context); - this.models = new Resource$Projects$Locations$Datastores$Models( - this.context - ); - this.operations = new Resource$Projects$Locations$Datastores$Operations( - this.context - ); - this.schemas = new Resource$Projects$Locations$Datastores$Schemas( - this.context - ); - this.servingConfigs = - new Resource$Projects$Locations$Datastores$Servingconfigs(this.context); - this.sessions = new Resource$Projects$Locations$Datastores$Sessions( - this.context - ); - this.siteSearchEngine = - new Resource$Projects$Locations$Datastores$Sitesearchengine( - this.context - ); - this.suggestionDenyListEntries = - new Resource$Projects$Locations$Datastores$Suggestiondenylistentries( - this.context - ); - this.userEvents = new Resource$Projects$Locations$Datastores$Userevents( - this.context - ); + } } /** - * Completes the specified user input with keyword suggestions. + * Updates a Document. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - completeQuery( - params: Params$Resource$Projects$Locations$Datastores$Completequery, + patch( + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Patch, options: StreamMethodOptions ): GaxiosPromise; - completeQuery( - params?: Params$Resource$Projects$Locations$Datastores$Completequery, + patch( + params?: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Patch, options?: MethodOptions - ): GaxiosPromise; - completeQuery( - params: Params$Resource$Projects$Locations$Datastores$Completequery, + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - completeQuery( - params: Params$Resource$Projects$Locations$Datastores$Completequery, + patch( + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Patch, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - completeQuery( - params: Params$Resource$Projects$Locations$Datastores$Completequery, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Patch, + callback: BodyResponseCallback ): void; - completeQuery( - callback: BodyResponseCallback + patch( + callback: BodyResponseCallback ): void; - completeQuery( + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Completequery - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Branches$Documents$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Completequery; + {}) as Params$Resource$Projects$Locations$Datastores$Branches$Documents$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Completequery; + {} as Params$Resource$Projects$Locations$Datastores$Branches$Documents$Patch; options = {}; } @@ -21378,70 +24430,67 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+dataStore}:completeQuery').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', apiVersion: '', }, options ), params, - requiredParams: ['dataStore'], - pathParams: ['dataStore'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * 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. + * 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. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - create( - params: Params$Resource$Projects$Locations$Datastores$Create, + purge( + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Purge, options: StreamMethodOptions ): GaxiosPromise; - create( - params?: Params$Resource$Projects$Locations$Datastores$Create, + purge( + params?: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Purge, options?: MethodOptions ): GaxiosPromise; - create( - params: Params$Resource$Projects$Locations$Datastores$Create, + purge( + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Purge, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Datastores$Create, + purge( + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Purge, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Datastores$Create, + purge( + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Purge, callback: BodyResponseCallback ): void; - create( + purge( callback: BodyResponseCallback ): void; - create( + purge( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Create + | Params$Resource$Projects$Locations$Datastores$Branches$Documents$Purge | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -21457,12 +24506,13 @@ export namespace discoveryengine_v1alpha { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Create; + {}) as Params$Resource$Projects$Locations$Datastores$Branches$Documents$Purge; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datastores$Create; + params = + {} as Params$Resource$Projects$Locations$Datastores$Branches$Documents$Purge; options = {}; } @@ -21476,7 +24526,7 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/dataStores').replace( + url: (rootUrl + '/v1alpha/{+parent}/documents:purge').replace( /([^:]\/)\/+/g, '$1' ), @@ -21499,66 +24549,179 @@ export namespace discoveryengine_v1alpha { return createAPIRequest(parameters); } } + } + export interface Params$Resource$Projects$Locations$Datastores$Branches$Documents$Create + extends StandardParameters { /** - * Deletes a DataStore. + * Required. The ID to use for the Document, which becomes the final component of the Document.name. If the caller does not have permission to create the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. This field must be unique among all Documents with the same parent. Otherwise, an `ALREADY_EXISTS` error is returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. + */ + documentId?: string; + /** + * Required. The parent resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}`. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaDocument; + } + export interface Params$Resource$Projects$Locations$Datastores$Branches$Documents$Delete + extends StandardParameters { + /** + * Required. Full resource name of Document, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}/documents/{document\}`. If the caller does not have permission to delete the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the Document to delete does not exist, a `NOT_FOUND` error is returned. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Datastores$Branches$Documents$Get + extends StandardParameters { + /** + * Required. Full resource name of Document, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}/documents/{document\}`. If the caller does not have permission to access the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the requested Document does not exist, a `NOT_FOUND` error is returned. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Datastores$Branches$Documents$Getprocesseddocument + extends StandardParameters { + /** + * Required. Full resource name of Document, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}/documents/{document\}`. If the caller does not have permission to access the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the requested Document does not exist, a `NOT_FOUND` error is returned. + */ + name?: string; + /** + * What format output should be. If unspecified, defaults to JSON. + */ + processedDocumentFormat?: string; + /** + * Required. What type of processing to return. + */ + processedDocumentType?: string; + } + export interface Params$Resource$Projects$Locations$Datastores$Branches$Documents$Import + extends StandardParameters { + /** + * Required. The parent branch resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}`. Requires create/update permission. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaImportDocumentsRequest; + } + export interface Params$Resource$Projects$Locations$Datastores$Branches$Documents$List + extends StandardParameters { + /** + * Maximum number of Documents to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 are set to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned. + */ + pageSize?: number; + /** + * A page token ListDocumentsResponse.next_page_token, received from a previous DocumentService.ListDocuments call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to DocumentService.ListDocuments must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned. + */ + pageToken?: string; + /** + * Required. The parent branch resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}`. Use `default_branch` as the branch ID, to list documents under the default branch. If the caller does not have permission to list Documents under this branch, regardless of whether or not this branch exists, a `PERMISSION_DENIED` error is returned. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Datastores$Branches$Documents$Patch + extends StandardParameters { + /** + * If set to `true` and the Document is not found, a new Document is be created. + */ + allowMissing?: boolean; + /** + * 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?: string; + /** + * Indicates which fields in the provided imported 'document' to update. If not set, by default updates all fields. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaDocument; + } + export interface Params$Resource$Projects$Locations$Datastores$Branches$Documents$Purge + extends StandardParameters { + /** + * Required. The parent resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}`. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaPurgeDocumentsRequest; + } + + export class Resource$Projects$Locations$Datastores$Branches$Documents$Chunks { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Gets a Document. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - delete( - params: Params$Resource$Projects$Locations$Datastores$Delete, + get( + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Chunks$Get, options: StreamMethodOptions ): GaxiosPromise; - delete( - params?: Params$Resource$Projects$Locations$Datastores$Delete, + get( + params?: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Chunks$Get, options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Projects$Locations$Datastores$Delete, + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Chunks$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Datastores$Delete, + get( + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Chunks$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Datastores$Delete, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Chunks$Get, + callback: BodyResponseCallback ): void; - delete( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - delete( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Branches$Documents$Chunks$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Delete; + {}) as Params$Resource$Projects$Locations$Datastores$Branches$Documents$Chunks$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datastores$Delete; + params = + {} as Params$Resource$Projects$Locations$Datastores$Branches$Documents$Chunks$Get; options = {}; } @@ -21573,7 +24736,7 @@ export namespace discoveryengine_v1alpha { options: Object.assign( { url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + method: 'GET', apiVersion: '', }, options @@ -21584,74 +24747,77 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Gets a DataStore. + * Gets a list of Chunks. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Datastores$Get, + list( + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Chunks$List, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Datastores$Get, + list( + params?: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Chunks$List, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Datastores$Get, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Chunks$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Datastores$Get, + list( + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Chunks$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Datastores$Get, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Chunks$List, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - get( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Branches$Documents$Chunks$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Get; + {}) as Params$Resource$Projects$Locations$Datastores$Branches$Documents$Chunks$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datastores$Get; + params = + {} as Params$Resource$Projects$Locations$Datastores$Branches$Documents$Chunks$List; options = {}; } @@ -21665,89 +24831,118 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1alpha/{+parent}/chunks').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } + } + export interface Params$Resource$Projects$Locations$Datastores$Branches$Documents$Chunks$Get + extends StandardParameters { /** - * Gets a DocumentProcessingConfig. + * Required. Full resource name of Chunk, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}/documents/{document\}/chunks/{chunk\}`. If the caller does not have permission to access the Chunk, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the requested Chunk does not exist, a `NOT_FOUND` error is returned. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Datastores$Branches$Documents$Chunks$List + extends StandardParameters { + /** + * Maximum number of Chunks to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned. + */ + pageSize?: number; + /** + * A page token ListChunksResponse.next_page_token, received from a previous ChunkService.ListChunks call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ChunkService.ListChunks must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned. + */ + pageToken?: string; + /** + * Required. The parent document resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}/documents/{document\}`. If the caller does not have permission to list Chunks under this document, regardless of whether or not this document exists, a `PERMISSION_DENIED` error is returned. + */ + parent?: string; + } + + export class Resource$Projects$Locations$Datastores$Branches$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * 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`. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - getDocumentProcessingConfig( - params: Params$Resource$Projects$Locations$Datastores$Getdocumentprocessingconfig, + cancel( + params: Params$Resource$Projects$Locations$Datastores$Branches$Operations$Cancel, options: StreamMethodOptions ): GaxiosPromise; - getDocumentProcessingConfig( - params?: Params$Resource$Projects$Locations$Datastores$Getdocumentprocessingconfig, + cancel( + params?: Params$Resource$Projects$Locations$Datastores$Branches$Operations$Cancel, options?: MethodOptions - ): GaxiosPromise; - getDocumentProcessingConfig( - params: Params$Resource$Projects$Locations$Datastores$Getdocumentprocessingconfig, + ): GaxiosPromise; + cancel( + params: Params$Resource$Projects$Locations$Datastores$Branches$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - getDocumentProcessingConfig( - params: Params$Resource$Projects$Locations$Datastores$Getdocumentprocessingconfig, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - getDocumentProcessingConfig( - params: Params$Resource$Projects$Locations$Datastores$Getdocumentprocessingconfig, - callback: BodyResponseCallback + cancel( + params: Params$Resource$Projects$Locations$Datastores$Branches$Operations$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - getDocumentProcessingConfig( - callback: BodyResponseCallback + cancel( + params: Params$Resource$Projects$Locations$Datastores$Branches$Operations$Cancel, + callback: BodyResponseCallback ): void; - getDocumentProcessingConfig( + cancel(callback: BodyResponseCallback): void; + cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Getdocumentprocessingconfig - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Branches$Operations$Cancel + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Getdocumentprocessingconfig; + {}) as Params$Resource$Projects$Locations$Datastores$Branches$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Getdocumentprocessingconfig; + {} as Params$Resource$Projects$Locations$Datastores$Branches$Operations$Cancel; options = {}; } @@ -21761,8 +24956,11 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1alpha/{+name}:cancel').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options @@ -21773,77 +24971,75 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Gets the SiteSearchEngine. + * 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. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - getSiteSearchEngine( - params: Params$Resource$Projects$Locations$Datastores$Getsitesearchengine, + get( + params: Params$Resource$Projects$Locations$Datastores$Branches$Operations$Get, options: StreamMethodOptions ): GaxiosPromise; - getSiteSearchEngine( - params?: Params$Resource$Projects$Locations$Datastores$Getsitesearchengine, + get( + params?: Params$Resource$Projects$Locations$Datastores$Branches$Operations$Get, options?: MethodOptions - ): GaxiosPromise; - getSiteSearchEngine( - params: Params$Resource$Projects$Locations$Datastores$Getsitesearchengine, + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Datastores$Branches$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - getSiteSearchEngine( - params: Params$Resource$Projects$Locations$Datastores$Getsitesearchengine, + get( + params: Params$Resource$Projects$Locations$Datastores$Branches$Operations$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - getSiteSearchEngine( - params: Params$Resource$Projects$Locations$Datastores$Getsitesearchengine, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Datastores$Branches$Operations$Get, + callback: BodyResponseCallback ): void; - getSiteSearchEngine( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - getSiteSearchEngine( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Getsitesearchengine - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Branches$Operations$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Getsitesearchengine; + {}) as Params$Resource$Projects$Locations$Datastores$Branches$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Getsitesearchengine; + {} as Params$Resource$Projects$Locations$Datastores$Branches$Operations$Get; options = {}; } @@ -21869,19 +25065,17 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Lists all the DataStores associated with the project. + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -21889,56 +25083,57 @@ export namespace discoveryengine_v1alpha { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Datastores$List, + params: Params$Resource$Projects$Locations$Datastores$Branches$Operations$List, options: StreamMethodOptions ): GaxiosPromise; list( - params?: Params$Resource$Projects$Locations$Datastores$List, + params?: Params$Resource$Projects$Locations$Datastores$Branches$Operations$List, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; list( - params: Params$Resource$Projects$Locations$Datastores$List, + params: Params$Resource$Projects$Locations$Datastores$Branches$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Datastores$List, + params: Params$Resource$Projects$Locations$Datastores$Branches$Operations$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Datastores$List, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Datastores$Branches$Operations$List, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Branches$Operations$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$List; + {}) as Params$Resource$Projects$Locations$Datastores$Branches$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datastores$List; + params = + {} as Params$Resource$Projects$Locations$Datastores$Branches$Operations$List; options = {}; } @@ -21952,7 +25147,7 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/dataStores').replace( + url: (rootUrl + '/v1alpha/{+name}/operations').replace( /([^:]\/)\/+/g, '$1' ), @@ -21962,81 +25157,128 @@ export namespace discoveryengine_v1alpha { options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } + } + + export interface Params$Resource$Projects$Locations$Datastores$Branches$Operations$Cancel + extends StandardParameters { + /** + * The name of the operation resource to be cancelled. + */ + name?: string; /** - * Updates a DataStore + * Request body metadata + */ + requestBody?: Schema$GoogleLongrunningCancelOperationRequest; + } + export interface Params$Resource$Projects$Locations$Datastores$Branches$Operations$Get + extends StandardParameters { + /** + * The name of the operation resource. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Datastores$Branches$Operations$List + extends StandardParameters { + /** + * The standard list filter. + */ + filter?: string; + /** + * The name of the operation's parent resource. + */ + name?: string; + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. + */ + pageToken?: string; + } + + export class Resource$Projects$Locations$Datastores$Completionsuggestions { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Imports CompletionSuggestions for a DataStore. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - patch( - params: Params$Resource$Projects$Locations$Datastores$Patch, + import( + params: Params$Resource$Projects$Locations$Datastores$Completionsuggestions$Import, options: StreamMethodOptions ): GaxiosPromise; - patch( - params?: Params$Resource$Projects$Locations$Datastores$Patch, + import( + params?: Params$Resource$Projects$Locations$Datastores$Completionsuggestions$Import, options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Projects$Locations$Datastores$Patch, + ): GaxiosPromise; + import( + params: Params$Resource$Projects$Locations$Datastores$Completionsuggestions$Import, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Datastores$Patch, + import( + params: Params$Resource$Projects$Locations$Datastores$Completionsuggestions$Import, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Datastores$Patch, - callback: BodyResponseCallback + import( + params: Params$Resource$Projects$Locations$Datastores$Completionsuggestions$Import, + callback: BodyResponseCallback ): void; - patch( - callback: BodyResponseCallback + import( + callback: BodyResponseCallback ): void; - patch( + import( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Patch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Completionsuggestions$Import + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Patch; + {}) as Params$Resource$Projects$Locations$Datastores$Completionsuggestions$Import; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datastores$Patch; + params = + {} as Params$Resource$Projects$Locations$Datastores$Completionsuggestions$Import; options = {}; } @@ -22050,279 +25292,159 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + url: ( + rootUrl + '/v1alpha/{+parent}/completionSuggestions:import' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Updates the DocumentProcessingConfig. DocumentProcessingConfig is a singleon resource of DataStore. It's empty when DataStore is created. The first call to this method will set up DocumentProcessingConfig. + * Permanently deletes all CompletionSuggestions for a DataStore. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - updateDocumentProcessingConfig( - params: Params$Resource$Projects$Locations$Datastores$Updatedocumentprocessingconfig, + purge( + params: Params$Resource$Projects$Locations$Datastores$Completionsuggestions$Purge, options: StreamMethodOptions ): GaxiosPromise; - updateDocumentProcessingConfig( - params?: Params$Resource$Projects$Locations$Datastores$Updatedocumentprocessingconfig, + purge( + params?: Params$Resource$Projects$Locations$Datastores$Completionsuggestions$Purge, options?: MethodOptions - ): GaxiosPromise; - updateDocumentProcessingConfig( - params: Params$Resource$Projects$Locations$Datastores$Updatedocumentprocessingconfig, + ): GaxiosPromise; + purge( + params: Params$Resource$Projects$Locations$Datastores$Completionsuggestions$Purge, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - updateDocumentProcessingConfig( - params: Params$Resource$Projects$Locations$Datastores$Updatedocumentprocessingconfig, + purge( + params: Params$Resource$Projects$Locations$Datastores$Completionsuggestions$Purge, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - updateDocumentProcessingConfig( - params: Params$Resource$Projects$Locations$Datastores$Updatedocumentprocessingconfig, - callback: BodyResponseCallback + purge( + params: Params$Resource$Projects$Locations$Datastores$Completionsuggestions$Purge, + callback: BodyResponseCallback ): void; - updateDocumentProcessingConfig( - callback: BodyResponseCallback + purge( + callback: BodyResponseCallback ): void; - updateDocumentProcessingConfig( + purge( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Updatedocumentprocessingconfig - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Completionsuggestions$Purge + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Updatedocumentprocessingconfig; + {}) as Params$Resource$Projects$Locations$Datastores$Completionsuggestions$Purge; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Updatedocumentprocessingconfig; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; + {} as Params$Resource$Projects$Locations$Datastores$Completionsuggestions$Purge; options = {}; } - const rootUrl = - options.rootUrl || 'https://discoveryengine.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest( - parameters - ); - } - } - } - - export interface Params$Resource$Projects$Locations$Datastores$Completequery - extends StandardParameters { - /** - * Required. The parent data store resource name for which the completion is performed, such as `projects/x/locations/global/collections/default_collection/dataStores/default_data_store`. - */ - dataStore?: string; - /** - * 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. - */ - includeTailSuggestions?: boolean; - /** - * Required. The typeahead input used to fetch suggestions. Maximum length is 128 characters. - */ - query?: string; - /** - * Specifies the autocomplete data model. 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. - */ - queryModel?: string; - /** - * 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 SearchRequest.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. - */ - userPseudoId?: string; - } - export interface Params$Resource$Projects$Locations$Datastores$Create - extends StandardParameters { - /** - * A boolean flag indicating whether user want to directly create an advanced data store for site search. If the data store is not configured as site search (GENERIC vertical and PUBLIC_WEBSITE content_config), this flag will be ignored. - */ - createAdvancedSiteSearch?: boolean; - /** - * Required. The ID to use for the DataStore, which will become the final component of the DataStore's resource name. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned. - */ - dataStoreId?: string; - /** - * Required. The parent resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}`. - */ - parent?: string; + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaDataStore; - } - export interface Params$Resource$Projects$Locations$Datastores$Delete - extends StandardParameters { - /** - * Required. Full resource name of DataStore, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}`. If the caller does not have permission to delete the DataStore, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the DataStore to delete does not exist, a NOT_FOUND error is returned. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Datastores$Get - extends StandardParameters { - /** - * Required. Full resource name of DataStore, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}`. If the caller does not have permission to access the DataStore, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested DataStore does not exist, a NOT_FOUND error is returned. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Datastores$Getdocumentprocessingconfig - extends StandardParameters { - /** - * Required. Full DocumentProcessingConfig resource name. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/dataStores/{data_store_id\}/documentProcessingConfig` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Datastores$Getsitesearchengine - extends StandardParameters { - /** - * Required. Resource name of SiteSearchEngine, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine`. If the caller does not have permission to access the [SiteSearchEngine], regardless of whether or not it exists, a PERMISSION_DENIED error is returned. - */ - name?: string; + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v1alpha/{+parent}/completionSuggestions:purge' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } } - export interface Params$Resource$Projects$Locations$Datastores$List + + export interface Params$Resource$Projects$Locations$Datastores$Completionsuggestions$Import extends StandardParameters { /** - * Filter by solution type . For example: `filter = 'solution_type:SOLUTION_TYPE_SEARCH'` - */ - filter?: string; - /** - * Maximum number of DataStores to return. If unspecified, defaults to 10. The maximum allowed value is 50. Values above 50 will be coerced to 50. If this field is negative, an INVALID_ARGUMENT is returned. - */ - pageSize?: number; - /** - * A page token ListDataStoresResponse.next_page_token, received from a previous DataStoreService.ListDataStores call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to DataStoreService.ListDataStores must match the call that provided the page token. Otherwise, an INVALID_ARGUMENT error is returned. - */ - pageToken?: string; - /** - * Required. The parent branch resource name, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}`. If the caller does not have permission to list DataStores under this location, regardless of whether or not this data store exists, a PERMISSION_DENIED error is returned. + * Required. The parent data store resource name for which to import customer autocomplete suggestions. Follows pattern `projects/x/locations/x/collections/x/dataStores/x` */ parent?: string; - } - export interface Params$Resource$Projects$Locations$Datastores$Patch - extends StandardParameters { - /** - * 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. - */ - name?: string; - /** - * Indicates which fields in the provided DataStore to update. If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned. - */ - updateMask?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaDataStore; + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaImportCompletionSuggestionsRequest; } - export interface Params$Resource$Projects$Locations$Datastores$Updatedocumentprocessingconfig + export interface Params$Resource$Projects$Locations$Datastores$Completionsuggestions$Purge extends StandardParameters { /** - * The full resource name of the Document Processing Config. Format: `projects/x/locations/x/collections/x/dataStores/x/documentProcessingConfig`. - */ - name?: string; - /** - * Indicates which fields in the provided DocumentProcessingConfig to update. The following are the only supported fields: * DocumentProcessingConfig.ocr_config If not set, all supported fields are updated. + * Required. The parent data store resource name for which to purge completion suggestions. Follows pattern projects/x/locations/x/collections/x/dataStores/x. */ - updateMask?: string; + parent?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig; - } - - export class Resource$Projects$Locations$Datastores$Branches { - context: APIRequestContext; - documents: Resource$Projects$Locations$Datastores$Branches$Documents; - operations: Resource$Projects$Locations$Datastores$Branches$Operations; - constructor(context: APIRequestContext) { - this.context = context; - this.documents = - new Resource$Projects$Locations$Datastores$Branches$Documents( - this.context - ); - this.operations = - new Resource$Projects$Locations$Datastores$Branches$Operations( - this.context - ); - } + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaPurgeCompletionSuggestionsRequest; } - export class Resource$Projects$Locations$Datastores$Branches$Documents { + export class Resource$Projects$Locations$Datastores$Controls { context: APIRequestContext; - chunks: Resource$Projects$Locations$Datastores$Branches$Documents$Chunks; constructor(context: APIRequestContext) { this.context = context; - this.chunks = - new Resource$Projects$Locations$Datastores$Branches$Documents$Chunks( - this.context - ); } /** - * Creates a Document. + * 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. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -22330,57 +25452,57 @@ export namespace discoveryengine_v1alpha { * @returns A promise if used with async/await, or void if used with a callback. */ create( - params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Create, + params: Params$Resource$Projects$Locations$Datastores$Controls$Create, options: StreamMethodOptions ): GaxiosPromise; create( - params?: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Create, + params?: Params$Resource$Projects$Locations$Datastores$Controls$Create, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; create( - params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Create, + params: Params$Resource$Projects$Locations$Datastores$Controls$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; create( - params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Create, + params: Params$Resource$Projects$Locations$Datastores$Controls$Create, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; create( - params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Create, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Datastores$Controls$Create, + callback: BodyResponseCallback ): void; create( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Branches$Documents$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Controls$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Branches$Documents$Create; + {}) as Params$Resource$Projects$Locations$Datastores$Controls$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Branches$Documents$Create; + {} as Params$Resource$Projects$Locations$Datastores$Controls$Create; options = {}; } @@ -22394,7 +25516,7 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/documents').replace( + url: (rootUrl + '/v1alpha/{+parent}/controls').replace( /([^:]\/)\/+/g, '$1' ), @@ -22409,19 +25531,19 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Deletes a Document. + * Deletes a Control. If the Control to delete does not exist, a NOT_FOUND error is returned. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -22429,31 +25551,31 @@ export namespace discoveryengine_v1alpha { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Delete, + params: Params$Resource$Projects$Locations$Datastores$Controls$Delete, options: StreamMethodOptions ): GaxiosPromise; delete( - params?: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Delete, + params?: Params$Resource$Projects$Locations$Datastores$Controls$Delete, options?: MethodOptions ): GaxiosPromise; delete( - params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Delete, + params: Params$Resource$Projects$Locations$Datastores$Controls$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Delete, + params: Params$Resource$Projects$Locations$Datastores$Controls$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Delete, + params: Params$Resource$Projects$Locations$Datastores$Controls$Delete, callback: BodyResponseCallback ): void; delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Branches$Documents$Delete + | Params$Resource$Projects$Locations$Datastores$Controls$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -22469,13 +25591,13 @@ export namespace discoveryengine_v1alpha { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Branches$Documents$Delete; + {}) as Params$Resource$Projects$Locations$Datastores$Controls$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Branches$Documents$Delete; + {} as Params$Resource$Projects$Locations$Datastores$Controls$Delete; options = {}; } @@ -22511,7 +25633,7 @@ export namespace discoveryengine_v1alpha { } /** - * Gets a Document. + * Gets a Control. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -22519,57 +25641,57 @@ export namespace discoveryengine_v1alpha { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Get, + params: Params$Resource$Projects$Locations$Datastores$Controls$Get, options: StreamMethodOptions ): GaxiosPromise; get( - params?: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Get, + params?: Params$Resource$Projects$Locations$Datastores$Controls$Get, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; get( - params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Get, + params: Params$Resource$Projects$Locations$Datastores$Controls$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Get, + params: Params$Resource$Projects$Locations$Datastores$Controls$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Get, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Datastores$Controls$Get, + callback: BodyResponseCallback ): void; get( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Branches$Documents$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Controls$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Branches$Documents$Get; + {}) as Params$Resource$Projects$Locations$Datastores$Controls$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Branches$Documents$Get; + {} as Params$Resource$Projects$Locations$Datastores$Controls$Get; options = {}; } @@ -22595,77 +25717,77 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Gets the parsed layout information for a Document. + * Lists all Controls by their parent DataStore. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - getProcessedDocument( - params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Getprocesseddocument, + list( + params: Params$Resource$Projects$Locations$Datastores$Controls$List, options: StreamMethodOptions ): GaxiosPromise; - getProcessedDocument( - params?: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Getprocesseddocument, + list( + params?: Params$Resource$Projects$Locations$Datastores$Controls$List, options?: MethodOptions - ): GaxiosPromise; - getProcessedDocument( - params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Getprocesseddocument, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Datastores$Controls$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - getProcessedDocument( - params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Getprocesseddocument, + list( + params: Params$Resource$Projects$Locations$Datastores$Controls$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - getProcessedDocument( - params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Getprocesseddocument, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - getProcessedDocument( - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Datastores$Controls$List, + callback: BodyResponseCallback ): void; - getProcessedDocument( + list( + callback: BodyResponseCallback + ): void; + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Branches$Documents$Getprocesseddocument - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Controls$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Branches$Documents$Getprocesseddocument; + {}) as Params$Resource$Projects$Locations$Datastores$Controls$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Branches$Documents$Getprocesseddocument; + {} as Params$Resource$Projects$Locations$Datastores$Controls$List; options = {}; } @@ -22679,7 +25801,7 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}:getProcessedDocument').replace( + url: (rootUrl + '/v1alpha/{+parent}/controls').replace( /([^:]\/)\/+/g, '$1' ), @@ -22689,82 +25811,82 @@ export namespace discoveryengine_v1alpha { options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * 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. + * Updates a Control. Control action type cannot be changed. If the Control to update does not exist, a NOT_FOUND error is returned. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - import( - params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Import, + patch( + params: Params$Resource$Projects$Locations$Datastores$Controls$Patch, options: StreamMethodOptions ): GaxiosPromise; - import( - params?: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Import, + patch( + params?: Params$Resource$Projects$Locations$Datastores$Controls$Patch, options?: MethodOptions - ): GaxiosPromise; - import( - params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Import, + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Datastores$Controls$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - import( - params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Import, + patch( + params: Params$Resource$Projects$Locations$Datastores$Controls$Patch, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - import( - params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Import, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Datastores$Controls$Patch, + callback: BodyResponseCallback ): void; - import( - callback: BodyResponseCallback + patch( + callback: BodyResponseCallback ): void; - import( + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Branches$Documents$Import - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Controls$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Branches$Documents$Import; + {}) as Params$Resource$Projects$Locations$Datastores$Controls$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Branches$Documents$Import; + {} as Params$Resource$Projects$Locations$Datastores$Controls$Patch; options = {}; } @@ -22778,90 +25900,162 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/documents:import').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } + } + export interface Params$Resource$Projects$Locations$Datastores$Controls$Create + extends StandardParameters { /** - * Gets a list of Documents. + * Required. The ID to use for the Control, which will become the final component of the Control's resource name. This value must be within 1-63 characters. Valid characters are /a-z-_/. + */ + controlId?: string; + /** + * Required. Full resource name of parent data store. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/dataStores/{data_store_id\}` or `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/engines/{engine_id\}`. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaControl; + } + export interface Params$Resource$Projects$Locations$Datastores$Controls$Delete + extends StandardParameters { + /** + * Required. The resource name of the Control to delete. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/dataStores/{data_store_id\}/controls/{control_id\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Datastores$Controls$Get + extends StandardParameters { + /** + * Required. The resource name of the Control to get. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/dataStores/{data_store_id\}/controls/{control_id\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Datastores$Controls$List + extends StandardParameters { + /** + * Optional. A filter to apply on the list results. Supported features: * List all the products under the parent branch if filter is unset. Currently this field is unsupported. + */ + filter?: string; + /** + * Optional. Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000. + */ + pageSize?: number; + /** + * Optional. A page token, received from a previous `ListControls` call. Provide this to retrieve the subsequent page. + */ + pageToken?: string; + /** + * Required. The data store resource name. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/dataStores/{data_store_id\}` or `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/engines/{engine_id\}`. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Datastores$Controls$Patch + extends StandardParameters { + /** + * Immutable. Fully qualified name `projects/x/locations/global/dataStore/x/controls/x` + */ + name?: string; + /** + * Optional. Indicates which fields in the provided Control to update. The following are NOT supported: * Control.name * Control.solution_type If not set or empty, all supported fields are updated. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaControl; + } + + export class Resource$Projects$Locations$Datastores$Conversations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Converses a conversation. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$List, + converse( + params: Params$Resource$Projects$Locations$Datastores$Conversations$Converse, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Datastores$Branches$Documents$List, + converse( + params?: Params$Resource$Projects$Locations$Datastores$Conversations$Converse, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$List, + ): GaxiosPromise; + converse( + params: Params$Resource$Projects$Locations$Datastores$Conversations$Converse, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$List, + converse( + params: Params$Resource$Projects$Locations$Datastores$Conversations$Converse, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$List, - callback: BodyResponseCallback + converse( + params: Params$Resource$Projects$Locations$Datastores$Conversations$Converse, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + converse( + callback: BodyResponseCallback ): void; - list( + converse( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Branches$Documents$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Conversations$Converse + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Branches$Documents$List; + {}) as Params$Resource$Projects$Locations$Datastores$Conversations$Converse; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Branches$Documents$List; + {} as Params$Resource$Projects$Locations$Datastores$Conversations$Converse; options = {}; } @@ -22875,92 +26069,92 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/documents').replace( + url: (rootUrl + '/v1alpha/{+name}:converse').replace( /([^:]\/)\/+/g, '$1' ), - method: 'GET', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Updates a Document. + * Creates a Conversation. If the Conversation to create already exists, an ALREADY_EXISTS error is returned. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - patch( - params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Patch, + create( + params: Params$Resource$Projects$Locations$Datastores$Conversations$Create, options: StreamMethodOptions ): GaxiosPromise; - patch( - params?: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Patch, + create( + params?: Params$Resource$Projects$Locations$Datastores$Conversations$Create, options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Patch, + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Datastores$Conversations$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Patch, + create( + params: Params$Resource$Projects$Locations$Datastores$Conversations$Create, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Patch, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Datastores$Conversations$Create, + callback: BodyResponseCallback ): void; - patch( - callback: BodyResponseCallback + create( + callback: BodyResponseCallback ): void; - patch( + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Branches$Documents$Patch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Conversations$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Branches$Documents$Patch; + {}) as Params$Resource$Projects$Locations$Datastores$Conversations$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Branches$Documents$Patch; + {} as Params$Resource$Projects$Locations$Datastores$Conversations$Create; options = {}; } @@ -22974,89 +26168,88 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + url: (rootUrl + '/v1alpha/{+parent}/conversations').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * 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. + * Deletes a Conversation. If the Conversation to delete does not exist, a NOT_FOUND error is returned. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - purge( - params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Purge, + delete( + params: Params$Resource$Projects$Locations$Datastores$Conversations$Delete, options: StreamMethodOptions ): GaxiosPromise; - purge( - params?: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Purge, + delete( + params?: Params$Resource$Projects$Locations$Datastores$Conversations$Delete, options?: MethodOptions - ): GaxiosPromise; - purge( - params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Purge, + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Datastores$Conversations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - purge( - params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Purge, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - purge( - params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Purge, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Datastores$Conversations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - purge( - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Datastores$Conversations$Delete, + callback: BodyResponseCallback ): void; - purge( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Branches$Documents$Purge - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Conversations$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Branches$Documents$Purge; + {}) as Params$Resource$Projects$Locations$Datastores$Conversations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Branches$Documents$Purge; + {} as Params$Resource$Projects$Locations$Datastores$Conversations$Delete; options = {}; } @@ -23070,144 +26263,29 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/documents:purge').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Projects$Locations$Datastores$Branches$Documents$Create - extends StandardParameters { - /** - * Required. The ID to use for the Document, which becomes the final component of the Document.name. If the caller does not have permission to create the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. This field must be unique among all Documents with the same parent. Otherwise, an `ALREADY_EXISTS` error is returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. - */ - documentId?: string; - /** - * Required. The parent resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}`. - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaDocument; - } - export interface Params$Resource$Projects$Locations$Datastores$Branches$Documents$Delete - extends StandardParameters { - /** - * Required. Full resource name of Document, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}/documents/{document\}`. If the caller does not have permission to delete the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the Document to delete does not exist, a `NOT_FOUND` error is returned. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Datastores$Branches$Documents$Get - extends StandardParameters { - /** - * Required. Full resource name of Document, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}/documents/{document\}`. If the caller does not have permission to access the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the requested Document does not exist, a `NOT_FOUND` error is returned. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Datastores$Branches$Documents$Getprocesseddocument - extends StandardParameters { - /** - * Required. Full resource name of Document, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}/documents/{document\}`. If the caller does not have permission to access the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the requested Document does not exist, a `NOT_FOUND` error is returned. - */ - name?: string; - /** - * What format output should be. If unspecified, defaults to JSON. - */ - processedDocumentFormat?: string; - /** - * Required. What type of processing to return. - */ - processedDocumentType?: string; - } - export interface Params$Resource$Projects$Locations$Datastores$Branches$Documents$Import - extends StandardParameters { - /** - * Required. The parent branch resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}`. Requires create/update permission. - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaImportDocumentsRequest; - } - export interface Params$Resource$Projects$Locations$Datastores$Branches$Documents$List - extends StandardParameters { - /** - * Maximum number of Documents to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 are set to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned. - */ - pageSize?: number; - /** - * A page token ListDocumentsResponse.next_page_token, received from a previous DocumentService.ListDocuments call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to DocumentService.ListDocuments must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned. - */ - pageToken?: string; - /** - * Required. The parent branch resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}`. Use `default_branch` as the branch ID, to list documents under the default branch. If the caller does not have permission to list Documents under this branch, regardless of whether or not this branch exists, a `PERMISSION_DENIED` error is returned. - */ - parent?: string; - } - export interface Params$Resource$Projects$Locations$Datastores$Branches$Documents$Patch - extends StandardParameters { - /** - * If set to `true` and the Document is not found, a new Document is be created. - */ - allowMissing?: boolean; - /** - * 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?: string; - /** - * Indicates which fields in the provided imported 'document' to update. If not set, by default updates all fields. - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaDocument; - } - export interface Params$Resource$Projects$Locations$Datastores$Branches$Documents$Purge - extends StandardParameters { - /** - * Required. The parent resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}`. - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaPurgeDocumentsRequest; - } - - export class Resource$Projects$Locations$Datastores$Branches$Documents$Chunks { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Gets a Document. + * Gets a Conversation. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -23215,57 +26293,57 @@ export namespace discoveryengine_v1alpha { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Chunks$Get, + params: Params$Resource$Projects$Locations$Datastores$Conversations$Get, options: StreamMethodOptions ): GaxiosPromise; get( - params?: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Chunks$Get, + params?: Params$Resource$Projects$Locations$Datastores$Conversations$Get, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; get( - params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Chunks$Get, + params: Params$Resource$Projects$Locations$Datastores$Conversations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Chunks$Get, + params: Params$Resource$Projects$Locations$Datastores$Conversations$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Chunks$Get, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Datastores$Conversations$Get, + callback: BodyResponseCallback ): void; get( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Branches$Documents$Chunks$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Conversations$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Branches$Documents$Chunks$Get; + {}) as Params$Resource$Projects$Locations$Datastores$Conversations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Branches$Documents$Chunks$Get; + {} as Params$Resource$Projects$Locations$Datastores$Conversations$Get; options = {}; } @@ -23291,19 +26369,19 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Gets a list of Chunks. + * Lists all Conversations by their parent DataStore. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -23311,57 +26389,57 @@ export namespace discoveryengine_v1alpha { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Chunks$List, + params: Params$Resource$Projects$Locations$Datastores$Conversations$List, options: StreamMethodOptions ): GaxiosPromise; list( - params?: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Chunks$List, + params?: Params$Resource$Projects$Locations$Datastores$Conversations$List, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; list( - params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Chunks$List, + params: Params$Resource$Projects$Locations$Datastores$Conversations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Chunks$List, + params: Params$Resource$Projects$Locations$Datastores$Conversations$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Chunks$List, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Datastores$Conversations$List, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Branches$Documents$Chunks$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Conversations$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Branches$Documents$Chunks$List; + {}) as Params$Resource$Projects$Locations$Datastores$Conversations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Branches$Documents$Chunks$List; + {} as Params$Resource$Projects$Locations$Datastores$Conversations$List; options = {}; } @@ -23375,7 +26453,7 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/chunks').replace( + url: (rootUrl + '/v1alpha/{+parent}/conversations').replace( /([^:]\/)\/+/g, '$1' ), @@ -23390,103 +26468,77 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } - } - - export interface Params$Resource$Projects$Locations$Datastores$Branches$Documents$Chunks$Get - extends StandardParameters { - /** - * Required. Full resource name of Chunk, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}/documents/{document\}/chunks/{chunk\}`. If the caller does not have permission to access the Chunk, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the requested Chunk does not exist, a `NOT_FOUND` error is returned. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Datastores$Branches$Documents$Chunks$List - extends StandardParameters { - /** - * Maximum number of Chunks to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned. - */ - pageSize?: number; - /** - * A page token ListChunksResponse.next_page_token, received from a previous ChunkService.ListChunks call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ChunkService.ListChunks must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned. - */ - pageToken?: string; - /** - * Required. The parent document resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}/documents/{document\}`. If the caller does not have permission to list Chunks under this document, regardless of whether or not this document exists, a `PERMISSION_DENIED` error is returned. - */ - parent?: string; - } - - export class Resource$Projects$Locations$Datastores$Branches$Operations { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * 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`. + * Updates a Conversation. Conversation action type cannot be changed. If the Conversation to update does not exist, a NOT_FOUND error is returned. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - cancel( - params: Params$Resource$Projects$Locations$Datastores$Branches$Operations$Cancel, + patch( + params: Params$Resource$Projects$Locations$Datastores$Conversations$Patch, options: StreamMethodOptions ): GaxiosPromise; - cancel( - params?: Params$Resource$Projects$Locations$Datastores$Branches$Operations$Cancel, + patch( + params?: Params$Resource$Projects$Locations$Datastores$Conversations$Patch, options?: MethodOptions - ): GaxiosPromise; - cancel( - params: Params$Resource$Projects$Locations$Datastores$Branches$Operations$Cancel, + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Datastores$Conversations$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Projects$Locations$Datastores$Branches$Operations$Cancel, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Datastores$Conversations$Patch, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Projects$Locations$Datastores$Branches$Operations$Cancel, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Datastores$Conversations$Patch, + callback: BodyResponseCallback ): void; - cancel(callback: BodyResponseCallback): void; - cancel( + patch( + callback: BodyResponseCallback + ): void; + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Branches$Operations$Cancel - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Conversations$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Branches$Operations$Cancel; + {}) as Params$Resource$Projects$Locations$Datastores$Conversations$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Branches$Operations$Cancel; + {} as Params$Resource$Projects$Locations$Datastores$Conversations$Patch; options = {}; } @@ -23500,11 +26552,8 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}:cancel').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', apiVersion: '', }, options @@ -23515,14 +26564,113 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } + } + + export interface Params$Resource$Projects$Locations$Datastores$Conversations$Converse + extends StandardParameters { + /** + * Required. The resource name of the Conversation to get. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/{conversation_id\}`. Use `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/-` to activate auto session mode, which automatically creates a new conversation inside a ConverseConversation session. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaConverseConversationRequest; + } + export interface Params$Resource$Projects$Locations$Datastores$Conversations$Create + extends StandardParameters { + /** + * Required. Full resource name of parent data store. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaConversation; + } + export interface Params$Resource$Projects$Locations$Datastores$Conversations$Delete + extends StandardParameters { + /** + * Required. The resource name of the Conversation to delete. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/{conversation_id\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Datastores$Conversations$Get + extends StandardParameters { + /** + * Required. The resource name of the Conversation to get. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/{conversation_id\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Datastores$Conversations$List + extends StandardParameters { + /** + * A filter to apply on the list results. The supported features are: user_pseudo_id, state. Example: "user_pseudo_id = some_id" + */ + filter?: string; + /** + * 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` * `conversation_name` Example: "update_time desc" "create_time" + */ + orderBy?: string; + /** + * Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000. + */ + pageSize?: number; + /** + * A page token, received from a previous `ListConversations` call. Provide this to retrieve the subsequent page. + */ + pageToken?: string; + /** + * Required. The data store resource name. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}` + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Datastores$Conversations$Patch + extends StandardParameters { + /** + * Immutable. Fully qualified name `projects/{project\}/locations/global/collections/{collection\}/dataStore/x/conversations/x` or `projects/{project\}/locations/global/collections/{collection\}/engines/x/conversations/x`. + */ + name?: string; + /** + * Indicates which fields in the provided Conversation to update. The following are NOT supported: * Conversation.name If not set or empty, all supported fields are updated. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaConversation; + } + + export class Resource$Projects$Locations$Datastores$Models { + context: APIRequestContext; + operations: Resource$Projects$Locations$Datastores$Models$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.operations = + new Resource$Projects$Locations$Datastores$Models$Operations( + this.context + ); + } + } + + export class Resource$Projects$Locations$Datastores$Models$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } /** * 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. @@ -23533,27 +26681,27 @@ export namespace discoveryengine_v1alpha { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Datastores$Branches$Operations$Get, + params: Params$Resource$Projects$Locations$Datastores$Models$Operations$Get, options: StreamMethodOptions ): GaxiosPromise; get( - params?: Params$Resource$Projects$Locations$Datastores$Branches$Operations$Get, + params?: Params$Resource$Projects$Locations$Datastores$Models$Operations$Get, options?: MethodOptions ): GaxiosPromise; get( - params: Params$Resource$Projects$Locations$Datastores$Branches$Operations$Get, + params: Params$Resource$Projects$Locations$Datastores$Models$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Datastores$Branches$Operations$Get, + params: Params$Resource$Projects$Locations$Datastores$Models$Operations$Get, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Datastores$Branches$Operations$Get, + params: Params$Resource$Projects$Locations$Datastores$Models$Operations$Get, callback: BodyResponseCallback ): void; get( @@ -23561,7 +26709,7 @@ export namespace discoveryengine_v1alpha { ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Branches$Operations$Get + | Params$Resource$Projects$Locations$Datastores$Models$Operations$Get | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -23577,13 +26725,13 @@ export namespace discoveryengine_v1alpha { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Branches$Operations$Get; + {}) as Params$Resource$Projects$Locations$Datastores$Models$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Branches$Operations$Get; + {} as Params$Resource$Projects$Locations$Datastores$Models$Operations$Get; options = {}; } @@ -23627,27 +26775,27 @@ export namespace discoveryengine_v1alpha { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Datastores$Branches$Operations$List, + params: Params$Resource$Projects$Locations$Datastores$Models$Operations$List, options: StreamMethodOptions ): GaxiosPromise; list( - params?: Params$Resource$Projects$Locations$Datastores$Branches$Operations$List, + params?: Params$Resource$Projects$Locations$Datastores$Models$Operations$List, options?: MethodOptions ): GaxiosPromise; list( - params: Params$Resource$Projects$Locations$Datastores$Branches$Operations$List, + params: Params$Resource$Projects$Locations$Datastores$Models$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Datastores$Branches$Operations$List, + params: Params$Resource$Projects$Locations$Datastores$Models$Operations$List, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Datastores$Branches$Operations$List, + params: Params$Resource$Projects$Locations$Datastores$Models$Operations$List, callback: BodyResponseCallback ): void; list( @@ -23655,7 +26803,7 @@ export namespace discoveryengine_v1alpha { ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Branches$Operations$List + | Params$Resource$Projects$Locations$Datastores$Models$Operations$List | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -23671,13 +26819,13 @@ export namespace discoveryengine_v1alpha { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Branches$Operations$List; + {}) as Params$Resource$Projects$Locations$Datastores$Models$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Branches$Operations$List; + {} as Params$Resource$Projects$Locations$Datastores$Models$Operations$List; options = {}; } @@ -23718,26 +26866,14 @@ export namespace discoveryengine_v1alpha { } } - export interface Params$Resource$Projects$Locations$Datastores$Branches$Operations$Cancel - extends StandardParameters { - /** - * The name of the operation resource to be cancelled. - */ - name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleLongrunningCancelOperationRequest; - } - export interface Params$Resource$Projects$Locations$Datastores$Branches$Operations$Get + export interface Params$Resource$Projects$Locations$Datastores$Models$Operations$Get extends StandardParameters { /** * The name of the operation resource. */ name?: string; } - export interface Params$Resource$Projects$Locations$Datastores$Branches$Operations$List + export interface Params$Resource$Projects$Locations$Datastores$Models$Operations$List extends StandardParameters { /** * The standard list filter. @@ -23757,50 +26893,50 @@ export namespace discoveryengine_v1alpha { pageToken?: string; } - export class Resource$Projects$Locations$Datastores$Completionsuggestions { + export class Resource$Projects$Locations$Datastores$Operations { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * Imports CompletionSuggestions for a DataStore. + * 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. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - import( - params: Params$Resource$Projects$Locations$Datastores$Completionsuggestions$Import, + get( + params: Params$Resource$Projects$Locations$Datastores$Operations$Get, options: StreamMethodOptions ): GaxiosPromise; - import( - params?: Params$Resource$Projects$Locations$Datastores$Completionsuggestions$Import, + get( + params?: Params$Resource$Projects$Locations$Datastores$Operations$Get, options?: MethodOptions ): GaxiosPromise; - import( - params: Params$Resource$Projects$Locations$Datastores$Completionsuggestions$Import, + get( + params: Params$Resource$Projects$Locations$Datastores$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - import( - params: Params$Resource$Projects$Locations$Datastores$Completionsuggestions$Import, + get( + params: Params$Resource$Projects$Locations$Datastores$Operations$Get, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - import( - params: Params$Resource$Projects$Locations$Datastores$Completionsuggestions$Import, + get( + params: Params$Resource$Projects$Locations$Datastores$Operations$Get, callback: BodyResponseCallback ): void; - import( + get( callback: BodyResponseCallback ): void; - import( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Completionsuggestions$Import + | Params$Resource$Projects$Locations$Datastores$Operations$Get | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -23816,13 +26952,13 @@ export namespace discoveryengine_v1alpha { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Completionsuggestions$Import; + {}) as Params$Resource$Projects$Locations$Datastores$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Completionsuggestions$Import; + {} as Params$Resource$Projects$Locations$Datastores$Operations$Get; options = {}; } @@ -23836,17 +26972,15 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: ( - rootUrl + '/v1alpha/{+parent}/completionSuggestions:import' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { @@ -23860,65 +26994,65 @@ export namespace discoveryengine_v1alpha { } /** - * Permanently deletes all CompletionSuggestions for a DataStore. + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - purge( - params: Params$Resource$Projects$Locations$Datastores$Completionsuggestions$Purge, + list( + params: Params$Resource$Projects$Locations$Datastores$Operations$List, options: StreamMethodOptions ): GaxiosPromise; - purge( - params?: Params$Resource$Projects$Locations$Datastores$Completionsuggestions$Purge, + list( + params?: Params$Resource$Projects$Locations$Datastores$Operations$List, options?: MethodOptions - ): GaxiosPromise; - purge( - params: Params$Resource$Projects$Locations$Datastores$Completionsuggestions$Purge, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Datastores$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - purge( - params: Params$Resource$Projects$Locations$Datastores$Completionsuggestions$Purge, + list( + params: Params$Resource$Projects$Locations$Datastores$Operations$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - purge( - params: Params$Resource$Projects$Locations$Datastores$Completionsuggestions$Purge, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Datastores$Operations$List, + callback: BodyResponseCallback ): void; - purge( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - purge( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Completionsuggestions$Purge - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Operations$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Completionsuggestions$Purge; + {}) as Params$Resource$Projects$Locations$Datastores$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Completionsuggestions$Purge; + {} as Params$Resource$Projects$Locations$Datastores$Operations$List; options = {}; } @@ -23932,63 +27066,68 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: ( - rootUrl + '/v1alpha/{+parent}/completionSuggestions:purge' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + url: (rootUrl + '/v1alpha/{+name}/operations').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } } - export interface Params$Resource$Projects$Locations$Datastores$Completionsuggestions$Import + export interface Params$Resource$Projects$Locations$Datastores$Operations$Get extends StandardParameters { /** - * Required. The parent data store resource name for which to import customer autocomplete suggestions. Follows pattern `projects/x/locations/x/collections/x/dataStores/x` - */ - parent?: string; - - /** - * Request body metadata + * The name of the operation resource. */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaImportCompletionSuggestionsRequest; + name?: string; } - export interface Params$Resource$Projects$Locations$Datastores$Completionsuggestions$Purge + export interface Params$Resource$Projects$Locations$Datastores$Operations$List extends StandardParameters { /** - * Required. The parent data store resource name for which to purge completion suggestions. Follows pattern projects/x/locations/x/collections/x/dataStores/x. + * The standard list filter. */ - parent?: string; - + filter?: string; /** - * Request body metadata + * The name of the operation's parent resource. */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaPurgeCompletionSuggestionsRequest; + name?: string; + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. + */ + pageToken?: string; } - export class Resource$Projects$Locations$Datastores$Controls { + export class Resource$Projects$Locations$Datastores$Schemas { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * 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. + * Creates a Schema. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -23996,57 +27135,57 @@ export namespace discoveryengine_v1alpha { * @returns A promise if used with async/await, or void if used with a callback. */ create( - params: Params$Resource$Projects$Locations$Datastores$Controls$Create, + params: Params$Resource$Projects$Locations$Datastores$Schemas$Create, options: StreamMethodOptions ): GaxiosPromise; create( - params?: Params$Resource$Projects$Locations$Datastores$Controls$Create, + params?: Params$Resource$Projects$Locations$Datastores$Schemas$Create, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; create( - params: Params$Resource$Projects$Locations$Datastores$Controls$Create, + params: Params$Resource$Projects$Locations$Datastores$Schemas$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; create( - params: Params$Resource$Projects$Locations$Datastores$Controls$Create, + params: Params$Resource$Projects$Locations$Datastores$Schemas$Create, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; create( - params: Params$Resource$Projects$Locations$Datastores$Controls$Create, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Datastores$Schemas$Create, + callback: BodyResponseCallback ): void; create( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Controls$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Schemas$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Controls$Create; + {}) as Params$Resource$Projects$Locations$Datastores$Schemas$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Controls$Create; + {} as Params$Resource$Projects$Locations$Datastores$Schemas$Create; options = {}; } @@ -24060,7 +27199,7 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/controls').replace( + url: (rootUrl + '/v1alpha/{+parent}/schemas').replace( /([^:]\/)\/+/g, '$1' ), @@ -24075,19 +27214,17 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Deletes a Control. If the Control to delete does not exist, a NOT_FOUND error is returned. + * Deletes a Schema. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -24095,53 +27232,57 @@ export namespace discoveryengine_v1alpha { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Datastores$Controls$Delete, + params: Params$Resource$Projects$Locations$Datastores$Schemas$Delete, options: StreamMethodOptions ): GaxiosPromise; delete( - params?: Params$Resource$Projects$Locations$Datastores$Controls$Delete, + params?: Params$Resource$Projects$Locations$Datastores$Schemas$Delete, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; delete( - params: Params$Resource$Projects$Locations$Datastores$Controls$Delete, + params: Params$Resource$Projects$Locations$Datastores$Schemas$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Datastores$Controls$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Datastores$Schemas$Delete, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Datastores$Controls$Delete, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Datastores$Schemas$Delete, + callback: BodyResponseCallback + ): void; + delete( + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Controls$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Schemas$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Controls$Delete; + {}) as Params$Resource$Projects$Locations$Datastores$Schemas$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Controls$Delete; + {} as Params$Resource$Projects$Locations$Datastores$Schemas$Delete; options = {}; } @@ -24167,17 +27308,17 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Gets a Control. + * Gets a Schema. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -24185,57 +27326,57 @@ export namespace discoveryengine_v1alpha { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Datastores$Controls$Get, + params: Params$Resource$Projects$Locations$Datastores$Schemas$Get, options: StreamMethodOptions ): GaxiosPromise; get( - params?: Params$Resource$Projects$Locations$Datastores$Controls$Get, + params?: Params$Resource$Projects$Locations$Datastores$Schemas$Get, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; get( - params: Params$Resource$Projects$Locations$Datastores$Controls$Get, + params: Params$Resource$Projects$Locations$Datastores$Schemas$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Datastores$Controls$Get, + params: Params$Resource$Projects$Locations$Datastores$Schemas$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Datastores$Controls$Get, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Datastores$Schemas$Get, + callback: BodyResponseCallback ): void; get( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Controls$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Schemas$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Controls$Get; + {}) as Params$Resource$Projects$Locations$Datastores$Schemas$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Controls$Get; + {} as Params$Resource$Projects$Locations$Datastores$Schemas$Get; options = {}; } @@ -24261,19 +27402,19 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Lists all Controls by their parent DataStore. + * Gets a list of Schemas. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -24281,57 +27422,57 @@ export namespace discoveryengine_v1alpha { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Datastores$Controls$List, + params: Params$Resource$Projects$Locations$Datastores$Schemas$List, options: StreamMethodOptions ): GaxiosPromise; list( - params?: Params$Resource$Projects$Locations$Datastores$Controls$List, + params?: Params$Resource$Projects$Locations$Datastores$Schemas$List, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; list( - params: Params$Resource$Projects$Locations$Datastores$Controls$List, + params: Params$Resource$Projects$Locations$Datastores$Schemas$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Datastores$Controls$List, + params: Params$Resource$Projects$Locations$Datastores$Schemas$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Datastores$Controls$List, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Datastores$Schemas$List, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Controls$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Schemas$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Controls$List; + {}) as Params$Resource$Projects$Locations$Datastores$Schemas$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Controls$List; + {} as Params$Resource$Projects$Locations$Datastores$Schemas$List; options = {}; } @@ -24345,7 +27486,7 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/controls').replace( + url: (rootUrl + '/v1alpha/{+parent}/schemas').replace( /([^:]\/)\/+/g, '$1' ), @@ -24360,77 +27501,240 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Updates a Control. Control action type cannot be changed. If the Control to update does not exist, a NOT_FOUND error is returned. + * Updates a Schema. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + patch( + params: Params$Resource$Projects$Locations$Datastores$Schemas$Patch, + options: StreamMethodOptions + ): GaxiosPromise; + patch( + params?: Params$Resource$Projects$Locations$Datastores$Schemas$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Datastores$Schemas$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Datastores$Schemas$Patch, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Datastores$Schemas$Patch, + callback: BodyResponseCallback + ): void; + patch( + callback: BodyResponseCallback + ): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Datastores$Schemas$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Datastores$Schemas$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Datastores$Schemas$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Datastores$Schemas$Create + extends StandardParameters { + /** + * Required. The parent data store resource name, in the format of `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}`. + */ + parent?: string; + /** + * Required. The ID to use for the Schema, which becomes the final component of the Schema.name. This field should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. + */ + schemaId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaSchema; + } + export interface Params$Resource$Projects$Locations$Datastores$Schemas$Delete + extends StandardParameters { + /** + * Required. The full resource name of the schema, in the format of `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/schemas/{schema\}`. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Datastores$Schemas$Get + extends StandardParameters { + /** + * Required. The full resource name of the schema, in the format of `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/schemas/{schema\}`. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Datastores$Schemas$List + extends StandardParameters { + /** + * The maximum number of Schemas to return. The service may return fewer than this value. If unspecified, at most 100 Schemas are returned. The maximum value is 1000; values above 1000 are set to 1000. + */ + pageSize?: number; + /** + * A page token, received from a previous SchemaService.ListSchemas call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SchemaService.ListSchemas must match the call that provided the page token. + */ + pageToken?: string; + /** + * Required. The parent data store resource name, in the format of `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}`. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Datastores$Schemas$Patch + extends StandardParameters { + /** + * If set to true, and the Schema is not found, a new Schema is created. In this situation, `update_mask` is ignored. + */ + allowMissing?: boolean; + /** + * 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. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaSchema; + } + + export class Resource$Projects$Locations$Datastores$Servingconfigs { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Answer query method. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - patch( - params: Params$Resource$Projects$Locations$Datastores$Controls$Patch, + answer( + params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Answer, options: StreamMethodOptions ): GaxiosPromise; - patch( - params?: Params$Resource$Projects$Locations$Datastores$Controls$Patch, + answer( + params?: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Answer, options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Projects$Locations$Datastores$Controls$Patch, + ): GaxiosPromise; + answer( + params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Answer, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Datastores$Controls$Patch, + answer( + params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Answer, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Datastores$Controls$Patch, - callback: BodyResponseCallback + answer( + params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Answer, + callback: BodyResponseCallback ): void; - patch( - callback: BodyResponseCallback + answer( + callback: BodyResponseCallback ): void; - patch( + answer( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Controls$Patch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Servingconfigs$Answer + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Controls$Patch; + {}) as Params$Resource$Projects$Locations$Datastores$Servingconfigs$Answer; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Controls$Patch; + {} as Params$Resource$Projects$Locations$Datastores$Servingconfigs$Answer; options = {}; } @@ -24444,162 +27748,92 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + url: (rootUrl + '/v1alpha/{+servingConfig}:answer').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['servingConfig'], + pathParams: ['servingConfig'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } - } - - export interface Params$Resource$Projects$Locations$Datastores$Controls$Create - extends StandardParameters { - /** - * Required. The ID to use for the Control, which will become the final component of the Control's resource name. This value must be within 1-63 characters. Valid characters are /a-z-_/. - */ - controlId?: string; - /** - * Required. Full resource name of parent data store. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/dataStores/{data_store_id\}` or `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/engines/{engine_id\}`. - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaControl; - } - export interface Params$Resource$Projects$Locations$Datastores$Controls$Delete - extends StandardParameters { - /** - * Required. The resource name of the Control to delete. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/dataStores/{data_store_id\}/controls/{control_id\}` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Datastores$Controls$Get - extends StandardParameters { - /** - * Required. The resource name of the Control to get. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/dataStores/{data_store_id\}/controls/{control_id\}` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Datastores$Controls$List - extends StandardParameters { - /** - * Optional. A filter to apply on the list results. Supported features: * List all the products under the parent branch if filter is unset. Currently this field is unsupported. - */ - filter?: string; - /** - * Optional. Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000. - */ - pageSize?: number; - /** - * Optional. A page token, received from a previous `ListControls` call. Provide this to retrieve the subsequent page. - */ - pageToken?: string; - /** - * Required. The data store resource name. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/dataStores/{data_store_id\}` or `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/engines/{engine_id\}`. - */ - parent?: string; - } - export interface Params$Resource$Projects$Locations$Datastores$Controls$Patch - extends StandardParameters { - /** - * Immutable. Fully qualified name `projects/x/locations/global/dataStore/x/controls/x` - */ - name?: string; - /** - * Optional. Indicates which fields in the provided Control to update. The following are NOT supported: * Control.name * Control.solution_type If not set or empty, all supported fields are updated. - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaControl; - } - - export class Resource$Projects$Locations$Datastores$Conversations { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Converses a conversation. + * Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not exist. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - converse( - params: Params$Resource$Projects$Locations$Datastores$Conversations$Converse, + get( + params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Get, options: StreamMethodOptions ): GaxiosPromise; - converse( - params?: Params$Resource$Projects$Locations$Datastores$Conversations$Converse, + get( + params?: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Get, options?: MethodOptions - ): GaxiosPromise; - converse( - params: Params$Resource$Projects$Locations$Datastores$Conversations$Converse, + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - converse( - params: Params$Resource$Projects$Locations$Datastores$Conversations$Converse, + get( + params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - converse( - params: Params$Resource$Projects$Locations$Datastores$Conversations$Converse, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Get, + callback: BodyResponseCallback ): void; - converse( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - converse( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Conversations$Converse - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Servingconfigs$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Conversations$Converse; + {}) as Params$Resource$Projects$Locations$Datastores$Servingconfigs$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Conversations$Converse; + {} as Params$Resource$Projects$Locations$Datastores$Servingconfigs$Get; options = {}; } @@ -24613,11 +27847,8 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}:converse').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options @@ -24628,77 +27859,77 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Creates a Conversation. If the Conversation to create already exists, an ALREADY_EXISTS error is returned. + * Lists all ServingConfigs linked to this dataStore. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - create( - params: Params$Resource$Projects$Locations$Datastores$Conversations$Create, + list( + params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$List, options: StreamMethodOptions ): GaxiosPromise; - create( - params?: Params$Resource$Projects$Locations$Datastores$Conversations$Create, + list( + params?: Params$Resource$Projects$Locations$Datastores$Servingconfigs$List, options?: MethodOptions - ): GaxiosPromise; - create( - params: Params$Resource$Projects$Locations$Datastores$Conversations$Create, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Datastores$Conversations$Create, + list( + params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Datastores$Conversations$Create, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$List, + callback: BodyResponseCallback ): void; - create( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - create( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Conversations$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Servingconfigs$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Conversations$Create; + {}) as Params$Resource$Projects$Locations$Datastores$Servingconfigs$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Conversations$Create; + {} as Params$Resource$Projects$Locations$Datastores$Servingconfigs$List; options = {}; } @@ -24712,11 +27943,11 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/conversations').replace( + url: (rootUrl + '/v1alpha/{+parent}/servingConfigs').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', apiVersion: '', }, options @@ -24727,73 +27958,77 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Deletes a Conversation. If the Conversation to delete does not exist, a NOT_FOUND error is returned. + * Updates a ServingConfig. Returns a NOT_FOUND error if the ServingConfig does not exist. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - delete( - params: Params$Resource$Projects$Locations$Datastores$Conversations$Delete, + patch( + params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Patch, options: StreamMethodOptions ): GaxiosPromise; - delete( - params?: Params$Resource$Projects$Locations$Datastores$Conversations$Delete, + patch( + params?: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Patch, options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Projects$Locations$Datastores$Conversations$Delete, + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Datastores$Conversations$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Patch, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Datastores$Conversations$Delete, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Patch, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + patch( + callback: BodyResponseCallback + ): void; + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Conversations$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Servingconfigs$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Conversations$Delete; + {}) as Params$Resource$Projects$Locations$Datastores$Servingconfigs$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Conversations$Delete; + {} as Params$Resource$Projects$Locations$Datastores$Servingconfigs$Patch; options = {}; } @@ -24808,7 +28043,7 @@ export namespace discoveryengine_v1alpha { options: Object.assign( { url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + method: 'PATCH', apiVersion: '', }, options @@ -24819,75 +28054,77 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Gets a Conversation. + * Makes a recommendation, which requires a contextual user event. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Datastores$Conversations$Get, + recommend( + params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Recommend, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Datastores$Conversations$Get, + recommend( + params?: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Recommend, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Datastores$Conversations$Get, + ): GaxiosPromise; + recommend( + params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Recommend, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Datastores$Conversations$Get, + recommend( + params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Recommend, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Datastores$Conversations$Get, - callback: BodyResponseCallback + recommend( + params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Recommend, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + recommend( + callback: BodyResponseCallback ): void; - get( + recommend( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Conversations$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Servingconfigs$Recommend + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Conversations$Get; + {}) as Params$Resource$Projects$Locations$Datastores$Servingconfigs$Recommend; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Conversations$Get; + {} as Params$Resource$Projects$Locations$Datastores$Servingconfigs$Recommend; options = {}; } @@ -24901,89 +28138,92 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1alpha/{+servingConfig}:recommend').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['servingConfig'], + pathParams: ['servingConfig'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Lists all Conversations by their parent DataStore. + * Performs a search. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Datastores$Conversations$List, + search( + params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Search, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Datastores$Conversations$List, + search( + params?: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Search, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Datastores$Conversations$List, + ): GaxiosPromise; + search( + params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Search, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Datastores$Conversations$List, + search( + params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Search, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Datastores$Conversations$List, - callback: BodyResponseCallback + search( + params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Search, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + search( + callback: BodyResponseCallback ): void; - list( + search( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Conversations$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Servingconfigs$Search + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Conversations$List; + {}) as Params$Resource$Projects$Locations$Datastores$Servingconfigs$Search; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Conversations$List; + {} as Params$Resource$Projects$Locations$Datastores$Servingconfigs$Search; options = {}; } @@ -24997,92 +28237,179 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/conversations').replace( + url: (rootUrl + '/v1alpha/{+servingConfig}:search').replace( /([^:]\/)\/+/g, '$1' ), - method: 'GET', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['servingConfig'], + pathParams: ['servingConfig'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); - } + } + } + } + + export interface Params$Resource$Projects$Locations$Datastores$Servingconfigs$Answer + extends StandardParameters { + /** + * Required. The resource name of the Search serving config, such as `projects/x/locations/global/collections/default_collection/engines/x/servingConfigs/default_serving_config`, or `projects/x/locations/global/collections/default_collection/dataStores/x/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. + */ + servingConfig?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaAnswerQueryRequest; + } + export interface Params$Resource$Projects$Locations$Datastores$Servingconfigs$Get + extends StandardParameters { + /** + * Required. The resource name of the ServingConfig to get. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/engines/{engine\}/servingConfigs/{serving_config_id\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Datastores$Servingconfigs$List + extends StandardParameters { + /** + * Optional. Maximum number of results to return. If unspecified, defaults to 100. If a value greater than 100 is provided, at most 100 results are returned. + */ + pageSize?: number; + /** + * Optional. A page token, received from a previous `ListServingConfigs` call. Provide this to retrieve the subsequent page. + */ + pageToken?: string; + /** + * Required. Full resource name of the parent resource. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/engines/{engine\}` + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Datastores$Servingconfigs$Patch + extends StandardParameters { + /** + * Immutable. Fully qualified name `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}/servingConfigs/{serving_config_id\}` + */ + name?: string; + /** + * Indicates which fields in the provided ServingConfig to update. The following are NOT supported: * ServingConfig.name If not set, all supported fields are updated. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaServingConfig; + } + export interface Params$Resource$Projects$Locations$Datastores$Servingconfigs$Recommend + extends StandardParameters { + /** + * Required. Full resource name of a ServingConfig: `projects/x/locations/global/collections/x/engines/x/servingConfigs/x`, or `projects/x/locations/global/collections/x/dataStores/x/servingConfigs/x` One default serving config is created along with your recommendation engine creation. The engine ID is used as the ID of the default serving config. For example, for Engine `projects/x/locations/global/collections/x/engines/my-engine`, you can use `projects/x/locations/global/collections/x/engines/my-engine/servingConfigs/my-engine` for your RecommendationService.Recommend requests. + */ + servingConfig?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaRecommendRequest; + } + export interface Params$Resource$Projects$Locations$Datastores$Servingconfigs$Search + extends StandardParameters { + /** + * Required. The resource name of the Search serving config, such as `projects/x/locations/global/collections/default_collection/engines/x/servingConfigs/default_serving_config`, or `projects/x/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. + */ + servingConfig?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequest; + } + + export class Resource$Projects$Locations$Datastores$Sessions { + context: APIRequestContext; + answers: Resource$Projects$Locations$Datastores$Sessions$Answers; + constructor(context: APIRequestContext) { + this.context = context; + this.answers = + new Resource$Projects$Locations$Datastores$Sessions$Answers( + this.context + ); } /** - * Updates a Conversation. Conversation action type cannot be changed. If the Conversation to update does not exist, a NOT_FOUND error is returned. + * Creates a Session. If the Session to create already exists, an ALREADY_EXISTS error is returned. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - patch( - params: Params$Resource$Projects$Locations$Datastores$Conversations$Patch, + create( + params: Params$Resource$Projects$Locations$Datastores$Sessions$Create, options: StreamMethodOptions ): GaxiosPromise; - patch( - params?: Params$Resource$Projects$Locations$Datastores$Conversations$Patch, + create( + params?: Params$Resource$Projects$Locations$Datastores$Sessions$Create, options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Projects$Locations$Datastores$Conversations$Patch, + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Datastores$Sessions$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Datastores$Conversations$Patch, + create( + params: Params$Resource$Projects$Locations$Datastores$Sessions$Create, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Datastores$Conversations$Patch, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Datastores$Sessions$Create, + callback: BodyResponseCallback ): void; - patch( - callback: BodyResponseCallback + create( + callback: BodyResponseCallback ): void; - patch( + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Conversations$Patch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Sessions$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Conversations$Patch; + {}) as Params$Resource$Projects$Locations$Datastores$Sessions$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Conversations$Patch; + {} as Params$Resource$Projects$Locations$Datastores$Sessions$Create; options = {}; } @@ -25096,186 +28423,88 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + url: (rootUrl + '/v1alpha/{+parent}/sessions').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } - } - - export interface Params$Resource$Projects$Locations$Datastores$Conversations$Converse - extends StandardParameters { - /** - * Required. The resource name of the Conversation to get. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/{conversation_id\}`. Use `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/-` to activate auto session mode, which automatically creates a new conversation inside a ConverseConversation session. - */ - name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaConverseConversationRequest; - } - export interface Params$Resource$Projects$Locations$Datastores$Conversations$Create - extends StandardParameters { - /** - * Required. Full resource name of parent data store. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}` - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaConversation; - } - export interface Params$Resource$Projects$Locations$Datastores$Conversations$Delete - extends StandardParameters { - /** - * Required. The resource name of the Conversation to delete. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/{conversation_id\}` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Datastores$Conversations$Get - extends StandardParameters { - /** - * Required. The resource name of the Conversation to get. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/{conversation_id\}` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Datastores$Conversations$List - extends StandardParameters { - /** - * A filter to apply on the list results. The supported features are: user_pseudo_id, state. Example: "user_pseudo_id = some_id" - */ - filter?: string; - /** - * 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` * `conversation_name` Example: "update_time desc" "create_time" - */ - orderBy?: string; - /** - * Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000. - */ - pageSize?: number; - /** - * A page token, received from a previous `ListConversations` call. Provide this to retrieve the subsequent page. - */ - pageToken?: string; - /** - * Required. The data store resource name. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}` - */ - parent?: string; - } - export interface Params$Resource$Projects$Locations$Datastores$Conversations$Patch - extends StandardParameters { - /** - * Immutable. Fully qualified name `projects/{project\}/locations/global/collections/{collection\}/dataStore/x/conversations/x` or `projects/{project\}/locations/global/collections/{collection\}/engines/x/conversations/x`. - */ - name?: string; - /** - * Indicates which fields in the provided Conversation to update. The following are NOT supported: * Conversation.name If not set or empty, all supported fields are updated. - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaConversation; - } - - export class Resource$Projects$Locations$Datastores$Models { - context: APIRequestContext; - operations: Resource$Projects$Locations$Datastores$Models$Operations; - constructor(context: APIRequestContext) { - this.context = context; - this.operations = - new Resource$Projects$Locations$Datastores$Models$Operations( - this.context - ); - } - } - - export class Resource$Projects$Locations$Datastores$Models$Operations { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * 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. + * Deletes a Session. If the Session to delete does not exist, a NOT_FOUND error is returned. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Datastores$Models$Operations$Get, + delete( + params: Params$Resource$Projects$Locations$Datastores$Sessions$Delete, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Datastores$Models$Operations$Get, + delete( + params?: Params$Resource$Projects$Locations$Datastores$Sessions$Delete, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Datastores$Models$Operations$Get, + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Datastores$Sessions$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Datastores$Models$Operations$Get, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Projects$Locations$Datastores$Models$Operations$Get, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Datastores$Sessions$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Datastores$Sessions$Delete, + callback: BodyResponseCallback ): void; - get( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Models$Operations$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Sessions$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Models$Operations$Get; + {}) as Params$Resource$Projects$Locations$Datastores$Sessions$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Models$Operations$Get; + {} as Params$Resource$Projects$Locations$Datastores$Sessions$Delete; options = {}; } @@ -25290,7 +28519,7 @@ export namespace discoveryengine_v1alpha { options: Object.assign( { url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'DELETE', apiVersion: '', }, options @@ -25301,75 +28530,75 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + * Gets a Session. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Datastores$Models$Operations$List, + get( + params: Params$Resource$Projects$Locations$Datastores$Sessions$Get, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Datastores$Models$Operations$List, + get( + params?: Params$Resource$Projects$Locations$Datastores$Sessions$Get, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Datastores$Models$Operations$List, + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Datastores$Sessions$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Datastores$Models$Operations$List, + get( + params: Params$Resource$Projects$Locations$Datastores$Sessions$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Datastores$Models$Operations$List, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Datastores$Sessions$Get, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - list( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Models$Operations$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Sessions$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Models$Operations$List; + {}) as Params$Resource$Projects$Locations$Datastores$Sessions$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Models$Operations$List; + {} as Params$Resource$Projects$Locations$Datastores$Sessions$Get; options = {}; } @@ -25383,10 +28612,7 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}/operations').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', }, @@ -25398,111 +28624,77 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } - } - - export interface Params$Resource$Projects$Locations$Datastores$Models$Operations$Get - extends StandardParameters { - /** - * The name of the operation resource. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Datastores$Models$Operations$List - extends StandardParameters { - /** - * The standard list filter. - */ - filter?: string; - /** - * The name of the operation's parent resource. - */ - name?: string; - /** - * The standard list page size. - */ - pageSize?: number; - /** - * The standard list page token. - */ - pageToken?: string; - } - - export class Resource$Projects$Locations$Datastores$Operations { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * 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. + * Lists all Sessions by their parent DataStore. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Datastores$Operations$Get, + list( + params: Params$Resource$Projects$Locations$Datastores$Sessions$List, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Datastores$Operations$Get, + list( + params?: Params$Resource$Projects$Locations$Datastores$Sessions$List, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Datastores$Operations$Get, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Datastores$Sessions$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Datastores$Operations$Get, + list( + params: Params$Resource$Projects$Locations$Datastores$Sessions$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Datastores$Operations$Get, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Datastores$Sessions$List, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - get( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Operations$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Sessions$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Operations$Get; + {}) as Params$Resource$Projects$Locations$Datastores$Sessions$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Operations$Get; + {} as Params$Resource$Projects$Locations$Datastores$Sessions$List; options = {}; } @@ -25516,87 +28708,92 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1alpha/{+parent}/sessions').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + * Updates a Session. Session action type cannot be changed. If the Session to update does not exist, a NOT_FOUND error is returned. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Datastores$Operations$List, + patch( + params: Params$Resource$Projects$Locations$Datastores$Sessions$Patch, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Datastores$Operations$List, + patch( + params?: Params$Resource$Projects$Locations$Datastores$Sessions$Patch, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Datastores$Operations$List, + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Datastores$Sessions$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Datastores$Operations$List, + patch( + params: Params$Resource$Projects$Locations$Datastores$Sessions$Patch, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Datastores$Operations$List, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Datastores$Sessions$Patch, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + patch( + callback: BodyResponseCallback ): void; - list( + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Operations$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Sessions$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Operations$List; + {}) as Params$Resource$Projects$Locations$Datastores$Sessions$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Operations$List; + {} as Params$Resource$Projects$Locations$Datastores$Sessions$Patch; options = {}; } @@ -25610,11 +28807,8 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}/operations').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', apiVersion: '', }, options @@ -25625,111 +28819,150 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } } - export interface Params$Resource$Projects$Locations$Datastores$Operations$Get + export interface Params$Resource$Projects$Locations$Datastores$Sessions$Create extends StandardParameters { /** - * The name of the operation resource. + * Required. Full resource name of parent data store. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaSession; + } + export interface Params$Resource$Projects$Locations$Datastores$Sessions$Delete + extends StandardParameters { + /** + * Required. The resource name of the Session to delete. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/sessions/{session_id\}` */ name?: string; } - export interface Params$Resource$Projects$Locations$Datastores$Operations$List + export interface Params$Resource$Projects$Locations$Datastores$Sessions$Get extends StandardParameters { /** - * The standard list filter. + * Required. The resource name of the Session to get. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/sessions/{session_id\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Datastores$Sessions$List + extends StandardParameters { + /** + * A filter to apply on the list results. The supported features are: user_pseudo_id, state. Example: "user_pseudo_id = some_id" */ filter?: string; /** - * The name of the operation's parent resource. + * 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` Example: "update_time desc" "create_time" */ - name?: string; + orderBy?: string; /** - * The standard list page size. + * Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000. */ pageSize?: number; /** - * The standard list page token. + * A page token, received from a previous `ListSessions` call. Provide this to retrieve the subsequent page. + */ + pageToken?: string; + /** + * Required. The data store resource name. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}` + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Datastores$Sessions$Patch + extends StandardParameters { + /** + * Immutable. Fully qualified name `projects/{project\}/locations/global/collections/{collection\}/engines/{engine\}/sessions/x` + */ + name?: string; + /** + * 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. + */ + updateMask?: string; + + /** + * Request body metadata */ - pageToken?: string; + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaSession; } - export class Resource$Projects$Locations$Datastores$Schemas { + export class Resource$Projects$Locations$Datastores$Sessions$Answers { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * Creates a Schema. + * Gets a Answer. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - create( - params: Params$Resource$Projects$Locations$Datastores$Schemas$Create, + get( + params: Params$Resource$Projects$Locations$Datastores$Sessions$Answers$Get, options: StreamMethodOptions ): GaxiosPromise; - create( - params?: Params$Resource$Projects$Locations$Datastores$Schemas$Create, + get( + params?: Params$Resource$Projects$Locations$Datastores$Sessions$Answers$Get, options?: MethodOptions - ): GaxiosPromise; - create( - params: Params$Resource$Projects$Locations$Datastores$Schemas$Create, + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Datastores$Sessions$Answers$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Datastores$Schemas$Create, + get( + params: Params$Resource$Projects$Locations$Datastores$Sessions$Answers$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Datastores$Schemas$Create, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Datastores$Sessions$Answers$Get, + callback: BodyResponseCallback ): void; - create( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - create( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Schemas$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Sessions$Answers$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Schemas$Create; + {}) as Params$Resource$Projects$Locations$Datastores$Sessions$Answers$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Schemas$Create; + {} as Params$Resource$Projects$Locations$Datastores$Sessions$Answers$Get; options = {}; } @@ -25743,68 +28976,87 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/schemas').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } + } + export interface Params$Resource$Projects$Locations$Datastores$Sessions$Answers$Get + extends StandardParameters { /** - * Deletes a Schema. + * Required. The resource name of the Answer to get. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/engines/{engine_id\}/sessions/{session_id\}/answers/{answer_id\}` + */ + name?: string; + } + + export class Resource$Projects$Locations$Datastores$Sitesearchengine { + context: APIRequestContext; + targetSites: Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites; + constructor(context: APIRequestContext) { + this.context = context; + this.targetSites = + new Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites( + this.context + ); + } + + /** + * Downgrade from advanced site search to basic site search. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - delete( - params: Params$Resource$Projects$Locations$Datastores$Schemas$Delete, + disableAdvancedSiteSearch( + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Disableadvancedsitesearch, options: StreamMethodOptions ): GaxiosPromise; - delete( - params?: Params$Resource$Projects$Locations$Datastores$Schemas$Delete, + disableAdvancedSiteSearch( + params?: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Disableadvancedsitesearch, options?: MethodOptions ): GaxiosPromise; - delete( - params: Params$Resource$Projects$Locations$Datastores$Schemas$Delete, + disableAdvancedSiteSearch( + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Disableadvancedsitesearch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Datastores$Schemas$Delete, + disableAdvancedSiteSearch( + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Disableadvancedsitesearch, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Datastores$Schemas$Delete, + disableAdvancedSiteSearch( + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Disableadvancedsitesearch, callback: BodyResponseCallback ): void; - delete( + disableAdvancedSiteSearch( callback: BodyResponseCallback ): void; - delete( + disableAdvancedSiteSearch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Schemas$Delete + | Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Disableadvancedsitesearch | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -25820,13 +29072,13 @@ export namespace discoveryengine_v1alpha { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Schemas$Delete; + {}) as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Disableadvancedsitesearch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Schemas$Delete; + {} as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Disableadvancedsitesearch; options = {}; } @@ -25840,15 +29092,17 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: ( + rootUrl + '/v1alpha/{+siteSearchEngine}:disableAdvancedSiteSearch' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['siteSearchEngine'], + pathParams: ['siteSearchEngine'], context: this.context, }; if (callback) { @@ -25862,161 +29116,65 @@ export namespace discoveryengine_v1alpha { } /** - * Gets a Schema. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - get( - params: Params$Resource$Projects$Locations$Datastores$Schemas$Get, - options: StreamMethodOptions - ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Datastores$Schemas$Get, - options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Datastores$Schemas$Get, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Projects$Locations$Datastores$Schemas$Get, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Projects$Locations$Datastores$Schemas$Get, - callback: BodyResponseCallback - ): void; - get( - callback: BodyResponseCallback - ): void; - get( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Schemas$Get - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Schemas$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Datastores$Schemas$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://discoveryengine.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest( - parameters - ); - } - } - - /** - * Gets a list of Schemas. + * Upgrade from basic site search to advanced site search. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Datastores$Schemas$List, + enableAdvancedSiteSearch( + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Enableadvancedsitesearch, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Datastores$Schemas$List, + enableAdvancedSiteSearch( + params?: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Enableadvancedsitesearch, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Datastores$Schemas$List, + ): GaxiosPromise; + enableAdvancedSiteSearch( + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Enableadvancedsitesearch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Datastores$Schemas$List, + enableAdvancedSiteSearch( + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Enableadvancedsitesearch, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Datastores$Schemas$List, - callback: BodyResponseCallback + enableAdvancedSiteSearch( + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Enableadvancedsitesearch, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + enableAdvancedSiteSearch( + callback: BodyResponseCallback ): void; - list( + enableAdvancedSiteSearch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Schemas$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Enableadvancedsitesearch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Schemas$List; + {}) as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Enableadvancedsitesearch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Schemas$List; + {} as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Enableadvancedsitesearch; options = {}; } @@ -26030,70 +29188,67 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/schemas').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: ( + rootUrl + '/v1alpha/{+siteSearchEngine}:enableAdvancedSiteSearch' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['siteSearchEngine'], + pathParams: ['siteSearchEngine'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Updates a Schema. + * Request on-demand recrawl for a list of URIs. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - patch( - params: Params$Resource$Projects$Locations$Datastores$Schemas$Patch, + recrawlUris( + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Recrawluris, options: StreamMethodOptions ): GaxiosPromise; - patch( - params?: Params$Resource$Projects$Locations$Datastores$Schemas$Patch, + recrawlUris( + params?: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Recrawluris, options?: MethodOptions ): GaxiosPromise; - patch( - params: Params$Resource$Projects$Locations$Datastores$Schemas$Patch, + recrawlUris( + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Recrawluris, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Datastores$Schemas$Patch, + recrawlUris( + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Recrawluris, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Datastores$Schemas$Patch, + recrawlUris( + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Recrawluris, callback: BodyResponseCallback ): void; - patch( + recrawlUris( callback: BodyResponseCallback ): void; - patch( + recrawlUris( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Schemas$Patch + | Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Recrawluris | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -26109,13 +29264,13 @@ export namespace discoveryengine_v1alpha { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Schemas$Patch; + {}) as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Recrawluris; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Schemas$Patch; + {} as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Recrawluris; options = {}; } @@ -26129,15 +29284,18 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + url: (rootUrl + '/v1alpha/{+siteSearchEngine}:recrawlUris').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['siteSearchEngine'], + pathParams: ['siteSearchEngine'], context: this.context, }; if (callback) { @@ -26151,134 +29309,109 @@ export namespace discoveryengine_v1alpha { } } - export interface Params$Resource$Projects$Locations$Datastores$Schemas$Create + export interface Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Disableadvancedsitesearch extends StandardParameters { /** - * Required. The parent data store resource name, in the format of `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}`. - */ - parent?: string; - /** - * Required. The ID to use for the Schema, which becomes the final component of the Schema.name. This field should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. + * Required. Full resource name of the SiteSearchEngine, such as `projects/{project\}/locations/{location\}/dataStores/{data_store_id\}/siteSearchEngine`. */ - schemaId?: string; + siteSearchEngine?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaSchema; - } - export interface Params$Resource$Projects$Locations$Datastores$Schemas$Delete - extends StandardParameters { - /** - * Required. The full resource name of the schema, in the format of `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/schemas/{schema\}`. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Datastores$Schemas$Get - extends StandardParameters { - /** - * Required. The full resource name of the schema, in the format of `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/schemas/{schema\}`. - */ - name?: string; + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaDisableAdvancedSiteSearchRequest; } - export interface Params$Resource$Projects$Locations$Datastores$Schemas$List + export interface Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Enableadvancedsitesearch extends StandardParameters { /** - * The maximum number of Schemas to return. The service may return fewer than this value. If unspecified, at most 100 Schemas are returned. The maximum value is 1000; values above 1000 are set to 1000. - */ - pageSize?: number; - /** - * A page token, received from a previous SchemaService.ListSchemas call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SchemaService.ListSchemas must match the call that provided the page token. + * Required. Full resource name of the SiteSearchEngine, such as `projects/{project\}/locations/{location\}/dataStores/{data_store_id\}/siteSearchEngine`. */ - pageToken?: string; + siteSearchEngine?: string; + /** - * Required. The parent data store resource name, in the format of `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}`. + * Request body metadata */ - parent?: string; + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaEnableAdvancedSiteSearchRequest; } - export interface Params$Resource$Projects$Locations$Datastores$Schemas$Patch + export interface Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Recrawluris extends StandardParameters { /** - * If set to true, and the Schema is not found, a new Schema is created. In this situation, `update_mask` is ignored. - */ - allowMissing?: boolean; - /** - * 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. + * Required. Full resource name of the SiteSearchEngine, such as `projects/x/locations/x/collections/x/dataStores/x/siteSearchEngine`. */ - name?: string; + siteSearchEngine?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaSchema; + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaRecrawlUrisRequest; } - export class Resource$Projects$Locations$Datastores$Servingconfigs { + export class Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * Answer query method. + * Creates TargetSite in a batch. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - answer( - params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Answer, + batchCreate( + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Batchcreate, options: StreamMethodOptions ): GaxiosPromise; - answer( - params?: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Answer, + batchCreate( + params?: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Batchcreate, options?: MethodOptions - ): GaxiosPromise; - answer( - params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Answer, + ): GaxiosPromise; + batchCreate( + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Batchcreate, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - answer( - params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Answer, + batchCreate( + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Batchcreate, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - answer( - params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Answer, - callback: BodyResponseCallback + batchCreate( + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Batchcreate, + callback: BodyResponseCallback ): void; - answer( - callback: BodyResponseCallback + batchCreate( + callback: BodyResponseCallback ): void; - answer( + batchCreate( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Servingconfigs$Answer - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Batchcreate + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Servingconfigs$Answer; + {}) as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Batchcreate; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Servingconfigs$Answer; + {} as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Batchcreate; options = {}; } @@ -26292,92 +29425,89 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+servingConfig}:answer').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: ( + rootUrl + '/v1alpha/{+parent}/targetSites:batchCreate' + ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['servingConfig'], - pathParams: ['servingConfig'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not exist. + * Creates a TargetSite. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Get, + create( + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Create, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Get, + create( + params?: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Create, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Get, + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Get, + create( + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Create, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Get, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Create, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + create( + callback: BodyResponseCallback ): void; - get( + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Servingconfigs$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Servingconfigs$Get; + {}) as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Servingconfigs$Get; + {} as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Create; options = {}; } @@ -26391,89 +29521,90 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1alpha/{+parent}/targetSites').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Lists all ServingConfigs linked to this dataStore. + * Deletes a TargetSite. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$List, + delete( + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Delete, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Datastores$Servingconfigs$List, + delete( + params?: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Delete, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$List, + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$List, + delete( + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Delete, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$List, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Delete, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + delete( + callback: BodyResponseCallback ): void; - list( + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Servingconfigs$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Servingconfigs$List; + {}) as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Servingconfigs$List; + {} as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Delete; options = {}; } @@ -26487,92 +29618,87 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/servingConfigs').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Updates a ServingConfig. Returns a NOT_FOUND error if the ServingConfig does not exist. + * Gets a TargetSite. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - patch( - params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Patch, + get( + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Get, options: StreamMethodOptions ): GaxiosPromise; - patch( - params?: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Patch, + get( + params?: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Get, options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Patch, + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Patch, + get( + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Patch, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Get, + callback: BodyResponseCallback ): void; - patch( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - patch( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Servingconfigs$Patch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Servingconfigs$Patch; + {}) as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Servingconfigs$Patch; + {} as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Get; options = {}; } @@ -26587,7 +29713,7 @@ export namespace discoveryengine_v1alpha { options: Object.assign( { url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + method: 'GET', apiVersion: '', }, options @@ -26598,77 +29724,77 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Makes a recommendation, which requires a contextual user event. + * Gets a list of TargetSites. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - recommend( - params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Recommend, + list( + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$List, options: StreamMethodOptions ): GaxiosPromise; - recommend( - params?: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Recommend, + list( + params?: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$List, options?: MethodOptions - ): GaxiosPromise; - recommend( - params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Recommend, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - recommend( - params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Recommend, + list( + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - recommend( - params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Recommend, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$List, + callback: BodyResponseCallback ): void; - recommend( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - recommend( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Servingconfigs$Recommend - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Servingconfigs$Recommend; + {}) as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Servingconfigs$Recommend; + {} as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$List; options = {}; } @@ -26682,92 +29808,92 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+servingConfig}:recommend').replace( + url: (rootUrl + '/v1alpha/{+parent}/targetSites').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['servingConfig'], - pathParams: ['servingConfig'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Performs a search. + * Updates a TargetSite. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - search( - params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Search, + patch( + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Patch, options: StreamMethodOptions ): GaxiosPromise; - search( - params?: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Search, + patch( + params?: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Patch, options?: MethodOptions - ): GaxiosPromise; - search( - params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Search, + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - search( - params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Search, + patch( + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Patch, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - search( - params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Search, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Patch, + callback: BodyResponseCallback ): void; - search( - callback: BodyResponseCallback + patch( + callback: BodyResponseCallback ): void; - search( + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Servingconfigs$Search - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Servingconfigs$Search; + {}) as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Servingconfigs$Search; + {} as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Patch; options = {}; } @@ -26781,179 +29907,160 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+servingConfig}:search').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', apiVersion: '', }, options ), params, - requiredParams: ['servingConfig'], - pathParams: ['servingConfig'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } } - export interface Params$Resource$Projects$Locations$Datastores$Servingconfigs$Answer + export interface Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Batchcreate extends StandardParameters { /** - * Required. The resource name of the Search serving config, such as `projects/x/locations/global/collections/default_collection/engines/x/servingConfigs/default_serving_config`, or `projects/x/locations/global/collections/default_collection/dataStores/x/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. + * Required. The parent resource shared by all TargetSites being created. `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine`. The parent field in the CreateBookRequest messages must either be empty or match this field. */ - servingConfig?: string; + parent?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaAnswerQueryRequest; - } - export interface Params$Resource$Projects$Locations$Datastores$Servingconfigs$Get - extends StandardParameters { - /** - * Required. The resource name of the ServingConfig to get. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/engines/{engine\}/servingConfigs/{serving_config_id\}` - */ - name?: string; + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSitesRequest; } - export interface Params$Resource$Projects$Locations$Datastores$Servingconfigs$List + export interface Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Create extends StandardParameters { /** - * Optional. Maximum number of results to return. If unspecified, defaults to 100. If a value greater than 100 is provided, at most 100 results are returned. - */ - pageSize?: number; - /** - * Optional. A page token, received from a previous `ListServingConfigs` call. Provide this to retrieve the subsequent page. + * Required. Parent resource name of TargetSite, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine`. */ - pageToken?: string; + parent?: string; + /** - * Required. Full resource name of the parent resource. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/engines/{engine\}` + * Request body metadata */ - parent?: string; + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaTargetSite; } - export interface Params$Resource$Projects$Locations$Datastores$Servingconfigs$Patch + export interface Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Delete extends StandardParameters { /** - * Immutable. Fully qualified name `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}/servingConfigs/{serving_config_id\}` + * Required. Full resource name of TargetSite, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine/targetSites/{target_site\}`. If the caller does not have permission to access the TargetSite, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested TargetSite does not exist, a NOT_FOUND error is returned. */ name?: string; + } + export interface Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Get + extends StandardParameters { /** - * Indicates which fields in the provided ServingConfig to update. The following are NOT supported: * ServingConfig.name If not set, all supported fields are updated. - */ - updateMask?: string; - - /** - * Request body metadata + * Required. Full resource name of TargetSite, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine/targetSites/{target_site\}`. If the caller does not have permission to access the TargetSite, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested TargetSite does not exist, a NOT_FOUND error is returned. */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaServingConfig; + name?: string; } - export interface Params$Resource$Projects$Locations$Datastores$Servingconfigs$Recommend + export interface Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$List extends StandardParameters { /** - * Required. Full resource name of a ServingConfig: `projects/x/locations/global/collections/x/engines/x/servingConfigs/x`, or `projects/x/locations/global/collections/x/dataStores/x/servingConfigs/x` One default serving config is created along with your recommendation engine creation. The engine ID is used as the ID of the default serving config. For example, for Engine `projects/x/locations/global/collections/x/engines/my-engine`, you can use `projects/x/locations/global/collections/x/engines/my-engine/servingConfigs/my-engine` for your RecommendationService.Recommend requests. + * Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. The maximum value is 1000; values above 1000 will be coerced to 1000. If this field is negative, an INVALID_ARGUMENT error is returned. */ - servingConfig?: string; - + pageSize?: number; /** - * Request body metadata + * A page token, received from a previous `ListTargetSites` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListTargetSites` must match the call that provided the page token. */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaRecommendRequest; + pageToken?: string; + /** + * Required. The parent site search engine resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine`. If the caller does not have permission to list TargetSites under this site search engine, regardless of whether or not this branch exists, a PERMISSION_DENIED error is returned. + */ + parent?: string; } - export interface Params$Resource$Projects$Locations$Datastores$Servingconfigs$Search + export interface Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Patch extends StandardParameters { /** - * Required. The resource name of the Search serving config, such as `projects/x/locations/global/collections/default_collection/engines/x/servingConfigs/default_serving_config`, or `projects/x/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. + * 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. */ - servingConfig?: string; + name?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequest; + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaTargetSite; } - export class Resource$Projects$Locations$Datastores$Sessions { + export class Resource$Projects$Locations$Datastores$Suggestiondenylistentries { context: APIRequestContext; - answers: Resource$Projects$Locations$Datastores$Sessions$Answers; constructor(context: APIRequestContext) { this.context = context; - this.answers = - new Resource$Projects$Locations$Datastores$Sessions$Answers( - this.context - ); } /** - * Creates a Session. If the Session to create already exists, an ALREADY_EXISTS error is returned. + * Imports all SuggestionDenyListEntry for a DataStore. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - create( - params: Params$Resource$Projects$Locations$Datastores$Sessions$Create, + import( + params: Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Import, options: StreamMethodOptions ): GaxiosPromise; - create( - params?: Params$Resource$Projects$Locations$Datastores$Sessions$Create, + import( + params?: Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Import, options?: MethodOptions - ): GaxiosPromise; - create( - params: Params$Resource$Projects$Locations$Datastores$Sessions$Create, + ): GaxiosPromise; + import( + params: Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Import, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Datastores$Sessions$Create, + import( + params: Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Import, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Datastores$Sessions$Create, - callback: BodyResponseCallback + import( + params: Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Import, + callback: BodyResponseCallback ): void; - create( - callback: BodyResponseCallback + import( + callback: BodyResponseCallback ): void; - create( + import( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Sessions$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Import + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Sessions$Create; + {}) as Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Import; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Sessions$Create; + {} as Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Import; options = {}; } @@ -26967,10 +30074,9 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/sessions').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: ( + rootUrl + '/v1alpha/{+parent}/suggestionDenyListEntries:import' + ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', }, @@ -26982,73 +30088,199 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters + return createAPIRequest(parameters); + } + } + + /** + * Permanently deletes all SuggestionDenyListEntry for a DataStore. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + purge( + params: Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Purge, + options: StreamMethodOptions + ): GaxiosPromise; + purge( + params?: Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Purge, + options?: MethodOptions + ): GaxiosPromise; + purge( + params: Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Purge, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + purge( + params: Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Purge, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + purge( + params: Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Purge, + callback: BodyResponseCallback + ): void; + purge( + callback: BodyResponseCallback + ): void; + purge( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Purge + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Purge; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Purge; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v1alpha/{+parent}/suggestionDenyListEntries:purge' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback ); + } else { + return createAPIRequest(parameters); } } + } + + export interface Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Import + extends StandardParameters { + /** + * Required. The parent data store resource name for which to import denylist entries. Follows pattern projects/x/locations/x/collections/x/dataStores/x. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesRequest; + } + export interface Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Purge + extends StandardParameters { + /** + * Required. The parent data store resource name for which to import denylist entries. Follows pattern projects/x/locations/x/collections/x/dataStores/x. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaPurgeSuggestionDenyListEntriesRequest; + } + + export class Resource$Projects$Locations$Datastores$Userevents { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } /** - * Deletes a Session. If the Session to delete does not exist, a NOT_FOUND error is returned. + * 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. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - delete( - params: Params$Resource$Projects$Locations$Datastores$Sessions$Delete, + collect( + params: Params$Resource$Projects$Locations$Datastores$Userevents$Collect, options: StreamMethodOptions ): GaxiosPromise; - delete( - params?: Params$Resource$Projects$Locations$Datastores$Sessions$Delete, + collect( + params?: Params$Resource$Projects$Locations$Datastores$Userevents$Collect, options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Projects$Locations$Datastores$Sessions$Delete, + ): GaxiosPromise; + collect( + params: Params$Resource$Projects$Locations$Datastores$Userevents$Collect, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Datastores$Sessions$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + collect( + params: Params$Resource$Projects$Locations$Datastores$Userevents$Collect, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Datastores$Sessions$Delete, - callback: BodyResponseCallback + collect( + params: Params$Resource$Projects$Locations$Datastores$Userevents$Collect, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + collect(callback: BodyResponseCallback): void; + collect( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Sessions$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Userevents$Collect + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Sessions$Delete; + {}) as Params$Resource$Projects$Locations$Datastores$Userevents$Collect; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Sessions$Delete; + {} as Params$Resource$Projects$Locations$Datastores$Userevents$Collect; options = {}; } @@ -27062,87 +30294,90 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1alpha/{+parent}/userEvents:collect').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Gets a Session. + * 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. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Datastores$Sessions$Get, + import( + params: Params$Resource$Projects$Locations$Datastores$Userevents$Import, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Datastores$Sessions$Get, + import( + params?: Params$Resource$Projects$Locations$Datastores$Userevents$Import, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Datastores$Sessions$Get, + ): GaxiosPromise; + import( + params: Params$Resource$Projects$Locations$Datastores$Userevents$Import, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Datastores$Sessions$Get, + import( + params: Params$Resource$Projects$Locations$Datastores$Userevents$Import, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Datastores$Sessions$Get, - callback: BodyResponseCallback + import( + params: Params$Resource$Projects$Locations$Datastores$Userevents$Import, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + import( + callback: BodyResponseCallback ): void; - get( + import( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Sessions$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Userevents$Import + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Sessions$Get; + {}) as Params$Resource$Projects$Locations$Datastores$Userevents$Import; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Sessions$Get; + {} as Params$Resource$Projects$Locations$Datastores$Userevents$Import; options = {}; } @@ -27156,89 +30391,90 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1alpha/{+parent}/userEvents:import').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Lists all Sessions by their parent DataStore. + * 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. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Datastores$Sessions$List, + purge( + params: Params$Resource$Projects$Locations$Datastores$Userevents$Purge, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Datastores$Sessions$List, + purge( + params?: Params$Resource$Projects$Locations$Datastores$Userevents$Purge, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Datastores$Sessions$List, + ): GaxiosPromise; + purge( + params: Params$Resource$Projects$Locations$Datastores$Userevents$Purge, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Datastores$Sessions$List, + purge( + params: Params$Resource$Projects$Locations$Datastores$Userevents$Purge, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Datastores$Sessions$List, - callback: BodyResponseCallback + purge( + params: Params$Resource$Projects$Locations$Datastores$Userevents$Purge, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + purge( + callback: BodyResponseCallback ): void; - list( + purge( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Sessions$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Userevents$Purge + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Sessions$List; + {}) as Params$Resource$Projects$Locations$Datastores$Userevents$Purge; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Sessions$List; + {} as Params$Resource$Projects$Locations$Datastores$Userevents$Purge; options = {}; } @@ -27252,11 +30488,11 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/sessions').replace( + url: (rootUrl + '/v1alpha/{+parent}/userEvents:purge').replace( /([^:]\/)\/+/g, '$1' ), - method: 'GET', + method: 'POST', apiVersion: '', }, options @@ -27267,77 +30503,75 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Updates a Session. Session action type cannot be changed. If the Session to update does not exist, a NOT_FOUND error is returned. + * Writes a single user event. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - patch( - params: Params$Resource$Projects$Locations$Datastores$Sessions$Patch, + write( + params: Params$Resource$Projects$Locations$Datastores$Userevents$Write, options: StreamMethodOptions ): GaxiosPromise; - patch( - params?: Params$Resource$Projects$Locations$Datastores$Sessions$Patch, + write( + params?: Params$Resource$Projects$Locations$Datastores$Userevents$Write, options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Projects$Locations$Datastores$Sessions$Patch, + ): GaxiosPromise; + write( + params: Params$Resource$Projects$Locations$Datastores$Userevents$Write, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Datastores$Sessions$Patch, + write( + params: Params$Resource$Projects$Locations$Datastores$Userevents$Write, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Datastores$Sessions$Patch, - callback: BodyResponseCallback + write( + params: Params$Resource$Projects$Locations$Datastores$Userevents$Write, + callback: BodyResponseCallback ): void; - patch( - callback: BodyResponseCallback + write( + callback: BodyResponseCallback ): void; - patch( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Sessions$Patch - | BodyResponseCallback + write( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Datastores$Userevents$Write + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Sessions$Patch; + {}) as Params$Resource$Projects$Locations$Datastores$Userevents$Write; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Sessions$Patch; + {} as Params$Resource$Projects$Locations$Datastores$Userevents$Write; options = {}; } @@ -27351,104 +30585,201 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + url: (rootUrl + '/v1alpha/{+parent}/userEvents:write').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } } - export interface Params$Resource$Projects$Locations$Datastores$Sessions$Create + export interface Params$Resource$Projects$Locations$Datastores$Userevents$Collect extends StandardParameters { /** - * Required. Full resource name of parent data store. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}` + * The event timestamp in milliseconds. This prevents browser caching of otherwise identical get requests. The name is abbreviated to reduce the payload bytes. */ - parent?: string; - + ets?: string; /** - * Request body metadata + * Required. The parent DataStore resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}`. */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaSession; - } - export interface Params$Resource$Projects$Locations$Datastores$Sessions$Delete - extends StandardParameters { + parent?: string; /** - * Required. The resource name of the Session to delete. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/sessions/{session_id\}` + * 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 third-party requests. */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Datastores$Sessions$Get - extends StandardParameters { + uri?: string; /** - * Required. The resource name of the Session to get. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/sessions/{session_id\}` + * Required. URL encoded UserEvent proto with a length limit of 2,000,000 characters. */ - name?: string; + userEvent?: string; } - export interface Params$Resource$Projects$Locations$Datastores$Sessions$List + export interface Params$Resource$Projects$Locations$Datastores$Userevents$Import extends StandardParameters { /** - * A filter to apply on the list results. The supported features are: user_pseudo_id, state. Example: "user_pseudo_id = some_id" - */ - filter?: string; - /** - * 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` Example: "update_time desc" "create_time" + * Required. Parent DataStore resource name, of the form `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}` */ - orderBy?: string; + parent?: string; + /** - * Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000. + * Request body metadata */ - pageSize?: number; + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaImportUserEventsRequest; + } + export interface Params$Resource$Projects$Locations$Datastores$Userevents$Purge + extends StandardParameters { /** - * A page token, received from a previous `ListSessions` call. Provide this to retrieve the subsequent page. + * Required. The resource name of the catalog under which the events are created. The format is `projects/${projectId\}/locations/global/collections/{$collectionId\}/dataStores/${dataStoreId\}` */ - pageToken?: string; + parent?: string; + /** - * Required. The data store resource name. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}` + * Request body metadata */ - parent?: string; + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaPurgeUserEventsRequest; } - export interface Params$Resource$Projects$Locations$Datastores$Sessions$Patch + export interface Params$Resource$Projects$Locations$Datastores$Userevents$Write extends StandardParameters { /** - * Immutable. Fully qualified name `projects/{project\}/locations/global/collections/{collection\}/engines/{engine\}/sessions/x` + * Required. The parent resource name. If the write user event action is applied in DataStore level, the format is: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}`. If the write user event action is applied in Location level, for example, the event with Document across multiple DataStore, the format is: `projects/{project\}/locations/{location\}`. */ - name?: string; + parent?: string; /** - * 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. + * If set to true, the user event is written asynchronously after validation, and the API responds without waiting for the write. */ - updateMask?: string; + writeAsync?: boolean; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaSession; + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaUserEvent; } - export class Resource$Projects$Locations$Datastores$Sessions$Answers { + export class Resource$Projects$Locations$Evaluations { context: APIRequestContext; + operations: Resource$Projects$Locations$Evaluations$Operations; constructor(context: APIRequestContext) { this.context = context; + this.operations = new Resource$Projects$Locations$Evaluations$Operations( + this.context + ); } /** - * Gets a Answer. + * Creates a Evaluation. Upon creation, the evaluation will be automatically triggered and begin execution. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + create( + params: Params$Resource$Projects$Locations$Evaluations$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Projects$Locations$Evaluations$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Evaluations$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Evaluations$Create, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Evaluations$Create, + callback: BodyResponseCallback + ): void; + create( + callback: BodyResponseCallback + ): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Evaluations$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Evaluations$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Evaluations$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+parent}/evaluations').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets a Evaluation. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -27456,57 +30787,56 @@ export namespace discoveryengine_v1alpha { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Datastores$Sessions$Answers$Get, + params: Params$Resource$Projects$Locations$Evaluations$Get, options: StreamMethodOptions ): GaxiosPromise; get( - params?: Params$Resource$Projects$Locations$Datastores$Sessions$Answers$Get, + params?: Params$Resource$Projects$Locations$Evaluations$Get, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; get( - params: Params$Resource$Projects$Locations$Datastores$Sessions$Answers$Get, + params: Params$Resource$Projects$Locations$Evaluations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Datastores$Sessions$Answers$Get, + params: Params$Resource$Projects$Locations$Evaluations$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Datastores$Sessions$Answers$Get, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Evaluations$Get, + callback: BodyResponseCallback ): void; get( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Sessions$Answers$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Evaluations$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Sessions$Answers$Get; + {}) as Params$Resource$Projects$Locations$Evaluations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Datastores$Sessions$Answers$Get; + params = {} as Params$Resource$Projects$Locations$Evaluations$Get; options = {}; } @@ -27532,97 +30862,76 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } - } - - export interface Params$Resource$Projects$Locations$Datastores$Sessions$Answers$Get - extends StandardParameters { - /** - * Required. The resource name of the Answer to get. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/engines/{engine_id\}/sessions/{session_id\}/answers/{answer_id\}` - */ - name?: string; - } - - export class Resource$Projects$Locations$Datastores$Sitesearchengine { - context: APIRequestContext; - targetSites: Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites; - constructor(context: APIRequestContext) { - this.context = context; - this.targetSites = - new Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites( - this.context - ); - } /** - * Downgrade from advanced site search to basic site search. + * Gets a list of Evaluations. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - disableAdvancedSiteSearch( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Disableadvancedsitesearch, + list( + params: Params$Resource$Projects$Locations$Evaluations$List, options: StreamMethodOptions ): GaxiosPromise; - disableAdvancedSiteSearch( - params?: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Disableadvancedsitesearch, + list( + params?: Params$Resource$Projects$Locations$Evaluations$List, options?: MethodOptions - ): GaxiosPromise; - disableAdvancedSiteSearch( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Disableadvancedsitesearch, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Evaluations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - disableAdvancedSiteSearch( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Disableadvancedsitesearch, + list( + params: Params$Resource$Projects$Locations$Evaluations$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - disableAdvancedSiteSearch( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Disableadvancedsitesearch, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Evaluations$List, + callback: BodyResponseCallback ): void; - disableAdvancedSiteSearch( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - disableAdvancedSiteSearch( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Disableadvancedsitesearch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Evaluations$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Disableadvancedsitesearch; + {}) as Params$Resource$Projects$Locations$Evaluations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Disableadvancedsitesearch; + params = {} as Params$Resource$Projects$Locations$Evaluations$List; options = {}; } @@ -27636,89 +30945,92 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: ( - rootUrl + '/v1alpha/{+siteSearchEngine}:disableAdvancedSiteSearch' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + url: (rootUrl + '/v1alpha/{+parent}/evaluations').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['siteSearchEngine'], - pathParams: ['siteSearchEngine'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Upgrade from basic site search to advanced site search. + * Gets a list of results for a given a Evaluation. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - enableAdvancedSiteSearch( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Enableadvancedsitesearch, + listResults( + params: Params$Resource$Projects$Locations$Evaluations$Listresults, options: StreamMethodOptions ): GaxiosPromise; - enableAdvancedSiteSearch( - params?: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Enableadvancedsitesearch, + listResults( + params?: Params$Resource$Projects$Locations$Evaluations$Listresults, options?: MethodOptions - ): GaxiosPromise; - enableAdvancedSiteSearch( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Enableadvancedsitesearch, + ): GaxiosPromise; + listResults( + params: Params$Resource$Projects$Locations$Evaluations$Listresults, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - enableAdvancedSiteSearch( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Enableadvancedsitesearch, + listResults( + params: Params$Resource$Projects$Locations$Evaluations$Listresults, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - enableAdvancedSiteSearch( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Enableadvancedsitesearch, - callback: BodyResponseCallback + listResults( + params: Params$Resource$Projects$Locations$Evaluations$Listresults, + callback: BodyResponseCallback ): void; - enableAdvancedSiteSearch( - callback: BodyResponseCallback + listResults( + callback: BodyResponseCallback ): void; - enableAdvancedSiteSearch( + listResults( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Enableadvancedsitesearch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Evaluations$Listresults + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Enableadvancedsitesearch; + {}) as Params$Resource$Projects$Locations$Evaluations$Listresults; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Enableadvancedsitesearch; + {} as Params$Resource$Projects$Locations$Evaluations$Listresults; options = {}; } @@ -27732,67 +31044,127 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: ( - rootUrl + '/v1alpha/{+siteSearchEngine}:enableAdvancedSiteSearch' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + url: (rootUrl + '/v1alpha/{+evaluation}:listResults').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['siteSearchEngine'], - pathParams: ['siteSearchEngine'], + requiredParams: ['evaluation'], + pathParams: ['evaluation'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } + } + export interface Params$Resource$Projects$Locations$Evaluations$Create + extends StandardParameters { /** - * Request on-demand recrawl for a list of URIs. + * Required. The parent resource name, such as `projects/{project\}/locations/{location\}`. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaEvaluation; + } + export interface Params$Resource$Projects$Locations$Evaluations$Get + extends StandardParameters { + /** + * Required. Full resource name of Evaluation, such as `projects/{project\}/locations/{location\}/evaluations/{evaluation\}`. If the caller does not have permission to access the Evaluation, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested Evaluation does not exist, a NOT_FOUND error is returned. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Evaluations$List + extends StandardParameters { + /** + * Maximum number of Evaluations to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned. + */ + pageSize?: number; + /** + * A page token ListEvaluationsResponse.next_page_token, received from a previous EvaluationService.ListEvaluations call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to EvaluationService.ListEvaluations must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned. + */ + pageToken?: string; + /** + * Required. The parent location resource name, such as `projects/{project\}/locations/{location\}`. If the caller does not have permission to list Evaluations under this location, regardless of whether or not this location exists, a `PERMISSION_DENIED` error is returned. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Evaluations$Listresults + extends StandardParameters { + /** + * Required. The evaluation resource name, such as `projects/{project\}/locations/{location\}/evaluations/{evaluation\}`. If the caller does not have permission to list EvaluationResult under this evaluation, regardless of whether or not this evaluation set exists, a `PERMISSION_DENIED` error is returned. + */ + evaluation?: string; + /** + * Maximum number of EvaluationResult to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned. + */ + pageSize?: number; + /** + * A page token ListEvaluationResultsResponse.next_page_token, received from a previous EvaluationService.ListEvaluationResults call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to EvaluationService.ListEvaluationResults must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned. + */ + pageToken?: string; + } + + export class Resource$Projects$Locations$Evaluations$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * 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. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - recrawlUris( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Recrawluris, + get( + params: Params$Resource$Projects$Locations$Evaluations$Operations$Get, options: StreamMethodOptions ): GaxiosPromise; - recrawlUris( - params?: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Recrawluris, + get( + params?: Params$Resource$Projects$Locations$Evaluations$Operations$Get, options?: MethodOptions ): GaxiosPromise; - recrawlUris( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Recrawluris, + get( + params: Params$Resource$Projects$Locations$Evaluations$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - recrawlUris( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Recrawluris, + get( + params: Params$Resource$Projects$Locations$Evaluations$Operations$Get, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - recrawlUris( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Recrawluris, + get( + params: Params$Resource$Projects$Locations$Evaluations$Operations$Get, callback: BodyResponseCallback ): void; - recrawlUris( + get( callback: BodyResponseCallback ): void; - recrawlUris( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Recrawluris + | Params$Resource$Projects$Locations$Evaluations$Operations$Get | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -27808,13 +31180,13 @@ export namespace discoveryengine_v1alpha { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Recrawluris; + {}) as Params$Resource$Projects$Locations$Evaluations$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Recrawluris; + {} as Params$Resource$Projects$Locations$Evaluations$Operations$Get; options = {}; } @@ -27828,18 +31200,15 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+siteSearchEngine}:recrawlUris').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['siteSearchEngine'], - pathParams: ['siteSearchEngine'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { @@ -27853,109 +31222,80 @@ export namespace discoveryengine_v1alpha { } } - export interface Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Disableadvancedsitesearch - extends StandardParameters { - /** - * Required. Full resource name of the SiteSearchEngine, such as `projects/{project\}/locations/{location\}/dataStores/{data_store_id\}/siteSearchEngine`. - */ - siteSearchEngine?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaDisableAdvancedSiteSearchRequest; - } - export interface Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Enableadvancedsitesearch - extends StandardParameters { - /** - * Required. Full resource name of the SiteSearchEngine, such as `projects/{project\}/locations/{location\}/dataStores/{data_store_id\}/siteSearchEngine`. - */ - siteSearchEngine?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaEnableAdvancedSiteSearchRequest; - } - export interface Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Recrawluris + export interface Params$Resource$Projects$Locations$Evaluations$Operations$Get extends StandardParameters { /** - * Required. Full resource name of the SiteSearchEngine, such as `projects/x/locations/x/collections/x/dataStores/x/siteSearchEngine`. - */ - siteSearchEngine?: string; - - /** - * Request body metadata + * The name of the operation resource. */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaRecrawlUrisRequest; + name?: string; } - export class Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites { + export class Resource$Projects$Locations$Groundingconfigs { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * Creates TargetSite in a batch. + * Performs a grounding check. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - batchCreate( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Batchcreate, + check( + params: Params$Resource$Projects$Locations$Groundingconfigs$Check, options: StreamMethodOptions ): GaxiosPromise; - batchCreate( - params?: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Batchcreate, + check( + params?: Params$Resource$Projects$Locations$Groundingconfigs$Check, options?: MethodOptions - ): GaxiosPromise; - batchCreate( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Batchcreate, + ): GaxiosPromise; + check( + params: Params$Resource$Projects$Locations$Groundingconfigs$Check, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - batchCreate( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Batchcreate, + check( + params: Params$Resource$Projects$Locations$Groundingconfigs$Check, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - batchCreate( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Batchcreate, - callback: BodyResponseCallback + check( + params: Params$Resource$Projects$Locations$Groundingconfigs$Check, + callback: BodyResponseCallback ): void; - batchCreate( - callback: BodyResponseCallback + check( + callback: BodyResponseCallback ): void; - batchCreate( + check( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Batchcreate - | BodyResponseCallback + | Params$Resource$Projects$Locations$Groundingconfigs$Check + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Batchcreate; + {}) as Params$Resource$Projects$Locations$Groundingconfigs$Check; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Batchcreate; + {} as Params$Resource$Projects$Locations$Groundingconfigs$Check; options = {}; } @@ -27969,67 +31309,102 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: ( - rootUrl + '/v1alpha/{+parent}/targetSites:batchCreate' - ).replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1alpha/{+groundingConfig}:check').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['groundingConfig'], + pathParams: ['groundingConfig'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); - } else { - return createAPIRequest(parameters); - } + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Projects$Locations$Groundingconfigs$Check + extends StandardParameters { + /** + * Required. The resource name of the grounding config, such as `projects/x/locations/global/groundingConfigs/default_grounding_config`. + */ + groundingConfig?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaCheckGroundingRequest; + } + + export class Resource$Projects$Locations$Identity_mapping_stores { + context: APIRequestContext; + operations: Resource$Projects$Locations$Identity_mapping_stores$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.operations = + new Resource$Projects$Locations$Identity_mapping_stores$Operations( + this.context + ); + } + } + + export class Resource$Projects$Locations$Identity_mapping_stores$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; } /** - * Creates a TargetSite. + * 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. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - create( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Create, + get( + params: Params$Resource$Projects$Locations$Identity_mapping_stores$Operations$Get, options: StreamMethodOptions ): GaxiosPromise; - create( - params?: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Create, + get( + params?: Params$Resource$Projects$Locations$Identity_mapping_stores$Operations$Get, options?: MethodOptions ): GaxiosPromise; - create( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Create, + get( + params: Params$Resource$Projects$Locations$Identity_mapping_stores$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Create, + get( + params: Params$Resource$Projects$Locations$Identity_mapping_stores$Operations$Get, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Create, + get( + params: Params$Resource$Projects$Locations$Identity_mapping_stores$Operations$Get, callback: BodyResponseCallback ): void; - create( + get( callback: BodyResponseCallback ): void; - create( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Create + | Params$Resource$Projects$Locations$Identity_mapping_stores$Operations$Get | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -28045,13 +31420,13 @@ export namespace discoveryengine_v1alpha { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Create; + {}) as Params$Resource$Projects$Locations$Identity_mapping_stores$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Create; + {} as Params$Resource$Projects$Locations$Identity_mapping_stores$Operations$Get; options = {}; } @@ -28065,18 +31440,15 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/targetSites').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { @@ -28090,65 +31462,65 @@ export namespace discoveryengine_v1alpha { } /** - * Deletes a TargetSite. + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - delete( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Delete, + list( + params: Params$Resource$Projects$Locations$Identity_mapping_stores$Operations$List, options: StreamMethodOptions ): GaxiosPromise; - delete( - params?: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Delete, + list( + params?: Params$Resource$Projects$Locations$Identity_mapping_stores$Operations$List, options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Delete, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Identity_mapping_stores$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Delete, + list( + params: Params$Resource$Projects$Locations$Identity_mapping_stores$Operations$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Delete, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Identity_mapping_stores$Operations$List, + callback: BodyResponseCallback ): void; - delete( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - delete( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Identity_mapping_stores$Operations$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Delete; + {}) as Params$Resource$Projects$Locations$Identity_mapping_stores$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Delete; + {} as Params$Resource$Projects$Locations$Identity_mapping_stores$Operations$List; options = {}; } @@ -28162,8 +31534,11 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1alpha/{+name}/operations').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', apiVersion: '', }, options @@ -28174,17 +31549,53 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } + } + export interface Params$Resource$Projects$Locations$Identity_mapping_stores$Operations$Get + extends StandardParameters { /** - * Gets a TargetSite. + * The name of the operation resource. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Identity_mapping_stores$Operations$List + extends StandardParameters { + /** + * The standard list filter. + */ + filter?: string; + /** + * The name of the operation's parent resource. + */ + name?: string; + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. + */ + pageToken?: string; + } + + export class Resource$Projects$Locations$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * 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. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -28192,57 +31603,56 @@ export namespace discoveryengine_v1alpha { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Get, + params: Params$Resource$Projects$Locations$Operations$Get, options: StreamMethodOptions ): GaxiosPromise; get( - params?: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Get, + params?: Params$Resource$Projects$Locations$Operations$Get, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; get( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Get, + params: Params$Resource$Projects$Locations$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Get, + params: Params$Resource$Projects$Locations$Operations$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Get, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Operations$Get, + callback: BodyResponseCallback ): void; get( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Operations$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Get; + {}) as Params$Resource$Projects$Locations$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Get; + params = {} as Params$Resource$Projects$Locations$Operations$Get; options = {}; } @@ -28268,19 +31678,17 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Gets a list of TargetSites. + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -28288,57 +31696,56 @@ export namespace discoveryengine_v1alpha { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$List, + params: Params$Resource$Projects$Locations$Operations$List, options: StreamMethodOptions ): GaxiosPromise; list( - params?: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$List, + params?: Params$Resource$Projects$Locations$Operations$List, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; list( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$List, + params: Params$Resource$Projects$Locations$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$List, + params: Params$Resource$Projects$Locations$Operations$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$List, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Operations$List, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Operations$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$List; + {}) as Params$Resource$Projects$Locations$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$List; + params = {} as Params$Resource$Projects$Locations$Operations$List; options = {}; } @@ -28352,7 +31759,7 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/targetSites').replace( + url: (rootUrl + '/v1alpha/{+name}/operations').replace( /([^:]\/)\/+/g, '$1' ), @@ -28362,82 +31769,115 @@ export namespace discoveryengine_v1alpha { options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } + } + + export interface Params$Resource$Projects$Locations$Operations$Get + extends StandardParameters { + /** + * The name of the operation resource. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Operations$List + extends StandardParameters { + /** + * The standard list filter. + */ + filter?: string; + /** + * The name of the operation's parent resource. + */ + name?: string; + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. + */ + pageToken?: string; + } + + export class Resource$Projects$Locations$Rankingconfigs { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } /** - * Updates a TargetSite. + * Ranks a list of text records based on the given input query. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - patch( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Patch, + rank( + params: Params$Resource$Projects$Locations$Rankingconfigs$Rank, options: StreamMethodOptions ): GaxiosPromise; - patch( - params?: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Patch, + rank( + params?: Params$Resource$Projects$Locations$Rankingconfigs$Rank, options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Patch, + ): GaxiosPromise; + rank( + params: Params$Resource$Projects$Locations$Rankingconfigs$Rank, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Patch, + rank( + params: Params$Resource$Projects$Locations$Rankingconfigs$Rank, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Patch, - callback: BodyResponseCallback + rank( + params: Params$Resource$Projects$Locations$Rankingconfigs$Rank, + callback: BodyResponseCallback ): void; - patch( - callback: BodyResponseCallback + rank( + callback: BodyResponseCallback ): void; - patch( + rank( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Patch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Rankingconfigs$Rank + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Patch; + {}) as Params$Resource$Projects$Locations$Rankingconfigs$Rank; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Patch; + params = {} as Params$Resource$Projects$Locations$Rankingconfigs$Rank; options = {}; } @@ -28451,160 +31891,112 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + url: (rootUrl + '/v1alpha/{+rankingConfig}:rank').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['rankingConfig'], + pathParams: ['rankingConfig'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } } - export interface Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Batchcreate - extends StandardParameters { - /** - * Required. The parent resource shared by all TargetSites being created. `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine`. The parent field in the CreateBookRequest messages must either be empty or match this field. - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSitesRequest; - } - export interface Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Create - extends StandardParameters { - /** - * Required. Parent resource name of TargetSite, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine`. - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaTargetSite; - } - export interface Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Delete - extends StandardParameters { - /** - * Required. Full resource name of TargetSite, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine/targetSites/{target_site\}`. If the caller does not have permission to access the TargetSite, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested TargetSite does not exist, a NOT_FOUND error is returned. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Get - extends StandardParameters { - /** - * Required. Full resource name of TargetSite, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine/targetSites/{target_site\}`. If the caller does not have permission to access the TargetSite, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested TargetSite does not exist, a NOT_FOUND error is returned. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$List - extends StandardParameters { - /** - * Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. The maximum value is 1000; values above 1000 will be coerced to 1000. If this field is negative, an INVALID_ARGUMENT error is returned. - */ - pageSize?: number; - /** - * A page token, received from a previous `ListTargetSites` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListTargetSites` must match the call that provided the page token. - */ - pageToken?: string; - /** - * Required. The parent site search engine resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine`. If the caller does not have permission to list TargetSites under this site search engine, regardless of whether or not this branch exists, a PERMISSION_DENIED error is returned. - */ - parent?: string; - } - export interface Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Patch + export interface Params$Resource$Projects$Locations$Rankingconfigs$Rank extends StandardParameters { /** - * 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. + * Required. The resource name of the rank service config, such as `projects/{project_num\}/locations/{location_id\}/rankingConfigs/default_ranking_config`. */ - name?: string; + rankingConfig?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaTargetSite; + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaRankRequest; } - export class Resource$Projects$Locations$Datastores$Suggestiondenylistentries { + export class Resource$Projects$Locations$Requirements { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * Imports all SuggestionDenyListEntry for a DataStore. + * Check a particular requirement. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - import( - params: Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Import, + checkRequirement( + params: Params$Resource$Projects$Locations$Requirements$Checkrequirement, options: StreamMethodOptions ): GaxiosPromise; - import( - params?: Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Import, + checkRequirement( + params?: Params$Resource$Projects$Locations$Requirements$Checkrequirement, options?: MethodOptions - ): GaxiosPromise; - import( - params: Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Import, + ): GaxiosPromise; + checkRequirement( + params: Params$Resource$Projects$Locations$Requirements$Checkrequirement, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - import( - params: Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Import, + checkRequirement( + params: Params$Resource$Projects$Locations$Requirements$Checkrequirement, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - import( - params: Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Import, - callback: BodyResponseCallback + checkRequirement( + params: Params$Resource$Projects$Locations$Requirements$Checkrequirement, + callback: BodyResponseCallback ): void; - import( - callback: BodyResponseCallback + checkRequirement( + callback: BodyResponseCallback ): void; - import( + checkRequirement( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Import - | BodyResponseCallback + | Params$Resource$Projects$Locations$Requirements$Checkrequirement + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Import; + {}) as Params$Resource$Projects$Locations$Requirements$Checkrequirement; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Import; + {} as Params$Resource$Projects$Locations$Requirements$Checkrequirement; options = {}; } @@ -28619,7 +32011,7 @@ export namespace discoveryengine_v1alpha { options: Object.assign( { url: ( - rootUrl + '/v1alpha/{+parent}/suggestionDenyListEntries:import' + rootUrl + '/v1alpha/{+location}/requirements:checkRequirement' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -28627,80 +32019,112 @@ export namespace discoveryengine_v1alpha { options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['location'], + pathParams: ['location'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } + } + + export interface Params$Resource$Projects$Locations$Requirements$Checkrequirement + extends StandardParameters { + /** + * Required. Full resource name of the location. Format `projects/{project_number_or_id\}/locations/{location\}` + */ + location?: string; /** - * Permanently deletes all SuggestionDenyListEntry for a DataStore. + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaCheckRequirementRequest; + } + + export class Resource$Projects$Locations$Samplequerysets { + context: APIRequestContext; + operations: Resource$Projects$Locations$Samplequerysets$Operations; + sampleQueries: Resource$Projects$Locations$Samplequerysets$Samplequeries; + constructor(context: APIRequestContext) { + this.context = context; + this.operations = + new Resource$Projects$Locations$Samplequerysets$Operations( + this.context + ); + this.sampleQueries = + new Resource$Projects$Locations$Samplequerysets$Samplequeries( + this.context + ); + } + + /** + * Creates a SampleQuerySet * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - purge( - params: Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Purge, + create( + params: Params$Resource$Projects$Locations$Samplequerysets$Create, options: StreamMethodOptions ): GaxiosPromise; - purge( - params?: Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Purge, + create( + params?: Params$Resource$Projects$Locations$Samplequerysets$Create, options?: MethodOptions - ): GaxiosPromise; - purge( - params: Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Purge, + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Samplequerysets$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - purge( - params: Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Purge, + create( + params: Params$Resource$Projects$Locations$Samplequerysets$Create, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - purge( - params: Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Purge, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Samplequerysets$Create, + callback: BodyResponseCallback ): void; - purge( - callback: BodyResponseCallback + create( + callback: BodyResponseCallback ): void; - purge( + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Purge - | BodyResponseCallback + | Params$Resource$Projects$Locations$Samplequerysets$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Purge; + {}) as Params$Resource$Projects$Locations$Samplequerysets$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Purge; + {} as Params$Resource$Projects$Locations$Samplequerysets$Create; options = {}; } @@ -28714,9 +32138,10 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: ( - rootUrl + '/v1alpha/{+parent}/suggestionDenyListEntries:purge' - ).replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1alpha/{+parent}/sampleQuerySets').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'POST', apiVersion: '', }, @@ -28728,103 +32153,73 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } - } - - export interface Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Import - extends StandardParameters { - /** - * Required. The parent data store resource name for which to import denylist entries. Follows pattern projects/x/locations/x/collections/x/dataStores/x. - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesRequest; - } - export interface Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Purge - extends StandardParameters { - /** - * Required. The parent data store resource name for which to import denylist entries. Follows pattern projects/x/locations/x/collections/x/dataStores/x. - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaPurgeSuggestionDenyListEntriesRequest; - } - - export class Resource$Projects$Locations$Datastores$Userevents { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * 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. + * Deletes a SampleQuerySet. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - collect( - params: Params$Resource$Projects$Locations$Datastores$Userevents$Collect, + delete( + params: Params$Resource$Projects$Locations$Samplequerysets$Delete, options: StreamMethodOptions ): GaxiosPromise; - collect( - params?: Params$Resource$Projects$Locations$Datastores$Userevents$Collect, + delete( + params?: Params$Resource$Projects$Locations$Samplequerysets$Delete, options?: MethodOptions - ): GaxiosPromise; - collect( - params: Params$Resource$Projects$Locations$Datastores$Userevents$Collect, + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Samplequerysets$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - collect( - params: Params$Resource$Projects$Locations$Datastores$Userevents$Collect, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Samplequerysets$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - collect( - params: Params$Resource$Projects$Locations$Datastores$Userevents$Collect, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Samplequerysets$Delete, + callback: BodyResponseCallback ): void; - collect(callback: BodyResponseCallback): void; - collect( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Userevents$Collect - | BodyResponseCallback + | Params$Resource$Projects$Locations$Samplequerysets$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Userevents$Collect; + {}) as Params$Resource$Projects$Locations$Samplequerysets$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Userevents$Collect; + {} as Params$Resource$Projects$Locations$Samplequerysets$Delete; options = {}; } @@ -28838,90 +32233,86 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/userEvents:collect').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * 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. + * Gets a SampleQuerySet. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - import( - params: Params$Resource$Projects$Locations$Datastores$Userevents$Import, + get( + params: Params$Resource$Projects$Locations$Samplequerysets$Get, options: StreamMethodOptions ): GaxiosPromise; - import( - params?: Params$Resource$Projects$Locations$Datastores$Userevents$Import, + get( + params?: Params$Resource$Projects$Locations$Samplequerysets$Get, options?: MethodOptions - ): GaxiosPromise; - import( - params: Params$Resource$Projects$Locations$Datastores$Userevents$Import, + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Samplequerysets$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - import( - params: Params$Resource$Projects$Locations$Datastores$Userevents$Import, + get( + params: Params$Resource$Projects$Locations$Samplequerysets$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - import( - params: Params$Resource$Projects$Locations$Datastores$Userevents$Import, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Samplequerysets$Get, + callback: BodyResponseCallback ): void; - import( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - import( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Userevents$Import - | BodyResponseCallback + | Params$Resource$Projects$Locations$Samplequerysets$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Userevents$Import; + {}) as Params$Resource$Projects$Locations$Samplequerysets$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Datastores$Userevents$Import; + params = {} as Params$Resource$Projects$Locations$Samplequerysets$Get; options = {}; } @@ -28935,90 +32326,88 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/userEvents:import').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * 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. + * Gets a list of SampleQuerySets. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - purge( - params: Params$Resource$Projects$Locations$Datastores$Userevents$Purge, + list( + params: Params$Resource$Projects$Locations$Samplequerysets$List, options: StreamMethodOptions ): GaxiosPromise; - purge( - params?: Params$Resource$Projects$Locations$Datastores$Userevents$Purge, + list( + params?: Params$Resource$Projects$Locations$Samplequerysets$List, options?: MethodOptions - ): GaxiosPromise; - purge( - params: Params$Resource$Projects$Locations$Datastores$Userevents$Purge, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Samplequerysets$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - purge( - params: Params$Resource$Projects$Locations$Datastores$Userevents$Purge, + list( + params: Params$Resource$Projects$Locations$Samplequerysets$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - purge( - params: Params$Resource$Projects$Locations$Datastores$Userevents$Purge, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Samplequerysets$List, + callback: BodyResponseCallback ): void; - purge( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - purge( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Userevents$Purge - | BodyResponseCallback + | Params$Resource$Projects$Locations$Samplequerysets$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Userevents$Purge; + {}) as Params$Resource$Projects$Locations$Samplequerysets$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Datastores$Userevents$Purge; + params = {} as Params$Resource$Projects$Locations$Samplequerysets$List; options = {}; } @@ -29032,11 +32421,11 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/userEvents:purge').replace( + url: (rootUrl + '/v1alpha/{+parent}/sampleQuerySets').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', apiVersion: '', }, options @@ -29047,75 +32436,76 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Writes a single user event. + * Updates a SampleQuerySet. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - write( - params: Params$Resource$Projects$Locations$Datastores$Userevents$Write, + patch( + params: Params$Resource$Projects$Locations$Samplequerysets$Patch, options: StreamMethodOptions ): GaxiosPromise; - write( - params?: Params$Resource$Projects$Locations$Datastores$Userevents$Write, + patch( + params?: Params$Resource$Projects$Locations$Samplequerysets$Patch, options?: MethodOptions - ): GaxiosPromise; - write( - params: Params$Resource$Projects$Locations$Datastores$Userevents$Write, + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Samplequerysets$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - write( - params: Params$Resource$Projects$Locations$Datastores$Userevents$Write, + patch( + params: Params$Resource$Projects$Locations$Samplequerysets$Patch, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - write( - params: Params$Resource$Projects$Locations$Datastores$Userevents$Write, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Samplequerysets$Patch, + callback: BodyResponseCallback ): void; - write( - callback: BodyResponseCallback + patch( + callback: BodyResponseCallback ): void; - write( + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Userevents$Write - | BodyResponseCallback + | Params$Resource$Projects$Locations$Samplequerysets$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Userevents$Write; + {}) as Params$Resource$Projects$Locations$Samplequerysets$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Datastores$Userevents$Write; + params = {} as Params$Resource$Projects$Locations$Samplequerysets$Patch; options = {}; } @@ -29129,105 +32519,93 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/userEvents:write').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } } - export interface Params$Resource$Projects$Locations$Datastores$Userevents$Collect + export interface Params$Resource$Projects$Locations$Samplequerysets$Create extends StandardParameters { /** - * The event timestamp in milliseconds. This prevents browser caching of otherwise identical get requests. The name is abbreviated to reduce the payload bytes. - */ - ets?: string; - /** - * Required. The parent DataStore resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}`. + * Required. The parent resource name, such as `projects/{project\}/locations/{location\}`. */ parent?: string; /** - * 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 third-party requests. + * Required. The ID to use for the SampleQuerySet, which will become the final component of the SampleQuerySet.name. If the caller does not have permission to create the SampleQuerySet, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. This field must be unique among all SampleQuerySets with the same parent. Otherwise, an `ALREADY_EXISTS` error is returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. */ - uri?: string; + sampleQuerySetId?: string; + /** - * Required. URL encoded UserEvent proto with a length limit of 2,000,000 characters. + * Request body metadata */ - userEvent?: string; + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaSampleQuerySet; } - export interface Params$Resource$Projects$Locations$Datastores$Userevents$Import + export interface Params$Resource$Projects$Locations$Samplequerysets$Delete extends StandardParameters { /** - * Required. Parent DataStore resource name, of the form `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}` + * Required. Full resource name of SampleQuerySet, such as `projects/{project\}/locations/{location\}/sampleQuerySets/{sampleQuerySet\}`. If the caller does not have permission to delete the SampleQuerySet, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the SampleQuerySet to delete does not exist, a `NOT_FOUND` error is returned. */ - parent?: string; - + name?: string; + } + export interface Params$Resource$Projects$Locations$Samplequerysets$Get + extends StandardParameters { /** - * Request body metadata + * Required. Full resource name of SampleQuerySet, such as `projects/{project\}/locations/{location\}/sampleQuerySets/{sampleQuerySet\}`. If the caller does not have permission to access the SampleQuerySet, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested SampleQuerySet does not exist, a NOT_FOUND error is returned. */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaImportUserEventsRequest; + name?: string; } - export interface Params$Resource$Projects$Locations$Datastores$Userevents$Purge + export interface Params$Resource$Projects$Locations$Samplequerysets$List extends StandardParameters { /** - * Required. The resource name of the catalog under which the events are created. The format is `projects/${projectId\}/locations/global/collections/{$collectionId\}/dataStores/${dataStoreId\}` + * Maximum number of SampleQuerySets to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned. */ - parent?: string; - + pageSize?: number; /** - * Request body metadata + * A page token ListSampleQuerySetsResponse.next_page_token, received from a previous SampleQuerySetService.ListSampleQuerySets call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SampleQuerySetService.ListSampleQuerySets must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned. */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaPurgeUserEventsRequest; + pageToken?: string; + /** + * Required. The parent location resource name, such as `projects/{project\}/locations/{location\}`. If the caller does not have permission to list SampleQuerySets under this location, regardless of whether or not this location exists, a `PERMISSION_DENIED` error is returned. + */ + parent?: string; } - export interface Params$Resource$Projects$Locations$Datastores$Userevents$Write + export interface Params$Resource$Projects$Locations$Samplequerysets$Patch extends StandardParameters { /** - * Required. The parent resource name. If the write user event action is applied in DataStore level, the format is: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}`. If the write user event action is applied in Location level, for example, the event with Document across multiple DataStore, the format is: `projects/{project\}/locations/{location\}`. + * Immutable. The full resource name of the SampleQuerySet, in the format of `projects/{project\}/locations/{location\}/sampleQuerySets/{sampleQuerySet\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. */ - parent?: string; + name?: string; /** - * If set to true, the user event is written asynchronously after validation, and the API responds without waiting for the write. + * Indicates which fields in the provided imported 'sample query set' to update. If not set, will by default update all fields. */ - writeAsync?: boolean; + updateMask?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaUserEvent; - } - - export class Resource$Projects$Locations$Evaluations { - context: APIRequestContext; - operations: Resource$Projects$Locations$Evaluations$Operations; - constructor(context: APIRequestContext) { - this.context = context; - this.operations = new Resource$Projects$Locations$Evaluations$Operations( - this.context - ); - } + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaSampleQuerySet; } - export class Resource$Projects$Locations$Evaluations$Operations { + export class Resource$Projects$Locations$Samplequerysets$Operations { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; @@ -29242,27 +32620,27 @@ export namespace discoveryengine_v1alpha { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Evaluations$Operations$Get, + params: Params$Resource$Projects$Locations$Samplequerysets$Operations$Get, options: StreamMethodOptions ): GaxiosPromise; get( - params?: Params$Resource$Projects$Locations$Evaluations$Operations$Get, + params?: Params$Resource$Projects$Locations$Samplequerysets$Operations$Get, options?: MethodOptions ): GaxiosPromise; get( - params: Params$Resource$Projects$Locations$Evaluations$Operations$Get, + params: Params$Resource$Projects$Locations$Samplequerysets$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Evaluations$Operations$Get, + params: Params$Resource$Projects$Locations$Samplequerysets$Operations$Get, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Evaluations$Operations$Get, + params: Params$Resource$Projects$Locations$Samplequerysets$Operations$Get, callback: BodyResponseCallback ): void; get( @@ -29270,7 +32648,7 @@ export namespace discoveryengine_v1alpha { ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Evaluations$Operations$Get + | Params$Resource$Projects$Locations$Samplequerysets$Operations$Get | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -29286,13 +32664,13 @@ export namespace discoveryengine_v1alpha { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Evaluations$Operations$Get; + {}) as Params$Resource$Projects$Locations$Samplequerysets$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Evaluations$Operations$Get; + {} as Params$Resource$Projects$Locations$Samplequerysets$Operations$Get; options = {}; } @@ -29328,7 +32706,7 @@ export namespace discoveryengine_v1alpha { } } - export interface Params$Resource$Projects$Locations$Evaluations$Operations$Get + export interface Params$Resource$Projects$Locations$Samplequerysets$Operations$Get extends StandardParameters { /** * The name of the operation resource. @@ -29336,72 +32714,72 @@ export namespace discoveryengine_v1alpha { name?: string; } - export class Resource$Projects$Locations$Groundingconfigs { + export class Resource$Projects$Locations$Samplequerysets$Samplequeries { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * Performs a grounding check. + * Creates a SampleQuery * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - check( - params: Params$Resource$Projects$Locations$Groundingconfigs$Check, + create( + params: Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Create, options: StreamMethodOptions ): GaxiosPromise; - check( - params?: Params$Resource$Projects$Locations$Groundingconfigs$Check, + create( + params?: Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Create, options?: MethodOptions - ): GaxiosPromise; - check( - params: Params$Resource$Projects$Locations$Groundingconfigs$Check, + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - check( - params: Params$Resource$Projects$Locations$Groundingconfigs$Check, + create( + params: Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Create, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - check( - params: Params$Resource$Projects$Locations$Groundingconfigs$Check, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Create, + callback: BodyResponseCallback ): void; - check( - callback: BodyResponseCallback + create( + callback: BodyResponseCallback ): void; - check( + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Groundingconfigs$Check - | BodyResponseCallback + | Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Groundingconfigs$Check; + {}) as Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Groundingconfigs$Check; + {} as Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Create; options = {}; } @@ -29415,7 +32793,7 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+groundingConfig}:check').replace( + url: (rootUrl + '/v1alpha/{+parent}/sampleQueries').replace( /([^:]\/)\/+/g, '$1' ), @@ -29425,101 +32803,78 @@ export namespace discoveryengine_v1alpha { options ), params, - requiredParams: ['groundingConfig'], - pathParams: ['groundingConfig'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } - } - - export interface Params$Resource$Projects$Locations$Groundingconfigs$Check - extends StandardParameters { - /** - * Required. The resource name of the grounding config, such as `projects/x/locations/global/groundingConfigs/default_grounding_config`. - */ - groundingConfig?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaCheckGroundingRequest; - } - - export class Resource$Projects$Locations$Operations { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * 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. + * Deletes a SampleQuery. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Operations$Get, + delete( + params: Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Delete, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Operations$Get, + delete( + params?: Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Delete, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Operations$Get, + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Operations$Get, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Projects$Locations$Operations$Get, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Delete, + callback: BodyResponseCallback ): void; - get( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Operations$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Operations$Get; + {}) as Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Operations$Get; + params = + {} as Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Delete; options = {}; } @@ -29534,7 +32889,7 @@ export namespace discoveryengine_v1alpha { options: Object.assign( { url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'DELETE', apiVersion: '', }, options @@ -29545,74 +32900,75 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + * Gets a SampleQuery. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Operations$List, + get( + params: Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Get, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Operations$List, + get( + params?: Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Get, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Operations$List, + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Operations$List, + get( + params: Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Operations$List, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Get, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - list( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Operations$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Operations$List; + {}) as Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Operations$List; + params = + {} as Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Get; options = {}; } @@ -29626,125 +32982,89 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}/operations').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), method: 'GET', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest( - parameters - ); - } - } - } - - export interface Params$Resource$Projects$Locations$Operations$Get - extends StandardParameters { - /** - * The name of the operation resource. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Operations$List - extends StandardParameters { - /** - * The standard list filter. - */ - filter?: string; - /** - * The name of the operation's parent resource. - */ - name?: string; - /** - * The standard list page size. - */ - pageSize?: number; - /** - * The standard list page token. - */ - pageToken?: string; - } - - export class Resource$Projects$Locations$Rankingconfigs { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } } /** - * Ranks a list of text records based on the given input query. + * Bulk import of multiple SampleQuerys. Sample queries that already exist may be deleted. Note: It is possible for a subset of the SampleQuerys to be successfully imported. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - rank( - params: Params$Resource$Projects$Locations$Rankingconfigs$Rank, + import( + params: Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Import, options: StreamMethodOptions ): GaxiosPromise; - rank( - params?: Params$Resource$Projects$Locations$Rankingconfigs$Rank, + import( + params?: Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Import, options?: MethodOptions - ): GaxiosPromise; - rank( - params: Params$Resource$Projects$Locations$Rankingconfigs$Rank, + ): GaxiosPromise; + import( + params: Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Import, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - rank( - params: Params$Resource$Projects$Locations$Rankingconfigs$Rank, + import( + params: Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Import, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - rank( - params: Params$Resource$Projects$Locations$Rankingconfigs$Rank, - callback: BodyResponseCallback + import( + params: Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Import, + callback: BodyResponseCallback ): void; - rank( - callback: BodyResponseCallback + import( + callback: BodyResponseCallback ): void; - rank( + import( paramsOrCallback?: - | Params$Resource$Projects$Locations$Rankingconfigs$Rank - | BodyResponseCallback + | Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Import + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Rankingconfigs$Rank; + {}) as Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Import; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Rankingconfigs$Rank; + params = + {} as Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Import; options = {}; } @@ -29758,7 +33078,7 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+rankingConfig}:rank').replace( + url: (rootUrl + '/v1alpha/{+parent}/sampleQueries:import').replace( /([^:]\/)\/+/g, '$1' ), @@ -29768,102 +33088,80 @@ export namespace discoveryengine_v1alpha { options ), params, - requiredParams: ['rankingConfig'], - pathParams: ['rankingConfig'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Projects$Locations$Rankingconfigs$Rank - extends StandardParameters { - /** - * Required. The resource name of the rank service config, such as `projects/{project_num\}/locations/{location_id\}/rankingConfigs/default_ranking_config`. - */ - rankingConfig?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaRankRequest; - } - - export class Resource$Projects$Locations$Requirements { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Check a particular requirement. + * Gets a list of SampleQuerys. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - checkRequirement( - params: Params$Resource$Projects$Locations$Requirements$Checkrequirement, + list( + params: Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$List, options: StreamMethodOptions ): GaxiosPromise; - checkRequirement( - params?: Params$Resource$Projects$Locations$Requirements$Checkrequirement, + list( + params?: Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$List, options?: MethodOptions - ): GaxiosPromise; - checkRequirement( - params: Params$Resource$Projects$Locations$Requirements$Checkrequirement, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - checkRequirement( - params: Params$Resource$Projects$Locations$Requirements$Checkrequirement, + list( + params: Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - checkRequirement( - params: Params$Resource$Projects$Locations$Requirements$Checkrequirement, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$List, + callback: BodyResponseCallback ): void; - checkRequirement( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - checkRequirement( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Requirements$Checkrequirement - | BodyResponseCallback + | Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Requirements$Checkrequirement; + {}) as Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Requirements$Checkrequirement; + {} as Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$List; options = {}; } @@ -29877,123 +33175,92 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: ( - rootUrl + '/v1alpha/{+location}/requirements:checkRequirement' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + url: (rootUrl + '/v1alpha/{+parent}/sampleQueries').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['location'], - pathParams: ['location'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } - } - - export interface Params$Resource$Projects$Locations$Requirements$Checkrequirement - extends StandardParameters { - /** - * Required. Full resource name of the location. Format `projects/{project_number_or_id\}/locations/{location\}` - */ - location?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaCheckRequirementRequest; - } - - export class Resource$Projects$Locations$Samplequerysets { - context: APIRequestContext; - operations: Resource$Projects$Locations$Samplequerysets$Operations; - constructor(context: APIRequestContext) { - this.context = context; - this.operations = - new Resource$Projects$Locations$Samplequerysets$Operations( - this.context - ); - } - } - - export class Resource$Projects$Locations$Samplequerysets$Operations { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * 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. + * Updates a SampleQuery. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Samplequerysets$Operations$Get, + patch( + params: Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Patch, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Samplequerysets$Operations$Get, + patch( + params?: Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Patch, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Samplequerysets$Operations$Get, + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Samplequerysets$Operations$Get, + patch( + params: Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Patch, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Samplequerysets$Operations$Get, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Patch, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + patch( + callback: BodyResponseCallback ): void; - get( + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Samplequerysets$Operations$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Samplequerysets$Operations$Get; + {}) as Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Samplequerysets$Operations$Get; + {} as Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Patch; options = {}; } @@ -30008,7 +33275,7 @@ export namespace discoveryengine_v1alpha { options: Object.assign( { url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'PATCH', apiVersion: '', }, options @@ -30019,23 +33286,91 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } } - export interface Params$Resource$Projects$Locations$Samplequerysets$Operations$Get + export interface Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Create extends StandardParameters { /** - * The name of the operation resource. + * Required. The parent resource name, such as `projects/{project\}/locations/{location\}/sampleQuerySets/{sampleQuerySet\}`. + */ + parent?: string; + /** + * Required. The ID to use for the SampleQuery, which will become the final component of the SampleQuery.name. If the caller does not have permission to create the SampleQuery, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. This field must be unique among all SampleQuerys with the same parent. Otherwise, an `ALREADY_EXISTS` error is returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. + */ + sampleQueryId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaSampleQuery; + } + export interface Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Delete + extends StandardParameters { + /** + * Required. Full resource name of SampleQuery, such as `projects/{project\}/locations/{location\}/sampleQuerySets/{sampleQuerySet\}/sampleQueries/{sampleQuery\}`. If the caller does not have permission to delete the SampleQuery, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the SampleQuery to delete does not exist, a `NOT_FOUND` error is returned. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Get + extends StandardParameters { + /** + * Required. Full resource name of SampleQuery, such as `projects/{project\}/locations/{location\}/sampleQuerySets/{sampleQuerySet\}/sampleQueries/{sampleQuery\}`. If the caller does not have permission to access the SampleQuery, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested SampleQuery does not exist, a NOT_FOUND error is returned. */ name?: string; } + export interface Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Import + extends StandardParameters { + /** + * Required. The parent sample query set resource name, such as `projects/{project\}/locations/{location\}/sampleQuerySets/{sampleQuerySet\}`. If the caller does not have permission to list SampleQuerys under this sample query set, regardless of whether or not this sample query set exists, a `PERMISSION_DENIED` error is returned. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaImportSampleQueriesRequest; + } + export interface Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$List + extends StandardParameters { + /** + * Maximum number of SampleQuerys to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned. + */ + pageSize?: number; + /** + * A page token ListSampleQueriesResponse.next_page_token, received from a previous SampleQueryService.ListSampleQueries call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SampleQueryService.ListSampleQueries must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned. + */ + pageToken?: string; + /** + * Required. The parent sample query set resource name, such as `projects/{project\}/locations/{location\}/sampleQuerySets/{sampleQuerySet\}`. If the caller does not have permission to list SampleQuerys under this sample query set, regardless of whether or not this sample query set exists, a `PERMISSION_DENIED` error is returned. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Patch + extends StandardParameters { + /** + * Immutable. The full resource name of the sample query, in the format of `projects/{project\}/locations/{location\}/sampleQuerySets/{sampleQuerySet\}/sampleQueries/{sampleQuery\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. + */ + name?: string; + /** + * Indicates which fields in the provided imported 'simple query' to update. If not set, will by default update all fields. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaSampleQuery; + } export class Resource$Projects$Locations$Userevents { context: APIRequestContext; diff --git a/src/apis/discoveryengine/v1beta.ts b/src/apis/discoveryengine/v1beta.ts index 72aabf0456..0b457d1ae2 100644 --- a/src/apis/discoveryengine/v1beta.ts +++ b/src/apis/discoveryengine/v1beta.ts @@ -502,6 +502,10 @@ export namespace discoveryengine_v1beta { * If citation_type is DOCUMENT_LEVEL_CITATION, populate document level snippets. */ snippetInfo?: Schema$GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultSnippetInfo[]; + /** + * 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 . + */ + structData?: {[key: string]: any} | null; /** * Title. */ @@ -730,6 +734,10 @@ export namespace discoveryengine_v1beta { */ updateTime?: string | null; } + /** + * Metadata for EvaluationService.CreateEvaluation method. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaCreateEvaluationMetadata {} /** * Metadata for Create Schema LRO. */ @@ -756,6 +764,15 @@ export namespace discoveryengine_v1beta { */ updateTime?: string | null; } + /** + * Defines custom fine tuning spec. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec { + /** + * Whether or not to enable and include custom fine tuned search adaptor model. + */ + enableSearchAdaptor?: boolean | null; + } /** * Metadata that describes a custom tuned model. */ @@ -768,6 +785,10 @@ export namespace discoveryengine_v1beta { * The display name of the model. */ displayName?: string | null; + /** + * The metrics of the trained model. + */ + metrics?: {[key: string]: number} | null; /** * The state that the model is in (e.g.`TRAINING` or `TRAINING_FAILED`). */ @@ -924,7 +945,7 @@ export namespace discoveryengine_v1beta { */ name?: string | null; /** - * 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 or layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and or layout parsing are supported. + * 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. */ parsingConfigOverrides?: { [ @@ -1216,6 +1237,91 @@ export namespace discoveryengine_v1beta { */ documentCount?: string | null; } + /** + * An evaluation is a single execution (or run) of an evaluation process. It encapsulates the state of the evaluation and the resulting data. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaEvaluation { + /** + * Output only. Timestamp the Evaluation was created at. + */ + createTime?: string | null; + /** + * Output only. Timestamp the Evaluation was completed at. + */ + endTime?: string | null; + /** + * Output only. The error that occurred during evaluation. Only populated when the evaluation's state is FAILED. + */ + error?: Schema$GoogleRpcStatus; + /** + * Output only. A sample of errors encountered while processing the request. + */ + errorSamples?: Schema$GoogleRpcStatus[]; + /** + * Required. The specification of the evaluation. + */ + evaluationSpec?: Schema$GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpec; + /** + * Immutable. 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. + */ + name?: string | null; + /** + * Output only. The metrics produced by the evaluation, averaged across all SampleQuerys in the SampleQuerySet. Only populated when the evaluation's state is SUCCEEDED. + */ + qualityMetrics?: Schema$GoogleCloudDiscoveryengineV1alphaQualityMetrics; + /** + * Output only. The state of the evaluation. + */ + state?: string | null; + } + /** + * Describes the specification of the evaluation. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpec { + /** + * Required. The specification of the query set. + */ + querySetSpec?: Schema$GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpecQuerySetSpec; + /** + * 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 + */ + searchRequest?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequest; + } + /** + * Describes the specification of the query set. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpecQuerySetSpec { + /** + * Required. The full resource name of the SampleQuerySet used for the evaluation, in the format of `projects/{project\}/locations/{location\}/sampleQuerySets/{sampleQuerySet\}`. + */ + sampleQuerySet?: string | null; + } + /** + * Metadata related to the progress of the Export operation. This is returned by the google.longrunning.Operation.metadata field. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaExportUserEventsMetadata { + /** + * Operation create time. + */ + createTime?: string | null; + /** + * Operation last update time. If the operation is done, this is also the finish time. + */ + updateTime?: string | null; + } + /** + * Response of the ExportUserEventsRequest. If the long running operation was successful, then this message is returned by the google.longrunning.Operations.response field. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaExportUserEventsResponse { + /** + * Output result indicating where the data were exported to. + */ + outputResult?: Schema$GoogleCloudDiscoveryengineV1alphaOutputResult; + /** + * The status of the export operation. + */ + status?: Schema$GoogleRpcStatus; + } /** * Configurations for fields of a schema. For example, configuring a field is indexable, or searchable. */ @@ -1265,6 +1371,15 @@ export namespace discoveryengine_v1beta { */ searchableOption?: string | null; } + /** + * Response message for SiteSearchEngineService.GetUriPatternDocumentData method. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaGetUriPatternDocumentDataResponse { + /** + * Document data keyed by URI pattern. For example: document_data_map = { "www.url1.com/x": { "Categories": ["category1", "category2"] \}, "www.url2.com/x": { "Categories": ["category3"] \} \} + */ + documentDataMap?: {[key: string]: {[key: string]: any}} | null; + } /** * Identity Provider Config. */ @@ -1368,6 +1483,44 @@ export namespace discoveryengine_v1beta { */ gcsPrefix?: string | null; } + /** + * Metadata related to the progress of the ImportSampleQueries operation. This will be returned by the google.longrunning.Operation.metadata field. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaImportSampleQueriesMetadata { + /** + * ImportSampleQueries operation create time. + */ + createTime?: string | null; + /** + * Count of SampleQuerys that failed to be imported. + */ + failureCount?: string | null; + /** + * Count of SampleQuerys successfully imported. + */ + successCount?: string | null; + /** + * Total count of SampleQuerys that were processed. + */ + totalCount?: string | null; + /** + * ImportSampleQueries operation last update time. If the operation is done, this is also the finish time. + */ + updateTime?: string | null; + } + /** + * 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. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaImportSampleQueriesResponse { + /** + * The desired location of errors incurred during the Import. + */ + errorConfig?: Schema$GoogleCloudDiscoveryengineV1alphaImportErrorConfig; + /** + * A sample of errors encountered while processing the request. + */ + errorSamples?: Schema$GoogleRpcStatus[]; + } /** * Metadata related to the progress of the ImportSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field. */ @@ -1440,6 +1593,27 @@ export namespace discoveryengine_v1beta { */ unjoinedEventsCount?: string | null; } + /** + * A floating point interval. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaInterval { + /** + * Exclusive upper bound. + */ + exclusiveMaximum?: number | null; + /** + * Exclusive lower bound. + */ + exclusiveMinimum?: number | null; + /** + * Inclusive upper bound. + */ + maximum?: number | null; + /** + * Inclusive lower bound. + */ + minimum?: number | null; + } /** * Language info for DataStore. */ @@ -1470,6 +1644,28 @@ export namespace discoveryengine_v1beta { */ models?: Schema$GoogleCloudDiscoveryengineV1alphaCustomTuningModel[]; } + /** + * Output result that stores the information about where the exported data is stored. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaOutputResult { + /** + * The BigQuery location where the result is stored. + */ + bigqueryResult?: Schema$GoogleCloudDiscoveryengineV1alphaOutputResultBigQueryOutputResult; + } + /** + * A BigQuery output result. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaOutputResultBigQueryOutputResult { + /** + * The ID of a BigQuery Dataset. + */ + datasetId?: string | null; + /** + * The ID of a BigQuery Table. + */ + tableId?: string | null; + } /** * Metadata and configurations for a Google Cloud project in the service. */ @@ -1644,6 +1840,52 @@ export namespace discoveryengine_v1beta { */ purgeCount?: string | null; } + /** + * Describes the metrics produced by the evaluation. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaQualityMetrics { + /** + * 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 + */ + docNdcg?: Schema$GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics; + /** + * 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 + */ + docPrecision?: Schema$GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics; + /** + * 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 + */ + docRecall?: Schema$GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics; + /** + * 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 + */ + pageNdcg?: Schema$GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics; + /** + * 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 + */ + pageRecall?: Schema$GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics; + } + /** + * Stores the metric values at specific top-k levels. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics { + /** + * The top-1 value. + */ + top1?: number | null; + /** + * The top-10 value. + */ + top10?: number | null; + /** + * The top-3 value. + */ + top3?: number | null; + /** + * The top-5 value. + */ + top5?: number | null; + } /** * Defines a user inputed query. */ @@ -1751,2620 +1993,2659 @@ export namespace discoveryengine_v1beta { structSchema?: {[key: string]: any} | null; } /** - * External session proto definition. + * Request message for SearchService.Search method. */ - export interface Schema$GoogleCloudDiscoveryengineV1alphaSession { + export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchRequest { /** - * Output only. The time the session finished. + * 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) */ - endTime?: string | null; + boostSpec?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpec; /** - * Immutable. Fully qualified name `projects/{project\}/locations/global/collections/{collection\}/engines/{engine\}/sessions/x` + * The branch resource name, such as `projects/x/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. */ - name?: string | null; + branch?: string | null; /** - * Output only. The time the session started. + * 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. */ - startTime?: string | null; + canonicalFilter?: string | null; /** - * The state of the session. + * A specification for configuring the behavior of content search. */ - state?: string | null; + contentSearchSpec?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpec; /** - * Turns. + * Custom fine tuning configs. If set, it has higher priority than the configs set in ServingConfig.custom_fine_tuning_spec. */ - turns?: Schema$GoogleCloudDiscoveryengineV1alphaSessionTurn[]; + customFineTuningSpec?: Schema$GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec; /** - * A unique identifier for tracking users. + * 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. */ - userPseudoId?: string | null; - } - /** - * Represents a turn, including a query from the user and a answer from service. - */ - export interface Schema$GoogleCloudDiscoveryengineV1alphaSessionTurn { + dataStoreSpecs?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec[]; /** - * The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn. + * 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. */ - answer?: string | null; + embeddingSpec?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpec; /** - * The user query. + * 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. */ - query?: Schema$GoogleCloudDiscoveryengineV1alphaQuery; - } - /** - * Verification information for target sites in advanced site search. - */ - export interface Schema$GoogleCloudDiscoveryengineV1alphaSiteVerificationInfo { + facetSpecs?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpec[]; /** - * Site verification state indicating the ownership and validity. + * 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) */ - siteVerificationState?: string | null; + filter?: string | null; /** - * Latest site verification time. + * Raw image query. */ - verifyTime?: string | null; - } - /** - * A target site for the SiteSearchEngine. - */ - export interface Schema$GoogleCloudDiscoveryengineV1alphaTargetSite { + imageQuery?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestImageQuery; /** - * 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. + * 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. */ - exactMatch?: boolean | null; + languageCode?: string | null; /** - * Output only. Failure reason. + * If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done. */ - failureReason?: Schema$GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReason; + naturalLanguageQueryUnderstandingSpec?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestNaturalLanguageQueryUnderstandingSpec; /** - * Output only. This is system-generated based on the provided_uri_pattern. + * 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. */ - generatedUriPattern?: string | null; + offset?: number | null; /** - * Output only. Indexing status. + * 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 for retail search, see [Ordering](https://cloud.google.com/retail/docs/filter-and-order#order) If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. */ - indexingStatus?: string | null; + orderBy?: string | null; /** - * 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. + * 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. */ - name?: string | null; + pageSize?: number | null; /** - * Required. Input only. The user provided URI pattern from which the `generated_uri_pattern` is generated. + * 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. */ - providedUriPattern?: string | null; + pageToken?: string | null; /** - * Output only. Root domain of the provided_uri_pattern. + * 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` */ - rootDomainUri?: string | null; + params?: {[key: string]: any} | null; /** - * Output only. Site ownership and validity verification status. + * Raw search query. */ - siteVerificationInfo?: Schema$GoogleCloudDiscoveryengineV1alphaSiteVerificationInfo; + query?: string | null; /** - * The type of the target site, e.g., whether the site is to be included or excluded. + * The query expansion specification that specifies the conditions under which query expansion occurs. */ - type?: string | null; + queryExpansionSpec?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestQueryExpansionSpec; /** - * Output only. The target site's last updated time. + * 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)`. */ - updateTime?: string | null; - } - /** - * Site search indexing failure reasons. - */ - export interface Schema$GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReason { + rankingExpression?: string | null; /** - * Failed due to insufficient quota. + * 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. */ - quotaFailure?: Schema$GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReasonQuotaFailure; - } - /** - * Failed due to insufficient quota. - */ - export interface Schema$GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReasonQuotaFailure { + regionCode?: string | null; /** - * This number is an estimation on how much total quota this project needs to successfully complete indexing. + * 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. */ - totalRequiredQuota?: string | null; - } - /** - * Metadata related to the progress of the TrainCustomModel operation. This is returned by the google.longrunning.Operation.metadata field. - */ - export interface Schema$GoogleCloudDiscoveryengineV1alphaTrainCustomModelMetadata { + relevanceThreshold?: string | null; /** - * Operation create time. + * Whether to turn on safe search. This is only supported for website search. */ - createTime?: string | null; + safeSearch?: boolean | null; /** - * Operation last update time. If the operation is done, this is also the finish time. + * Search as you type configuration. Only supported for the IndustryVertical.MEDIA vertical. */ - updateTime?: string | null; - } - /** - * Response of the TrainCustomModelRequest. This message is returned by the google.longrunning.Operations.response field. - */ - export interface Schema$GoogleCloudDiscoveryengineV1alphaTrainCustomModelResponse { + searchAsYouTypeSpec?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAsYouTypeSpec; /** - * Echoes the destination for the complete errors in the request if set. + * Required. The resource name of the Search serving config, such as `projects/x/locations/global/collections/default_collection/engines/x/servingConfigs/default_serving_config`, or `projects/x/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. */ - errorConfig?: Schema$GoogleCloudDiscoveryengineV1alphaImportErrorConfig; + servingConfig?: string | null; /** - * A sample of errors encountered while processing the data. + * 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. */ - errorSamples?: Schema$GoogleRpcStatus[]; + session?: string | null; /** - * The metrics of the trained model. + * Session specification. Can be used only when `session` is set. */ - metrics?: {[key: string]: number} | null; + sessionSpec?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestSessionSpec; /** - * Fully qualified name of the CustomTuningModel. + * The spell correction specification that specifies the mode under which spell correction takes effect. */ - modelName?: string | null; + spellCorrectionSpec?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestSpellCorrectionSpec; /** - * 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. + * Information about the end user. Highly recommended for analytics. UserInfo.user_agent is used to deduce `device_type` for analytics. */ - modelStatus?: string | null; + userInfo?: Schema$GoogleCloudDiscoveryengineV1alphaUserInfo; + /** + * 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. + */ + userLabels?: {[key: string]: string} | null; + /** + * 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. + */ + userPseudoId?: string | null; } /** - * Metadata associated with a tune operation. + * Boost specification to boost certain documents. */ - export interface Schema$GoogleCloudDiscoveryengineV1alphaTuneEngineMetadata { + export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpec { /** - * Required. The resource name of the engine that this tune applies to. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/engines/{engine_id\}` + * 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. */ - engine?: string | null; + conditionBoostSpecs?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpec[]; } /** - * Response associated with a tune operation. - */ - export interface Schema$GoogleCloudDiscoveryengineV1alphaTuneEngineResponse {} - /** - * Metadata for UpdateSchema LRO. + * Boost applies to documents which match a condition. */ - export interface Schema$GoogleCloudDiscoveryengineV1alphaUpdateSchemaMetadata { + export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpec { /** - * Operation create time. + * 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. */ - createTime?: string | null; + boost?: number | null; /** - * Operation last update time. If the operation is done, this is also the finish time. + * Complex specification for custom ranking based on customer defined attribute value. */ - updateTime?: string | null; + boostControlSpec?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpecBoostControlSpec; + /** + * 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"))` + */ + condition?: string | null; } /** - * Metadata related to the progress of the SiteSearchEngineService.UpdateTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field. + * Specification for custom ranking based on customer specified attribute value. It provides more controls for customized ranking than the simple (condition, boost) combination above. */ - export interface Schema$GoogleCloudDiscoveryengineV1alphaUpdateTargetSiteMetadata { + export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpecBoostControlSpec { /** - * Operation create time. + * 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). */ - createTime?: string | null; + attributeType?: string | null; /** - * Operation last update time. If the operation is done, this is also the finish time. + * The control points used to define the curve. The monotonic function (defined through the interpolation_type above) passes through the control points listed here. */ - updateTime?: string | null; + controlPoints?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpecBoostControlSpecControlPoint[]; + /** + * The name of the field whose value will be used to determine the boost amount. + */ + fieldName?: string | null; + /** + * The interpolation type to be applied to connect the control points listed below. + */ + interpolationType?: string | null; } /** - * Metadata related to the progress of the SiteSearchEngineService.BatchCreateTargetSites operation. This will be returned by the google.longrunning.Operation.metadata field. + * 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). */ - export interface Schema$GoogleCloudDiscoveryengineV1BatchCreateTargetSiteMetadata { + export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpecBoostControlSpecControlPoint { /** - * Operation create time. + * 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]`. */ - createTime?: string | null; + attributeValue?: string | null; /** - * Operation last update time. If the operation is done, this is also the finish time. + * The value between -1 to 1 by which to boost the score if the attribute_value evaluates to the value specified above. */ - updateTime?: string | null; + boostAmount?: number | null; } /** - * Response message for SiteSearchEngineService.BatchCreateTargetSites method. + * A specification for configuring the behavior of content search. */ - export interface Schema$GoogleCloudDiscoveryengineV1BatchCreateTargetSitesResponse { + export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpec { /** - * TargetSites created. + * Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS */ - targetSites?: Schema$GoogleCloudDiscoveryengineV1TargetSite[]; + chunkSpec?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecChunkSpec; + /** + * If there is no extractive_content_spec provided, there will be no extractive answer in the search response. + */ + extractiveContentSpec?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecExtractiveContentSpec; + /** + * Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`. + */ + searchResultMode?: string | null; + /** + * If `snippetSpec` is not specified, snippets are not included in the search response. + */ + snippetSpec?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSnippetSpec; + /** + * If `summarySpec` is not specified, summaries are not included in the search response. + */ + summarySpec?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpec; } /** - * AlloyDB source import data from. + * Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS */ - export interface Schema$GoogleCloudDiscoveryengineV1betaAlloyDbSource { + export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecChunkSpec { /** - * Required. The AlloyDB cluster to copy the data from with a length limit of 256 characters. + * 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. */ - clusterId?: string | null; + numNextChunks?: number | null; /** - * Required. The AlloyDB database to copy the data from with a length limit of 256 characters. + * 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. */ - databaseId?: string | null; + numPreviousChunks?: number | null; + } + /** + * A specification for configuring the extractive content in a search response. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecExtractiveContentSpec { /** - * 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. + * 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. */ - gcsStagingDir?: string | null; + maxExtractiveAnswerCount?: number | null; /** - * Required. The AlloyDB location to copy the data from with a length limit of 256 characters. + * 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`. */ - locationId?: string | null; + maxExtractiveSegmentCount?: number | null; /** - * The project ID that the AlloyDB source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request. + * Return at most `num_next_segments` segments after each selected segments. */ - projectId?: string | null; + numNextSegments?: number | null; /** - * Required. The AlloyDB table to copy the data from with a length limit of 256 characters. + * Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments. */ - tableId?: string | null; + numPreviousSegments?: number | null; + /** + * 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`. + */ + returnExtractiveSegmentScore?: boolean | null; } /** - * Defines an answer. + * A specification for configuring snippets in a search response. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaAnswer { + export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSnippetSpec { /** - * Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set. + * [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. */ - answerSkippedReasons?: string[] | null; + maxSnippetCount?: number | null; /** - * The textual answer. + * [DEPRECATED] This field is deprecated and will have no affect on the snippet. */ - answerText?: string | null; + referenceOnly?: boolean | null; /** - * Citations. + * 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. */ - citations?: Schema$GoogleCloudDiscoveryengineV1betaAnswerCitation[]; + returnSnippet?: boolean | null; + } + /** + * A specification for configuring a summary returned in a search response. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpec { /** - * Output only. Answer completed timestamp. + * 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. */ - completeTime?: string | null; + ignoreAdversarialQuery?: boolean | null; /** - * Output only. Answer creation timestamp. + * 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. */ - createTime?: string | null; + ignoreNonSummarySeekingQuery?: boolean | null; /** - * Immutable. Fully qualified name `projects/{project\}/locations/global/collections/{collection\}/engines/{engine\}/sessions/x/answers/x` + * 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. */ - name?: string | null; + includeCitations?: boolean | null; /** - * Query understanding information. + * 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. */ - queryUnderstandingInfo?: Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryUnderstandingInfo; + languageCode?: string | null; /** - * References. + * If specified, the spec will be used to modify the prompt provided to the LLM. */ - references?: Schema$GoogleCloudDiscoveryengineV1betaAnswerReference[]; + modelPromptSpec?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelPromptSpec; /** - * Suggested related questions. + * If specified, the spec will be used to modify the model specification provided to the LLM. */ - relatedQuestions?: string[] | null; + modelSpec?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelSpec; /** - * The state of the answer generation. + * 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. */ - state?: string | null; + summaryResultCount?: number | null; /** - * Answer generation steps. + * 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. */ - steps?: Schema$GoogleCloudDiscoveryengineV1betaAnswerStep[]; + useSemanticChunks?: boolean | null; } /** - * Citation info for a segment. + * Specification of the prompt to use with the model. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaAnswerCitation { + export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelPromptSpec { /** - * End of the attributed segment, exclusive. + * Text at the beginning of the prompt that instructs the assistant. Examples are available in the user guide. */ - endIndex?: string | null; + preamble?: string | null; + } + /** + * Specification of the model. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelSpec { /** - * Citation sources for the attributed segment. + * 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). */ - sources?: Schema$GoogleCloudDiscoveryengineV1betaAnswerCitationSource[]; + version?: string | null; + } + /** + * 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. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec { /** - * Index indicates the start of the segment, measured in bytes (UTF-8 unicode). + * Required. Full resource name of DataStore, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}`. */ - startIndex?: string | null; + dataStore?: string | null; } /** - * Citation source. + * The specification that uses customized query embedding vector to do semantic document retrieval. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaAnswerCitationSource { + export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpec { /** - * ID of the citation source. + * The embedding vector used for retrieval. Limit to 1. */ - referenceId?: string | null; + embeddingVectors?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpecEmbeddingVector[]; } /** - * Request message for ConversationalSearchService.AnswerQuery method. + * Embedding vector. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryRequest { + export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpecEmbeddingVector { /** - * Answer generation specification. + * Embedding field path in schema. */ - answerGenerationSpec?: Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryRequestAnswerGenerationSpec; + fieldPath?: string | null; /** - * 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. + * Query embedding vector. */ - asynchronousMode?: boolean | null; + vector?: number[] | null; + } + /** + * A facet specification to perform faceted search. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpec { /** - * Required. Current user query. + * 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. */ - query?: Schema$GoogleCloudDiscoveryengineV1betaQuery; + enableDynamicPosition?: boolean | null; /** - * Query understanding specification. + * 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. */ - queryUnderstandingSpec?: Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryRequestQueryUnderstandingSpec; + excludedFilterKeys?: string[] | null; /** - * Related questions specification. + * Required. The facet key specification. */ - relatedQuestionsSpec?: Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryRequestRelatedQuestionsSpec; + facetKey?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpecFacetKey; /** - * Model specification. - */ - safetySpec?: Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSafetySpec; - /** - * Search specification. - */ - searchSpec?: Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSearchSpec; - /** - * 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. - */ - session?: string | null; - /** - * 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. - */ - userLabels?: {[key: string]: string} | null; - /** - * 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. + * 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. */ - userPseudoId?: string | null; + limit?: number | null; } /** - * Answer generation specification. + * Specifies how a facet is computed. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryRequestAnswerGenerationSpec { + export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpecFacetKey { /** - * 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. + * True to make facet keys case insensitive when getting faceting values with prefixes or contains; false otherwise. */ - answerLanguageCode?: string | null; + caseInsensitive?: boolean | null; /** - * 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. + * 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. */ - ignoreAdversarialQuery?: boolean | null; + contains?: string[] | null; /** - * 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. + * 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. */ - ignoreLowRelevantContent?: boolean | null; + intervals?: Schema$GoogleCloudDiscoveryengineV1alphaInterval[]; /** - * 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. + * Required. Supported textual and numerical facet keys in Document object, over which the facet values are computed. Facet key is case-sensitive. */ - ignoreNonAnswerSeekingQuery?: boolean | null; + key?: string | null; /** - * Specifies whether to include citation metadata in the answer. The default value is `false`. + * 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. */ - includeCitations?: boolean | null; + orderBy?: string | null; /** - * Answer generation model specification. + * 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. */ - modelSpec?: Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryRequestAnswerGenerationSpecModelSpec; + prefixes?: string[] | null; /** - * Answer generation prompt specification. + * 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. */ - promptSpec?: Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryRequestAnswerGenerationSpecPromptSpec; + restrictedValues?: string[] | null; } /** - * Answer Generation Model specification. + * Specifies the image query input. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryRequestAnswerGenerationSpecModelSpec { + export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestImageQuery { /** - * Model version. If not set, it will use the default stable model. Allowed values are: stable, preview. + * Base64 encoded image bytes. Supported image formats: JPEG, PNG, and BMP. */ - modelVersion?: string | null; + imageBytes?: string | null; } /** - * Answer generation prompt specification. + * Specification to enable natural language understanding capabilities for search requests. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryRequestAnswerGenerationSpecPromptSpec { + export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestNaturalLanguageQueryUnderstandingSpec { /** - * Customized preamble. + * The condition under which filter extraction should occur. Default to Condition.DISABLED. */ - preamble?: string | null; + filterExtractionCondition?: string | null; + /** + * 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. + */ + geoSearchQueryDetectionFieldNames?: string[] | null; } /** - * Query understanding specification. + * Specification to determine under which conditions query expansion should occur. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryRequestQueryUnderstandingSpec { + export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestQueryExpansionSpec { /** - * Query classification specification. + * The condition under which query expansion should occur. Default to Condition.DISABLED. */ - queryClassificationSpec?: Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryRequestQueryUnderstandingSpecQueryClassificationSpec; + condition?: string | null; /** - * Query rephraser specification. + * 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. */ - queryRephraserSpec?: Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryRequestQueryUnderstandingSpecQueryRephraserSpec; + pinUnexpandedResults?: boolean | null; } /** - * Query classification specification. + * Specification for search as you type in search requests. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryRequestQueryUnderstandingSpecQueryClassificationSpec { + export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAsYouTypeSpec { /** - * Enabled query classification types. + * The condition under which search as you type should occur. Default to Condition.DISABLED. */ - types?: string[] | null; + condition?: string | null; } /** - * Query rephraser specification. + * 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. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryRequestQueryUnderstandingSpecQueryRephraserSpec { - /** - * Disable query rephraser. - */ - disable?: boolean | null; + export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestSessionSpec { /** - * Max rephrase steps. The max number is 5 steps. If not set or set to < 1, it will be set to 1 by default. + * 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. */ - maxRephraseSteps?: number | null; - } - /** - * Related questions specification. - */ - export interface Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryRequestRelatedQuestionsSpec { + queryId?: string | null; /** - * Enable related questions feature if true. + * 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. */ - enable?: boolean | null; + searchResultPersistenceCount?: number | null; } /** - * Safety specification. + * The specification for query spell correction. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSafetySpec { + export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestSpellCorrectionSpec { /** - * Enable the safety filtering on the answer response. It is false by default. + * The mode under which spell correction replaces the original search query. Defaults to Mode.AUTO. */ - enable?: boolean | null; + mode?: string | null; } /** - * Search specification. + * External session proto definition. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSearchSpec { + export interface Schema$GoogleCloudDiscoveryengineV1alphaSession { /** - * Search parameters. + * Output only. The time the session finished. */ - searchParams?: Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSearchSpecSearchParams; + endTime?: string | null; /** - * Search result list. + * Immutable. Fully qualified name `projects/{project\}/locations/global/collections/{collection\}/engines/{engine\}/sessions/x` */ - searchResultList?: Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSearchSpecSearchResultList; - } - /** - * Search parameters. - */ - export interface Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSearchSpecSearchParams { + name?: string | null; /** - * 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) + * Output only. The time the session started. */ - boostSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpec; + startTime?: string | null; /** - * 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 state of the session. */ - dataStoreSpecs?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec[]; + state?: string | null; /** - * 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) + * Turns. */ - filter?: string | null; + turns?: Schema$GoogleCloudDiscoveryengineV1alphaSessionTurn[]; /** - * Number of search results to return. The default value is 10. + * A unique identifier for tracking users. */ - maxReturnResults?: number | null; + userPseudoId?: string | null; + } + /** + * Represents a turn, including a query from the user and a answer from service. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaSessionTurn { /** - * 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. + * The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn. */ - orderBy?: string | null; + answer?: string | null; /** - * Specifies the search result mode. If unspecified, the search result mode is based on DataStore.DocumentProcessingConfig.chunking_config: * If DataStore.DocumentProcessingConfig.chunking_config is specified, it defaults to `CHUNKS`. * Otherwise, it defaults to `DOCUMENTS`. See [parse and chunk documents](https://cloud.google.com/generative-ai-app-builder/docs/parse-chunk-documents) + * The user query. */ - searchResultMode?: string | null; + query?: Schema$GoogleCloudDiscoveryengineV1alphaQuery; } /** - * Search result list. + * Metadata related to the progress of the SiteSearchEngineService.SetUriPatternDocumentData operation. This will be returned by the google.longrunning.Operation.metadata field. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSearchSpecSearchResultList { + export interface Schema$GoogleCloudDiscoveryengineV1alphaSetUriPatternDocumentDataMetadata { /** - * Search results. + * Operation create time. */ - searchResults?: Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSearchSpecSearchResultListSearchResult[]; + createTime?: string | null; + /** + * Operation last update time. If the operation is done, this is also the finish time. + */ + updateTime?: string | null; } /** - * Search result. + * Response message for SiteSearchEngineService.SetUriPatternDocumentData method. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSearchSpecSearchResultListSearchResult { + export interface Schema$GoogleCloudDiscoveryengineV1alphaSetUriPatternDocumentDataResponse {} + /** + * Verification information for target sites in advanced site search. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaSiteVerificationInfo { /** - * Chunk information. + * Site verification state indicating the ownership and validity. */ - chunkInfo?: Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSearchSpecSearchResultListSearchResultChunkInfo; + siteVerificationState?: string | null; /** - * Unstructured document information. + * Latest site verification time. */ - unstructuredDocumentInfo?: Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfo; + verifyTime?: string | null; } /** - * Chunk information. + * A target site for the SiteSearchEngine. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSearchSpecSearchResultListSearchResultChunkInfo { + export interface Schema$GoogleCloudDiscoveryengineV1alphaTargetSite { /** - * Chunk resource name. + * 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. */ - chunk?: string | null; + exactMatch?: boolean | null; /** - * Chunk textual content. + * Output only. Failure reason. */ - content?: string | null; - } - /** - * Unstructured document information. - */ - export interface Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfo { + failureReason?: Schema$GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReason; /** - * Document resource name. + * Output only. This is system-generated based on the provided_uri_pattern. */ - document?: string | null; + generatedUriPattern?: string | null; /** - * List of document contexts. + * Output only. Indexing status. */ - documentContexts?: Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoDocumentContext[]; + indexingStatus?: string | null; /** - * List of extractive answers. + * 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. */ - extractiveAnswers?: Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoExtractiveAnswer[]; + name?: string | null; /** - * List of extractive segments. + * Required. Input only. The user provided URI pattern from which the `generated_uri_pattern` is generated. */ - extractiveSegments?: Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoExtractiveSegment[]; + providedUriPattern?: string | null; /** - * Title. + * Output only. Root domain of the provided_uri_pattern. */ - title?: string | null; + rootDomainUri?: string | null; /** - * URI for the document. + * Output only. Site ownership and validity verification status. */ - uri?: string | null; - } - /** - * Document context. - */ - export interface Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoDocumentContext { + siteVerificationInfo?: Schema$GoogleCloudDiscoveryengineV1alphaSiteVerificationInfo; /** - * Document content. + * The type of the target site, e.g., whether the site is to be included or excluded. */ - content?: string | null; + type?: string | null; /** - * Page identifier. + * Output only. The target site's last updated time. */ - pageIdentifier?: string | null; + updateTime?: string | null; } /** - * Extractive answer. [Guide](https://cloud.google.com/generative-ai-app-builder/docs/snippets#get-answers) + * Site search indexing failure reasons. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoExtractiveAnswer { + export interface Schema$GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReason { /** - * Extractive answer content. + * Failed due to insufficient quota. */ - content?: string | null; + quotaFailure?: Schema$GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReasonQuotaFailure; + } + /** + * Failed due to insufficient quota. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReasonQuotaFailure { /** - * Page identifier. + * This number is an estimation on how much total quota this project needs to successfully complete indexing. */ - pageIdentifier?: string | null; + totalRequiredQuota?: string | null; } /** - * Extractive segment. [Guide](https://cloud.google.com/generative-ai-app-builder/docs/snippets#extractive-segments) + * Metadata related to the progress of the TrainCustomModel operation. This is returned by the google.longrunning.Operation.metadata field. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoExtractiveSegment { + export interface Schema$GoogleCloudDiscoveryengineV1alphaTrainCustomModelMetadata { /** - * Extractive segment content. + * Operation create time. */ - content?: string | null; + createTime?: string | null; /** - * Page identifier. + * Operation last update time. If the operation is done, this is also the finish time. */ - pageIdentifier?: string | null; + updateTime?: string | null; } /** - * Response message for ConversationalSearchService.AnswerQuery method. + * Response of the TrainCustomModelRequest. This message is returned by the google.longrunning.Operations.response field. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryResponse { + export interface Schema$GoogleCloudDiscoveryengineV1alphaTrainCustomModelResponse { /** - * Answer resource object. If AnswerQueryRequest.StepSpec.max_step_count is greater than 1, use Answer.name to fetch answer information using ConversationalSearchService.GetAnswer API. + * Echoes the destination for the complete errors in the request if set. */ - answer?: Schema$GoogleCloudDiscoveryengineV1betaAnswer; + errorConfig?: Schema$GoogleCloudDiscoveryengineV1alphaImportErrorConfig; /** - * A global unique ID used for logging. + * A sample of errors encountered while processing the data. */ - answerQueryToken?: string | null; + errorSamples?: Schema$GoogleRpcStatus[]; /** - * Session resource object. It will be only available when session field is set and valid in the AnswerQueryRequest request. + * The metrics of the trained model. */ - session?: Schema$GoogleCloudDiscoveryengineV1betaSession; + metrics?: {[key: string]: number} | null; + /** + * Fully qualified name of the CustomTuningModel. + */ + modelName?: string | null; + /** + * 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. + */ + modelStatus?: string | null; } /** - * Query understanding information. + * Metadata associated with a tune operation. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryUnderstandingInfo { + export interface Schema$GoogleCloudDiscoveryengineV1alphaTuneEngineMetadata { /** - * Query classification information. + * Required. The resource name of the engine that this tune applies to. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/engines/{engine_id\}` */ - queryClassificationInfo?: Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryUnderstandingInfoQueryClassificationInfo[]; + engine?: string | null; } /** - * Query classification information. + * Response associated with a tune operation. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryUnderstandingInfoQueryClassificationInfo { + export interface Schema$GoogleCloudDiscoveryengineV1alphaTuneEngineResponse {} + /** + * Metadata for UpdateSchema LRO. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaUpdateSchemaMetadata { /** - * Classification output. + * Operation create time. */ - positive?: boolean | null; + createTime?: string | null; /** - * Query classification type. + * Operation last update time. If the operation is done, this is also the finish time. */ - type?: string | null; + updateTime?: string | null; } /** - * Reference. + * Metadata related to the progress of the SiteSearchEngineService.UpdateTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaAnswerReference { + export interface Schema$GoogleCloudDiscoveryengineV1alphaUpdateTargetSiteMetadata { /** - * Chunk information. + * Operation create time. */ - chunkInfo?: Schema$GoogleCloudDiscoveryengineV1betaAnswerReferenceChunkInfo; + createTime?: string | null; /** - * Unstructured document information. + * Operation last update time. If the operation is done, this is also the finish time. */ - unstructuredDocumentInfo?: Schema$GoogleCloudDiscoveryengineV1betaAnswerReferenceUnstructuredDocumentInfo; + updateTime?: string | null; } /** - * Chunk information. + * Information of an end user. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaAnswerReferenceChunkInfo { + export interface Schema$GoogleCloudDiscoveryengineV1alphaUserInfo { /** - * Chunk resource name. + * 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. */ - chunk?: string | null; + userAgent?: string | null; /** - * Chunk textual content. + * 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. */ - content?: string | null; + userId?: string | null; + } + /** + * Metadata related to the progress of the SiteSearchEngineService.BatchCreateTargetSites operation. This will be returned by the google.longrunning.Operation.metadata field. + */ + export interface Schema$GoogleCloudDiscoveryengineV1BatchCreateTargetSiteMetadata { /** - * Document metadata. + * Operation create time. */ - documentMetadata?: Schema$GoogleCloudDiscoveryengineV1betaAnswerReferenceChunkInfoDocumentMetadata; + createTime?: string | null; /** - * Relevance score. + * Operation last update time. If the operation is done, this is also the finish time. */ - relevanceScore?: number | null; + updateTime?: string | null; } /** - * Document metadata. + * Response message for SiteSearchEngineService.BatchCreateTargetSites method. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaAnswerReferenceChunkInfoDocumentMetadata { + export interface Schema$GoogleCloudDiscoveryengineV1BatchCreateTargetSitesResponse { /** - * Document resource name. + * TargetSites created. */ - document?: string | null; + targetSites?: Schema$GoogleCloudDiscoveryengineV1TargetSite[]; + } + /** + * AlloyDB source import data from. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaAlloyDbSource { /** - * Page identifier. + * Required. The AlloyDB cluster to copy the data from with a length limit of 256 characters. */ - pageIdentifier?: string | null; + clusterId?: string | null; /** - * The structured JSON metadata for the document. It is populated from the struct data from the Chunk in search result. + * Required. The AlloyDB database to copy the data from with a length limit of 256 characters. */ - structData?: {[key: string]: any} | null; + databaseId?: string | null; /** - * Title. + * 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. */ - title?: string | null; + gcsStagingDir?: string | null; /** - * URI for the document. + * Required. The AlloyDB location to copy the data from with a length limit of 256 characters. */ - uri?: string | null; + locationId?: string | null; + /** + * The project ID that the AlloyDB source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request. + */ + projectId?: string | null; + /** + * Required. The AlloyDB table to copy the data from with a length limit of 256 characters. + */ + tableId?: string | null; } /** - * Unstructured document information. + * Defines an answer. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaAnswerReferenceUnstructuredDocumentInfo { + export interface Schema$GoogleCloudDiscoveryengineV1betaAnswer { /** - * List of cited chunk contents derived from document content. + * Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set. */ - chunkContents?: Schema$GoogleCloudDiscoveryengineV1betaAnswerReferenceUnstructuredDocumentInfoChunkContent[]; + answerSkippedReasons?: string[] | null; /** - * Document resource name. + * The textual answer. */ - document?: string | null; + answerText?: string | null; /** - * The structured JSON metadata for the document. It is populated from the struct data from the Chunk in search result. + * Citations. */ - structData?: {[key: string]: any} | null; + citations?: Schema$GoogleCloudDiscoveryengineV1betaAnswerCitation[]; /** - * Title. + * Output only. Answer completed timestamp. */ - title?: string | null; + completeTime?: string | null; /** - * URI for the document. + * Output only. Answer creation timestamp. */ - uri?: string | null; - } - /** - * Chunk content. - */ - export interface Schema$GoogleCloudDiscoveryengineV1betaAnswerReferenceUnstructuredDocumentInfoChunkContent { + createTime?: string | null; /** - * Chunk textual content. + * Immutable. Fully qualified name `projects/{project\}/locations/global/collections/{collection\}/engines/{engine\}/sessions/x/answers/x` */ - content?: string | null; + name?: string | null; /** - * Page identifier. + * Query understanding information. */ - pageIdentifier?: string | null; - } - /** - * Step information. - */ - export interface Schema$GoogleCloudDiscoveryengineV1betaAnswerStep { + queryUnderstandingInfo?: Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryUnderstandingInfo; /** - * Actions. + * References. */ - actions?: Schema$GoogleCloudDiscoveryengineV1betaAnswerStepAction[]; + references?: Schema$GoogleCloudDiscoveryengineV1betaAnswerReference[]; /** - * The description of the step. + * Suggested related questions. */ - description?: string | null; + relatedQuestions?: string[] | null; /** - * The state of the step. + * The state of the answer generation. */ state?: string | null; /** - * The thought of the step. + * Answer generation steps. */ - thought?: string | null; + steps?: Schema$GoogleCloudDiscoveryengineV1betaAnswerStep[]; } /** - * Action. + * Citation info for a segment. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaAnswerStepAction { + export interface Schema$GoogleCloudDiscoveryengineV1betaAnswerCitation { /** - * Observation. + * End of the attributed segment, exclusive. */ - observation?: Schema$GoogleCloudDiscoveryengineV1betaAnswerStepActionObservation; + endIndex?: string | null; /** - * Search action. + * Citation sources for the attributed segment. */ - searchAction?: Schema$GoogleCloudDiscoveryengineV1betaAnswerStepActionSearchAction; + sources?: Schema$GoogleCloudDiscoveryengineV1betaAnswerCitationSource[]; + /** + * Index indicates the start of the segment, measured in bytes (UTF-8 unicode). + */ + startIndex?: string | null; } /** - * Observation. + * Citation source. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaAnswerStepActionObservation { + export interface Schema$GoogleCloudDiscoveryengineV1betaAnswerCitationSource { /** - * Search results observed by the search action, it can be snippets info or chunk info, depending on the citation type set by the user. + * ID of the citation source. */ - searchResults?: Schema$GoogleCloudDiscoveryengineV1betaAnswerStepActionObservationSearchResult[]; + referenceId?: string | null; } - export interface Schema$GoogleCloudDiscoveryengineV1betaAnswerStepActionObservationSearchResult { + /** + * Request message for ConversationalSearchService.AnswerQuery method. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryRequest { /** - * If citation_type is CHUNK_LEVEL_CITATION and chunk mode is on, populate chunk info. + * Answer generation specification. */ - chunkInfo?: Schema$GoogleCloudDiscoveryengineV1betaAnswerStepActionObservationSearchResultChunkInfo[]; + answerGenerationSpec?: Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryRequestAnswerGenerationSpec; /** - * Document resource name. + * 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. */ - document?: string | null; + asynchronousMode?: boolean | null; /** - * If citation_type is DOCUMENT_LEVEL_CITATION, populate document level snippets. + * Required. Current user query. */ - snippetInfo?: Schema$GoogleCloudDiscoveryengineV1betaAnswerStepActionObservationSearchResultSnippetInfo[]; + query?: Schema$GoogleCloudDiscoveryengineV1betaQuery; /** - * Title. + * Query understanding specification. */ - title?: string | null; + queryUnderstandingSpec?: Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryRequestQueryUnderstandingSpec; /** - * URI for the document. + * Related questions specification. */ - uri?: string | null; - } - /** - * Chunk information. - */ - export interface Schema$GoogleCloudDiscoveryengineV1betaAnswerStepActionObservationSearchResultChunkInfo { + relatedQuestionsSpec?: Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryRequestRelatedQuestionsSpec; /** - * Chunk resource name. + * Model specification. */ - chunk?: string | null; + safetySpec?: Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSafetySpec; /** - * Chunk textual content. + * Search specification. */ - content?: string | null; + searchSpec?: Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSearchSpec; /** - * Relevance score. + * 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. */ - relevanceScore?: number | null; - } - /** - * Snippet information. - */ - export interface Schema$GoogleCloudDiscoveryengineV1betaAnswerStepActionObservationSearchResultSnippetInfo { + session?: string | null; /** - * Snippet content. + * 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. */ - snippet?: string | null; + userLabels?: {[key: string]: string} | null; /** - * Status of the snippet defined by the search team. + * 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. */ - snippetStatus?: string | null; + userPseudoId?: string | null; } /** - * Search action. + * Answer generation specification. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaAnswerStepActionSearchAction { + export interface Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryRequestAnswerGenerationSpec { /** - * The query to search. + * 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. */ - query?: string | null; - } - /** - * Metadata related to the progress of the SiteSearchEngineService.BatchCreateTargetSites operation. This will be returned by the google.longrunning.Operation.metadata field. - */ - export interface Schema$GoogleCloudDiscoveryengineV1betaBatchCreateTargetSiteMetadata { + answerLanguageCode?: string | null; /** - * Operation create time. + * 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. */ - createTime?: string | null; + ignoreAdversarialQuery?: boolean | null; /** - * Operation last update time. If the operation is done, this is also the finish time. + * 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. */ - updateTime?: string | null; + ignoreLowRelevantContent?: boolean | null; + /** + * 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. + */ + ignoreNonAnswerSeekingQuery?: boolean | null; + /** + * Specifies whether to include citation metadata in the answer. The default value is `false`. + */ + includeCitations?: boolean | null; + /** + * Answer generation model specification. + */ + modelSpec?: Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryRequestAnswerGenerationSpecModelSpec; + /** + * Answer generation prompt specification. + */ + promptSpec?: Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryRequestAnswerGenerationSpecPromptSpec; } /** - * Request message for SiteSearchEngineService.BatchCreateTargetSites method. + * Answer Generation Model specification. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaBatchCreateTargetSitesRequest { + export interface Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryRequestAnswerGenerationSpecModelSpec { /** - * Required. The request message specifying the resources to create. A maximum of 20 TargetSites can be created in a batch. + * Model version. If not set, it will use the default stable model. Allowed values are: stable, preview. */ - requests?: Schema$GoogleCloudDiscoveryengineV1betaCreateTargetSiteRequest[]; + modelVersion?: string | null; } /** - * Response message for SiteSearchEngineService.BatchCreateTargetSites method. + * Answer generation prompt specification. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaBatchCreateTargetSitesResponse { + export interface Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryRequestAnswerGenerationSpecPromptSpec { /** - * TargetSites created. + * Customized preamble. */ - targetSites?: Schema$GoogleCloudDiscoveryengineV1betaTargetSite[]; + preamble?: string | null; } /** - * Request message for SiteSearchEngineService.BatchVerifyTargetSites method. - */ - export interface Schema$GoogleCloudDiscoveryengineV1betaBatchVerifyTargetSitesRequest {} - /** - * BigQuery source import data from. + * Query understanding specification. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaBigQuerySource { - /** - * The schema to use when parsing the data from the source. Supported values for user event imports: * `user_event` (default): One UserEvent per row. Supported values for document imports: * `document` (default): One Document format per row. Each document must have a valid Document.id and one of Document.json_data or Document.struct_data. * `custom`: One custom data per row in arbitrary format that conforms to the defined Schema of the data store. This can only be used by the GENERIC Data Store vertical. - */ - dataSchema?: string | null; - /** - * Required. The BigQuery data set to copy the data from with a length limit of 1,024 characters. - */ - datasetId?: string | null; - /** - * 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. - */ - gcsStagingDir?: string | null; - /** - * BigQuery time partitioned table's _PARTITIONDATE in YYYY-MM-DD format. - */ - partitionDate?: Schema$GoogleTypeDate; + export interface Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryRequestQueryUnderstandingSpec { /** - * The project ID (can be project # or ID) that the BigQuery source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request. + * Query classification specification. */ - projectId?: string | null; + queryClassificationSpec?: Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryRequestQueryUnderstandingSpecQueryClassificationSpec; /** - * Required. The BigQuery table to copy the data from with a length limit of 1,024 characters. + * Query rephraser specification. */ - tableId?: string | null; + queryRephraserSpec?: Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryRequestQueryUnderstandingSpecQueryRephraserSpec; } /** - * The Bigtable Options object that contains information to support the import. + * Query classification specification. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaBigtableOptions { - /** - * 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. - */ - families?: { - [ - key: string - ]: Schema$GoogleCloudDiscoveryengineV1betaBigtableOptionsBigtableColumnFamily; - } | null; + export interface Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryRequestQueryUnderstandingSpecQueryClassificationSpec { /** - * The field name used for saving row key value in the document. The name has to match the pattern `a-zA-Z0-9*`. + * Enabled query classification types. */ - keyFieldName?: string | null; + types?: string[] | null; } /** - * The column of the Bigtable. + * Query rephraser specification. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaBigtableOptionsBigtableColumn { + export interface Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryRequestQueryUnderstandingSpecQueryRephraserSpec { /** - * 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. + * Disable query rephraser. */ - encoding?: string | null; + disable?: boolean | null; /** - * 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. + * Max rephrase steps. The max number is 5 steps. If not set or set to < 1, it will be set to 1 by default. */ - fieldName?: string | null; + maxRephraseSteps?: number | null; + } + /** + * Related questions specification. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryRequestRelatedQuestionsSpec { /** - * Required. Qualifier of the column. If it cannot be decoded with utf-8, use a base-64 encoded string instead. + * Enable related questions feature if true. */ - qualifier?: string | null; + enable?: boolean | null; + } + /** + * Safety specification. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSafetySpec { /** - * 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`. + * Enable the safety filtering on the answer response. It is false by default. */ - type?: string | null; + enable?: boolean | null; } /** - * The column family of the Bigtable. + * Search specification. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaBigtableOptionsBigtableColumnFamily { + export interface Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSearchSpec { /** - * 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. + * Search parameters. */ - columns?: Schema$GoogleCloudDiscoveryengineV1betaBigtableOptionsBigtableColumn[]; + searchParams?: Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSearchSpecSearchParams; /** - * 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. + * Search result list. */ - encoding?: string | null; + searchResultList?: Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSearchSpecSearchResultList; + } + /** + * Search parameters. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSearchSpecSearchParams { /** - * 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. + * 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) */ - fieldName?: string | null; + boostSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpec; /** - * 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`. + * 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?: string | null; - } - /** - * The Cloud Bigtable source for importing data. - */ - export interface Schema$GoogleCloudDiscoveryengineV1betaBigtableSource { + dataStoreSpecs?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec[]; /** - * Required. Bigtable options that contains information needed when parsing data into typed structures. For example, column type annotations. + * 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) */ - bigtableOptions?: Schema$GoogleCloudDiscoveryengineV1betaBigtableOptions; + filter?: string | null; /** - * Required. The instance ID of the Cloud Bigtable that needs to be imported. + * Number of search results to return. The default value is 10. */ - instanceId?: string | null; + maxReturnResults?: number | null; /** - * The project ID that the Bigtable source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request. + * 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. */ - projectId?: string | null; + orderBy?: string | null; /** - * Required. The table ID of the Cloud Bigtable that needs to be imported. + * 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) */ - tableId?: string | null; + searchResultMode?: string | null; } /** - * Request message for GroundedGenerationService.CheckGrounding method. + * Search result list. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaCheckGroundingRequest { - /** - * Answer candidate to check. Can have a maximum length of 1024 characters. - */ - answerCandidate?: string | null; + export interface Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSearchSpecSearchResultList { /** - * List of facts for the grounding check. We support up to 200 facts. + * Search results. */ - facts?: Schema$GoogleCloudDiscoveryengineV1betaGroundingFact[]; + searchResults?: Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSearchSpecSearchResultListSearchResult[]; + } + /** + * Search result. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSearchSpecSearchResultListSearchResult { /** - * Configuration of the grounding check. + * Chunk information. */ - groundingSpec?: Schema$GoogleCloudDiscoveryengineV1betaCheckGroundingSpec; + chunkInfo?: Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSearchSpecSearchResultListSearchResultChunkInfo; /** - * 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. + * Unstructured document information. */ - userLabels?: {[key: string]: string} | null; + unstructuredDocumentInfo?: Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfo; } /** - * Response message for the GroundedGenerationService.CheckGrounding method. + * Chunk information. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaCheckGroundingResponse { - /** - * List of facts cited across all claims in the answer candidate. These are derived from the facts supplied in the request. - */ - citedChunks?: Schema$GoogleCloudDiscoveryengineV1betaFactChunk[]; + export interface Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSearchSpecSearchResultListSearchResultChunkInfo { /** - * Claim texts and citation info across all claims in the answer candidate. + * Chunk resource name. */ - claims?: Schema$GoogleCloudDiscoveryengineV1betaCheckGroundingResponseClaim[]; + chunk?: string | null; /** - * 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. + * Chunk textual content. */ - supportScore?: number | null; + content?: string | null; } /** - * Text and citation info for a claim in the answer candidate. + * Unstructured document information. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaCheckGroundingResponseClaim { + export interface Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfo { /** - * 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. + * Document resource name. */ - citationIndices?: number[] | null; + document?: string | null; /** - * Text for the claim in the answer candidate. Always provided regardless of whether citations or anti-citations are found. + * List of document contexts. */ - claimText?: string | null; + documentContexts?: Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoDocumentContext[]; /** - * Position indicating the end of the claim in the answer candidate, exclusive. + * List of extractive answers. */ - endPos?: number | null; + extractiveAnswers?: Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoExtractiveAnswer[]; /** - * 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, and anti_citation_indices should not be returned. + * List of extractive segments. */ - groundingCheckRequired?: boolean | null; + extractiveSegments?: Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoExtractiveSegment[]; /** - * Position indicating the start of the claim in the answer candidate, measured in bytes. + * Title. */ - startPos?: number | null; - } - /** - * Specification for the grounding check. - */ - export interface Schema$GoogleCloudDiscoveryengineV1betaCheckGroundingSpec { + title?: string | null; /** - * 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. + * URI for the document. */ - citationThreshold?: number | null; + uri?: string | null; } /** - * Chunk captures all raw metadata information of items to be recommended or searched in the chunk mode. + * Document context. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaChunk { + export interface Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoDocumentContext { /** - * Output only. Metadata of the current chunk. + * Document content. */ - chunkMetadata?: Schema$GoogleCloudDiscoveryengineV1betaChunkChunkMetadata; + content?: string | null; /** - * Content is a string from a document (parsed content). + * Page identifier. + */ + pageIdentifier?: string | null; + } + /** + * Extractive answer. [Guide](https://cloud.google.com/generative-ai-app-builder/docs/snippets#get-answers) + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoExtractiveAnswer { + /** + * Extractive answer content. */ content?: string | null; /** - * Output only. This field is OUTPUT_ONLY. It contains derived data that are not in the original input document. + * Page identifier. */ - derivedStructData?: {[key: string]: any} | null; + pageIdentifier?: string | null; + } + /** + * Extractive segment. [Guide](https://cloud.google.com/generative-ai-app-builder/docs/snippets#extractive-segments) + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoExtractiveSegment { /** - * Metadata of the document from the current chunk. + * Extractive segment content. */ - documentMetadata?: Schema$GoogleCloudDiscoveryengineV1betaChunkDocumentMetadata; + content?: string | null; /** - * Unique chunk ID of the current chunk. + * Page identifier. */ - id?: string | null; + pageIdentifier?: string | null; + } + /** + * Response message for ConversationalSearchService.AnswerQuery method. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryResponse { /** - * 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. + * 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. */ - name?: string | null; + answer?: Schema$GoogleCloudDiscoveryengineV1betaAnswer; /** - * Page span of the chunk. + * A global unique ID used for logging. */ - pageSpan?: Schema$GoogleCloudDiscoveryengineV1betaChunkPageSpan; + answerQueryToken?: string | null; /** - * 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. + * Session resource object. It will be only available when session field is set and valid in the AnswerQueryRequest request. */ - relevanceScore?: number | null; + session?: Schema$GoogleCloudDiscoveryengineV1betaSession; } /** - * Metadata of the current chunk. This field is only populated on SearchService.Search API. + * Query understanding information. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaChunkChunkMetadata { - /** - * 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. - */ - nextChunks?: Schema$GoogleCloudDiscoveryengineV1betaChunk[]; + export interface Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryUnderstandingInfo { /** - * 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. + * Query classification information. */ - previousChunks?: Schema$GoogleCloudDiscoveryengineV1betaChunk[]; + queryClassificationInfo?: Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryUnderstandingInfoQueryClassificationInfo[]; } /** - * Document metadata contains the information of the document of the current chunk. + * Query classification information. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaChunkDocumentMetadata { - /** - * Data representation. The structured JSON data for the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown. - */ - structData?: {[key: string]: any} | null; + export interface Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryUnderstandingInfoQueryClassificationInfo { /** - * Title of the document. + * Classification output. */ - title?: string | null; + positive?: boolean | null; /** - * Uri of the document. + * Query classification type. */ - uri?: string | null; + type?: string | null; } /** - * Page span of the chunk. + * Reference. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaChunkPageSpan { + export interface Schema$GoogleCloudDiscoveryengineV1betaAnswerReference { /** - * The end page of the chunk. + * Chunk information. */ - pageEnd?: number | null; + chunkInfo?: Schema$GoogleCloudDiscoveryengineV1betaAnswerReferenceChunkInfo; /** - * The start page of the chunk. + * Unstructured document information. */ - pageStart?: number | null; + unstructuredDocumentInfo?: Schema$GoogleCloudDiscoveryengineV1betaAnswerReferenceUnstructuredDocumentInfo; } /** - * Cloud SQL source import data from. + * Chunk information. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaCloudSqlSource { - /** - * Required. The Cloud SQL database to copy the data from with a length limit of 256 characters. - */ - databaseId?: string | null; - /** - * 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. - */ - gcsStagingDir?: string | null; + export interface Schema$GoogleCloudDiscoveryengineV1betaAnswerReferenceChunkInfo { /** - * Required. The Cloud SQL instance to copy the data from with a length limit of 256 characters. + * Chunk resource name. */ - instanceId?: string | null; + chunk?: string | null; /** - * Option for serverless export. Enabling this option will incur additional cost. More info can be found [here](https://cloud.google.com/sql/pricing#serverless). + * Chunk textual content. */ - offload?: boolean | null; + content?: string | null; /** - * 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. + * Document metadata. */ - projectId?: string | null; + documentMetadata?: Schema$GoogleCloudDiscoveryengineV1betaAnswerReferenceChunkInfoDocumentMetadata; /** - * Required. The Cloud SQL table to copy the data from with a length limit of 256 characters. + * Relevance score. */ - tableId?: string | null; + relevanceScore?: number | null; } /** - * Response message for CompletionService.CompleteQuery method. + * Document metadata. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaCompleteQueryResponse { - /** - * Results of the matched query suggestions. The result list is ordered and the first result is a top suggestion. - */ - querySuggestions?: Schema$GoogleCloudDiscoveryengineV1betaCompleteQueryResponseQuerySuggestion[]; + export interface Schema$GoogleCloudDiscoveryengineV1betaAnswerReferenceChunkInfoDocumentMetadata { /** - * 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. + * Document resource name. */ - tailMatchTriggered?: boolean | null; - } - /** - * Suggestions as search queries. - */ - export interface Schema$GoogleCloudDiscoveryengineV1betaCompleteQueryResponseQuerySuggestion { + document?: string | null; /** - * 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. + * Page identifier. */ - completableFieldPaths?: string[] | null; + pageIdentifier?: string | null; /** - * The suggestion for the query. + * The structured JSON metadata for the document. It is populated from the struct data from the Chunk in search result. */ - suggestion?: string | null; - } - /** - * Detailed completion information including completion attribution token and clicked completion info. - */ - export interface Schema$GoogleCloudDiscoveryengineV1betaCompletionInfo { + structData?: {[key: string]: any} | null; /** - * End user selected CompleteQueryResponse.QuerySuggestion.suggestion position, starting from 0. + * Title. */ - selectedPosition?: number | null; + title?: string | null; /** - * End user selected CompleteQueryResponse.QuerySuggestion.suggestion. + * URI for the document. */ - selectedSuggestion?: string | null; + uri?: string | null; } /** - * Autocomplete suggestions that are imported from Customer. + * Unstructured document information. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaCompletionSuggestion { + export interface Schema$GoogleCloudDiscoveryengineV1betaAnswerReferenceUnstructuredDocumentInfo { /** - * Alternative matching phrases for this suggestion. + * List of cited chunk contents derived from document content. */ - alternativePhrases?: string[] | null; + chunkContents?: Schema$GoogleCloudDiscoveryengineV1betaAnswerReferenceUnstructuredDocumentInfoChunkContent[]; /** - * Frequency of this suggestion. Will be used to rank suggestions when score is not available. + * Document resource name. */ - frequency?: string | null; + document?: string | null; /** - * Global score of this suggestion. Control how this suggestion would be scored / ranked. + * The structured JSON metadata for the document. It is populated from the struct data from the Chunk in search result. */ - globalScore?: number | null; + structData?: {[key: string]: any} | null; /** - * 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. + * Title. */ - groupId?: string | null; + title?: string | null; /** - * The score of this suggestion within its group. + * URI for the document. */ - groupScore?: number | null; + uri?: string | null; + } + /** + * Chunk content. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaAnswerReferenceUnstructuredDocumentInfoChunkContent { /** - * BCP-47 language code of this suggestion. + * Chunk textual content. */ - languageCode?: string | null; + content?: string | null; /** - * Required. The suggestion text. + * Page identifier. */ - suggestion?: string | null; + pageIdentifier?: string | null; } /** - * Defines circumstances to be checked before allowing a behavior + * Step information. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaCondition { + export interface Schema$GoogleCloudDiscoveryengineV1betaAnswerStep { /** - * Range of time(s) specifying when condition is active. Maximum of 10 time ranges. + * Actions. */ - activeTimeRange?: Schema$GoogleCloudDiscoveryengineV1betaConditionTimeRange[]; + actions?: Schema$GoogleCloudDiscoveryengineV1betaAnswerStepAction[]; /** - * Search only A list of terms to match the query on. Maximum of 10 query terms. + * The description of the step. */ - queryTerms?: Schema$GoogleCloudDiscoveryengineV1betaConditionQueryTerm[]; - } - /** - * Matcher for search request query - */ - export interface Schema$GoogleCloudDiscoveryengineV1betaConditionQueryTerm { + description?: string | null; /** - * Whether the search query needs to exactly match the query term. + * The state of the step. */ - fullMatch?: boolean | null; + state?: string | null; /** - * 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. + * The thought of the step. */ - value?: string | null; + thought?: string | null; } /** - * Used for time-dependent conditions. + * Action. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaConditionTimeRange { + export interface Schema$GoogleCloudDiscoveryengineV1betaAnswerStepAction { /** - * End of time range. Range is inclusive. Must be in the future. + * Observation. */ - endTime?: string | null; + observation?: Schema$GoogleCloudDiscoveryengineV1betaAnswerStepActionObservation; /** - * Start of time range. Range is inclusive. + * Search action. */ - startTime?: string | null; + searchAction?: Schema$GoogleCloudDiscoveryengineV1betaAnswerStepActionSearchAction; } /** - * 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`. + * Observation. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaControl { + export interface Schema$GoogleCloudDiscoveryengineV1betaAnswerStepActionObservation { /** - * Output only. List of all ServingConfig ids this control is attached to. May take up to 10 minutes to update after changes. + * Search results observed by the search action, it can be snippets info or chunk info, depending on the citation type set by the user. */ - associatedServingConfigIds?: string[] | null; + searchResults?: Schema$GoogleCloudDiscoveryengineV1betaAnswerStepActionObservationSearchResult[]; + } + export interface Schema$GoogleCloudDiscoveryengineV1betaAnswerStepActionObservationSearchResult { /** - * Defines a boost-type control + * If citation_type is CHUNK_LEVEL_CITATION and chunk mode is on, populate chunk info. */ - boostAction?: Schema$GoogleCloudDiscoveryengineV1betaControlBoostAction; + chunkInfo?: Schema$GoogleCloudDiscoveryengineV1betaAnswerStepActionObservationSearchResultChunkInfo[]; /** - * 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. + * Document resource name. */ - conditions?: Schema$GoogleCloudDiscoveryengineV1betaCondition[]; + document?: string | null; /** - * 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. + * If citation_type is DOCUMENT_LEVEL_CITATION, populate document level snippets. */ - displayName?: string | null; + snippetInfo?: Schema$GoogleCloudDiscoveryengineV1betaAnswerStepActionObservationSearchResultSnippetInfo[]; /** - * Defines a filter-type control Currently not supported by Recommendation + * 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 . */ - filterAction?: Schema$GoogleCloudDiscoveryengineV1betaControlFilterAction; + structData?: {[key: string]: any} | null; /** - * Immutable. Fully qualified name `projects/x/locations/global/dataStore/x/controls/x` + * Title. */ - name?: string | null; + title?: string | null; /** - * Defines a redirect-type control. + * URI for the document. */ - redirectAction?: Schema$GoogleCloudDiscoveryengineV1betaControlRedirectAction; - /** - * Required. Immutable. What solution the control belongs to. Must be compatible with vertical of resource. Otherwise an INVALID ARGUMENT error is thrown. + uri?: string | null; + } + /** + * Chunk information. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaAnswerStepActionObservationSearchResultChunkInfo { + /** + * Chunk resource name. */ - solutionType?: string | null; + chunk?: string | null; /** - * Treats a group of terms as synonyms of one another. + * Chunk textual content. */ - synonymsAction?: Schema$GoogleCloudDiscoveryengineV1betaControlSynonymsAction; + content?: string | null; /** - * 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. + * Relevance score. */ - useCases?: string[] | null; + relevanceScore?: number | null; } /** - * Adjusts order of products in returned list. + * Snippet information. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaControlBoostAction { + export interface Schema$GoogleCloudDiscoveryengineV1betaAnswerStepActionObservationSearchResultSnippetInfo { /** - * Required. Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0 (No-op). + * Snippet content. */ - boost?: number | null; + snippet?: string | null; /** - * 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 + * Status of the snippet defined by the search team. */ - dataStore?: string | null; + snippetStatus?: string | null; + } + /** + * Search action. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaAnswerStepActionSearchAction { /** - * 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 query to search. */ - filter?: string | null; + query?: string | null; } /** - * Specified which products may be included in results. Uses same filter as boost. + * Metadata related to the progress of the SiteSearchEngineService.BatchCreateTargetSites operation. This will be returned by the google.longrunning.Operation.metadata field. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaControlFilterAction { + export interface Schema$GoogleCloudDiscoveryengineV1betaBatchCreateTargetSiteMetadata { /** - * 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 + * Operation create time. */ - dataStore?: string | null; + createTime?: string | null; /** - * 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. + * Operation last update time. If the operation is done, this is also the finish time. */ - filter?: string | null; + updateTime?: string | null; } /** - * Redirects a shopper to the provided URI. + * Request message for SiteSearchEngineService.BatchCreateTargetSites method. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaControlRedirectAction { + export interface Schema$GoogleCloudDiscoveryengineV1betaBatchCreateTargetSitesRequest { /** - * 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. + * Required. The request message specifying the resources to create. A maximum of 20 TargetSites can be created in a batch. */ - redirectUri?: string | null; + requests?: Schema$GoogleCloudDiscoveryengineV1betaCreateTargetSiteRequest[]; } /** - * 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". + * Response message for SiteSearchEngineService.BatchCreateTargetSites method. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaControlSynonymsAction { + export interface Schema$GoogleCloudDiscoveryengineV1betaBatchCreateTargetSitesResponse { /** - * Defines a set of synonyms. Can specify up to 100 synonyms. Must specify at least 2 synonyms. Otherwise an INVALID ARGUMENT error is thrown. + * TargetSites created. */ - synonyms?: string[] | null; + targetSites?: Schema$GoogleCloudDiscoveryengineV1betaTargetSite[]; } /** - * External conversation proto definition. + * Request message for SiteSearchEngineService.BatchVerifyTargetSites method. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaConversation { + export interface Schema$GoogleCloudDiscoveryengineV1betaBatchVerifyTargetSitesRequest {} + /** + * BigQuery source import data from. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaBigQuerySource { /** - * Output only. The time the conversation finished. + * 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. */ - endTime?: string | null; + dataSchema?: string | null; /** - * Conversation messages. + * Required. The BigQuery data set to copy the data from with a length limit of 1,024 characters. */ - messages?: Schema$GoogleCloudDiscoveryengineV1betaConversationMessage[]; + datasetId?: string | null; /** - * Immutable. Fully qualified name `projects/{project\}/locations/global/collections/{collection\}/dataStore/x/conversations/x` or `projects/{project\}/locations/global/collections/{collection\}/engines/x/conversations/x`. + * 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. */ - name?: string | null; + gcsStagingDir?: string | null; /** - * Output only. The time the conversation started. + * BigQuery time partitioned table's _PARTITIONDATE in YYYY-MM-DD format. */ - startTime?: string | null; + partitionDate?: Schema$GoogleTypeDate; /** - * The state of the Conversation. + * The project ID (can be project # or ID) that the BigQuery source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request. */ - state?: string | null; + projectId?: string | null; /** - * A unique identifier for tracking users. + * Required. The BigQuery table to copy the data from with a length limit of 1,024 characters. */ - userPseudoId?: string | null; + tableId?: string | null; } /** - * Defines context of the conversation + * The Bigtable Options object that contains information to support the import. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaConversationContext { + export interface Schema$GoogleCloudDiscoveryengineV1betaBigtableOptions { /** - * The current active document the user opened. It contains the document resource reference. + * 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. */ - activeDocument?: string | null; + families?: { + [ + key: string + ]: Schema$GoogleCloudDiscoveryengineV1betaBigtableOptionsBigtableColumnFamily; + } | null; /** - * The current list of documents the user is seeing. It contains the document resource references. + * The field name used for saving row key value in the document. The name has to match the pattern `a-zA-Z0-9*`. */ - contextDocuments?: string[] | null; + keyFieldName?: string | null; } /** - * Defines a conversation message. + * The column of the Bigtable. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaConversationMessage { + export interface Schema$GoogleCloudDiscoveryengineV1betaBigtableOptionsBigtableColumn { /** - * Output only. Message creation timestamp. + * 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. */ - createTime?: string | null; + encoding?: string | null; /** - * Search reply. + * 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. */ - reply?: Schema$GoogleCloudDiscoveryengineV1betaReply; + fieldName?: string | null; /** - * User text input. + * Required. Qualifier of the column. If it cannot be decoded with utf-8, use a base-64 encoded string instead. */ - userInput?: Schema$GoogleCloudDiscoveryengineV1betaTextInput; + qualifier?: string | null; + /** + * 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 | null; } /** - * Request message for ConversationalSearchService.ConverseConversation method. + * The column family of the Bigtable. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaConverseConversationRequest { + export interface Schema$GoogleCloudDiscoveryengineV1betaBigtableOptionsBigtableColumnFamily { /** - * 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) + * 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. */ - boostSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpec; + columns?: Schema$GoogleCloudDiscoveryengineV1betaBigtableOptionsBigtableColumn[]; /** - * 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. + * 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. */ - conversation?: Schema$GoogleCloudDiscoveryengineV1betaConversation; + encoding?: string | null; /** - * 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) + * 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. */ - filter?: string | null; + fieldName?: string | null; /** - * Required. Current user input. + * 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`. */ - query?: Schema$GoogleCloudDiscoveryengineV1betaTextInput; + type?: string | null; + } + /** + * The Cloud Bigtable source for importing data. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaBigtableSource { /** - * Whether to turn on safe search. + * Required. Bigtable options that contains information needed when parsing data into typed structures. For example, column type annotations. */ - safeSearch?: boolean | null; + bigtableOptions?: Schema$GoogleCloudDiscoveryengineV1betaBigtableOptions; /** - * The resource name of the Serving Config to use. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/servingConfigs/{serving_config_id\}` If this is not set, the default serving config will be used. + * Required. The instance ID of the Cloud Bigtable that needs to be imported. */ - servingConfig?: string | null; + instanceId?: string | null; /** - * A specification for configuring the summary returned in the response. + * The project ID that the Bigtable source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request. */ - summarySpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpec; + projectId?: string | null; /** - * 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. + * Required. The table ID of the Cloud Bigtable that needs to be imported. */ - userLabels?: {[key: string]: string} | null; + tableId?: string | null; } /** - * Response message for ConversationalSearchService.ConverseConversation method. + * Request message for GroundedGenerationService.CheckGrounding method. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaConverseConversationResponse { + export interface Schema$GoogleCloudDiscoveryengineV1betaCheckGroundingRequest { /** - * Updated conversation including the answer. + * Answer candidate to check. Can have a maximum length of 1024 characters. */ - conversation?: Schema$GoogleCloudDiscoveryengineV1betaConversation; + answerCandidate?: string | null; /** - * Suggested related questions. + * List of facts for the grounding check. We support up to 200 facts. */ - relatedQuestions?: string[] | null; + facts?: Schema$GoogleCloudDiscoveryengineV1betaGroundingFact[]; /** - * Answer to the current query. + * Configuration of the grounding check. */ - reply?: Schema$GoogleCloudDiscoveryengineV1betaReply; + groundingSpec?: Schema$GoogleCloudDiscoveryengineV1betaCheckGroundingSpec; /** - * Search Results. + * 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. */ - searchResults?: Schema$GoogleCloudDiscoveryengineV1betaSearchResponseSearchResult[]; + userLabels?: {[key: string]: string} | null; } /** - * Metadata related to the progress of the DataStoreService.CreateDataStore operation. This will be returned by the google.longrunning.Operation.metadata field. + * Response message for the GroundedGenerationService.CheckGrounding method. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaCreateDataStoreMetadata { + export interface Schema$GoogleCloudDiscoveryengineV1betaCheckGroundingResponse { /** - * Operation create time. + * List of facts cited across all claims in the answer candidate. These are derived from the facts supplied in the request. */ - createTime?: string | null; + citedChunks?: Schema$GoogleCloudDiscoveryengineV1betaFactChunk[]; /** - * Operation last update time. If the operation is done, this is also the finish time. + * Claim texts and citation info across all claims in the answer candidate. */ - updateTime?: string | null; + claims?: Schema$GoogleCloudDiscoveryengineV1betaCheckGroundingResponseClaim[]; + /** + * 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. + */ + supportScore?: number | null; } /** - * Metadata related to the progress of the EngineService.CreateEngine operation. This will be returned by the google.longrunning.Operation.metadata field. + * Text and citation info for a claim in the answer candidate. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaCreateEngineMetadata { + export interface Schema$GoogleCloudDiscoveryengineV1betaCheckGroundingResponseClaim { /** - * Operation create time. + * 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. */ - createTime?: string | null; + citationIndices?: number[] | null; /** - * Operation last update time. If the operation is done, this is also the finish time. + * Text for the claim in the answer candidate. Always provided regardless of whether citations or anti-citations are found. */ - updateTime?: string | null; - } - /** - * Metadata for Create Schema LRO. - */ - export interface Schema$GoogleCloudDiscoveryengineV1betaCreateSchemaMetadata { + claimText?: string | null; /** - * Operation create time. + * Position indicating the end of the claim in the answer candidate, exclusive. */ - createTime?: string | null; + endPos?: number | null; /** - * Operation last update time. If the operation is done, this is also the finish time. + * 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, and anti_citation_indices should not be returned. */ - updateTime?: string | null; + groundingCheckRequired?: boolean | null; + /** + * Position indicating the start of the claim in the answer candidate, measured in bytes. + */ + startPos?: number | null; } /** - * Metadata related to the progress of the SiteSearchEngineService.CreateTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field. + * Specification for the grounding check. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaCreateTargetSiteMetadata { - /** - * Operation create time. - */ - createTime?: string | null; + export interface Schema$GoogleCloudDiscoveryengineV1betaCheckGroundingSpec { /** - * Operation last update time. If the operation is done, this is also the finish time. + * 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. */ - updateTime?: string | null; + citationThreshold?: number | null; } /** - * Request message for SiteSearchEngineService.CreateTargetSite method. + * Chunk captures all raw metadata information of items to be recommended or searched in the chunk mode. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaCreateTargetSiteRequest { + export interface Schema$GoogleCloudDiscoveryengineV1betaChunk { /** - * Required. Parent resource name of TargetSite, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine`. + * Output only. Metadata of the current chunk. */ - parent?: string | null; + chunkMetadata?: Schema$GoogleCloudDiscoveryengineV1betaChunkChunkMetadata; /** - * Required. The TargetSite to create. + * Content is a string from a document (parsed content). */ - targetSite?: Schema$GoogleCloudDiscoveryengineV1betaTargetSite; - } - /** - * A custom attribute that is not explicitly modeled in a resource, e.g. UserEvent. - */ - export interface Schema$GoogleCloudDiscoveryengineV1betaCustomAttribute { + content?: string | null; /** - * 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. + * Output only. This field is OUTPUT_ONLY. It contains derived data that are not in the original input document. */ - numbers?: number[] | null; + derivedStructData?: {[key: string]: any} | null; /** - * 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. + * Metadata of the document from the current chunk. */ - text?: string[] | null; - } - /** - * Metadata that describes a custom tuned model. - */ - export interface Schema$GoogleCloudDiscoveryengineV1betaCustomTuningModel { + documentMetadata?: Schema$GoogleCloudDiscoveryengineV1betaChunkDocumentMetadata; /** - * Timestamp the Model was created at. + * Unique chunk ID of the current chunk. */ - createTime?: string | null; + id?: string | null; /** - * The display name of the model. + * 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. */ - displayName?: string | null; + name?: string | null; /** - * The state that the model is in (e.g.`TRAINING` or `TRAINING_FAILED`). + * Page span of the chunk. */ - modelState?: string | null; + pageSpan?: Schema$GoogleCloudDiscoveryengineV1betaChunkPageSpan; /** - * The version of the model. + * 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. */ - modelVersion?: string | null; + relevanceScore?: number | null; + } + /** + * Metadata of the current chunk. This field is only populated on SearchService.Search API. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaChunkChunkMetadata { /** - * Required. The fully qualified resource name of the model. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/customTuningModels/{custom_tuning_model\}` model must be an alpha-numerical string with limit of 40 characters. + * 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. */ - name?: string | null; + nextChunks?: Schema$GoogleCloudDiscoveryengineV1betaChunk[]; /** - * Timestamp the model training was initiated. + * 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. */ - trainingStartTime?: string | null; + previousChunks?: Schema$GoogleCloudDiscoveryengineV1betaChunk[]; } /** - * DataStore captures global settings and configs at the DataStore level. + * Document metadata contains the information of the document of the current chunk. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaDataStore { - /** - * Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT. - */ - contentConfig?: string | null; + export interface Schema$GoogleCloudDiscoveryengineV1betaChunkDocumentMetadata { /** - * Output only. Timestamp the DataStore was created at. + * Data representation. The structured JSON data for the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown. */ - createTime?: string | null; + structData?: {[key: string]: any} | null; /** - * Output only. The id of the default Schema asscociated to this data store. + * Title of the document. */ - defaultSchemaId?: string | null; + title?: string | null; /** - * 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. + * Uri of the document. */ - displayName?: string | null; + uri?: string | null; + } + /** + * Page span of the chunk. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaChunkPageSpan { /** - * Configuration for Document understanding and enrichment. + * The end page of the chunk. */ - documentProcessingConfig?: Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfig; + pageEnd?: number | null; /** - * Immutable. The industry vertical that the data store registers. + * The start page of the chunk. */ - industryVertical?: string | null; + pageStart?: number | null; + } + /** + * Cloud SQL source import data from. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaCloudSqlSource { /** - * Language info for DataStore. + * Required. The Cloud SQL database to copy the data from with a length limit of 256 characters. */ - languageInfo?: Schema$GoogleCloudDiscoveryengineV1betaLanguageInfo; + databaseId?: string | null; /** - * 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. + * 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. */ - name?: string | null; + gcsStagingDir?: string | null; /** - * 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. + * Required. The Cloud SQL instance to copy the data from with a length limit of 256 characters. */ - solutionTypes?: string[] | null; + instanceId?: string | null; /** - * 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). + * Option for serverless export. Enabling this option will incur additional cost. More info can be found [here](https://cloud.google.com/sql/pricing#serverless). */ - startingSchema?: Schema$GoogleCloudDiscoveryengineV1betaSchema; - } - /** - * Metadata related to the progress of the DataStoreService.DeleteDataStore operation. This will be returned by the google.longrunning.Operation.metadata field. - */ - export interface Schema$GoogleCloudDiscoveryengineV1betaDeleteDataStoreMetadata { + offload?: boolean | null; /** - * Operation create time. + * 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. */ - createTime?: string | null; + projectId?: string | null; /** - * Operation last update time. If the operation is done, this is also the finish time. + * Required. The Cloud SQL table to copy the data from with a length limit of 256 characters. */ - updateTime?: string | null; + tableId?: string | null; } /** - * Metadata related to the progress of the EngineService.DeleteEngine operation. This will be returned by the google.longrunning.Operation.metadata field. + * Response message for CompletionService.CompleteQuery method. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaDeleteEngineMetadata { + export interface Schema$GoogleCloudDiscoveryengineV1betaCompleteQueryResponse { /** - * Operation create time. + * Results of the matched query suggestions. The result list is ordered and the first result is a top suggestion. */ - createTime?: string | null; + querySuggestions?: Schema$GoogleCloudDiscoveryengineV1betaCompleteQueryResponseQuerySuggestion[]; /** - * Operation last update time. If the operation is done, this is also the finish time. + * 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. */ - updateTime?: string | null; + tailMatchTriggered?: boolean | null; } /** - * Metadata for DeleteSchema LRO. + * Suggestions as search queries. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaDeleteSchemaMetadata { + export interface Schema$GoogleCloudDiscoveryengineV1betaCompleteQueryResponseQuerySuggestion { /** - * Operation create time. + * 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. */ - createTime?: string | null; + completableFieldPaths?: string[] | null; /** - * Operation last update time. If the operation is done, this is also the finish time. + * The suggestion for the query. */ - updateTime?: string | null; + suggestion?: string | null; } /** - * Metadata related to the progress of the SiteSearchEngineService.DeleteTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field. + * Detailed completion information including completion attribution token and clicked completion info. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaDeleteTargetSiteMetadata { + export interface Schema$GoogleCloudDiscoveryengineV1betaCompletionInfo { /** - * Operation create time. + * End user selected CompleteQueryResponse.QuerySuggestion.suggestion position, starting from 0. */ - createTime?: string | null; + selectedPosition?: number | null; /** - * Operation last update time. If the operation is done, this is also the finish time. + * End user selected CompleteQueryResponse.QuerySuggestion.suggestion. */ - updateTime?: string | null; + selectedSuggestion?: string | null; } /** - * Metadata related to the progress of the SiteSearchEngineService.DisableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field. + * Autocomplete suggestions that are imported from Customer. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaDisableAdvancedSiteSearchMetadata { + export interface Schema$GoogleCloudDiscoveryengineV1betaCompletionSuggestion { /** - * Operation create time. + * Alternative matching phrases for this suggestion. */ - createTime?: string | null; + alternativePhrases?: string[] | null; /** - * Operation last update time. If the operation is done, this is also the finish time. + * Frequency of this suggestion. Will be used to rank suggestions when score is not available. */ - updateTime?: string | null; - } - /** - * Request message for SiteSearchEngineService.DisableAdvancedSiteSearch method. - */ - export interface Schema$GoogleCloudDiscoveryengineV1betaDisableAdvancedSiteSearchRequest {} - /** - * Response message for SiteSearchEngineService.DisableAdvancedSiteSearch method. - */ - export interface Schema$GoogleCloudDiscoveryengineV1betaDisableAdvancedSiteSearchResponse {} - /** - * Document captures all raw metadata information of items to be recommended or searched. - */ - export interface Schema$GoogleCloudDiscoveryengineV1betaDocument { + frequency?: string | null; /** - * The unstructured data linked to this document. Content must be set if this document is under a `CONTENT_REQUIRED` data store. + * Global score of this suggestion. Control how this suggestion would be scored / ranked. */ - content?: Schema$GoogleCloudDiscoveryengineV1betaDocumentContent; + globalScore?: number | null; /** - * Output only. This field is OUTPUT_ONLY. It contains derived data that are not in the original input document. + * 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. */ - derivedStructData?: {[key: string]: any} | null; + groupId?: string | null; /** - * 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. + * The score of this suggestion within its group. */ - id?: string | null; + groupScore?: number | null; /** - * 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. + * BCP-47 language code of this suggestion. */ - indexTime?: string | null; + languageCode?: string | null; /** - * The JSON string representation of the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown. + * Required. The suggestion text. */ - jsonData?: string | null; + suggestion?: string | null; + } + /** + * Defines circumstances to be checked before allowing a behavior + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaCondition { /** - * 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. + * Range of time(s) specifying when condition is active. Maximum of 10 time ranges. */ - name?: string | null; + activeTimeRange?: Schema$GoogleCloudDiscoveryengineV1betaConditionTimeRange[]; /** - * 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. + * Search only A list of terms to match the query on. Maximum of 10 query terms. */ - parentDocumentId?: string | null; + queryTerms?: Schema$GoogleCloudDiscoveryengineV1betaConditionQueryTerm[]; + } + /** + * Matcher for search request query + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaConditionQueryTerm { /** - * The identifier of the schema located in the same data store. + * Whether the search query needs to exactly match the query term. */ - schemaId?: string | null; + fullMatch?: boolean | null; /** - * The structured JSON data for the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown. + * 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. */ - structData?: {[key: string]: any} | null; + value?: string | null; } /** - * Unstructured data linked to this document. + * Used for time-dependent conditions. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaDocumentContent { - /** - * 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. - */ - mimeType?: string | null; + export interface Schema$GoogleCloudDiscoveryengineV1betaConditionTimeRange { /** - * 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. + * End of time range. Range is inclusive. Must be in the future. */ - rawBytes?: string | null; + endTime?: string | null; /** - * 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. + * Start of time range. Range is inclusive. */ - uri?: string | null; + startTime?: string | null; } /** - * Detailed document information associated with a user event. + * 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`. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaDocumentInfo { + export interface Schema$GoogleCloudDiscoveryengineV1betaControl { /** - * The Document resource ID. + * Output only. List of all ServingConfig ids this control is attached to. May take up to 10 minutes to update after changes. */ - id?: string | null; + associatedServingConfigIds?: string[] | null; /** - * The Document resource full name, of the form: `projects/{project_id\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/branches/{branch_id\}/documents/{document_id\}` - */ - name?: string | null; - /** - * The promotion IDs associated with this Document. Currently, this field is restricted to at most one ID. - */ - promotionIds?: string[] | null; - /** - * 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` + * Defines a boost-type control */ - quantity?: number | null; + boostAction?: Schema$GoogleCloudDiscoveryengineV1betaControlBoostAction; /** - * The Document URI - only allowed for website data stores. + * 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. */ - uri?: string | null; - } - /** - * A singleton resource of DataStore. It's empty when DataStore is created, which defaults to digital parser. The first call to DataStoreService.UpdateDocumentProcessingConfig method will initialize the config. - */ - export interface Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfig { + conditions?: Schema$GoogleCloudDiscoveryengineV1betaCondition[]; /** - * Whether chunking mode is enabled. + * 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. */ - chunkingConfig?: Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfig; + displayName?: string | null; /** - * 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. + * Defines a filter-type control Currently not supported by Recommendation */ - defaultParsingConfig?: Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig; + filterAction?: Schema$GoogleCloudDiscoveryengineV1betaControlFilterAction; /** - * The full resource name of the Document Processing Config. Format: `projects/x/locations/x/collections/x/dataStores/x/documentProcessingConfig`. + * Immutable. Fully qualified name `projects/x/locations/global/dataStore/x/controls/x` */ name?: string | null; /** - * 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 or layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and or layout parsing are supported. + * Defines a redirect-type control. */ - parsingConfigOverrides?: { - [ - key: string - ]: Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig; - } | null; - } - /** - * Configuration for chunking config. - */ - export interface Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfig { + redirectAction?: Schema$GoogleCloudDiscoveryengineV1betaControlRedirectAction; /** - * Configuration for the layout based chunking. + * Required. Immutable. What solution the control belongs to. Must be compatible with vertical of resource. Otherwise an INVALID ARGUMENT error is thrown. */ - layoutBasedChunkingConfig?: Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig; - } - /** - * Configuration for the layout based chunking. - */ - export interface Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig { + solutionType?: string | null; /** - * The token size limit for each chunk. Supported values: 100-500 (inclusive). Default value: 500. + * Treats a group of terms as synonyms of one another. */ - chunkSize?: number | null; + synonymsAction?: Schema$GoogleCloudDiscoveryengineV1betaControlSynonymsAction; /** - * Whether to include appending different levels of headings to chunks from the middle of the document to prevent context loss. Default value: False. + * 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. */ - includeAncestorHeadings?: boolean | null; + useCases?: string[] | null; } /** - * Related configurations applied to a specific type of document parser. + * Adjusts order of products in returned list. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig { + export interface Schema$GoogleCloudDiscoveryengineV1betaControlBoostAction { /** - * Configurations applied to digital parser. + * Required. Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0 (No-op). */ - digitalParsingConfig?: Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigDigitalParsingConfig; + boost?: number | null; /** - * Configurations applied to layout parser. + * 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 */ - layoutParsingConfig?: Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigLayoutParsingConfig; + dataStore?: string | null; /** - * Configurations applied to OCR parser. Currently it only applies to PDFs. + * 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. */ - ocrParsingConfig?: Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsingConfig; + filter?: string | null; } /** - * The digital parsing configurations for documents. - */ - export interface Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigDigitalParsingConfig {} - /** - * The layout parsing configurations for documents. - */ - export interface Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigLayoutParsingConfig {} - /** - * The OCR parsing configurations for documents. + * Specified which products may be included in results. Uses same filter as boost. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsingConfig { + export interface Schema$GoogleCloudDiscoveryengineV1betaControlFilterAction { /** - * [DEPRECATED] This field is deprecated. To use the additional enhanced document elements processing, please switch to `layout_parsing_config`. + * 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 */ - enhancedDocumentElements?: string[] | null; + dataStore?: string | null; /** - * If true, will use native text instead of OCR text on pages containing native text. + * 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. */ - useNativeText?: boolean | null; + filter?: string | null; } /** - * Double list. + * Redirects a shopper to the provided URI. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaDoubleList { + export interface Schema$GoogleCloudDiscoveryengineV1betaControlRedirectAction { /** - * Double values. + * 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. */ - values?: number[] | null; + redirectUri?: string | null; } /** - * Defines embedding config, used for bring your own embeddings feature. + * 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". */ - export interface Schema$GoogleCloudDiscoveryengineV1betaEmbeddingConfig { + export interface Schema$GoogleCloudDiscoveryengineV1betaControlSynonymsAction { /** - * Full field path in the schema mapped as embedding field. + * Defines a set of synonyms. Can specify up to 100 synonyms. Must specify at least 2 synonyms. Otherwise an INVALID ARGUMENT error is thrown. */ - fieldPath?: string | null; + synonyms?: string[] | null; } /** - * Metadata related to the progress of the SiteSearchEngineService.EnableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field. + * External conversation proto definition. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaEnableAdvancedSiteSearchMetadata { + export interface Schema$GoogleCloudDiscoveryengineV1betaConversation { /** - * Operation create time. + * Output only. The time the conversation finished. */ - createTime?: string | null; + endTime?: string | null; /** - * Operation last update time. If the operation is done, this is also the finish time. + * Conversation messages. */ - updateTime?: string | null; + messages?: Schema$GoogleCloudDiscoveryengineV1betaConversationMessage[]; + /** + * Immutable. Fully qualified name `projects/{project\}/locations/global/collections/{collection\}/dataStore/x/conversations/x` or `projects/{project\}/locations/global/collections/{collection\}/engines/x/conversations/x`. + */ + name?: string | null; + /** + * Output only. The time the conversation started. + */ + startTime?: string | null; + /** + * The state of the Conversation. + */ + state?: string | null; + /** + * A unique identifier for tracking users. + */ + userPseudoId?: string | null; } /** - * Request message for SiteSearchEngineService.EnableAdvancedSiteSearch method. - */ - export interface Schema$GoogleCloudDiscoveryengineV1betaEnableAdvancedSiteSearchRequest {} - /** - * Response message for SiteSearchEngineService.EnableAdvancedSiteSearch method. - */ - export interface Schema$GoogleCloudDiscoveryengineV1betaEnableAdvancedSiteSearchResponse {} - /** - * Metadata that describes the training and serving parameters of an Engine. + * Defines context of the conversation */ - export interface Schema$GoogleCloudDiscoveryengineV1betaEngine { + export interface Schema$GoogleCloudDiscoveryengineV1betaConversationContext { /** - * Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT. + * The current active document the user opened. It contains the document resource reference. */ - chatEngineConfig?: Schema$GoogleCloudDiscoveryengineV1betaEngineChatEngineConfig; + activeDocument?: string | null; /** - * Output only. Additional information of the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT. + * The current list of documents the user is seeing. It contains the document resource references. */ - chatEngineMetadata?: Schema$GoogleCloudDiscoveryengineV1betaEngineChatEngineMetadata; + contextDocuments?: string[] | null; + } + /** + * Defines a conversation message. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaConversationMessage { /** - * Common config spec that specifies the metadata of the engine. + * Output only. Message creation timestamp. */ - commonConfig?: Schema$GoogleCloudDiscoveryengineV1betaEngineCommonConfig; + createTime?: string | null; /** - * Output only. Timestamp the Recommendation Engine was created at. + * Search reply. */ - createTime?: string | null; + reply?: Schema$GoogleCloudDiscoveryengineV1betaReply; /** - * 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. + * User text input. */ - dataStoreIds?: string[] | null; + userInput?: Schema$GoogleCloudDiscoveryengineV1betaTextInput; + } + /** + * Request message for ConversationalSearchService.ConverseConversation method. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaConverseConversationRequest { /** - * Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. + * 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) */ - displayName?: string | null; + boostSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpec; /** - * 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. + * 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. */ - industryVertical?: string | null; + conversation?: Schema$GoogleCloudDiscoveryengineV1betaConversation; /** - * 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_number\}/locations/{location\}/collections/{collection\}/engines/{engine\}` engine should be 1-63 characters, and valid characters are /a-z0-9x/. Otherwise, an INVALID_ARGUMENT error is returned. + * 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) */ - name?: string | null; + filter?: string | null; /** - * Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH. + * Required. Current user input. */ - searchEngineConfig?: Schema$GoogleCloudDiscoveryengineV1betaEngineSearchEngineConfig; + query?: Schema$GoogleCloudDiscoveryengineV1betaTextInput; /** - * Required. The solutions of the engine. + * Whether to turn on safe search. */ - solutionType?: string | null; + safeSearch?: boolean | null; /** - * Output only. Timestamp the Recommendation Engine was last updated. + * The resource name of the Serving Config to use. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/servingConfigs/{serving_config_id\}` If this is not set, the default serving config will be used. */ - updateTime?: string | null; - } - /** - * Configurations for a Chat Engine. - */ - export interface Schema$GoogleCloudDiscoveryengineV1betaEngineChatEngineConfig { + servingConfig?: string | null; /** - * 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. + * A specification for configuring the summary returned in the response. */ - agentCreationConfig?: Schema$GoogleCloudDiscoveryengineV1betaEngineChatEngineConfigAgentCreationConfig; + summarySpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpec; /** - * 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. + * 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. */ - dialogflowAgentToLink?: string | null; + userLabels?: {[key: string]: string} | null; } /** - * 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. + * Response message for ConversationalSearchService.ConverseConversation method. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaEngineChatEngineConfigAgentCreationConfig { + export interface Schema$GoogleCloudDiscoveryengineV1betaConverseConversationResponse { /** - * Name of the company, organization or other entity that the agent represents. Used for knowledge connector LLM prompt and for knowledge search. + * Updated conversation including the answer. */ - business?: string | null; + conversation?: Schema$GoogleCloudDiscoveryengineV1betaConversation; /** - * 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. + * Suggested related questions. */ - defaultLanguageCode?: string | null; + relatedQuestions?: string[] | null; /** - * 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. + * Answer to the current query. */ - location?: string | null; + reply?: Schema$GoogleCloudDiscoveryengineV1betaReply; /** - * 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. + * Search Results. */ - timeZone?: string | null; + searchResults?: Schema$GoogleCloudDiscoveryengineV1betaSearchResponseSearchResult[]; } /** - * Additional information of a Chat Engine. Fields in this message are output only. + * Metadata related to the progress of the DataStoreService.CreateDataStore operation. This will be returned by the google.longrunning.Operation.metadata field. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaEngineChatEngineMetadata { + export interface Schema$GoogleCloudDiscoveryengineV1betaCreateDataStoreMetadata { /** - * The resource name of a Dialogflow agent, that this Chat Engine refers to. Format: `projects//locations//agents/`. + * Operation create time. */ - dialogflowAgent?: string | null; + createTime?: string | null; + /** + * Operation last update time. If the operation is done, this is also the finish time. + */ + updateTime?: string | null; } /** - * Common configurations for an Engine. + * Metadata related to the progress of the EngineService.CreateEngine operation. This will be returned by the google.longrunning.Operation.metadata field. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaEngineCommonConfig { + export interface Schema$GoogleCloudDiscoveryengineV1betaCreateEngineMetadata { /** - * The name of the company, business or entity that is associated with the engine. Setting this may help improve LLM related features. + * Operation create time. */ - companyName?: string | null; + createTime?: string | null; + /** + * Operation last update time. If the operation is done, this is also the finish time. + */ + updateTime?: string | null; } /** - * Configurations for a Search Engine. + * Metadata for EvaluationService.CreateEvaluation method. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaEngineSearchEngineConfig { + export interface Schema$GoogleCloudDiscoveryengineV1betaCreateEvaluationMetadata {} + /** + * Metadata for Create Schema LRO. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaCreateSchemaMetadata { /** - * The add-on that this search engine enables. + * Operation create time. */ - searchAddOns?: string[] | null; + createTime?: string | null; /** - * 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. */ - searchTier?: string | null; + updateTime?: string | null; } /** - * Fact Chunk. + * Metadata related to the progress of the SiteSearchEngineService.CreateTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaFactChunk { - /** - * Text content of the fact chunk. Can be at most 10K characters long. - */ - chunkText?: string | null; - /** - * The index of this chunk. Currently, only used for the streaming mode. - */ - index?: number | null; + export interface Schema$GoogleCloudDiscoveryengineV1betaCreateTargetSiteMetadata { /** - * 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. + * Operation create time. */ - source?: string | null; + createTime?: string | null; /** - * More fine-grained information for the source reference. + * Operation last update time. If the operation is done, this is also the finish time. */ - sourceMetadata?: {[key: string]: string} | null; + updateTime?: string | null; } /** - * Response message for SiteSearchEngineService.FetchDomainVerificationStatus method. + * Request message for SiteSearchEngineService.CreateTargetSite method. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaFetchDomainVerificationStatusResponse { - /** - * A token that can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. - */ - nextPageToken?: string | null; + export interface Schema$GoogleCloudDiscoveryengineV1betaCreateTargetSiteRequest { /** - * List of TargetSites containing the site verification status. + * Required. Parent resource name of TargetSite, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine`. */ - targetSites?: Schema$GoogleCloudDiscoveryengineV1betaTargetSite[]; + parent?: string | null; /** - * The total number of items matching the request. This will always be populated in the response. + * Required. The TargetSite to create. */ - totalSize?: number | null; + targetSite?: Schema$GoogleCloudDiscoveryengineV1betaTargetSite; } /** - * Cloud FhirStore source import data from. + * A custom attribute that is not explicitly modeled in a resource, e.g. UserEvent. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaFhirStoreSource { + export interface Schema$GoogleCloudDiscoveryengineV1betaCustomAttribute { /** - * 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\}`. + * 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. */ - fhirStore?: string | null; + numbers?: number[] | null; /** - * 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. + * 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. */ - gcsStagingDir?: string | null; + text?: string[] | null; } /** - * Firestore source import data from. + * Metadata that describes a custom tuned model. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaFirestoreSource { + export interface Schema$GoogleCloudDiscoveryengineV1betaCustomTuningModel { /** - * Required. The Firestore collection (or entity) to copy the data from with a length limit of 1,500 characters. + * Timestamp the Model was created at. */ - collectionId?: string | null; + createTime?: string | null; /** - * Required. The Firestore database to copy the data from with a length limit of 256 characters. + * The display name of the model. */ - databaseId?: string | null; + displayName?: string | null; /** - * 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. + * The metrics of the trained model. */ - gcsStagingDir?: string | null; + metrics?: {[key: string]: number} | null; /** - * 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. + * The state that the model is in (e.g.`TRAINING` or `TRAINING_FAILED`). */ - projectId?: string | null; - } - /** - * Cloud Storage location for input content. - */ - export interface Schema$GoogleCloudDiscoveryengineV1betaGcsSource { + modelState?: string | null; /** - * 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 version of the model. */ - dataSchema?: string | null; + modelVersion?: string | null; /** - * 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/x.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`). + * Required. The fully qualified resource name of the model. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/customTuningModels/{custom_tuning_model\}` model must be an alpha-numerical string with limit of 40 characters. */ - inputUris?: string[] | null; + name?: string | null; + /** + * Timestamp the model training was initiated. + */ + trainingStartTime?: string | null; } /** - * Grounding Fact. + * DataStore captures global settings and configs at the DataStore level. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaGroundingFact { + export interface Schema$GoogleCloudDiscoveryengineV1betaDataStore { /** - * 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. + * Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT. */ - attributes?: {[key: string]: string} | null; + contentConfig?: string | null; /** - * Text content of the fact. Can be at most 10K characters long. + * Output only. Timestamp the DataStore was created at. */ - factText?: string | null; - } - /** - * Metadata related to the progress of the ImportCompletionSuggestions operation. This will be returned by the google.longrunning.Operation.metadata field. - */ - export interface Schema$GoogleCloudDiscoveryengineV1betaImportCompletionSuggestionsMetadata { + createTime?: string | null; /** - * Operation create time. + * Output only. The id of the default Schema asscociated to this data store. */ - createTime?: string | null; + defaultSchemaId?: string | null; /** - * Count of CompletionSuggestions that failed to be imported. + * 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. */ - failureCount?: string | null; + displayName?: string | null; /** - * Count of CompletionSuggestions successfully imported. + * Configuration for Document understanding and enrichment. */ - successCount?: string | null; + documentProcessingConfig?: Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfig; /** - * Operation last update time. If the operation is done, this is also the finish time. + * Immutable. The industry vertical that the data store registers. */ - updateTime?: string | null; - } - /** - * Request message for CompletionService.ImportCompletionSuggestions method. - */ - export interface Schema$GoogleCloudDiscoveryengineV1betaImportCompletionSuggestionsRequest { + industryVertical?: string | null; /** - * BigQuery input source. + * Language info for DataStore. */ - bigquerySource?: Schema$GoogleCloudDiscoveryengineV1betaBigQuerySource; + languageInfo?: Schema$GoogleCloudDiscoveryengineV1betaLanguageInfo; /** - * The desired location of errors incurred during the Import. + * 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. */ - errorConfig?: Schema$GoogleCloudDiscoveryengineV1betaImportErrorConfig; + name?: string | null; /** - * Cloud Storage location for the input content. + * 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. */ - gcsSource?: Schema$GoogleCloudDiscoveryengineV1betaGcsSource; + solutionTypes?: string[] | null; /** - * The Inline source for suggestion entries. + * 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). */ - inlineSource?: Schema$GoogleCloudDiscoveryengineV1betaImportCompletionSuggestionsRequestInlineSource; + startingSchema?: Schema$GoogleCloudDiscoveryengineV1betaSchema; } /** - * The inline source for CompletionSuggestions. + * Metadata related to the progress of the DataStoreService.DeleteDataStore operation. This will be returned by the google.longrunning.Operation.metadata field. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaImportCompletionSuggestionsRequestInlineSource { + export interface Schema$GoogleCloudDiscoveryengineV1betaDeleteDataStoreMetadata { /** - * Required. A list of all denylist entries to import. Max of 1000 items. + * Operation create time. */ - suggestions?: Schema$GoogleCloudDiscoveryengineV1betaCompletionSuggestion[]; + createTime?: string | null; + /** + * Operation last update time. If the operation is done, this is also the finish time. + */ + updateTime?: string | null; } /** - * 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. + * Metadata related to the progress of the EngineService.DeleteEngine operation. This will be returned by the google.longrunning.Operation.metadata field. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaImportCompletionSuggestionsResponse { + export interface Schema$GoogleCloudDiscoveryengineV1betaDeleteEngineMetadata { /** - * The desired location of errors incurred during the Import. + * Operation create time. */ - errorConfig?: Schema$GoogleCloudDiscoveryengineV1betaImportErrorConfig; + createTime?: string | null; /** - * A sample of errors encountered while processing the request. + * Operation last update time. If the operation is done, this is also the finish time. */ - errorSamples?: Schema$GoogleRpcStatus[]; + updateTime?: string | null; } /** - * Metadata related to the progress of the ImportDocuments operation. This is returned by the google.longrunning.Operation.metadata field. + * Metadata for DeleteSchema LRO. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaImportDocumentsMetadata { + export interface Schema$GoogleCloudDiscoveryengineV1betaDeleteSchemaMetadata { /** * Operation create time. */ createTime?: string | null; /** - * Count of entries that encountered errors while processing. - */ - failureCount?: string | null; - /** - * Count of entries that were processed successfully. + * Operation last update time. If the operation is done, this is also the finish time. */ - successCount?: string | null; + updateTime?: string | null; + } + /** + * Metadata related to the progress of the SiteSearchEngineService.DeleteTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaDeleteTargetSiteMetadata { /** - * Total count of entries that were processed. + * Operation create time. */ - totalCount?: string | null; + createTime?: string | null; /** * Operation last update time. If the operation is done, this is also the finish time. */ updateTime?: string | null; } /** - * Request message for Import methods. + * Metadata related to the progress of the SiteSearchEngineService.DisableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaImportDocumentsRequest { + export interface Schema$GoogleCloudDiscoveryengineV1betaDisableAdvancedSiteSearchMetadata { /** - * AlloyDB input source. + * Operation create time. */ - alloyDbSource?: Schema$GoogleCloudDiscoveryengineV1betaAlloyDbSource; + createTime?: string | null; /** - * 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. + * Operation last update time. If the operation is done, this is also the finish time. */ - autoGenerateIds?: boolean | null; + updateTime?: string | null; + } + /** + * Request message for SiteSearchEngineService.DisableAdvancedSiteSearch method. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaDisableAdvancedSiteSearchRequest {} + /** + * Response message for SiteSearchEngineService.DisableAdvancedSiteSearch method. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaDisableAdvancedSiteSearchResponse {} + /** + * Document captures all raw metadata information of items to be recommended or searched. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaDocument { /** - * BigQuery input source. + * The unstructured data linked to this document. Content must be set if this document is under a `CONTENT_REQUIRED` data store. */ - bigquerySource?: Schema$GoogleCloudDiscoveryengineV1betaBigQuerySource; + content?: Schema$GoogleCloudDiscoveryengineV1betaDocumentContent; /** - * Cloud Bigtable input source. + * Output only. This field is OUTPUT_ONLY. It contains derived data that are not in the original input document. */ - bigtableSource?: Schema$GoogleCloudDiscoveryengineV1betaBigtableSource; + derivedStructData?: {[key: string]: any} | null; /** - * Cloud SQL input source. + * 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. */ - cloudSqlSource?: Schema$GoogleCloudDiscoveryengineV1betaCloudSqlSource; + id?: string | null; /** - * The desired location of errors incurred during the Import. + * 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. */ - errorConfig?: Schema$GoogleCloudDiscoveryengineV1betaImportErrorConfig; + indexTime?: string | null; /** - * FhirStore input source. + * The JSON string representation of the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown. */ - fhirStoreSource?: Schema$GoogleCloudDiscoveryengineV1betaFhirStoreSource; + jsonData?: string | null; /** - * Firestore input source. + * 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. */ - firestoreSource?: Schema$GoogleCloudDiscoveryengineV1betaFirestoreSource; + name?: string | null; /** - * Cloud Storage location for the input content. + * 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. */ - gcsSource?: Schema$GoogleCloudDiscoveryengineV1betaGcsSource; + parentDocumentId?: string | null; /** - * 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. + * The identifier of the schema located in the same data store. */ - idField?: string | null; + schemaId?: string | null; /** - * The Inline source for the input content for documents. + * The structured JSON data for the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown. */ - inlineSource?: Schema$GoogleCloudDiscoveryengineV1betaImportDocumentsRequestInlineSource; + structData?: {[key: string]: any} | null; + } + /** + * Unstructured data linked to this document. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaDocumentContent { /** - * The mode of reconciliation between existing documents and the documents to be imported. Defaults to ReconciliationMode.INCREMENTAL. + * 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. */ - reconciliationMode?: string | null; + mimeType?: string | null; /** - * Spanner input source. + * 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. */ - spannerSource?: Schema$GoogleCloudDiscoveryengineV1betaSpannerSource; + rawBytes?: string | null; /** - * Indicates which fields in the provided imported documents to update. If not set, the default is to update all fields. + * 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. */ - updateMask?: string | null; + uri?: string | null; } /** - * The inline source for the input config for ImportDocuments method. + * Detailed document information associated with a user event. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaImportDocumentsRequestInlineSource { + export interface Schema$GoogleCloudDiscoveryengineV1betaDocumentInfo { /** - * Required. A list of documents to update/create. Each document must have a valid Document.id. Recommended max of 100 items. + * The Document resource ID. */ - documents?: Schema$GoogleCloudDiscoveryengineV1betaDocument[]; + id?: string | null; + /** + * The Document resource full name, of the form: `projects/{project_id\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/branches/{branch_id\}/documents/{document_id\}` + */ + name?: string | null; + /** + * The promotion IDs associated with this Document. Currently, this field is restricted to at most one ID. + */ + promotionIds?: string[] | null; + /** + * 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` + */ + quantity?: number | null; + /** + * The Document URI - only allowed for website data stores. + */ + uri?: string | null; } /** - * 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. + * A singleton resource of DataStore. It's empty when DataStore is created, which defaults to digital parser. The first call to DataStoreService.UpdateDocumentProcessingConfig method will initialize the config. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaImportDocumentsResponse { + export interface Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfig { /** - * Echoes the destination for the complete errors in the request if set. + * Whether chunking mode is enabled. */ - errorConfig?: Schema$GoogleCloudDiscoveryengineV1betaImportErrorConfig; + chunkingConfig?: Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfig; /** - * A sample of errors encountered while processing the request. + * 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. */ - errorSamples?: Schema$GoogleRpcStatus[]; + defaultParsingConfig?: Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig; + /** + * The full resource name of the Document Processing Config. Format: `projects/x/locations/x/collections/x/dataStores/x/documentProcessingConfig`. + */ + name?: string | null; + /** + * 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. + */ + parsingConfigOverrides?: { + [ + key: string + ]: Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig; + } | null; } /** - * Configuration of destination for Import related errors. + * Configuration for chunking config. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaImportErrorConfig { + export interface Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfig { /** - * 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. + * Configuration for the layout based chunking. */ - gcsPrefix?: string | null; + layoutBasedChunkingConfig?: Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig; } /** - * Metadata related to the progress of the ImportSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field. + * Configuration for the layout based chunking. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaImportSuggestionDenyListEntriesMetadata { + export interface Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig { /** - * Operation create time. + * The token size limit for each chunk. Supported values: 100-500 (inclusive). Default value: 500. */ - createTime?: string | null; + chunkSize?: number | null; /** - * Operation last update time. If the operation is done, this is also the finish time. + * Whether to include appending different levels of headings to chunks from the middle of the document to prevent context loss. Default value: False. */ - updateTime?: string | null; + includeAncestorHeadings?: boolean | null; } /** - * Request message for CompletionService.ImportSuggestionDenyListEntries method. + * Related configurations applied to a specific type of document parser. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaImportSuggestionDenyListEntriesRequest { + export interface Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig { /** - * 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. + * Configurations applied to digital parser. */ - gcsSource?: Schema$GoogleCloudDiscoveryengineV1betaGcsSource; + digitalParsingConfig?: Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigDigitalParsingConfig; /** - * The Inline source for the input content for suggestion deny list entries. + * Configurations applied to layout parser. */ - inlineSource?: Schema$GoogleCloudDiscoveryengineV1betaImportSuggestionDenyListEntriesRequestInlineSource; + layoutParsingConfig?: Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigLayoutParsingConfig; + /** + * Configurations applied to OCR parser. Currently it only applies to PDFs. + */ + ocrParsingConfig?: Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsingConfig; } /** - * The inline source for SuggestionDenyListEntry. + * The digital parsing configurations for documents. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaImportSuggestionDenyListEntriesRequestInlineSource { + export interface Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigDigitalParsingConfig {} + /** + * The layout parsing configurations for documents. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigLayoutParsingConfig {} + /** + * The OCR parsing configurations for documents. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsingConfig { /** - * Required. A list of all denylist entries to import. Max of 1000 items. + * [DEPRECATED] This field is deprecated. To use the additional enhanced document elements processing, please switch to `layout_parsing_config`. */ - entries?: Schema$GoogleCloudDiscoveryengineV1betaSuggestionDenyListEntry[]; + enhancedDocumentElements?: string[] | null; + /** + * If true, will use native text instead of OCR text on pages containing native text. + */ + useNativeText?: boolean | null; } /** - * Response message for CompletionService.ImportSuggestionDenyListEntries method. + * Double list. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaImportSuggestionDenyListEntriesResponse { - /** - * A sample of errors encountered while processing the request. - */ - errorSamples?: Schema$GoogleRpcStatus[]; + export interface Schema$GoogleCloudDiscoveryengineV1betaDoubleList { /** - * Count of deny list entries that failed to be imported. + * Double values. */ - failedEntriesCount?: string | null; + values?: number[] | null; + } + /** + * Defines embedding config, used for bring your own embeddings feature. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaEmbeddingConfig { /** - * Count of deny list entries successfully imported. + * Full field path in the schema mapped as embedding field. */ - importedEntriesCount?: string | null; + fieldPath?: string | null; } /** - * Metadata related to the progress of the Import operation. This is returned by the google.longrunning.Operation.metadata field. + * Metadata related to the progress of the SiteSearchEngineService.EnableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaImportUserEventsMetadata { + export interface Schema$GoogleCloudDiscoveryengineV1betaEnableAdvancedSiteSearchMetadata { /** * Operation create time. */ createTime?: string | null; - /** - * Count of entries that encountered errors while processing. - */ - failureCount?: string | null; - /** - * Count of entries that were processed successfully. - */ - successCount?: string | null; /** * Operation last update time. If the operation is done, this is also the finish time. */ updateTime?: string | null; } /** - * Request message for the ImportUserEvents request. + * Request message for SiteSearchEngineService.EnableAdvancedSiteSearch method. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaImportUserEventsRequest { + export interface Schema$GoogleCloudDiscoveryengineV1betaEnableAdvancedSiteSearchRequest {} + /** + * Response message for SiteSearchEngineService.EnableAdvancedSiteSearch method. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaEnableAdvancedSiteSearchResponse {} + /** + * Metadata that describes the training and serving parameters of an Engine. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaEngine { /** - * BigQuery input source. + * Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT. */ - bigquerySource?: Schema$GoogleCloudDiscoveryengineV1betaBigQuerySource; + chatEngineConfig?: Schema$GoogleCloudDiscoveryengineV1betaEngineChatEngineConfig; /** - * The desired location of errors incurred during the Import. Cannot be set for inline user event imports. + * Output only. Additional information of the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT. */ - errorConfig?: Schema$GoogleCloudDiscoveryengineV1betaImportErrorConfig; + chatEngineMetadata?: Schema$GoogleCloudDiscoveryengineV1betaEngineChatEngineMetadata; /** - * Cloud Storage location for the input content. + * Common config spec that specifies the metadata of the engine. */ - gcsSource?: Schema$GoogleCloudDiscoveryengineV1betaGcsSource; + commonConfig?: Schema$GoogleCloudDiscoveryengineV1betaEngineCommonConfig; /** - * The Inline source for the input content for UserEvents. + * Output only. Timestamp the Recommendation Engine was created at. */ - inlineSource?: Schema$GoogleCloudDiscoveryengineV1betaImportUserEventsRequestInlineSource; - } - /** - * The inline source for the input config for ImportUserEvents method. - */ - export interface Schema$GoogleCloudDiscoveryengineV1betaImportUserEventsRequestInlineSource { + createTime?: string | null; /** - * Required. A list of user events to import. Recommended max of 10k items. + * 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. */ - userEvents?: Schema$GoogleCloudDiscoveryengineV1betaUserEvent[]; - } - /** - * 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. - */ - export interface Schema$GoogleCloudDiscoveryengineV1betaImportUserEventsResponse { + dataStoreIds?: string[] | null; /** - * Echoes the destination for the complete errors if this field was set in the request. + * Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. */ - errorConfig?: Schema$GoogleCloudDiscoveryengineV1betaImportErrorConfig; + displayName?: string | null; /** - * A sample of errors encountered while processing the request. + * 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. */ - errorSamples?: Schema$GoogleRpcStatus[]; + industryVertical?: string | null; /** - * Count of user events imported with complete existing Documents. + * 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_number\}/locations/{location\}/collections/{collection\}/engines/{engine\}` engine should be 1-63 characters, and valid characters are /a-z0-9x/. Otherwise, an INVALID_ARGUMENT error is returned. */ - joinedEventsCount?: string | null; + name?: string | null; /** - * Count of user events imported, but with Document information not found in the existing Branch. + * Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH. */ - unjoinedEventsCount?: string | null; - } - /** - * A floating point interval. - */ - export interface Schema$GoogleCloudDiscoveryengineV1betaInterval { + searchEngineConfig?: Schema$GoogleCloudDiscoveryengineV1betaEngineSearchEngineConfig; /** - * Exclusive upper bound. + * Required. The solutions of the engine. */ - exclusiveMaximum?: number | null; + solutionType?: string | null; /** - * Exclusive lower bound. + * Output only. Timestamp the Recommendation Engine was last updated. */ - exclusiveMinimum?: number | null; + updateTime?: string | null; + } + /** + * Configurations for a Chat Engine. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaEngineChatEngineConfig { /** - * Inclusive upper bound. + * 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. */ - maximum?: number | null; + agentCreationConfig?: Schema$GoogleCloudDiscoveryengineV1betaEngineChatEngineConfigAgentCreationConfig; /** - * Inclusive lower bound. + * 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. */ - minimum?: number | null; + dialogflowAgentToLink?: string | null; } /** - * Language info for DataStore. + * 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. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaLanguageInfo { + export interface Schema$GoogleCloudDiscoveryengineV1betaEngineChatEngineConfigAgentCreationConfig { /** - * Output only. Language part of normalized_language_code. E.g.: `en-US` -\> `en`, `zh-Hans-HK` -\> `zh`, `en` -\> `en`. + * Name of the company, organization or other entity that the agent represents. Used for knowledge connector LLM prompt and for knowledge search. */ - language?: string | null; + business?: string | null; /** - * The language code for the DataStore. + * 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. */ - languageCode?: string | null; + defaultLanguageCode?: string | null; /** - * 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`. + * 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. */ - normalizedLanguageCode?: string | null; + location?: string | null; /** - * Output only. Region part of normalized_language_code, if present. E.g.: `en-US` -\> `US`, `zh-Hans-HK` -\> `HK`, `en` -\> ``. + * 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. */ - region?: string | null; + timeZone?: string | null; } /** - * Response for ListControls method. + * Additional information of a Chat Engine. Fields in this message are output only. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaListControlsResponse { + export interface Schema$GoogleCloudDiscoveryengineV1betaEngineChatEngineMetadata { /** - * All the Controls for a given data store. + * The resource name of a Dialogflow agent, that this Chat Engine refers to. Format: `projects//locations//agents/`. */ - controls?: Schema$GoogleCloudDiscoveryengineV1betaControl[]; + dialogflowAgent?: string | null; + } + /** + * Common configurations for an Engine. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaEngineCommonConfig { /** - * Pagination token, if not returned indicates the last page. + * The name of the company, business or entity that is associated with the engine. Setting this may help improve LLM related features. */ - nextPageToken?: string | null; + companyName?: string | null; } /** - * Response for ListConversations method. + * Configurations for a Search Engine. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaListConversationsResponse { + export interface Schema$GoogleCloudDiscoveryengineV1betaEngineSearchEngineConfig { /** - * All the Conversations for a given data store. + * The add-on that this search engine enables. */ - conversations?: Schema$GoogleCloudDiscoveryengineV1betaConversation[]; + searchAddOns?: string[] | null; /** - * Pagination token, if not returned indicates the last page. + * 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. */ - nextPageToken?: string | null; + searchTier?: string | null; } /** - * Response message for SearchTuningService.ListCustomModels method. + * An evaluation is a single execution (or run) of an evaluation process. It encapsulates the state of the evaluation and the resulting data. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaListCustomModelsResponse { + export interface Schema$GoogleCloudDiscoveryengineV1betaEvaluation { /** - * List of custom tuning models. + * Output only. Timestamp the Evaluation was created at. */ - models?: Schema$GoogleCloudDiscoveryengineV1betaCustomTuningModel[]; - } - /** - * Response message for DataStoreService.ListDataStores method. - */ - export interface Schema$GoogleCloudDiscoveryengineV1betaListDataStoresResponse { + createTime?: string | null; /** - * All the customer's DataStores. + * Output only. Timestamp the Evaluation was completed at. */ - dataStores?: Schema$GoogleCloudDiscoveryengineV1betaDataStore[]; + endTime?: string | null; /** - * 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. + * Output only. The error that occurred during evaluation. Only populated when the evaluation's state is FAILED. */ - nextPageToken?: string | null; - } - /** - * Response message for DocumentService.ListDocuments method. - */ - export interface Schema$GoogleCloudDiscoveryengineV1betaListDocumentsResponse { + error?: Schema$GoogleRpcStatus; /** - * The Documents. + * Output only. A sample of errors encountered while processing the request. */ - documents?: Schema$GoogleCloudDiscoveryengineV1betaDocument[]; + errorSamples?: Schema$GoogleRpcStatus[]; /** - * 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. + * Required. The specification of the evaluation. */ - nextPageToken?: string | null; - } - /** - * Response message for EngineService.ListEngines method. - */ - export interface Schema$GoogleCloudDiscoveryengineV1betaListEnginesResponse { + evaluationSpec?: Schema$GoogleCloudDiscoveryengineV1betaEvaluationEvaluationSpec; /** - * All the customer's Engines. + * Immutable. 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. */ - engines?: Schema$GoogleCloudDiscoveryengineV1betaEngine[]; + name?: string | null; /** - * Not supported. + * Output only. The metrics produced by the evaluation, averaged across all SampleQuerys in the SampleQuerySet. Only populated when the evaluation's state is SUCCEEDED. */ - nextPageToken?: string | null; + qualityMetrics?: Schema$GoogleCloudDiscoveryengineV1betaQualityMetrics; + /** + * Output only. The state of the evaluation. + */ + state?: string | null; } /** - * Response message for SchemaService.ListSchemas method. + * Describes the specification of the evaluation. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaListSchemasResponse { + export interface Schema$GoogleCloudDiscoveryengineV1betaEvaluationEvaluationSpec { /** - * 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. + * Required. The specification of the query set. */ - nextPageToken?: string | null; + querySetSpec?: Schema$GoogleCloudDiscoveryengineV1betaEvaluationEvaluationSpecQuerySetSpec; /** - * The Schemas. + * 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 */ - schemas?: Schema$GoogleCloudDiscoveryengineV1betaSchema[]; + searchRequest?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequest; } /** - * Response for ListServingConfigs method. + * Describes the specification of the query set. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaListServingConfigsResponse { - /** - * Pagination token, if not returned indicates the last page. - */ - nextPageToken?: string | null; + export interface Schema$GoogleCloudDiscoveryengineV1betaEvaluationEvaluationSpecQuerySetSpec { /** - * All the ServingConfigs for a given dataStore. + * Required. The full resource name of the SampleQuerySet used for the evaluation, in the format of `projects/{project\}/locations/{location\}/sampleQuerySets/{sampleQuerySet\}`. */ - servingConfigs?: Schema$GoogleCloudDiscoveryengineV1betaServingConfig[]; + sampleQuerySet?: string | null; } /** - * Response for ListSessions method. + * Fact Chunk. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaListSessionsResponse { + export interface Schema$GoogleCloudDiscoveryengineV1betaFactChunk { /** - * Pagination token, if not returned indicates the last page. + * Text content of the fact chunk. Can be at most 10K characters long. */ - nextPageToken?: string | null; + chunkText?: string | null; /** - * All the Sessions for a given data store. + * The index of this chunk. Currently, only used for the streaming mode. */ - sessions?: Schema$GoogleCloudDiscoveryengineV1betaSession[]; + index?: number | null; + /** + * 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. + */ + source?: string | null; + /** + * More fine-grained information for the source reference. + */ + sourceMetadata?: {[key: string]: string} | null; } /** - * Response message for SiteSearchEngineService.ListTargetSites method. + * Response message for SiteSearchEngineService.FetchDomainVerificationStatus method. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaListTargetSitesResponse { + export interface Schema$GoogleCloudDiscoveryengineV1betaFetchDomainVerificationStatusResponse { /** * A token that can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. */ nextPageToken?: string | null; /** - * List of TargetSites. + * List of TargetSites containing the site verification status. */ targetSites?: Schema$GoogleCloudDiscoveryengineV1betaTargetSite[]; /** @@ -4373,137 +4654,133 @@ export namespace discoveryengine_v1beta { totalSize?: number | null; } /** - * Media-specific user event information. + * Cloud FhirStore source import data from. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaMediaInfo { + export interface Schema$GoogleCloudDiscoveryengineV1betaFhirStoreSource { /** - * 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. + * 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\}`. */ - mediaProgressDuration?: string | null; + fhirStore?: string | null; /** - * 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. + * 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. */ - mediaProgressPercentage?: number | null; + gcsStagingDir?: string | null; } /** - * Detailed page information. + * Firestore source import data from. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaPageInfo { + export interface Schema$GoogleCloudDiscoveryengineV1betaFirestoreSource { /** - * 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. + * Required. The Firestore collection (or entity) to copy the data from with a length limit of 1,500 characters. */ - pageCategory?: string | null; + collectionId?: string | null; /** - * 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. + * Required. The Firestore database to copy the data from with a length limit of 256 characters. */ - pageviewId?: string | null; + databaseId?: string | null; /** - * 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. + * 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. */ - referrerUri?: string | null; + gcsStagingDir?: string | null; /** - * 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. + * 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. */ - uri?: string | null; + projectId?: string | null; } /** - * Detailed panel information associated with a user event. + * Cloud Storage location for input content. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaPanelInfo { + export interface Schema$GoogleCloudDiscoveryengineV1betaGcsSource { /** - * The display name of the panel. + * 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. */ - displayName?: string | null; + dataSchema?: string | null; /** - * Required. The panel ID. + * 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/x.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`). */ - panelId?: string | null; + inputUris?: string[] | null; + } + /** + * Grounding Fact. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaGroundingFact { /** - * The ordered position of the panel, if shown to the user with other panels. If set, then total_panels must also be set. + * 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. */ - panelPosition?: number | null; + attributes?: {[key: string]: string} | null; /** - * The total number of panels, including this one, shown to the user. Must be set if panel_position is set. + * Text content of the fact. Can be at most 10K characters long. */ - totalPanels?: number | null; + factText?: string | null; } /** - * Request for pausing training of an engine. - */ - export interface Schema$GoogleCloudDiscoveryengineV1betaPauseEngineRequest {} - /** - * Metadata and configurations for a Google Cloud project in the service. + * Metadata related to the progress of the ImportCompletionSuggestions operation. This will be returned by the google.longrunning.Operation.metadata field. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaProject { + export interface Schema$GoogleCloudDiscoveryengineV1betaImportCompletionSuggestionsMetadata { /** - * Output only. The timestamp when this project is created. + * Operation create time. */ createTime?: string | null; /** - * Output only. Full resource name of the project, for example `projects/{project_number\}`. Note that when making requests, project number and project id are both acceptable, but the server will always respond in project number. + * Count of CompletionSuggestions that failed to be imported. */ - name?: string | null; + failureCount?: string | null; /** - * Output only. The timestamp when this project is successfully provisioned. Empty value means this project is still provisioning and is not ready for use. + * Count of CompletionSuggestions successfully imported. */ - provisionCompletionTime?: string | null; + successCount?: string | null; /** - * Output only. A map of terms of services. The key is the `id` of ServiceTerms. + * Operation last update time. If the operation is done, this is also the finish time. */ - serviceTermsMap?: { - [key: string]: Schema$GoogleCloudDiscoveryengineV1betaProjectServiceTerms; - } | null; + updateTime?: string | null; } /** - * Metadata about the terms of service. + * Request message for CompletionService.ImportCompletionSuggestions method. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaProjectServiceTerms { - /** - * The last time when the project agreed to the terms of service. - */ - acceptTime?: string | null; + export interface Schema$GoogleCloudDiscoveryengineV1betaImportCompletionSuggestionsRequest { /** - * The last time when the project declined or revoked the agreement to terms of service. + * BigQuery input source. */ - declineTime?: string | null; + bigquerySource?: Schema$GoogleCloudDiscoveryengineV1betaBigQuerySource; /** - * 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`. + * The desired location of errors incurred during the Import. */ - id?: string | null; + errorConfig?: Schema$GoogleCloudDiscoveryengineV1betaImportErrorConfig; /** - * Whether the project has accepted/rejected the service terms or it is still pending. + * Cloud Storage location for the input content. */ - state?: string | null; + gcsSource?: Schema$GoogleCloudDiscoveryengineV1betaGcsSource; /** - * The version string of the terms of service. For acceptable values, see the comments for id above. + * The Inline source for suggestion entries. */ - version?: string | null; + inlineSource?: Schema$GoogleCloudDiscoveryengineV1betaImportCompletionSuggestionsRequestInlineSource; } /** - * Metadata associated with a project provision operation. + * The inline source for CompletionSuggestions. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaProvisionProjectMetadata {} + export interface Schema$GoogleCloudDiscoveryengineV1betaImportCompletionSuggestionsRequestInlineSource { + /** + * Required. A list of all denylist entries to import. Max of 1000 items. + */ + suggestions?: Schema$GoogleCloudDiscoveryengineV1betaCompletionSuggestion[]; + } /** - * Request for ProjectService.ProvisionProject method. + * 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. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaProvisionProjectRequest { + export interface Schema$GoogleCloudDiscoveryengineV1betaImportCompletionSuggestionsResponse { /** - * 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). + * The desired location of errors incurred during the Import. */ - acceptDataUseTerms?: boolean | null; + errorConfig?: Schema$GoogleCloudDiscoveryengineV1betaImportErrorConfig; /** - * 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. + * A sample of errors encountered while processing the request. */ - dataUseTermsVersion?: string | null; + errorSamples?: Schema$GoogleRpcStatus[]; } /** - * Request message for CompletionService.PurgeCompletionSuggestions method. - */ - export interface Schema$GoogleCloudDiscoveryengineV1betaPurgeCompletionSuggestionsRequest {} - /** - * Metadata related to the progress of the PurgeDocuments operation. This will be returned by the google.longrunning.Operation.metadata field. + * Metadata related to the progress of the ImportDocuments operation. This is returned by the google.longrunning.Operation.metadata field. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaPurgeDocumentsMetadata { + export interface Schema$GoogleCloudDiscoveryengineV1betaImportDocumentsMetadata { /** * Operation create time. */ @@ -4513,2313 +4790,2401 @@ export namespace discoveryengine_v1beta { */ failureCount?: string | null; /** - * Count of entries that were ignored as entries were not found. + * Count of entries that were processed successfully. */ - ignoredCount?: string | null; + successCount?: string | null; /** - * Count of entries that were deleted successfully. + * Total count of entries that were processed. */ - successCount?: string | null; + totalCount?: string | null; /** * Operation last update time. If the operation is done, this is also the finish time. */ updateTime?: string | null; } /** - * Request message for DocumentService.PurgeDocuments method. + * Request message for Import methods. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaPurgeDocumentsRequest { + export interface Schema$GoogleCloudDiscoveryengineV1betaImportDocumentsRequest { /** - * Required. Filter matching documents to purge. Only currently supported value is `*` (all items). + * AlloyDB input source. */ - filter?: string | null; + alloyDbSource?: Schema$GoogleCloudDiscoveryengineV1betaAlloyDbSource; /** - * Actually performs the purge. If `force` is set to false, return the expected purge count without deleting any documents. + * 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. */ - force?: boolean | null; - } - /** - * 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. - */ - export interface Schema$GoogleCloudDiscoveryengineV1betaPurgeDocumentsResponse { + autoGenerateIds?: boolean | null; /** - * The total count of documents purged as a result of the operation. + * BigQuery input source. */ - purgeCount?: string | null; + bigquerySource?: Schema$GoogleCloudDiscoveryengineV1betaBigQuerySource; /** - * 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. + * Cloud Bigtable input source. */ - purgeSample?: string[] | null; - } - /** - * Metadata related to the progress of the PurgeSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field. - */ - export interface Schema$GoogleCloudDiscoveryengineV1betaPurgeSuggestionDenyListEntriesMetadata { + bigtableSource?: Schema$GoogleCloudDiscoveryengineV1betaBigtableSource; /** - * Operation create time. + * Cloud SQL input source. */ - createTime?: string | null; + cloudSqlSource?: Schema$GoogleCloudDiscoveryengineV1betaCloudSqlSource; /** - * Operation last update time. If the operation is done, this is also the finish time. + * The desired location of errors incurred during the Import. */ - updateTime?: string | null; - } - /** - * Request message for CompletionService.PurgeSuggestionDenyListEntries method. - */ - export interface Schema$GoogleCloudDiscoveryengineV1betaPurgeSuggestionDenyListEntriesRequest {} - /** - * Response message for CompletionService.PurgeSuggestionDenyListEntries method. - */ - export interface Schema$GoogleCloudDiscoveryengineV1betaPurgeSuggestionDenyListEntriesResponse { + errorConfig?: Schema$GoogleCloudDiscoveryengineV1betaImportErrorConfig; /** - * A sample of errors encountered while processing the request. + * FhirStore input source. */ - errorSamples?: Schema$GoogleRpcStatus[]; + fhirStoreSource?: Schema$GoogleCloudDiscoveryengineV1betaFhirStoreSource; /** - * Number of suggestion deny list entries purged. + * Firestore input source. */ - purgeCount?: string | null; - } - /** - * Defines a user inputed query. - */ - export interface Schema$GoogleCloudDiscoveryengineV1betaQuery { + firestoreSource?: Schema$GoogleCloudDiscoveryengineV1betaFirestoreSource; /** - * Unique Id for the query. + * Cloud Storage location for the input content. */ - queryId?: string | null; + gcsSource?: Schema$GoogleCloudDiscoveryengineV1betaGcsSource; /** - * Plain text. + * 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. */ - text?: string | null; - } - /** - * Record message for RankService.Rank method. - */ - export interface Schema$GoogleCloudDiscoveryengineV1betaRankingRecord { + idField?: string | null; /** - * 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. + * The Inline source for the input content for documents. */ - content?: string | null; + inlineSource?: Schema$GoogleCloudDiscoveryengineV1betaImportDocumentsRequestInlineSource; /** - * The unique ID to represent the record. + * The mode of reconciliation between existing documents and the documents to be imported. Defaults to ReconciliationMode.INCREMENTAL. */ - id?: string | null; + reconciliationMode?: string | null; /** - * The score of this record based on the given query and selected model. + * Spanner input source. */ - score?: number | null; + spannerSource?: Schema$GoogleCloudDiscoveryengineV1betaSpannerSource; /** - * 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. + * Indicates which fields in the provided imported documents to update. If not set, the default is to update all fields. */ - title?: string | null; + updateMask?: string | null; } /** - * Request message for RankService.Rank method. + * The inline source for the input config for ImportDocuments method. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaRankRequest { - /** - * If true, the response will contain only record ID and score. By default, it is false, the response will contain record details. - */ - ignoreRecordDetailsInResponse?: boolean | null; - /** - * 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. - */ - model?: string | null; - /** - * The query to use. - */ - query?: string | null; + export interface Schema$GoogleCloudDiscoveryengineV1betaImportDocumentsRequestInlineSource { /** - * Required. A list of records to rank. At most 200 records to rank. + * Required. A list of documents to update/create. Each document must have a valid Document.id. Recommended max of 100 items. */ - records?: Schema$GoogleCloudDiscoveryengineV1betaRankingRecord[]; + documents?: Schema$GoogleCloudDiscoveryengineV1betaDocument[]; + } + /** + * 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. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaImportDocumentsResponse { /** - * The number of results to return. If this is unset or no bigger than zero, returns all results. + * Echoes the destination for the complete errors in the request if set. */ - topN?: number | null; + errorConfig?: Schema$GoogleCloudDiscoveryengineV1betaImportErrorConfig; /** - * 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. + * A sample of errors encountered while processing the request. */ - userLabels?: {[key: string]: string} | null; + errorSamples?: Schema$GoogleRpcStatus[]; } /** - * Response message for RankService.Rank method. + * Configuration of destination for Import related errors. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaRankResponse { + export interface Schema$GoogleCloudDiscoveryengineV1betaImportErrorConfig { /** - * A list of records sorted by descending score. + * 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. */ - records?: Schema$GoogleCloudDiscoveryengineV1betaRankingRecord[]; + gcsPrefix?: string | null; } /** - * Request message for Recommend method. + * Metadata related to the progress of the ImportSampleQueries operation. This will be returned by the google.longrunning.Operation.metadata field. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaRecommendRequest { + export interface Schema$GoogleCloudDiscoveryengineV1betaImportSampleQueriesMetadata { /** - * 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. - */ - filter?: string | null; - /** - * 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. + * ImportSampleQueries operation create time. */ - pageSize?: number | null; + createTime?: string | null; /** - * 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. + * Count of SampleQuerys that failed to be imported. */ - params?: {[key: string]: any} | null; + failureCount?: string | null; /** - * 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. + * Count of SampleQuerys successfully imported. */ - userEvent?: Schema$GoogleCloudDiscoveryengineV1betaUserEvent; + successCount?: string | null; /** - * 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. + * Total count of SampleQuerys that were processed. */ - userLabels?: {[key: string]: string} | null; + totalCount?: string | null; /** - * 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. + * ImportSampleQueries operation last update time. If the operation is done, this is also the finish time. */ - validateOnly?: boolean | null; + updateTime?: string | null; } /** - * Response message for Recommend method. + * Request message for SampleQueryService.ImportSampleQueries method. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaRecommendResponse { + export interface Schema$GoogleCloudDiscoveryengineV1betaImportSampleQueriesRequest { /** - * A unique attribution token. This should be included in the UserEvent logs resulting from this recommendation, which enables accurate attribution of recommendation model performance. + * BigQuery input source. */ - attributionToken?: string | null; + bigquerySource?: Schema$GoogleCloudDiscoveryengineV1betaBigQuerySource; /** - * IDs of documents in the request that were missing from the default Branch associated with the requested ServingConfig. + * The desired location of errors incurred during the Import. */ - missingIds?: string[] | null; + errorConfig?: Schema$GoogleCloudDiscoveryengineV1betaImportErrorConfig; /** - * A list of recommended Documents. The order represents the ranking (from the most relevant Document to the least). + * Cloud Storage location for the input content. */ - results?: Schema$GoogleCloudDiscoveryengineV1betaRecommendResponseRecommendationResult[]; + gcsSource?: Schema$GoogleCloudDiscoveryengineV1betaGcsSource; /** - * True if RecommendRequest.validate_only was set. + * The Inline source for sample query entries. */ - validateOnly?: boolean | null; + inlineSource?: Schema$GoogleCloudDiscoveryengineV1betaImportSampleQueriesRequestInlineSource; } /** - * RecommendationResult represents a generic recommendation result with associated metadata. + * The inline source for SampleQuerys. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaRecommendResponseRecommendationResult { + export interface Schema$GoogleCloudDiscoveryengineV1betaImportSampleQueriesRequestInlineSource { /** - * Set if `returnDocument` is set to true in RecommendRequest.params. + * Required. A list of SampleQuerys to import. Max of 1000 items. */ - document?: Schema$GoogleCloudDiscoveryengineV1betaDocument; + sampleQueries?: Schema$GoogleCloudDiscoveryengineV1betaSampleQuery[]; + } + /** + * 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. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaImportSampleQueriesResponse { /** - * Resource ID of the recommended Document. + * The desired location of errors incurred during the Import. */ - id?: string | null; + errorConfig?: Schema$GoogleCloudDiscoveryengineV1betaImportErrorConfig; /** - * Additional Document metadata or annotations. Possible values: * `score`: Recommendation score in double value. Is set if `returnScore` is set to true in RecommendRequest.params. + * A sample of errors encountered while processing the request. */ - metadata?: {[key: string]: any} | null; + errorSamples?: Schema$GoogleRpcStatus[]; } /** - * Request message for SiteSearchEngineService.RecrawlUris method. + * Metadata related to the progress of the ImportSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaRecrawlUrisRequest { + export interface Schema$GoogleCloudDiscoveryengineV1betaImportSuggestionDenyListEntriesMetadata { /** - * 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`. + * Operation create time. */ - uris?: string[] | null; + createTime?: string | null; + /** + * Operation last update time. If the operation is done, this is also the finish time. + */ + updateTime?: string | null; } /** - * Defines a reply message to user. + * Request message for CompletionService.ImportSuggestionDenyListEntries method. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaReply { - /** - * References in the reply. - */ - references?: Schema$GoogleCloudDiscoveryengineV1betaReplyReference[]; + export interface Schema$GoogleCloudDiscoveryengineV1betaImportSuggestionDenyListEntriesRequest { /** - * DEPRECATED: use `summary` instead. Text reply. + * 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. */ - reply?: string | null; + gcsSource?: Schema$GoogleCloudDiscoveryengineV1betaGcsSource; /** - * Summary based on search results. + * The Inline source for the input content for suggestion deny list entries. */ - summary?: Schema$GoogleCloudDiscoveryengineV1betaSearchResponseSummary; + inlineSource?: Schema$GoogleCloudDiscoveryengineV1betaImportSuggestionDenyListEntriesRequestInlineSource; } /** - * Defines reference in reply. + * The inline source for SuggestionDenyListEntry. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaReplyReference { + export interface Schema$GoogleCloudDiscoveryengineV1betaImportSuggestionDenyListEntriesRequestInlineSource { /** - * Anchor text. + * Required. A list of all denylist entries to import. Max of 1000 items. */ - anchorText?: string | null; + entries?: Schema$GoogleCloudDiscoveryengineV1betaSuggestionDenyListEntry[]; + } + /** + * Response message for CompletionService.ImportSuggestionDenyListEntries method. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaImportSuggestionDenyListEntriesResponse { /** - * Anchor text end index. + * A sample of errors encountered while processing the request. */ - end?: number | null; + errorSamples?: Schema$GoogleRpcStatus[]; /** - * Anchor text start index. + * Count of deny list entries that failed to be imported. */ - start?: number | null; + failedEntriesCount?: string | null; /** - * URI link reference. + * Count of deny list entries successfully imported. */ - uri?: string | null; + importedEntriesCount?: string | null; } /** - * Request for resuming training of an engine. - */ - export interface Schema$GoogleCloudDiscoveryengineV1betaResumeEngineRequest {} - /** - * Defines the structure and layout of a type of document data. + * Metadata related to the progress of the Import operation. This is returned by the google.longrunning.Operation.metadata field. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaSchema { + export interface Schema$GoogleCloudDiscoveryengineV1betaImportUserEventsMetadata { /** - * The JSON representation of the schema. + * Operation create time. */ - jsonSchema?: string | null; + createTime?: string | null; /** - * 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. + * Count of entries that encountered errors while processing. */ - name?: string | null; + failureCount?: string | null; /** - * The structured representation of the schema. + * Count of entries that were processed successfully. */ - structSchema?: {[key: string]: any} | null; + successCount?: string | null; + /** + * Operation last update time. If the operation is done, this is also the finish time. + */ + updateTime?: string | null; } /** - * Detailed search information. + * Request message for the ImportUserEvents request. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaSearchInfo { + export interface Schema$GoogleCloudDiscoveryengineV1betaImportUserEventsRequest { /** - * 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. + * BigQuery input source. */ - offset?: number | null; + bigquerySource?: Schema$GoogleCloudDiscoveryengineV1betaBigQuerySource; /** - * 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. + * The desired location of errors incurred during the Import. Cannot be set for inline user event imports. */ - orderBy?: string | null; + errorConfig?: Schema$GoogleCloudDiscoveryengineV1betaImportErrorConfig; /** - * 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. + * Cloud Storage location for the input content. */ - searchQuery?: string | null; + gcsSource?: Schema$GoogleCloudDiscoveryengineV1betaGcsSource; + /** + * The Inline source for the input content for UserEvents. + */ + inlineSource?: Schema$GoogleCloudDiscoveryengineV1betaImportUserEventsRequestInlineSource; } /** - * Request message for SearchService.Search method. + * The inline source for the input config for ImportUserEvents method. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequest { + export interface Schema$GoogleCloudDiscoveryengineV1betaImportUserEventsRequestInlineSource { /** - * 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) + * Required. A list of user events to import. Recommended max of 10k items. */ - boostSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpec; + userEvents?: Schema$GoogleCloudDiscoveryengineV1betaUserEvent[]; + } + /** + * 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. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaImportUserEventsResponse { /** - * The branch resource name, such as `projects/x/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. + * Echoes the destination for the complete errors if this field was set in the request. */ - branch?: string | null; + errorConfig?: Schema$GoogleCloudDiscoveryengineV1betaImportErrorConfig; /** - * 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. + * A sample of errors encountered while processing the request. */ - canonicalFilter?: string | null; + errorSamples?: Schema$GoogleRpcStatus[]; /** - * A specification for configuring the behavior of content search. + * Count of user events imported with complete existing Documents. */ - contentSearchSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpec; + joinedEventsCount?: string | null; /** - * 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. + * Count of user events imported, but with Document information not found in the existing Branch. */ - dataStoreSpecs?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec[]; + unjoinedEventsCount?: string | null; + } + /** + * A floating point interval. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaInterval { /** - * 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. + * Exclusive upper bound. */ - embeddingSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpec; + exclusiveMaximum?: number | null; /** - * 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. + * Exclusive lower bound. */ - facetSpecs?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestFacetSpec[]; + exclusiveMinimum?: number | null; /** - * 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) + * Inclusive upper bound. */ - filter?: string | null; + maximum?: number | null; /** - * Raw image query. + * Inclusive lower bound. */ - imageQuery?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestImageQuery; + minimum?: number | null; + } + /** + * Language info for DataStore. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaLanguageInfo { /** - * 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. Language part of normalized_language_code. E.g.: `en-US` -\> `en`, `zh-Hans-HK` -\> `zh`, `en` -\> `en`. */ - languageCode?: string | null; + language?: string | null; /** - * 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. + * The language code for the DataStore. */ - offset?: number | null; + languageCode?: string | null; /** - * 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 for retail search, see [Ordering](https://cloud.google.com/retail/docs/filter-and-order#order) If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. + * 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`. */ - orderBy?: string | null; + normalizedLanguageCode?: string | null; /** - * 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. + * Output only. Region part of normalized_language_code, if present. E.g.: `en-US` -\> `US`, `zh-Hans-HK` -\> `HK`, `en` -\> ``. */ - pageSize?: number | null; + region?: string | null; + } + /** + * Response for ListControls method. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaListControlsResponse { /** - * 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. + * All the Controls for a given data store. */ - pageToken?: string | null; + controls?: Schema$GoogleCloudDiscoveryengineV1betaControl[]; /** - * 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` + * Pagination token, if not returned indicates the last page. */ - params?: {[key: string]: any} | null; + nextPageToken?: string | null; + } + /** + * Response for ListConversations method. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaListConversationsResponse { /** - * Raw search query. + * All the Conversations for a given data store. */ - query?: string | null; + conversations?: Schema$GoogleCloudDiscoveryengineV1betaConversation[]; /** - * The query expansion specification that specifies the conditions under which query expansion occurs. + * Pagination token, if not returned indicates the last page. */ - queryExpansionSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestQueryExpansionSpec; + nextPageToken?: string | null; + } + /** + * Response message for SearchTuningService.ListCustomModels method. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaListCustomModelsResponse { /** - * 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 joint 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)`. + * List of custom tuning models. */ - rankingExpression?: string | null; + models?: Schema$GoogleCloudDiscoveryengineV1betaCustomTuningModel[]; + } + /** + * Response message for DataStoreService.ListDataStores method. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaListDataStoresResponse { /** - * 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. + * All the customer's DataStores. */ - regionCode?: string | null; + dataStores?: Schema$GoogleCloudDiscoveryengineV1betaDataStore[]; /** - * Whether to turn on safe search. This is only supported for website search. + * 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. */ - safeSearch?: boolean | null; + nextPageToken?: string | null; + } + /** + * Response message for DocumentService.ListDocuments method. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaListDocumentsResponse { /** - * The spell correction specification that specifies the mode under which spell correction takes effect. + * The Documents. */ - spellCorrectionSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestSpellCorrectionSpec; + documents?: Schema$GoogleCloudDiscoveryengineV1betaDocument[]; /** - * Information about the end user. Highly recommended for analytics. UserInfo.user_agent is used to deduce `device_type` for analytics. + * 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. */ - userInfo?: Schema$GoogleCloudDiscoveryengineV1betaUserInfo; + nextPageToken?: string | null; + } + /** + * Response message for EngineService.ListEngines method. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaListEnginesResponse { /** - * 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. + * All the customer's Engines. */ - userLabels?: {[key: string]: string} | null; + engines?: Schema$GoogleCloudDiscoveryengineV1betaEngine[]; /** - * 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. + * Not supported. */ - userPseudoId?: string | null; + nextPageToken?: string | null; } /** - * Boost specification to boost certain documents. + * Response message for EvaluationService.ListEvaluationResults method. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpec { + export interface Schema$GoogleCloudDiscoveryengineV1betaListEvaluationResultsResponse { /** - * 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 EvaluationResults. */ - conditionBoostSpecs?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpec[]; + evaluationResults?: Schema$GoogleCloudDiscoveryengineV1betaListEvaluationResultsResponseEvaluationResult[]; + /** + * A token that can be sent as ListEvaluationResultsRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages. + */ + nextPageToken?: string | null; } /** - * Boost applies to documents which match a condition. + * Represents the results of an evaluation for a single SampleQuery. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpec { - /** - * 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. - */ - boost?: number | null; + export interface Schema$GoogleCloudDiscoveryengineV1betaListEvaluationResultsResponseEvaluationResult { /** - * Complex specification for custom ranking based on customer defined attribute value. + * Output only. The metrics produced by the evaluation, for a given SampleQuery. */ - boostControlSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpecBoostControlSpec; + qualityMetrics?: Schema$GoogleCloudDiscoveryengineV1betaQualityMetrics; /** - * 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"))` + * Output only. The SampleQuery that was evaluated. */ - condition?: string | null; + sampleQuery?: Schema$GoogleCloudDiscoveryengineV1betaSampleQuery; } /** - * Specification for custom ranking based on customer specified attribute value. It provides more controls for customized ranking than the simple (condition, boost) combination above. + * Response message for EvaluationService.ListEvaluations method. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpecBoostControlSpec { + export interface Schema$GoogleCloudDiscoveryengineV1betaListEvaluationsResponse { /** - * 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). + * The Evaluations. */ - attributeType?: string | null; + evaluations?: Schema$GoogleCloudDiscoveryengineV1betaEvaluation[]; /** - * The control points used to define the curve. The monotonic function (defined through the interpolation_type above) passes through the control points listed here. + * A token that can be sent as ListEvaluationsRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages. */ - controlPoints?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpecBoostControlSpecControlPoint[]; + nextPageToken?: string | null; + } + /** + * Response message for SampleQueryService.ListSampleQueries method. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaListSampleQueriesResponse { /** - * The name of the field whose value will be used to determine the boost amount. + * A token that can be sent as ListSampleQueriesRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages. */ - fieldName?: string | null; + nextPageToken?: string | null; /** - * The interpolation type to be applied to connect the control points listed below. + * The SampleQuerys. */ - interpolationType?: string | null; + sampleQueries?: Schema$GoogleCloudDiscoveryengineV1betaSampleQuery[]; } /** - * 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). + * Response message for SampleQuerySetService.ListSampleQuerySets method. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpecBoostControlSpecControlPoint { + export interface Schema$GoogleCloudDiscoveryengineV1betaListSampleQuerySetsResponse { /** - * 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]`. + * A token that can be sent as ListSampleQuerySetsRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages. */ - attributeValue?: string | null; + nextPageToken?: string | null; /** - * The value between -1 to 1 by which to boost the score if the attribute_value evaluates to the value specified above. + * The SampleQuerySets. */ - boostAmount?: number | null; + sampleQuerySets?: Schema$GoogleCloudDiscoveryengineV1betaSampleQuerySet[]; } /** - * A specification for configuring the behavior of content search. + * Response message for SchemaService.ListSchemas method. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpec { - /** - * Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS - */ - chunkSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecChunkSpec; + export interface Schema$GoogleCloudDiscoveryengineV1betaListSchemasResponse { /** - * If there is no extractive_content_spec provided, there will be no extractive answer in the search response. + * 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. */ - extractiveContentSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecExtractiveContentSpec; + nextPageToken?: string | null; /** - * Specifies the search result mode. If unspecified, the search result mode is based on DataStore.DocumentProcessingConfig.chunking_config: * If DataStore.DocumentProcessingConfig.chunking_config is specified, it defaults to `CHUNKS`. * Otherwise, it defaults to `DOCUMENTS`. + * The Schemas. */ - searchResultMode?: string | null; + schemas?: Schema$GoogleCloudDiscoveryengineV1betaSchema[]; + } + /** + * Response for ListServingConfigs method. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaListServingConfigsResponse { /** - * If `snippetSpec` is not specified, snippets are not included in the search response. + * Pagination token, if not returned indicates the last page. */ - snippetSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSnippetSpec; + nextPageToken?: string | null; /** - * If `summarySpec` is not specified, summaries are not included in the search response. + * All the ServingConfigs for a given dataStore. */ - summarySpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpec; + servingConfigs?: Schema$GoogleCloudDiscoveryengineV1betaServingConfig[]; } /** - * Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS + * Response for ListSessions method. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecChunkSpec { + export interface Schema$GoogleCloudDiscoveryengineV1betaListSessionsResponse { /** - * 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. + * Pagination token, if not returned indicates the last page. */ - numNextChunks?: number | null; + nextPageToken?: string | null; /** - * 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. + * All the Sessions for a given data store. */ - numPreviousChunks?: number | null; + sessions?: Schema$GoogleCloudDiscoveryengineV1betaSession[]; } /** - * A specification for configuring the extractive content in a search response. + * Response message for SiteSearchEngineService.ListTargetSites method. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecExtractiveContentSpec { + export interface Schema$GoogleCloudDiscoveryengineV1betaListTargetSitesResponse { /** - * 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. + * A token that can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. */ - maxExtractiveAnswerCount?: number | null; + nextPageToken?: string | null; /** - * 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`. + * List of TargetSites. */ - maxExtractiveSegmentCount?: number | null; + targetSites?: Schema$GoogleCloudDiscoveryengineV1betaTargetSite[]; /** - * Return at most `num_next_segments` segments after each selected segments. + * The total number of items matching the request. This will always be populated in the response. */ - numNextSegments?: number | null; + totalSize?: number | null; + } + /** + * Media-specific user event information. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaMediaInfo { /** - * Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments. + * 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. */ - numPreviousSegments?: number | null; + mediaProgressDuration?: string | null; /** - * 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`. + * 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. */ - returnExtractiveSegmentScore?: boolean | null; + mediaProgressPercentage?: number | null; } /** - * A specification for configuring snippets in a search response. + * Detailed page information. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSnippetSpec { + export interface Schema$GoogleCloudDiscoveryengineV1betaPageInfo { /** - * [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. + * 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. */ - maxSnippetCount?: number | null; + pageCategory?: string | null; /** - * [DEPRECATED] This field is deprecated and will have no affect on the snippet. + * 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. */ - referenceOnly?: boolean | null; + pageviewId?: string | null; /** - * 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. + * 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. */ - returnSnippet?: boolean | null; + referrerUri?: string | null; + /** + * 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. + */ + uri?: string | null; } /** - * A specification for configuring a summary returned in a search response. + * Detailed panel information associated with a user event. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpec { + export interface Schema$GoogleCloudDiscoveryengineV1betaPanelInfo { /** - * 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. + * The display name of the panel. */ - ignoreAdversarialQuery?: boolean | null; + displayName?: string | null; /** - * 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. + * Required. The panel ID. */ - ignoreNonSummarySeekingQuery?: boolean | null; + panelId?: string | null; /** - * 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. + * The ordered position of the panel, if shown to the user with other panels. If set, then total_panels must also be set. */ - includeCitations?: boolean | null; + panelPosition?: number | null; /** - * 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 total number of panels, including this one, shown to the user. Must be set if panel_position is set. */ - languageCode?: string | null; + totalPanels?: number | null; + } + /** + * Request for pausing training of an engine. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaPauseEngineRequest {} + /** + * Metadata and configurations for a Google Cloud project in the service. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaProject { /** - * If specified, the spec will be used to modify the prompt provided to the LLM. + * Output only. The timestamp when this project is created. */ - modelPromptSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelPromptSpec; + createTime?: string | null; /** - * If specified, the spec will be used to modify the model specification provided to the LLM. + * Output only. Full resource name of the project, for example `projects/{project_number\}`. Note that when making requests, project number and project id are both acceptable, but the server will always respond in project number. */ - modelSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelSpec; + name?: string | null; /** - * 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. + * Output only. The timestamp when this project is successfully provisioned. Empty value means this project is still provisioning and is not ready for use. */ - summaryResultCount?: number | null; + provisionCompletionTime?: string | null; /** - * 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. + * Output only. A map of terms of services. The key is the `id` of ServiceTerms. */ - useSemanticChunks?: boolean | null; + serviceTermsMap?: { + [key: string]: Schema$GoogleCloudDiscoveryengineV1betaProjectServiceTerms; + } | null; } /** - * Specification of the prompt to use with the model. + * Metadata about the terms of service. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelPromptSpec { + export interface Schema$GoogleCloudDiscoveryengineV1betaProjectServiceTerms { /** - * Text at the beginning of the prompt that instructs the assistant. Examples are available in the user guide. + * The last time when the project agreed to the terms of service. */ - preamble?: string | null; - } - /** - * Specification of the model. - */ - export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelSpec { + acceptTime?: string | null; /** - * 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 last time when the project declined or revoked the agreement to terms of service. + */ + declineTime?: string | null; + /** + * 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`. + */ + id?: string | null; + /** + * Whether the project has accepted/rejected the service terms or it is still pending. + */ + state?: string | null; + /** + * The version string of the terms of service. For acceptable values, see the comments for id above. */ version?: string | null; } /** - * A struct to define data stores to filter on in a search call and configurations for those data stores. A maximum of 1 DataStoreSpec per data_store is allowed. Otherwise, an `INVALID_ARGUMENT` error is returned. + * Metadata associated with a project provision operation. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec { + export interface Schema$GoogleCloudDiscoveryengineV1betaProvisionProjectMetadata {} + /** + * Request for ProjectService.ProvisionProject method. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaProvisionProjectRequest { /** - * Required. Full resource name of DataStore, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}`. + * 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). */ - dataStore?: string | null; + acceptDataUseTerms?: boolean | null; + /** + * 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. + */ + dataUseTermsVersion?: string | null; } /** - * The specification that uses customized query embedding vector to do semantic document retrieval. + * Request message for CompletionService.PurgeCompletionSuggestions method. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpec { + export interface Schema$GoogleCloudDiscoveryengineV1betaPurgeCompletionSuggestionsRequest {} + /** + * Metadata related to the progress of the PurgeDocuments operation. This will be returned by the google.longrunning.Operation.metadata field. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaPurgeDocumentsMetadata { /** - * The embedding vector used for retrieval. Limit to 1. + * Operation create time. */ - embeddingVectors?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpecEmbeddingVector[]; + createTime?: string | null; + /** + * Count of entries that encountered errors while processing. + */ + failureCount?: string | null; + /** + * Count of entries that were ignored as entries were not found. + */ + ignoredCount?: string | null; + /** + * Count of entries that were deleted successfully. + */ + successCount?: string | null; + /** + * Operation last update time. If the operation is done, this is also the finish time. + */ + updateTime?: string | null; } /** - * Embedding vector. + * Request message for DocumentService.PurgeDocuments method. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpecEmbeddingVector { + export interface Schema$GoogleCloudDiscoveryengineV1betaPurgeDocumentsRequest { /** - * Embedding field path in schema. + * Required. Filter matching documents to purge. Only currently supported value is `*` (all items). */ - fieldPath?: string | null; + filter?: string | null; /** - * Query embedding vector. + * Actually performs the purge. If `force` is set to false, return the expected purge count without deleting any documents. */ - vector?: number[] | null; + force?: boolean | null; } /** - * A facet specification to perform faceted search. + * 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. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestFacetSpec { + export interface Schema$GoogleCloudDiscoveryengineV1betaPurgeDocumentsResponse { /** - * 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. + * The total count of documents purged as a result of the operation. */ - enableDynamicPosition?: boolean | null; + purgeCount?: string | null; /** - * 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. */ - excludedFilterKeys?: string[] | null; + purgeSample?: string[] | null; + } + /** + * Metadata related to the progress of the PurgeSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaPurgeSuggestionDenyListEntriesMetadata { /** - * Required. The facet key specification. + * Operation create time. */ - facetKey?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestFacetSpecFacetKey; + createTime?: string | null; /** - * 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. + * Operation last update time. If the operation is done, this is also the finish time. */ - limit?: number | null; + updateTime?: string | null; } /** - * Specifies how a facet is computed. + * Request message for CompletionService.PurgeSuggestionDenyListEntries method. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestFacetSpecFacetKey { + export interface Schema$GoogleCloudDiscoveryengineV1betaPurgeSuggestionDenyListEntriesRequest {} + /** + * Response message for CompletionService.PurgeSuggestionDenyListEntries method. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaPurgeSuggestionDenyListEntriesResponse { /** - * True to make facet keys case insensitive when getting faceting values with prefixes or contains; false otherwise. + * A sample of errors encountered while processing the request. */ - caseInsensitive?: boolean | null; + errorSamples?: Schema$GoogleRpcStatus[]; /** - * 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. + * Number of suggestion deny list entries purged. */ - contains?: string[] | null; + purgeCount?: string | null; + } + /** + * Describes the metrics produced by the evaluation. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaQualityMetrics { /** - * 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. + * 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 */ - intervals?: Schema$GoogleCloudDiscoveryengineV1betaInterval[]; + docNdcg?: Schema$GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics; /** - * Required. Supported textual and numerical facet keys in Document object, over which the facet values are computed. Facet key is case-sensitive. + * 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 */ - key?: string | null; + docPrecision?: Schema$GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics; /** - * 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. + * 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 */ - orderBy?: string | null; + docRecall?: Schema$GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics; /** - * 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. + * 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 */ - prefixes?: string[] | null; + pageNdcg?: Schema$GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics; /** - * 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. + * 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 */ - restrictedValues?: string[] | null; + pageRecall?: Schema$GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics; } /** - * Specifies the image query input. + * Stores the metric values at specific top-k levels. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestImageQuery { + export interface Schema$GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics { /** - * Base64 encoded image bytes. Supported image formats: JPEG, PNG, and BMP. + * The top-1 value. */ - imageBytes?: string | null; - } - /** - * Specification to determine under which conditions query expansion should occur. - */ - export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestQueryExpansionSpec { + top1?: number | null; /** - * The condition under which query expansion should occur. Default to Condition.DISABLED. + * The top-10 value. */ - condition?: string | null; + top10?: number | null; /** - * 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. + * The top-3 value. */ - pinUnexpandedResults?: boolean | null; - } - /** - * The specification for query spell correction. - */ - export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestSpellCorrectionSpec { + top3?: number | null; /** - * The mode under which spell correction replaces the original search query. Defaults to Mode.AUTO. + * The top-5 value. */ - mode?: string | null; + top5?: number | null; } /** - * Response message for SearchService.Search method. + * Defines a user inputed query. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaSearchResponse { + export interface Schema$GoogleCloudDiscoveryengineV1betaQuery { /** - * Controls applied as part of the Control service. + * Unique Id for the query. */ - appliedControls?: string[] | null; + queryId?: string | null; /** - * A unique search token. This should be included in the UserEvent logs resulting from this search, which enables accurate attribution of search model performance. + * Plain text. */ - attributionToken?: string | null; + text?: string | null; + } + /** + * Record message for RankService.Rank method. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaRankingRecord { /** - * 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. + * 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. */ - correctedQuery?: string | null; + content?: string | null; /** - * Results of facets requested by user. + * The unique ID to represent the record. */ - facets?: Schema$GoogleCloudDiscoveryengineV1betaSearchResponseFacet[]; - geoSearchDebugInfo?: Schema$GoogleCloudDiscoveryengineV1betaSearchResponseGeoSearchDebugInfo[]; + id?: string | null; /** - * Guided search result. + * The score of this record based on the given query and selected model. */ - guidedSearchResult?: Schema$GoogleCloudDiscoveryengineV1betaSearchResponseGuidedSearchResult; + score?: number | null; /** - * 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. + * 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. */ - nextPageToken?: string | null; + title?: string | null; + } + /** + * Request message for RankService.Rank method. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaRankRequest { /** - * Query expansion information for the returned results. + * If true, the response will contain only record ID and score. By default, it is false, the response will contain record details. */ - queryExpansionInfo?: Schema$GoogleCloudDiscoveryengineV1betaSearchResponseQueryExpansionInfo; + ignoreRecordDetailsInResponse?: boolean | null; /** - * 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. + * 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. */ - redirectUri?: string | null; + model?: string | null; /** - * A list of matched documents. The order represents the ranking. + * The query to use. */ - results?: Schema$GoogleCloudDiscoveryengineV1betaSearchResponseSearchResult[]; + query?: string | null; /** - * A summary as part of the search results. This field is only returned if SearchRequest.ContentSearchSpec.summary_spec is set. + * Required. A list of records to rank. At most 200 records to rank. */ - summary?: Schema$GoogleCloudDiscoveryengineV1betaSearchResponseSummary; + records?: Schema$GoogleCloudDiscoveryengineV1betaRankingRecord[]; /** - * 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. + * The number of results to return. If this is unset or no bigger than zero, returns all results. */ - totalSize?: number | null; + topN?: number | null; + /** + * 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. + */ + userLabels?: {[key: string]: string} | null; } /** - * A facet result. + * Response message for RankService.Rank method. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaSearchResponseFacet { - /** - * Whether the facet is dynamically generated. - */ - dynamicFacet?: boolean | null; - /** - * The key for this facet. For example, `"colors"` or `"price"`. It matches SearchRequest.FacetSpec.FacetKey.key. - */ - key?: string | null; + export interface Schema$GoogleCloudDiscoveryengineV1betaRankResponse { /** - * The facet values for this field. + * A list of records sorted by descending score. */ - values?: Schema$GoogleCloudDiscoveryengineV1betaSearchResponseFacetFacetValue[]; + records?: Schema$GoogleCloudDiscoveryengineV1betaRankingRecord[]; } /** - * A facet value which contains value names and their count. + * Request message for Recommend method. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaSearchResponseFacetFacetValue { + export interface Schema$GoogleCloudDiscoveryengineV1betaRecommendRequest { /** - * Number of items that have this facet value. + * 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. */ - count?: string | null; + filter?: string | null; /** - * Interval value for a facet, such as 10, 20) for facet "price". It matches [SearchRequest.FacetSpec.FacetKey.intervals. + * 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. */ - interval?: Schema$GoogleCloudDiscoveryengineV1betaInterval; + pageSize?: number | null; /** - * Text value of a facet, such as "Black" for facet "colors". + * 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. */ - value?: string | null; - } - /** - * Debug information specifically related to forward geocoding issues arising from Geolocation Search. - */ - export interface Schema$GoogleCloudDiscoveryengineV1betaSearchResponseGeoSearchDebugInfo { + params?: {[key: string]: any} | null; /** - * The error produced. + * 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. */ - errorMessage?: string | null; + userEvent?: Schema$GoogleCloudDiscoveryengineV1betaUserEvent; /** - * The address from which forward geocoding ingestion produced issues. + * 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. */ - originalAddressQuery?: string | null; + userLabels?: {[key: string]: string} | null; + /** + * 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. + */ + validateOnly?: boolean | null; } /** - * Guided search result. The guided search helps user to refine the search results and narrow down to the real needs from a broaded search results. + * Response message for Recommend method. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaSearchResponseGuidedSearchResult { + export interface Schema$GoogleCloudDiscoveryengineV1betaRecommendResponse { /** - * Suggested follow-up questions. + * A unique attribution token. This should be included in the UserEvent logs resulting from this recommendation, which enables accurate attribution of recommendation model performance. */ - followUpQuestions?: string[] | null; + attributionToken?: string | null; /** - * A list of ranked refinement attributes. + * IDs of documents in the request that were missing from the default Branch associated with the requested ServingConfig. */ - refinementAttributes?: Schema$GoogleCloudDiscoveryengineV1betaSearchResponseGuidedSearchResultRefinementAttribute[]; - } - /** - * Useful attribute for search result refinements. - */ - export interface Schema$GoogleCloudDiscoveryengineV1betaSearchResponseGuidedSearchResultRefinementAttribute { + missingIds?: string[] | null; /** - * Attribute key used to refine the results. For example, `"movie_type"`. + * A list of recommended Documents. The order represents the ranking (from the most relevant Document to the least). */ - attributeKey?: string | null; + results?: Schema$GoogleCloudDiscoveryengineV1betaRecommendResponseRecommendationResult[]; /** - * Attribute value used to refine the results. For example, `"drama"`. + * True if RecommendRequest.validate_only was set. */ - attributeValue?: string | null; + validateOnly?: boolean | null; } /** - * Information describing query expansion including whether expansion has occurred. + * RecommendationResult represents a generic recommendation result with associated metadata. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaSearchResponseQueryExpansionInfo { + export interface Schema$GoogleCloudDiscoveryengineV1betaRecommendResponseRecommendationResult { /** - * Bool describing whether query expansion has occurred. + * Set if `returnDocument` is set to true in RecommendRequest.params. */ - expandedQuery?: boolean | null; + document?: Schema$GoogleCloudDiscoveryengineV1betaDocument; /** - * Number of pinned results. This field will only be set when expansion happens and SearchRequest.QueryExpansionSpec.pin_unexpanded_results is set to true. + * Resource ID of the recommended Document. */ - pinnedResultCount?: string | null; + id?: string | null; + /** + * Additional Document metadata or annotations. Possible values: * `score`: Recommendation score in double value. Is set if `returnScore` is set to true in RecommendRequest.params. + */ + metadata?: {[key: string]: any} | null; } /** - * Represents the search results. + * Request message for SiteSearchEngineService.RecrawlUris method. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaSearchResponseSearchResult { + export interface Schema$GoogleCloudDiscoveryengineV1betaRecrawlUrisRequest { /** - * The chunk data in the search response if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS. + * 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`. */ - chunk?: Schema$GoogleCloudDiscoveryengineV1betaChunk; + uris?: string[] | null; + } + /** + * Defines a reply message to user. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaReply { /** - * The document data snippet in the search response. Only fields that are marked as `retrievable` are populated. + * References in the reply. */ - document?: Schema$GoogleCloudDiscoveryengineV1betaDocument; + references?: Schema$GoogleCloudDiscoveryengineV1betaReplyReference[]; /** - * Document.id of the searched Document. + * DEPRECATED: use `summary` instead. Text reply. */ - id?: string | null; + reply?: string | null; /** - * Google provided available scores. + * Summary based on search results. */ - modelScores?: { - [key: string]: Schema$GoogleCloudDiscoveryengineV1betaDoubleList; - } | null; + summary?: Schema$GoogleCloudDiscoveryengineV1betaSearchResponseSummary; } /** - * Summary of the top N search results specified by the summary spec. + * Defines reference in reply. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaSearchResponseSummary { + export interface Schema$GoogleCloudDiscoveryengineV1betaReplyReference { /** - * A collection of Safety Attribute categories and their associated confidence scores. + * Anchor text. */ - safetyAttributes?: Schema$GoogleCloudDiscoveryengineV1betaSearchResponseSummarySafetyAttributes; + anchorText?: string | null; /** - * Additional summary-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set. + * Anchor text end index. */ - summarySkippedReasons?: string[] | null; + end?: number | null; /** - * The summary content. + * Anchor text start index. */ - summaryText?: string | null; + start?: number | null; /** - * Summary with metadata information. + * URI link reference. */ - summaryWithMetadata?: Schema$GoogleCloudDiscoveryengineV1betaSearchResponseSummarySummaryWithMetadata; + uri?: string | null; } /** - * Citation info for a segment. + * Request for resuming training of an engine. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaSearchResponseSummaryCitation { + export interface Schema$GoogleCloudDiscoveryengineV1betaResumeEngineRequest {} + /** + * Sample Query captures metadata to be used for evaluation. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaSampleQuery { /** - * End of the attributed segment, exclusive. + * Output only. Timestamp the SampleQuery was created at. */ - endIndex?: string | null; + createTime?: string | null; /** - * Citation sources for the attributed segment. + * Immutable. The full resource name of the sample query, in the format of `projects/{project\}/locations/{location\}/sampleQuerySets/{sampleQuerySet\}/sampleQueries/{sampleQuery\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. */ - sources?: Schema$GoogleCloudDiscoveryengineV1betaSearchResponseSummaryCitationSource[]; + name?: string | null; /** - * Index indicates the start of the segment, measured in bytes/unicode. + * The query entry. */ - startIndex?: string | null; + queryEntry?: Schema$GoogleCloudDiscoveryengineV1betaSampleQueryQueryEntry; } /** - * Citation metadata. + * Query Entry captures metadata to be used for search evaluation. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaSearchResponseSummaryCitationMetadata { + export interface Schema$GoogleCloudDiscoveryengineV1betaSampleQueryQueryEntry { /** - * Citations for segments. + * Required. The query. */ - citations?: Schema$GoogleCloudDiscoveryengineV1betaSearchResponseSummaryCitation[]; - } - /** - * Citation source. - */ - export interface Schema$GoogleCloudDiscoveryengineV1betaSearchResponseSummaryCitationSource { + query?: string | null; /** - * Document reference index from SummaryWithMetadata.references. It is 0-indexed and the value will be zero if the reference_index is not set explicitly. + * List of targets for the query. */ - referenceIndex?: string | null; + targets?: Schema$GoogleCloudDiscoveryengineV1betaSampleQueryQueryEntryTarget[]; } /** - * Document reference. + * Defines the parameters of the query's expected outcome. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaSearchResponseSummaryReference { - /** - * List of cited chunk contents derived from document content. - */ - chunkContents?: Schema$GoogleCloudDiscoveryengineV1betaSearchResponseSummaryReferenceChunkContent[]; + export interface Schema$GoogleCloudDiscoveryengineV1betaSampleQueryQueryEntryTarget { /** - * Required. Document.name of the document. Full resource name of the referenced document, in the format `projects/x/locations/x/collections/x/dataStores/x/branches/x/documents/x`. + * Expected page numbers of the target. Each page number must be non negative. */ - document?: string | null; + pageNumbers?: number[] | null; /** - * Title of the document. + * Relevance score of the target. */ - title?: string | null; + score?: number | null; /** - * Cloud Storage or HTTP uri for the document. + * Expected uri of the target. This field must be a UTF-8 encoded string with a length limit of 2048 characters. Example of valid uris: `https://example.com/abc`, `gcs://example/example.pdf`. */ uri?: string | null; } /** - * Chunk content. + * A SampleQuerySet is the parent resource of SampleQuery, and contains the configurations shared by all SampleQuery under it. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaSearchResponseSummaryReferenceChunkContent { + export interface Schema$GoogleCloudDiscoveryengineV1betaSampleQuerySet { /** - * Chunk textual content. + * Output only. Timestamp the SampleQuerySet was created at. */ - content?: string | null; + createTime?: string | null; /** - * Page identifier. + * The description of the SampleQuerySet. */ - pageIdentifier?: string | null; - } - /** - * Safety Attribute categories and their associated confidence scores. - */ - export interface Schema$GoogleCloudDiscoveryengineV1betaSearchResponseSummarySafetyAttributes { + description?: string | null; /** - * The display names of Safety Attribute categories associated with the generated content. Order matches the Scores. + * Required. The sample query set display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. */ - categories?: string[] | null; + displayName?: string | null; /** - * The confidence scores of the each category, higher value means higher confidence. Order matches the Categories. + * Immutable. The full resource name of the SampleQuerySet, in the format of `projects/{project\}/locations/{location\}/sampleQuerySets/{sampleQuerySet\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. */ - scores?: number[] | null; + name?: string | null; } /** - * Summary with metadata information. + * Defines the structure and layout of a type of document data. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaSearchResponseSummarySummaryWithMetadata { + export interface Schema$GoogleCloudDiscoveryengineV1betaSchema { /** - * Citation metadata for given summary. + * The JSON representation of the schema. */ - citationMetadata?: Schema$GoogleCloudDiscoveryengineV1betaSearchResponseSummaryCitationMetadata; + jsonSchema?: string | null; /** - * Document References. + * 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. */ - references?: Schema$GoogleCloudDiscoveryengineV1betaSearchResponseSummaryReference[]; + name?: string | null; /** - * Summary text with no citation information. + * The structured representation of the schema. */ - summary?: string | null; + structSchema?: {[key: string]: any} | null; } /** - * 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. + * Detailed search information. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaServingConfig { + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchInfo { /** - * 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. + * 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. */ - boostControlIds?: string[] | null; + offset?: number | null; /** - * Output only. ServingConfig created timestamp. + * 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. */ - createTime?: string | null; + orderBy?: string | null; /** - * 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. + * 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. */ - displayName?: string | null; + searchQuery?: string | null; + } + /** + * Request message for SearchService.Search method. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequest { /** - * 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. + * 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) */ - dissociateControlIds?: string[] | null; + boostSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpec; /** - * 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. + * The branch resource name, such as `projects/x/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. */ - diversityLevel?: string | null; + branch?: string | null; /** - * Bring your own embedding config. The config is used for search semantic retrieval. The retrieval is based on the dot product of SearchRequest.EmbeddingSpec.EmbeddingVector.vector and the document embeddings that are provided by this EmbeddingConfig. If SearchRequest.EmbeddingSpec.EmbeddingVector.vector is provided, it overrides this ServingConfig.embedding_config. + * 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. */ - embeddingConfig?: Schema$GoogleCloudDiscoveryengineV1betaEmbeddingConfig; + canonicalFilter?: string | null; /** - * 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. + * A specification for configuring the behavior of content search. */ - filterControlIds?: string[] | null; + contentSearchSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpec; /** - * The GenericConfig of the serving configuration. + * 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. */ - genericConfig?: Schema$GoogleCloudDiscoveryengineV1betaServingConfigGenericConfig; + dataStoreSpecs?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec[]; /** - * 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. + * 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. */ - ignoreControlIds?: string[] | null; + embeddingSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpec; /** - * The MediaConfig of the serving configuration. + * 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. */ - mediaConfig?: Schema$GoogleCloudDiscoveryengineV1betaServingConfigMediaConfig; + facetSpecs?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestFacetSpec[]; /** - * 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. + * 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) */ - modelId?: string | null; + filter?: string | null; /** - * Immutable. Fully qualified name `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}/servingConfigs/{serving_config_id\}` + * Raw image query. */ - name?: string | null; + imageQuery?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestImageQuery; /** - * 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. + * 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. */ - onewaySynonymsControlIds?: string[] | null; + languageCode?: string | null; /** - * 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). + * If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done. */ - rankingExpression?: string | null; + naturalLanguageQueryUnderstandingSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestNaturalLanguageQueryUnderstandingSpec; /** - * 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. + * 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. */ - redirectControlIds?: string[] | null; + offset?: number | null; /** - * 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. + * 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 for retail search, see [Ordering](https://cloud.google.com/retail/docs/filter-and-order#order) If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. */ - replacementControlIds?: string[] | null; + orderBy?: string | null; /** - * Required. Immutable. Specifies the solution type that a serving config can be associated with. + * 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. */ - solutionType?: string | null; + pageSize?: number | null; /** - * 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. + * 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. */ - synonymsControlIds?: string[] | null; + pageToken?: string | null; /** - * Output only. ServingConfig updated timestamp. + * 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` */ - updateTime?: string | null; - } - /** - * Specifies the configurations needed for Generic Discovery.Currently we support: * `content_search_spec`: configuration for generic content search. - */ - export interface Schema$GoogleCloudDiscoveryengineV1betaServingConfigGenericConfig { + params?: {[key: string]: any} | null; /** - * Specifies the expected behavior of content search. Only valid for content-search enabled data store. + * Raw search query. */ - contentSearchSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpec; - } - /** - * 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. - */ - export interface Schema$GoogleCloudDiscoveryengineV1betaServingConfigMediaConfig { + query?: string | null; /** - * Specifies the content freshness used for recommendation result. Contents will be demoted if contents were published for more than content freshness cutoff days. + * The query expansion specification that specifies the conditions under which query expansion occurs. */ - contentFreshnessCutoffDays?: number | null; + queryExpansionSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestQueryExpansionSpec; /** - * Specifies the content watched percentage threshold for demotion. Threshold value must be between [0, 1.0] inclusive. + * 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)`. */ - contentWatchedPercentageThreshold?: number | null; + rankingExpression?: string | null; /** - * Specifies the content watched minutes threshold for demotion. + * 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. */ - contentWatchedSecondsThreshold?: number | null; + regionCode?: string | null; /** - * 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. + * Whether to turn on safe search. This is only supported for website search. */ - demotionEventType?: string | null; - } - /** - * External session proto definition. - */ - export interface Schema$GoogleCloudDiscoveryengineV1betaSession { + safeSearch?: boolean | null; /** - * Output only. The time the session finished. + * Search as you type configuration. Only supported for the IndustryVertical.MEDIA vertical. */ - endTime?: string | null; + searchAsYouTypeSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestSearchAsYouTypeSpec; /** - * Immutable. Fully qualified name `projects/{project\}/locations/global/collections/{collection\}/engines/{engine\}/sessions/x` + * Required. The resource name of the Search serving config, such as `projects/x/locations/global/collections/default_collection/engines/x/servingConfigs/default_serving_config`, or `projects/x/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. */ - name?: string | null; + servingConfig?: string | null; /** - * Output only. The time the session started. + * 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. */ - startTime?: string | null; + session?: string | null; /** - * The state of the session. + * Session specification. Can be used only when `session` is set. */ - state?: string | null; + sessionSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestSessionSpec; /** - * Turns. + * The spell correction specification that specifies the mode under which spell correction takes effect. */ - turns?: Schema$GoogleCloudDiscoveryengineV1betaSessionTurn[]; + spellCorrectionSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestSpellCorrectionSpec; /** - * A unique identifier for tracking users. + * Information about the end user. Highly recommended for analytics. UserInfo.user_agent is used to deduce `device_type` for analytics. */ - userPseudoId?: string | null; - } - /** - * Represents a turn, including a query from the user and a answer from service. - */ - export interface Schema$GoogleCloudDiscoveryengineV1betaSessionTurn { + userInfo?: Schema$GoogleCloudDiscoveryengineV1betaUserInfo; /** - * The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn. + * 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. */ - answer?: string | null; + userLabels?: {[key: string]: string} | null; /** - * The user query. + * 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. */ - query?: Schema$GoogleCloudDiscoveryengineV1betaQuery; + userPseudoId?: string | null; } /** - * SiteSearchEngine captures DataStore level site search persisting configurations. It is a singleton value per data store. + * Boost specification to boost certain documents. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaSiteSearchEngine { + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpec { /** - * The fully qualified resource name of the site search engine. Format: `projects/x/locations/x/dataStores/x/siteSearchEngine` + * 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. */ - name?: string | null; + conditionBoostSpecs?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpec[]; } /** - * Verification information for target sites in advanced site search. + * Boost applies to documents which match a condition. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaSiteVerificationInfo { + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpec { /** - * Site verification state indicating the ownership and validity. + * 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. */ - siteVerificationState?: string | null; + boost?: number | null; /** - * Latest site verification time. + * Complex specification for custom ranking based on customer defined attribute value. */ - verifyTime?: string | null; + boostControlSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpecBoostControlSpec; + /** + * 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"))` + */ + condition?: string | null; } /** - * The Spanner source for importing data + * Specification for custom ranking based on customer specified attribute value. It provides more controls for customized ranking than the simple (condition, boost) combination above. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaSpannerSource { - /** - * Required. The database ID of the source Spanner table. - */ - databaseId?: string | null; + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpecBoostControlSpec { /** - * 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). + * 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). */ - enableDataBoost?: boolean | null; + attributeType?: string | null; /** - * Required. The instance ID of the source Spanner table. + * The control points used to define the curve. The monotonic function (defined through the interpolation_type above) passes through the control points listed here. */ - instanceId?: string | null; + controlPoints?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpecBoostControlSpecControlPoint[]; /** - * The project ID that the Spanner source is in with 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. */ - projectId?: string | null; + fieldName?: string | null; /** - * Required. The table name of the Spanner database that needs to be imported. + * The interpolation type to be applied to connect the control points listed below. */ - tableId?: string | null; + interpolationType?: string | null; } /** - * Suggestion deny list entry identifying the phrase to block from suggestions and the applied operation for the phrase. + * 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). */ - export interface Schema$GoogleCloudDiscoveryengineV1betaSuggestionDenyListEntry { + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpecBoostControlSpecControlPoint { /** - * Required. Phrase to block from suggestions served. Can be maximum 125 characters. + * 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]`. */ - blockPhrase?: string | null; + attributeValue?: string | null; /** - * Required. The match operator to apply for this phrase. Whether to block the exact phrase, or block any suggestions containing this phrase. + * The value between -1 to 1 by which to boost the score if the attribute_value evaluates to the value specified above. */ - matchOperator?: string | null; + boostAmount?: number | null; } /** - * A target site for the SiteSearchEngine. + * A specification for configuring the behavior of content search. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaTargetSite { + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpec { /** - * 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. + * Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS */ - exactMatch?: boolean | null; + chunkSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecChunkSpec; /** - * Output only. Failure reason. + * If there is no extractive_content_spec provided, there will be no extractive answer in the search response. */ - failureReason?: Schema$GoogleCloudDiscoveryengineV1betaTargetSiteFailureReason; + extractiveContentSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecExtractiveContentSpec; /** - * Output only. This is system-generated based on the provided_uri_pattern. + * Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`. */ - generatedUriPattern?: string | null; + searchResultMode?: string | null; /** - * Output only. Indexing status. + * If `snippetSpec` is not specified, snippets are not included in the search response. */ - indexingStatus?: string | null; + snippetSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSnippetSpec; /** - * 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. + * If `summarySpec` is not specified, summaries are not included in the search response. */ - name?: string | null; + summarySpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpec; + } + /** + * Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecChunkSpec { /** - * Required. Input only. The user provided URI pattern from which the `generated_uri_pattern` is generated. + * 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. */ - providedUriPattern?: string | null; + numNextChunks?: number | null; /** - * Output only. Root domain of the provided_uri_pattern. + * 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. */ - rootDomainUri?: string | null; + numPreviousChunks?: number | null; + } + /** + * A specification for configuring the extractive content in a search response. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecExtractiveContentSpec { /** - * Output only. Site ownership and validity verification status. + * 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. */ - siteVerificationInfo?: Schema$GoogleCloudDiscoveryengineV1betaSiteVerificationInfo; + maxExtractiveAnswerCount?: number | null; /** - * The type of the target site, e.g., whether the site is to be included or excluded. + * 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?: string | null; + maxExtractiveSegmentCount?: number | null; /** - * Output only. The target site's last updated time. + * Return at most `num_next_segments` segments after each selected segments. */ - updateTime?: string | null; - } - /** - * Site search indexing failure reasons. - */ - export interface Schema$GoogleCloudDiscoveryengineV1betaTargetSiteFailureReason { + numNextSegments?: number | null; /** - * Failed due to insufficient quota. + * Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments. */ - quotaFailure?: Schema$GoogleCloudDiscoveryengineV1betaTargetSiteFailureReasonQuotaFailure; - } - /** - * Failed due to insufficient quota. - */ - export interface Schema$GoogleCloudDiscoveryengineV1betaTargetSiteFailureReasonQuotaFailure { + numPreviousSegments?: number | null; /** - * This number is an estimation on how much total quota this project needs to successfully complete indexing. + * 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`. */ - totalRequiredQuota?: string | null; + returnExtractiveSegmentScore?: boolean | null; } /** - * Defines text input. + * A specification for configuring snippets in a search response. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaTextInput { + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSnippetSpec { /** - * Conversation context of the input. + * [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. */ - context?: Schema$GoogleCloudDiscoveryengineV1betaConversationContext; + maxSnippetCount?: number | null; /** - * Text input. + * [DEPRECATED] This field is deprecated and will have no affect on the snippet. */ - input?: string | null; + referenceOnly?: boolean | null; + /** + * 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. + */ + returnSnippet?: boolean | null; } /** - * Metadata related to the progress of the TrainCustomModel operation. This is returned by the google.longrunning.Operation.metadata field. + * A specification for configuring a summary returned in a search response. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaTrainCustomModelMetadata { + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpec { /** - * Operation create time. + * 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. */ - createTime?: string | null; + ignoreAdversarialQuery?: boolean | null; /** - * Operation last update time. If the operation is done, this is also the finish time. + * 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. */ - updateTime?: string | null; - } - /** - * Request message for SearchTuningService.TrainCustomModel method. - */ - export interface Schema$GoogleCloudDiscoveryengineV1betaTrainCustomModelRequest { + ignoreNonSummarySeekingQuery?: boolean | null; /** - * The desired location of errors incurred during the data ingestion and training. + * 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. */ - errorConfig?: Schema$GoogleCloudDiscoveryengineV1betaImportErrorConfig; + includeCitations?: boolean | null; /** - * Cloud Storage training input. + * 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. */ - gcsTrainingInput?: Schema$GoogleCloudDiscoveryengineV1betaTrainCustomModelRequestGcsTrainingInput; + languageCode?: string | null; /** - * If not provided, a UUID will be generated. + * If specified, the spec will be used to modify the prompt provided to the LLM. */ - modelId?: string | null; + modelPromptSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelPromptSpec; /** - * Model to be trained. Supported values are: * **search-tuning**: Fine tuning the search system based on data provided. + * If specified, the spec will be used to modify the model specification provided to the LLM. */ - modelType?: string | null; + modelSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelSpec; + /** + * 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. + */ + summaryResultCount?: number | null; + /** + * 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. + */ + useSemanticChunks?: boolean | null; } /** - * Cloud Storage training data input. + * Specification of the prompt to use with the model. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaTrainCustomModelRequestGcsTrainingInput { + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelPromptSpec { /** - * 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"\}` + * Text at the beginning of the prompt that instructs the assistant. Examples are available in the user guide. */ - corpusDataPath?: string | null; + preamble?: string | null; + } + /** + * Specification of the model. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelSpec { /** - * 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"\} + * 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). */ - queryDataPath?: string | null; + version?: string | null; + } + /** + * 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. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec { /** - * 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. + * Required. Full resource name of DataStore, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}`. */ - testDataPath?: string | null; + dataStore?: string | null; + } + /** + * The specification that uses customized query embedding vector to do semantic document retrieval. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpec { /** - * 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 embedding vector used for retrieval. Limit to 1. */ - trainDataPath?: string | null; + embeddingVectors?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpecEmbeddingVector[]; } /** - * Response of the TrainCustomModelRequest. This message is returned by the google.longrunning.Operations.response field. + * Embedding vector. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaTrainCustomModelResponse { + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpecEmbeddingVector { /** - * Echoes the destination for the complete errors in the request if set. + * Embedding field path in schema. */ - errorConfig?: Schema$GoogleCloudDiscoveryengineV1betaImportErrorConfig; + fieldPath?: string | null; /** - * A sample of errors encountered while processing the data. + * Query embedding vector. */ - errorSamples?: Schema$GoogleRpcStatus[]; + vector?: number[] | null; + } + /** + * A facet specification to perform faceted search. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestFacetSpec { /** - * The metrics of the trained model. + * 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. */ - metrics?: {[key: string]: number} | null; + enableDynamicPosition?: boolean | null; /** - * Fully qualified name of the CustomTuningModel. + * 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. */ - modelName?: string | null; + excludedFilterKeys?: string[] | null; /** - * 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. + * Required. The facet key specification. */ - modelStatus?: string | null; + facetKey?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestFacetSpecFacetKey; + /** + * 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. + */ + limit?: number | null; } /** - * A transaction represents the entire purchase transaction. + * Specifies how a facet is computed. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaTransactionInfo { + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestFacetSpecFacetKey { /** - * 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 + * True to make facet keys case insensitive when getting faceting values with prefixes or contains; false otherwise. */ - cost?: number | null; + caseInsensitive?: boolean | null; /** - * Required. Currency code. Use three-character ISO-4217 code. + * 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. */ - currency?: string | null; + contains?: string[] | null; /** - * 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 + * 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. */ - discountValue?: number | null; + intervals?: Schema$GoogleCloudDiscoveryengineV1betaInterval[]; /** - * All the taxes associated with the transaction. + * Required. Supported textual and numerical facet keys in Document object, over which the facet values are computed. Facet key is case-sensitive. */ - tax?: number | null; + key?: string | null; /** - * The transaction ID with a length limit of 128 characters. + * 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. */ - transactionId?: string | null; + orderBy?: string | null; /** - * 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. + * 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. */ - value?: number | null; + prefixes?: string[] | null; + /** + * 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. + */ + restrictedValues?: string[] | null; } /** - * Metadata associated with a tune operation. + * Specifies the image query input. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaTuneEngineMetadata { + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestImageQuery { /** - * Required. The resource name of the engine that this tune applies to. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/engines/{engine_id\}` + * Base64 encoded image bytes. Supported image formats: JPEG, PNG, and BMP. */ - engine?: string | null; + imageBytes?: string | null; } /** - * Request to manually start a tuning process now (instead of waiting for the periodically scheduled tuning to happen). - */ - export interface Schema$GoogleCloudDiscoveryengineV1betaTuneEngineRequest {} - /** - * Response associated with a tune operation. - */ - export interface Schema$GoogleCloudDiscoveryengineV1betaTuneEngineResponse {} - /** - * Metadata for UpdateSchema LRO. + * Specification to enable natural language understanding capabilities for search requests. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaUpdateSchemaMetadata { + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestNaturalLanguageQueryUnderstandingSpec { /** - * Operation create time. + * The condition under which filter extraction should occur. Default to Condition.DISABLED. */ - createTime?: string | null; + filterExtractionCondition?: string | null; /** - * Operation last update time. If the operation is done, this is also the finish time. + * 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. */ - updateTime?: string | null; + geoSearchQueryDetectionFieldNames?: string[] | null; } /** - * Metadata related to the progress of the SiteSearchEngineService.UpdateTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field. + * Specification to determine under which conditions query expansion should occur. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaUpdateTargetSiteMetadata { + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestQueryExpansionSpec { /** - * Operation create time. + * The condition under which query expansion should occur. Default to Condition.DISABLED. */ - createTime?: string | null; + condition?: string | null; /** - * Operation last update time. If the operation is done, this is also the finish time. + * 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. */ - updateTime?: string | null; + pinUnexpandedResults?: boolean | null; } /** - * UserEvent captures all metadata information Discovery Engine API needs to know about how end users interact with your website. + * Specification for search as you type in search requests. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaUserEvent { + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestSearchAsYouTypeSpec { /** - * 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. + * The condition under which search as you type should occur. Default to Condition.DISABLED. */ - attributes?: { - [key: string]: Schema$GoogleCloudDiscoveryengineV1betaCustomAttribute; - } | null; + condition?: string | null; + } + /** + * 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. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestSessionSpec { /** - * 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. + * 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. */ - attributionToken?: string | null; + queryId?: string | null; /** - * 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. + * 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. */ - completionInfo?: Schema$GoogleCloudDiscoveryengineV1betaCompletionInfo; + searchResultPersistenceCount?: number | null; + } + /** + * The specification for query spell correction. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestSpellCorrectionSpec { /** - * 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. + * The mode under which spell correction replaces the original search query. Defaults to Mode.AUTO. */ - dataStore?: string | null; + mode?: string | null; + } + /** + * Response message for SearchService.Search method. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchResponse { /** - * 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. + * Controls applied as part of the Control service. */ - directUserRequest?: boolean | null; + appliedControls?: string[] | null; /** - * 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. + * A unique search token. This should be included in the UserEvent logs resulting from this search, which enables accurate attribution of search model performance. */ - documents?: Schema$GoogleCloudDiscoveryengineV1betaDocumentInfo[]; + attributionToken?: string | null; /** - * 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. + * 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. */ - engine?: string | null; + correctedQuery?: string | null; /** - * Only required for UserEventService.ImportUserEvents method. Timestamp of when the user event happened. + * Results of facets requested by user. */ - eventTime?: string | null; + facets?: Schema$GoogleCloudDiscoveryengineV1betaSearchResponseFacet[]; + geoSearchDebugInfo?: Schema$GoogleCloudDiscoveryengineV1betaSearchResponseGeoSearchDebugInfo[]; /** - * 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 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. + * Guided search result. */ - eventType?: string | null; + guidedSearchResult?: Schema$GoogleCloudDiscoveryengineV1betaSearchResponseGuidedSearchResult; /** - * 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. + * Natural language query understanding information for the returned results. */ - filter?: string | null; + naturalLanguageQueryUnderstandingInfo?: Schema$GoogleCloudDiscoveryengineV1betaSearchResponseNaturalLanguageQueryUnderstandingInfo; /** - * Media-specific info. + * 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. */ - mediaInfo?: Schema$GoogleCloudDiscoveryengineV1betaMediaInfo; + nextPageToken?: string | null; /** - * Page metadata such as categories and other critical information for certain event types such as `view-category-page`. + * Query expansion information for the returned results. */ - pageInfo?: Schema$GoogleCloudDiscoveryengineV1betaPageInfo; + queryExpansionInfo?: Schema$GoogleCloudDiscoveryengineV1betaSearchResponseQueryExpansionInfo; /** - * Panel metadata associated with this user event. + * 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. */ - panel?: Schema$GoogleCloudDiscoveryengineV1betaPanelInfo; + redirectUri?: string | null; /** - * The promotion IDs if this is an event associated with promotions. Currently, this field is restricted to at most one ID. + * A list of matched documents. The order represents the ranking. */ - promotionIds?: string[] | null; + results?: Schema$GoogleCloudDiscoveryengineV1betaSearchResponseSearchResult[]; /** - * SearchService.Search details related to the event. This field should be set for `search` event. + * Session information. Only set if SearchRequest.session is provided. See its description for more details. */ - searchInfo?: Schema$GoogleCloudDiscoveryengineV1betaSearchInfo; + sessionInfo?: Schema$GoogleCloudDiscoveryengineV1betaSearchResponseSessionInfo; /** - * 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. + * A summary as part of the search results. This field is only returned if SearchRequest.ContentSearchSpec.summary_spec is set. */ - sessionId?: string | null; + summary?: Schema$GoogleCloudDiscoveryengineV1betaSearchResponseSummary; /** - * 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. + * 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. */ - tagIds?: string[] | null; + totalSize?: number | null; + } + /** + * A facet result. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchResponseFacet { /** - * The transaction metadata (if any) associated with this user event. + * Whether the facet is dynamically generated. */ - transactionInfo?: Schema$GoogleCloudDiscoveryengineV1betaTransactionInfo; + dynamicFacet?: boolean | null; /** - * Information about the end user. + * The key for this facet. For example, `"colors"` or `"price"`. It matches SearchRequest.FacetSpec.FacetKey.key. */ - userInfo?: Schema$GoogleCloudDiscoveryengineV1betaUserInfo; + key?: string | null; /** - * 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. + * The facet values for this field. */ - userPseudoId?: string | null; + values?: Schema$GoogleCloudDiscoveryengineV1betaSearchResponseFacetFacetValue[]; } /** - * Information of an end user. + * A facet value which contains value names and their count. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaUserInfo { + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchResponseFacetFacetValue { /** - * 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. + * Number of items that have this facet value. */ - userAgent?: string | null; + count?: string | null; /** - * 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. + * Interval value for a facet, such as 10, 20) for facet "price". It matches [SearchRequest.FacetSpec.FacetKey.intervals. */ - userId?: string | null; + interval?: Schema$GoogleCloudDiscoveryengineV1betaInterval; + /** + * Text value of a facet, such as "Black" for facet "colors". + */ + value?: string | null; } /** - * Defines circumstances to be checked before allowing a behavior + * Debug information specifically related to forward geocoding issues arising from Geolocation Search. */ - export interface Schema$GoogleCloudDiscoveryengineV1Condition { + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchResponseGeoSearchDebugInfo { /** - * Range of time(s) specifying when condition is active. Maximum of 10 time ranges. + * The error produced. */ - activeTimeRange?: Schema$GoogleCloudDiscoveryengineV1ConditionTimeRange[]; + errorMessage?: string | null; /** - * Search only A list of terms to match the query on. Maximum of 10 query terms. + * The address from which forward geocoding ingestion produced issues. */ - queryTerms?: Schema$GoogleCloudDiscoveryengineV1ConditionQueryTerm[]; + originalAddressQuery?: string | null; } /** - * Matcher for search request query + * Guided search result. The guided search helps user to refine the search results and narrow down to the real needs from a broaded search results. */ - export interface Schema$GoogleCloudDiscoveryengineV1ConditionQueryTerm { + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchResponseGuidedSearchResult { /** - * Whether the search query needs to exactly match the query term. + * Suggested follow-up questions. */ - fullMatch?: boolean | null; + followUpQuestions?: string[] | null; /** - * 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. + * A list of ranked refinement attributes. */ - value?: string | null; + refinementAttributes?: Schema$GoogleCloudDiscoveryengineV1betaSearchResponseGuidedSearchResultRefinementAttribute[]; } /** - * Used for time-dependent conditions. + * Useful attribute for search result refinements. */ - export interface Schema$GoogleCloudDiscoveryengineV1ConditionTimeRange { + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchResponseGuidedSearchResultRefinementAttribute { /** - * End of time range. Range is inclusive. Must be in the future. + * Attribute key used to refine the results. For example, `"movie_type"`. */ - endTime?: string | null; + attributeKey?: string | null; /** - * Start of time range. Range is inclusive. + * Attribute value used to refine the results. For example, `"drama"`. */ - startTime?: string | null; + attributeValue?: string | null; } /** - * 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`. + * Information describing what natural language understanding was done on the input query. */ - export interface Schema$GoogleCloudDiscoveryengineV1Control { + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchResponseNaturalLanguageQueryUnderstandingInfo { /** - * Output only. List of all ServingConfig ids this control is attached to. May take up to 10 minutes to update after changes. + * The filters that were extracted from the input query. */ - associatedServingConfigIds?: string[] | null; + extractedFilters?: string | null; /** - * Defines a boost-type control + * Rewritten input query minus the extracted filters. */ - boostAction?: Schema$GoogleCloudDiscoveryengineV1ControlBoostAction; + rewrittenQuery?: string | null; /** - * 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 filters that were extracted from the input query represented in a structured form. */ - conditions?: Schema$GoogleCloudDiscoveryengineV1Condition[]; + structuredExtractedFilter?: Schema$GoogleCloudDiscoveryengineV1betaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilter; + } + /** + * The filters that were extracted from the input query represented in a structured form. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilter { /** - * 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. + * The expression denoting the filter that was extracted from the input query in a structured form. It can be a simple expression denoting a single string, numerical or geolocation constraint or a compound expression which is a combination of multiple expressions connected using logical (OR and AND) operators. */ - displayName?: string | null; + expression?: Schema$GoogleCloudDiscoveryengineV1betaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterExpression; + } + /** + * Logical `And` operator. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterAndExpression { /** - * Defines a filter-type control Currently not supported by Recommendation + * The expressions that were ANDed together. */ - filterAction?: Schema$GoogleCloudDiscoveryengineV1ControlFilterAction; + expressions?: Schema$GoogleCloudDiscoveryengineV1betaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterExpression[]; + } + /** + * The expression denoting the filter that was extracted from the input query. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterExpression { /** - * Immutable. Fully qualified name `projects/x/locations/global/dataStore/x/controls/x` + * Logical "And" compound operator connecting multiple expressions. */ - name?: string | null; + andExpr?: Schema$GoogleCloudDiscoveryengineV1betaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterAndExpression; /** - * Defines a redirect-type control. + * Geolocation constraint expression. */ - redirectAction?: Schema$GoogleCloudDiscoveryengineV1ControlRedirectAction; + geolocationConstraint?: Schema$GoogleCloudDiscoveryengineV1betaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterGeolocationConstraint; /** - * Required. Immutable. What solution the control belongs to. Must be compatible with vertical of resource. Otherwise an INVALID ARGUMENT error is thrown. + * Numerical constraint expression. */ - solutionType?: string | null; + numberConstraint?: Schema$GoogleCloudDiscoveryengineV1betaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterNumberConstraint; /** - * Treats a group of terms as synonyms of one another. + * Logical "Or" compound operator connecting multiple expressions. */ - synonymsAction?: Schema$GoogleCloudDiscoveryengineV1ControlSynonymsAction; + orExpr?: Schema$GoogleCloudDiscoveryengineV1betaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterOrExpression; /** - * 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. + * String constraint expression. */ - useCases?: string[] | null; + stringConstraint?: Schema$GoogleCloudDiscoveryengineV1betaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterStringConstraint; } /** - * Adjusts order of products in returned list. + * Constraint of a geolocation field. Name of the geolocation field as defined in the schema. */ - export interface Schema$GoogleCloudDiscoveryengineV1ControlBoostAction { + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterGeolocationConstraint { /** - * Required. Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0 (No-op). + * The reference address that was inferred from the input query. The proximity of the reference address to the geolocation field will be used to filter the results. */ - boost?: number | null; + address?: string | null; /** - * 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 name of the geolocation field as defined in the schema. */ - dataStore?: string | null; + fieldName?: string | null; /** - * 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 radius in meters around the address. The record is returned if the location of the geolocation field is within the radius. */ - filter?: string | null; + radiusInMeters?: number | null; } /** - * Specified which products may be included in results. Uses same filter as boost. + * Constraint expression of a number field. Example: price < 100. */ - export interface Schema$GoogleCloudDiscoveryengineV1ControlFilterAction { + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterNumberConstraint { /** - * 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 + * The comparison operation performed between the field value and the value specified in the constraint. */ - dataStore?: string | null; + comparison?: string | null; /** - * 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. + * Name of the numerical field as defined in the schema. */ - filter?: string | null; - } - /** - * Redirects a shopper to the provided URI. - */ - export interface Schema$GoogleCloudDiscoveryengineV1ControlRedirectAction { + fieldName?: string | null; /** - * 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 value specified in the numerical constraint. */ - redirectUri?: string | null; + value?: number | null; } /** - * 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". + * Logical `Or` operator. */ - export interface Schema$GoogleCloudDiscoveryengineV1ControlSynonymsAction { + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterOrExpression { /** - * Defines a set of synonyms. Can specify up to 100 synonyms. Must specify at least 2 synonyms. Otherwise an INVALID ARGUMENT error is thrown. + * The expressions that were ORed together. */ - synonyms?: string[] | null; + expressions?: Schema$GoogleCloudDiscoveryengineV1betaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterExpression[]; } /** - * Metadata related to the progress of the DataStoreService.CreateDataStore operation. This will be returned by the google.longrunning.Operation.metadata field. + * Constraint expression of a string field. */ - export interface Schema$GoogleCloudDiscoveryengineV1CreateDataStoreMetadata { + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterStringConstraint { /** - * Operation create time. + * Name of the string field as defined in the schema. */ - createTime?: string | null; + fieldName?: string | null; /** - * Operation last update time. If the operation is done, this is also the finish time. + * Values of the string field. The record will only be returned if the field value matches one of the values specified here. */ - updateTime?: string | null; + values?: string[] | null; } /** - * Metadata related to the progress of the EngineService.CreateEngine operation. This will be returned by the google.longrunning.Operation.metadata field. + * Information describing query expansion including whether expansion has occurred. */ - export interface Schema$GoogleCloudDiscoveryengineV1CreateEngineMetadata { + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchResponseQueryExpansionInfo { /** - * Operation create time. + * Bool describing whether query expansion has occurred. */ - createTime?: string | null; + expandedQuery?: boolean | null; /** - * Operation last update time. If the operation is done, this is also the finish time. + * Number of pinned results. This field will only be set when expansion happens and SearchRequest.QueryExpansionSpec.pin_unexpanded_results is set to true. */ - updateTime?: string | null; + pinnedResultCount?: string | null; } /** - * Metadata for Create Schema LRO. + * Represents the search results. */ - export interface Schema$GoogleCloudDiscoveryengineV1CreateSchemaMetadata { + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchResponseSearchResult { /** - * Operation create time. + * The chunk data in the search response if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS. */ - createTime?: string | null; + chunk?: Schema$GoogleCloudDiscoveryengineV1betaChunk; /** - * Operation last update time. If the operation is done, this is also the finish time. + * The document data snippet in the search response. Only fields that are marked as `retrievable` are populated. */ - updateTime?: string | null; + document?: Schema$GoogleCloudDiscoveryengineV1betaDocument; + /** + * Document.id of the searched Document. + */ + id?: string | null; + /** + * Google provided available scores. + */ + modelScores?: { + [key: string]: Schema$GoogleCloudDiscoveryengineV1betaDoubleList; + } | null; } /** - * Metadata related to the progress of the SiteSearchEngineService.CreateTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field. + * Information about the session. */ - export interface Schema$GoogleCloudDiscoveryengineV1CreateTargetSiteMetadata { + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchResponseSessionInfo { /** - * Operation create time. + * Name of the session. If the auto-session mode is used (when SearchRequest.session ends with "-"), this field holds the newly generated session name. */ - createTime?: string | null; + name?: string | null; /** - * Operation last update time. If the operation is done, this is also the finish time. + * 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. */ - updateTime?: string | null; + queryId?: string | null; } /** - * DataStore captures global settings and configs at the DataStore level. + * Summary of the top N search results specified by the summary spec. */ - export interface Schema$GoogleCloudDiscoveryengineV1DataStore { + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchResponseSummary { /** - * Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT. + * A collection of Safety Attribute categories and their associated confidence scores. */ - contentConfig?: string | null; + safetyAttributes?: Schema$GoogleCloudDiscoveryengineV1betaSearchResponseSummarySafetyAttributes; /** - * Output only. Timestamp the DataStore was created at. + * Additional summary-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set. */ - createTime?: string | null; + summarySkippedReasons?: string[] | null; /** - * Output only. The id of the default Schema asscociated to this data store. + * The summary content. */ - defaultSchemaId?: string | null; + summaryText?: string | null; /** - * 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. + * Summary with metadata information. */ - displayName?: string | null; + summaryWithMetadata?: Schema$GoogleCloudDiscoveryengineV1betaSearchResponseSummarySummaryWithMetadata; + } + /** + * Citation info for a segment. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchResponseSummaryCitation { /** - * Configuration for Document understanding and enrichment. + * End of the attributed segment, exclusive. */ - documentProcessingConfig?: Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfig; + endIndex?: string | null; /** - * Immutable. The industry vertical that the data store registers. + * Citation sources for the attributed segment. */ - industryVertical?: string | null; + sources?: Schema$GoogleCloudDiscoveryengineV1betaSearchResponseSummaryCitationSource[]; /** - * 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. + * Index indicates the start of the segment, measured in bytes/unicode. */ - name?: string | null; - /** - * 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. - */ - solutionTypes?: string[] | null; - /** - * 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). - */ - startingSchema?: Schema$GoogleCloudDiscoveryengineV1Schema; + startIndex?: string | null; } /** - * Metadata related to the progress of the DataStoreService.DeleteDataStore operation. This will be returned by the google.longrunning.Operation.metadata field. + * Citation metadata. */ - export interface Schema$GoogleCloudDiscoveryengineV1DeleteDataStoreMetadata { - /** - * Operation create time. - */ - createTime?: string | null; + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchResponseSummaryCitationMetadata { /** - * Operation last update time. If the operation is done, this is also the finish time. + * Citations for segments. */ - updateTime?: string | null; + citations?: Schema$GoogleCloudDiscoveryengineV1betaSearchResponseSummaryCitation[]; } /** - * Metadata related to the progress of the EngineService.DeleteEngine operation. This will be returned by the google.longrunning.Operation.metadata field. + * Citation source. */ - export interface Schema$GoogleCloudDiscoveryengineV1DeleteEngineMetadata { - /** - * Operation create time. - */ - createTime?: string | null; + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchResponseSummaryCitationSource { /** - * Operation last update time. If the operation is done, this is also the finish time. + * Document reference index from SummaryWithMetadata.references. It is 0-indexed and the value will be zero if the reference_index is not set explicitly. */ - updateTime?: string | null; + referenceIndex?: string | null; } /** - * Metadata for DeleteSchema LRO. + * Document reference. */ - export interface Schema$GoogleCloudDiscoveryengineV1DeleteSchemaMetadata { + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchResponseSummaryReference { /** - * Operation create time. + * List of cited chunk contents derived from document content. */ - createTime?: string | null; + chunkContents?: Schema$GoogleCloudDiscoveryengineV1betaSearchResponseSummaryReferenceChunkContent[]; /** - * Operation last update time. If the operation is done, this is also the finish time. + * Required. Document.name of the document. Full resource name of the referenced document, in the format `projects/x/locations/x/collections/x/dataStores/x/branches/x/documents/x`. */ - updateTime?: string | null; - } - /** - * Metadata related to the progress of the SiteSearchEngineService.DeleteTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field. - */ - export interface Schema$GoogleCloudDiscoveryengineV1DeleteTargetSiteMetadata { + document?: string | null; /** - * Operation create time. + * Title of the document. */ - createTime?: string | null; + title?: string | null; /** - * Operation last update time. If the operation is done, this is also the finish time. + * Cloud Storage or HTTP uri for the document. */ - updateTime?: string | null; + uri?: string | null; } /** - * Metadata related to the progress of the SiteSearchEngineService.DisableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field. + * Chunk content. */ - export interface Schema$GoogleCloudDiscoveryengineV1DisableAdvancedSiteSearchMetadata { + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchResponseSummaryReferenceChunkContent { /** - * Operation create time. + * Chunk textual content. */ - createTime?: string | null; + content?: string | null; /** - * Operation last update time. If the operation is done, this is also the finish time. + * Page identifier. */ - updateTime?: string | null; + pageIdentifier?: string | null; } /** - * Response message for SiteSearchEngineService.DisableAdvancedSiteSearch method. - */ - export interface Schema$GoogleCloudDiscoveryengineV1DisableAdvancedSiteSearchResponse {} - /** - * A singleton resource of DataStore. It's empty when DataStore is created, which defaults to digital parser. The first call to DataStoreService.UpdateDocumentProcessingConfig method will initialize the config. + * Safety Attribute categories and their associated confidence scores. */ - export interface Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfig { - /** - * Whether chunking mode is enabled. - */ - chunkingConfig?: Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfig; - /** - * 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. - */ - defaultParsingConfig?: Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig; + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchResponseSummarySafetyAttributes { /** - * The full resource name of the Document Processing Config. Format: `projects/x/locations/x/collections/x/dataStores/x/documentProcessingConfig`. + * The display names of Safety Attribute categories associated with the generated content. Order matches the Scores. */ - name?: string | null; + categories?: string[] | null; /** - * 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 or layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and or layout parsing are supported. + * The confidence scores of the each category, higher value means higher confidence. Order matches the Categories. */ - parsingConfigOverrides?: { - [ - key: string - ]: Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig; - } | null; + scores?: number[] | null; } /** - * Configuration for chunking config. + * Summary with metadata information. */ - export interface Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfig { + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchResponseSummarySummaryWithMetadata { /** - * Configuration for the layout based chunking. + * Citation metadata for given summary. */ - layoutBasedChunkingConfig?: Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig; - } - /** - * Configuration for the layout based chunking. - */ - export interface Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig { + citationMetadata?: Schema$GoogleCloudDiscoveryengineV1betaSearchResponseSummaryCitationMetadata; /** - * The token size limit for each chunk. Supported values: 100-500 (inclusive). Default value: 500. + * Document References. */ - chunkSize?: number | null; + references?: Schema$GoogleCloudDiscoveryengineV1betaSearchResponseSummaryReference[]; /** - * Whether to include appending different levels of headings to chunks from the middle of the document to prevent context loss. Default value: False. + * Summary text with no citation information. */ - includeAncestorHeadings?: boolean | null; + summary?: string | null; } /** - * Related configurations applied to a specific type of document parser. + * 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. */ - export interface Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig { + export interface Schema$GoogleCloudDiscoveryengineV1betaServingConfig { /** - * Configurations applied to digital parser. + * 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. */ - digitalParsingConfig?: Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigDigitalParsingConfig; + boostControlIds?: string[] | null; /** - * Configurations applied to layout parser. + * Output only. ServingConfig created timestamp. */ - layoutParsingConfig?: Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigLayoutParsingConfig; + createTime?: string | null; /** - * Configurations applied to OCR parser. Currently it only applies to PDFs. + * 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. */ - ocrParsingConfig?: Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigOcrParsingConfig; - } - /** - * The digital parsing configurations for documents. - */ - export interface Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigDigitalParsingConfig {} - /** - * The layout parsing configurations for documents. - */ - export interface Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigLayoutParsingConfig {} - /** - * The OCR parsing configurations for documents. - */ - export interface Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigOcrParsingConfig { + displayName?: string | null; /** - * [DEPRECATED] This field is deprecated. To use the additional enhanced document elements processing, please switch to `layout_parsing_config`. + * 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. */ - enhancedDocumentElements?: string[] | null; + dissociateControlIds?: string[] | null; /** - * If true, will use native text instead of OCR text on pages containing native text. + * 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. */ - useNativeText?: boolean | null; - } - /** - * Metadata related to the progress of the SiteSearchEngineService.EnableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field. - */ - export interface Schema$GoogleCloudDiscoveryengineV1EnableAdvancedSiteSearchMetadata { + diversityLevel?: string | null; /** - * Operation create time. + * Bring your own embedding config. The config is used for search semantic retrieval. The retrieval is based on the dot product of SearchRequest.EmbeddingSpec.EmbeddingVector.vector and the document embeddings that are provided by this EmbeddingConfig. If SearchRequest.EmbeddingSpec.EmbeddingVector.vector is provided, it overrides this ServingConfig.embedding_config. */ - createTime?: string | null; + embeddingConfig?: Schema$GoogleCloudDiscoveryengineV1betaEmbeddingConfig; /** - * Operation last update time. If the operation is done, this is also the finish time. + * 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. */ - updateTime?: string | null; - } - /** - * Response message for SiteSearchEngineService.EnableAdvancedSiteSearch method. - */ - export interface Schema$GoogleCloudDiscoveryengineV1EnableAdvancedSiteSearchResponse {} - /** - * Metadata that describes the training and serving parameters of an Engine. - */ - export interface Schema$GoogleCloudDiscoveryengineV1Engine { + filterControlIds?: string[] | null; /** - * Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT. + * The GenericConfig of the serving configuration. */ - chatEngineConfig?: Schema$GoogleCloudDiscoveryengineV1EngineChatEngineConfig; + genericConfig?: Schema$GoogleCloudDiscoveryengineV1betaServingConfigGenericConfig; /** - * Output only. Additional information of the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT. + * 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. */ - chatEngineMetadata?: Schema$GoogleCloudDiscoveryengineV1EngineChatEngineMetadata; + ignoreControlIds?: string[] | null; /** - * Common config spec that specifies the metadata of the engine. + * The MediaConfig of the serving configuration. */ - commonConfig?: Schema$GoogleCloudDiscoveryengineV1EngineCommonConfig; + mediaConfig?: Schema$GoogleCloudDiscoveryengineV1betaServingConfigMediaConfig; /** - * Output only. Timestamp the Recommendation Engine was created at. + * 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. */ - createTime?: string | null; + modelId?: string | null; /** - * 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. + * Immutable. Fully qualified name `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}/servingConfigs/{serving_config_id\}` */ - dataStoreIds?: string[] | null; + name?: string | null; /** - * Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. + * 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. */ - displayName?: string | null; + onewaySynonymsControlIds?: string[] | null; /** - * 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. + * 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)`. */ - industryVertical?: string | null; + rankingExpression?: string | null; /** - * 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_number\}/locations/{location\}/collections/{collection\}/engines/{engine\}` engine should be 1-63 characters, and valid characters are /a-z0-9x/. Otherwise, an INVALID_ARGUMENT error is returned. + * 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. */ - name?: string | null; + redirectControlIds?: string[] | null; /** - * Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH. + * 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. */ - searchEngineConfig?: Schema$GoogleCloudDiscoveryengineV1EngineSearchEngineConfig; + replacementControlIds?: string[] | null; /** - * Required. The solutions of the engine. + * Required. Immutable. Specifies the solution type that a serving config can be associated with. */ solutionType?: string | null; /** - * Output only. Timestamp the Recommendation Engine was last updated. + * 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. + */ + synonymsControlIds?: string[] | null; + /** + * Output only. ServingConfig updated timestamp. */ updateTime?: string | null; } /** - * Configurations for a Chat Engine. + * Specifies the configurations needed for Generic Discovery.Currently we support: * `content_search_spec`: configuration for generic content search. */ - export interface Schema$GoogleCloudDiscoveryengineV1EngineChatEngineConfig { - /** - * 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. - */ - agentCreationConfig?: Schema$GoogleCloudDiscoveryengineV1EngineChatEngineConfigAgentCreationConfig; + export interface Schema$GoogleCloudDiscoveryengineV1betaServingConfigGenericConfig { /** - * 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. + * Specifies the expected behavior of content search. Only valid for content-search enabled data store. */ - dialogflowAgentToLink?: string | null; + contentSearchSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpec; } /** - * 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. + * 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. */ - export interface Schema$GoogleCloudDiscoveryengineV1EngineChatEngineConfigAgentCreationConfig { + export interface Schema$GoogleCloudDiscoveryengineV1betaServingConfigMediaConfig { /** - * Name of the company, organization or other entity that the agent represents. Used for knowledge connector LLM prompt and for knowledge search. + * Specifies the content freshness used for recommendation result. Contents will be demoted if contents were published for more than content freshness cutoff days. */ - business?: string | null; + contentFreshnessCutoffDays?: number | null; /** - * 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. + * Specifies the content watched percentage threshold for demotion. Threshold value must be between [0, 1.0] inclusive. */ - defaultLanguageCode?: string | null; + contentWatchedPercentageThreshold?: number | null; /** - * 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. + * Specifies the content watched minutes threshold for demotion. */ - location?: string | null; + contentWatchedSecondsThreshold?: number | null; /** - * 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. + * 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. */ - timeZone?: string | null; + demotionEventType?: string | null; } /** - * Additional information of a Chat Engine. Fields in this message are output only. + * External session proto definition. */ - export interface Schema$GoogleCloudDiscoveryengineV1EngineChatEngineMetadata { + export interface Schema$GoogleCloudDiscoveryengineV1betaSession { /** - * The resource name of a Dialogflow agent, that this Chat Engine refers to. Format: `projects//locations//agents/`. + * Output only. The time the session finished. */ - dialogflowAgent?: string | null; + endTime?: string | null; + /** + * Immutable. Fully qualified name `projects/{project\}/locations/global/collections/{collection\}/engines/{engine\}/sessions/x` + */ + name?: string | null; + /** + * Output only. The time the session started. + */ + startTime?: string | null; + /** + * The state of the session. + */ + state?: string | null; + /** + * Turns. + */ + turns?: Schema$GoogleCloudDiscoveryengineV1betaSessionTurn[]; + /** + * A unique identifier for tracking users. + */ + userPseudoId?: string | null; } /** - * Common configurations for an Engine. + * Represents a turn, including a query from the user and a answer from service. */ - export interface Schema$GoogleCloudDiscoveryengineV1EngineCommonConfig { + export interface Schema$GoogleCloudDiscoveryengineV1betaSessionTurn { /** - * The name of the company, business or entity that is associated with the engine. Setting this may help improve LLM related features. + * The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn. */ - companyName?: string | null; + answer?: string | null; + /** + * The user query. + */ + query?: Schema$GoogleCloudDiscoveryengineV1betaQuery; } /** - * Configurations for a Search Engine. + * SiteSearchEngine captures DataStore level site search persisting configurations. It is a singleton value per data store. */ - export interface Schema$GoogleCloudDiscoveryengineV1EngineSearchEngineConfig { + export interface Schema$GoogleCloudDiscoveryengineV1betaSiteSearchEngine { /** - * The add-on that this search engine enables. + * The fully qualified resource name of the site search engine. Format: `projects/x/locations/x/dataStores/x/siteSearchEngine` */ - searchAddOns?: string[] | null; + name?: string | null; + } + /** + * Verification information for target sites in advanced site search. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaSiteVerificationInfo { /** - * 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. + * Site verification state indicating the ownership and validity. */ - searchTier?: string | null; + siteVerificationState?: string | null; + /** + * Latest site verification time. + */ + verifyTime?: string | null; } /** - * Metadata related to the progress of the ImportCompletionSuggestions operation. This will be returned by the google.longrunning.Operation.metadata field. + * The Spanner source for importing data */ - export interface Schema$GoogleCloudDiscoveryengineV1ImportCompletionSuggestionsMetadata { + export interface Schema$GoogleCloudDiscoveryengineV1betaSpannerSource { /** - * Operation create time. + * Required. The database ID of the source Spanner table. */ - createTime?: string | null; + databaseId?: string | null; /** - * Count of CompletionSuggestions that failed to be imported. + * 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). */ - failureCount?: string | null; + enableDataBoost?: boolean | null; /** - * Count of CompletionSuggestions successfully imported. + * Required. The instance ID of the source Spanner table. */ - successCount?: string | null; + instanceId?: string | null; /** - * Operation last update time. If the operation is done, this is also the finish time. + * The project ID that the Spanner source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request. */ - updateTime?: string | null; + projectId?: string | null; + /** + * Required. The table name of the Spanner database that needs to be imported. + */ + tableId?: string | null; } /** - * 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. + * Suggestion deny list entry identifying the phrase to block from suggestions and the applied operation for the phrase. */ - export interface Schema$GoogleCloudDiscoveryengineV1ImportCompletionSuggestionsResponse { + export interface Schema$GoogleCloudDiscoveryengineV1betaSuggestionDenyListEntry { /** - * The desired location of errors incurred during the Import. + * Required. Phrase to block from suggestions served. Can be maximum 125 characters. */ - errorConfig?: Schema$GoogleCloudDiscoveryengineV1ImportErrorConfig; + blockPhrase?: string | null; /** - * A sample of errors encountered while processing the request. + * Required. The match operator to apply for this phrase. Whether to block the exact phrase, or block any suggestions containing this phrase. */ - errorSamples?: Schema$GoogleRpcStatus[]; + matchOperator?: string | null; } /** - * Metadata related to the progress of the ImportDocuments operation. This is returned by the google.longrunning.Operation.metadata field. + * A target site for the SiteSearchEngine. */ - export interface Schema$GoogleCloudDiscoveryengineV1ImportDocumentsMetadata { + export interface Schema$GoogleCloudDiscoveryengineV1betaTargetSite { /** - * Operation create time. + * 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. */ - createTime?: string | null; + exactMatch?: boolean | null; /** - * Count of entries that encountered errors while processing. + * Output only. Failure reason. */ - failureCount?: string | null; + failureReason?: Schema$GoogleCloudDiscoveryengineV1betaTargetSiteFailureReason; /** - * Count of entries that were processed successfully. + * Output only. This is system-generated based on the provided_uri_pattern. */ - successCount?: string | null; + generatedUriPattern?: string | null; /** - * Total count of entries that were processed. + * Output only. Indexing status. */ - totalCount?: string | null; + indexingStatus?: string | null; /** - * Operation last update time. If the operation is done, this is also the finish 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. */ - updateTime?: string | null; - } - /** - * 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. - */ - export interface Schema$GoogleCloudDiscoveryengineV1ImportDocumentsResponse { + name?: string | null; /** - * Echoes the destination for the complete errors in the request if set. + * Required. Input only. The user provided URI pattern from which the `generated_uri_pattern` is generated. */ - errorConfig?: Schema$GoogleCloudDiscoveryengineV1ImportErrorConfig; + providedUriPattern?: string | null; /** - * A sample of errors encountered while processing the request. + * Output only. Root domain of the provided_uri_pattern. */ - errorSamples?: Schema$GoogleRpcStatus[]; + rootDomainUri?: string | null; + /** + * Output only. Site ownership and validity verification status. + */ + siteVerificationInfo?: Schema$GoogleCloudDiscoveryengineV1betaSiteVerificationInfo; + /** + * The type of the target site, e.g., whether the site is to be included or excluded. + */ + type?: string | null; + /** + * Output only. The target site's last updated time. + */ + updateTime?: string | null; } /** - * Configuration of destination for Import related errors. + * Site search indexing failure reasons. */ - export interface Schema$GoogleCloudDiscoveryengineV1ImportErrorConfig { + export interface Schema$GoogleCloudDiscoveryengineV1betaTargetSiteFailureReason { /** - * 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. + * Failed due to insufficient quota. */ - gcsPrefix?: string | null; + quotaFailure?: Schema$GoogleCloudDiscoveryengineV1betaTargetSiteFailureReasonQuotaFailure; } /** - * Metadata related to the progress of the ImportSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field. + * Failed due to insufficient quota. */ - export interface Schema$GoogleCloudDiscoveryengineV1ImportSuggestionDenyListEntriesMetadata { - /** - * Operation create time. - */ - createTime?: string | null; + export interface Schema$GoogleCloudDiscoveryengineV1betaTargetSiteFailureReasonQuotaFailure { /** - * Operation last update time. If the operation is done, this is also the finish time. + * This number is an estimation on how much total quota this project needs to successfully complete indexing. */ - updateTime?: string | null; + totalRequiredQuota?: string | null; } /** - * Response message for CompletionService.ImportSuggestionDenyListEntries method. + * Defines text input. */ - export interface Schema$GoogleCloudDiscoveryengineV1ImportSuggestionDenyListEntriesResponse { - /** - * A sample of errors encountered while processing the request. - */ - errorSamples?: Schema$GoogleRpcStatus[]; + export interface Schema$GoogleCloudDiscoveryengineV1betaTextInput { /** - * Count of deny list entries that failed to be imported. + * Conversation context of the input. */ - failedEntriesCount?: string | null; + context?: Schema$GoogleCloudDiscoveryengineV1betaConversationContext; /** - * Count of deny list entries successfully imported. + * Text input. */ - importedEntriesCount?: string | null; + input?: string | null; } /** - * Metadata related to the progress of the Import operation. This is returned by the google.longrunning.Operation.metadata field. + * Metadata related to the progress of the TrainCustomModel operation. This is returned by the google.longrunning.Operation.metadata field. */ - export interface Schema$GoogleCloudDiscoveryengineV1ImportUserEventsMetadata { + export interface Schema$GoogleCloudDiscoveryengineV1betaTrainCustomModelMetadata { /** * Operation create time. */ createTime?: string | null; - /** - * Count of entries that encountered errors while processing. - */ - failureCount?: string | null; - /** - * Count of entries that were processed successfully. - */ - successCount?: string | null; /** * Operation last update time. If the operation is done, this is also the finish time. */ updateTime?: string | null; } /** - * 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. + * Request message for SearchTuningService.TrainCustomModel method. */ - export interface Schema$GoogleCloudDiscoveryengineV1ImportUserEventsResponse { + export interface Schema$GoogleCloudDiscoveryengineV1betaTrainCustomModelRequest { /** - * Echoes the destination for the complete errors if this field was set in the request. + * The desired location of errors incurred during the data ingestion and training. */ - errorConfig?: Schema$GoogleCloudDiscoveryengineV1ImportErrorConfig; + errorConfig?: Schema$GoogleCloudDiscoveryengineV1betaImportErrorConfig; /** - * A sample of errors encountered while processing the request. + * Cloud Storage training input. */ - errorSamples?: Schema$GoogleRpcStatus[]; + gcsTrainingInput?: Schema$GoogleCloudDiscoveryengineV1betaTrainCustomModelRequestGcsTrainingInput; /** - * Count of user events imported with complete existing Documents. + * If not provided, a UUID will be generated. */ - joinedEventsCount?: string | null; + modelId?: string | null; /** - * Count of user events imported, but with Document information not found in the existing Branch. + * Model to be trained. Supported values are: * **search-tuning**: Fine tuning the search system based on data provided. */ - unjoinedEventsCount?: string | null; + modelType?: string | null; } /** - * Metadata and configurations for a Google Cloud project in the service. + * Cloud Storage training data input. */ - export interface Schema$GoogleCloudDiscoveryengineV1Project { + export interface Schema$GoogleCloudDiscoveryengineV1betaTrainCustomModelRequestGcsTrainingInput { /** - * Output only. The timestamp when this project is created. + * 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"\}` */ - createTime?: string | null; + corpusDataPath?: string | null; /** - * Output only. Full resource name of the project, for example `projects/{project_number\}`. Note that when making requests, project number and project id are both acceptable, but the server will always respond in project number. + * 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"\} */ - name?: string | null; + queryDataPath?: string | null; /** - * Output only. The timestamp when this project is successfully provisioned. Empty value means this project is still provisioning and is not ready for use. + * 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. */ - provisionCompletionTime?: string | null; + testDataPath?: string | null; /** - * Output only. A map of terms of services. The key is the `id` of ServiceTerms. + * 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` */ - serviceTermsMap?: { - [key: string]: Schema$GoogleCloudDiscoveryengineV1ProjectServiceTerms; - } | null; + trainDataPath?: string | null; } /** - * Metadata about the terms of service. + * Response of the TrainCustomModelRequest. This message is returned by the google.longrunning.Operations.response field. */ - export interface Schema$GoogleCloudDiscoveryengineV1ProjectServiceTerms { + export interface Schema$GoogleCloudDiscoveryengineV1betaTrainCustomModelResponse { /** - * The last time when the project agreed to the terms of service. + * Echoes the destination for the complete errors in the request if set. */ - acceptTime?: string | null; + errorConfig?: Schema$GoogleCloudDiscoveryengineV1betaImportErrorConfig; /** - * The last time when the project declined or revoked the agreement to terms of service. + * A sample of errors encountered while processing the data. */ - declineTime?: string | null; + errorSamples?: Schema$GoogleRpcStatus[]; /** - * 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`. + * The metrics of the trained model. */ - id?: string | null; + metrics?: {[key: string]: number} | null; /** - * Whether the project has accepted/rejected the service terms or it is still pending. + * Fully qualified name of the CustomTuningModel. */ - state?: string | null; + modelName?: string | null; /** - * The version string of the terms of service. For acceptable values, see the comments for id above. + * 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. */ - version?: string | null; + modelStatus?: string | null; } /** - * Metadata associated with a project provision operation. - */ - export interface Schema$GoogleCloudDiscoveryengineV1ProvisionProjectMetadata {} - /** - * Metadata related to the progress of the PurgeCompletionSuggestions operation. This is returned by the google.longrunning.Operation.metadata field. - */ - export interface Schema$GoogleCloudDiscoveryengineV1PurgeCompletionSuggestionsMetadata { - /** - * Operation create time. - */ - createTime?: string | null; - /** - * Operation last update time. If the operation is done, this is also the finish time. - */ - updateTime?: string | null; - } - /** - * Response message for CompletionService.PurgeCompletionSuggestions method. + * A transaction represents the entire purchase transaction. */ - export interface Schema$GoogleCloudDiscoveryengineV1PurgeCompletionSuggestionsResponse { + export interface Schema$GoogleCloudDiscoveryengineV1betaTransactionInfo { /** - * A sample of errors encountered while processing the request. + * 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 */ - errorSamples?: Schema$GoogleRpcStatus[]; + cost?: number | null; /** - * Whether the completion suggestions were successfully purged. + * Required. Currency code. Use three-character ISO-4217 code. */ - purgeSucceeded?: boolean | null; - } - /** - * Metadata related to the progress of the PurgeDocuments operation. This will be returned by the google.longrunning.Operation.metadata field. - */ - export interface Schema$GoogleCloudDiscoveryengineV1PurgeDocumentsMetadata { + currency?: string | null; /** - * Operation create time. + * 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 */ - createTime?: string | null; + discountValue?: number | null; /** - * Count of entries that encountered errors while processing. + * All the taxes associated with the transaction. */ - failureCount?: string | null; + tax?: number | null; /** - * Count of entries that were ignored as entries were not found. + * The transaction ID with a length limit of 128 characters. */ - ignoredCount?: string | null; + transactionId?: string | null; /** - * Count of entries that were deleted successfully. + * 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. */ - successCount?: string | null; + value?: number | null; + } + /** + * Metadata associated with a tune operation. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaTuneEngineMetadata { /** - * Operation last update time. If the operation is done, this is also the finish time. + * Required. The resource name of the engine that this tune applies to. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/engines/{engine_id\}` */ - updateTime?: string | null; + engine?: string | null; } /** - * 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. + * Request to manually start a tuning process now (instead of waiting for the periodically scheduled tuning to happen). */ - export interface Schema$GoogleCloudDiscoveryengineV1PurgeDocumentsResponse { + export interface Schema$GoogleCloudDiscoveryengineV1betaTuneEngineRequest {} + /** + * Response associated with a tune operation. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaTuneEngineResponse {} + /** + * Metadata for UpdateSchema LRO. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaUpdateSchemaMetadata { /** - * The total count of documents purged as a result of the operation. + * Operation create time. */ - purgeCount?: string | null; + createTime?: string | null; /** - * 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. + * Operation last update time. If the operation is done, this is also the finish time. */ - purgeSample?: string[] | null; + updateTime?: string | null; } /** - * Metadata related to the progress of the PurgeSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field. + * Metadata related to the progress of the SiteSearchEngineService.UpdateTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field. */ - export interface Schema$GoogleCloudDiscoveryengineV1PurgeSuggestionDenyListEntriesMetadata { + export interface Schema$GoogleCloudDiscoveryengineV1betaUpdateTargetSiteMetadata { /** * Operation create time. */ @@ -6830,266 +7195,2316 @@ export namespace discoveryengine_v1beta { updateTime?: string | null; } /** - * Response message for CompletionService.PurgeSuggestionDenyListEntries method. + * UserEvent captures all metadata information Discovery Engine API needs to know about how end users interact with your website. */ - export interface Schema$GoogleCloudDiscoveryengineV1PurgeSuggestionDenyListEntriesResponse { + export interface Schema$GoogleCloudDiscoveryengineV1betaUserEvent { /** - * A sample of errors encountered while processing the request. + * 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. */ - errorSamples?: Schema$GoogleRpcStatus[]; + attributes?: { + [key: string]: Schema$GoogleCloudDiscoveryengineV1betaCustomAttribute; + } | null; /** - * Number of suggestion deny list entries purged. + * 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. */ - purgeCount?: string | null; - } - /** - * Defines the structure and layout of a type of document data. - */ - export interface Schema$GoogleCloudDiscoveryengineV1Schema { + attributionToken?: string | null; /** - * The JSON representation of the schema. + * 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. */ - jsonSchema?: string | null; + completionInfo?: Schema$GoogleCloudDiscoveryengineV1betaCompletionInfo; /** - * 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 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. */ - name?: string | null; + dataStore?: string | null; /** - * The structured representation of the schema. + * 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. */ - structSchema?: {[key: string]: any} | null; - } - /** - * Verification information for target sites in advanced site search. - */ - export interface Schema$GoogleCloudDiscoveryengineV1SiteVerificationInfo { + directUserRequest?: boolean | null; /** - * Site verification state indicating the ownership and validity. + * 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. */ - siteVerificationState?: string | null; + documents?: Schema$GoogleCloudDiscoveryengineV1betaDocumentInfo[]; /** - * Latest site verification time. + * 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. */ - verifyTime?: string | null; - } - /** - * A target site for the SiteSearchEngine. - */ - export interface Schema$GoogleCloudDiscoveryengineV1TargetSite { + engine?: string | null; /** - * 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. + * Only required for UserEventService.ImportUserEvents method. Timestamp of when the user event happened. */ - exactMatch?: boolean | null; + eventTime?: string | null; /** - * Output only. Failure reason. + * 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 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. */ - failureReason?: Schema$GoogleCloudDiscoveryengineV1TargetSiteFailureReason; + eventType?: string | null; /** - * Output only. This is system-generated based on the provided_uri_pattern. + * 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. */ - generatedUriPattern?: string | null; + filter?: string | null; /** - * Output only. Indexing status. + * Media-specific info. */ - indexingStatus?: string | null; + mediaInfo?: Schema$GoogleCloudDiscoveryengineV1betaMediaInfo; /** - * 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. + * Page metadata such as categories and other critical information for certain event types such as `view-category-page`. */ - name?: string | null; + pageInfo?: Schema$GoogleCloudDiscoveryengineV1betaPageInfo; /** - * Required. Input only. The user provided URI pattern from which the `generated_uri_pattern` is generated. + * Panel metadata associated with this user event. */ - providedUriPattern?: string | null; + panel?: Schema$GoogleCloudDiscoveryengineV1betaPanelInfo; /** - * Output only. Root domain of the provided_uri_pattern. + * The promotion IDs if this is an event associated with promotions. Currently, this field is restricted to at most one ID. */ - rootDomainUri?: string | null; + promotionIds?: string[] | null; /** - * Output only. Site ownership and validity verification status. + * SearchService.Search details related to the event. This field should be set for `search` event. */ - siteVerificationInfo?: Schema$GoogleCloudDiscoveryengineV1SiteVerificationInfo; + searchInfo?: Schema$GoogleCloudDiscoveryengineV1betaSearchInfo; /** - * The type of the target site, e.g., whether the site is to be included or excluded. + * 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 | null; + sessionId?: string | null; /** - * Output only. The target site's last updated time. + * 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. */ - updateTime?: string | null; - } - /** - * Site search indexing failure reasons. - */ - export interface Schema$GoogleCloudDiscoveryengineV1TargetSiteFailureReason { + tagIds?: string[] | null; /** - * Failed due to insufficient quota. + * The transaction metadata (if any) associated with this user event. */ - quotaFailure?: Schema$GoogleCloudDiscoveryengineV1TargetSiteFailureReasonQuotaFailure; + transactionInfo?: Schema$GoogleCloudDiscoveryengineV1betaTransactionInfo; + /** + * Information about the end user. + */ + userInfo?: Schema$GoogleCloudDiscoveryengineV1betaUserInfo; + /** + * 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. + */ + userPseudoId?: string | null; } /** - * Failed due to insufficient quota. + * Information of an end user. */ - export interface Schema$GoogleCloudDiscoveryengineV1TargetSiteFailureReasonQuotaFailure { + export interface Schema$GoogleCloudDiscoveryengineV1betaUserInfo { /** - * This number is an estimation on how much total quota this project needs to successfully complete indexing. + * 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. */ - totalRequiredQuota?: string | null; + userAgent?: string | null; + /** + * 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. + */ + userId?: string | null; } /** - * Metadata for UpdateSchema LRO. + * Defines circumstances to be checked before allowing a behavior */ - export interface Schema$GoogleCloudDiscoveryengineV1UpdateSchemaMetadata { + export interface Schema$GoogleCloudDiscoveryengineV1Condition { /** - * Operation create time. + * Range of time(s) specifying when condition is active. Maximum of 10 time ranges. */ - createTime?: string | null; + activeTimeRange?: Schema$GoogleCloudDiscoveryengineV1ConditionTimeRange[]; /** - * Operation last update time. If the operation is done, this is also the finish time. + * Search only A list of terms to match the query on. Maximum of 10 query terms. */ - updateTime?: string | null; + queryTerms?: Schema$GoogleCloudDiscoveryengineV1ConditionQueryTerm[]; } /** - * Metadata related to the progress of the SiteSearchEngineService.UpdateTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field. + * Matcher for search request query */ - export interface Schema$GoogleCloudDiscoveryengineV1UpdateTargetSiteMetadata { + export interface Schema$GoogleCloudDiscoveryengineV1ConditionQueryTerm { /** - * Operation create time. + * Whether the search query needs to exactly match the query term. */ - createTime?: string | null; + fullMatch?: boolean | null; /** - * Operation last update time. If the operation is done, this is also the finish time. + * 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. */ - updateTime?: string | null; + value?: string | null; } /** - * The request message for Operations.CancelOperation. - */ - export interface Schema$GoogleLongrunningCancelOperationRequest {} - /** - * The response message for Operations.ListOperations. + * Used for time-dependent conditions. */ - export interface Schema$GoogleLongrunningListOperationsResponse { + export interface Schema$GoogleCloudDiscoveryengineV1ConditionTimeRange { /** - * The standard List next-page token. + * End of time range. Range is inclusive. Must be in the future. */ - nextPageToken?: string | null; + endTime?: string | null; /** - * A list of operations that matches the specified filter in the request. + * Start of time range. Range is inclusive. */ - operations?: Schema$GoogleLongrunningOperation[]; + startTime?: string | null; } /** - * This resource represents a long-running operation that is the result of a network API call. + * 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`. */ - export interface Schema$GoogleLongrunningOperation { + export interface Schema$GoogleCloudDiscoveryengineV1Control { /** - * 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. + * Output only. List of all ServingConfig ids this control is attached to. May take up to 10 minutes to update after changes. */ - done?: boolean | null; + associatedServingConfigIds?: string[] | null; /** - * The error result of the operation in case of failure or cancellation. + * Defines a boost-type control */ - error?: Schema$GoogleRpcStatus; + boostAction?: Schema$GoogleCloudDiscoveryengineV1ControlBoostAction; /** - * 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. + * 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. */ - metadata?: {[key: string]: any} | null; + conditions?: Schema$GoogleCloudDiscoveryengineV1Condition[]; /** - * 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. 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. + */ + displayName?: string | null; + /** + * Defines a filter-type control Currently not supported by Recommendation + */ + filterAction?: Schema$GoogleCloudDiscoveryengineV1ControlFilterAction; + /** + * Immutable. Fully qualified name `projects/x/locations/global/dataStore/x/controls/x` */ name?: string | null; /** - * 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`. + * Defines a redirect-type control. */ - response?: {[key: string]: any} | null; + redirectAction?: Schema$GoogleCloudDiscoveryengineV1ControlRedirectAction; + /** + * Required. Immutable. What solution the control belongs to. Must be compatible with vertical of resource. Otherwise an INVALID ARGUMENT error is thrown. + */ + solutionType?: string | null; + /** + * Treats a group of terms as synonyms of one another. + */ + synonymsAction?: Schema$GoogleCloudDiscoveryengineV1ControlSynonymsAction; + /** + * 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. + */ + useCases?: string[] | null; } /** - * 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); \} + * Adjusts order of products in returned list. */ - export interface Schema$GoogleProtobufEmpty {} + export interface Schema$GoogleCloudDiscoveryengineV1ControlBoostAction { + /** + * Required. Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0 (No-op). + */ + boost?: number | null; + /** + * 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 + */ + dataStore?: string | null; + /** + * 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. + */ + filter?: string | null; + } /** - * 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). + * Specified which products may be included in results. Uses same filter as boost. */ - export interface Schema$GoogleRpcStatus { + export interface Schema$GoogleCloudDiscoveryengineV1ControlFilterAction { /** - * The status code, which should be an enum value of google.rpc.Code. + * 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 */ - code?: number | null; + dataStore?: string | null; /** - * A list of messages that carry the error details. There is a common set of message types for APIs to use. + * 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. */ - details?: Array<{[key: string]: any}> | null; + filter?: string | null; + } + /** + * Redirects a shopper to the provided URI. + */ + export interface Schema$GoogleCloudDiscoveryengineV1ControlRedirectAction { /** - * 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. + * 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. */ - message?: string | null; + redirectUri?: string | null; } /** - * 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 + * 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". */ - export interface Schema$GoogleTypeDate { + export interface Schema$GoogleCloudDiscoveryengineV1ControlSynonymsAction { /** - * 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. + * Defines a set of synonyms. Can specify up to 100 synonyms. Must specify at least 2 synonyms. Otherwise an INVALID ARGUMENT error is thrown. */ - day?: number | null; + synonyms?: string[] | null; + } + /** + * Metadata related to the progress of the DataStoreService.CreateDataStore operation. This will be returned by the google.longrunning.Operation.metadata field. + */ + export interface Schema$GoogleCloudDiscoveryengineV1CreateDataStoreMetadata { /** - * Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + * Operation create time. */ - month?: number | null; + createTime?: string | null; /** - * Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + * Operation last update time. If the operation is done, this is also the finish time. */ - year?: number | null; + updateTime?: string | null; + } + /** + * Metadata related to the progress of the EngineService.CreateEngine operation. This will be returned by the google.longrunning.Operation.metadata field. + */ + export interface Schema$GoogleCloudDiscoveryengineV1CreateEngineMetadata { + /** + * Operation create time. + */ + createTime?: string | null; + /** + * Operation last update time. If the operation is done, this is also the finish time. + */ + updateTime?: string | null; + } + /** + * Metadata for Create Schema LRO. + */ + export interface Schema$GoogleCloudDiscoveryengineV1CreateSchemaMetadata { + /** + * Operation create time. + */ + createTime?: string | null; + /** + * Operation last update time. If the operation is done, this is also the finish time. + */ + updateTime?: string | null; + } + /** + * Metadata related to the progress of the SiteSearchEngineService.CreateTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field. + */ + export interface Schema$GoogleCloudDiscoveryengineV1CreateTargetSiteMetadata { + /** + * Operation create time. + */ + createTime?: string | null; + /** + * Operation last update time. If the operation is done, this is also the finish time. + */ + updateTime?: string | null; + } + /** + * DataStore captures global settings and configs at the DataStore level. + */ + export interface Schema$GoogleCloudDiscoveryengineV1DataStore { + /** + * Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT. + */ + contentConfig?: string | null; + /** + * Output only. Timestamp the DataStore was created at. + */ + createTime?: string | null; + /** + * Output only. The id of the default Schema asscociated to this data store. + */ + defaultSchemaId?: string | null; + /** + * 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. + */ + displayName?: string | null; + /** + * Configuration for Document understanding and enrichment. + */ + documentProcessingConfig?: Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfig; + /** + * Immutable. The industry vertical that the data store registers. + */ + industryVertical?: string | null; + /** + * 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. + */ + name?: string | null; + /** + * 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. + */ + solutionTypes?: string[] | null; + /** + * 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). + */ + startingSchema?: Schema$GoogleCloudDiscoveryengineV1Schema; + } + /** + * Metadata related to the progress of the DataStoreService.DeleteDataStore operation. This will be returned by the google.longrunning.Operation.metadata field. + */ + export interface Schema$GoogleCloudDiscoveryengineV1DeleteDataStoreMetadata { + /** + * Operation create time. + */ + createTime?: string | null; + /** + * Operation last update time. If the operation is done, this is also the finish time. + */ + updateTime?: string | null; + } + /** + * Metadata related to the progress of the EngineService.DeleteEngine operation. This will be returned by the google.longrunning.Operation.metadata field. + */ + export interface Schema$GoogleCloudDiscoveryengineV1DeleteEngineMetadata { + /** + * Operation create time. + */ + createTime?: string | null; + /** + * Operation last update time. If the operation is done, this is also the finish time. + */ + updateTime?: string | null; + } + /** + * Metadata for DeleteSchema LRO. + */ + export interface Schema$GoogleCloudDiscoveryengineV1DeleteSchemaMetadata { + /** + * Operation create time. + */ + createTime?: string | null; + /** + * Operation last update time. If the operation is done, this is also the finish time. + */ + updateTime?: string | null; + } + /** + * Metadata related to the progress of the SiteSearchEngineService.DeleteTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field. + */ + export interface Schema$GoogleCloudDiscoveryengineV1DeleteTargetSiteMetadata { + /** + * Operation create time. + */ + createTime?: string | null; + /** + * Operation last update time. If the operation is done, this is also the finish time. + */ + updateTime?: string | null; + } + /** + * Metadata related to the progress of the SiteSearchEngineService.DisableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field. + */ + export interface Schema$GoogleCloudDiscoveryengineV1DisableAdvancedSiteSearchMetadata { + /** + * Operation create time. + */ + createTime?: string | null; + /** + * Operation last update time. If the operation is done, this is also the finish time. + */ + updateTime?: string | null; } + /** + * Response message for SiteSearchEngineService.DisableAdvancedSiteSearch method. + */ + export interface Schema$GoogleCloudDiscoveryengineV1DisableAdvancedSiteSearchResponse {} + /** + * A singleton resource of DataStore. It's empty when DataStore is created, which defaults to digital parser. The first call to DataStoreService.UpdateDocumentProcessingConfig method will initialize the config. + */ + export interface Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfig { + /** + * Whether chunking mode is enabled. + */ + chunkingConfig?: Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfig; + /** + * 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. + */ + defaultParsingConfig?: Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig; + /** + * The full resource name of the Document Processing Config. Format: `projects/x/locations/x/collections/x/dataStores/x/documentProcessingConfig`. + */ + name?: string | null; + /** + * 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. + */ + parsingConfigOverrides?: { + [ + key: string + ]: Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig; + } | null; + } + /** + * Configuration for chunking config. + */ + export interface Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfig { + /** + * Configuration for the layout based chunking. + */ + layoutBasedChunkingConfig?: Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig; + } + /** + * Configuration for the layout based chunking. + */ + export interface Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig { + /** + * The token size limit for each chunk. Supported values: 100-500 (inclusive). Default value: 500. + */ + chunkSize?: number | null; + /** + * Whether to include appending different levels of headings to chunks from the middle of the document to prevent context loss. Default value: False. + */ + includeAncestorHeadings?: boolean | null; + } + /** + * Related configurations applied to a specific type of document parser. + */ + export interface Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig { + /** + * Configurations applied to digital parser. + */ + digitalParsingConfig?: Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigDigitalParsingConfig; + /** + * Configurations applied to layout parser. + */ + layoutParsingConfig?: Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigLayoutParsingConfig; + /** + * Configurations applied to OCR parser. Currently it only applies to PDFs. + */ + ocrParsingConfig?: Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigOcrParsingConfig; + } + /** + * The digital parsing configurations for documents. + */ + export interface Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigDigitalParsingConfig {} + /** + * The layout parsing configurations for documents. + */ + export interface Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigLayoutParsingConfig {} + /** + * The OCR parsing configurations for documents. + */ + export interface Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigOcrParsingConfig { + /** + * [DEPRECATED] This field is deprecated. To use the additional enhanced document elements processing, please switch to `layout_parsing_config`. + */ + enhancedDocumentElements?: string[] | null; + /** + * If true, will use native text instead of OCR text on pages containing native text. + */ + useNativeText?: boolean | null; + } + /** + * Metadata related to the progress of the SiteSearchEngineService.EnableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field. + */ + export interface Schema$GoogleCloudDiscoveryengineV1EnableAdvancedSiteSearchMetadata { + /** + * Operation create time. + */ + createTime?: string | null; + /** + * Operation last update time. If the operation is done, this is also the finish time. + */ + updateTime?: string | null; + } + /** + * Response message for SiteSearchEngineService.EnableAdvancedSiteSearch method. + */ + export interface Schema$GoogleCloudDiscoveryengineV1EnableAdvancedSiteSearchResponse {} + /** + * Metadata that describes the training and serving parameters of an Engine. + */ + export interface Schema$GoogleCloudDiscoveryengineV1Engine { + /** + * Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT. + */ + chatEngineConfig?: Schema$GoogleCloudDiscoveryengineV1EngineChatEngineConfig; + /** + * Output only. Additional information of the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT. + */ + chatEngineMetadata?: Schema$GoogleCloudDiscoveryengineV1EngineChatEngineMetadata; + /** + * Common config spec that specifies the metadata of the engine. + */ + commonConfig?: Schema$GoogleCloudDiscoveryengineV1EngineCommonConfig; + /** + * Output only. Timestamp the Recommendation Engine was created at. + */ + createTime?: string | null; + /** + * 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. + */ + dataStoreIds?: string[] | null; + /** + * Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. + */ + displayName?: string | null; + /** + * 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. + */ + industryVertical?: string | null; + /** + * 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_number\}/locations/{location\}/collections/{collection\}/engines/{engine\}` engine should be 1-63 characters, and valid characters are /a-z0-9x/. Otherwise, an INVALID_ARGUMENT error is returned. + */ + name?: string | null; + /** + * Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH. + */ + searchEngineConfig?: Schema$GoogleCloudDiscoveryengineV1EngineSearchEngineConfig; + /** + * Required. The solutions of the engine. + */ + solutionType?: string | null; + /** + * Output only. Timestamp the Recommendation Engine was last updated. + */ + updateTime?: string | null; + } + /** + * Configurations for a Chat Engine. + */ + export interface Schema$GoogleCloudDiscoveryengineV1EngineChatEngineConfig { + /** + * 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. + */ + agentCreationConfig?: Schema$GoogleCloudDiscoveryengineV1EngineChatEngineConfigAgentCreationConfig; + /** + * 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. + */ + dialogflowAgentToLink?: string | null; + } + /** + * 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. + */ + export interface Schema$GoogleCloudDiscoveryengineV1EngineChatEngineConfigAgentCreationConfig { + /** + * Name of the company, organization or other entity that the agent represents. Used for knowledge connector LLM prompt and for knowledge search. + */ + business?: string | null; + /** + * 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. + */ + defaultLanguageCode?: string | null; + /** + * 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. + */ + location?: string | null; + /** + * 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. + */ + timeZone?: string | null; + } + /** + * Additional information of a Chat Engine. Fields in this message are output only. + */ + export interface Schema$GoogleCloudDiscoveryengineV1EngineChatEngineMetadata { + /** + * The resource name of a Dialogflow agent, that this Chat Engine refers to. Format: `projects//locations//agents/`. + */ + dialogflowAgent?: string | null; + } + /** + * Common configurations for an Engine. + */ + export interface Schema$GoogleCloudDiscoveryengineV1EngineCommonConfig { + /** + * The name of the company, business or entity that is associated with the engine. Setting this may help improve LLM related features. + */ + companyName?: string | null; + } + /** + * Configurations for a Search Engine. + */ + export interface Schema$GoogleCloudDiscoveryengineV1EngineSearchEngineConfig { + /** + * The add-on that this search engine enables. + */ + searchAddOns?: string[] | null; + /** + * 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. + */ + searchTier?: string | null; + } + /** + * Metadata related to the progress of the ImportCompletionSuggestions operation. This will be returned by the google.longrunning.Operation.metadata field. + */ + export interface Schema$GoogleCloudDiscoveryengineV1ImportCompletionSuggestionsMetadata { + /** + * Operation create time. + */ + createTime?: string | null; + /** + * Count of CompletionSuggestions that failed to be imported. + */ + failureCount?: string | null; + /** + * Count of CompletionSuggestions successfully imported. + */ + successCount?: string | null; + /** + * Operation last update time. If the operation is done, this is also the finish time. + */ + updateTime?: string | null; + } + /** + * 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. + */ + export interface Schema$GoogleCloudDiscoveryengineV1ImportCompletionSuggestionsResponse { + /** + * The desired location of errors incurred during the Import. + */ + errorConfig?: Schema$GoogleCloudDiscoveryengineV1ImportErrorConfig; + /** + * A sample of errors encountered while processing the request. + */ + errorSamples?: Schema$GoogleRpcStatus[]; + } + /** + * Metadata related to the progress of the ImportDocuments operation. This is returned by the google.longrunning.Operation.metadata field. + */ + export interface Schema$GoogleCloudDiscoveryengineV1ImportDocumentsMetadata { + /** + * Operation create time. + */ + createTime?: string | null; + /** + * Count of entries that encountered errors while processing. + */ + failureCount?: string | null; + /** + * Count of entries that were processed successfully. + */ + successCount?: string | null; + /** + * Total count of entries that were processed. + */ + totalCount?: string | null; + /** + * Operation last update time. If the operation is done, this is also the finish time. + */ + updateTime?: string | null; + } + /** + * 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. + */ + export interface Schema$GoogleCloudDiscoveryengineV1ImportDocumentsResponse { + /** + * Echoes the destination for the complete errors in the request if set. + */ + errorConfig?: Schema$GoogleCloudDiscoveryengineV1ImportErrorConfig; + /** + * A sample of errors encountered while processing the request. + */ + errorSamples?: Schema$GoogleRpcStatus[]; + } + /** + * Configuration of destination for Import related errors. + */ + export interface Schema$GoogleCloudDiscoveryengineV1ImportErrorConfig { + /** + * 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. + */ + gcsPrefix?: string | null; + } + /** + * Metadata related to the progress of the ImportSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field. + */ + export interface Schema$GoogleCloudDiscoveryengineV1ImportSuggestionDenyListEntriesMetadata { + /** + * Operation create time. + */ + createTime?: string | null; + /** + * Operation last update time. If the operation is done, this is also the finish time. + */ + updateTime?: string | null; + } + /** + * Response message for CompletionService.ImportSuggestionDenyListEntries method. + */ + export interface Schema$GoogleCloudDiscoveryengineV1ImportSuggestionDenyListEntriesResponse { + /** + * A sample of errors encountered while processing the request. + */ + errorSamples?: Schema$GoogleRpcStatus[]; + /** + * Count of deny list entries that failed to be imported. + */ + failedEntriesCount?: string | null; + /** + * Count of deny list entries successfully imported. + */ + importedEntriesCount?: string | null; + } + /** + * Metadata related to the progress of the Import operation. This is returned by the google.longrunning.Operation.metadata field. + */ + export interface Schema$GoogleCloudDiscoveryengineV1ImportUserEventsMetadata { + /** + * Operation create time. + */ + createTime?: string | null; + /** + * Count of entries that encountered errors while processing. + */ + failureCount?: string | null; + /** + * Count of entries that were processed successfully. + */ + successCount?: string | null; + /** + * Operation last update time. If the operation is done, this is also the finish time. + */ + updateTime?: string | null; + } + /** + * 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. + */ + export interface Schema$GoogleCloudDiscoveryengineV1ImportUserEventsResponse { + /** + * Echoes the destination for the complete errors if this field was set in the request. + */ + errorConfig?: Schema$GoogleCloudDiscoveryengineV1ImportErrorConfig; + /** + * A sample of errors encountered while processing the request. + */ + errorSamples?: Schema$GoogleRpcStatus[]; + /** + * Count of user events imported with complete existing Documents. + */ + joinedEventsCount?: string | null; + /** + * Count of user events imported, but with Document information not found in the existing Branch. + */ + unjoinedEventsCount?: string | null; + } + /** + * Metadata and configurations for a Google Cloud project in the service. + */ + export interface Schema$GoogleCloudDiscoveryengineV1Project { + /** + * Output only. The timestamp when this project is created. + */ + createTime?: string | null; + /** + * Output only. Full resource name of the project, for example `projects/{project_number\}`. Note that when making requests, project number and project id are both acceptable, but the server will always respond in project number. + */ + name?: string | null; + /** + * Output only. The timestamp when this project is successfully provisioned. Empty value means this project is still provisioning and is not ready for use. + */ + provisionCompletionTime?: string | null; + /** + * Output only. A map of terms of services. The key is the `id` of ServiceTerms. + */ + serviceTermsMap?: { + [key: string]: Schema$GoogleCloudDiscoveryengineV1ProjectServiceTerms; + } | null; + } + /** + * Metadata about the terms of service. + */ + export interface Schema$GoogleCloudDiscoveryengineV1ProjectServiceTerms { + /** + * The last time when the project agreed to the terms of service. + */ + acceptTime?: string | null; + /** + * The last time when the project declined or revoked the agreement to terms of service. + */ + declineTime?: string | null; + /** + * 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`. + */ + id?: string | null; + /** + * Whether the project has accepted/rejected the service terms or it is still pending. + */ + state?: string | null; + /** + * The version string of the terms of service. For acceptable values, see the comments for id above. + */ + version?: string | null; + } + /** + * Metadata associated with a project provision operation. + */ + export interface Schema$GoogleCloudDiscoveryengineV1ProvisionProjectMetadata {} + /** + * Metadata related to the progress of the PurgeCompletionSuggestions operation. This is returned by the google.longrunning.Operation.metadata field. + */ + export interface Schema$GoogleCloudDiscoveryengineV1PurgeCompletionSuggestionsMetadata { + /** + * Operation create time. + */ + createTime?: string | null; + /** + * Operation last update time. If the operation is done, this is also the finish time. + */ + updateTime?: string | null; + } + /** + * Response message for CompletionService.PurgeCompletionSuggestions method. + */ + export interface Schema$GoogleCloudDiscoveryengineV1PurgeCompletionSuggestionsResponse { + /** + * A sample of errors encountered while processing the request. + */ + errorSamples?: Schema$GoogleRpcStatus[]; + /** + * Whether the completion suggestions were successfully purged. + */ + purgeSucceeded?: boolean | null; + } + /** + * Metadata related to the progress of the PurgeDocuments operation. This will be returned by the google.longrunning.Operation.metadata field. + */ + export interface Schema$GoogleCloudDiscoveryengineV1PurgeDocumentsMetadata { + /** + * Operation create time. + */ + createTime?: string | null; + /** + * Count of entries that encountered errors while processing. + */ + failureCount?: string | null; + /** + * Count of entries that were ignored as entries were not found. + */ + ignoredCount?: string | null; + /** + * Count of entries that were deleted successfully. + */ + successCount?: string | null; + /** + * Operation last update time. If the operation is done, this is also the finish time. + */ + updateTime?: string | null; + } + /** + * 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. + */ + export interface Schema$GoogleCloudDiscoveryengineV1PurgeDocumentsResponse { + /** + * The total count of documents purged as a result of the operation. + */ + purgeCount?: string | null; + /** + * 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. + */ + purgeSample?: string[] | null; + } + /** + * Metadata related to the progress of the PurgeSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field. + */ + export interface Schema$GoogleCloudDiscoveryengineV1PurgeSuggestionDenyListEntriesMetadata { + /** + * Operation create time. + */ + createTime?: string | null; + /** + * Operation last update time. If the operation is done, this is also the finish time. + */ + updateTime?: string | null; + } + /** + * Response message for CompletionService.PurgeSuggestionDenyListEntries method. + */ + export interface Schema$GoogleCloudDiscoveryengineV1PurgeSuggestionDenyListEntriesResponse { + /** + * A sample of errors encountered while processing the request. + */ + errorSamples?: Schema$GoogleRpcStatus[]; + /** + * Number of suggestion deny list entries purged. + */ + purgeCount?: string | null; + } + /** + * Defines the structure and layout of a type of document data. + */ + export interface Schema$GoogleCloudDiscoveryengineV1Schema { + /** + * The JSON representation of the schema. + */ + jsonSchema?: string | null; + /** + * 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. + */ + name?: string | null; + /** + * The structured representation of the schema. + */ + structSchema?: {[key: string]: any} | null; + } + /** + * Verification information for target sites in advanced site search. + */ + export interface Schema$GoogleCloudDiscoveryengineV1SiteVerificationInfo { + /** + * Site verification state indicating the ownership and validity. + */ + siteVerificationState?: string | null; + /** + * Latest site verification time. + */ + verifyTime?: string | null; + } + /** + * A target site for the SiteSearchEngine. + */ + export interface Schema$GoogleCloudDiscoveryengineV1TargetSite { + /** + * 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. + */ + exactMatch?: boolean | null; + /** + * Output only. Failure reason. + */ + failureReason?: Schema$GoogleCloudDiscoveryengineV1TargetSiteFailureReason; + /** + * Output only. This is system-generated based on the provided_uri_pattern. + */ + generatedUriPattern?: string | null; + /** + * Output only. Indexing status. + */ + indexingStatus?: string | null; + /** + * 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. + */ + name?: string | null; + /** + * Required. Input only. The user provided URI pattern from which the `generated_uri_pattern` is generated. + */ + providedUriPattern?: string | null; + /** + * Output only. Root domain of the provided_uri_pattern. + */ + rootDomainUri?: string | null; + /** + * Output only. Site ownership and validity verification status. + */ + siteVerificationInfo?: Schema$GoogleCloudDiscoveryengineV1SiteVerificationInfo; + /** + * The type of the target site, e.g., whether the site is to be included or excluded. + */ + type?: string | null; + /** + * Output only. The target site's last updated time. + */ + updateTime?: string | null; + } + /** + * Site search indexing failure reasons. + */ + export interface Schema$GoogleCloudDiscoveryengineV1TargetSiteFailureReason { + /** + * Failed due to insufficient quota. + */ + quotaFailure?: Schema$GoogleCloudDiscoveryengineV1TargetSiteFailureReasonQuotaFailure; + } + /** + * Failed due to insufficient quota. + */ + export interface Schema$GoogleCloudDiscoveryengineV1TargetSiteFailureReasonQuotaFailure { + /** + * This number is an estimation on how much total quota this project needs to successfully complete indexing. + */ + totalRequiredQuota?: string | null; + } + /** + * Metadata for UpdateSchema LRO. + */ + export interface Schema$GoogleCloudDiscoveryengineV1UpdateSchemaMetadata { + /** + * Operation create time. + */ + createTime?: string | null; + /** + * Operation last update time. If the operation is done, this is also the finish time. + */ + updateTime?: string | null; + } + /** + * Metadata related to the progress of the SiteSearchEngineService.UpdateTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field. + */ + export interface Schema$GoogleCloudDiscoveryengineV1UpdateTargetSiteMetadata { + /** + * Operation create time. + */ + createTime?: string | null; + /** + * Operation last update time. If the operation is done, this is also the finish time. + */ + updateTime?: string | null; + } + /** + * The request message for Operations.CancelOperation. + */ + export interface Schema$GoogleLongrunningCancelOperationRequest {} + /** + * The response message for Operations.ListOperations. + */ + export interface Schema$GoogleLongrunningListOperationsResponse { + /** + * The standard List next-page token. + */ + nextPageToken?: string | null; + /** + * A list of operations that matches the specified filter in the request. + */ + operations?: Schema$GoogleLongrunningOperation[]; + } + /** + * This resource represents a long-running operation that is the result of a network API call. + */ + export interface Schema$GoogleLongrunningOperation { + /** + * 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. + */ + done?: boolean | null; + /** + * The error result of the operation in case of failure or cancellation. + */ + error?: Schema$GoogleRpcStatus; + /** + * 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. + */ + metadata?: {[key: string]: any} | null; + /** + * 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\}`. + */ + name?: string | null; + /** + * 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`. + */ + response?: {[key: string]: any} | null; + } + /** + * 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); \} + */ + export interface Schema$GoogleProtobufEmpty {} + /** + * 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). + */ + export interface Schema$GoogleRpcStatus { + /** + * The status code, which should be an enum value of google.rpc.Code. + */ + code?: number | null; + /** + * A list of messages that carry the error details. There is a common set of message types for APIs to use. + */ + details?: Array<{[key: string]: any}> | null; + /** + * 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. + */ + message?: string | null; + } + /** + * 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 + */ + export interface Schema$GoogleTypeDate { + /** + * 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. + */ + day?: number | null; + /** + * Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + */ + month?: number | null; + /** + * Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + */ + year?: number | null; + } + + export class Resource$Projects { + context: APIRequestContext; + locations: Resource$Projects$Locations; + operations: Resource$Projects$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.locations = new Resource$Projects$Locations(this.context); + this.operations = new Resource$Projects$Operations(this.context); + } + + /** + * 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. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + provision( + params: Params$Resource$Projects$Provision, + options: StreamMethodOptions + ): GaxiosPromise; + provision( + params?: Params$Resource$Projects$Provision, + options?: MethodOptions + ): GaxiosPromise; + provision( + params: Params$Resource$Projects$Provision, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + provision( + params: Params$Resource$Projects$Provision, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + provision( + params: Params$Resource$Projects$Provision, + callback: BodyResponseCallback + ): void; + provision( + callback: BodyResponseCallback + ): void; + provision( + paramsOrCallback?: + | Params$Resource$Projects$Provision + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Provision; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Provision; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta/{+name}:provision').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Provision + extends StandardParameters { + /** + * Required. Full resource name of a Project, such as `projects/{project_id_or_number\}`. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1betaProvisionProjectRequest; + } + + export class Resource$Projects$Locations { + context: APIRequestContext; + collections: Resource$Projects$Locations$Collections; + dataStores: Resource$Projects$Locations$Datastores; + evaluations: Resource$Projects$Locations$Evaluations; + groundingConfigs: Resource$Projects$Locations$Groundingconfigs; + operations: Resource$Projects$Locations$Operations; + rankingConfigs: Resource$Projects$Locations$Rankingconfigs; + sampleQuerySets: Resource$Projects$Locations$Samplequerysets; + userEvents: Resource$Projects$Locations$Userevents; + constructor(context: APIRequestContext) { + this.context = context; + this.collections = new Resource$Projects$Locations$Collections( + this.context + ); + this.dataStores = new Resource$Projects$Locations$Datastores( + this.context + ); + this.evaluations = new Resource$Projects$Locations$Evaluations( + this.context + ); + this.groundingConfigs = new Resource$Projects$Locations$Groundingconfigs( + this.context + ); + this.operations = new Resource$Projects$Locations$Operations( + this.context + ); + this.rankingConfigs = new Resource$Projects$Locations$Rankingconfigs( + this.context + ); + this.sampleQuerySets = new Resource$Projects$Locations$Samplequerysets( + this.context + ); + this.userEvents = new Resource$Projects$Locations$Userevents( + this.context + ); + } + } + + export class Resource$Projects$Locations$Collections { + context: APIRequestContext; + dataConnector: Resource$Projects$Locations$Collections$Dataconnector; + dataStores: Resource$Projects$Locations$Collections$Datastores; + engines: Resource$Projects$Locations$Collections$Engines; + operations: Resource$Projects$Locations$Collections$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.dataConnector = + new Resource$Projects$Locations$Collections$Dataconnector(this.context); + this.dataStores = new Resource$Projects$Locations$Collections$Datastores( + this.context + ); + this.engines = new Resource$Projects$Locations$Collections$Engines( + this.context + ); + this.operations = new Resource$Projects$Locations$Collections$Operations( + this.context + ); + } + } + + export class Resource$Projects$Locations$Collections$Dataconnector { + context: APIRequestContext; + operations: Resource$Projects$Locations$Collections$Dataconnector$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.operations = + new Resource$Projects$Locations$Collections$Dataconnector$Operations( + this.context + ); + } + } + + export class Resource$Projects$Locations$Collections$Dataconnector$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * 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. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta/{+name}/operations').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$Get + extends StandardParameters { + /** + * The name of the operation resource. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$List + extends StandardParameters { + /** + * The standard list filter. + */ + filter?: string; + /** + * The name of the operation's parent resource. + */ + name?: string; + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. + */ + pageToken?: string; + } + + export class Resource$Projects$Locations$Collections$Datastores { + context: APIRequestContext; + branches: Resource$Projects$Locations$Collections$Datastores$Branches; + completionSuggestions: Resource$Projects$Locations$Collections$Datastores$Completionsuggestions; + controls: Resource$Projects$Locations$Collections$Datastores$Controls; + conversations: Resource$Projects$Locations$Collections$Datastores$Conversations; + customModels: Resource$Projects$Locations$Collections$Datastores$Custommodels; + models: Resource$Projects$Locations$Collections$Datastores$Models; + operations: Resource$Projects$Locations$Collections$Datastores$Operations; + schemas: Resource$Projects$Locations$Collections$Datastores$Schemas; + servingConfigs: Resource$Projects$Locations$Collections$Datastores$Servingconfigs; + sessions: Resource$Projects$Locations$Collections$Datastores$Sessions; + siteSearchEngine: Resource$Projects$Locations$Collections$Datastores$Sitesearchengine; + suggestionDenyListEntries: Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries; + userEvents: Resource$Projects$Locations$Collections$Datastores$Userevents; + constructor(context: APIRequestContext) { + this.context = context; + this.branches = + new Resource$Projects$Locations$Collections$Datastores$Branches( + this.context + ); + this.completionSuggestions = + new Resource$Projects$Locations$Collections$Datastores$Completionsuggestions( + this.context + ); + this.controls = + new Resource$Projects$Locations$Collections$Datastores$Controls( + this.context + ); + this.conversations = + new Resource$Projects$Locations$Collections$Datastores$Conversations( + this.context + ); + this.customModels = + new Resource$Projects$Locations$Collections$Datastores$Custommodels( + this.context + ); + this.models = + new Resource$Projects$Locations$Collections$Datastores$Models( + this.context + ); + this.operations = + new Resource$Projects$Locations$Collections$Datastores$Operations( + this.context + ); + this.schemas = + new Resource$Projects$Locations$Collections$Datastores$Schemas( + this.context + ); + this.servingConfigs = + new Resource$Projects$Locations$Collections$Datastores$Servingconfigs( + this.context + ); + this.sessions = + new Resource$Projects$Locations$Collections$Datastores$Sessions( + this.context + ); + this.siteSearchEngine = + new Resource$Projects$Locations$Collections$Datastores$Sitesearchengine( + this.context + ); + this.suggestionDenyListEntries = + new Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries( + this.context + ); + this.userEvents = + new Resource$Projects$Locations$Collections$Datastores$Userevents( + this.context + ); + } + + /** + * Completes the specified user input with keyword suggestions. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + completeQuery( + params: Params$Resource$Projects$Locations$Collections$Datastores$Completequery, + options: StreamMethodOptions + ): GaxiosPromise; + completeQuery( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Completequery, + options?: MethodOptions + ): GaxiosPromise; + completeQuery( + params: Params$Resource$Projects$Locations$Collections$Datastores$Completequery, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + completeQuery( + params: Params$Resource$Projects$Locations$Collections$Datastores$Completequery, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + completeQuery( + params: Params$Resource$Projects$Locations$Collections$Datastores$Completequery, + callback: BodyResponseCallback + ): void; + completeQuery( + callback: BodyResponseCallback + ): void; + completeQuery( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Collections$Datastores$Completequery + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Completequery; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Collections$Datastores$Completequery; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta/{+dataStore}:completeQuery').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['dataStore'], + pathParams: ['dataStore'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * 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. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + create( + params: Params$Resource$Projects$Locations$Collections$Datastores$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Collections$Datastores$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Collections$Datastores$Create, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Collections$Datastores$Create, + callback: BodyResponseCallback + ): void; + create( + callback: BodyResponseCallback + ): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Collections$Datastores$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Collections$Datastores$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta/{+parent}/dataStores').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Deletes a DataStore. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Projects$Locations$Collections$Datastores$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Collections$Datastores$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Collections$Datastores$Delete, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Collections$Datastores$Delete, + callback: BodyResponseCallback + ): void; + delete( + callback: BodyResponseCallback + ): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Collections$Datastores$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Collections$Datastores$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets a DataStore. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Collections$Datastores$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Collections$Datastores$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Gets the SiteSearchEngine. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + getSiteSearchEngine( + params: Params$Resource$Projects$Locations$Collections$Datastores$Getsitesearchengine, + options: StreamMethodOptions + ): GaxiosPromise; + getSiteSearchEngine( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Getsitesearchengine, + options?: MethodOptions + ): GaxiosPromise; + getSiteSearchEngine( + params: Params$Resource$Projects$Locations$Collections$Datastores$Getsitesearchengine, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getSiteSearchEngine( + params: Params$Resource$Projects$Locations$Collections$Datastores$Getsitesearchengine, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getSiteSearchEngine( + params: Params$Resource$Projects$Locations$Collections$Datastores$Getsitesearchengine, + callback: BodyResponseCallback + ): void; + getSiteSearchEngine( + callback: BodyResponseCallback + ): void; + getSiteSearchEngine( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Collections$Datastores$Getsitesearchengine + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Getsitesearchengine; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Collections$Datastores$Getsitesearchengine; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Lists all the DataStores associated with the project. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Collections$Datastores$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Collections$Datastores$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Collections$Datastores$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Collections$Datastores$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta/{+parent}/dataStores').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Updates a DataStore + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + patch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Patch, + options: StreamMethodOptions + ): GaxiosPromise; + patch( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Patch, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Patch, + callback: BodyResponseCallback + ): void; + patch( + callback: BodyResponseCallback + ): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Collections$Datastores$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; - export class Resource$Projects { - context: APIRequestContext; - locations: Resource$Projects$Locations; - operations: Resource$Projects$Operations; - constructor(context: APIRequestContext) { - this.context = context; - this.locations = new Resource$Projects$Locations(this.context); - this.operations = new Resource$Projects$Operations(this.context); + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Collections$Datastores$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } } /** - * 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. + * Trains a custom model. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - provision( - params: Params$Resource$Projects$Provision, + trainCustomModel( + params: Params$Resource$Projects$Locations$Collections$Datastores$Traincustommodel, options: StreamMethodOptions ): GaxiosPromise; - provision( - params?: Params$Resource$Projects$Provision, + trainCustomModel( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Traincustommodel, options?: MethodOptions ): GaxiosPromise; - provision( - params: Params$Resource$Projects$Provision, + trainCustomModel( + params: Params$Resource$Projects$Locations$Collections$Datastores$Traincustommodel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - provision( - params: Params$Resource$Projects$Provision, + trainCustomModel( + params: Params$Resource$Projects$Locations$Collections$Datastores$Traincustommodel, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - provision( - params: Params$Resource$Projects$Provision, + trainCustomModel( + params: Params$Resource$Projects$Locations$Collections$Datastores$Traincustommodel, callback: BodyResponseCallback ): void; - provision( + trainCustomModel( callback: BodyResponseCallback ): void; - provision( + trainCustomModel( paramsOrCallback?: - | Params$Resource$Projects$Provision + | Params$Resource$Projects$Locations$Collections$Datastores$Traincustommodel | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -7105,12 +9520,13 @@ export namespace discoveryengine_v1beta { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Provision; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Traincustommodel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Provision; + params = + {} as Params$Resource$Projects$Locations$Collections$Datastores$Traincustommodel; options = {}; } @@ -7124,7 +9540,7 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+name}:provision').replace( + url: (rootUrl + '/v1beta/{+dataStore}:trainCustomModel').replace( /([^:]\/)\/+/g, '$1' ), @@ -7134,8 +9550,8 @@ export namespace discoveryengine_v1beta { options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['dataStore'], + pathParams: ['dataStore'], context: this.context, }; if (callback) { @@ -7149,150 +9565,201 @@ export namespace discoveryengine_v1beta { } } - export interface Params$Resource$Projects$Provision + export interface Params$Resource$Projects$Locations$Collections$Datastores$Completequery extends StandardParameters { /** - * Required. Full resource name of a Project, such as `projects/{project_id_or_number\}`. + * Required. The parent data store resource name for which the completion is performed, such as `projects/x/locations/global/collections/default_collection/dataStores/default_data_store`. */ - name?: string; + dataStore?: string; + /** + * 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. + */ + includeTailSuggestions?: boolean; + /** + * Required. The typeahead input used to fetch suggestions. Maximum length is 128 characters. + */ + query?: string; + /** + * Specifies the autocomplete data model. 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. + */ + queryModel?: string; + /** + * 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 SearchRequest.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. + */ + userPseudoId?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Create + extends StandardParameters { + /** + * A boolean flag indicating whether user want to directly create an advanced data store for site search. If the data store is not configured as site search (GENERIC vertical and PUBLIC_WEBSITE content_config), this flag will be ignored. + */ + createAdvancedSiteSearch?: boolean; + /** + * Required. The ID to use for the DataStore, which will become the final component of the DataStore's resource name. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned. + */ + dataStoreId?: string; + /** + * Required. The parent resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}`. + */ + parent?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1betaProvisionProjectRequest; + requestBody?: Schema$GoogleCloudDiscoveryengineV1betaDataStore; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Delete + extends StandardParameters { + /** + * Required. Full resource name of DataStore, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}`. If the caller does not have permission to delete the DataStore, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the DataStore to delete does not exist, a NOT_FOUND error is returned. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Get + extends StandardParameters { + /** + * Required. Full resource name of DataStore, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}`. If the caller does not have permission to access the DataStore, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested DataStore does not exist, a NOT_FOUND error is returned. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Getsitesearchengine + extends StandardParameters { + /** + * Required. Resource name of SiteSearchEngine, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine`. If the caller does not have permission to access the [SiteSearchEngine], regardless of whether or not it exists, a PERMISSION_DENIED error is returned. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$List + extends StandardParameters { + /** + * Filter by solution type . For example: `filter = 'solution_type:SOLUTION_TYPE_SEARCH'` + */ + filter?: string; + /** + * Maximum number of DataStores to return. If unspecified, defaults to 10. The maximum allowed value is 50. Values above 50 will be coerced to 50. If this field is negative, an INVALID_ARGUMENT is returned. + */ + pageSize?: number; + /** + * A page token ListDataStoresResponse.next_page_token, received from a previous DataStoreService.ListDataStores call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to DataStoreService.ListDataStores must match the call that provided the page token. Otherwise, an INVALID_ARGUMENT error is returned. + */ + pageToken?: string; + /** + * Required. The parent branch resource name, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}`. If the caller does not have permission to list DataStores under this location, regardless of whether or not this data store exists, a PERMISSION_DENIED error is returned. + */ + parent?: string; } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Patch + extends StandardParameters { + /** + * 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. + */ + name?: string; + /** + * Indicates which fields in the provided DataStore to update. If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned. + */ + updateMask?: string; - export class Resource$Projects$Locations { - context: APIRequestContext; - collections: Resource$Projects$Locations$Collections; - dataStores: Resource$Projects$Locations$Datastores; - groundingConfigs: Resource$Projects$Locations$Groundingconfigs; - operations: Resource$Projects$Locations$Operations; - rankingConfigs: Resource$Projects$Locations$Rankingconfigs; - userEvents: Resource$Projects$Locations$Userevents; - constructor(context: APIRequestContext) { - this.context = context; - this.collections = new Resource$Projects$Locations$Collections( - this.context - ); - this.dataStores = new Resource$Projects$Locations$Datastores( - this.context - ); - this.groundingConfigs = new Resource$Projects$Locations$Groundingconfigs( - this.context - ); - this.operations = new Resource$Projects$Locations$Operations( - this.context - ); - this.rankingConfigs = new Resource$Projects$Locations$Rankingconfigs( - this.context - ); - this.userEvents = new Resource$Projects$Locations$Userevents( - this.context - ); - } + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1betaDataStore; } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Traincustommodel + extends StandardParameters { + /** + * Required. The resource name of the Data Store, such as `projects/x/locations/global/collections/default_collection/dataStores/default_data_store`. This field is used to identify the data store where to train the models. + */ + dataStore?: string; - export class Resource$Projects$Locations$Collections { - context: APIRequestContext; - dataConnector: Resource$Projects$Locations$Collections$Dataconnector; - dataStores: Resource$Projects$Locations$Collections$Datastores; - engines: Resource$Projects$Locations$Collections$Engines; - operations: Resource$Projects$Locations$Collections$Operations; - constructor(context: APIRequestContext) { - this.context = context; - this.dataConnector = - new Resource$Projects$Locations$Collections$Dataconnector(this.context); - this.dataStores = new Resource$Projects$Locations$Collections$Datastores( - this.context - ); - this.engines = new Resource$Projects$Locations$Collections$Engines( - this.context - ); - this.operations = new Resource$Projects$Locations$Collections$Operations( - this.context - ); - } + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1betaTrainCustomModelRequest; } - export class Resource$Projects$Locations$Collections$Dataconnector { + export class Resource$Projects$Locations$Collections$Datastores$Branches { context: APIRequestContext; - operations: Resource$Projects$Locations$Collections$Dataconnector$Operations; + documents: Resource$Projects$Locations$Collections$Datastores$Branches$Documents; + operations: Resource$Projects$Locations$Collections$Datastores$Branches$Operations; constructor(context: APIRequestContext) { this.context = context; + this.documents = + new Resource$Projects$Locations$Collections$Datastores$Branches$Documents( + this.context + ); this.operations = - new Resource$Projects$Locations$Collections$Dataconnector$Operations( + new Resource$Projects$Locations$Collections$Datastores$Branches$Operations( this.context ); } } - export class Resource$Projects$Locations$Collections$Dataconnector$Operations { + export class Resource$Projects$Locations$Collections$Datastores$Branches$Documents { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * 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 Document. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$Get, + create( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Create, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$Get, + create( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Create, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$Get, + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$Get, + create( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Create, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$Get, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Create, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + create( + callback: BodyResponseCallback ): void; - get( + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$Get; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$Get; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Create; options = {}; } @@ -7306,285 +9773,182 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1beta/{+parent}/documents').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + * Deletes a Document. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$List, + delete( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Delete, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$List, + delete( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Delete, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$List, + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$List, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Delete, + callback: BodyResponseCallback ): void; - list( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://discoveryengine.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1beta/{+name}/operations').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest( - parameters - ); - } - } - } - - export interface Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$Get - extends StandardParameters { - /** - * The name of the operation resource. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$List - extends StandardParameters { - /** - * The standard list filter. - */ - filter?: string; - /** - * The name of the operation's parent resource. - */ - name?: string; - /** - * The standard list page size. - */ - pageSize?: number; - /** - * The standard list page token. - */ - pageToken?: string; - } - - export class Resource$Projects$Locations$Collections$Datastores { - context: APIRequestContext; - branches: Resource$Projects$Locations$Collections$Datastores$Branches; - completionSuggestions: Resource$Projects$Locations$Collections$Datastores$Completionsuggestions; - controls: Resource$Projects$Locations$Collections$Datastores$Controls; - conversations: Resource$Projects$Locations$Collections$Datastores$Conversations; - customModels: Resource$Projects$Locations$Collections$Datastores$Custommodels; - models: Resource$Projects$Locations$Collections$Datastores$Models; - operations: Resource$Projects$Locations$Collections$Datastores$Operations; - schemas: Resource$Projects$Locations$Collections$Datastores$Schemas; - servingConfigs: Resource$Projects$Locations$Collections$Datastores$Servingconfigs; - sessions: Resource$Projects$Locations$Collections$Datastores$Sessions; - siteSearchEngine: Resource$Projects$Locations$Collections$Datastores$Sitesearchengine; - suggestionDenyListEntries: Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries; - userEvents: Resource$Projects$Locations$Collections$Datastores$Userevents; - constructor(context: APIRequestContext) { - this.context = context; - this.branches = - new Resource$Projects$Locations$Collections$Datastores$Branches( - this.context - ); - this.completionSuggestions = - new Resource$Projects$Locations$Collections$Datastores$Completionsuggestions( - this.context - ); - this.controls = - new Resource$Projects$Locations$Collections$Datastores$Controls( - this.context - ); - this.conversations = - new Resource$Projects$Locations$Collections$Datastores$Conversations( - this.context - ); - this.customModels = - new Resource$Projects$Locations$Collections$Datastores$Custommodels( - this.context - ); - this.models = - new Resource$Projects$Locations$Collections$Datastores$Models( - this.context - ); - this.operations = - new Resource$Projects$Locations$Collections$Datastores$Operations( - this.context - ); - this.schemas = - new Resource$Projects$Locations$Collections$Datastores$Schemas( - this.context - ); - this.servingConfigs = - new Resource$Projects$Locations$Collections$Datastores$Servingconfigs( - this.context - ); - this.sessions = - new Resource$Projects$Locations$Collections$Datastores$Sessions( - this.context - ); - this.siteSearchEngine = - new Resource$Projects$Locations$Collections$Datastores$Sitesearchengine( - this.context - ); - this.suggestionDenyListEntries = - new Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries( - this.context - ); - this.userEvents = - new Resource$Projects$Locations$Collections$Datastores$Userevents( - this.context + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback ); + } else { + return createAPIRequest(parameters); + } } /** - * Completes the specified user input with keyword suggestions. + * Gets a Document. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - completeQuery( - params: Params$Resource$Projects$Locations$Collections$Datastores$Completequery, + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Get, options: StreamMethodOptions ): GaxiosPromise; - completeQuery( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Completequery, + get( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Get, options?: MethodOptions - ): GaxiosPromise; - completeQuery( - params: Params$Resource$Projects$Locations$Collections$Datastores$Completequery, + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - completeQuery( - params: Params$Resource$Projects$Locations$Collections$Datastores$Completequery, + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - completeQuery( - params: Params$Resource$Projects$Locations$Collections$Datastores$Completequery, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Get, + callback: BodyResponseCallback ): void; - completeQuery( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - completeQuery( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Completequery - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Completequery; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Completequery; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Get; options = {}; } @@ -7598,70 +9962,67 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+dataStore}:completeQuery').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['dataStore'], - pathParams: ['dataStore'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * 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. + * 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. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - create( - params: Params$Resource$Projects$Locations$Collections$Datastores$Create, + import( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Import, options: StreamMethodOptions ): GaxiosPromise; - create( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Create, + import( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Import, options?: MethodOptions ): GaxiosPromise; - create( - params: Params$Resource$Projects$Locations$Collections$Datastores$Create, + import( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Import, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Collections$Datastores$Create, + import( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Import, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Collections$Datastores$Create, + import( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Import, callback: BodyResponseCallback ): void; - create( + import( callback: BodyResponseCallback ): void; - create( + import( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Create + | Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Import | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -7677,13 +10038,13 @@ export namespace discoveryengine_v1beta { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Create; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Import; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Create; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Import; options = {}; } @@ -7697,7 +10058,7 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+parent}/dataStores').replace( + url: (rootUrl + '/v1beta/{+parent}/documents:import').replace( /([^:]\/)\/+/g, '$1' ), @@ -7722,65 +10083,65 @@ export namespace discoveryengine_v1beta { } /** - * Deletes a DataStore. + * Gets a list of Documents. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - delete( - params: Params$Resource$Projects$Locations$Collections$Datastores$Delete, + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$List, options: StreamMethodOptions ): GaxiosPromise; - delete( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Delete, + list( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$List, options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Projects$Locations$Collections$Datastores$Delete, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Collections$Datastores$Delete, + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Collections$Datastores$Delete, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$List, + callback: BodyResponseCallback ): void; - delete( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - delete( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Delete; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Delete; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$List; options = {}; } @@ -7794,87 +10155,92 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1beta/{+parent}/documents').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Gets a DataStore. + * Updates a Document. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Get, + patch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Patch, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Get, + patch( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Patch, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Get, + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Get, + patch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Patch, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Get, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Patch, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + patch( + callback: BodyResponseCallback ): void; - get( + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Get; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Get; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Patch; options = {}; } @@ -7889,7 +10255,7 @@ export namespace discoveryengine_v1beta { options: Object.assign( { url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'PATCH', apiVersion: '', }, options @@ -7900,77 +10266,77 @@ export namespace discoveryengine_v1beta { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Gets the SiteSearchEngine. + * 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. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - getSiteSearchEngine( - params: Params$Resource$Projects$Locations$Collections$Datastores$Getsitesearchengine, + purge( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Purge, options: StreamMethodOptions ): GaxiosPromise; - getSiteSearchEngine( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Getsitesearchengine, + purge( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Purge, options?: MethodOptions - ): GaxiosPromise; - getSiteSearchEngine( - params: Params$Resource$Projects$Locations$Collections$Datastores$Getsitesearchengine, + ): GaxiosPromise; + purge( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Purge, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - getSiteSearchEngine( - params: Params$Resource$Projects$Locations$Collections$Datastores$Getsitesearchengine, + purge( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Purge, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - getSiteSearchEngine( - params: Params$Resource$Projects$Locations$Collections$Datastores$Getsitesearchengine, - callback: BodyResponseCallback + purge( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Purge, + callback: BodyResponseCallback ): void; - getSiteSearchEngine( - callback: BodyResponseCallback + purge( + callback: BodyResponseCallback ): void; - getSiteSearchEngine( + purge( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Getsitesearchengine - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Purge + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Getsitesearchengine; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Purge; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Getsitesearchengine; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Purge; options = {}; } @@ -7984,89 +10350,183 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1beta/{+parent}/documents:purge').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Create + extends StandardParameters { /** - * Lists all the DataStores associated with the project. + * Required. The ID to use for the Document, which becomes the final component of the Document.name. If the caller does not have permission to create the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. This field must be unique among all Documents with the same parent. Otherwise, an `ALREADY_EXISTS` error is returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. + */ + documentId?: string; + /** + * Required. The parent resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}`. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1betaDocument; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Delete + extends StandardParameters { + /** + * Required. Full resource name of Document, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}/documents/{document\}`. If the caller does not have permission to delete the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the Document to delete does not exist, a `NOT_FOUND` error is returned. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Get + extends StandardParameters { + /** + * Required. Full resource name of Document, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}/documents/{document\}`. If the caller does not have permission to access the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the requested Document does not exist, a `NOT_FOUND` error is returned. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Import + extends StandardParameters { + /** + * Required. The parent branch resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}`. Requires create/update permission. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1betaImportDocumentsRequest; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$List + extends StandardParameters { + /** + * Maximum number of Documents to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 are set to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned. + */ + pageSize?: number; + /** + * A page token ListDocumentsResponse.next_page_token, received from a previous DocumentService.ListDocuments call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to DocumentService.ListDocuments must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned. + */ + pageToken?: string; + /** + * Required. The parent branch resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}`. Use `default_branch` as the branch ID, to list documents under the default branch. If the caller does not have permission to list Documents under this branch, regardless of whether or not this branch exists, a `PERMISSION_DENIED` error is returned. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Patch + extends StandardParameters { + /** + * If set to `true` and the Document is not found, a new Document is be created. + */ + allowMissing?: boolean; + /** + * 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?: string; + /** + * Indicates which fields in the provided imported 'document' to update. If not set, by default updates all fields. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1betaDocument; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Purge + extends StandardParameters { + /** + * Required. The parent resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}`. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1betaPurgeDocumentsRequest; + } + + export class Resource$Projects$Locations$Collections$Datastores$Branches$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * 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`. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$List, + cancel( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$Cancel, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Collections$Datastores$List, + cancel( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$Cancel, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$List, + ): GaxiosPromise; + cancel( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$List, - callback: BodyResponseCallback + cancel( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + cancel( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$Cancel, + callback: BodyResponseCallback ): void; - list( + cancel(callback: BodyResponseCallback): void; + cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$Cancel + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$List; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$List; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$Cancel; options = {}; } @@ -8080,92 +10540,90 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+parent}/dataStores').replace( + url: (rootUrl + '/v1beta/{+name}:cancel').replace( /([^:]\/)\/+/g, '$1' ), - method: 'GET', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Updates a DataStore + * 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. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - patch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Patch, + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$Get, options: StreamMethodOptions ): GaxiosPromise; - patch( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Patch, + get( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$Get, options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Patch, + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Patch, + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Patch, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$Get, + callback: BodyResponseCallback ): void; - patch( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - patch( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Patch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Patch; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Patch; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$Get; options = {}; } @@ -8180,7 +10638,7 @@ export namespace discoveryengine_v1beta { options: Object.assign( { url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + method: 'GET', apiVersion: '', }, options @@ -8191,77 +10649,75 @@ export namespace discoveryengine_v1beta { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Trains a custom model. + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - trainCustomModel( - params: Params$Resource$Projects$Locations$Collections$Datastores$Traincustommodel, + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$List, options: StreamMethodOptions ): GaxiosPromise; - trainCustomModel( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Traincustommodel, + list( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$List, options?: MethodOptions - ): GaxiosPromise; - trainCustomModel( - params: Params$Resource$Projects$Locations$Collections$Datastores$Traincustommodel, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - trainCustomModel( - params: Params$Resource$Projects$Locations$Collections$Datastores$Traincustommodel, + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - trainCustomModel( - params: Params$Resource$Projects$Locations$Collections$Datastores$Traincustommodel, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$List, + callback: BodyResponseCallback ): void; - trainCustomModel( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - trainCustomModel( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Traincustommodel - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Traincustommodel; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Traincustommodel; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$List; options = {}; } @@ -8275,226 +10731,138 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+dataStore}:trainCustomModel').replace( + url: (rootUrl + '/v1beta/{+name}/operations').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['dataStore'], - pathParams: ['dataStore'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Completequery - extends StandardParameters { - /** - * Required. The parent data store resource name for which the completion is performed, such as `projects/x/locations/global/collections/default_collection/dataStores/default_data_store`. - */ - dataStore?: string; - /** - * 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. - */ - includeTailSuggestions?: boolean; - /** - * Required. The typeahead input used to fetch suggestions. Maximum length is 128 characters. - */ - query?: string; - /** - * Specifies the autocomplete data model. 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. - */ - queryModel?: string; - /** - * 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 SearchRequest.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. - */ - userPseudoId?: string; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Create + export interface Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$Cancel extends StandardParameters { /** - * A boolean flag indicating whether user want to directly create an advanced data store for site search. If the data store is not configured as site search (GENERIC vertical and PUBLIC_WEBSITE content_config), this flag will be ignored. - */ - createAdvancedSiteSearch?: boolean; - /** - * Required. The ID to use for the DataStore, which will become the final component of the DataStore's resource name. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned. - */ - dataStoreId?: string; - /** - * Required. The parent resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}`. + * The name of the operation resource to be cancelled. */ - parent?: string; + name?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1betaDataStore; + requestBody?: Schema$GoogleLongrunningCancelOperationRequest; } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Delete + export interface Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$Get extends StandardParameters { /** - * Required. Full resource name of DataStore, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}`. If the caller does not have permission to delete the DataStore, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the DataStore to delete does not exist, a NOT_FOUND error is returned. + * The name of the operation resource. */ name?: string; } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Get + export interface Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$List extends StandardParameters { /** - * Required. Full resource name of DataStore, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}`. If the caller does not have permission to access the DataStore, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested DataStore does not exist, a NOT_FOUND error is returned. + * The standard list filter. */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Getsitesearchengine - extends StandardParameters { + filter?: string; /** - * Required. Resource name of SiteSearchEngine, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine`. If the caller does not have permission to access the [SiteSearchEngine], regardless of whether or not it exists, a PERMISSION_DENIED error is returned. + * The name of the operation's parent resource. */ name?: string; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$List - extends StandardParameters { - /** - * Filter by solution type . For example: `filter = 'solution_type:SOLUTION_TYPE_SEARCH'` - */ - filter?: string; /** - * Maximum number of DataStores to return. If unspecified, defaults to 10. The maximum allowed value is 50. Values above 50 will be coerced to 50. If this field is negative, an INVALID_ARGUMENT is returned. + * The standard list page size. */ pageSize?: number; /** - * A page token ListDataStoresResponse.next_page_token, received from a previous DataStoreService.ListDataStores call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to DataStoreService.ListDataStores must match the call that provided the page token. Otherwise, an INVALID_ARGUMENT error is returned. + * The standard list page token. */ pageToken?: string; - /** - * Required. The parent branch resource name, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}`. If the caller does not have permission to list DataStores under this location, regardless of whether or not this data store exists, a PERMISSION_DENIED error is returned. - */ - parent?: string; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Patch - extends StandardParameters { - /** - * 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. - */ - name?: string; - /** - * Indicates which fields in the provided DataStore to update. If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned. - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1betaDataStore; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Traincustommodel - extends StandardParameters { - /** - * Required. The resource name of the Data Store, such as `projects/x/locations/global/collections/default_collection/dataStores/default_data_store`. This field is used to identify the data store where to train the models. - */ - dataStore?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1betaTrainCustomModelRequest; - } - - export class Resource$Projects$Locations$Collections$Datastores$Branches { - context: APIRequestContext; - documents: Resource$Projects$Locations$Collections$Datastores$Branches$Documents; - operations: Resource$Projects$Locations$Collections$Datastores$Branches$Operations; - constructor(context: APIRequestContext) { - this.context = context; - this.documents = - new Resource$Projects$Locations$Collections$Datastores$Branches$Documents( - this.context - ); - this.operations = - new Resource$Projects$Locations$Collections$Datastores$Branches$Operations( - this.context - ); - } } - export class Resource$Projects$Locations$Collections$Datastores$Branches$Documents { + export class Resource$Projects$Locations$Collections$Datastores$Completionsuggestions { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * Creates a Document. + * Imports CompletionSuggestions for a DataStore. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - create( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Create, + import( + params: Params$Resource$Projects$Locations$Collections$Datastores$Completionsuggestions$Import, options: StreamMethodOptions ): GaxiosPromise; - create( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Create, + import( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Completionsuggestions$Import, options?: MethodOptions - ): GaxiosPromise; - create( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Create, + ): GaxiosPromise; + import( + params: Params$Resource$Projects$Locations$Collections$Datastores$Completionsuggestions$Import, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Create, + import( + params: Params$Resource$Projects$Locations$Collections$Datastores$Completionsuggestions$Import, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Create, - callback: BodyResponseCallback + import( + params: Params$Resource$Projects$Locations$Collections$Datastores$Completionsuggestions$Import, + callback: BodyResponseCallback ): void; - create( - callback: BodyResponseCallback + import( + callback: BodyResponseCallback ): void; - create( + import( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Completionsuggestions$Import + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Create; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Completionsuggestions$Import; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Create; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Completionsuggestions$Import; options = {}; } @@ -8508,10 +10876,9 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+parent}/documents').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: ( + rootUrl + '/v1beta/{+parent}/completionSuggestions:import' + ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', }, @@ -8523,73 +10890,75 @@ export namespace discoveryengine_v1beta { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Deletes a Document. + * Permanently deletes all CompletionSuggestions for a DataStore. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - delete( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Delete, + purge( + params: Params$Resource$Projects$Locations$Collections$Datastores$Completionsuggestions$Purge, options: StreamMethodOptions ): GaxiosPromise; - delete( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Delete, + purge( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Completionsuggestions$Purge, options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Delete, + ): GaxiosPromise; + purge( + params: Params$Resource$Projects$Locations$Collections$Datastores$Completionsuggestions$Purge, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + purge( + params: Params$Resource$Projects$Locations$Collections$Datastores$Completionsuggestions$Purge, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Delete, - callback: BodyResponseCallback + purge( + params: Params$Resource$Projects$Locations$Collections$Datastores$Completionsuggestions$Purge, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + purge( + callback: BodyResponseCallback + ): void; + purge( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Completionsuggestions$Purge + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Delete; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Completionsuggestions$Purge; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Delete; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Completionsuggestions$Purge; options = {}; } @@ -8603,87 +10972,121 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: ( + rootUrl + '/v1beta/{+parent}/completionSuggestions:purge' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } + } + + export interface Params$Resource$Projects$Locations$Collections$Datastores$Completionsuggestions$Import + extends StandardParameters { + /** + * Required. The parent data store resource name for which to import customer autocomplete suggestions. Follows pattern `projects/x/locations/x/collections/x/dataStores/x` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1betaImportCompletionSuggestionsRequest; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Completionsuggestions$Purge + extends StandardParameters { + /** + * Required. The parent data store resource name for which to purge completion suggestions. Follows pattern projects/x/locations/x/collections/x/dataStores/x. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1betaPurgeCompletionSuggestionsRequest; + } + + export class Resource$Projects$Locations$Collections$Datastores$Controls { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } /** - * Gets a Document. + * 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. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Get, + create( + params: Params$Resource$Projects$Locations$Collections$Datastores$Controls$Create, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Get, + create( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Controls$Create, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Get, + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Collections$Datastores$Controls$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Get, + create( + params: Params$Resource$Projects$Locations$Collections$Datastores$Controls$Create, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Get, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Collections$Datastores$Controls$Create, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + create( + callback: BodyResponseCallback ): void; - get( + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Controls$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Get; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Controls$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Get; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Controls$Create; options = {}; } @@ -8697,89 +11100,88 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1beta/{+parent}/controls').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * 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. + * Deletes a Control. If the Control to delete does not exist, a NOT_FOUND error is returned. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - import( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Import, + delete( + params: Params$Resource$Projects$Locations$Collections$Datastores$Controls$Delete, options: StreamMethodOptions ): GaxiosPromise; - import( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Import, + delete( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Controls$Delete, options?: MethodOptions - ): GaxiosPromise; - import( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Import, + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Collections$Datastores$Controls$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - import( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Import, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - import( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Import, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Collections$Datastores$Controls$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - import( - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Collections$Datastores$Controls$Delete, + callback: BodyResponseCallback ): void; - import( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Import - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Controls$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Import; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Controls$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Import; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Controls$Delete; options = {}; } @@ -8793,90 +11195,87 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+parent}/documents:import').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Gets a list of Documents. + * Gets a Control. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$List, + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Controls$Get, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$List, + get( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Controls$Get, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$List, + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Controls$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$List, + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Controls$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$List, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Controls$Get, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - list( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Controls$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$List; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Controls$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$List; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Controls$Get; options = {}; } @@ -8890,92 +11289,89 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+parent}/documents').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Updates a Document. + * Lists all Controls by their parent DataStore. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - patch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Patch, + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Controls$List, options: StreamMethodOptions ): GaxiosPromise; - patch( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Patch, + list( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Controls$List, options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Patch, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Controls$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Patch, + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Controls$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Patch, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Controls$List, + callback: BodyResponseCallback ): void; - patch( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - patch( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Patch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Controls$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Patch; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Controls$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Patch; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Controls$List; options = {}; } @@ -8989,89 +11385,92 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + url: (rootUrl + '/v1beta/{+parent}/controls').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * 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. + * Updates a Control. Control action type cannot be changed. If the Control to update does not exist, a NOT_FOUND error is returned. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - purge( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Purge, + patch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Controls$Patch, options: StreamMethodOptions ): GaxiosPromise; - purge( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Purge, + patch( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Controls$Patch, options?: MethodOptions - ): GaxiosPromise; - purge( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Purge, + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Controls$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - purge( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Purge, + patch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Controls$Patch, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - purge( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Purge, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Controls$Patch, + callback: BodyResponseCallback ): void; - purge( - callback: BodyResponseCallback + patch( + callback: BodyResponseCallback ): void; - purge( + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Purge - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Controls$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Purge; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Controls$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Purge; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Controls$Patch; options = {}; } @@ -9085,183 +11484,162 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+parent}/documents:purge').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Create + export interface Params$Resource$Projects$Locations$Collections$Datastores$Controls$Create extends StandardParameters { /** - * Required. The ID to use for the Document, which becomes the final component of the Document.name. If the caller does not have permission to create the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. This field must be unique among all Documents with the same parent. Otherwise, an `ALREADY_EXISTS` error is returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. + * Required. The ID to use for the Control, which will become the final component of the Control's resource name. This value must be within 1-63 characters. Valid characters are /a-z-_/. */ - documentId?: string; + controlId?: string; /** - * Required. The parent resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}`. + * Required. Full resource name of parent data store. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/dataStores/{data_store_id\}` or `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/engines/{engine_id\}`. */ parent?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1betaDocument; + requestBody?: Schema$GoogleCloudDiscoveryengineV1betaControl; } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Delete + export interface Params$Resource$Projects$Locations$Collections$Datastores$Controls$Delete extends StandardParameters { /** - * Required. Full resource name of Document, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}/documents/{document\}`. If the caller does not have permission to delete the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the Document to delete does not exist, a `NOT_FOUND` error is returned. + * Required. The resource name of the Control to delete. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/dataStores/{data_store_id\}/controls/{control_id\}` */ name?: string; } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Get + export interface Params$Resource$Projects$Locations$Collections$Datastores$Controls$Get extends StandardParameters { /** - * Required. Full resource name of Document, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}/documents/{document\}`. If the caller does not have permission to access the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the requested Document does not exist, a `NOT_FOUND` error is returned. + * Required. The resource name of the Control to get. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/dataStores/{data_store_id\}/controls/{control_id\}` */ name?: string; } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Import + export interface Params$Resource$Projects$Locations$Collections$Datastores$Controls$List extends StandardParameters { /** - * Required. The parent branch resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}`. Requires create/update permission. - */ - parent?: string; - - /** - * Request body metadata + * Optional. A filter to apply on the list results. Supported features: * List all the products under the parent branch if filter is unset. Currently this field is unsupported. */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1betaImportDocumentsRequest; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$List - extends StandardParameters { + filter?: string; /** - * Maximum number of Documents to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 are set to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned. + * Optional. Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000. */ pageSize?: number; /** - * A page token ListDocumentsResponse.next_page_token, received from a previous DocumentService.ListDocuments call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to DocumentService.ListDocuments must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned. + * Optional. A page token, received from a previous `ListControls` call. Provide this to retrieve the subsequent page. */ pageToken?: string; /** - * Required. The parent branch resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}`. Use `default_branch` as the branch ID, to list documents under the default branch. If the caller does not have permission to list Documents under this branch, regardless of whether or not this branch exists, a `PERMISSION_DENIED` error is returned. + * Required. The data store resource name. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/dataStores/{data_store_id\}` or `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/engines/{engine_id\}`. */ parent?: string; } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Patch + export interface Params$Resource$Projects$Locations$Collections$Datastores$Controls$Patch extends StandardParameters { /** - * If set to `true` and the Document is not found, a new Document is be created. - */ - allowMissing?: boolean; - /** - * 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. + * Immutable. Fully qualified name `projects/x/locations/global/dataStore/x/controls/x` */ name?: string; /** - * Indicates which fields in the provided imported 'document' to update. If not set, by default updates all fields. - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1betaDocument; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Purge - extends StandardParameters { - /** - * Required. The parent resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}`. + * Optional. Indicates which fields in the provided Control to update. The following are NOT supported: * Control.name * Control.solution_type If not set or empty, all supported fields are updated. */ - parent?: string; + updateMask?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1betaPurgeDocumentsRequest; + requestBody?: Schema$GoogleCloudDiscoveryengineV1betaControl; } - export class Resource$Projects$Locations$Collections$Datastores$Branches$Operations { + export class Resource$Projects$Locations$Collections$Datastores$Conversations { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * 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`. + * Converses a conversation. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - cancel( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$Cancel, + converse( + params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Converse, options: StreamMethodOptions ): GaxiosPromise; - cancel( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$Cancel, + converse( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Converse, options?: MethodOptions - ): GaxiosPromise; - cancel( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$Cancel, + ): GaxiosPromise; + converse( + params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Converse, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$Cancel, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + converse( + params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Converse, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$Cancel, - callback: BodyResponseCallback + converse( + params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Converse, + callback: BodyResponseCallback ): void; - cancel(callback: BodyResponseCallback): void; - cancel( + converse( + callback: BodyResponseCallback + ): void; + converse( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$Cancel - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Converse + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$Cancel; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Converse; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$Cancel; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Converse; options = {}; } @@ -9275,7 +11653,7 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+name}:cancel').replace( + url: (rootUrl + '/v1beta/{+name}:converse').replace( /([^:]\/)\/+/g, '$1' ), @@ -9290,75 +11668,172 @@ export namespace discoveryengine_v1beta { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * 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 Conversation. If the Conversation to create already exists, an ALREADY_EXISTS error is returned. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$Get, + create( + params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Create, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$Get, + create( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Create, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$Get, + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$Get, + create( + params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Create, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$Get, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Create, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + create( + callback: BodyResponseCallback ): void; - get( + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$Get; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$Get; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta/{+parent}/conversations').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Deletes a Conversation. If the Conversation to delete does not exist, a NOT_FOUND error is returned. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Delete; options = {}; } @@ -9373,7 +11848,7 @@ export namespace discoveryengine_v1beta { options: Object.assign( { url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'DELETE', apiVersion: '', }, options @@ -9384,75 +11859,75 @@ export namespace discoveryengine_v1beta { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + * Gets a Conversation. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$List, + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Get, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$List, + get( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Get, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$List, + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$List, + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$List, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Get, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - list( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$List; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$List; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Get; options = {}; } @@ -9466,10 +11941,7 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+name}/operations').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', }, @@ -9481,123 +11953,77 @@ export namespace discoveryengine_v1beta { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } - } - - export interface Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$Cancel - extends StandardParameters { - /** - * The name of the operation resource to be cancelled. - */ - name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleLongrunningCancelOperationRequest; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$Get - extends StandardParameters { - /** - * The name of the operation resource. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$List - extends StandardParameters { - /** - * The standard list filter. - */ - filter?: string; - /** - * The name of the operation's parent resource. - */ - name?: string; - /** - * The standard list page size. - */ - pageSize?: number; - /** - * The standard list page token. - */ - pageToken?: string; - } - - export class Resource$Projects$Locations$Collections$Datastores$Completionsuggestions { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Imports CompletionSuggestions for a DataStore. + * Lists all Conversations by their parent DataStore. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - import( - params: Params$Resource$Projects$Locations$Collections$Datastores$Completionsuggestions$Import, + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$List, options: StreamMethodOptions ): GaxiosPromise; - import( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Completionsuggestions$Import, + list( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$List, options?: MethodOptions - ): GaxiosPromise; - import( - params: Params$Resource$Projects$Locations$Collections$Datastores$Completionsuggestions$Import, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - import( - params: Params$Resource$Projects$Locations$Collections$Datastores$Completionsuggestions$Import, + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - import( - params: Params$Resource$Projects$Locations$Collections$Datastores$Completionsuggestions$Import, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$List, + callback: BodyResponseCallback ): void; - import( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - import( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Completionsuggestions$Import - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Conversations$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Completionsuggestions$Import; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Conversations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Completionsuggestions$Import; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Conversations$List; options = {}; } @@ -9611,10 +12037,11 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: ( - rootUrl + '/v1beta/{+parent}/completionSuggestions:import' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + url: (rootUrl + '/v1beta/{+parent}/conversations').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', apiVersion: '', }, options @@ -9625,75 +12052,77 @@ export namespace discoveryengine_v1beta { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Permanently deletes all CompletionSuggestions for a DataStore. + * Updates a Conversation. Conversation action type cannot be changed. If the Conversation to update does not exist, a NOT_FOUND error is returned. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - purge( - params: Params$Resource$Projects$Locations$Collections$Datastores$Completionsuggestions$Purge, + patch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Patch, options: StreamMethodOptions ): GaxiosPromise; - purge( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Completionsuggestions$Purge, + patch( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Patch, options?: MethodOptions - ): GaxiosPromise; - purge( - params: Params$Resource$Projects$Locations$Collections$Datastores$Completionsuggestions$Purge, + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - purge( - params: Params$Resource$Projects$Locations$Collections$Datastores$Completionsuggestions$Purge, + patch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Patch, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - purge( - params: Params$Resource$Projects$Locations$Collections$Datastores$Completionsuggestions$Purge, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Patch, + callback: BodyResponseCallback ): void; - purge( - callback: BodyResponseCallback + patch( + callback: BodyResponseCallback ): void; - purge( + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Completionsuggestions$Purge - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Completionsuggestions$Purge; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Completionsuggestions$Purge; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Patch; options = {}; } @@ -9707,121 +12136,174 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: ( - rootUrl + '/v1beta/{+parent}/completionSuggestions:purge' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Completionsuggestions$Import + export interface Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Converse extends StandardParameters { /** - * Required. The parent data store resource name for which to import customer autocomplete suggestions. Follows pattern `projects/x/locations/x/collections/x/dataStores/x` + * Required. The resource name of the Conversation to get. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/{conversation_id\}`. Use `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/-` to activate auto session mode, which automatically creates a new conversation inside a ConverseConversation session. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1betaConverseConversationRequest; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Create + extends StandardParameters { + /** + * Required. Full resource name of parent data store. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}` */ parent?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1betaImportCompletionSuggestionsRequest; + requestBody?: Schema$GoogleCloudDiscoveryengineV1betaConversation; } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Completionsuggestions$Purge + export interface Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Delete + extends StandardParameters { + /** + * Required. The resource name of the Conversation to delete. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/{conversation_id\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Get extends StandardParameters { /** - * Required. The parent data store resource name for which to purge completion suggestions. Follows pattern projects/x/locations/x/collections/x/dataStores/x. + * Required. The resource name of the Conversation to get. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/{conversation_id\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Conversations$List + extends StandardParameters { + /** + * A filter to apply on the list results. The supported features are: user_pseudo_id, state. Example: "user_pseudo_id = some_id" + */ + filter?: string; + /** + * 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` * `conversation_name` Example: "update_time desc" "create_time" + */ + orderBy?: string; + /** + * Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000. + */ + pageSize?: number; + /** + * A page token, received from a previous `ListConversations` call. Provide this to retrieve the subsequent page. + */ + pageToken?: string; + /** + * Required. The data store resource name. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}` + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Patch + extends StandardParameters { + /** + * Immutable. Fully qualified name `projects/{project\}/locations/global/collections/{collection\}/dataStore/x/conversations/x` or `projects/{project\}/locations/global/collections/{collection\}/engines/x/conversations/x`. + */ + name?: string; + /** + * Indicates which fields in the provided Conversation to update. The following are NOT supported: * Conversation.name If not set or empty, all supported fields are updated. */ - parent?: string; + updateMask?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1betaPurgeCompletionSuggestionsRequest; + requestBody?: Schema$GoogleCloudDiscoveryengineV1betaConversation; } - export class Resource$Projects$Locations$Collections$Datastores$Controls { + export class Resource$Projects$Locations$Collections$Datastores$Custommodels { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * 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. + * Gets a list of all the custom models. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - create( - params: Params$Resource$Projects$Locations$Collections$Datastores$Controls$Create, + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Custommodels$List, options: StreamMethodOptions ): GaxiosPromise; - create( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Controls$Create, + list( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Custommodels$List, options?: MethodOptions - ): GaxiosPromise; - create( - params: Params$Resource$Projects$Locations$Collections$Datastores$Controls$Create, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Custommodels$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Collections$Datastores$Controls$Create, + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Custommodels$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Collections$Datastores$Controls$Create, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Custommodels$List, + callback: BodyResponseCallback ): void; - create( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - create( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Controls$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Custommodels$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Controls$Create; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Custommodels$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Controls$Create; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Custommodels$List; options = {}; } @@ -9835,124 +12317,61 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+parent}/controls').replace( + url: (rootUrl + '/v1beta/{+dataStore}/customModels').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['dataStore'], + pathParams: ['dataStore'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Custommodels$List + extends StandardParameters { /** - * Deletes a Control. If the Control to delete does not exist, a NOT_FOUND error is returned. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. + * Required. The resource name of the parent Data Store, such as `projects/x/locations/global/collections/default_collection/dataStores/default_data_store`. This field is used to identify the data store where to fetch the models from. */ - delete( - params: Params$Resource$Projects$Locations$Collections$Datastores$Controls$Delete, - options: StreamMethodOptions - ): GaxiosPromise; - delete( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Controls$Delete, - options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Projects$Locations$Collections$Datastores$Controls$Delete, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Projects$Locations$Collections$Datastores$Controls$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Projects$Locations$Collections$Datastores$Controls$Delete, - callback: BodyResponseCallback - ): void; - delete(callback: BodyResponseCallback): void; - delete( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Controls$Delete - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Controls$Delete; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Controls$Delete; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } + dataStore?: string; + } - const rootUrl = - options.rootUrl || 'https://discoveryengine.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback + export class Resource$Projects$Locations$Collections$Datastores$Models { + context: APIRequestContext; + operations: Resource$Projects$Locations$Collections$Datastores$Models$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.operations = + new Resource$Projects$Locations$Collections$Datastores$Models$Operations( + this.context ); - } else { - return createAPIRequest(parameters); - } + } + } + + export class Resource$Projects$Locations$Collections$Datastores$Models$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; } /** - * Gets a Control. + * 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. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -9960,57 +12379,57 @@ export namespace discoveryengine_v1beta { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Controls$Get, + params: Params$Resource$Projects$Locations$Collections$Datastores$Models$Operations$Get, options: StreamMethodOptions ): GaxiosPromise; get( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Controls$Get, + params?: Params$Resource$Projects$Locations$Collections$Datastores$Models$Operations$Get, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Controls$Get, + params: Params$Resource$Projects$Locations$Collections$Datastores$Models$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Controls$Get, + params: Params$Resource$Projects$Locations$Collections$Datastores$Models$Operations$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Controls$Get, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Collections$Datastores$Models$Operations$Get, + callback: BodyResponseCallback ): void; get( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Controls$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Models$Operations$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Controls$Get; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Models$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Controls$Get; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Models$Operations$Get; options = {}; } @@ -10036,19 +12455,17 @@ export namespace discoveryengine_v1beta { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Lists all Controls by their parent DataStore. + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -10056,57 +12473,57 @@ export namespace discoveryengine_v1beta { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Controls$List, + params: Params$Resource$Projects$Locations$Collections$Datastores$Models$Operations$List, options: StreamMethodOptions ): GaxiosPromise; list( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Controls$List, + params?: Params$Resource$Projects$Locations$Collections$Datastores$Models$Operations$List, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Controls$List, + params: Params$Resource$Projects$Locations$Collections$Datastores$Models$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Controls$List, + params: Params$Resource$Projects$Locations$Collections$Datastores$Models$Operations$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Controls$List, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Collections$Datastores$Models$Operations$List, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Controls$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Models$Operations$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Controls$List; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Models$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Controls$List; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Models$Operations$List; options = {}; } @@ -10120,7 +12537,7 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+parent}/controls').replace( + url: (rootUrl + '/v1beta/{+name}/operations').replace( /([^:]\/)\/+/g, '$1' ), @@ -10130,82 +12547,116 @@ export namespace discoveryengine_v1beta { options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Models$Operations$Get + extends StandardParameters { /** - * Updates a Control. Control action type cannot be changed. If the Control to update does not exist, a NOT_FOUND error is returned. + * The name of the operation resource. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Models$Operations$List + extends StandardParameters { + /** + * The standard list filter. + */ + filter?: string; + /** + * The name of the operation's parent resource. + */ + name?: string; + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. + */ + pageToken?: string; + } + + export class Resource$Projects$Locations$Collections$Datastores$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * 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. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - patch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Controls$Patch, + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Operations$Get, options: StreamMethodOptions ): GaxiosPromise; - patch( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Controls$Patch, + get( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Operations$Get, options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Controls$Patch, + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Controls$Patch, + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Operations$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Controls$Patch, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Operations$Get, + callback: BodyResponseCallback ): void; - patch( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - patch( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Controls$Patch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Operations$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Controls$Patch; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Controls$Patch; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Operations$Get; options = {}; } @@ -10220,7 +12671,7 @@ export namespace discoveryengine_v1beta { options: Object.assign( { url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + method: 'GET', apiVersion: '', }, options @@ -10231,150 +12682,75 @@ export namespace discoveryengine_v1beta { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Projects$Locations$Collections$Datastores$Controls$Create - extends StandardParameters { - /** - * Required. The ID to use for the Control, which will become the final component of the Control's resource name. This value must be within 1-63 characters. Valid characters are /a-z-_/. - */ - controlId?: string; - /** - * Required. Full resource name of parent data store. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/dataStores/{data_store_id\}` or `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/engines/{engine_id\}`. - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1betaControl; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Controls$Delete - extends StandardParameters { - /** - * Required. The resource name of the Control to delete. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/dataStores/{data_store_id\}/controls/{control_id\}` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Controls$Get - extends StandardParameters { - /** - * Required. The resource name of the Control to get. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/dataStores/{data_store_id\}/controls/{control_id\}` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Controls$List - extends StandardParameters { - /** - * Optional. A filter to apply on the list results. Supported features: * List all the products under the parent branch if filter is unset. Currently this field is unsupported. - */ - filter?: string; - /** - * Optional. Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000. - */ - pageSize?: number; - /** - * Optional. A page token, received from a previous `ListControls` call. Provide this to retrieve the subsequent page. - */ - pageToken?: string; - /** - * Required. The data store resource name. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/dataStores/{data_store_id\}` or `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/engines/{engine_id\}`. - */ - parent?: string; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Controls$Patch - extends StandardParameters { - /** - * Immutable. Fully qualified name `projects/x/locations/global/dataStore/x/controls/x` - */ - name?: string; - /** - * Optional. Indicates which fields in the provided Control to update. The following are NOT supported: * Control.name * Control.solution_type If not set or empty, all supported fields are updated. - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1betaControl; - } - - export class Resource$Projects$Locations$Collections$Datastores$Conversations { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Converses a conversation. + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - converse( - params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Converse, + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Operations$List, options: StreamMethodOptions ): GaxiosPromise; - converse( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Converse, + list( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Operations$List, options?: MethodOptions - ): GaxiosPromise; - converse( - params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Converse, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - converse( - params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Converse, + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Operations$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - converse( - params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Converse, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Operations$List, + callback: BodyResponseCallback ): void; - converse( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - converse( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Converse - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Operations$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Converse; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Converse; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Operations$List; options = {}; } @@ -10388,11 +12764,11 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+name}:converse').replace( + url: (rootUrl + '/v1beta/{+name}/operations').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', apiVersion: '', }, options @@ -10403,19 +12779,58 @@ export namespace discoveryengine_v1beta { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); - } + } + } + } + + export interface Params$Resource$Projects$Locations$Collections$Datastores$Operations$Get + extends StandardParameters { + /** + * The name of the operation resource. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Operations$List + extends StandardParameters { + /** + * The standard list filter. + */ + filter?: string; + /** + * The name of the operation's parent resource. + */ + name?: string; + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. + */ + pageToken?: string; + } + + export class Resource$Projects$Locations$Collections$Datastores$Schemas { + context: APIRequestContext; + operations: Resource$Projects$Locations$Collections$Datastores$Schemas$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.operations = + new Resource$Projects$Locations$Collections$Datastores$Schemas$Operations( + this.context + ); } /** - * Creates a Conversation. If the Conversation to create already exists, an ALREADY_EXISTS error is returned. + * Creates a Schema. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -10423,57 +12838,57 @@ export namespace discoveryengine_v1beta { * @returns A promise if used with async/await, or void if used with a callback. */ create( - params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Create, + params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Create, options: StreamMethodOptions ): GaxiosPromise; create( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Create, + params?: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Create, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; create( - params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Create, + params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; create( - params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Create, + params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Create, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; create( - params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Create, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Create, + callback: BodyResponseCallback ): void; create( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Create; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Create; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Create; options = {}; } @@ -10487,7 +12902,7 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+parent}/conversations').replace( + url: (rootUrl + '/v1beta/{+parent}/schemas').replace( /([^:]\/)\/+/g, '$1' ), @@ -10502,19 +12917,17 @@ export namespace discoveryengine_v1beta { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Deletes a Conversation. If the Conversation to delete does not exist, a NOT_FOUND error is returned. + * Deletes a Schema. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -10522,53 +12935,57 @@ export namespace discoveryengine_v1beta { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Delete, + params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Delete, options: StreamMethodOptions ): GaxiosPromise; delete( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Delete, + params?: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Delete, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; delete( - params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Delete, + params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Delete, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Delete, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Delete, + callback: BodyResponseCallback + ): void; + delete( + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Delete; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Delete; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Delete; options = {}; } @@ -10594,17 +13011,17 @@ export namespace discoveryengine_v1beta { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Gets a Conversation. + * Gets a Schema. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -10612,57 +13029,57 @@ export namespace discoveryengine_v1beta { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Get, + params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Get, options: StreamMethodOptions ): GaxiosPromise; get( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Get, + params?: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Get, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Get, + params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Get, + params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Get, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Get, + callback: BodyResponseCallback ): void; get( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Get; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Get; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Get; options = {}; } @@ -10688,19 +13105,19 @@ export namespace discoveryengine_v1beta { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Lists all Conversations by their parent DataStore. + * Gets a list of Schemas. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -10708,57 +13125,57 @@ export namespace discoveryengine_v1beta { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$List, + params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$List, options: StreamMethodOptions ): GaxiosPromise; list( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$List, + params?: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$List, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$List, + params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$List, + params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$List, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$List, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Conversations$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Schemas$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Conversations$List; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Schemas$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Conversations$List; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Schemas$List; options = {}; } @@ -10772,7 +13189,7 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+parent}/conversations').replace( + url: (rootUrl + '/v1beta/{+parent}/schemas').replace( /([^:]\/)\/+/g, '$1' ), @@ -10787,19 +13204,19 @@ export namespace discoveryengine_v1beta { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Updates a Conversation. Conversation action type cannot be changed. If the Conversation to update does not exist, a NOT_FOUND error is returned. + * Updates a Schema. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -10807,57 +13224,57 @@ export namespace discoveryengine_v1beta { * @returns A promise if used with async/await, or void if used with a callback. */ patch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Patch, + params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Patch, options: StreamMethodOptions ): GaxiosPromise; patch( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Patch, + params?: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Patch, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; patch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Patch, + params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; patch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Patch, + params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Patch, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; patch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Patch, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Patch, + callback: BodyResponseCallback ): void; patch( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Patch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Patch; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Patch; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Patch; options = {}; } @@ -10883,162 +13300,144 @@ export namespace discoveryengine_v1beta { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Converse + export interface Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Create extends StandardParameters { /** - * Required. The resource name of the Conversation to get. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/{conversation_id\}`. Use `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/-` to activate auto session mode, which automatically creates a new conversation inside a ConverseConversation session. - */ - name?: string; - - /** - * Request body metadata + * Required. The parent data store resource name, in the format of `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}`. */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1betaConverseConversationRequest; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Create - extends StandardParameters { + parent?: string; /** - * Required. Full resource name of parent data store. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}` + * Required. The ID to use for the Schema, which becomes the final component of the Schema.name. This field should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. */ - parent?: string; + schemaId?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1betaConversation; + requestBody?: Schema$GoogleCloudDiscoveryengineV1betaSchema; } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Delete + export interface Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Delete extends StandardParameters { /** - * Required. The resource name of the Conversation to delete. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/{conversation_id\}` + * Required. The full resource name of the schema, in the format of `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/schemas/{schema\}`. */ name?: string; } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Get + export interface Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Get extends StandardParameters { /** - * Required. The resource name of the Conversation to get. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/{conversation_id\}` + * Required. The full resource name of the schema, in the format of `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/schemas/{schema\}`. */ name?: string; } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Conversations$List + export interface Params$Resource$Projects$Locations$Collections$Datastores$Schemas$List extends StandardParameters { /** - * A filter to apply on the list results. The supported features are: user_pseudo_id, state. Example: "user_pseudo_id = some_id" - */ - filter?: string; - /** - * 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` * `conversation_name` Example: "update_time desc" "create_time" - */ - orderBy?: string; - /** - * Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000. + * The maximum number of Schemas to return. The service may return fewer than this value. If unspecified, at most 100 Schemas are returned. The maximum value is 1000; values above 1000 are set to 1000. */ pageSize?: number; /** - * A page token, received from a previous `ListConversations` call. Provide this to retrieve the subsequent page. + * A page token, received from a previous SchemaService.ListSchemas call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SchemaService.ListSchemas must match the call that provided the page token. */ pageToken?: string; /** - * Required. The data store resource name. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}` + * Required. The parent data store resource name, in the format of `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}`. */ parent?: string; } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Patch + export interface Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Patch extends StandardParameters { /** - * Immutable. Fully qualified name `projects/{project\}/locations/global/collections/{collection\}/dataStore/x/conversations/x` or `projects/{project\}/locations/global/collections/{collection\}/engines/x/conversations/x`. + * If set to true, and the Schema is not found, a new Schema is created. In this situation, `update_mask` is ignored. */ - name?: string; + allowMissing?: boolean; /** - * Indicates which fields in the provided Conversation to update. The following are NOT supported: * Conversation.name If not set or empty, all supported fields are updated. + * 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. */ - updateMask?: string; + name?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1betaConversation; + requestBody?: Schema$GoogleCloudDiscoveryengineV1betaSchema; } - export class Resource$Projects$Locations$Collections$Datastores$Custommodels { + export class Resource$Projects$Locations$Collections$Datastores$Schemas$Operations { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * Gets a list of all the custom models. + * 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. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Custommodels$List, + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Operations$Get, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Custommodels$List, + get( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Operations$Get, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Custommodels$List, + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Custommodels$List, + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Operations$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Custommodels$List, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Operations$Get, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - list( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Custommodels$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Operations$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Custommodels$List; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Custommodels$List; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Operations$Get; options = {}; } @@ -11052,119 +13451,87 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+dataStore}/customModels').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['dataStore'], - pathParams: ['dataStore'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Projects$Locations$Collections$Datastores$Custommodels$List - extends StandardParameters { - /** - * Required. The resource name of the parent Data Store, such as `projects/x/locations/global/collections/default_collection/dataStores/default_data_store`. This field is used to identify the data store where to fetch the models from. - */ - dataStore?: string; - } - - export class Resource$Projects$Locations$Collections$Datastores$Models { - context: APIRequestContext; - operations: Resource$Projects$Locations$Collections$Datastores$Models$Operations; - constructor(context: APIRequestContext) { - this.context = context; - this.operations = - new Resource$Projects$Locations$Collections$Datastores$Models$Operations( - this.context - ); - } - } - - export class Resource$Projects$Locations$Collections$Datastores$Models$Operations { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * 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. + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Models$Operations$Get, + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Operations$List, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Models$Operations$Get, + list( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Operations$List, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Models$Operations$Get, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Models$Operations$Get, + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Operations$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Models$Operations$Get, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Operations$List, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - get( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Models$Operations$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Operations$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Models$Operations$Get; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Models$Operations$Get; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Operations$List; options = {}; } @@ -11178,7 +13545,10 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1beta/{+name}/operations').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'GET', apiVersion: '', }, @@ -11190,75 +13560,111 @@ export namespace discoveryengine_v1beta { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Operations$Get + extends StandardParameters { /** - * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + * The name of the operation resource. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Operations$List + extends StandardParameters { + /** + * The standard list filter. + */ + filter?: string; + /** + * The name of the operation's parent resource. + */ + name?: string; + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. + */ + pageToken?: string; + } + + export class Resource$Projects$Locations$Collections$Datastores$Servingconfigs { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Answer query method. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Models$Operations$List, + answer( + params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Answer, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Models$Operations$List, + answer( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Answer, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Models$Operations$List, + ): GaxiosPromise; + answer( + params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Answer, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Models$Operations$List, + answer( + params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Answer, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Models$Operations$List, - callback: BodyResponseCallback + answer( + params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Answer, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + answer( + callback: BodyResponseCallback ): void; - list( + answer( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Models$Operations$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Answer + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Models$Operations$List; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Answer; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Models$Operations$List; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Answer; options = {}; } @@ -11272,68 +13678,34 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+name}/operations').replace( + url: (rootUrl + '/v1beta/{+servingConfig}:answer').replace( /([^:]\/)\/+/g, '$1' ), - method: 'GET', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['servingConfig'], + pathParams: ['servingConfig'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } - } - - export interface Params$Resource$Projects$Locations$Collections$Datastores$Models$Operations$Get - extends StandardParameters { - /** - * The name of the operation resource. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Models$Operations$List - extends StandardParameters { - /** - * The standard list filter. - */ - filter?: string; - /** - * The name of the operation's parent resource. - */ - name?: string; - /** - * The standard list page size. - */ - pageSize?: number; - /** - * The standard list page token. - */ - pageToken?: string; - } - - export class Resource$Projects$Locations$Collections$Datastores$Operations { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * 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. + * Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not exist. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -11341,57 +13713,57 @@ export namespace discoveryengine_v1beta { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Operations$Get, + params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get, options: StreamMethodOptions ): GaxiosPromise; get( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Operations$Get, + params?: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Operations$Get, + params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Operations$Get, + params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Operations$Get, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get, + callback: BodyResponseCallback ): void; get( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Operations$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Operations$Get; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Operations$Get; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get; options = {}; } @@ -11417,17 +13789,19 @@ export namespace discoveryengine_v1beta { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + * Lists all ServingConfigs linked to this dataStore. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -11435,57 +13809,57 @@ export namespace discoveryengine_v1beta { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Operations$List, + params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List, options: StreamMethodOptions ): GaxiosPromise; list( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Operations$List, + params?: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Operations$List, + params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Operations$List, + params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Operations$List, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Operations$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Operations$List; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Operations$List; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List; options = {}; } @@ -11499,7 +13873,7 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+name}/operations').replace( + url: (rootUrl + '/v1beta/{+parent}/servingConfigs').replace( /([^:]\/)\/+/g, '$1' ), @@ -11509,121 +13883,178 @@ export namespace discoveryengine_v1beta { options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Operations$Get - extends StandardParameters { - /** - * The name of the operation resource. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Operations$List - extends StandardParameters { - /** - * The standard list filter. - */ - filter?: string; /** - * The name of the operation's parent resource. - */ - name?: string; - /** - * The standard list page size. - */ - pageSize?: number; - /** - * The standard list page token. + * Updates a ServingConfig. Returns a NOT_FOUND error if the ServingConfig does not exist. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. */ - pageToken?: string; - } + patch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch, + options: StreamMethodOptions + ): GaxiosPromise; + patch( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch, + callback: BodyResponseCallback + ): void; + patch( + callback: BodyResponseCallback + ): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; - export class Resource$Projects$Locations$Collections$Datastores$Schemas { - context: APIRequestContext; - operations: Resource$Projects$Locations$Collections$Datastores$Schemas$Operations; - constructor(context: APIRequestContext) { - this.context = context; - this.operations = - new Resource$Projects$Locations$Collections$Datastores$Schemas$Operations( - this.context + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback ); + } else { + return createAPIRequest( + parameters + ); + } } /** - * Creates a Schema. + * Makes a recommendation, which requires a contextual user event. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - create( - params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Create, + recommend( + params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend, options: StreamMethodOptions ): GaxiosPromise; - create( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Create, + recommend( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend, options?: MethodOptions - ): GaxiosPromise; - create( - params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Create, + ): GaxiosPromise; + recommend( + params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Create, + recommend( + params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Create, - callback: BodyResponseCallback + recommend( + params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend, + callback: BodyResponseCallback ): void; - create( - callback: BodyResponseCallback + recommend( + callback: BodyResponseCallback ): void; - create( + recommend( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Create; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Create; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend; options = {}; } @@ -11637,7 +14068,7 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+parent}/schemas').replace( + url: (rootUrl + '/v1beta/{+servingConfig}:recommend').replace( /([^:]\/)\/+/g, '$1' ), @@ -11647,80 +14078,82 @@ export namespace discoveryengine_v1beta { options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['servingConfig'], + pathParams: ['servingConfig'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Deletes a Schema. + * Performs a search. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - delete( - params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Delete, + search( + params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Search, options: StreamMethodOptions ): GaxiosPromise; - delete( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Delete, + search( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Search, options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Delete, + ): GaxiosPromise; + search( + params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Search, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Delete, + search( + params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Search, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Delete, - callback: BodyResponseCallback + search( + params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Search, + callback: BodyResponseCallback ): void; - delete( - callback: BodyResponseCallback + search( + callback: BodyResponseCallback ): void; - delete( + search( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Search + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Delete; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Search; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Delete; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Search; options = {}; } @@ -11734,87 +14167,179 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1beta/{+servingConfig}:search').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['servingConfig'], + pathParams: ['servingConfig'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } + } + + export interface Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Answer + extends StandardParameters { + /** + * Required. The resource name of the Search serving config, such as `projects/x/locations/global/collections/default_collection/engines/x/servingConfigs/default_serving_config`, or `projects/x/locations/global/collections/default_collection/dataStores/x/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. + */ + servingConfig?: string; /** - * Gets a Schema. + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryRequest; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get + extends StandardParameters { + /** + * Required. The resource name of the ServingConfig to get. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/engines/{engine\}/servingConfigs/{serving_config_id\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List + extends StandardParameters { + /** + * Optional. Maximum number of results to return. If unspecified, defaults to 100. If a value greater than 100 is provided, at most 100 results are returned. + */ + pageSize?: number; + /** + * Optional. A page token, received from a previous `ListServingConfigs` call. Provide this to retrieve the subsequent page. + */ + pageToken?: string; + /** + * Required. Full resource name of the parent resource. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/engines/{engine\}` + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch + extends StandardParameters { + /** + * Immutable. Fully qualified name `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}/servingConfigs/{serving_config_id\}` + */ + name?: string; + /** + * Indicates which fields in the provided ServingConfig to update. The following are NOT supported: * ServingConfig.name If not set, all supported fields are updated. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1betaServingConfig; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend + extends StandardParameters { + /** + * Required. Full resource name of a ServingConfig: `projects/x/locations/global/collections/x/engines/x/servingConfigs/x`, or `projects/x/locations/global/collections/x/dataStores/x/servingConfigs/x` One default serving config is created along with your recommendation engine creation. The engine ID is used as the ID of the default serving config. For example, for Engine `projects/x/locations/global/collections/x/engines/my-engine`, you can use `projects/x/locations/global/collections/x/engines/my-engine/servingConfigs/my-engine` for your RecommendationService.Recommend requests. + */ + servingConfig?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1betaRecommendRequest; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Search + extends StandardParameters { + /** + * Required. The resource name of the Search serving config, such as `projects/x/locations/global/collections/default_collection/engines/x/servingConfigs/default_serving_config`, or `projects/x/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. + */ + servingConfig?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequest; + } + + export class Resource$Projects$Locations$Collections$Datastores$Sessions { + context: APIRequestContext; + answers: Resource$Projects$Locations$Collections$Datastores$Sessions$Answers; + constructor(context: APIRequestContext) { + this.context = context; + this.answers = + new Resource$Projects$Locations$Collections$Datastores$Sessions$Answers( + this.context + ); + } + + /** + * Creates a Session. If the Session to create already exists, an ALREADY_EXISTS error is returned. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Get, + create( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Create, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Get, + create( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Create, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Get, + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Get, + create( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Create, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Get, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Create, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + create( + callback: BodyResponseCallback ): void; - get( + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Get; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Get; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Create; options = {}; } @@ -11828,89 +14353,88 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1beta/{+parent}/sessions').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Gets a list of Schemas. + * Deletes a Session. If the Session to delete does not exist, a NOT_FOUND error is returned. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$List, + delete( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Delete, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$List, + delete( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Delete, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$List, + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$List, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Delete, + callback: BodyResponseCallback ): void; - list( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Schemas$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Schemas$List; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Schemas$List; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Delete; options = {}; } @@ -11924,92 +14448,87 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+parent}/schemas').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Updates a Schema. + * Gets a Session. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - patch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Patch, + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Get, options: StreamMethodOptions ): GaxiosPromise; - patch( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Patch, + get( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Get, options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Patch, + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Patch, + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Patch, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Get, + callback: BodyResponseCallback ): void; - patch( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - patch( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Patch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Patch; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Patch; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Get; options = {}; } @@ -12024,7 +14543,7 @@ export namespace discoveryengine_v1beta { options: Object.assign( { url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + method: 'GET', apiVersion: '', }, options @@ -12035,144 +14554,77 @@ export namespace discoveryengine_v1beta { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } - } - - export interface Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Create - extends StandardParameters { - /** - * Required. The parent data store resource name, in the format of `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}`. - */ - parent?: string; - /** - * Required. The ID to use for the Schema, which becomes the final component of the Schema.name. This field should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. - */ - schemaId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1betaSchema; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Delete - extends StandardParameters { - /** - * Required. The full resource name of the schema, in the format of `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/schemas/{schema\}`. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Get - extends StandardParameters { - /** - * Required. The full resource name of the schema, in the format of `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/schemas/{schema\}`. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Schemas$List - extends StandardParameters { - /** - * The maximum number of Schemas to return. The service may return fewer than this value. If unspecified, at most 100 Schemas are returned. The maximum value is 1000; values above 1000 are set to 1000. - */ - pageSize?: number; - /** - * A page token, received from a previous SchemaService.ListSchemas call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SchemaService.ListSchemas must match the call that provided the page token. - */ - pageToken?: string; - /** - * Required. The parent data store resource name, in the format of `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}`. - */ - parent?: string; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Patch - extends StandardParameters { - /** - * If set to true, and the Schema is not found, a new Schema is created. In this situation, `update_mask` is ignored. - */ - allowMissing?: boolean; - /** - * 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. - */ - name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1betaSchema; - } - - export class Resource$Projects$Locations$Collections$Datastores$Schemas$Operations { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * 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. + * Lists all Sessions by their parent DataStore. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Operations$Get, + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$List, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Operations$Get, + list( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$List, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Operations$Get, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Operations$Get, + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Operations$Get, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$List, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - get( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Operations$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Sessions$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Operations$Get; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sessions$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Operations$Get; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Sessions$List; options = {}; } @@ -12186,87 +14638,92 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1beta/{+parent}/sessions').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + * Updates a Session. Session action type cannot be changed. If the Session to update does not exist, a NOT_FOUND error is returned. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Operations$List, + patch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Patch, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Operations$List, + patch( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Patch, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Operations$List, + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Operations$List, + patch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Patch, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Operations$List, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Patch, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + patch( + callback: BodyResponseCallback ): void; - list( + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Operations$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Operations$List; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Operations$List; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Patch; options = {}; } @@ -12280,11 +14737,8 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+name}/operations').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', apiVersion: '', }, options @@ -12295,111 +14749,150 @@ export namespace discoveryengine_v1beta { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Operations$Get + export interface Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Create extends StandardParameters { /** - * The name of the operation resource. + * Required. Full resource name of parent data store. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1betaSession; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Delete + extends StandardParameters { + /** + * Required. The resource name of the Session to delete. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/sessions/{session_id\}` */ name?: string; } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Operations$List + export interface Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Get extends StandardParameters { /** - * The standard list filter. + * Required. The resource name of the Session to get. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/sessions/{session_id\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Sessions$List + extends StandardParameters { + /** + * A filter to apply on the list results. The supported features are: user_pseudo_id, state. Example: "user_pseudo_id = some_id" */ filter?: string; /** - * The name of the operation's parent resource. + * 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` Example: "update_time desc" "create_time" */ - name?: string; + orderBy?: string; /** - * The standard list page size. + * Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000. */ pageSize?: number; /** - * The standard list page token. + * A page token, received from a previous `ListSessions` call. Provide this to retrieve the subsequent page. */ pageToken?: string; + /** + * Required. The data store resource name. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}` + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Patch + extends StandardParameters { + /** + * Immutable. Fully qualified name `projects/{project\}/locations/global/collections/{collection\}/engines/{engine\}/sessions/x` + */ + name?: string; + /** + * 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. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1betaSession; } - export class Resource$Projects$Locations$Collections$Datastores$Servingconfigs { + export class Resource$Projects$Locations$Collections$Datastores$Sessions$Answers { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * Answer query method. + * Gets a Answer. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - answer( - params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Answer, + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Answers$Get, options: StreamMethodOptions ): GaxiosPromise; - answer( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Answer, + get( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Answers$Get, options?: MethodOptions - ): GaxiosPromise; - answer( - params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Answer, + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Answers$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - answer( - params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Answer, + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Answers$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - answer( - params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Answer, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Answers$Get, + callback: BodyResponseCallback ): void; - answer( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - answer( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Answer - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Answers$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Answer; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Answers$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Answer; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Answers$Get; options = {}; } @@ -12413,92 +14906,114 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+servingConfig}:answer').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['servingConfig'], - pathParams: ['servingConfig'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Answers$Get + extends StandardParameters { /** - * Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not exist. + * Required. The resource name of the Answer to get. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/engines/{engine_id\}/sessions/{session_id\}/answers/{answer_id\}` + */ + name?: string; + } + + export class Resource$Projects$Locations$Collections$Datastores$Sitesearchengine { + context: APIRequestContext; + operations: Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations; + targetSites: Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites; + constructor(context: APIRequestContext) { + this.context = context; + this.operations = + new Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations( + this.context + ); + this.targetSites = + new Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites( + this.context + ); + } + + /** + * Verify target sites' ownership and validity. This API sends all the target sites under site search engine for verification. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get, + batchVerifyTargetSites( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Batchverifytargetsites, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get, + batchVerifyTargetSites( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Batchverifytargetsites, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get, + ): GaxiosPromise; + batchVerifyTargetSites( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Batchverifytargetsites, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get, + batchVerifyTargetSites( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Batchverifytargetsites, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get, - callback: BodyResponseCallback + batchVerifyTargetSites( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Batchverifytargetsites, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + batchVerifyTargetSites( + callback: BodyResponseCallback ): void; - get( + batchVerifyTargetSites( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Batchverifytargetsites + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Batchverifytargetsites; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Batchverifytargetsites; options = {}; } @@ -12512,89 +15027,90 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1beta/{+parent}:batchVerifyTargetSites').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Lists all ServingConfigs linked to this dataStore. + * Downgrade from advanced site search to basic site search. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List, + disableAdvancedSiteSearch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Disableadvancedsitesearch, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List, + disableAdvancedSiteSearch( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Disableadvancedsitesearch, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List, + ): GaxiosPromise; + disableAdvancedSiteSearch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Disableadvancedsitesearch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List, + disableAdvancedSiteSearch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Disableadvancedsitesearch, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List, - callback: BodyResponseCallback + disableAdvancedSiteSearch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Disableadvancedsitesearch, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + disableAdvancedSiteSearch( + callback: BodyResponseCallback ): void; - list( + disableAdvancedSiteSearch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Disableadvancedsitesearch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Disableadvancedsitesearch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Disableadvancedsitesearch; options = {}; } @@ -12608,92 +15124,89 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+parent}/servingConfigs').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: ( + rootUrl + '/v1beta/{+siteSearchEngine}:disableAdvancedSiteSearch' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['siteSearchEngine'], + pathParams: ['siteSearchEngine'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Updates a ServingConfig. Returns a NOT_FOUND error if the ServingConfig does not exist. + * Upgrade from basic site search to advanced site search. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - patch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch, + enableAdvancedSiteSearch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Enableadvancedsitesearch, options: StreamMethodOptions ): GaxiosPromise; - patch( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch, + enableAdvancedSiteSearch( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Enableadvancedsitesearch, options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch, + ): GaxiosPromise; + enableAdvancedSiteSearch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Enableadvancedsitesearch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch, + enableAdvancedSiteSearch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Enableadvancedsitesearch, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch, - callback: BodyResponseCallback + enableAdvancedSiteSearch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Enableadvancedsitesearch, + callback: BodyResponseCallback ): void; - patch( - callback: BodyResponseCallback + enableAdvancedSiteSearch( + callback: BodyResponseCallback ): void; - patch( + enableAdvancedSiteSearch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Enableadvancedsitesearch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Enableadvancedsitesearch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Enableadvancedsitesearch; options = {}; } @@ -12707,89 +15220,89 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + url: ( + rootUrl + '/v1beta/{+siteSearchEngine}:enableAdvancedSiteSearch' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['siteSearchEngine'], + pathParams: ['siteSearchEngine'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Makes a recommendation, which requires a contextual user event. + * 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. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - recommend( - params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend, + fetchDomainVerificationStatus( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Fetchdomainverificationstatus, options: StreamMethodOptions ): GaxiosPromise; - recommend( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend, + fetchDomainVerificationStatus( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Fetchdomainverificationstatus, options?: MethodOptions - ): GaxiosPromise; - recommend( - params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend, + ): GaxiosPromise; + fetchDomainVerificationStatus( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Fetchdomainverificationstatus, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - recommend( - params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend, + fetchDomainVerificationStatus( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Fetchdomainverificationstatus, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - recommend( - params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend, - callback: BodyResponseCallback + fetchDomainVerificationStatus( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Fetchdomainverificationstatus, + callback: BodyResponseCallback ): void; - recommend( - callback: BodyResponseCallback + fetchDomainVerificationStatus( + callback: BodyResponseCallback ): void; - recommend( + fetchDomainVerificationStatus( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Fetchdomainverificationstatus + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Fetchdomainverificationstatus; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Fetchdomainverificationstatus; options = {}; } @@ -12799,96 +15312,96 @@ export namespace discoveryengine_v1beta { } const rootUrl = - options.rootUrl || 'https://discoveryengine.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1beta/{+servingConfig}:recommend').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v1beta/{+siteSearchEngine}:fetchDomainVerificationStatus' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['servingConfig'], - pathParams: ['servingConfig'], + requiredParams: ['siteSearchEngine'], + pathParams: ['siteSearchEngine'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Performs a search. + * Request on-demand recrawl for a list of URIs. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - search( - params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Search, + recrawlUris( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Recrawluris, options: StreamMethodOptions ): GaxiosPromise; - search( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Search, + recrawlUris( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Recrawluris, options?: MethodOptions - ): GaxiosPromise; - search( - params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Search, + ): GaxiosPromise; + recrawlUris( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Recrawluris, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - search( - params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Search, + recrawlUris( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Recrawluris, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - search( - params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Search, - callback: BodyResponseCallback + recrawlUris( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Recrawluris, + callback: BodyResponseCallback ): void; - search( - callback: BodyResponseCallback + recrawlUris( + callback: BodyResponseCallback ): void; - search( + recrawlUris( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Search - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Recrawluris + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Search; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Recrawluris; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Search; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Recrawluris; options = {}; } @@ -12902,7 +15415,7 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+servingConfig}:search').replace( + url: (rootUrl + '/v1beta/{+siteSearchEngine}:recrawlUris').replace( /([^:]\/)\/+/g, '$1' ), @@ -12912,169 +15425,245 @@ export namespace discoveryengine_v1beta { options ), params, - requiredParams: ['servingConfig'], - pathParams: ['servingConfig'], + requiredParams: ['siteSearchEngine'], + pathParams: ['siteSearchEngine'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Answer + export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Batchverifytargetsites extends StandardParameters { /** - * Required. The resource name of the Search serving config, such as `projects/x/locations/global/collections/default_collection/engines/x/servingConfigs/default_serving_config`, or `projects/x/locations/global/collections/default_collection/dataStores/x/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. + * Required. The parent resource shared by all TargetSites being verified. `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine`. */ - servingConfig?: string; + parent?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryRequest; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get - extends StandardParameters { - /** - * Required. The resource name of the ServingConfig to get. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/engines/{engine\}/servingConfigs/{serving_config_id\}` - */ - name?: string; + requestBody?: Schema$GoogleCloudDiscoveryengineV1betaBatchVerifyTargetSitesRequest; } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List + export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Disableadvancedsitesearch extends StandardParameters { /** - * Optional. Maximum number of results to return. If unspecified, defaults to 100. If a value greater than 100 is provided, at most 100 results are returned. - */ - pageSize?: number; - /** - * Optional. A page token, received from a previous `ListServingConfigs` call. Provide this to retrieve the subsequent page. + * Required. Full resource name of the SiteSearchEngine, such as `projects/{project\}/locations/{location\}/dataStores/{data_store_id\}/siteSearchEngine`. */ - pageToken?: string; + siteSearchEngine?: string; + /** - * Required. Full resource name of the parent resource. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/engines/{engine\}` + * Request body metadata */ - parent?: string; + requestBody?: Schema$GoogleCloudDiscoveryengineV1betaDisableAdvancedSiteSearchRequest; } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch + export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Enableadvancedsitesearch extends StandardParameters { /** - * Immutable. Fully qualified name `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}/servingConfigs/{serving_config_id\}` - */ - name?: string; - /** - * Indicates which fields in the provided ServingConfig to update. The following are NOT supported: * ServingConfig.name If not set, all supported fields are updated. + * Required. Full resource name of the SiteSearchEngine, such as `projects/{project\}/locations/{location\}/dataStores/{data_store_id\}/siteSearchEngine`. */ - updateMask?: string; + siteSearchEngine?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1betaServingConfig; + requestBody?: Schema$GoogleCloudDiscoveryengineV1betaEnableAdvancedSiteSearchRequest; } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend + export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Fetchdomainverificationstatus extends StandardParameters { /** - * Required. Full resource name of a ServingConfig: `projects/x/locations/global/collections/x/engines/x/servingConfigs/x`, or `projects/x/locations/global/collections/x/dataStores/x/servingConfigs/x` One default serving config is created along with your recommendation engine creation. The engine ID is used as the ID of the default serving config. For example, for Engine `projects/x/locations/global/collections/x/engines/my-engine`, you can use `projects/x/locations/global/collections/x/engines/my-engine/servingConfigs/my-engine` for your RecommendationService.Recommend requests. + * Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. The maximum value is 1000; values above 1000 will be coerced to 1000. If this field is negative, an INVALID_ARGUMENT error is returned. */ - servingConfig?: string; - + pageSize?: number; /** - * Request body metadata + * A page token, received from a previous `FetchDomainVerificationStatus` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `FetchDomainVerificationStatus` must match the call that provided the page token. */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1betaRecommendRequest; + pageToken?: string; + /** + * Required. The site search engine resource under which we fetch all the domain verification status. `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine`. + */ + siteSearchEngine?: string; } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Search + export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Recrawluris extends StandardParameters { /** - * Required. The resource name of the Search serving config, such as `projects/x/locations/global/collections/default_collection/engines/x/servingConfigs/default_serving_config`, or `projects/x/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. + * Required. Full resource name of the SiteSearchEngine, such as `projects/x/locations/x/collections/x/dataStores/x/siteSearchEngine`. */ - servingConfig?: string; + siteSearchEngine?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequest; + requestBody?: Schema$GoogleCloudDiscoveryengineV1betaRecrawlUrisRequest; } - export class Resource$Projects$Locations$Collections$Datastores$Sessions { + export class Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations { context: APIRequestContext; - answers: Resource$Projects$Locations$Collections$Datastores$Sessions$Answers; constructor(context: APIRequestContext) { this.context = context; - this.answers = - new Resource$Projects$Locations$Collections$Datastores$Sessions$Answers( - this.context - ); } /** - * Creates a Session. If the Session to create already exists, an ALREADY_EXISTS error is returned. + * 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. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - create( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Create, + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations$Get, options: StreamMethodOptions ): GaxiosPromise; - create( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Create, + get( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations$Get, options?: MethodOptions - ): GaxiosPromise; - create( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Create, + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Create, + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Create, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations$List, + callback: BodyResponseCallback ): void; - create( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - create( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Create; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Create; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations$List; options = {}; } @@ -13088,88 +15677,131 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+parent}/sessions').replace( + url: (rootUrl + '/v1beta/{+name}/operations').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations$Get + extends StandardParameters { /** - * Deletes a Session. If the Session to delete does not exist, a NOT_FOUND error is returned. + * The name of the operation resource. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations$List + extends StandardParameters { + /** + * The standard list filter. + */ + filter?: string; + /** + * The name of the operation's parent resource. + */ + name?: string; + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. + */ + pageToken?: string; + } + + export class Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites { + context: APIRequestContext; + operations: Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.operations = + new Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations( + this.context + ); + } + + /** + * Creates TargetSite in a batch. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - delete( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Delete, + batchCreate( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Batchcreate, options: StreamMethodOptions ): GaxiosPromise; - delete( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Delete, + batchCreate( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Batchcreate, options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Delete, + ): GaxiosPromise; + batchCreate( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Batchcreate, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + batchCreate( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Batchcreate, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Delete, - callback: BodyResponseCallback + batchCreate( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Batchcreate, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + batchCreate( + callback: BodyResponseCallback + ): void; + batchCreate( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Batchcreate + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Delete; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Batchcreate; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Delete; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Batchcreate; options = {}; } @@ -13183,87 +15815,89 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: ( + rootUrl + '/v1beta/{+parent}/targetSites:batchCreate' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Gets a Session. + * Creates a TargetSite. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Get, + create( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Create, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Get, + create( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Create, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Get, + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Get, + create( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Create, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Get, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Create, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + create( + callback: BodyResponseCallback ): void; - get( + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Get; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Get; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Create; options = {}; } @@ -13277,89 +15911,90 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1beta/{+parent}/targetSites').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Lists all Sessions by their parent DataStore. + * Deletes a TargetSite. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$List, + delete( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Delete, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$List, + delete( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Delete, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$List, + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$List, + delete( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Delete, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$List, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Delete, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + delete( + callback: BodyResponseCallback ): void; - list( + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Sessions$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sessions$List; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Sessions$List; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Delete; options = {}; } @@ -13373,92 +16008,87 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+parent}/sessions').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Updates a Session. Session action type cannot be changed. If the Session to update does not exist, a NOT_FOUND error is returned. + * Gets a TargetSite. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - patch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Patch, + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Get, options: StreamMethodOptions ): GaxiosPromise; - patch( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Patch, + get( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Get, options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Patch, + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Patch, + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Patch, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Get, + callback: BodyResponseCallback ): void; - patch( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - patch( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Patch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Patch; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Patch; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Get; options = {}; } @@ -13473,7 +16103,7 @@ export namespace discoveryengine_v1beta { options: Object.assign( { url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + method: 'GET', apiVersion: '', }, options @@ -13484,150 +16114,77 @@ export namespace discoveryengine_v1beta { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } - } - - export interface Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Create - extends StandardParameters { - /** - * Required. Full resource name of parent data store. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}` - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1betaSession; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Delete - extends StandardParameters { - /** - * Required. The resource name of the Session to delete. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/sessions/{session_id\}` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Get - extends StandardParameters { - /** - * Required. The resource name of the Session to get. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/sessions/{session_id\}` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Sessions$List - extends StandardParameters { - /** - * A filter to apply on the list results. The supported features are: user_pseudo_id, state. Example: "user_pseudo_id = some_id" - */ - filter?: string; - /** - * 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` Example: "update_time desc" "create_time" - */ - orderBy?: string; - /** - * Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000. - */ - pageSize?: number; - /** - * A page token, received from a previous `ListSessions` call. Provide this to retrieve the subsequent page. - */ - pageToken?: string; - /** - * Required. The data store resource name. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}` - */ - parent?: string; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Patch - extends StandardParameters { - /** - * Immutable. Fully qualified name `projects/{project\}/locations/global/collections/{collection\}/engines/{engine\}/sessions/x` - */ - name?: string; - /** - * 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. - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1betaSession; - } - - export class Resource$Projects$Locations$Collections$Datastores$Sessions$Answers { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Gets a Answer. + * Gets a list of TargetSites. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Answers$Get, + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$List, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Answers$Get, + list( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$List, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Answers$Get, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Answers$Get, + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Answers$Get, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$List, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - get( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Answers$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Answers$Get; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Answers$Get; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$List; options = {}; } @@ -13641,92 +16198,70 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1beta/{+parent}/targetSites').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } - } - - export interface Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Answers$Get - extends StandardParameters { - /** - * Required. The resource name of the Answer to get. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/engines/{engine_id\}/sessions/{session_id\}/answers/{answer_id\}` - */ - name?: string; - } - - export class Resource$Projects$Locations$Collections$Datastores$Sitesearchengine { - context: APIRequestContext; - operations: Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations; - targetSites: Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites; - constructor(context: APIRequestContext) { - this.context = context; - this.operations = - new Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations( - this.context - ); - this.targetSites = - new Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites( - this.context - ); - } /** - * Verify target sites' ownership and validity. This API sends all the target sites under site search engine for verification. + * Updates a TargetSite. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - batchVerifyTargetSites( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Batchverifytargetsites, + patch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Patch, options: StreamMethodOptions ): GaxiosPromise; - batchVerifyTargetSites( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Batchverifytargetsites, + patch( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Patch, options?: MethodOptions ): GaxiosPromise; - batchVerifyTargetSites( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Batchverifytargetsites, + patch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - batchVerifyTargetSites( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Batchverifytargetsites, + patch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Patch, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - batchVerifyTargetSites( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Batchverifytargetsites, + patch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Patch, callback: BodyResponseCallback ): void; - batchVerifyTargetSites( + patch( callback: BodyResponseCallback ): void; - batchVerifyTargetSites( + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Batchverifytargetsites + | Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Patch | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -13742,13 +16277,13 @@ export namespace discoveryengine_v1beta { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Batchverifytargetsites; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Batchverifytargetsites; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Patch; options = {}; } @@ -13762,18 +16297,15 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+parent}:batchVerifyTargetSites').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { @@ -13785,45 +16317,118 @@ export namespace discoveryengine_v1beta { return createAPIRequest(parameters); } } + } + + export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Batchcreate + extends StandardParameters { + /** + * Required. The parent resource shared by all TargetSites being created. `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine`. The parent field in the CreateBookRequest messages must either be empty or match this field. + */ + parent?: string; /** - * Downgrade from advanced site search to basic site search. + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1betaBatchCreateTargetSitesRequest; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Create + extends StandardParameters { + /** + * Required. Parent resource name of TargetSite, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine`. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1betaTargetSite; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Delete + extends StandardParameters { + /** + * Required. Full resource name of TargetSite, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine/targetSites/{target_site\}`. If the caller does not have permission to access the TargetSite, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested TargetSite does not exist, a NOT_FOUND error is returned. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Get + extends StandardParameters { + /** + * Required. Full resource name of TargetSite, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine/targetSites/{target_site\}`. If the caller does not have permission to access the TargetSite, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested TargetSite does not exist, a NOT_FOUND error is returned. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$List + extends StandardParameters { + /** + * Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. The maximum value is 1000; values above 1000 will be coerced to 1000. If this field is negative, an INVALID_ARGUMENT error is returned. + */ + pageSize?: number; + /** + * A page token, received from a previous `ListTargetSites` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListTargetSites` must match the call that provided the page token. + */ + pageToken?: string; + /** + * Required. The parent site search engine resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine`. If the caller does not have permission to list TargetSites under this site search engine, regardless of whether or not this branch exists, a PERMISSION_DENIED error is returned. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Patch + extends StandardParameters { + /** + * 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. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1betaTargetSite; + } + + export class Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * 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. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - disableAdvancedSiteSearch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Disableadvancedsitesearch, + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$Get, options: StreamMethodOptions ): GaxiosPromise; - disableAdvancedSiteSearch( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Disableadvancedsitesearch, + get( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$Get, options?: MethodOptions ): GaxiosPromise; - disableAdvancedSiteSearch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Disableadvancedsitesearch, + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - disableAdvancedSiteSearch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Disableadvancedsitesearch, + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$Get, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - disableAdvancedSiteSearch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Disableadvancedsitesearch, + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$Get, callback: BodyResponseCallback ): void; - disableAdvancedSiteSearch( + get( callback: BodyResponseCallback ): void; - disableAdvancedSiteSearch( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Disableadvancedsitesearch + | Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$Get | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -13839,13 +16444,13 @@ export namespace discoveryengine_v1beta { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Disableadvancedsitesearch; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Disableadvancedsitesearch; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$Get; options = {}; } @@ -13859,17 +16464,15 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: ( - rootUrl + '/v1beta/{+siteSearchEngine}:disableAdvancedSiteSearch' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['siteSearchEngine'], - pathParams: ['siteSearchEngine'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { @@ -13883,65 +16486,65 @@ export namespace discoveryengine_v1beta { } /** - * Upgrade from basic site search to advanced site search. + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - enableAdvancedSiteSearch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Enableadvancedsitesearch, + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$List, options: StreamMethodOptions ): GaxiosPromise; - enableAdvancedSiteSearch( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Enableadvancedsitesearch, + list( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$List, options?: MethodOptions - ): GaxiosPromise; - enableAdvancedSiteSearch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Enableadvancedsitesearch, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - enableAdvancedSiteSearch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Enableadvancedsitesearch, + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - enableAdvancedSiteSearch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Enableadvancedsitesearch, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$List, + callback: BodyResponseCallback ): void; - enableAdvancedSiteSearch( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - enableAdvancedSiteSearch( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Enableadvancedsitesearch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Enableadvancedsitesearch; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Enableadvancedsitesearch; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$List; options = {}; } @@ -13955,89 +16558,126 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: ( - rootUrl + '/v1beta/{+siteSearchEngine}:enableAdvancedSiteSearch' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + url: (rootUrl + '/v1beta/{+name}/operations').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['siteSearchEngine'], - pathParams: ['siteSearchEngine'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } + } + + export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$Get + extends StandardParameters { + /** + * The name of the operation resource. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$List + extends StandardParameters { + /** + * The standard list filter. + */ + filter?: string; + /** + * The name of the operation's parent resource. + */ + name?: string; + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. + */ + pageToken?: string; + } + + export class Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } /** - * 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. + * Imports all SuggestionDenyListEntry for a DataStore. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - fetchDomainVerificationStatus( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Fetchdomainverificationstatus, + import( + params: Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Import, options: StreamMethodOptions ): GaxiosPromise; - fetchDomainVerificationStatus( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Fetchdomainverificationstatus, + import( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Import, options?: MethodOptions - ): GaxiosPromise; - fetchDomainVerificationStatus( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Fetchdomainverificationstatus, + ): GaxiosPromise; + import( + params: Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Import, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - fetchDomainVerificationStatus( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Fetchdomainverificationstatus, + import( + params: Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Import, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - fetchDomainVerificationStatus( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Fetchdomainverificationstatus, - callback: BodyResponseCallback + import( + params: Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Import, + callback: BodyResponseCallback ): void; - fetchDomainVerificationStatus( - callback: BodyResponseCallback + import( + callback: BodyResponseCallback ): void; - fetchDomainVerificationStatus( + import( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Fetchdomainverificationstatus - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Import + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Fetchdomainverificationstatus; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Import; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Fetchdomainverificationstatus; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Import; options = {}; } @@ -14052,69 +16692,66 @@ export namespace discoveryengine_v1beta { options: Object.assign( { url: ( - rootUrl + - '/v1beta/{+siteSearchEngine}:fetchDomainVerificationStatus' + rootUrl + '/v1beta/{+parent}/suggestionDenyListEntries:import' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['siteSearchEngine'], - pathParams: ['siteSearchEngine'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Request on-demand recrawl for a list of URIs. + * Permanently deletes all SuggestionDenyListEntry for a DataStore. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - recrawlUris( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Recrawluris, + purge( + params: Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Purge, options: StreamMethodOptions ): GaxiosPromise; - recrawlUris( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Recrawluris, + purge( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Purge, options?: MethodOptions ): GaxiosPromise; - recrawlUris( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Recrawluris, + purge( + params: Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Purge, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - recrawlUris( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Recrawluris, + purge( + params: Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Purge, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - recrawlUris( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Recrawluris, + purge( + params: Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Purge, callback: BodyResponseCallback ): void; - recrawlUris( + purge( callback: BodyResponseCallback ): void; - recrawlUris( + purge( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Recrawluris + | Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Purge | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -14130,13 +16767,13 @@ export namespace discoveryengine_v1beta { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Recrawluris; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Purge; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Recrawluris; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Purge; options = {}; } @@ -14150,18 +16787,17 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+siteSearchEngine}:recrawlUris').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: ( + rootUrl + '/v1beta/{+parent}/suggestionDenyListEntries:purge' + ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['siteSearchEngine'], - pathParams: ['siteSearchEngine'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { @@ -14175,136 +16811,93 @@ export namespace discoveryengine_v1beta { } } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Batchverifytargetsites + export interface Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Import extends StandardParameters { /** - * Required. The parent resource shared by all TargetSites being verified. `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine`. + * Required. The parent data store resource name for which to import denylist entries. Follows pattern projects/x/locations/x/collections/x/dataStores/x. */ parent?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1betaBatchVerifyTargetSitesRequest; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Disableadvancedsitesearch - extends StandardParameters { - /** - * Required. Full resource name of the SiteSearchEngine, such as `projects/{project\}/locations/{location\}/dataStores/{data_store_id\}/siteSearchEngine`. - */ - siteSearchEngine?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1betaDisableAdvancedSiteSearchRequest; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Enableadvancedsitesearch - extends StandardParameters { - /** - * Required. Full resource name of the SiteSearchEngine, such as `projects/{project\}/locations/{location\}/dataStores/{data_store_id\}/siteSearchEngine`. - */ - siteSearchEngine?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1betaEnableAdvancedSiteSearchRequest; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Fetchdomainverificationstatus - extends StandardParameters { - /** - * Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. The maximum value is 1000; values above 1000 will be coerced to 1000. If this field is negative, an INVALID_ARGUMENT error is returned. - */ - pageSize?: number; - /** - * A page token, received from a previous `FetchDomainVerificationStatus` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `FetchDomainVerificationStatus` must match the call that provided the page token. - */ - pageToken?: string; - /** - * Required. The site search engine resource under which we fetch all the domain verification status. `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine`. - */ - siteSearchEngine?: string; + requestBody?: Schema$GoogleCloudDiscoveryengineV1betaImportSuggestionDenyListEntriesRequest; } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Recrawluris + export interface Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Purge extends StandardParameters { /** - * Required. Full resource name of the SiteSearchEngine, such as `projects/x/locations/x/collections/x/dataStores/x/siteSearchEngine`. + * Required. The parent data store resource name for which to import denylist entries. Follows pattern projects/x/locations/x/collections/x/dataStores/x. */ - siteSearchEngine?: string; + parent?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1betaRecrawlUrisRequest; + requestBody?: Schema$GoogleCloudDiscoveryengineV1betaPurgeSuggestionDenyListEntriesRequest; } - export class Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations { + export class Resource$Projects$Locations$Collections$Datastores$Userevents { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * 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. + * 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. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations$Get, + collect( + params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Collect, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations$Get, + collect( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Collect, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations$Get, + ): GaxiosPromise; + collect( + params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Collect, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations$Get, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations$Get, - callback: BodyResponseCallback + collect( + params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Collect, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + collect( + params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Collect, + callback: BodyResponseCallback ): void; - get( + collect(callback: BodyResponseCallback): void; + collect( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Collect + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations$Get; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Collect; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations$Get; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Collect; options = {}; } @@ -14318,87 +16911,90 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1beta/{+parent}/userEvents:collect').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + * 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. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations$List, + import( + params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Import, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations$List, + import( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Import, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations$List, + ): GaxiosPromise; + import( + params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Import, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations$List, + import( + params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Import, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations$List, - callback: BodyResponseCallback + import( + params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Import, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + import( + callback: BodyResponseCallback ): void; - list( + import( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Import + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations$List; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Import; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations$List; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Import; options = {}; } @@ -14412,131 +17008,90 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+name}/operations').replace( + url: (rootUrl + '/v1beta/{+parent}/userEvents:import').replace( /([^:]\/)\/+/g, '$1' ), - method: 'GET', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations$Get - extends StandardParameters { - /** - * The name of the operation resource. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations$List - extends StandardParameters { - /** - * The standard list filter. - */ - filter?: string; - /** - * The name of the operation's parent resource. - */ - name?: string; - /** - * The standard list page size. - */ - pageSize?: number; - /** - * The standard list page token. - */ - pageToken?: string; - } - - export class Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites { - context: APIRequestContext; - operations: Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations; - constructor(context: APIRequestContext) { - this.context = context; - this.operations = - new Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations( - this.context - ); - } /** - * Creates TargetSite in a batch. + * Writes a single user event. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - batchCreate( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Batchcreate, + write( + params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Write, options: StreamMethodOptions ): GaxiosPromise; - batchCreate( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Batchcreate, + write( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Write, options?: MethodOptions - ): GaxiosPromise; - batchCreate( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Batchcreate, + ): GaxiosPromise; + write( + params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Write, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - batchCreate( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Batchcreate, + write( + params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Write, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - batchCreate( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Batchcreate, - callback: BodyResponseCallback + write( + params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Write, + callback: BodyResponseCallback ): void; - batchCreate( - callback: BodyResponseCallback + write( + callback: BodyResponseCallback ): void; - batchCreate( + write( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Batchcreate - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Write + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Batchcreate; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Write; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Batchcreate; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Write; options = {}; } @@ -14550,9 +17105,10 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: ( - rootUrl + '/v1beta/{+parent}/targetSites:batchCreate' - ).replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1beta/{+parent}/userEvents:write').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'POST', apiVersion: '', }, @@ -14564,17 +17120,99 @@ export namespace discoveryengine_v1beta { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Collect + extends StandardParameters { /** - * Creates a TargetSite. + * The event timestamp in milliseconds. This prevents browser caching of otherwise identical get requests. The name is abbreviated to reduce the payload bytes. + */ + ets?: string; + /** + * Required. The parent DataStore resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}`. + */ + parent?: string; + /** + * 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 third-party requests. + */ + uri?: string; + /** + * Required. URL encoded UserEvent proto with a length limit of 2,000,000 characters. + */ + userEvent?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Import + extends StandardParameters { + /** + * Required. Parent DataStore resource name, of the form `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1betaImportUserEventsRequest; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Write + extends StandardParameters { + /** + * Required. The parent resource name. If the write user event action is applied in DataStore level, the format is: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}`. If the write user event action is applied in Location level, for example, the event with Document across multiple DataStore, the format is: `projects/{project\}/locations/{location\}`. + */ + parent?: string; + /** + * If set to true, the user event is written asynchronously after validation, and the API responds without waiting for the write. + */ + writeAsync?: boolean; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1betaUserEvent; + } + + export class Resource$Projects$Locations$Collections$Engines { + context: APIRequestContext; + controls: Resource$Projects$Locations$Collections$Engines$Controls; + conversations: Resource$Projects$Locations$Collections$Engines$Conversations; + operations: Resource$Projects$Locations$Collections$Engines$Operations; + servingConfigs: Resource$Projects$Locations$Collections$Engines$Servingconfigs; + sessions: Resource$Projects$Locations$Collections$Engines$Sessions; + constructor(context: APIRequestContext) { + this.context = context; + this.controls = + new Resource$Projects$Locations$Collections$Engines$Controls( + this.context + ); + this.conversations = + new Resource$Projects$Locations$Collections$Engines$Conversations( + this.context + ); + this.operations = + new Resource$Projects$Locations$Collections$Engines$Operations( + this.context + ); + this.servingConfigs = + new Resource$Projects$Locations$Collections$Engines$Servingconfigs( + this.context + ); + this.sessions = + new Resource$Projects$Locations$Collections$Engines$Sessions( + this.context + ); + } + + /** + * Creates a Engine. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -14582,27 +17220,27 @@ export namespace discoveryengine_v1beta { * @returns A promise if used with async/await, or void if used with a callback. */ create( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Create, + params: Params$Resource$Projects$Locations$Collections$Engines$Create, options: StreamMethodOptions ): GaxiosPromise; create( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Create, + params?: Params$Resource$Projects$Locations$Collections$Engines$Create, options?: MethodOptions ): GaxiosPromise; create( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Create, + params: Params$Resource$Projects$Locations$Collections$Engines$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; create( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Create, + params: Params$Resource$Projects$Locations$Collections$Engines$Create, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; create( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Create, + params: Params$Resource$Projects$Locations$Collections$Engines$Create, callback: BodyResponseCallback ): void; create( @@ -14610,7 +17248,7 @@ export namespace discoveryengine_v1beta { ): void; create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Create + | Params$Resource$Projects$Locations$Collections$Engines$Create | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -14626,13 +17264,13 @@ export namespace discoveryengine_v1beta { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Create; + {}) as Params$Resource$Projects$Locations$Collections$Engines$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Create; + {} as Params$Resource$Projects$Locations$Collections$Engines$Create; options = {}; } @@ -14646,7 +17284,7 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+parent}/targetSites').replace( + url: (rootUrl + '/v1beta/{+parent}/engines').replace( /([^:]\/)\/+/g, '$1' ), @@ -14671,7 +17309,7 @@ export namespace discoveryengine_v1beta { } /** - * Deletes a TargetSite. + * Deletes a Engine. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -14679,27 +17317,27 @@ export namespace discoveryengine_v1beta { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Delete, + params: Params$Resource$Projects$Locations$Collections$Engines$Delete, options: StreamMethodOptions ): GaxiosPromise; delete( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Delete, + params?: Params$Resource$Projects$Locations$Collections$Engines$Delete, options?: MethodOptions ): GaxiosPromise; delete( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Delete, + params: Params$Resource$Projects$Locations$Collections$Engines$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Delete, + params: Params$Resource$Projects$Locations$Collections$Engines$Delete, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Delete, + params: Params$Resource$Projects$Locations$Collections$Engines$Delete, callback: BodyResponseCallback ): void; delete( @@ -14707,7 +17345,7 @@ export namespace discoveryengine_v1beta { ): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Delete + | Params$Resource$Projects$Locations$Collections$Engines$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -14723,13 +17361,13 @@ export namespace discoveryengine_v1beta { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Delete; + {}) as Params$Resource$Projects$Locations$Collections$Engines$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Delete; + {} as Params$Resource$Projects$Locations$Collections$Engines$Delete; options = {}; } @@ -14765,7 +17403,7 @@ export namespace discoveryengine_v1beta { } /** - * Gets a TargetSite. + * Gets a Engine. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -14773,57 +17411,57 @@ export namespace discoveryengine_v1beta { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Get, + params: Params$Resource$Projects$Locations$Collections$Engines$Get, options: StreamMethodOptions ): GaxiosPromise; get( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Get, + params?: Params$Resource$Projects$Locations$Collections$Engines$Get, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Get, + params: Params$Resource$Projects$Locations$Collections$Engines$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Get, + params: Params$Resource$Projects$Locations$Collections$Engines$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Get, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Collections$Engines$Get, + callback: BodyResponseCallback ): void; get( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Engines$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Get; + {}) as Params$Resource$Projects$Locations$Collections$Engines$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Get; + {} as Params$Resource$Projects$Locations$Collections$Engines$Get; options = {}; } @@ -14849,19 +17487,19 @@ export namespace discoveryengine_v1beta { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Gets a list of TargetSites. + * Lists all the Engines associated with the project. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -14869,57 +17507,57 @@ export namespace discoveryengine_v1beta { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$List, + params: Params$Resource$Projects$Locations$Collections$Engines$List, options: StreamMethodOptions ): GaxiosPromise; list( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$List, + params?: Params$Resource$Projects$Locations$Collections$Engines$List, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$List, + params: Params$Resource$Projects$Locations$Collections$Engines$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$List, + params: Params$Resource$Projects$Locations$Collections$Engines$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$List, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Collections$Engines$List, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Engines$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$List; + {}) as Params$Resource$Projects$Locations$Collections$Engines$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$List; + {} as Params$Resource$Projects$Locations$Collections$Engines$List; options = {}; } @@ -14933,7 +17571,7 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+parent}/targetSites').replace( + url: (rootUrl + '/v1beta/{+parent}/engines').replace( /([^:]\/)\/+/g, '$1' ), @@ -14948,19 +17586,19 @@ export namespace discoveryengine_v1beta { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Updates a TargetSite. + * Updates an Engine * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -14968,57 +17606,57 @@ export namespace discoveryengine_v1beta { * @returns A promise if used with async/await, or void if used with a callback. */ patch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Patch, + params: Params$Resource$Projects$Locations$Collections$Engines$Patch, options: StreamMethodOptions ): GaxiosPromise; patch( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Patch, + params?: Params$Resource$Projects$Locations$Collections$Engines$Patch, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; patch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Patch, + params: Params$Resource$Projects$Locations$Collections$Engines$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; patch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Patch, + params: Params$Resource$Projects$Locations$Collections$Engines$Patch, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; patch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Patch, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Collections$Engines$Patch, + callback: BodyResponseCallback ): void; patch( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Patch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Engines$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Patch; + {}) as Params$Resource$Projects$Locations$Collections$Engines$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Patch; + {} as Params$Resource$Projects$Locations$Collections$Engines$Patch; options = {}; } @@ -15044,148 +17682,77 @@ export namespace discoveryengine_v1beta { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } - } - - export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Batchcreate - extends StandardParameters { - /** - * Required. The parent resource shared by all TargetSites being created. `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine`. The parent field in the CreateBookRequest messages must either be empty or match this field. - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1betaBatchCreateTargetSitesRequest; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Create - extends StandardParameters { - /** - * Required. Parent resource name of TargetSite, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine`. - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1betaTargetSite; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Delete - extends StandardParameters { - /** - * Required. Full resource name of TargetSite, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine/targetSites/{target_site\}`. If the caller does not have permission to access the TargetSite, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested TargetSite does not exist, a NOT_FOUND error is returned. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Get - extends StandardParameters { - /** - * Required. Full resource name of TargetSite, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine/targetSites/{target_site\}`. If the caller does not have permission to access the TargetSite, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested TargetSite does not exist, a NOT_FOUND error is returned. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$List - extends StandardParameters { - /** - * Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. The maximum value is 1000; values above 1000 will be coerced to 1000. If this field is negative, an INVALID_ARGUMENT error is returned. - */ - pageSize?: number; - /** - * A page token, received from a previous `ListTargetSites` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListTargetSites` must match the call that provided the page token. - */ - pageToken?: string; - /** - * Required. The parent site search engine resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine`. If the caller does not have permission to list TargetSites under this site search engine, regardless of whether or not this branch exists, a PERMISSION_DENIED error is returned. - */ - parent?: string; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Patch - extends StandardParameters { - /** - * 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. - */ - name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1betaTargetSite; - } - - export class Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * 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. + * Pauses the training of an existing engine. Only applicable if SolutionType is SOLUTION_TYPE_RECOMMENDATION. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$Get, + pause( + params: Params$Resource$Projects$Locations$Collections$Engines$Pause, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$Get, + pause( + params?: Params$Resource$Projects$Locations$Collections$Engines$Pause, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$Get, + ): GaxiosPromise; + pause( + params: Params$Resource$Projects$Locations$Collections$Engines$Pause, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$Get, + pause( + params: Params$Resource$Projects$Locations$Collections$Engines$Pause, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$Get, - callback: BodyResponseCallback + pause( + params: Params$Resource$Projects$Locations$Collections$Engines$Pause, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + pause( + callback: BodyResponseCallback ): void; - get( + pause( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Engines$Pause + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$Get; + {}) as Params$Resource$Projects$Locations$Collections$Engines$Pause; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$Get; + {} as Params$Resource$Projects$Locations$Collections$Engines$Pause; options = {}; } @@ -15199,8 +17766,11 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1beta/{+name}:pause').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options @@ -15211,75 +17781,77 @@ export namespace discoveryengine_v1beta { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + * Resumes the training of an existing engine. Only applicable if SolutionType is SOLUTION_TYPE_RECOMMENDATION. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$List, + resume( + params: Params$Resource$Projects$Locations$Collections$Engines$Resume, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$List, + resume( + params?: Params$Resource$Projects$Locations$Collections$Engines$Resume, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$List, + ): GaxiosPromise; + resume( + params: Params$Resource$Projects$Locations$Collections$Engines$Resume, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$List, + resume( + params: Params$Resource$Projects$Locations$Collections$Engines$Resume, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$List, - callback: BodyResponseCallback + resume( + params: Params$Resource$Projects$Locations$Collections$Engines$Resume, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + resume( + callback: BodyResponseCallback ): void; - list( + resume( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Engines$Resume + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$List; + {}) as Params$Resource$Projects$Locations$Collections$Engines$Resume; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$List; + {} as Params$Resource$Projects$Locations$Collections$Engines$Resume; options = {}; } @@ -15293,11 +17865,11 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+name}/operations').replace( + url: (rootUrl + '/v1beta/{+name}:resume').replace( /([^:]\/)\/+/g, '$1' ), - method: 'GET', + method: 'POST', apiVersion: '', }, options @@ -15308,89 +17880,55 @@ export namespace discoveryengine_v1beta { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } - } - - export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$Get - extends StandardParameters { - /** - * The name of the operation resource. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$List - extends StandardParameters { - /** - * The standard list filter. - */ - filter?: string; - /** - * The name of the operation's parent resource. - */ - name?: string; - /** - * The standard list page size. - */ - pageSize?: number; - /** - * The standard list page token. - */ - pageToken?: string; - } - - export class Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Imports all SuggestionDenyListEntry for a DataStore. + * Tunes an existing engine. Only applicable if SolutionType is SOLUTION_TYPE_RECOMMENDATION. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - import( - params: Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Import, + tune( + params: Params$Resource$Projects$Locations$Collections$Engines$Tune, options: StreamMethodOptions ): GaxiosPromise; - import( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Import, + tune( + params?: Params$Resource$Projects$Locations$Collections$Engines$Tune, options?: MethodOptions ): GaxiosPromise; - import( - params: Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Import, + tune( + params: Params$Resource$Projects$Locations$Collections$Engines$Tune, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - import( - params: Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Import, + tune( + params: Params$Resource$Projects$Locations$Collections$Engines$Tune, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - import( - params: Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Import, + tune( + params: Params$Resource$Projects$Locations$Collections$Engines$Tune, callback: BodyResponseCallback ): void; - import( + tune( callback: BodyResponseCallback ): void; - import( + tune( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Import + | Params$Resource$Projects$Locations$Collections$Engines$Tune | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -15406,13 +17944,13 @@ export namespace discoveryengine_v1beta { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Import; + {}) as Params$Resource$Projects$Locations$Collections$Engines$Tune; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Import; + {} as Params$Resource$Projects$Locations$Collections$Engines$Tune; options = {}; } @@ -15426,17 +17964,18 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: ( - rootUrl + '/v1beta/{+parent}/suggestionDenyListEntries:import' - ).replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1beta/{+name}:tune').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { @@ -15448,67 +17987,176 @@ export namespace discoveryengine_v1beta { return createAPIRequest(parameters); } } + } + export interface Params$Resource$Projects$Locations$Collections$Engines$Create + extends StandardParameters { /** - * Permanently deletes all SuggestionDenyListEntry for a DataStore. + * Required. The ID to use for the Engine, which will become the final component of the Engine's resource name. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned. + */ + engineId?: string; + /** + * Required. The parent resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}`. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1betaEngine; + } + export interface Params$Resource$Projects$Locations$Collections$Engines$Delete + extends StandardParameters { + /** + * Required. Full resource name of Engine, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}`. If the caller does not have permission to delete the Engine, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the Engine to delete does not exist, a NOT_FOUND error is returned. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Engines$Get + extends StandardParameters { + /** + * Required. Full resource name of Engine, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}`. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Engines$List + extends StandardParameters { + /** + * Optional. Filter by solution type. For example: solution_type=SOLUTION_TYPE_SEARCH + */ + filter?: string; + /** + * Optional. Not supported. + */ + pageSize?: number; + /** + * Optional. Not supported. + */ + pageToken?: string; + /** + * Required. The parent resource name, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}`. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Engines$Patch + extends StandardParameters { + /** + * 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_number\}/locations/{location\}/collections/{collection\}/engines/{engine\}` engine should be 1-63 characters, and valid characters are /a-z0-9x/. Otherwise, an INVALID_ARGUMENT error is returned. + */ + name?: string; + /** + * Indicates which fields in the provided Engine to update. If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1betaEngine; + } + export interface Params$Resource$Projects$Locations$Collections$Engines$Pause + extends StandardParameters { + /** + * Required. The name of the engine to pause. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/engines/{engine_id\}` + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1betaPauseEngineRequest; + } + export interface Params$Resource$Projects$Locations$Collections$Engines$Resume + extends StandardParameters { + /** + * Required. The name of the engine to resume. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/engines/{engine_id\}` + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1betaResumeEngineRequest; + } + export interface Params$Resource$Projects$Locations$Collections$Engines$Tune + extends StandardParameters { + /** + * Required. The resource name of the engine to tune. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/engines/{engine_id\}` + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1betaTuneEngineRequest; + } + + export class Resource$Projects$Locations$Collections$Engines$Controls { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * 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. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - purge( - params: Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Purge, + create( + params: Params$Resource$Projects$Locations$Collections$Engines$Controls$Create, options: StreamMethodOptions ): GaxiosPromise; - purge( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Purge, + create( + params?: Params$Resource$Projects$Locations$Collections$Engines$Controls$Create, options?: MethodOptions - ): GaxiosPromise; - purge( - params: Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Purge, + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Collections$Engines$Controls$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - purge( - params: Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Purge, + create( + params: Params$Resource$Projects$Locations$Collections$Engines$Controls$Create, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - purge( - params: Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Purge, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Collections$Engines$Controls$Create, + callback: BodyResponseCallback ): void; - purge( - callback: BodyResponseCallback + create( + callback: BodyResponseCallback ): void; - purge( + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Purge - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Engines$Controls$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Purge; + {}) as Params$Resource$Projects$Locations$Collections$Engines$Controls$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Purge; + {} as Params$Resource$Projects$Locations$Collections$Engines$Controls$Create; options = {}; } @@ -15522,9 +18170,10 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: ( - rootUrl + '/v1beta/{+parent}/suggestionDenyListEntries:purge' - ).replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1beta/{+parent}/controls').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'POST', apiVersion: '', }, @@ -15536,103 +18185,73 @@ export namespace discoveryengine_v1beta { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } - } - - export interface Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Import - extends StandardParameters { - /** - * Required. The parent data store resource name for which to import denylist entries. Follows pattern projects/x/locations/x/collections/x/dataStores/x. - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1betaImportSuggestionDenyListEntriesRequest; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Purge - extends StandardParameters { - /** - * Required. The parent data store resource name for which to import denylist entries. Follows pattern projects/x/locations/x/collections/x/dataStores/x. - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1betaPurgeSuggestionDenyListEntriesRequest; - } - - export class Resource$Projects$Locations$Collections$Datastores$Userevents { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * 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. + * Deletes a Control. If the Control to delete does not exist, a NOT_FOUND error is returned. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - collect( - params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Collect, + delete( + params: Params$Resource$Projects$Locations$Collections$Engines$Controls$Delete, options: StreamMethodOptions ): GaxiosPromise; - collect( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Collect, + delete( + params?: Params$Resource$Projects$Locations$Collections$Engines$Controls$Delete, options?: MethodOptions - ): GaxiosPromise; - collect( - params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Collect, + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Collections$Engines$Controls$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - collect( - params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Collect, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Collections$Engines$Controls$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - collect( - params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Collect, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Collections$Engines$Controls$Delete, + callback: BodyResponseCallback ): void; - collect(callback: BodyResponseCallback): void; - collect( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Collect - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Engines$Controls$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Collect; + {}) as Params$Resource$Projects$Locations$Collections$Engines$Controls$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Collect; + {} as Params$Resource$Projects$Locations$Collections$Engines$Controls$Delete; options = {}; } @@ -15646,90 +18265,87 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+parent}/userEvents:collect').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * 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. + * Gets a Control. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - import( - params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Import, + get( + params: Params$Resource$Projects$Locations$Collections$Engines$Controls$Get, options: StreamMethodOptions ): GaxiosPromise; - import( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Import, + get( + params?: Params$Resource$Projects$Locations$Collections$Engines$Controls$Get, options?: MethodOptions - ): GaxiosPromise; - import( - params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Import, + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Collections$Engines$Controls$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - import( - params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Import, + get( + params: Params$Resource$Projects$Locations$Collections$Engines$Controls$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - import( - params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Import, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Collections$Engines$Controls$Get, + callback: BodyResponseCallback ): void; - import( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - import( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Import - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Engines$Controls$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Import; + {}) as Params$Resource$Projects$Locations$Collections$Engines$Controls$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Import; + {} as Params$Resource$Projects$Locations$Collections$Engines$Controls$Get; options = {}; } @@ -15743,90 +18359,89 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+parent}/userEvents:import').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Writes a single user event. + * Lists all Controls by their parent DataStore. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - write( - params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Write, + list( + params: Params$Resource$Projects$Locations$Collections$Engines$Controls$List, options: StreamMethodOptions ): GaxiosPromise; - write( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Write, + list( + params?: Params$Resource$Projects$Locations$Collections$Engines$Controls$List, options?: MethodOptions - ): GaxiosPromise; - write( - params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Write, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Collections$Engines$Controls$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - write( - params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Write, + list( + params: Params$Resource$Projects$Locations$Collections$Engines$Controls$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - write( - params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Write, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Collections$Engines$Controls$List, + callback: BodyResponseCallback ): void; - write( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - write( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Write - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Engines$Controls$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Write; + {}) as Params$Resource$Projects$Locations$Collections$Engines$Controls$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Write; + {} as Params$Resource$Projects$Locations$Collections$Engines$Controls$List; options = {}; } @@ -15840,11 +18455,11 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+parent}/userEvents:write').replace( + url: (rootUrl + '/v1beta/{+parent}/controls').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', apiVersion: '', }, options @@ -15855,157 +18470,77 @@ export namespace discoveryengine_v1beta { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } - } - - export interface Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Collect - extends StandardParameters { - /** - * The event timestamp in milliseconds. This prevents browser caching of otherwise identical get requests. The name is abbreviated to reduce the payload bytes. - */ - ets?: string; - /** - * Required. The parent DataStore resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}`. - */ - parent?: string; - /** - * 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 third-party requests. - */ - uri?: string; - /** - * Required. URL encoded UserEvent proto with a length limit of 2,000,000 characters. - */ - userEvent?: string; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Import - extends StandardParameters { - /** - * Required. Parent DataStore resource name, of the form `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}` - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1betaImportUserEventsRequest; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Write - extends StandardParameters { - /** - * Required. The parent resource name. If the write user event action is applied in DataStore level, the format is: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}`. If the write user event action is applied in Location level, for example, the event with Document across multiple DataStore, the format is: `projects/{project\}/locations/{location\}`. - */ - parent?: string; - /** - * If set to true, the user event is written asynchronously after validation, and the API responds without waiting for the write. - */ - writeAsync?: boolean; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1betaUserEvent; - } - - export class Resource$Projects$Locations$Collections$Engines { - context: APIRequestContext; - controls: Resource$Projects$Locations$Collections$Engines$Controls; - conversations: Resource$Projects$Locations$Collections$Engines$Conversations; - operations: Resource$Projects$Locations$Collections$Engines$Operations; - servingConfigs: Resource$Projects$Locations$Collections$Engines$Servingconfigs; - sessions: Resource$Projects$Locations$Collections$Engines$Sessions; - constructor(context: APIRequestContext) { - this.context = context; - this.controls = - new Resource$Projects$Locations$Collections$Engines$Controls( - this.context - ); - this.conversations = - new Resource$Projects$Locations$Collections$Engines$Conversations( - this.context - ); - this.operations = - new Resource$Projects$Locations$Collections$Engines$Operations( - this.context - ); - this.servingConfigs = - new Resource$Projects$Locations$Collections$Engines$Servingconfigs( - this.context - ); - this.sessions = - new Resource$Projects$Locations$Collections$Engines$Sessions( - this.context - ); - } /** - * Creates a Engine. + * Updates a Control. Control action type cannot be changed. If the Control to update does not exist, a NOT_FOUND error is returned. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - create( - params: Params$Resource$Projects$Locations$Collections$Engines$Create, + patch( + params: Params$Resource$Projects$Locations$Collections$Engines$Controls$Patch, options: StreamMethodOptions ): GaxiosPromise; - create( - params?: Params$Resource$Projects$Locations$Collections$Engines$Create, + patch( + params?: Params$Resource$Projects$Locations$Collections$Engines$Controls$Patch, options?: MethodOptions - ): GaxiosPromise; - create( - params: Params$Resource$Projects$Locations$Collections$Engines$Create, + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Collections$Engines$Controls$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Collections$Engines$Create, + patch( + params: Params$Resource$Projects$Locations$Collections$Engines$Controls$Patch, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Collections$Engines$Create, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Collections$Engines$Controls$Patch, + callback: BodyResponseCallback ): void; - create( - callback: BodyResponseCallback + patch( + callback: BodyResponseCallback ): void; - create( + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Engines$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Engines$Controls$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Engines$Create; + {}) as Params$Resource$Projects$Locations$Collections$Engines$Controls$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Engines$Create; + {} as Params$Resource$Projects$Locations$Collections$Engines$Controls$Patch; options = {}; } @@ -16019,184 +18554,162 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+parent}/engines').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } + } + export interface Params$Resource$Projects$Locations$Collections$Engines$Controls$Create + extends StandardParameters { /** - * Deletes a Engine. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. + * Required. The ID to use for the Control, which will become the final component of the Control's resource name. This value must be within 1-63 characters. Valid characters are /a-z-_/. */ - delete( - params: Params$Resource$Projects$Locations$Collections$Engines$Delete, - options: StreamMethodOptions - ): GaxiosPromise; - delete( - params?: Params$Resource$Projects$Locations$Collections$Engines$Delete, - options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Projects$Locations$Collections$Engines$Delete, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Projects$Locations$Collections$Engines$Delete, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Projects$Locations$Collections$Engines$Delete, - callback: BodyResponseCallback - ): void; - delete( - callback: BodyResponseCallback - ): void; - delete( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Engines$Delete - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Engines$Delete; - let options = (optionsOrCallback || {}) as MethodOptions; + controlId?: string; + /** + * Required. Full resource name of parent data store. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/dataStores/{data_store_id\}` or `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/engines/{engine_id\}`. + */ + parent?: string; - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Collections$Engines$Delete; - options = {}; - } + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1betaControl; + } + export interface Params$Resource$Projects$Locations$Collections$Engines$Controls$Delete + extends StandardParameters { + /** + * Required. The resource name of the Control to delete. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/dataStores/{data_store_id\}/controls/{control_id\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Engines$Controls$Get + extends StandardParameters { + /** + * Required. The resource name of the Control to get. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/dataStores/{data_store_id\}/controls/{control_id\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Engines$Controls$List + extends StandardParameters { + /** + * Optional. A filter to apply on the list results. Supported features: * List all the products under the parent branch if filter is unset. Currently this field is unsupported. + */ + filter?: string; + /** + * Optional. Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000. + */ + pageSize?: number; + /** + * Optional. A page token, received from a previous `ListControls` call. Provide this to retrieve the subsequent page. + */ + pageToken?: string; + /** + * Required. The data store resource name. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/dataStores/{data_store_id\}` or `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/engines/{engine_id\}`. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Engines$Controls$Patch + extends StandardParameters { + /** + * Immutable. Fully qualified name `projects/x/locations/global/dataStore/x/controls/x` + */ + name?: string; + /** + * Optional. Indicates which fields in the provided Control to update. The following are NOT supported: * Control.name * Control.solution_type If not set or empty, all supported fields are updated. + */ + updateMask?: string; - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1betaControl; + } - const rootUrl = - options.rootUrl || 'https://discoveryengine.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } + export class Resource$Projects$Locations$Collections$Engines$Conversations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; } /** - * Gets a Engine. + * Converses a conversation. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Collections$Engines$Get, + converse( + params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Converse, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Collections$Engines$Get, + converse( + params?: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Converse, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Collections$Engines$Get, + ): GaxiosPromise; + converse( + params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Converse, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Collections$Engines$Get, + converse( + params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Converse, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Collections$Engines$Get, - callback: BodyResponseCallback + converse( + params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Converse, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + converse( + callback: BodyResponseCallback ): void; - get( + converse( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Engines$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Engines$Conversations$Converse + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Engines$Get; + {}) as Params$Resource$Projects$Locations$Collections$Engines$Conversations$Converse; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Engines$Get; + {} as Params$Resource$Projects$Locations$Collections$Engines$Conversations$Converse; options = {}; } @@ -16210,8 +18723,11 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1beta/{+name}:converse').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options @@ -16222,77 +18738,77 @@ export namespace discoveryengine_v1beta { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Lists all the Engines associated with the project. + * Creates a Conversation. If the Conversation to create already exists, an ALREADY_EXISTS error is returned. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Collections$Engines$List, + create( + params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Create, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Collections$Engines$List, + create( + params?: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Create, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Collections$Engines$List, + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Collections$Engines$List, + create( + params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Create, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Collections$Engines$List, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Create, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + create( + callback: BodyResponseCallback ): void; - list( + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Engines$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Engines$Conversations$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Engines$List; + {}) as Params$Resource$Projects$Locations$Collections$Engines$Conversations$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Engines$List; + {} as Params$Resource$Projects$Locations$Collections$Engines$Conversations$Create; options = {}; } @@ -16306,11 +18822,11 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+parent}/engines').replace( + url: (rootUrl + '/v1beta/{+parent}/conversations').replace( /([^:]\/)\/+/g, '$1' ), - method: 'GET', + method: 'POST', apiVersion: '', }, options @@ -16321,77 +18837,73 @@ export namespace discoveryengine_v1beta { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Updates an Engine + * Deletes a Conversation. If the Conversation to delete does not exist, a NOT_FOUND error is returned. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - patch( - params: Params$Resource$Projects$Locations$Collections$Engines$Patch, + delete( + params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Delete, options: StreamMethodOptions ): GaxiosPromise; - patch( - params?: Params$Resource$Projects$Locations$Collections$Engines$Patch, + delete( + params?: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Delete, options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Projects$Locations$Collections$Engines$Patch, + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Collections$Engines$Patch, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - patch( - params: Params$Resource$Projects$Locations$Collections$Engines$Patch, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Delete, + callback: BodyResponseCallback ): void; - patch( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Engines$Patch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Engines$Conversations$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Engines$Patch; + {}) as Params$Resource$Projects$Locations$Collections$Engines$Conversations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Engines$Patch; + {} as Params$Resource$Projects$Locations$Collections$Engines$Conversations$Delete; options = {}; } @@ -16406,7 +18918,7 @@ export namespace discoveryengine_v1beta { options: Object.assign( { url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + method: 'DELETE', apiVersion: '', }, options @@ -16417,77 +18929,75 @@ export namespace discoveryengine_v1beta { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Pauses the training of an existing engine. Only applicable if SolutionType is SOLUTION_TYPE_RECOMMENDATION. + * Gets a Conversation. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - pause( - params: Params$Resource$Projects$Locations$Collections$Engines$Pause, + get( + params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Get, options: StreamMethodOptions ): GaxiosPromise; - pause( - params?: Params$Resource$Projects$Locations$Collections$Engines$Pause, - options?: MethodOptions - ): GaxiosPromise; - pause( - params: Params$Resource$Projects$Locations$Collections$Engines$Pause, + get( + params?: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - pause( - params: Params$Resource$Projects$Locations$Collections$Engines$Pause, + get( + params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - pause( - params: Params$Resource$Projects$Locations$Collections$Engines$Pause, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Get, + callback: BodyResponseCallback ): void; - pause( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - pause( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Engines$Pause - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Engines$Conversations$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Engines$Pause; + {}) as Params$Resource$Projects$Locations$Collections$Engines$Conversations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Engines$Pause; + {} as Params$Resource$Projects$Locations$Collections$Engines$Conversations$Get; options = {}; } @@ -16501,11 +19011,8 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+name}:pause').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options @@ -16516,77 +19023,77 @@ export namespace discoveryengine_v1beta { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Resumes the training of an existing engine. Only applicable if SolutionType is SOLUTION_TYPE_RECOMMENDATION. + * Lists all Conversations by their parent DataStore. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - resume( - params: Params$Resource$Projects$Locations$Collections$Engines$Resume, + list( + params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$List, options: StreamMethodOptions ): GaxiosPromise; - resume( - params?: Params$Resource$Projects$Locations$Collections$Engines$Resume, + list( + params?: Params$Resource$Projects$Locations$Collections$Engines$Conversations$List, options?: MethodOptions - ): GaxiosPromise; - resume( - params: Params$Resource$Projects$Locations$Collections$Engines$Resume, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - resume( - params: Params$Resource$Projects$Locations$Collections$Engines$Resume, + list( + params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - resume( - params: Params$Resource$Projects$Locations$Collections$Engines$Resume, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$List, + callback: BodyResponseCallback ): void; - resume( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - resume( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Engines$Resume - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Engines$Conversations$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Engines$Resume; + {}) as Params$Resource$Projects$Locations$Collections$Engines$Conversations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Engines$Resume; + {} as Params$Resource$Projects$Locations$Collections$Engines$Conversations$List; options = {}; } @@ -16600,92 +19107,92 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+name}:resume').replace( + url: (rootUrl + '/v1beta/{+parent}/conversations').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Tunes an existing engine. Only applicable if SolutionType is SOLUTION_TYPE_RECOMMENDATION. + * Updates a Conversation. Conversation action type cannot be changed. If the Conversation to update does not exist, a NOT_FOUND error is returned. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - tune( - params: Params$Resource$Projects$Locations$Collections$Engines$Tune, + patch( + params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Patch, options: StreamMethodOptions ): GaxiosPromise; - tune( - params?: Params$Resource$Projects$Locations$Collections$Engines$Tune, + patch( + params?: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Patch, options?: MethodOptions - ): GaxiosPromise; - tune( - params: Params$Resource$Projects$Locations$Collections$Engines$Tune, + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - tune( - params: Params$Resource$Projects$Locations$Collections$Engines$Tune, + patch( + params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Patch, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - tune( - params: Params$Resource$Projects$Locations$Collections$Engines$Tune, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Patch, + callback: BodyResponseCallback ): void; - tune( - callback: BodyResponseCallback + patch( + callback: BodyResponseCallback ): void; - tune( + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Engines$Tune - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Engines$Conversations$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Engines$Tune; + {}) as Params$Resource$Projects$Locations$Collections$Engines$Conversations$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Engines$Tune; + {} as Params$Resource$Projects$Locations$Collections$Engines$Conversations$Patch; options = {}; } @@ -16699,11 +19206,8 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+name}:tune').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', apiVersion: '', }, options @@ -16714,184 +19218,162 @@ export namespace discoveryengine_v1beta { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } } - export interface Params$Resource$Projects$Locations$Collections$Engines$Create + export interface Params$Resource$Projects$Locations$Collections$Engines$Conversations$Converse extends StandardParameters { /** - * Required. The ID to use for the Engine, which will become the final component of the Engine's resource name. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned. + * Required. The resource name of the Conversation to get. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/{conversation_id\}`. Use `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/-` to activate auto session mode, which automatically creates a new conversation inside a ConverseConversation session. */ - engineId?: string; + name?: string; + /** - * Required. The parent resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}`. + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1betaConverseConversationRequest; + } + export interface Params$Resource$Projects$Locations$Collections$Engines$Conversations$Create + extends StandardParameters { + /** + * Required. Full resource name of parent data store. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}` */ parent?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1betaEngine; + requestBody?: Schema$GoogleCloudDiscoveryengineV1betaConversation; } - export interface Params$Resource$Projects$Locations$Collections$Engines$Delete + export interface Params$Resource$Projects$Locations$Collections$Engines$Conversations$Delete extends StandardParameters { /** - * Required. Full resource name of Engine, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}`. If the caller does not have permission to delete the Engine, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the Engine to delete does not exist, a NOT_FOUND error is returned. + * Required. The resource name of the Conversation to delete. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/{conversation_id\}` */ name?: string; } - export interface Params$Resource$Projects$Locations$Collections$Engines$Get + export interface Params$Resource$Projects$Locations$Collections$Engines$Conversations$Get extends StandardParameters { /** - * Required. Full resource name of Engine, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}`. + * Required. The resource name of the Conversation to get. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/{conversation_id\}` */ name?: string; } - export interface Params$Resource$Projects$Locations$Collections$Engines$List + export interface Params$Resource$Projects$Locations$Collections$Engines$Conversations$List extends StandardParameters { /** - * Optional. Filter by solution type. For example: solution_type=SOLUTION_TYPE_SEARCH + * A filter to apply on the list results. The supported features are: user_pseudo_id, state. Example: "user_pseudo_id = some_id" */ filter?: string; /** - * Optional. Not supported. + * 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` * `conversation_name` Example: "update_time desc" "create_time" + */ + orderBy?: string; + /** + * Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000. */ pageSize?: number; /** - * Optional. Not supported. + * A page token, received from a previous `ListConversations` call. Provide this to retrieve the subsequent page. */ pageToken?: string; /** - * Required. The parent resource name, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}`. + * Required. The data store resource name. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}` */ parent?: string; } - export interface Params$Resource$Projects$Locations$Collections$Engines$Patch + export interface Params$Resource$Projects$Locations$Collections$Engines$Conversations$Patch extends StandardParameters { /** - * 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_number\}/locations/{location\}/collections/{collection\}/engines/{engine\}` engine should be 1-63 characters, and valid characters are /a-z0-9x/. Otherwise, an INVALID_ARGUMENT error is returned. + * Immutable. Fully qualified name `projects/{project\}/locations/global/collections/{collection\}/dataStore/x/conversations/x` or `projects/{project\}/locations/global/collections/{collection\}/engines/x/conversations/x`. */ name?: string; /** - * Indicates which fields in the provided Engine to update. If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned. + * Indicates which fields in the provided Conversation to update. The following are NOT supported: * Conversation.name If not set or empty, all supported fields are updated. */ updateMask?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1betaEngine; - } - export interface Params$Resource$Projects$Locations$Collections$Engines$Pause - extends StandardParameters { - /** - * Required. The name of the engine to pause. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/engines/{engine_id\}` - */ - name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1betaPauseEngineRequest; - } - export interface Params$Resource$Projects$Locations$Collections$Engines$Resume - extends StandardParameters { - /** - * Required. The name of the engine to resume. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/engines/{engine_id\}` - */ - name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1betaResumeEngineRequest; - } - export interface Params$Resource$Projects$Locations$Collections$Engines$Tune - extends StandardParameters { - /** - * Required. The resource name of the engine to tune. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/engines/{engine_id\}` - */ - name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1betaTuneEngineRequest; + requestBody?: Schema$GoogleCloudDiscoveryengineV1betaConversation; } - export class Resource$Projects$Locations$Collections$Engines$Controls { + export class Resource$Projects$Locations$Collections$Engines$Operations { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * 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. + * 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. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - create( - params: Params$Resource$Projects$Locations$Collections$Engines$Controls$Create, + get( + params: Params$Resource$Projects$Locations$Collections$Engines$Operations$Get, options: StreamMethodOptions ): GaxiosPromise; - create( - params?: Params$Resource$Projects$Locations$Collections$Engines$Controls$Create, + get( + params?: Params$Resource$Projects$Locations$Collections$Engines$Operations$Get, options?: MethodOptions - ): GaxiosPromise; - create( - params: Params$Resource$Projects$Locations$Collections$Engines$Controls$Create, + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Collections$Engines$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Collections$Engines$Controls$Create, + get( + params: Params$Resource$Projects$Locations$Collections$Engines$Operations$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Collections$Engines$Controls$Create, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Collections$Engines$Operations$Get, + callback: BodyResponseCallback ): void; - create( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - create( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Engines$Controls$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Engines$Operations$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Engines$Controls$Create; + {}) as Params$Resource$Projects$Locations$Collections$Engines$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Engines$Controls$Create; + {} as Params$Resource$Projects$Locations$Collections$Engines$Operations$Get; options = {}; } @@ -16905,88 +19387,220 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+parent}/controls').replace( + url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Locations$Collections$Engines$Operations$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Collections$Engines$Operations$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Collections$Engines$Operations$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Collections$Engines$Operations$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Collections$Engines$Operations$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Collections$Engines$Operations$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Collections$Engines$Operations$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Collections$Engines$Operations$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta/{+name}/operations').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } + } + export interface Params$Resource$Projects$Locations$Collections$Engines$Operations$Get + extends StandardParameters { /** - * Deletes a Control. If the Control to delete does not exist, a NOT_FOUND error is returned. + * The name of the operation resource. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Engines$Operations$List + extends StandardParameters { + /** + * The standard list filter. + */ + filter?: string; + /** + * The name of the operation's parent resource. + */ + name?: string; + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. + */ + pageToken?: string; + } + + export class Resource$Projects$Locations$Collections$Engines$Servingconfigs { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Answer query method. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - delete( - params: Params$Resource$Projects$Locations$Collections$Engines$Controls$Delete, + answer( + params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Answer, options: StreamMethodOptions ): GaxiosPromise; - delete( - params?: Params$Resource$Projects$Locations$Collections$Engines$Controls$Delete, + answer( + params?: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Answer, options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Projects$Locations$Collections$Engines$Controls$Delete, + ): GaxiosPromise; + answer( + params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Answer, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Collections$Engines$Controls$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + answer( + params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Answer, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Collections$Engines$Controls$Delete, - callback: BodyResponseCallback + answer( + params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Answer, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + answer( + callback: BodyResponseCallback + ): void; + answer( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Engines$Controls$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Answer + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Engines$Controls$Delete; + {}) as Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Answer; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Engines$Controls$Delete; + {} as Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Answer; options = {}; } @@ -17000,29 +19614,34 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1beta/{+servingConfig}:answer').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), - params, - requiredParams: ['name'], - pathParams: ['name'], + params, + requiredParams: ['servingConfig'], + pathParams: ['servingConfig'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Gets a Control. + * Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not exist. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -17030,57 +19649,57 @@ export namespace discoveryengine_v1beta { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Collections$Engines$Controls$Get, + params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get, options: StreamMethodOptions ): GaxiosPromise; get( - params?: Params$Resource$Projects$Locations$Collections$Engines$Controls$Get, + params?: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; get( - params: Params$Resource$Projects$Locations$Collections$Engines$Controls$Get, + params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Collections$Engines$Controls$Get, + params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Collections$Engines$Controls$Get, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get, + callback: BodyResponseCallback ): void; get( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Engines$Controls$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Engines$Controls$Get; + {}) as Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Engines$Controls$Get; + {} as Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get; options = {}; } @@ -17106,19 +19725,19 @@ export namespace discoveryengine_v1beta { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Lists all Controls by their parent DataStore. + * Lists all ServingConfigs linked to this dataStore. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -17126,57 +19745,57 @@ export namespace discoveryengine_v1beta { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Collections$Engines$Controls$List, + params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$List, options: StreamMethodOptions ): GaxiosPromise; list( - params?: Params$Resource$Projects$Locations$Collections$Engines$Controls$List, + params?: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$List, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; list( - params: Params$Resource$Projects$Locations$Collections$Engines$Controls$List, + params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Collections$Engines$Controls$List, + params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Collections$Engines$Controls$List, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$List, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Engines$Controls$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Engines$Controls$List; + {}) as Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Engines$Controls$List; + {} as Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$List; options = {}; } @@ -17190,7 +19809,7 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+parent}/controls').replace( + url: (rootUrl + '/v1beta/{+parent}/servingConfigs').replace( /([^:]\/)\/+/g, '$1' ), @@ -17205,19 +19824,19 @@ export namespace discoveryengine_v1beta { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Updates a Control. Control action type cannot be changed. If the Control to update does not exist, a NOT_FOUND error is returned. + * Updates a ServingConfig. Returns a NOT_FOUND error if the ServingConfig does not exist. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -17225,57 +19844,57 @@ export namespace discoveryengine_v1beta { * @returns A promise if used with async/await, or void if used with a callback. */ patch( - params: Params$Resource$Projects$Locations$Collections$Engines$Controls$Patch, + params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Patch, options: StreamMethodOptions ): GaxiosPromise; patch( - params?: Params$Resource$Projects$Locations$Collections$Engines$Controls$Patch, + params?: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Patch, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; patch( - params: Params$Resource$Projects$Locations$Collections$Engines$Controls$Patch, + params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; patch( - params: Params$Resource$Projects$Locations$Collections$Engines$Controls$Patch, + params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Patch, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; patch( - params: Params$Resource$Projects$Locations$Collections$Engines$Controls$Patch, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Patch, + callback: BodyResponseCallback ): void; patch( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Engines$Controls$Patch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Engines$Controls$Patch; + {}) as Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Engines$Controls$Patch; + {} as Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Patch; options = {}; } @@ -17301,150 +19920,176 @@ export namespace discoveryengine_v1beta { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } - } - export interface Params$Resource$Projects$Locations$Collections$Engines$Controls$Create - extends StandardParameters { - /** - * Required. The ID to use for the Control, which will become the final component of the Control's resource name. This value must be within 1-63 characters. Valid characters are /a-z-_/. - */ - controlId?: string; /** - * Required. Full resource name of parent data store. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/dataStores/{data_store_id\}` or `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/engines/{engine_id\}`. + * Makes a recommendation, which requires a contextual user event. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. */ - parent?: string; + recommend( + params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Recommend, + options: StreamMethodOptions + ): GaxiosPromise; + recommend( + params?: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Recommend, + options?: MethodOptions + ): GaxiosPromise; + recommend( + params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Recommend, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + recommend( + params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Recommend, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + recommend( + params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Recommend, + callback: BodyResponseCallback + ): void; + recommend( + callback: BodyResponseCallback + ): void; + recommend( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Recommend + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Recommend; + let options = (optionsOrCallback || {}) as MethodOptions; - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1betaControl; - } - export interface Params$Resource$Projects$Locations$Collections$Engines$Controls$Delete - extends StandardParameters { - /** - * Required. The resource name of the Control to delete. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/dataStores/{data_store_id\}/controls/{control_id\}` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Collections$Engines$Controls$Get - extends StandardParameters { - /** - * Required. The resource name of the Control to get. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/dataStores/{data_store_id\}/controls/{control_id\}` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Collections$Engines$Controls$List - extends StandardParameters { - /** - * Optional. A filter to apply on the list results. Supported features: * List all the products under the parent branch if filter is unset. Currently this field is unsupported. - */ - filter?: string; - /** - * Optional. Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000. - */ - pageSize?: number; - /** - * Optional. A page token, received from a previous `ListControls` call. Provide this to retrieve the subsequent page. - */ - pageToken?: string; - /** - * Required. The data store resource name. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/dataStores/{data_store_id\}` or `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/engines/{engine_id\}`. - */ - parent?: string; - } - export interface Params$Resource$Projects$Locations$Collections$Engines$Controls$Patch - extends StandardParameters { - /** - * Immutable. Fully qualified name `projects/x/locations/global/dataStore/x/controls/x` - */ - name?: string; - /** - * Optional. Indicates which fields in the provided Control to update. The following are NOT supported: * Control.name * Control.solution_type If not set or empty, all supported fields are updated. - */ - updateMask?: string; + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Recommend; + options = {}; + } - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1betaControl; - } + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } - export class Resource$Projects$Locations$Collections$Engines$Conversations { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta/{+servingConfig}:recommend').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['servingConfig'], + pathParams: ['servingConfig'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } } /** - * Converses a conversation. + * Performs a search. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - converse( - params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Converse, + search( + params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Search, options: StreamMethodOptions ): GaxiosPromise; - converse( - params?: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Converse, + search( + params?: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Search, options?: MethodOptions - ): GaxiosPromise; - converse( - params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Converse, + ): GaxiosPromise; + search( + params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Search, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - converse( - params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Converse, + search( + params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Search, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - converse( - params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Converse, - callback: BodyResponseCallback + search( + params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Search, + callback: BodyResponseCallback ): void; - converse( - callback: BodyResponseCallback + search( + callback: BodyResponseCallback ): void; - converse( + search( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Engines$Conversations$Converse - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Search + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Engines$Conversations$Converse; + {}) as Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Search; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Engines$Conversations$Converse; + {} as Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Search; options = {}; } @@ -17458,7 +20103,7 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+name}:converse').replace( + url: (rootUrl + '/v1beta/{+servingConfig}:search').replace( /([^:]\/)\/+/g, '$1' ), @@ -17468,24 +20113,111 @@ export namespace discoveryengine_v1beta { options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['servingConfig'], + pathParams: ['servingConfig'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } + } + + export interface Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Answer + extends StandardParameters { + /** + * Required. The resource name of the Search serving config, such as `projects/x/locations/global/collections/default_collection/engines/x/servingConfigs/default_serving_config`, or `projects/x/locations/global/collections/default_collection/dataStores/x/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. + */ + servingConfig?: string; /** - * Creates a Conversation. If the Conversation to create already exists, an ALREADY_EXISTS error is returned. + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryRequest; + } + export interface Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get + extends StandardParameters { + /** + * Required. The resource name of the ServingConfig to get. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/engines/{engine\}/servingConfigs/{serving_config_id\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$List + extends StandardParameters { + /** + * Optional. Maximum number of results to return. If unspecified, defaults to 100. If a value greater than 100 is provided, at most 100 results are returned. + */ + pageSize?: number; + /** + * Optional. A page token, received from a previous `ListServingConfigs` call. Provide this to retrieve the subsequent page. + */ + pageToken?: string; + /** + * Required. Full resource name of the parent resource. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/engines/{engine\}` + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Patch + extends StandardParameters { + /** + * Immutable. Fully qualified name `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}/servingConfigs/{serving_config_id\}` + */ + name?: string; + /** + * Indicates which fields in the provided ServingConfig to update. The following are NOT supported: * ServingConfig.name If not set, all supported fields are updated. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1betaServingConfig; + } + export interface Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Recommend + extends StandardParameters { + /** + * Required. Full resource name of a ServingConfig: `projects/x/locations/global/collections/x/engines/x/servingConfigs/x`, or `projects/x/locations/global/collections/x/dataStores/x/servingConfigs/x` One default serving config is created along with your recommendation engine creation. The engine ID is used as the ID of the default serving config. For example, for Engine `projects/x/locations/global/collections/x/engines/my-engine`, you can use `projects/x/locations/global/collections/x/engines/my-engine/servingConfigs/my-engine` for your RecommendationService.Recommend requests. + */ + servingConfig?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1betaRecommendRequest; + } + export interface Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Search + extends StandardParameters { + /** + * Required. The resource name of the Search serving config, such as `projects/x/locations/global/collections/default_collection/engines/x/servingConfigs/default_serving_config`, or `projects/x/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. + */ + servingConfig?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequest; + } + + export class Resource$Projects$Locations$Collections$Engines$Sessions { + context: APIRequestContext; + answers: Resource$Projects$Locations$Collections$Engines$Sessions$Answers; + constructor(context: APIRequestContext) { + this.context = context; + this.answers = + new Resource$Projects$Locations$Collections$Engines$Sessions$Answers( + this.context + ); + } + + /** + * Creates a Session. If the Session to create already exists, an ALREADY_EXISTS error is returned. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -17493,57 +20225,57 @@ export namespace discoveryengine_v1beta { * @returns A promise if used with async/await, or void if used with a callback. */ create( - params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Create, + params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Create, options: StreamMethodOptions ): GaxiosPromise; create( - params?: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Create, + params?: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Create, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; create( - params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Create, + params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; create( - params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Create, + params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Create, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; create( - params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Create, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Create, + callback: BodyResponseCallback ): void; create( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Engines$Conversations$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Engines$Sessions$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Engines$Conversations$Create; + {}) as Params$Resource$Projects$Locations$Collections$Engines$Sessions$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Engines$Conversations$Create; + {} as Params$Resource$Projects$Locations$Collections$Engines$Sessions$Create; options = {}; } @@ -17557,7 +20289,7 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+parent}/conversations').replace( + url: (rootUrl + '/v1beta/{+parent}/sessions').replace( /([^:]\/)\/+/g, '$1' ), @@ -17572,19 +20304,19 @@ export namespace discoveryengine_v1beta { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * 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. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -17592,31 +20324,31 @@ export namespace discoveryengine_v1beta { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Delete, + params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Delete, options: StreamMethodOptions ): GaxiosPromise; delete( - params?: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Delete, + params?: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Delete, options?: MethodOptions ): GaxiosPromise; delete( - params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Delete, + params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Delete, + params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Delete, + params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Delete, callback: BodyResponseCallback ): void; delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Engines$Conversations$Delete + | Params$Resource$Projects$Locations$Collections$Engines$Sessions$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -17632,13 +20364,13 @@ export namespace discoveryengine_v1beta { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Engines$Conversations$Delete; + {}) as Params$Resource$Projects$Locations$Collections$Engines$Sessions$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Engines$Conversations$Delete; + {} as Params$Resource$Projects$Locations$Collections$Engines$Sessions$Delete; options = {}; } @@ -17674,7 +20406,7 @@ export namespace discoveryengine_v1beta { } /** - * Gets a Conversation. + * Gets a Session. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -17682,57 +20414,57 @@ export namespace discoveryengine_v1beta { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Get, + params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Get, options: StreamMethodOptions ): GaxiosPromise; get( - params?: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Get, + params?: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Get, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; get( - params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Get, + params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Get, + params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Get, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Get, + callback: BodyResponseCallback ): void; get( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Engines$Conversations$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Engines$Sessions$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Engines$Conversations$Get; + {}) as Params$Resource$Projects$Locations$Collections$Engines$Sessions$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Engines$Conversations$Get; + {} as Params$Resource$Projects$Locations$Collections$Engines$Sessions$Get; options = {}; } @@ -17758,19 +20490,19 @@ export namespace discoveryengine_v1beta { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Lists all Conversations by their parent DataStore. + * Lists all Sessions by their parent DataStore. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -17778,57 +20510,57 @@ export namespace discoveryengine_v1beta { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$List, + params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$List, options: StreamMethodOptions ): GaxiosPromise; list( - params?: Params$Resource$Projects$Locations$Collections$Engines$Conversations$List, + params?: Params$Resource$Projects$Locations$Collections$Engines$Sessions$List, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; list( - params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$List, + params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$List, + params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$List, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$List, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Engines$Conversations$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Engines$Sessions$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Engines$Conversations$List; + {}) as Params$Resource$Projects$Locations$Collections$Engines$Sessions$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Engines$Conversations$List; + {} as Params$Resource$Projects$Locations$Collections$Engines$Sessions$List; options = {}; } @@ -17842,7 +20574,7 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+parent}/conversations').replace( + url: (rootUrl + '/v1beta/{+parent}/sessions').replace( /([^:]\/)\/+/g, '$1' ), @@ -17857,19 +20589,19 @@ export namespace discoveryengine_v1beta { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Updates a Conversation. Conversation action type cannot be changed. If the Conversation to update does not exist, a NOT_FOUND error is returned. + * Updates a Session. Session action type cannot be changed. If the Session to update does not exist, a NOT_FOUND error is returned. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -17877,57 +20609,57 @@ export namespace discoveryengine_v1beta { * @returns A promise if used with async/await, or void if used with a callback. */ patch( - params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Patch, + params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Patch, options: StreamMethodOptions ): GaxiosPromise; patch( - params?: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Patch, + params?: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Patch, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; patch( - params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Patch, + params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; patch( - params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Patch, + params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Patch, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; patch( - params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Patch, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Patch, + callback: BodyResponseCallback ): void; patch( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Engines$Conversations$Patch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Engines$Sessions$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Engines$Conversations$Patch; + {}) as Params$Resource$Projects$Locations$Collections$Engines$Sessions$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Engines$Conversations$Patch; + {} as Params$Resource$Projects$Locations$Collections$Engines$Sessions$Patch; options = {}; } @@ -17953,97 +20685,196 @@ export namespace discoveryengine_v1beta { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } } - export interface Params$Resource$Projects$Locations$Collections$Engines$Conversations$Converse + export interface Params$Resource$Projects$Locations$Collections$Engines$Sessions$Create extends StandardParameters { /** - * Required. The resource name of the Conversation to get. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/{conversation_id\}`. Use `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/-` to activate auto session mode, which automatically creates a new conversation inside a ConverseConversation session. + * Required. Full resource name of parent data store. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1betaSession; + } + export interface Params$Resource$Projects$Locations$Collections$Engines$Sessions$Delete + extends StandardParameters { + /** + * Required. The resource name of the Session to delete. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/sessions/{session_id\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Engines$Sessions$Get + extends StandardParameters { + /** + * Required. The resource name of the Session to get. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/sessions/{session_id\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Engines$Sessions$List + extends StandardParameters { + /** + * A filter to apply on the list results. The supported features are: user_pseudo_id, state. Example: "user_pseudo_id = some_id" + */ + filter?: string; + /** + * 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` Example: "update_time desc" "create_time" + */ + orderBy?: string; + /** + * Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000. + */ + pageSize?: number; + /** + * A page token, received from a previous `ListSessions` call. Provide this to retrieve the subsequent page. + */ + pageToken?: string; + /** + * Required. The data store resource name. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}` + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Engines$Sessions$Patch + extends StandardParameters { + /** + * Immutable. Fully qualified name `projects/{project\}/locations/global/collections/{collection\}/engines/{engine\}/sessions/x` */ name?: string; + /** + * 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. + */ + updateMask?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1betaConverseConversationRequest; + requestBody?: Schema$GoogleCloudDiscoveryengineV1betaSession; + } + + export class Resource$Projects$Locations$Collections$Engines$Sessions$Answers { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Gets a Answer. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Answers$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Answers$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Answers$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Answers$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Answers$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Collections$Engines$Sessions$Answers$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Collections$Engines$Sessions$Answers$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Collections$Engines$Sessions$Answers$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } } - export interface Params$Resource$Projects$Locations$Collections$Engines$Conversations$Create - extends StandardParameters { - /** - * Required. Full resource name of parent data store. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}` - */ - parent?: string; - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1betaConversation; - } - export interface Params$Resource$Projects$Locations$Collections$Engines$Conversations$Delete - extends StandardParameters { - /** - * Required. The resource name of the Conversation to delete. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/{conversation_id\}` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Collections$Engines$Conversations$Get - extends StandardParameters { - /** - * Required. The resource name of the Conversation to get. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/{conversation_id\}` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Collections$Engines$Conversations$List - extends StandardParameters { - /** - * A filter to apply on the list results. The supported features are: user_pseudo_id, state. Example: "user_pseudo_id = some_id" - */ - filter?: string; - /** - * 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` * `conversation_name` Example: "update_time desc" "create_time" - */ - orderBy?: string; - /** - * Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000. - */ - pageSize?: number; - /** - * A page token, received from a previous `ListConversations` call. Provide this to retrieve the subsequent page. - */ - pageToken?: string; - /** - * Required. The data store resource name. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}` - */ - parent?: string; - } - export interface Params$Resource$Projects$Locations$Collections$Engines$Conversations$Patch + export interface Params$Resource$Projects$Locations$Collections$Engines$Sessions$Answers$Get extends StandardParameters { /** - * Immutable. Fully qualified name `projects/{project\}/locations/global/collections/{collection\}/dataStore/x/conversations/x` or `projects/{project\}/locations/global/collections/{collection\}/engines/x/conversations/x`. + * Required. The resource name of the Answer to get. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/engines/{engine_id\}/sessions/{session_id\}/answers/{answer_id\}` */ name?: string; - /** - * Indicates which fields in the provided Conversation to update. The following are NOT supported: * Conversation.name If not set or empty, all supported fields are updated. - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1betaConversation; } - export class Resource$Projects$Locations$Collections$Engines$Operations { + export class Resource$Projects$Locations$Collections$Operations { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; @@ -18058,27 +20889,27 @@ export namespace discoveryengine_v1beta { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Collections$Engines$Operations$Get, + params: Params$Resource$Projects$Locations$Collections$Operations$Get, options: StreamMethodOptions ): GaxiosPromise; get( - params?: Params$Resource$Projects$Locations$Collections$Engines$Operations$Get, + params?: Params$Resource$Projects$Locations$Collections$Operations$Get, options?: MethodOptions ): GaxiosPromise; get( - params: Params$Resource$Projects$Locations$Collections$Engines$Operations$Get, + params: Params$Resource$Projects$Locations$Collections$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Collections$Engines$Operations$Get, + params: Params$Resource$Projects$Locations$Collections$Operations$Get, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Collections$Engines$Operations$Get, + params: Params$Resource$Projects$Locations$Collections$Operations$Get, callback: BodyResponseCallback ): void; get( @@ -18086,7 +20917,7 @@ export namespace discoveryengine_v1beta { ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Engines$Operations$Get + | Params$Resource$Projects$Locations$Collections$Operations$Get | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -18102,13 +20933,13 @@ export namespace discoveryengine_v1beta { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Engines$Operations$Get; + {}) as Params$Resource$Projects$Locations$Collections$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Engines$Operations$Get; + {} as Params$Resource$Projects$Locations$Collections$Operations$Get; options = {}; } @@ -18152,27 +20983,27 @@ export namespace discoveryengine_v1beta { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Collections$Engines$Operations$List, + params: Params$Resource$Projects$Locations$Collections$Operations$List, options: StreamMethodOptions ): GaxiosPromise; list( - params?: Params$Resource$Projects$Locations$Collections$Engines$Operations$List, + params?: Params$Resource$Projects$Locations$Collections$Operations$List, options?: MethodOptions ): GaxiosPromise; list( - params: Params$Resource$Projects$Locations$Collections$Engines$Operations$List, + params: Params$Resource$Projects$Locations$Collections$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Collections$Engines$Operations$List, + params: Params$Resource$Projects$Locations$Collections$Operations$List, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Collections$Engines$Operations$List, + params: Params$Resource$Projects$Locations$Collections$Operations$List, callback: BodyResponseCallback ): void; list( @@ -18180,7 +21011,7 @@ export namespace discoveryengine_v1beta { ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Engines$Operations$List + | Params$Resource$Projects$Locations$Collections$Operations$List | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -18196,13 +21027,13 @@ export namespace discoveryengine_v1beta { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Engines$Operations$List; + {}) as Params$Resource$Projects$Locations$Collections$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Engines$Operations$List; + {} as Params$Resource$Projects$Locations$Collections$Operations$List; options = {}; } @@ -18243,14 +21074,14 @@ export namespace discoveryengine_v1beta { } } - export interface Params$Resource$Projects$Locations$Collections$Engines$Operations$Get + export interface Params$Resource$Projects$Locations$Collections$Operations$Get extends StandardParameters { /** * The name of the operation resource. */ name?: string; } - export interface Params$Resource$Projects$Locations$Collections$Engines$Operations$List + export interface Params$Resource$Projects$Locations$Collections$Operations$List extends StandardParameters { /** * The standard list filter. @@ -18270,72 +21101,219 @@ export namespace discoveryengine_v1beta { pageToken?: string; } - export class Resource$Projects$Locations$Collections$Engines$Servingconfigs { + export class Resource$Projects$Locations$Datastores { context: APIRequestContext; + branches: Resource$Projects$Locations$Datastores$Branches; + completionSuggestions: Resource$Projects$Locations$Datastores$Completionsuggestions; + controls: Resource$Projects$Locations$Datastores$Controls; + conversations: Resource$Projects$Locations$Datastores$Conversations; + models: Resource$Projects$Locations$Datastores$Models; + operations: Resource$Projects$Locations$Datastores$Operations; + schemas: Resource$Projects$Locations$Datastores$Schemas; + servingConfigs: Resource$Projects$Locations$Datastores$Servingconfigs; + sessions: Resource$Projects$Locations$Datastores$Sessions; + siteSearchEngine: Resource$Projects$Locations$Datastores$Sitesearchengine; + suggestionDenyListEntries: Resource$Projects$Locations$Datastores$Suggestiondenylistentries; + userEvents: Resource$Projects$Locations$Datastores$Userevents; constructor(context: APIRequestContext) { this.context = context; + this.branches = new Resource$Projects$Locations$Datastores$Branches( + this.context + ); + this.completionSuggestions = + new Resource$Projects$Locations$Datastores$Completionsuggestions( + this.context + ); + this.controls = new Resource$Projects$Locations$Datastores$Controls( + this.context + ); + this.conversations = + new Resource$Projects$Locations$Datastores$Conversations(this.context); + this.models = new Resource$Projects$Locations$Datastores$Models( + this.context + ); + this.operations = new Resource$Projects$Locations$Datastores$Operations( + this.context + ); + this.schemas = new Resource$Projects$Locations$Datastores$Schemas( + this.context + ); + this.servingConfigs = + new Resource$Projects$Locations$Datastores$Servingconfigs(this.context); + this.sessions = new Resource$Projects$Locations$Datastores$Sessions( + this.context + ); + this.siteSearchEngine = + new Resource$Projects$Locations$Datastores$Sitesearchengine( + this.context + ); + this.suggestionDenyListEntries = + new Resource$Projects$Locations$Datastores$Suggestiondenylistentries( + this.context + ); + this.userEvents = new Resource$Projects$Locations$Datastores$Userevents( + this.context + ); + } + + /** + * Completes the specified user input with keyword suggestions. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + completeQuery( + params: Params$Resource$Projects$Locations$Datastores$Completequery, + options: StreamMethodOptions + ): GaxiosPromise; + completeQuery( + params?: Params$Resource$Projects$Locations$Datastores$Completequery, + options?: MethodOptions + ): GaxiosPromise; + completeQuery( + params: Params$Resource$Projects$Locations$Datastores$Completequery, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + completeQuery( + params: Params$Resource$Projects$Locations$Datastores$Completequery, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + completeQuery( + params: Params$Resource$Projects$Locations$Datastores$Completequery, + callback: BodyResponseCallback + ): void; + completeQuery( + callback: BodyResponseCallback + ): void; + completeQuery( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Datastores$Completequery + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Datastores$Completequery; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Datastores$Completequery; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta/{+dataStore}:completeQuery').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['dataStore'], + pathParams: ['dataStore'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } } /** - * Answer query method. + * 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. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - answer( - params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Answer, + create( + params: Params$Resource$Projects$Locations$Datastores$Create, options: StreamMethodOptions ): GaxiosPromise; - answer( - params?: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Answer, + create( + params?: Params$Resource$Projects$Locations$Datastores$Create, options?: MethodOptions - ): GaxiosPromise; - answer( - params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Answer, + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Datastores$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - answer( - params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Answer, + create( + params: Params$Resource$Projects$Locations$Datastores$Create, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - answer( - params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Answer, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Datastores$Create, + callback: BodyResponseCallback ): void; - answer( - callback: BodyResponseCallback + create( + callback: BodyResponseCallback ): void; - answer( + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Answer - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Answer; + {}) as Params$Resource$Projects$Locations$Datastores$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Answer; + params = {} as Params$Resource$Projects$Locations$Datastores$Create; options = {}; } @@ -18349,7 +21327,7 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+servingConfig}:answer').replace( + url: (rootUrl + '/v1beta/{+parent}/dataStores').replace( /([^:]\/)\/+/g, '$1' ), @@ -18359,82 +21337,79 @@ export namespace discoveryengine_v1beta { options ), params, - requiredParams: ['servingConfig'], - pathParams: ['servingConfig'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not exist. + * Deletes a DataStore. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get, + delete( + params: Params$Resource$Projects$Locations$Datastores$Delete, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get, + delete( + params?: Params$Resource$Projects$Locations$Datastores$Delete, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get, + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Datastores$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get, + delete( + params: Params$Resource$Projects$Locations$Datastores$Delete, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Datastores$Delete, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + delete( + callback: BodyResponseCallback ): void; - get( + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get; + {}) as Params$Resource$Projects$Locations$Datastores$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get; + params = {} as Params$Resource$Projects$Locations$Datastores$Delete; options = {}; } @@ -18449,7 +21424,7 @@ export namespace discoveryengine_v1beta { options: Object.assign( { url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'DELETE', apiVersion: '', }, options @@ -18460,77 +21435,74 @@ export namespace discoveryengine_v1beta { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Lists all ServingConfigs linked to this dataStore. + * Gets a DataStore. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$List, + get( + params: Params$Resource$Projects$Locations$Datastores$Get, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$List, + get( + params?: Params$Resource$Projects$Locations$Datastores$Get, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$List, + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Datastores$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$List, + get( + params: Params$Resource$Projects$Locations$Datastores$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$List, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Datastores$Get, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - list( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$List; + {}) as Params$Resource$Projects$Locations$Datastores$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$List; + params = {} as Params$Resource$Projects$Locations$Datastores$Get; options = {}; } @@ -18544,92 +21516,89 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+parent}/servingConfigs').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Updates a ServingConfig. Returns a NOT_FOUND error if the ServingConfig does not exist. + * Gets the SiteSearchEngine. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - patch( - params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Patch, + getSiteSearchEngine( + params: Params$Resource$Projects$Locations$Datastores$Getsitesearchengine, options: StreamMethodOptions ): GaxiosPromise; - patch( - params?: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Patch, + getSiteSearchEngine( + params?: Params$Resource$Projects$Locations$Datastores$Getsitesearchengine, options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Patch, + ): GaxiosPromise; + getSiteSearchEngine( + params: Params$Resource$Projects$Locations$Datastores$Getsitesearchengine, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Patch, + getSiteSearchEngine( + params: Params$Resource$Projects$Locations$Datastores$Getsitesearchengine, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Patch, - callback: BodyResponseCallback + getSiteSearchEngine( + params: Params$Resource$Projects$Locations$Datastores$Getsitesearchengine, + callback: BodyResponseCallback ): void; - patch( - callback: BodyResponseCallback + getSiteSearchEngine( + callback: BodyResponseCallback ): void; - patch( + getSiteSearchEngine( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Patch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Getsitesearchengine + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Patch; + {}) as Params$Resource$Projects$Locations$Datastores$Getsitesearchengine; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Patch; + {} as Params$Resource$Projects$Locations$Datastores$Getsitesearchengine; options = {}; } @@ -18644,7 +21613,7 @@ export namespace discoveryengine_v1beta { options: Object.assign( { url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + method: 'GET', apiVersion: '', }, options @@ -18655,77 +21624,76 @@ export namespace discoveryengine_v1beta { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Makes a recommendation, which requires a contextual user event. + * Lists all the DataStores associated with the project. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - recommend( - params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Recommend, + list( + params: Params$Resource$Projects$Locations$Datastores$List, options: StreamMethodOptions - ): GaxiosPromise; - recommend( - params?: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Recommend, + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Datastores$List, options?: MethodOptions - ): GaxiosPromise; - recommend( - params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Recommend, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Datastores$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - recommend( - params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Recommend, + list( + params: Params$Resource$Projects$Locations$Datastores$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - recommend( - params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Recommend, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Datastores$List, + callback: BodyResponseCallback ): void; - recommend( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - recommend( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Recommend - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Recommend; + {}) as Params$Resource$Projects$Locations$Datastores$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Recommend; + params = {} as Params$Resource$Projects$Locations$Datastores$List; options = {}; } @@ -18739,92 +21707,91 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+servingConfig}:recommend').replace( + url: (rootUrl + '/v1beta/{+parent}/dataStores').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['servingConfig'], - pathParams: ['servingConfig'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Performs a search. + * Updates a DataStore * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - search( - params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Search, + patch( + params: Params$Resource$Projects$Locations$Datastores$Patch, options: StreamMethodOptions ): GaxiosPromise; - search( - params?: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Search, + patch( + params?: Params$Resource$Projects$Locations$Datastores$Patch, options?: MethodOptions - ): GaxiosPromise; - search( - params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Search, + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Datastores$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - search( - params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Search, + patch( + params: Params$Resource$Projects$Locations$Datastores$Patch, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - search( - params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Search, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Datastores$Patch, + callback: BodyResponseCallback ): void; - search( - callback: BodyResponseCallback + patch( + callback: BodyResponseCallback ): void; - search( + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Search - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Search; + {}) as Params$Resource$Projects$Locations$Datastores$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Search; + params = {} as Params$Resource$Projects$Locations$Datastores$Patch; options = {}; } @@ -18838,121 +21805,155 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+servingConfig}:search').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', apiVersion: '', }, options ), params, - requiredParams: ['servingConfig'], - pathParams: ['servingConfig'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } } - export interface Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Answer + export interface Params$Resource$Projects$Locations$Datastores$Completequery extends StandardParameters { /** - * Required. The resource name of the Search serving config, such as `projects/x/locations/global/collections/default_collection/engines/x/servingConfigs/default_serving_config`, or `projects/x/locations/global/collections/default_collection/dataStores/x/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. + * Required. The parent data store resource name for which the completion is performed, such as `projects/x/locations/global/collections/default_collection/dataStores/default_data_store`. */ - servingConfig?: string; - + dataStore?: string; /** - * Request body metadata + * 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. */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryRequest; - } - export interface Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get - extends StandardParameters { + includeTailSuggestions?: boolean; /** - * Required. The resource name of the ServingConfig to get. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/engines/{engine\}/servingConfigs/{serving_config_id\}` + * Required. The typeahead input used to fetch suggestions. Maximum length is 128 characters. */ - name?: string; + query?: string; + /** + * Specifies the autocomplete data model. 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. + */ + queryModel?: string; + /** + * 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 SearchRequest.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. + */ + userPseudoId?: string; } - export interface Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$List + export interface Params$Resource$Projects$Locations$Datastores$Create extends StandardParameters { /** - * Optional. Maximum number of results to return. If unspecified, defaults to 100. If a value greater than 100 is provided, at most 100 results are returned. + * A boolean flag indicating whether user want to directly create an advanced data store for site search. If the data store is not configured as site search (GENERIC vertical and PUBLIC_WEBSITE content_config), this flag will be ignored. */ - pageSize?: number; + createAdvancedSiteSearch?: boolean; /** - * Optional. A page token, received from a previous `ListServingConfigs` call. Provide this to retrieve the subsequent page. + * Required. The ID to use for the DataStore, which will become the final component of the DataStore's resource name. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned. */ - pageToken?: string; + dataStoreId?: string; /** - * Required. Full resource name of the parent resource. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/engines/{engine\}` + * Required. The parent resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}`. */ parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1betaDataStore; } - export interface Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Patch + export interface Params$Resource$Projects$Locations$Datastores$Delete extends StandardParameters { /** - * Immutable. Fully qualified name `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}/servingConfigs/{serving_config_id\}` + * Required. Full resource name of DataStore, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}`. If the caller does not have permission to delete the DataStore, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the DataStore to delete does not exist, a NOT_FOUND error is returned. */ name?: string; + } + export interface Params$Resource$Projects$Locations$Datastores$Get + extends StandardParameters { /** - * Indicates which fields in the provided ServingConfig to update. The following are NOT supported: * ServingConfig.name If not set, all supported fields are updated. + * Required. Full resource name of DataStore, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}`. If the caller does not have permission to access the DataStore, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested DataStore does not exist, a NOT_FOUND error is returned. */ - updateMask?: string; - + name?: string; + } + export interface Params$Resource$Projects$Locations$Datastores$Getsitesearchengine + extends StandardParameters { /** - * Request body metadata + * Required. Resource name of SiteSearchEngine, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine`. If the caller does not have permission to access the [SiteSearchEngine], regardless of whether or not it exists, a PERMISSION_DENIED error is returned. */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1betaServingConfig; + name?: string; } - export interface Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Recommend + export interface Params$Resource$Projects$Locations$Datastores$List extends StandardParameters { /** - * Required. Full resource name of a ServingConfig: `projects/x/locations/global/collections/x/engines/x/servingConfigs/x`, or `projects/x/locations/global/collections/x/dataStores/x/servingConfigs/x` One default serving config is created along with your recommendation engine creation. The engine ID is used as the ID of the default serving config. For example, for Engine `projects/x/locations/global/collections/x/engines/my-engine`, you can use `projects/x/locations/global/collections/x/engines/my-engine/servingConfigs/my-engine` for your RecommendationService.Recommend requests. + * Filter by solution type . For example: `filter = 'solution_type:SOLUTION_TYPE_SEARCH'` */ - servingConfig?: string; - + filter?: string; /** - * Request body metadata + * Maximum number of DataStores to return. If unspecified, defaults to 10. The maximum allowed value is 50. Values above 50 will be coerced to 50. If this field is negative, an INVALID_ARGUMENT is returned. */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1betaRecommendRequest; + pageSize?: number; + /** + * A page token ListDataStoresResponse.next_page_token, received from a previous DataStoreService.ListDataStores call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to DataStoreService.ListDataStores must match the call that provided the page token. Otherwise, an INVALID_ARGUMENT error is returned. + */ + pageToken?: string; + /** + * Required. The parent branch resource name, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}`. If the caller does not have permission to list DataStores under this location, regardless of whether or not this data store exists, a PERMISSION_DENIED error is returned. + */ + parent?: string; } - export interface Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Search + export interface Params$Resource$Projects$Locations$Datastores$Patch extends StandardParameters { /** - * Required. The resource name of the Search serving config, such as `projects/x/locations/global/collections/default_collection/engines/x/servingConfigs/default_serving_config`, or `projects/x/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. + * 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. */ - servingConfig?: string; + name?: string; + /** + * Indicates which fields in the provided DataStore to update. If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned. + */ + updateMask?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequest; + requestBody?: Schema$GoogleCloudDiscoveryengineV1betaDataStore; } - export class Resource$Projects$Locations$Collections$Engines$Sessions { + export class Resource$Projects$Locations$Datastores$Branches { context: APIRequestContext; - answers: Resource$Projects$Locations$Collections$Engines$Sessions$Answers; + documents: Resource$Projects$Locations$Datastores$Branches$Documents; + operations: Resource$Projects$Locations$Datastores$Branches$Operations; constructor(context: APIRequestContext) { this.context = context; - this.answers = - new Resource$Projects$Locations$Collections$Engines$Sessions$Answers( + this.documents = + new Resource$Projects$Locations$Datastores$Branches$Documents( this.context ); + this.operations = + new Resource$Projects$Locations$Datastores$Branches$Operations( + this.context + ); + } + } + + export class Resource$Projects$Locations$Datastores$Branches$Documents { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; } /** - * Creates a Session. If the Session to create already exists, an ALREADY_EXISTS error is returned. + * Creates a Document. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -18960,57 +21961,57 @@ export namespace discoveryengine_v1beta { * @returns A promise if used with async/await, or void if used with a callback. */ create( - params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Create, + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Create, options: StreamMethodOptions ): GaxiosPromise; create( - params?: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Create, + params?: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Create, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; create( - params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Create, + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; create( - params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Create, + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Create, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; create( - params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Create, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Create, + callback: BodyResponseCallback ): void; create( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Engines$Sessions$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Branches$Documents$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Engines$Sessions$Create; + {}) as Params$Resource$Projects$Locations$Datastores$Branches$Documents$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Engines$Sessions$Create; + {} as Params$Resource$Projects$Locations$Datastores$Branches$Documents$Create; options = {}; } @@ -19024,7 +22025,7 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+parent}/sessions').replace( + url: (rootUrl + '/v1beta/{+parent}/documents').replace( /([^:]\/)\/+/g, '$1' ), @@ -19039,19 +22040,19 @@ export namespace discoveryengine_v1beta { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Deletes a Session. If the Session to delete does not exist, a NOT_FOUND error is returned. + * Deletes a Document. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -19059,31 +22060,31 @@ export namespace discoveryengine_v1beta { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Delete, + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Delete, options: StreamMethodOptions ): GaxiosPromise; delete( - params?: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Delete, + params?: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Delete, options?: MethodOptions ): GaxiosPromise; delete( - params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Delete, + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Delete, + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Delete, + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Delete, callback: BodyResponseCallback ): void; delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Engines$Sessions$Delete + | Params$Resource$Projects$Locations$Datastores$Branches$Documents$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -19099,13 +22100,13 @@ export namespace discoveryengine_v1beta { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Engines$Sessions$Delete; + {}) as Params$Resource$Projects$Locations$Datastores$Branches$Documents$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Engines$Sessions$Delete; + {} as Params$Resource$Projects$Locations$Datastores$Branches$Documents$Delete; options = {}; } @@ -19141,7 +22142,7 @@ export namespace discoveryengine_v1beta { } /** - * Gets a Session. + * Gets a Document. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -19149,57 +22150,250 @@ export namespace discoveryengine_v1beta { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Get, + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Get, options: StreamMethodOptions ): GaxiosPromise; get( - params?: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Get, + params?: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Get, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; get( - params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Get, + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Get, + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Get, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Get, + callback: BodyResponseCallback ): void; get( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Engines$Sessions$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Branches$Documents$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Datastores$Branches$Documents$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Datastores$Branches$Documents$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * 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. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + import( + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Import, + options: StreamMethodOptions + ): GaxiosPromise; + import( + params?: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Import, + options?: MethodOptions + ): GaxiosPromise; + import( + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Import, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + import( + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Import, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + import( + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Import, + callback: BodyResponseCallback + ): void; + import( + callback: BodyResponseCallback + ): void; + import( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Datastores$Branches$Documents$Import + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Datastores$Branches$Documents$Import; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Datastores$Branches$Documents$Import; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta/{+parent}/documents:import').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets a list of Documents. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Datastores$Branches$Documents$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Datastores$Branches$Documents$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Engines$Sessions$Get; + {}) as Params$Resource$Projects$Locations$Datastores$Branches$Documents$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Engines$Sessions$Get; + {} as Params$Resource$Projects$Locations$Datastores$Branches$Documents$List; options = {}; } @@ -19213,89 +22407,92 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1beta/{+parent}/documents').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Lists all Sessions by their parent DataStore. + * Updates a Document. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$List, + patch( + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Patch, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Collections$Engines$Sessions$List, + patch( + params?: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Patch, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$List, + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$List, + patch( + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Patch, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$List, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Patch, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + patch( + callback: BodyResponseCallback ): void; - list( + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Engines$Sessions$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Branches$Documents$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Engines$Sessions$List; + {}) as Params$Resource$Projects$Locations$Datastores$Branches$Documents$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Engines$Sessions$List; + {} as Params$Resource$Projects$Locations$Datastores$Branches$Documents$Patch; options = {}; } @@ -19309,92 +22506,89 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+parent}/sessions').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Updates a Session. Session action type cannot be changed. If the Session to update does not exist, a NOT_FOUND error is returned. + * 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. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - patch( - params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Patch, + purge( + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Purge, options: StreamMethodOptions ): GaxiosPromise; - patch( - params?: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Patch, + purge( + params?: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Purge, options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Patch, + ): GaxiosPromise; + purge( + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Purge, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Patch, + purge( + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Purge, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Patch, - callback: BodyResponseCallback + purge( + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Purge, + callback: BodyResponseCallback ): void; - patch( - callback: BodyResponseCallback + purge( + callback: BodyResponseCallback ): void; - patch( + purge( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Engines$Sessions$Patch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Branches$Documents$Purge + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Engines$Sessions$Patch; + {}) as Params$Resource$Projects$Locations$Datastores$Branches$Documents$Purge; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Engines$Sessions$Patch; + {} as Params$Resource$Projects$Locations$Datastores$Branches$Documents$Purge; options = {}; } @@ -19408,162 +22602,183 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + url: (rootUrl + '/v1beta/{+parent}/documents:purge').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } } - export interface Params$Resource$Projects$Locations$Collections$Engines$Sessions$Create + export interface Params$Resource$Projects$Locations$Datastores$Branches$Documents$Create extends StandardParameters { /** - * Required. Full resource name of parent data store. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}` + * Required. The ID to use for the Document, which becomes the final component of the Document.name. If the caller does not have permission to create the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. This field must be unique among all Documents with the same parent. Otherwise, an `ALREADY_EXISTS` error is returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. + */ + documentId?: string; + /** + * Required. The parent resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}`. */ parent?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1betaSession; + requestBody?: Schema$GoogleCloudDiscoveryengineV1betaDocument; } - export interface Params$Resource$Projects$Locations$Collections$Engines$Sessions$Delete + export interface Params$Resource$Projects$Locations$Datastores$Branches$Documents$Delete extends StandardParameters { /** - * Required. The resource name of the Session to delete. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/sessions/{session_id\}` + * Required. Full resource name of Document, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}/documents/{document\}`. If the caller does not have permission to delete the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the Document to delete does not exist, a `NOT_FOUND` error is returned. */ name?: string; } - export interface Params$Resource$Projects$Locations$Collections$Engines$Sessions$Get + export interface Params$Resource$Projects$Locations$Datastores$Branches$Documents$Get extends StandardParameters { /** - * Required. The resource name of the Session to get. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/sessions/{session_id\}` + * Required. Full resource name of Document, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}/documents/{document\}`. If the caller does not have permission to access the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the requested Document does not exist, a `NOT_FOUND` error is returned. */ name?: string; } - export interface Params$Resource$Projects$Locations$Collections$Engines$Sessions$List + export interface Params$Resource$Projects$Locations$Datastores$Branches$Documents$Import extends StandardParameters { /** - * A filter to apply on the list results. The supported features are: user_pseudo_id, state. Example: "user_pseudo_id = some_id" + * Required. The parent branch resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}`. Requires create/update permission. */ - filter?: string; + parent?: string; + /** - * 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` Example: "update_time desc" "create_time" + * Request body metadata */ - orderBy?: string; + requestBody?: Schema$GoogleCloudDiscoveryengineV1betaImportDocumentsRequest; + } + export interface Params$Resource$Projects$Locations$Datastores$Branches$Documents$List + extends StandardParameters { /** - * Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000. + * Maximum number of Documents to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 are set to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned. */ pageSize?: number; /** - * A page token, received from a previous `ListSessions` call. Provide this to retrieve the subsequent page. + * A page token ListDocumentsResponse.next_page_token, received from a previous DocumentService.ListDocuments call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to DocumentService.ListDocuments must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned. */ pageToken?: string; /** - * Required. The data store resource name. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}` + * Required. The parent branch resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}`. Use `default_branch` as the branch ID, to list documents under the default branch. If the caller does not have permission to list Documents under this branch, regardless of whether or not this branch exists, a `PERMISSION_DENIED` error is returned. */ parent?: string; } - export interface Params$Resource$Projects$Locations$Collections$Engines$Sessions$Patch + export interface Params$Resource$Projects$Locations$Datastores$Branches$Documents$Patch extends StandardParameters { /** - * Immutable. Fully qualified name `projects/{project\}/locations/global/collections/{collection\}/engines/{engine\}/sessions/x` + * If set to `true` and the Document is not found, a new Document is be created. + */ + allowMissing?: boolean; + /** + * 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?: string; /** - * 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. + * Indicates which fields in the provided imported 'document' to update. If not set, by default updates all fields. */ updateMask?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1betaSession; + requestBody?: Schema$GoogleCloudDiscoveryengineV1betaDocument; + } + export interface Params$Resource$Projects$Locations$Datastores$Branches$Documents$Purge + extends StandardParameters { + /** + * Required. The parent resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}`. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1betaPurgeDocumentsRequest; } - export class Resource$Projects$Locations$Collections$Engines$Sessions$Answers { + export class Resource$Projects$Locations$Datastores$Branches$Operations { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * Gets a Answer. + * 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`. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Answers$Get, + cancel( + params: Params$Resource$Projects$Locations$Datastores$Branches$Operations$Cancel, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Answers$Get, + cancel( + params?: Params$Resource$Projects$Locations$Datastores$Branches$Operations$Cancel, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Answers$Get, + ): GaxiosPromise; + cancel( + params: Params$Resource$Projects$Locations$Datastores$Branches$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Answers$Get, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Answers$Get, - callback: BodyResponseCallback + cancel( + params: Params$Resource$Projects$Locations$Datastores$Branches$Operations$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + cancel( + params: Params$Resource$Projects$Locations$Datastores$Branches$Operations$Cancel, + callback: BodyResponseCallback ): void; - get( + cancel(callback: BodyResponseCallback): void; + cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Engines$Sessions$Answers$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Branches$Operations$Cancel + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Engines$Sessions$Answers$Get; + {}) as Params$Resource$Projects$Locations$Datastores$Branches$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Engines$Sessions$Answers$Get; + {} as Params$Resource$Projects$Locations$Datastores$Branches$Operations$Cancel; options = {}; } @@ -19577,8 +22792,11 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1beta/{+name}:cancel').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options @@ -19589,31 +22807,14 @@ export namespace discoveryengine_v1beta { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Projects$Locations$Collections$Engines$Sessions$Answers$Get - extends StandardParameters { - /** - * Required. The resource name of the Answer to get. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/engines/{engine_id\}/sessions/{session_id\}/answers/{answer_id\}` - */ - name?: string; - } - - export class Resource$Projects$Locations$Collections$Operations { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** * 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. @@ -19624,27 +22825,27 @@ export namespace discoveryengine_v1beta { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Collections$Operations$Get, + params: Params$Resource$Projects$Locations$Datastores$Branches$Operations$Get, options: StreamMethodOptions ): GaxiosPromise; get( - params?: Params$Resource$Projects$Locations$Collections$Operations$Get, + params?: Params$Resource$Projects$Locations$Datastores$Branches$Operations$Get, options?: MethodOptions ): GaxiosPromise; get( - params: Params$Resource$Projects$Locations$Collections$Operations$Get, + params: Params$Resource$Projects$Locations$Datastores$Branches$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Collections$Operations$Get, + params: Params$Resource$Projects$Locations$Datastores$Branches$Operations$Get, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Collections$Operations$Get, + params: Params$Resource$Projects$Locations$Datastores$Branches$Operations$Get, callback: BodyResponseCallback ): void; get( @@ -19652,7 +22853,7 @@ export namespace discoveryengine_v1beta { ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Operations$Get + | Params$Resource$Projects$Locations$Datastores$Branches$Operations$Get | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -19668,13 +22869,13 @@ export namespace discoveryengine_v1beta { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Operations$Get; + {}) as Params$Resource$Projects$Locations$Datastores$Branches$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Operations$Get; + {} as Params$Resource$Projects$Locations$Datastores$Branches$Operations$Get; options = {}; } @@ -19718,27 +22919,27 @@ export namespace discoveryengine_v1beta { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Collections$Operations$List, + params: Params$Resource$Projects$Locations$Datastores$Branches$Operations$List, options: StreamMethodOptions ): GaxiosPromise; list( - params?: Params$Resource$Projects$Locations$Collections$Operations$List, + params?: Params$Resource$Projects$Locations$Datastores$Branches$Operations$List, options?: MethodOptions ): GaxiosPromise; list( - params: Params$Resource$Projects$Locations$Collections$Operations$List, + params: Params$Resource$Projects$Locations$Datastores$Branches$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Collections$Operations$List, + params: Params$Resource$Projects$Locations$Datastores$Branches$Operations$List, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Collections$Operations$List, + params: Params$Resource$Projects$Locations$Datastores$Branches$Operations$List, callback: BodyResponseCallback ): void; list( @@ -19746,7 +22947,7 @@ export namespace discoveryengine_v1beta { ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Operations$List + | Params$Resource$Projects$Locations$Datastores$Branches$Operations$List | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -19762,13 +22963,13 @@ export namespace discoveryengine_v1beta { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Operations$List; + {}) as Params$Resource$Projects$Locations$Datastores$Branches$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Operations$List; + {} as Params$Resource$Projects$Locations$Datastores$Branches$Operations$List; options = {}; } @@ -19809,225 +23010,89 @@ export namespace discoveryengine_v1beta { } } - export interface Params$Resource$Projects$Locations$Collections$Operations$Get + export interface Params$Resource$Projects$Locations$Datastores$Branches$Operations$Cancel extends StandardParameters { /** - * The name of the operation resource. + * The name of the operation resource to be cancelled. */ name?: string; - } - export interface Params$Resource$Projects$Locations$Collections$Operations$List - extends StandardParameters { + /** - * The standard list filter. + * Request body metadata */ - filter?: string; + requestBody?: Schema$GoogleLongrunningCancelOperationRequest; + } + export interface Params$Resource$Projects$Locations$Datastores$Branches$Operations$Get + extends StandardParameters { /** - * The name of the operation's parent resource. + * The name of the operation resource. */ name?: string; - /** - * The standard list page size. - */ - pageSize?: number; - /** - * The standard list page token. - */ - pageToken?: string; } - - export class Resource$Projects$Locations$Datastores { - context: APIRequestContext; - branches: Resource$Projects$Locations$Datastores$Branches; - completionSuggestions: Resource$Projects$Locations$Datastores$Completionsuggestions; - controls: Resource$Projects$Locations$Datastores$Controls; - conversations: Resource$Projects$Locations$Datastores$Conversations; - models: Resource$Projects$Locations$Datastores$Models; - operations: Resource$Projects$Locations$Datastores$Operations; - schemas: Resource$Projects$Locations$Datastores$Schemas; - servingConfigs: Resource$Projects$Locations$Datastores$Servingconfigs; - sessions: Resource$Projects$Locations$Datastores$Sessions; - siteSearchEngine: Resource$Projects$Locations$Datastores$Sitesearchengine; - suggestionDenyListEntries: Resource$Projects$Locations$Datastores$Suggestiondenylistentries; - userEvents: Resource$Projects$Locations$Datastores$Userevents; - constructor(context: APIRequestContext) { - this.context = context; - this.branches = new Resource$Projects$Locations$Datastores$Branches( - this.context - ); - this.completionSuggestions = - new Resource$Projects$Locations$Datastores$Completionsuggestions( - this.context - ); - this.controls = new Resource$Projects$Locations$Datastores$Controls( - this.context - ); - this.conversations = - new Resource$Projects$Locations$Datastores$Conversations(this.context); - this.models = new Resource$Projects$Locations$Datastores$Models( - this.context - ); - this.operations = new Resource$Projects$Locations$Datastores$Operations( - this.context - ); - this.schemas = new Resource$Projects$Locations$Datastores$Schemas( - this.context - ); - this.servingConfigs = - new Resource$Projects$Locations$Datastores$Servingconfigs(this.context); - this.sessions = new Resource$Projects$Locations$Datastores$Sessions( - this.context - ); - this.siteSearchEngine = - new Resource$Projects$Locations$Datastores$Sitesearchengine( - this.context - ); - this.suggestionDenyListEntries = - new Resource$Projects$Locations$Datastores$Suggestiondenylistentries( - this.context - ); - this.userEvents = new Resource$Projects$Locations$Datastores$Userevents( - this.context - ); - } - + export interface Params$Resource$Projects$Locations$Datastores$Branches$Operations$List + extends StandardParameters { /** - * Completes the specified user input with keyword suggestions. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. + * The standard list filter. */ - completeQuery( - params: Params$Resource$Projects$Locations$Datastores$Completequery, - options: StreamMethodOptions - ): GaxiosPromise; - completeQuery( - params?: Params$Resource$Projects$Locations$Datastores$Completequery, - options?: MethodOptions - ): GaxiosPromise; - completeQuery( - params: Params$Resource$Projects$Locations$Datastores$Completequery, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - completeQuery( - params: Params$Resource$Projects$Locations$Datastores$Completequery, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - completeQuery( - params: Params$Resource$Projects$Locations$Datastores$Completequery, - callback: BodyResponseCallback - ): void; - completeQuery( - callback: BodyResponseCallback - ): void; - completeQuery( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Completequery - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Completequery; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Datastores$Completequery; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://discoveryengine.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1beta/{+dataStore}:completeQuery').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['dataStore'], - pathParams: ['dataStore'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest( - parameters - ); - } + filter?: string; + /** + * The name of the operation's parent resource. + */ + name?: string; + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. + */ + pageToken?: string; + } + + export class Resource$Projects$Locations$Datastores$Completionsuggestions { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; } /** - * 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. + * Imports CompletionSuggestions for a DataStore. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - create( - params: Params$Resource$Projects$Locations$Datastores$Create, + import( + params: Params$Resource$Projects$Locations$Datastores$Completionsuggestions$Import, options: StreamMethodOptions ): GaxiosPromise; - create( - params?: Params$Resource$Projects$Locations$Datastores$Create, + import( + params?: Params$Resource$Projects$Locations$Datastores$Completionsuggestions$Import, options?: MethodOptions ): GaxiosPromise; - create( - params: Params$Resource$Projects$Locations$Datastores$Create, + import( + params: Params$Resource$Projects$Locations$Datastores$Completionsuggestions$Import, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Datastores$Create, + import( + params: Params$Resource$Projects$Locations$Datastores$Completionsuggestions$Import, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Datastores$Create, + import( + params: Params$Resource$Projects$Locations$Datastores$Completionsuggestions$Import, callback: BodyResponseCallback ): void; - create( + import( callback: BodyResponseCallback ): void; - create( + import( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Create + | Params$Resource$Projects$Locations$Datastores$Completionsuggestions$Import | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -20043,12 +23108,13 @@ export namespace discoveryengine_v1beta { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Create; + {}) as Params$Resource$Projects$Locations$Datastores$Completionsuggestions$Import; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datastores$Create; + params = + {} as Params$Resource$Projects$Locations$Datastores$Completionsuggestions$Import; options = {}; } @@ -20062,10 +23128,9 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+parent}/dataStores').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: ( + rootUrl + '/v1beta/{+parent}/completionSuggestions:import' + ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', }, @@ -20087,43 +23152,43 @@ export namespace discoveryengine_v1beta { } /** - * Deletes a DataStore. + * Permanently deletes all CompletionSuggestions for a DataStore. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - delete( - params: Params$Resource$Projects$Locations$Datastores$Delete, + purge( + params: Params$Resource$Projects$Locations$Datastores$Completionsuggestions$Purge, options: StreamMethodOptions ): GaxiosPromise; - delete( - params?: Params$Resource$Projects$Locations$Datastores$Delete, + purge( + params?: Params$Resource$Projects$Locations$Datastores$Completionsuggestions$Purge, options?: MethodOptions ): GaxiosPromise; - delete( - params: Params$Resource$Projects$Locations$Datastores$Delete, + purge( + params: Params$Resource$Projects$Locations$Datastores$Completionsuggestions$Purge, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Datastores$Delete, + purge( + params: Params$Resource$Projects$Locations$Datastores$Completionsuggestions$Purge, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Datastores$Delete, + purge( + params: Params$Resource$Projects$Locations$Datastores$Completionsuggestions$Purge, callback: BodyResponseCallback ): void; - delete( + purge( callback: BodyResponseCallback ): void; - delete( + purge( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Delete + | Params$Resource$Projects$Locations$Datastores$Completionsuggestions$Purge | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -20139,12 +23204,13 @@ export namespace discoveryengine_v1beta { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Delete; + {}) as Params$Resource$Projects$Locations$Datastores$Completionsuggestions$Purge; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datastores$Delete; + params = + {} as Params$Resource$Projects$Locations$Datastores$Completionsuggestions$Purge; options = {}; } @@ -20158,15 +23224,17 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: ( + rootUrl + '/v1beta/{+parent}/completionSuggestions:purge' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { @@ -20178,66 +23246,99 @@ export namespace discoveryengine_v1beta { return createAPIRequest(parameters); } } + } + + export interface Params$Resource$Projects$Locations$Datastores$Completionsuggestions$Import + extends StandardParameters { + /** + * Required. The parent data store resource name for which to import customer autocomplete suggestions. Follows pattern `projects/x/locations/x/collections/x/dataStores/x` + */ + parent?: string; /** - * Gets a DataStore. + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1betaImportCompletionSuggestionsRequest; + } + export interface Params$Resource$Projects$Locations$Datastores$Completionsuggestions$Purge + extends StandardParameters { + /** + * Required. The parent data store resource name for which to purge completion suggestions. Follows pattern projects/x/locations/x/collections/x/dataStores/x. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1betaPurgeCompletionSuggestionsRequest; + } + + export class Resource$Projects$Locations$Datastores$Controls { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * 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. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Datastores$Get, + create( + params: Params$Resource$Projects$Locations$Datastores$Controls$Create, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Datastores$Get, + create( + params?: Params$Resource$Projects$Locations$Datastores$Controls$Create, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Datastores$Get, + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Datastores$Controls$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Datastores$Get, + create( + params: Params$Resource$Projects$Locations$Datastores$Controls$Create, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Datastores$Get, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Datastores$Controls$Create, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + create( + callback: BodyResponseCallback ): void; - get( + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Controls$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Get; + {}) as Params$Resource$Projects$Locations$Datastores$Controls$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datastores$Get; + params = + {} as Params$Resource$Projects$Locations$Datastores$Controls$Create; options = {}; } @@ -20251,89 +23352,88 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1beta/{+parent}/controls').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Gets the SiteSearchEngine. + * Deletes a Control. If the Control to delete does not exist, a NOT_FOUND error is returned. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - getSiteSearchEngine( - params: Params$Resource$Projects$Locations$Datastores$Getsitesearchengine, + delete( + params: Params$Resource$Projects$Locations$Datastores$Controls$Delete, options: StreamMethodOptions ): GaxiosPromise; - getSiteSearchEngine( - params?: Params$Resource$Projects$Locations$Datastores$Getsitesearchengine, + delete( + params?: Params$Resource$Projects$Locations$Datastores$Controls$Delete, options?: MethodOptions - ): GaxiosPromise; - getSiteSearchEngine( - params: Params$Resource$Projects$Locations$Datastores$Getsitesearchengine, + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Datastores$Controls$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - getSiteSearchEngine( - params: Params$Resource$Projects$Locations$Datastores$Getsitesearchengine, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - getSiteSearchEngine( - params: Params$Resource$Projects$Locations$Datastores$Getsitesearchengine, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Datastores$Controls$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - getSiteSearchEngine( - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Datastores$Controls$Delete, + callback: BodyResponseCallback ): void; - getSiteSearchEngine( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Getsitesearchengine - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Controls$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Getsitesearchengine; + {}) as Params$Resource$Projects$Locations$Datastores$Controls$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Getsitesearchengine; + {} as Params$Resource$Projects$Locations$Datastores$Controls$Delete; options = {}; } @@ -20348,7 +23448,7 @@ export namespace discoveryengine_v1beta { options: Object.assign( { url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'DELETE', apiVersion: '', }, options @@ -20359,76 +23459,75 @@ export namespace discoveryengine_v1beta { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Lists all the DataStores associated with the project. + * Gets a Control. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Datastores$List, + get( + params: Params$Resource$Projects$Locations$Datastores$Controls$Get, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Datastores$List, + get( + params?: Params$Resource$Projects$Locations$Datastores$Controls$Get, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Datastores$List, + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Datastores$Controls$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Datastores$List, + get( + params: Params$Resource$Projects$Locations$Datastores$Controls$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Datastores$List, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Datastores$Controls$Get, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - list( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Controls$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$List; + {}) as Params$Resource$Projects$Locations$Datastores$Controls$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datastores$List; + params = + {} as Params$Resource$Projects$Locations$Datastores$Controls$Get; options = {}; } @@ -20442,91 +23541,89 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+parent}/dataStores').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Updates a DataStore + * Lists all Controls by their parent DataStore. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - patch( - params: Params$Resource$Projects$Locations$Datastores$Patch, + list( + params: Params$Resource$Projects$Locations$Datastores$Controls$List, options: StreamMethodOptions ): GaxiosPromise; - patch( - params?: Params$Resource$Projects$Locations$Datastores$Patch, + list( + params?: Params$Resource$Projects$Locations$Datastores$Controls$List, options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Projects$Locations$Datastores$Patch, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Datastores$Controls$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Datastores$Patch, + list( + params: Params$Resource$Projects$Locations$Datastores$Controls$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Datastores$Patch, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Datastores$Controls$List, + callback: BodyResponseCallback ): void; - patch( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - patch( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Patch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Controls$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Patch; + {}) as Params$Resource$Projects$Locations$Datastores$Controls$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datastores$Patch; + params = + {} as Params$Resource$Projects$Locations$Datastores$Controls$List; options = {}; } @@ -20540,213 +23637,92 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + url: (rootUrl + '/v1beta/{+parent}/controls').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', apiVersion: '', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest( - parameters - ); - } - } - } - - export interface Params$Resource$Projects$Locations$Datastores$Completequery - extends StandardParameters { - /** - * Required. The parent data store resource name for which the completion is performed, such as `projects/x/locations/global/collections/default_collection/dataStores/default_data_store`. - */ - dataStore?: string; - /** - * 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. - */ - includeTailSuggestions?: boolean; - /** - * Required. The typeahead input used to fetch suggestions. Maximum length is 128 characters. - */ - query?: string; - /** - * Specifies the autocomplete data model. 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. - */ - queryModel?: string; - /** - * 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 SearchRequest.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. - */ - userPseudoId?: string; - } - export interface Params$Resource$Projects$Locations$Datastores$Create - extends StandardParameters { - /** - * A boolean flag indicating whether user want to directly create an advanced data store for site search. If the data store is not configured as site search (GENERIC vertical and PUBLIC_WEBSITE content_config), this flag will be ignored. - */ - createAdvancedSiteSearch?: boolean; - /** - * Required. The ID to use for the DataStore, which will become the final component of the DataStore's resource name. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned. - */ - dataStoreId?: string; - /** - * Required. The parent resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}`. - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1betaDataStore; - } - export interface Params$Resource$Projects$Locations$Datastores$Delete - extends StandardParameters { - /** - * Required. Full resource name of DataStore, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}`. If the caller does not have permission to delete the DataStore, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the DataStore to delete does not exist, a NOT_FOUND error is returned. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Datastores$Get - extends StandardParameters { - /** - * Required. Full resource name of DataStore, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}`. If the caller does not have permission to access the DataStore, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested DataStore does not exist, a NOT_FOUND error is returned. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Datastores$Getsitesearchengine - extends StandardParameters { - /** - * Required. Resource name of SiteSearchEngine, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine`. If the caller does not have permission to access the [SiteSearchEngine], regardless of whether or not it exists, a PERMISSION_DENIED error is returned. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Datastores$List - extends StandardParameters { - /** - * Filter by solution type . For example: `filter = 'solution_type:SOLUTION_TYPE_SEARCH'` - */ - filter?: string; - /** - * Maximum number of DataStores to return. If unspecified, defaults to 10. The maximum allowed value is 50. Values above 50 will be coerced to 50. If this field is negative, an INVALID_ARGUMENT is returned. - */ - pageSize?: number; - /** - * A page token ListDataStoresResponse.next_page_token, received from a previous DataStoreService.ListDataStores call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to DataStoreService.ListDataStores must match the call that provided the page token. Otherwise, an INVALID_ARGUMENT error is returned. - */ - pageToken?: string; - /** - * Required. The parent branch resource name, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}`. If the caller does not have permission to list DataStores under this location, regardless of whether or not this data store exists, a PERMISSION_DENIED error is returned. - */ - parent?: string; - } - export interface Params$Resource$Projects$Locations$Datastores$Patch - extends StandardParameters { - /** - * 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. - */ - name?: string; - /** - * Indicates which fields in the provided DataStore to update. If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned. - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1betaDataStore; - } - - export class Resource$Projects$Locations$Datastores$Branches { - context: APIRequestContext; - documents: Resource$Projects$Locations$Datastores$Branches$Documents; - operations: Resource$Projects$Locations$Datastores$Branches$Operations; - constructor(context: APIRequestContext) { - this.context = context; - this.documents = - new Resource$Projects$Locations$Datastores$Branches$Documents( - this.context + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback ); - this.operations = - new Resource$Projects$Locations$Datastores$Branches$Operations( - this.context + } else { + return createAPIRequest( + parameters ); - } - } - - export class Resource$Projects$Locations$Datastores$Branches$Documents { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; + } } /** - * Creates a Document. + * Updates a Control. Control action type cannot be changed. If the Control to update does not exist, a NOT_FOUND error is returned. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - create( - params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Create, + patch( + params: Params$Resource$Projects$Locations$Datastores$Controls$Patch, options: StreamMethodOptions ): GaxiosPromise; - create( - params?: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Create, + patch( + params?: Params$Resource$Projects$Locations$Datastores$Controls$Patch, options?: MethodOptions - ): GaxiosPromise; - create( - params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Create, + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Datastores$Controls$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Create, + patch( + params: Params$Resource$Projects$Locations$Datastores$Controls$Patch, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Create, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Datastores$Controls$Patch, + callback: BodyResponseCallback ): void; - create( - callback: BodyResponseCallback + patch( + callback: BodyResponseCallback ): void; - create( + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Branches$Documents$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Controls$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Branches$Documents$Create; + {}) as Params$Resource$Projects$Locations$Datastores$Controls$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Branches$Documents$Create; + {} as Params$Resource$Projects$Locations$Datastores$Controls$Patch; options = {}; } @@ -20760,88 +23736,162 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+parent}/documents').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } + } + export interface Params$Resource$Projects$Locations$Datastores$Controls$Create + extends StandardParameters { /** - * Deletes a Document. + * Required. The ID to use for the Control, which will become the final component of the Control's resource name. This value must be within 1-63 characters. Valid characters are /a-z-_/. + */ + controlId?: string; + /** + * Required. Full resource name of parent data store. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/dataStores/{data_store_id\}` or `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/engines/{engine_id\}`. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1betaControl; + } + export interface Params$Resource$Projects$Locations$Datastores$Controls$Delete + extends StandardParameters { + /** + * Required. The resource name of the Control to delete. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/dataStores/{data_store_id\}/controls/{control_id\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Datastores$Controls$Get + extends StandardParameters { + /** + * Required. The resource name of the Control to get. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/dataStores/{data_store_id\}/controls/{control_id\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Datastores$Controls$List + extends StandardParameters { + /** + * Optional. A filter to apply on the list results. Supported features: * List all the products under the parent branch if filter is unset. Currently this field is unsupported. + */ + filter?: string; + /** + * Optional. Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000. + */ + pageSize?: number; + /** + * Optional. A page token, received from a previous `ListControls` call. Provide this to retrieve the subsequent page. + */ + pageToken?: string; + /** + * Required. The data store resource name. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/dataStores/{data_store_id\}` or `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/engines/{engine_id\}`. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Datastores$Controls$Patch + extends StandardParameters { + /** + * Immutable. Fully qualified name `projects/x/locations/global/dataStore/x/controls/x` + */ + name?: string; + /** + * Optional. Indicates which fields in the provided Control to update. The following are NOT supported: * Control.name * Control.solution_type If not set or empty, all supported fields are updated. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1betaControl; + } + + export class Resource$Projects$Locations$Datastores$Conversations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Converses a conversation. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - delete( - params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Delete, + converse( + params: Params$Resource$Projects$Locations$Datastores$Conversations$Converse, options: StreamMethodOptions ): GaxiosPromise; - delete( - params?: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Delete, + converse( + params?: Params$Resource$Projects$Locations$Datastores$Conversations$Converse, options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Delete, + ): GaxiosPromise; + converse( + params: Params$Resource$Projects$Locations$Datastores$Conversations$Converse, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + converse( + params: Params$Resource$Projects$Locations$Datastores$Conversations$Converse, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Delete, - callback: BodyResponseCallback + converse( + params: Params$Resource$Projects$Locations$Datastores$Conversations$Converse, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + converse( + callback: BodyResponseCallback + ): void; + converse( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Branches$Documents$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Conversations$Converse + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Branches$Documents$Delete; + {}) as Params$Resource$Projects$Locations$Datastores$Conversations$Converse; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Branches$Documents$Delete; + {} as Params$Resource$Projects$Locations$Datastores$Conversations$Converse; options = {}; } @@ -20855,8 +23905,11 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1beta/{+name}:converse').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options @@ -20867,75 +23920,77 @@ export namespace discoveryengine_v1beta { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Gets a Document. + * Creates a Conversation. If the Conversation to create already exists, an ALREADY_EXISTS error is returned. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Get, + create( + params: Params$Resource$Projects$Locations$Datastores$Conversations$Create, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Get, + create( + params?: Params$Resource$Projects$Locations$Datastores$Conversations$Create, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Get, + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Datastores$Conversations$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Get, + create( + params: Params$Resource$Projects$Locations$Datastores$Conversations$Create, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Get, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Datastores$Conversations$Create, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + create( + callback: BodyResponseCallback ): void; - get( + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Branches$Documents$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Conversations$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Branches$Documents$Get; + {}) as Params$Resource$Projects$Locations$Datastores$Conversations$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Branches$Documents$Get; + {} as Params$Resource$Projects$Locations$Datastores$Conversations$Create; options = {}; } @@ -20949,89 +24004,88 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1beta/{+parent}/conversations').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * 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. + * Deletes a Conversation. If the Conversation to delete does not exist, a NOT_FOUND error is returned. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - import( - params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Import, + delete( + params: Params$Resource$Projects$Locations$Datastores$Conversations$Delete, options: StreamMethodOptions ): GaxiosPromise; - import( - params?: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Import, + delete( + params?: Params$Resource$Projects$Locations$Datastores$Conversations$Delete, options?: MethodOptions - ): GaxiosPromise; - import( - params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Import, + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Datastores$Conversations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - import( - params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Import, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - import( - params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Import, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Datastores$Conversations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - import( - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Datastores$Conversations$Delete, + callback: BodyResponseCallback ): void; - import( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Branches$Documents$Import - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Conversations$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Branches$Documents$Import; + {}) as Params$Resource$Projects$Locations$Datastores$Conversations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Branches$Documents$Import; + {} as Params$Resource$Projects$Locations$Datastores$Conversations$Delete; options = {}; } @@ -21045,90 +24099,87 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+parent}/documents:import').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Gets a list of Documents. + * Gets a Conversation. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$List, + get( + params: Params$Resource$Projects$Locations$Datastores$Conversations$Get, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Datastores$Branches$Documents$List, + get( + params?: Params$Resource$Projects$Locations$Datastores$Conversations$Get, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$List, + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Datastores$Conversations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$List, + get( + params: Params$Resource$Projects$Locations$Datastores$Conversations$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$List, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Datastores$Conversations$Get, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - list( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Branches$Documents$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Conversations$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Branches$Documents$List; + {}) as Params$Resource$Projects$Locations$Datastores$Conversations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Branches$Documents$List; + {} as Params$Resource$Projects$Locations$Datastores$Conversations$Get; options = {}; } @@ -21142,92 +24193,89 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+parent}/documents').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Updates a Document. + * Lists all Conversations by their parent DataStore. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - patch( - params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Patch, + list( + params: Params$Resource$Projects$Locations$Datastores$Conversations$List, options: StreamMethodOptions ): GaxiosPromise; - patch( - params?: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Patch, + list( + params?: Params$Resource$Projects$Locations$Datastores$Conversations$List, options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Patch, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Datastores$Conversations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Patch, + list( + params: Params$Resource$Projects$Locations$Datastores$Conversations$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Patch, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Datastores$Conversations$List, + callback: BodyResponseCallback ): void; - patch( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - patch( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Branches$Documents$Patch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Conversations$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Branches$Documents$Patch; + {}) as Params$Resource$Projects$Locations$Datastores$Conversations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Branches$Documents$Patch; + {} as Params$Resource$Projects$Locations$Datastores$Conversations$List; options = {}; } @@ -21241,89 +24289,92 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + url: (rootUrl + '/v1beta/{+parent}/conversations').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * 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. + * Updates a Conversation. Conversation action type cannot be changed. If the Conversation to update does not exist, a NOT_FOUND error is returned. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - purge( - params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Purge, + patch( + params: Params$Resource$Projects$Locations$Datastores$Conversations$Patch, options: StreamMethodOptions ): GaxiosPromise; - purge( - params?: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Purge, + patch( + params?: Params$Resource$Projects$Locations$Datastores$Conversations$Patch, options?: MethodOptions - ): GaxiosPromise; - purge( - params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Purge, + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Datastores$Conversations$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - purge( - params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Purge, + patch( + params: Params$Resource$Projects$Locations$Datastores$Conversations$Patch, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - purge( - params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Purge, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Datastores$Conversations$Patch, + callback: BodyResponseCallback ): void; - purge( - callback: BodyResponseCallback + patch( + callback: BodyResponseCallback ): void; - purge( + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Branches$Documents$Purge - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Conversations$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Branches$Documents$Purge; + {}) as Params$Resource$Projects$Locations$Datastores$Conversations$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Branches$Documents$Purge; + {} as Params$Resource$Projects$Locations$Datastores$Conversations$Patch; options = {}; } @@ -21337,183 +24388,280 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+parent}/documents:purge').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } } - export interface Params$Resource$Projects$Locations$Datastores$Branches$Documents$Create + export interface Params$Resource$Projects$Locations$Datastores$Conversations$Converse extends StandardParameters { /** - * Required. The ID to use for the Document, which becomes the final component of the Document.name. If the caller does not have permission to create the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. This field must be unique among all Documents with the same parent. Otherwise, an `ALREADY_EXISTS` error is returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. + * Required. The resource name of the Conversation to get. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/{conversation_id\}`. Use `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/-` to activate auto session mode, which automatically creates a new conversation inside a ConverseConversation session. */ - documentId?: string; + name?: string; + /** - * Required. The parent resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}`. + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1betaConverseConversationRequest; + } + export interface Params$Resource$Projects$Locations$Datastores$Conversations$Create + extends StandardParameters { + /** + * Required. Full resource name of parent data store. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}` */ parent?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1betaDocument; + requestBody?: Schema$GoogleCloudDiscoveryengineV1betaConversation; } - export interface Params$Resource$Projects$Locations$Datastores$Branches$Documents$Delete + export interface Params$Resource$Projects$Locations$Datastores$Conversations$Delete extends StandardParameters { /** - * Required. Full resource name of Document, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}/documents/{document\}`. If the caller does not have permission to delete the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the Document to delete does not exist, a `NOT_FOUND` error is returned. + * Required. The resource name of the Conversation to delete. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/{conversation_id\}` */ name?: string; } - export interface Params$Resource$Projects$Locations$Datastores$Branches$Documents$Get + export interface Params$Resource$Projects$Locations$Datastores$Conversations$Get extends StandardParameters { /** - * Required. Full resource name of Document, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}/documents/{document\}`. If the caller does not have permission to access the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the requested Document does not exist, a `NOT_FOUND` error is returned. + * Required. The resource name of the Conversation to get. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/{conversation_id\}` */ name?: string; } - export interface Params$Resource$Projects$Locations$Datastores$Branches$Documents$Import + export interface Params$Resource$Projects$Locations$Datastores$Conversations$List extends StandardParameters { /** - * Required. The parent branch resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}`. Requires create/update permission. + * A filter to apply on the list results. The supported features are: user_pseudo_id, state. Example: "user_pseudo_id = some_id" */ - parent?: string; - + filter?: string; /** - * Request body metadata + * 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` * `conversation_name` Example: "update_time desc" "create_time" */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1betaImportDocumentsRequest; - } - export interface Params$Resource$Projects$Locations$Datastores$Branches$Documents$List - extends StandardParameters { + orderBy?: string; /** - * Maximum number of Documents to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 are set to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned. + * Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000. */ pageSize?: number; /** - * A page token ListDocumentsResponse.next_page_token, received from a previous DocumentService.ListDocuments call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to DocumentService.ListDocuments must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned. + * A page token, received from a previous `ListConversations` call. Provide this to retrieve the subsequent page. */ pageToken?: string; /** - * Required. The parent branch resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}`. Use `default_branch` as the branch ID, to list documents under the default branch. If the caller does not have permission to list Documents under this branch, regardless of whether or not this branch exists, a `PERMISSION_DENIED` error is returned. + * Required. The data store resource name. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}` */ parent?: string; } - export interface Params$Resource$Projects$Locations$Datastores$Branches$Documents$Patch + export interface Params$Resource$Projects$Locations$Datastores$Conversations$Patch extends StandardParameters { /** - * If set to `true` and the Document is not found, a new Document is be created. - */ - allowMissing?: boolean; - /** - * 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. + * Immutable. Fully qualified name `projects/{project\}/locations/global/collections/{collection\}/dataStore/x/conversations/x` or `projects/{project\}/locations/global/collections/{collection\}/engines/x/conversations/x`. */ name?: string; /** - * Indicates which fields in the provided imported 'document' to update. If not set, by default updates all fields. + * Indicates which fields in the provided Conversation to update. The following are NOT supported: * Conversation.name If not set or empty, all supported fields are updated. */ updateMask?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1betaDocument; + requestBody?: Schema$GoogleCloudDiscoveryengineV1betaConversation; } - export interface Params$Resource$Projects$Locations$Datastores$Branches$Documents$Purge - extends StandardParameters { - /** - * Required. The parent resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}`. - */ - parent?: string; - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1betaPurgeDocumentsRequest; + export class Resource$Projects$Locations$Datastores$Models { + context: APIRequestContext; + operations: Resource$Projects$Locations$Datastores$Models$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.operations = + new Resource$Projects$Locations$Datastores$Models$Operations( + this.context + ); + } } - export class Resource$Projects$Locations$Datastores$Branches$Operations { + export class Resource$Projects$Locations$Datastores$Models$Operations { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * 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`. + * 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. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - cancel( - params: Params$Resource$Projects$Locations$Datastores$Branches$Operations$Cancel, + get( + params: Params$Resource$Projects$Locations$Datastores$Models$Operations$Get, options: StreamMethodOptions ): GaxiosPromise; - cancel( - params?: Params$Resource$Projects$Locations$Datastores$Branches$Operations$Cancel, + get( + params?: Params$Resource$Projects$Locations$Datastores$Models$Operations$Get, options?: MethodOptions - ): GaxiosPromise; - cancel( - params: Params$Resource$Projects$Locations$Datastores$Branches$Operations$Cancel, + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Datastores$Models$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Projects$Locations$Datastores$Branches$Operations$Cancel, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Datastores$Models$Operations$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Projects$Locations$Datastores$Branches$Operations$Cancel, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Datastores$Models$Operations$Get, + callback: BodyResponseCallback ): void; - cancel(callback: BodyResponseCallback): void; - cancel( + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Datastores$Models$Operations$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Datastores$Models$Operations$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Datastores$Models$Operations$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Locations$Datastores$Models$Operations$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Datastores$Models$Operations$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Datastores$Models$Operations$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Datastores$Models$Operations$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Datastores$Models$Operations$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Branches$Operations$Cancel - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Models$Operations$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Branches$Operations$Cancel; + {}) as Params$Resource$Projects$Locations$Datastores$Models$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Branches$Operations$Cancel; + {} as Params$Resource$Projects$Locations$Datastores$Models$Operations$List; options = {}; } @@ -21527,11 +24675,11 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+name}:cancel').replace( + url: (rootUrl + '/v1beta/{+name}/operations').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', apiVersion: '', }, options @@ -21542,14 +24690,50 @@ export namespace discoveryengine_v1beta { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } + } + + export interface Params$Resource$Projects$Locations$Datastores$Models$Operations$Get + extends StandardParameters { + /** + * The name of the operation resource. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Datastores$Models$Operations$List + extends StandardParameters { + /** + * The standard list filter. + */ + filter?: string; + /** + * The name of the operation's parent resource. + */ + name?: string; + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. + */ + pageToken?: string; + } + + export class Resource$Projects$Locations$Datastores$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } /** * 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. @@ -21560,27 +24744,27 @@ export namespace discoveryengine_v1beta { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Datastores$Branches$Operations$Get, + params: Params$Resource$Projects$Locations$Datastores$Operations$Get, options: StreamMethodOptions ): GaxiosPromise; get( - params?: Params$Resource$Projects$Locations$Datastores$Branches$Operations$Get, + params?: Params$Resource$Projects$Locations$Datastores$Operations$Get, options?: MethodOptions ): GaxiosPromise; get( - params: Params$Resource$Projects$Locations$Datastores$Branches$Operations$Get, + params: Params$Resource$Projects$Locations$Datastores$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Datastores$Branches$Operations$Get, + params: Params$Resource$Projects$Locations$Datastores$Operations$Get, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Datastores$Branches$Operations$Get, + params: Params$Resource$Projects$Locations$Datastores$Operations$Get, callback: BodyResponseCallback ): void; get( @@ -21588,7 +24772,7 @@ export namespace discoveryengine_v1beta { ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Branches$Operations$Get + | Params$Resource$Projects$Locations$Datastores$Operations$Get | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -21604,13 +24788,13 @@ export namespace discoveryengine_v1beta { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Branches$Operations$Get; + {}) as Params$Resource$Projects$Locations$Datastores$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Branches$Operations$Get; + {} as Params$Resource$Projects$Locations$Datastores$Operations$Get; options = {}; } @@ -21654,27 +24838,27 @@ export namespace discoveryengine_v1beta { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Datastores$Branches$Operations$List, + params: Params$Resource$Projects$Locations$Datastores$Operations$List, options: StreamMethodOptions ): GaxiosPromise; list( - params?: Params$Resource$Projects$Locations$Datastores$Branches$Operations$List, + params?: Params$Resource$Projects$Locations$Datastores$Operations$List, options?: MethodOptions ): GaxiosPromise; list( - params: Params$Resource$Projects$Locations$Datastores$Branches$Operations$List, + params: Params$Resource$Projects$Locations$Datastores$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Datastores$Branches$Operations$List, + params: Params$Resource$Projects$Locations$Datastores$Operations$List, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Datastores$Branches$Operations$List, + params: Params$Resource$Projects$Locations$Datastores$Operations$List, callback: BodyResponseCallback ): void; list( @@ -21682,7 +24866,7 @@ export namespace discoveryengine_v1beta { ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Branches$Operations$List + | Params$Resource$Projects$Locations$Datastores$Operations$List | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -21698,13 +24882,13 @@ export namespace discoveryengine_v1beta { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Branches$Operations$List; + {}) as Params$Resource$Projects$Locations$Datastores$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Branches$Operations$List; + {} as Params$Resource$Projects$Locations$Datastores$Operations$List; options = {}; } @@ -21745,26 +24929,14 @@ export namespace discoveryengine_v1beta { } } - export interface Params$Resource$Projects$Locations$Datastores$Branches$Operations$Cancel - extends StandardParameters { - /** - * The name of the operation resource to be cancelled. - */ - name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleLongrunningCancelOperationRequest; - } - export interface Params$Resource$Projects$Locations$Datastores$Branches$Operations$Get + export interface Params$Resource$Projects$Locations$Datastores$Operations$Get extends StandardParameters { /** * The name of the operation resource. */ name?: string; } - export interface Params$Resource$Projects$Locations$Datastores$Branches$Operations$List + export interface Params$Resource$Projects$Locations$Datastores$Operations$List extends StandardParameters { /** * The standard list filter. @@ -21784,50 +24956,50 @@ export namespace discoveryengine_v1beta { pageToken?: string; } - export class Resource$Projects$Locations$Datastores$Completionsuggestions { + export class Resource$Projects$Locations$Datastores$Schemas { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * Imports CompletionSuggestions for a DataStore. + * Creates a Schema. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - import( - params: Params$Resource$Projects$Locations$Datastores$Completionsuggestions$Import, + create( + params: Params$Resource$Projects$Locations$Datastores$Schemas$Create, options: StreamMethodOptions ): GaxiosPromise; - import( - params?: Params$Resource$Projects$Locations$Datastores$Completionsuggestions$Import, + create( + params?: Params$Resource$Projects$Locations$Datastores$Schemas$Create, options?: MethodOptions ): GaxiosPromise; - import( - params: Params$Resource$Projects$Locations$Datastores$Completionsuggestions$Import, + create( + params: Params$Resource$Projects$Locations$Datastores$Schemas$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - import( - params: Params$Resource$Projects$Locations$Datastores$Completionsuggestions$Import, + create( + params: Params$Resource$Projects$Locations$Datastores$Schemas$Create, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - import( - params: Params$Resource$Projects$Locations$Datastores$Completionsuggestions$Import, + create( + params: Params$Resource$Projects$Locations$Datastores$Schemas$Create, callback: BodyResponseCallback ): void; - import( + create( callback: BodyResponseCallback ): void; - import( + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Completionsuggestions$Import + | Params$Resource$Projects$Locations$Datastores$Schemas$Create | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -21843,13 +25015,13 @@ export namespace discoveryengine_v1beta { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Completionsuggestions$Import; + {}) as Params$Resource$Projects$Locations$Datastores$Schemas$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Completionsuggestions$Import; + {} as Params$Resource$Projects$Locations$Datastores$Schemas$Create; options = {}; } @@ -21863,9 +25035,10 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: ( - rootUrl + '/v1beta/{+parent}/completionSuggestions:import' - ).replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1beta/{+parent}/schemas').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'POST', apiVersion: '', }, @@ -21887,43 +25060,43 @@ export namespace discoveryengine_v1beta { } /** - * Permanently deletes all CompletionSuggestions for a DataStore. + * Deletes a Schema. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - purge( - params: Params$Resource$Projects$Locations$Datastores$Completionsuggestions$Purge, + delete( + params: Params$Resource$Projects$Locations$Datastores$Schemas$Delete, options: StreamMethodOptions ): GaxiosPromise; - purge( - params?: Params$Resource$Projects$Locations$Datastores$Completionsuggestions$Purge, + delete( + params?: Params$Resource$Projects$Locations$Datastores$Schemas$Delete, options?: MethodOptions ): GaxiosPromise; - purge( - params: Params$Resource$Projects$Locations$Datastores$Completionsuggestions$Purge, + delete( + params: Params$Resource$Projects$Locations$Datastores$Schemas$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - purge( - params: Params$Resource$Projects$Locations$Datastores$Completionsuggestions$Purge, + delete( + params: Params$Resource$Projects$Locations$Datastores$Schemas$Delete, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - purge( - params: Params$Resource$Projects$Locations$Datastores$Completionsuggestions$Purge, + delete( + params: Params$Resource$Projects$Locations$Datastores$Schemas$Delete, callback: BodyResponseCallback ): void; - purge( + delete( callback: BodyResponseCallback ): void; - purge( + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Completionsuggestions$Purge + | Params$Resource$Projects$Locations$Datastores$Schemas$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -21939,13 +25112,13 @@ export namespace discoveryengine_v1beta { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Completionsuggestions$Purge; + {}) as Params$Resource$Projects$Locations$Datastores$Schemas$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Completionsuggestions$Purge; + {} as Params$Resource$Projects$Locations$Datastores$Schemas$Delete; options = {}; } @@ -21959,17 +25132,15 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: ( - rootUrl + '/v1beta/{+parent}/completionSuggestions:purge' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { @@ -21981,99 +25152,67 @@ export namespace discoveryengine_v1beta { return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Projects$Locations$Datastores$Completionsuggestions$Import - extends StandardParameters { - /** - * Required. The parent data store resource name for which to import customer autocomplete suggestions. Follows pattern `projects/x/locations/x/collections/x/dataStores/x` - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1betaImportCompletionSuggestionsRequest; - } - export interface Params$Resource$Projects$Locations$Datastores$Completionsuggestions$Purge - extends StandardParameters { - /** - * Required. The parent data store resource name for which to purge completion suggestions. Follows pattern projects/x/locations/x/collections/x/dataStores/x. - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1betaPurgeCompletionSuggestionsRequest; - } - - export class Resource$Projects$Locations$Datastores$Controls { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * 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. + * Gets a Schema. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - create( - params: Params$Resource$Projects$Locations$Datastores$Controls$Create, + get( + params: Params$Resource$Projects$Locations$Datastores$Schemas$Get, options: StreamMethodOptions ): GaxiosPromise; - create( - params?: Params$Resource$Projects$Locations$Datastores$Controls$Create, + get( + params?: Params$Resource$Projects$Locations$Datastores$Schemas$Get, options?: MethodOptions - ): GaxiosPromise; - create( - params: Params$Resource$Projects$Locations$Datastores$Controls$Create, + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Datastores$Schemas$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Datastores$Controls$Create, + get( + params: Params$Resource$Projects$Locations$Datastores$Schemas$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Datastores$Controls$Create, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Datastores$Schemas$Get, + callback: BodyResponseCallback ): void; - create( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - create( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Controls$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Schemas$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Controls$Create; + {}) as Params$Resource$Projects$Locations$Datastores$Schemas$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Controls$Create; + {} as Params$Resource$Projects$Locations$Datastores$Schemas$Get; options = {}; } @@ -22087,88 +25226,89 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+parent}/controls').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Deletes a Control. If the Control to delete does not exist, a NOT_FOUND error is returned. + * Gets a list of Schemas. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - delete( - params: Params$Resource$Projects$Locations$Datastores$Controls$Delete, + list( + params: Params$Resource$Projects$Locations$Datastores$Schemas$List, options: StreamMethodOptions ): GaxiosPromise; - delete( - params?: Params$Resource$Projects$Locations$Datastores$Controls$Delete, + list( + params?: Params$Resource$Projects$Locations$Datastores$Schemas$List, options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Projects$Locations$Datastores$Controls$Delete, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Datastores$Schemas$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Datastores$Controls$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Datastores$Schemas$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Datastores$Controls$Delete, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Datastores$Schemas$List, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + list( + callback: BodyResponseCallback + ): void; + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Controls$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Schemas$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Controls$Delete; + {}) as Params$Resource$Projects$Locations$Datastores$Schemas$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Controls$Delete; + {} as Params$Resource$Projects$Locations$Datastores$Schemas$List; options = {}; } @@ -22182,87 +25322,92 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1beta/{+parent}/schemas').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Gets a Control. + * Updates a Schema. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Datastores$Controls$Get, + patch( + params: Params$Resource$Projects$Locations$Datastores$Schemas$Patch, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Datastores$Controls$Get, + patch( + params?: Params$Resource$Projects$Locations$Datastores$Schemas$Patch, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Datastores$Controls$Get, + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Datastores$Schemas$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Datastores$Controls$Get, + patch( + params: Params$Resource$Projects$Locations$Datastores$Schemas$Patch, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Datastores$Controls$Get, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Datastores$Schemas$Patch, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + patch( + callback: BodyResponseCallback ): void; - get( + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Controls$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Schemas$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Controls$Get; + {}) as Params$Resource$Projects$Locations$Datastores$Schemas$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Controls$Get; + {} as Params$Resource$Projects$Locations$Datastores$Schemas$Patch; options = {}; } @@ -22277,7 +25422,7 @@ export namespace discoveryengine_v1beta { options: Object.assign( { url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'PATCH', apiVersion: '', }, options @@ -22288,77 +25433,144 @@ export namespace discoveryengine_v1beta { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } + } + + export interface Params$Resource$Projects$Locations$Datastores$Schemas$Create + extends StandardParameters { + /** + * Required. The parent data store resource name, in the format of `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}`. + */ + parent?: string; + /** + * Required. The ID to use for the Schema, which becomes the final component of the Schema.name. This field should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. + */ + schemaId?: string; /** - * Lists all Controls by their parent DataStore. + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1betaSchema; + } + export interface Params$Resource$Projects$Locations$Datastores$Schemas$Delete + extends StandardParameters { + /** + * Required. The full resource name of the schema, in the format of `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/schemas/{schema\}`. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Datastores$Schemas$Get + extends StandardParameters { + /** + * Required. The full resource name of the schema, in the format of `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/schemas/{schema\}`. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Datastores$Schemas$List + extends StandardParameters { + /** + * The maximum number of Schemas to return. The service may return fewer than this value. If unspecified, at most 100 Schemas are returned. The maximum value is 1000; values above 1000 are set to 1000. + */ + pageSize?: number; + /** + * A page token, received from a previous SchemaService.ListSchemas call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SchemaService.ListSchemas must match the call that provided the page token. + */ + pageToken?: string; + /** + * Required. The parent data store resource name, in the format of `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}`. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Datastores$Schemas$Patch + extends StandardParameters { + /** + * If set to true, and the Schema is not found, a new Schema is created. In this situation, `update_mask` is ignored. + */ + allowMissing?: boolean; + /** + * 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. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1betaSchema; + } + + export class Resource$Projects$Locations$Datastores$Servingconfigs { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Answer query method. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Datastores$Controls$List, + answer( + params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Answer, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Datastores$Controls$List, + answer( + params?: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Answer, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Datastores$Controls$List, + ): GaxiosPromise; + answer( + params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Answer, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Datastores$Controls$List, + answer( + params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Answer, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Datastores$Controls$List, - callback: BodyResponseCallback + answer( + params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Answer, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + answer( + callback: BodyResponseCallback ): void; - list( + answer( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Controls$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Servingconfigs$Answer + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Controls$List; + {}) as Params$Resource$Projects$Locations$Datastores$Servingconfigs$Answer; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Controls$List; + {} as Params$Resource$Projects$Locations$Datastores$Servingconfigs$Answer; options = {}; } @@ -22372,92 +25584,92 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+parent}/controls').replace( + url: (rootUrl + '/v1beta/{+servingConfig}:answer').replace( /([^:]\/)\/+/g, '$1' ), - method: 'GET', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['servingConfig'], + pathParams: ['servingConfig'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Updates a Control. Control action type cannot be changed. If the Control to update does not exist, a NOT_FOUND error is returned. + * Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not exist. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - patch( - params: Params$Resource$Projects$Locations$Datastores$Controls$Patch, + get( + params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Get, options: StreamMethodOptions ): GaxiosPromise; - patch( - params?: Params$Resource$Projects$Locations$Datastores$Controls$Patch, + get( + params?: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Get, options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Projects$Locations$Datastores$Controls$Patch, + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Datastores$Controls$Patch, + get( + params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Datastores$Controls$Patch, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Get, + callback: BodyResponseCallback ): void; - patch( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - patch( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Controls$Patch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Servingconfigs$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Controls$Patch; + {}) as Params$Resource$Projects$Locations$Datastores$Servingconfigs$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Controls$Patch; + {} as Params$Resource$Projects$Locations$Datastores$Servingconfigs$Get; options = {}; } @@ -22472,7 +25684,7 @@ export namespace discoveryengine_v1beta { options: Object.assign( { url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + method: 'GET', apiVersion: '', }, options @@ -22483,150 +25695,77 @@ export namespace discoveryengine_v1beta { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } - } - - export interface Params$Resource$Projects$Locations$Datastores$Controls$Create - extends StandardParameters { - /** - * Required. The ID to use for the Control, which will become the final component of the Control's resource name. This value must be within 1-63 characters. Valid characters are /a-z-_/. - */ - controlId?: string; - /** - * Required. Full resource name of parent data store. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/dataStores/{data_store_id\}` or `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/engines/{engine_id\}`. - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1betaControl; - } - export interface Params$Resource$Projects$Locations$Datastores$Controls$Delete - extends StandardParameters { - /** - * Required. The resource name of the Control to delete. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/dataStores/{data_store_id\}/controls/{control_id\}` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Datastores$Controls$Get - extends StandardParameters { - /** - * Required. The resource name of the Control to get. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/dataStores/{data_store_id\}/controls/{control_id\}` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Datastores$Controls$List - extends StandardParameters { - /** - * Optional. A filter to apply on the list results. Supported features: * List all the products under the parent branch if filter is unset. Currently this field is unsupported. - */ - filter?: string; - /** - * Optional. Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000. - */ - pageSize?: number; - /** - * Optional. A page token, received from a previous `ListControls` call. Provide this to retrieve the subsequent page. - */ - pageToken?: string; - /** - * Required. The data store resource name. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/dataStores/{data_store_id\}` or `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/engines/{engine_id\}`. - */ - parent?: string; - } - export interface Params$Resource$Projects$Locations$Datastores$Controls$Patch - extends StandardParameters { - /** - * Immutable. Fully qualified name `projects/x/locations/global/dataStore/x/controls/x` - */ - name?: string; - /** - * Optional. Indicates which fields in the provided Control to update. The following are NOT supported: * Control.name * Control.solution_type If not set or empty, all supported fields are updated. - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1betaControl; - } - - export class Resource$Projects$Locations$Datastores$Conversations { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Converses a conversation. + * Lists all ServingConfigs linked to this dataStore. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - converse( - params: Params$Resource$Projects$Locations$Datastores$Conversations$Converse, + list( + params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$List, options: StreamMethodOptions ): GaxiosPromise; - converse( - params?: Params$Resource$Projects$Locations$Datastores$Conversations$Converse, + list( + params?: Params$Resource$Projects$Locations$Datastores$Servingconfigs$List, options?: MethodOptions - ): GaxiosPromise; - converse( - params: Params$Resource$Projects$Locations$Datastores$Conversations$Converse, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - converse( - params: Params$Resource$Projects$Locations$Datastores$Conversations$Converse, + list( + params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - converse( - params: Params$Resource$Projects$Locations$Datastores$Conversations$Converse, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$List, + callback: BodyResponseCallback ): void; - converse( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - converse( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Conversations$Converse - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Servingconfigs$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Conversations$Converse; + {}) as Params$Resource$Projects$Locations$Datastores$Servingconfigs$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Conversations$Converse; + {} as Params$Resource$Projects$Locations$Datastores$Servingconfigs$List; options = {}; } @@ -22640,92 +25779,92 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+name}:converse').replace( + url: (rootUrl + '/v1beta/{+parent}/servingConfigs').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Creates a Conversation. If the Conversation to create already exists, an ALREADY_EXISTS error is returned. + * Updates a ServingConfig. Returns a NOT_FOUND error if the ServingConfig does not exist. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - create( - params: Params$Resource$Projects$Locations$Datastores$Conversations$Create, + patch( + params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Patch, options: StreamMethodOptions ): GaxiosPromise; - create( - params?: Params$Resource$Projects$Locations$Datastores$Conversations$Create, + patch( + params?: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Patch, options?: MethodOptions - ): GaxiosPromise; - create( - params: Params$Resource$Projects$Locations$Datastores$Conversations$Create, + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Datastores$Conversations$Create, + patch( + params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Patch, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - create( - params: Params$Resource$Projects$Locations$Datastores$Conversations$Create, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Patch, + callback: BodyResponseCallback ): void; - create( + patch( + callback: BodyResponseCallback + ): void; + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Conversations$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Servingconfigs$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Conversations$Create; + {}) as Params$Resource$Projects$Locations$Datastores$Servingconfigs$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Conversations$Create; + {} as Params$Resource$Projects$Locations$Datastores$Servingconfigs$Patch; options = {}; } @@ -22739,88 +25878,89 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+parent}/conversations').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Deletes a Conversation. If the Conversation to delete does not exist, a NOT_FOUND error is returned. + * Makes a recommendation, which requires a contextual user event. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - delete( - params: Params$Resource$Projects$Locations$Datastores$Conversations$Delete, + recommend( + params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Recommend, options: StreamMethodOptions ): GaxiosPromise; - delete( - params?: Params$Resource$Projects$Locations$Datastores$Conversations$Delete, + recommend( + params?: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Recommend, options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Projects$Locations$Datastores$Conversations$Delete, + ): GaxiosPromise; + recommend( + params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Recommend, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Datastores$Conversations$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + recommend( + params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Recommend, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Datastores$Conversations$Delete, - callback: BodyResponseCallback + recommend( + params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Recommend, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + recommend( + callback: BodyResponseCallback + ): void; + recommend( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Conversations$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Servingconfigs$Recommend + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Conversations$Delete; + {}) as Params$Resource$Projects$Locations$Datastores$Servingconfigs$Recommend; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Conversations$Delete; + {} as Params$Resource$Projects$Locations$Datastores$Servingconfigs$Recommend; options = {}; } @@ -22834,87 +25974,92 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1beta/{+servingConfig}:recommend').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['servingConfig'], + pathParams: ['servingConfig'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Gets a Conversation. + * Performs a search. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Datastores$Conversations$Get, + search( + params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Search, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Datastores$Conversations$Get, + search( + params?: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Search, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Datastores$Conversations$Get, + ): GaxiosPromise; + search( + params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Search, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Datastores$Conversations$Get, + search( + params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Search, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Datastores$Conversations$Get, - callback: BodyResponseCallback + search( + params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Search, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + search( + callback: BodyResponseCallback ): void; - get( + search( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Conversations$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Servingconfigs$Search + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Conversations$Get; + {}) as Params$Resource$Projects$Locations$Datastores$Servingconfigs$Search; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Conversations$Get; + {} as Params$Resource$Projects$Locations$Datastores$Servingconfigs$Search; options = {}; } @@ -22923,94 +26068,184 @@ export namespace discoveryengine_v1beta { options = {}; } - const rootUrl = - options.rootUrl || 'https://discoveryengine.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest( - parameters + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta/{+servingConfig}:search').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['servingConfig'], + pathParams: ['servingConfig'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Projects$Locations$Datastores$Servingconfigs$Answer + extends StandardParameters { + /** + * Required. The resource name of the Search serving config, such as `projects/x/locations/global/collections/default_collection/engines/x/servingConfigs/default_serving_config`, or `projects/x/locations/global/collections/default_collection/dataStores/x/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. + */ + servingConfig?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryRequest; + } + export interface Params$Resource$Projects$Locations$Datastores$Servingconfigs$Get + extends StandardParameters { + /** + * Required. The resource name of the ServingConfig to get. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/engines/{engine\}/servingConfigs/{serving_config_id\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Datastores$Servingconfigs$List + extends StandardParameters { + /** + * Optional. Maximum number of results to return. If unspecified, defaults to 100. If a value greater than 100 is provided, at most 100 results are returned. + */ + pageSize?: number; + /** + * Optional. A page token, received from a previous `ListServingConfigs` call. Provide this to retrieve the subsequent page. + */ + pageToken?: string; + /** + * Required. Full resource name of the parent resource. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/engines/{engine\}` + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Datastores$Servingconfigs$Patch + extends StandardParameters { + /** + * Immutable. Fully qualified name `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}/servingConfigs/{serving_config_id\}` + */ + name?: string; + /** + * Indicates which fields in the provided ServingConfig to update. The following are NOT supported: * ServingConfig.name If not set, all supported fields are updated. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1betaServingConfig; + } + export interface Params$Resource$Projects$Locations$Datastores$Servingconfigs$Recommend + extends StandardParameters { + /** + * Required. Full resource name of a ServingConfig: `projects/x/locations/global/collections/x/engines/x/servingConfigs/x`, or `projects/x/locations/global/collections/x/dataStores/x/servingConfigs/x` One default serving config is created along with your recommendation engine creation. The engine ID is used as the ID of the default serving config. For example, for Engine `projects/x/locations/global/collections/x/engines/my-engine`, you can use `projects/x/locations/global/collections/x/engines/my-engine/servingConfigs/my-engine` for your RecommendationService.Recommend requests. + */ + servingConfig?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1betaRecommendRequest; + } + export interface Params$Resource$Projects$Locations$Datastores$Servingconfigs$Search + extends StandardParameters { + /** + * Required. The resource name of the Search serving config, such as `projects/x/locations/global/collections/default_collection/engines/x/servingConfigs/default_serving_config`, or `projects/x/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. + */ + servingConfig?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequest; + } + + export class Resource$Projects$Locations$Datastores$Sessions { + context: APIRequestContext; + answers: Resource$Projects$Locations$Datastores$Sessions$Answers; + constructor(context: APIRequestContext) { + this.context = context; + this.answers = + new Resource$Projects$Locations$Datastores$Sessions$Answers( + this.context ); - } } /** - * Lists all Conversations by their parent DataStore. + * Creates a Session. If the Session to create already exists, an ALREADY_EXISTS error is returned. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Datastores$Conversations$List, + create( + params: Params$Resource$Projects$Locations$Datastores$Sessions$Create, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Datastores$Conversations$List, + create( + params?: Params$Resource$Projects$Locations$Datastores$Sessions$Create, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Datastores$Conversations$List, + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Datastores$Sessions$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Datastores$Conversations$List, + create( + params: Params$Resource$Projects$Locations$Datastores$Sessions$Create, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Datastores$Conversations$List, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Datastores$Sessions$Create, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + create( + callback: BodyResponseCallback ): void; - list( + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Conversations$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Sessions$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Conversations$List; + {}) as Params$Resource$Projects$Locations$Datastores$Sessions$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Conversations$List; + {} as Params$Resource$Projects$Locations$Datastores$Sessions$Create; options = {}; } @@ -23024,11 +26259,11 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+parent}/conversations').replace( + url: (rootUrl + '/v1beta/{+parent}/sessions').replace( /([^:]\/)\/+/g, '$1' ), - method: 'GET', + method: 'POST', apiVersion: '', }, options @@ -23039,77 +26274,73 @@ export namespace discoveryengine_v1beta { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Updates a Conversation. Conversation action type cannot be changed. If the Conversation to update 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. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - patch( - params: Params$Resource$Projects$Locations$Datastores$Conversations$Patch, + delete( + params: Params$Resource$Projects$Locations$Datastores$Sessions$Delete, options: StreamMethodOptions ): GaxiosPromise; - patch( - params?: Params$Resource$Projects$Locations$Datastores$Conversations$Patch, + delete( + params?: Params$Resource$Projects$Locations$Datastores$Sessions$Delete, options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Projects$Locations$Datastores$Conversations$Patch, + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Datastores$Sessions$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Datastores$Conversations$Patch, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - patch( - params: Params$Resource$Projects$Locations$Datastores$Conversations$Patch, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Datastores$Sessions$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Datastores$Sessions$Delete, + callback: BodyResponseCallback ): void; - patch( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Conversations$Patch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Sessions$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Conversations$Patch; + {}) as Params$Resource$Projects$Locations$Datastores$Sessions$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Conversations$Patch; + {} as Params$Resource$Projects$Locations$Datastores$Sessions$Delete; options = {}; } @@ -23124,7 +26355,7 @@ export namespace discoveryengine_v1beta { options: Object.assign( { url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + method: 'DELETE', apiVersion: '', }, options @@ -23135,116 +26366,17 @@ export namespace discoveryengine_v1beta { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Projects$Locations$Datastores$Conversations$Converse - extends StandardParameters { - /** - * Required. The resource name of the Conversation to get. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/{conversation_id\}`. Use `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/-` to activate auto session mode, which automatically creates a new conversation inside a ConverseConversation session. - */ - name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1betaConverseConversationRequest; - } - export interface Params$Resource$Projects$Locations$Datastores$Conversations$Create - extends StandardParameters { - /** - * Required. Full resource name of parent data store. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}` - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1betaConversation; - } - export interface Params$Resource$Projects$Locations$Datastores$Conversations$Delete - extends StandardParameters { - /** - * Required. The resource name of the Conversation to delete. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/{conversation_id\}` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Datastores$Conversations$Get - extends StandardParameters { - /** - * Required. The resource name of the Conversation to get. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/{conversation_id\}` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Datastores$Conversations$List - extends StandardParameters { - /** - * A filter to apply on the list results. The supported features are: user_pseudo_id, state. Example: "user_pseudo_id = some_id" - */ - filter?: string; - /** - * 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` * `conversation_name` Example: "update_time desc" "create_time" - */ - orderBy?: string; - /** - * Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000. - */ - pageSize?: number; - /** - * A page token, received from a previous `ListConversations` call. Provide this to retrieve the subsequent page. - */ - pageToken?: string; - /** - * Required. The data store resource name. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}` - */ - parent?: string; - } - export interface Params$Resource$Projects$Locations$Datastores$Conversations$Patch - extends StandardParameters { - /** - * Immutable. Fully qualified name `projects/{project\}/locations/global/collections/{collection\}/dataStore/x/conversations/x` or `projects/{project\}/locations/global/collections/{collection\}/engines/x/conversations/x`. - */ - name?: string; - /** - * Indicates which fields in the provided Conversation to update. The following are NOT supported: * Conversation.name If not set or empty, all supported fields are updated. - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1betaConversation; - } - - export class Resource$Projects$Locations$Datastores$Models { - context: APIRequestContext; - operations: Resource$Projects$Locations$Datastores$Models$Operations; - constructor(context: APIRequestContext) { - this.context = context; - this.operations = - new Resource$Projects$Locations$Datastores$Models$Operations( - this.context - ); - } - } - - export class Resource$Projects$Locations$Datastores$Models$Operations { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * 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. + * Gets a Session. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -23252,57 +26384,57 @@ export namespace discoveryengine_v1beta { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Datastores$Models$Operations$Get, + params: Params$Resource$Projects$Locations$Datastores$Sessions$Get, options: StreamMethodOptions ): GaxiosPromise; get( - params?: Params$Resource$Projects$Locations$Datastores$Models$Operations$Get, + params?: Params$Resource$Projects$Locations$Datastores$Sessions$Get, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; get( - params: Params$Resource$Projects$Locations$Datastores$Models$Operations$Get, + params: Params$Resource$Projects$Locations$Datastores$Sessions$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Datastores$Models$Operations$Get, + params: Params$Resource$Projects$Locations$Datastores$Sessions$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Datastores$Models$Operations$Get, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Datastores$Sessions$Get, + callback: BodyResponseCallback ): void; get( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Models$Operations$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Sessions$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Models$Operations$Get; + {}) as Params$Resource$Projects$Locations$Datastores$Sessions$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Models$Operations$Get; + {} as Params$Resource$Projects$Locations$Datastores$Sessions$Get; options = {}; } @@ -23328,17 +26460,19 @@ export namespace discoveryengine_v1beta { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + * Lists all Sessions by their parent DataStore. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -23346,57 +26480,57 @@ export namespace discoveryengine_v1beta { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Datastores$Models$Operations$List, + params: Params$Resource$Projects$Locations$Datastores$Sessions$List, options: StreamMethodOptions ): GaxiosPromise; list( - params?: Params$Resource$Projects$Locations$Datastores$Models$Operations$List, + params?: Params$Resource$Projects$Locations$Datastores$Sessions$List, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; list( - params: Params$Resource$Projects$Locations$Datastores$Models$Operations$List, + params: Params$Resource$Projects$Locations$Datastores$Sessions$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Datastores$Models$Operations$List, + params: Params$Resource$Projects$Locations$Datastores$Sessions$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Datastores$Models$Operations$List, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Datastores$Sessions$List, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Models$Operations$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Sessions$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Models$Operations$List; + {}) as Params$Resource$Projects$Locations$Datastores$Sessions$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Models$Operations$List; + {} as Params$Resource$Projects$Locations$Datastores$Sessions$List; options = {}; } @@ -23410,7 +26544,7 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+name}/operations').replace( + url: (rootUrl + '/v1beta/{+parent}/sessions').replace( /([^:]\/)\/+/g, '$1' ), @@ -23420,210 +26554,251 @@ export namespace discoveryengine_v1beta { options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } - } - - export interface Params$Resource$Projects$Locations$Datastores$Models$Operations$Get - extends StandardParameters { - /** - * The name of the operation resource. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Datastores$Models$Operations$List - extends StandardParameters { - /** - * The standard list filter. - */ - filter?: string; - /** - * The name of the operation's parent resource. - */ - name?: string; - /** - * The standard list page size. - */ - pageSize?: number; - /** - * The standard list page token. - */ - pageToken?: string; - } - - export class Resource$Projects$Locations$Datastores$Operations { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * 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. + * Updates a Session. Session action type cannot be changed. If the Session to update does not exist, a NOT_FOUND error is returned. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Datastores$Operations$Get, + patch( + params: Params$Resource$Projects$Locations$Datastores$Sessions$Patch, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Datastores$Operations$Get, + patch( + params?: Params$Resource$Projects$Locations$Datastores$Sessions$Patch, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Datastores$Operations$Get, + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Datastores$Sessions$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Datastores$Operations$Get, + patch( + params: Params$Resource$Projects$Locations$Datastores$Sessions$Patch, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Datastores$Operations$Get, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Datastores$Sessions$Patch, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + patch( + callback: BodyResponseCallback ): void; - get( + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Operations$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Sessions$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Operations$Get; + {}) as Params$Resource$Projects$Locations$Datastores$Sessions$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Operations$Get; + {} as Params$Resource$Projects$Locations$Datastores$Sessions$Patch; options = {}; } - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Projects$Locations$Datastores$Sessions$Create + extends StandardParameters { + /** + * Required. Full resource name of parent data store. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1betaSession; + } + export interface Params$Resource$Projects$Locations$Datastores$Sessions$Delete + extends StandardParameters { + /** + * Required. The resource name of the Session to delete. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/sessions/{session_id\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Datastores$Sessions$Get + extends StandardParameters { + /** + * Required. The resource name of the Session to get. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/sessions/{session_id\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Datastores$Sessions$List + extends StandardParameters { + /** + * A filter to apply on the list results. The supported features are: user_pseudo_id, state. Example: "user_pseudo_id = some_id" + */ + filter?: string; + /** + * 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` Example: "update_time desc" "create_time" + */ + orderBy?: string; + /** + * Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000. + */ + pageSize?: number; + /** + * A page token, received from a previous `ListSessions` call. Provide this to retrieve the subsequent page. + */ + pageToken?: string; + /** + * Required. The data store resource name. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}` + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Datastores$Sessions$Patch + extends StandardParameters { + /** + * Immutable. Fully qualified name `projects/{project\}/locations/global/collections/{collection\}/engines/{engine\}/sessions/x` + */ + name?: string; + /** + * 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. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1betaSession; + } - const rootUrl = - options.rootUrl || 'https://discoveryengine.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } + export class Resource$Projects$Locations$Datastores$Sessions$Answers { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; } /** - * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + * Gets a Answer. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Datastores$Operations$List, + get( + params: Params$Resource$Projects$Locations$Datastores$Sessions$Answers$Get, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Datastores$Operations$List, + get( + params?: Params$Resource$Projects$Locations$Datastores$Sessions$Answers$Get, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Datastores$Operations$List, + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Datastores$Sessions$Answers$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Datastores$Operations$List, + get( + params: Params$Resource$Projects$Locations$Datastores$Sessions$Answers$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Datastores$Operations$List, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Datastores$Sessions$Answers$Get, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - list( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Operations$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Sessions$Answers$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Operations$List; + {}) as Params$Resource$Projects$Locations$Datastores$Sessions$Answers$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Operations$List; + {} as Params$Resource$Projects$Locations$Datastores$Sessions$Answers$Get; options = {}; } @@ -23637,10 +26812,7 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+name}/operations').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', }, @@ -23652,89 +26824,75 @@ export namespace discoveryengine_v1beta { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } } - export interface Params$Resource$Projects$Locations$Datastores$Operations$Get - extends StandardParameters { - /** - * The name of the operation resource. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Datastores$Operations$List + export interface Params$Resource$Projects$Locations$Datastores$Sessions$Answers$Get extends StandardParameters { /** - * The standard list filter. - */ - filter?: string; - /** - * The name of the operation's parent resource. + * Required. The resource name of the Answer to get. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/engines/{engine_id\}/sessions/{session_id\}/answers/{answer_id\}` */ name?: string; - /** - * The standard list page size. - */ - pageSize?: number; - /** - * The standard list page token. - */ - pageToken?: string; } - export class Resource$Projects$Locations$Datastores$Schemas { + export class Resource$Projects$Locations$Datastores$Sitesearchengine { context: APIRequestContext; + targetSites: Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites; constructor(context: APIRequestContext) { this.context = context; + this.targetSites = + new Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites( + this.context + ); } /** - * Creates a Schema. + * Downgrade from advanced site search to basic site search. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - create( - params: Params$Resource$Projects$Locations$Datastores$Schemas$Create, + disableAdvancedSiteSearch( + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Disableadvancedsitesearch, options: StreamMethodOptions ): GaxiosPromise; - create( - params?: Params$Resource$Projects$Locations$Datastores$Schemas$Create, + disableAdvancedSiteSearch( + params?: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Disableadvancedsitesearch, options?: MethodOptions ): GaxiosPromise; - create( - params: Params$Resource$Projects$Locations$Datastores$Schemas$Create, + disableAdvancedSiteSearch( + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Disableadvancedsitesearch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Datastores$Schemas$Create, + disableAdvancedSiteSearch( + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Disableadvancedsitesearch, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Datastores$Schemas$Create, + disableAdvancedSiteSearch( + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Disableadvancedsitesearch, callback: BodyResponseCallback ): void; - create( + disableAdvancedSiteSearch( callback: BodyResponseCallback ): void; - create( + disableAdvancedSiteSearch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Schemas$Create + | Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Disableadvancedsitesearch | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -23750,13 +26908,13 @@ export namespace discoveryengine_v1beta { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Schemas$Create; + {}) as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Disableadvancedsitesearch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Schemas$Create; + {} as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Disableadvancedsitesearch; options = {}; } @@ -23770,18 +26928,17 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+parent}/schemas').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: ( + rootUrl + '/v1beta/{+siteSearchEngine}:disableAdvancedSiteSearch' + ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['siteSearchEngine'], + pathParams: ['siteSearchEngine'], context: this.context, }; if (callback) { @@ -23795,43 +26952,43 @@ export namespace discoveryengine_v1beta { } /** - * Deletes a Schema. + * Upgrade from basic site search to advanced site search. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - delete( - params: Params$Resource$Projects$Locations$Datastores$Schemas$Delete, + enableAdvancedSiteSearch( + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Enableadvancedsitesearch, options: StreamMethodOptions ): GaxiosPromise; - delete( - params?: Params$Resource$Projects$Locations$Datastores$Schemas$Delete, + enableAdvancedSiteSearch( + params?: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Enableadvancedsitesearch, options?: MethodOptions ): GaxiosPromise; - delete( - params: Params$Resource$Projects$Locations$Datastores$Schemas$Delete, + enableAdvancedSiteSearch( + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Enableadvancedsitesearch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Datastores$Schemas$Delete, + enableAdvancedSiteSearch( + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Enableadvancedsitesearch, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Datastores$Schemas$Delete, + enableAdvancedSiteSearch( + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Enableadvancedsitesearch, callback: BodyResponseCallback ): void; - delete( + enableAdvancedSiteSearch( callback: BodyResponseCallback ): void; - delete( + enableAdvancedSiteSearch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Schemas$Delete + | Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Enableadvancedsitesearch | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -23847,13 +27004,13 @@ export namespace discoveryengine_v1beta { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Schemas$Delete; + {}) as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Enableadvancedsitesearch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Schemas$Delete; + {} as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Enableadvancedsitesearch; options = {}; } @@ -23867,15 +27024,17 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: ( + rootUrl + '/v1beta/{+siteSearchEngine}:enableAdvancedSiteSearch' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['siteSearchEngine'], + pathParams: ['siteSearchEngine'], context: this.context, }; if (callback) { @@ -23889,65 +27048,65 @@ export namespace discoveryengine_v1beta { } /** - * Gets a Schema. + * Request on-demand recrawl for a list of URIs. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Datastores$Schemas$Get, + recrawlUris( + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Recrawluris, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Datastores$Schemas$Get, + recrawlUris( + params?: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Recrawluris, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Datastores$Schemas$Get, + ): GaxiosPromise; + recrawlUris( + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Recrawluris, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Datastores$Schemas$Get, + recrawlUris( + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Recrawluris, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Datastores$Schemas$Get, - callback: BodyResponseCallback + recrawlUris( + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Recrawluris, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + recrawlUris( + callback: BodyResponseCallback ): void; - get( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Schemas$Get - | BodyResponseCallback + recrawlUris( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Recrawluris + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Schemas$Get; + {}) as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Recrawluris; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Schemas$Get; + {} as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Recrawluris; options = {}; } @@ -23961,89 +27120,134 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1beta/{+siteSearchEngine}:recrawlUris').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['siteSearchEngine'], + pathParams: ['siteSearchEngine'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } + } + + export interface Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Disableadvancedsitesearch + extends StandardParameters { + /** + * Required. Full resource name of the SiteSearchEngine, such as `projects/{project\}/locations/{location\}/dataStores/{data_store_id\}/siteSearchEngine`. + */ + siteSearchEngine?: string; /** - * Gets a list of Schemas. + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1betaDisableAdvancedSiteSearchRequest; + } + export interface Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Enableadvancedsitesearch + extends StandardParameters { + /** + * Required. Full resource name of the SiteSearchEngine, such as `projects/{project\}/locations/{location\}/dataStores/{data_store_id\}/siteSearchEngine`. + */ + siteSearchEngine?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1betaEnableAdvancedSiteSearchRequest; + } + export interface Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Recrawluris + extends StandardParameters { + /** + * Required. Full resource name of the SiteSearchEngine, such as `projects/x/locations/x/collections/x/dataStores/x/siteSearchEngine`. + */ + siteSearchEngine?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1betaRecrawlUrisRequest; + } + + export class Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Creates TargetSite in a batch. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Datastores$Schemas$List, + batchCreate( + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Batchcreate, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Datastores$Schemas$List, + batchCreate( + params?: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Batchcreate, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Datastores$Schemas$List, + ): GaxiosPromise; + batchCreate( + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Batchcreate, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Datastores$Schemas$List, + batchCreate( + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Batchcreate, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Datastores$Schemas$List, - callback: BodyResponseCallback + batchCreate( + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Batchcreate, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + batchCreate( + callback: BodyResponseCallback ): void; - list( + batchCreate( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Schemas$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Batchcreate + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Schemas$List; + {}) as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Batchcreate; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Schemas$List; + {} as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Batchcreate; options = {}; } @@ -24057,11 +27261,10 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+parent}/schemas').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: ( + rootUrl + '/v1beta/{+parent}/targetSites:batchCreate' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options @@ -24072,55 +27275,53 @@ export namespace discoveryengine_v1beta { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Updates a Schema. + * Creates a TargetSite. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - patch( - params: Params$Resource$Projects$Locations$Datastores$Schemas$Patch, + create( + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Create, options: StreamMethodOptions ): GaxiosPromise; - patch( - params?: Params$Resource$Projects$Locations$Datastores$Schemas$Patch, + create( + params?: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Create, options?: MethodOptions ): GaxiosPromise; - patch( - params: Params$Resource$Projects$Locations$Datastores$Schemas$Patch, + create( + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Datastores$Schemas$Patch, + create( + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Create, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Datastores$Schemas$Patch, + create( + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Create, callback: BodyResponseCallback ): void; - patch( + create( callback: BodyResponseCallback ): void; - patch( + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Schemas$Patch + | Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Create | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -24136,13 +27337,13 @@ export namespace discoveryengine_v1beta { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Schemas$Patch; + {}) as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Schemas$Patch; + {} as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Create; options = {}; } @@ -24156,156 +27357,90 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + url: (rootUrl + '/v1beta/{+parent}/targetSites').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { createAPIRequest( parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Projects$Locations$Datastores$Schemas$Create - extends StandardParameters { - /** - * Required. The parent data store resource name, in the format of `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}`. - */ - parent?: string; - /** - * Required. The ID to use for the Schema, which becomes the final component of the Schema.name. This field should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. - */ - schemaId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1betaSchema; - } - export interface Params$Resource$Projects$Locations$Datastores$Schemas$Delete - extends StandardParameters { - /** - * Required. The full resource name of the schema, in the format of `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/schemas/{schema\}`. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Datastores$Schemas$Get - extends StandardParameters { - /** - * Required. The full resource name of the schema, in the format of `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/schemas/{schema\}`. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Datastores$Schemas$List - extends StandardParameters { - /** - * The maximum number of Schemas to return. The service may return fewer than this value. If unspecified, at most 100 Schemas are returned. The maximum value is 1000; values above 1000 are set to 1000. - */ - pageSize?: number; - /** - * A page token, received from a previous SchemaService.ListSchemas call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SchemaService.ListSchemas must match the call that provided the page token. - */ - pageToken?: string; - /** - * Required. The parent data store resource name, in the format of `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}`. - */ - parent?: string; - } - export interface Params$Resource$Projects$Locations$Datastores$Schemas$Patch - extends StandardParameters { - /** - * If set to true, and the Schema is not found, a new Schema is created. In this situation, `update_mask` is ignored. - */ - allowMissing?: boolean; - /** - * 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. - */ - name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1betaSchema; - } - - export class Resource$Projects$Locations$Datastores$Servingconfigs { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } } /** - * Answer query method. + * Deletes a TargetSite. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - answer( - params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Answer, + delete( + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Delete, options: StreamMethodOptions ): GaxiosPromise; - answer( - params?: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Answer, + delete( + params?: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Delete, options?: MethodOptions - ): GaxiosPromise; - answer( - params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Answer, + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - answer( - params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Answer, + delete( + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Delete, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - answer( - params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Answer, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Delete, + callback: BodyResponseCallback ): void; - answer( - callback: BodyResponseCallback + delete( + callback: BodyResponseCallback ): void; - answer( + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Servingconfigs$Answer - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Servingconfigs$Answer; + {}) as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Servingconfigs$Answer; + {} as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Delete; options = {}; } @@ -24319,34 +27454,29 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+servingConfig}:answer').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['servingConfig'], - pathParams: ['servingConfig'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not exist. + * Gets a TargetSite. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -24354,57 +27484,57 @@ export namespace discoveryengine_v1beta { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Get, + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Get, options: StreamMethodOptions ): GaxiosPromise; get( - params?: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Get, + params?: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Get, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; get( - params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Get, + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Get, + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Get, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Get, + callback: BodyResponseCallback ): void; get( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Servingconfigs$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Servingconfigs$Get; + {}) as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Servingconfigs$Get; + {} as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Get; options = {}; } @@ -24430,19 +27560,19 @@ export namespace discoveryengine_v1beta { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Lists all ServingConfigs linked to this dataStore. + * Gets a list of TargetSites. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -24450,57 +27580,57 @@ export namespace discoveryengine_v1beta { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$List, + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$List, options: StreamMethodOptions ): GaxiosPromise; list( - params?: Params$Resource$Projects$Locations$Datastores$Servingconfigs$List, + params?: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$List, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; list( - params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$List, + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$List, + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$List, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$List, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Servingconfigs$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Servingconfigs$List; + {}) as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Servingconfigs$List; + {} as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$List; options = {}; } @@ -24514,7 +27644,7 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+parent}/servingConfigs').replace( + url: (rootUrl + '/v1beta/{+parent}/targetSites').replace( /([^:]\/)\/+/g, '$1' ), @@ -24529,19 +27659,19 @@ export namespace discoveryengine_v1beta { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Updates a ServingConfig. Returns a NOT_FOUND error if the ServingConfig does not exist. + * Updates a TargetSite. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -24549,153 +27679,224 @@ export namespace discoveryengine_v1beta { * @returns A promise if used with async/await, or void if used with a callback. */ patch( - params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Patch, + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Patch, options: StreamMethodOptions ): GaxiosPromise; patch( - params?: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Patch, + params?: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Patch, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; patch( - params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Patch, + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; patch( - params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Patch, + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Patch, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; patch( - params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Patch, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Patch, + callback: BodyResponseCallback ): void; patch( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Servingconfigs$Patch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Servingconfigs$Patch; + {}) as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Servingconfigs$Patch; + {} as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; options = {}; } - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Batchcreate + extends StandardParameters { + /** + * Required. The parent resource shared by all TargetSites being created. `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine`. The parent field in the CreateBookRequest messages must either be empty or match this field. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1betaBatchCreateTargetSitesRequest; + } + export interface Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Create + extends StandardParameters { + /** + * Required. Parent resource name of TargetSite, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine`. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1betaTargetSite; + } + export interface Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Delete + extends StandardParameters { + /** + * Required. Full resource name of TargetSite, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine/targetSites/{target_site\}`. If the caller does not have permission to access the TargetSite, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested TargetSite does not exist, a NOT_FOUND error is returned. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Get + extends StandardParameters { + /** + * Required. Full resource name of TargetSite, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine/targetSites/{target_site\}`. If the caller does not have permission to access the TargetSite, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested TargetSite does not exist, a NOT_FOUND error is returned. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$List + extends StandardParameters { + /** + * Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. The maximum value is 1000; values above 1000 will be coerced to 1000. If this field is negative, an INVALID_ARGUMENT error is returned. + */ + pageSize?: number; + /** + * A page token, received from a previous `ListTargetSites` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListTargetSites` must match the call that provided the page token. + */ + pageToken?: string; + /** + * Required. The parent site search engine resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine`. If the caller does not have permission to list TargetSites under this site search engine, regardless of whether or not this branch exists, a PERMISSION_DENIED error is returned. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Patch + extends StandardParameters { + /** + * 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. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1betaTargetSite; + } - const rootUrl = - options.rootUrl || 'https://discoveryengine.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest( - parameters - ); - } + export class Resource$Projects$Locations$Datastores$Suggestiondenylistentries { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; } /** - * Makes a recommendation, which requires a contextual user event. + * Imports all SuggestionDenyListEntry for a DataStore. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - recommend( - params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Recommend, + import( + params: Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Import, options: StreamMethodOptions ): GaxiosPromise; - recommend( - params?: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Recommend, + import( + params?: Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Import, options?: MethodOptions - ): GaxiosPromise; - recommend( - params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Recommend, + ): GaxiosPromise; + import( + params: Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Import, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - recommend( - params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Recommend, + import( + params: Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Import, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - recommend( - params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Recommend, - callback: BodyResponseCallback + import( + params: Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Import, + callback: BodyResponseCallback ): void; - recommend( - callback: BodyResponseCallback + import( + callback: BodyResponseCallback ): void; - recommend( + import( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Servingconfigs$Recommend - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Import + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Servingconfigs$Recommend; + {}) as Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Import; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Servingconfigs$Recommend; + {} as Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Import; options = {}; } @@ -24709,92 +27910,89 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+servingConfig}:recommend').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: ( + rootUrl + '/v1beta/{+parent}/suggestionDenyListEntries:import' + ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['servingConfig'], - pathParams: ['servingConfig'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Performs a search. + * Permanently deletes all SuggestionDenyListEntry for a DataStore. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - search( - params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Search, + purge( + params: Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Purge, options: StreamMethodOptions ): GaxiosPromise; - search( - params?: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Search, + purge( + params?: Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Purge, options?: MethodOptions - ): GaxiosPromise; - search( - params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Search, + ): GaxiosPromise; + purge( + params: Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Purge, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - search( - params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Search, + purge( + params: Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Purge, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - search( - params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Search, - callback: BodyResponseCallback + purge( + params: Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Purge, + callback: BodyResponseCallback ): void; - search( - callback: BodyResponseCallback + purge( + callback: BodyResponseCallback ): void; - search( + purge( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Servingconfigs$Search - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Purge + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Servingconfigs$Search; + {}) as Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Purge; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Servingconfigs$Search; + {} as Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Purge; options = {}; } @@ -24808,179 +28006,117 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+servingConfig}:search').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: ( + rootUrl + '/v1beta/{+parent}/suggestionDenyListEntries:purge' + ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['servingConfig'], - pathParams: ['servingConfig'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest( - parameters - ); - } - } - } - - export interface Params$Resource$Projects$Locations$Datastores$Servingconfigs$Answer - extends StandardParameters { - /** - * Required. The resource name of the Search serving config, such as `projects/x/locations/global/collections/default_collection/engines/x/servingConfigs/default_serving_config`, or `projects/x/locations/global/collections/default_collection/dataStores/x/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. - */ - servingConfig?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryRequest; - } - export interface Params$Resource$Projects$Locations$Datastores$Servingconfigs$Get - extends StandardParameters { - /** - * Required. The resource name of the ServingConfig to get. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/engines/{engine\}/servingConfigs/{serving_config_id\}` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Datastores$Servingconfigs$List - extends StandardParameters { - /** - * Optional. Maximum number of results to return. If unspecified, defaults to 100. If a value greater than 100 is provided, at most 100 results are returned. - */ - pageSize?: number; - /** - * Optional. A page token, received from a previous `ListServingConfigs` call. Provide this to retrieve the subsequent page. - */ - pageToken?: string; - /** - * Required. Full resource name of the parent resource. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/engines/{engine\}` - */ - parent?: string; - } - export interface Params$Resource$Projects$Locations$Datastores$Servingconfigs$Patch - extends StandardParameters { - /** - * Immutable. Fully qualified name `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}/servingConfigs/{serving_config_id\}` - */ - name?: string; - /** - * Indicates which fields in the provided ServingConfig to update. The following are NOT supported: * ServingConfig.name If not set, all supported fields are updated. - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1betaServingConfig; + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } } - export interface Params$Resource$Projects$Locations$Datastores$Servingconfigs$Recommend + + export interface Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Import extends StandardParameters { /** - * Required. Full resource name of a ServingConfig: `projects/x/locations/global/collections/x/engines/x/servingConfigs/x`, or `projects/x/locations/global/collections/x/dataStores/x/servingConfigs/x` One default serving config is created along with your recommendation engine creation. The engine ID is used as the ID of the default serving config. For example, for Engine `projects/x/locations/global/collections/x/engines/my-engine`, you can use `projects/x/locations/global/collections/x/engines/my-engine/servingConfigs/my-engine` for your RecommendationService.Recommend requests. + * Required. The parent data store resource name for which to import denylist entries. Follows pattern projects/x/locations/x/collections/x/dataStores/x. */ - servingConfig?: string; + parent?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1betaRecommendRequest; + requestBody?: Schema$GoogleCloudDiscoveryengineV1betaImportSuggestionDenyListEntriesRequest; } - export interface Params$Resource$Projects$Locations$Datastores$Servingconfigs$Search + export interface Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Purge extends StandardParameters { /** - * Required. The resource name of the Search serving config, such as `projects/x/locations/global/collections/default_collection/engines/x/servingConfigs/default_serving_config`, or `projects/x/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. + * Required. The parent data store resource name for which to import denylist entries. Follows pattern projects/x/locations/x/collections/x/dataStores/x. */ - servingConfig?: string; + parent?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequest; + requestBody?: Schema$GoogleCloudDiscoveryengineV1betaPurgeSuggestionDenyListEntriesRequest; } - export class Resource$Projects$Locations$Datastores$Sessions { + export class Resource$Projects$Locations$Datastores$Userevents { context: APIRequestContext; - answers: Resource$Projects$Locations$Datastores$Sessions$Answers; constructor(context: APIRequestContext) { this.context = context; - this.answers = - new Resource$Projects$Locations$Datastores$Sessions$Answers( - this.context - ); } /** - * Creates a Session. If the Session to create already exists, an ALREADY_EXISTS error is returned. + * 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. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - create( - params: Params$Resource$Projects$Locations$Datastores$Sessions$Create, + collect( + params: Params$Resource$Projects$Locations$Datastores$Userevents$Collect, options: StreamMethodOptions ): GaxiosPromise; - create( - params?: Params$Resource$Projects$Locations$Datastores$Sessions$Create, + collect( + params?: Params$Resource$Projects$Locations$Datastores$Userevents$Collect, options?: MethodOptions - ): GaxiosPromise; - create( - params: Params$Resource$Projects$Locations$Datastores$Sessions$Create, + ): GaxiosPromise; + collect( + params: Params$Resource$Projects$Locations$Datastores$Userevents$Collect, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Datastores$Sessions$Create, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - create( - params: Params$Resource$Projects$Locations$Datastores$Sessions$Create, - callback: BodyResponseCallback + collect( + params: Params$Resource$Projects$Locations$Datastores$Userevents$Collect, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - callback: BodyResponseCallback + collect( + params: Params$Resource$Projects$Locations$Datastores$Userevents$Collect, + callback: BodyResponseCallback ): void; - create( + collect(callback: BodyResponseCallback): void; + collect( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Sessions$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Userevents$Collect + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Sessions$Create; + {}) as Params$Resource$Projects$Locations$Datastores$Userevents$Collect; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Sessions$Create; + {} as Params$Resource$Projects$Locations$Datastores$Userevents$Collect; options = {}; } @@ -24994,11 +28130,11 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+parent}/sessions').replace( + url: (rootUrl + '/v1beta/{+parent}/userEvents:collect').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', apiVersion: '', }, options @@ -25009,73 +28145,75 @@ export namespace discoveryengine_v1beta { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Deletes a Session. If the Session to delete does not exist, a NOT_FOUND error is returned. + * 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. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - delete( - params: Params$Resource$Projects$Locations$Datastores$Sessions$Delete, + import( + params: Params$Resource$Projects$Locations$Datastores$Userevents$Import, options: StreamMethodOptions ): GaxiosPromise; - delete( - params?: Params$Resource$Projects$Locations$Datastores$Sessions$Delete, + import( + params?: Params$Resource$Projects$Locations$Datastores$Userevents$Import, options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Projects$Locations$Datastores$Sessions$Delete, + ): GaxiosPromise; + import( + params: Params$Resource$Projects$Locations$Datastores$Userevents$Import, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Datastores$Sessions$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + import( + params: Params$Resource$Projects$Locations$Datastores$Userevents$Import, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Datastores$Sessions$Delete, - callback: BodyResponseCallback + import( + params: Params$Resource$Projects$Locations$Datastores$Userevents$Import, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + import( + callback: BodyResponseCallback + ): void; + import( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Sessions$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Userevents$Import + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Sessions$Delete; + {}) as Params$Resource$Projects$Locations$Datastores$Userevents$Import; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Sessions$Delete; + {} as Params$Resource$Projects$Locations$Datastores$Userevents$Import; options = {}; } @@ -25089,87 +28227,90 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1beta/{+parent}/userEvents:import').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Gets a Session. + * Writes a single user event. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Datastores$Sessions$Get, + write( + params: Params$Resource$Projects$Locations$Datastores$Userevents$Write, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Datastores$Sessions$Get, + write( + params?: Params$Resource$Projects$Locations$Datastores$Userevents$Write, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Datastores$Sessions$Get, + ): GaxiosPromise; + write( + params: Params$Resource$Projects$Locations$Datastores$Userevents$Write, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Datastores$Sessions$Get, + write( + params: Params$Resource$Projects$Locations$Datastores$Userevents$Write, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Datastores$Sessions$Get, - callback: BodyResponseCallback + write( + params: Params$Resource$Projects$Locations$Datastores$Userevents$Write, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + write( + callback: BodyResponseCallback ): void; - get( + write( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Sessions$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Userevents$Write + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Sessions$Get; + {}) as Params$Resource$Projects$Locations$Datastores$Userevents$Write; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Sessions$Get; + {} as Params$Resource$Projects$Locations$Datastores$Userevents$Write; options = {}; } @@ -25183,89 +28324,150 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1beta/{+parent}/userEvents:write').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } + } + + export interface Params$Resource$Projects$Locations$Datastores$Userevents$Collect + extends StandardParameters { + /** + * The event timestamp in milliseconds. This prevents browser caching of otherwise identical get requests. The name is abbreviated to reduce the payload bytes. + */ + ets?: string; + /** + * Required. The parent DataStore resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}`. + */ + parent?: string; + /** + * 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 third-party requests. + */ + uri?: string; + /** + * Required. URL encoded UserEvent proto with a length limit of 2,000,000 characters. + */ + userEvent?: string; + } + export interface Params$Resource$Projects$Locations$Datastores$Userevents$Import + extends StandardParameters { + /** + * Required. Parent DataStore resource name, of the form `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1betaImportUserEventsRequest; + } + export interface Params$Resource$Projects$Locations$Datastores$Userevents$Write + extends StandardParameters { + /** + * Required. The parent resource name. If the write user event action is applied in DataStore level, the format is: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}`. If the write user event action is applied in Location level, for example, the event with Document across multiple DataStore, the format is: `projects/{project\}/locations/{location\}`. + */ + parent?: string; + /** + * If set to true, the user event is written asynchronously after validation, and the API responds without waiting for the write. + */ + writeAsync?: boolean; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1betaUserEvent; + } + + export class Resource$Projects$Locations$Evaluations { + context: APIRequestContext; + operations: Resource$Projects$Locations$Evaluations$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.operations = new Resource$Projects$Locations$Evaluations$Operations( + this.context + ); + } /** - * Lists all Sessions by their parent DataStore. + * Creates a Evaluation. Upon creation, the evaluation will be automatically triggered and begin execution. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Datastores$Sessions$List, + create( + params: Params$Resource$Projects$Locations$Evaluations$Create, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Datastores$Sessions$List, + create( + params?: Params$Resource$Projects$Locations$Evaluations$Create, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Datastores$Sessions$List, + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Evaluations$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Datastores$Sessions$List, + create( + params: Params$Resource$Projects$Locations$Evaluations$Create, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Datastores$Sessions$List, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Evaluations$Create, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + create( + callback: BodyResponseCallback ): void; - list( + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Sessions$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Evaluations$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Sessions$List; + {}) as Params$Resource$Projects$Locations$Evaluations$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Datastores$Sessions$List; + params = {} as Params$Resource$Projects$Locations$Evaluations$Create; options = {}; } @@ -25279,11 +28481,11 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+parent}/sessions').replace( + url: (rootUrl + '/v1beta/{+parent}/evaluations').replace( /([^:]\/)\/+/g, '$1' ), - method: 'GET', + method: 'POST', apiVersion: '', }, options @@ -25294,77 +28496,74 @@ export namespace discoveryengine_v1beta { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Updates a Session. Session action type cannot be changed. If the Session to update does not exist, a NOT_FOUND error is returned. + * Gets a Evaluation. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - patch( - params: Params$Resource$Projects$Locations$Datastores$Sessions$Patch, + get( + params: Params$Resource$Projects$Locations$Evaluations$Get, options: StreamMethodOptions ): GaxiosPromise; - patch( - params?: Params$Resource$Projects$Locations$Datastores$Sessions$Patch, + get( + params?: Params$Resource$Projects$Locations$Evaluations$Get, options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Projects$Locations$Datastores$Sessions$Patch, + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Evaluations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Datastores$Sessions$Patch, + get( + params: Params$Resource$Projects$Locations$Evaluations$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Datastores$Sessions$Patch, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Evaluations$Get, + callback: BodyResponseCallback ): void; - patch( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - patch( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Sessions$Patch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Evaluations$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Sessions$Patch; + {}) as Params$Resource$Projects$Locations$Evaluations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Datastores$Sessions$Patch; + params = {} as Params$Resource$Projects$Locations$Evaluations$Get; options = {}; } @@ -25379,7 +28578,7 @@ export namespace discoveryengine_v1beta { options: Object.assign( { url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + method: 'GET', apiVersion: '', }, options @@ -25390,150 +28589,76 @@ export namespace discoveryengine_v1beta { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } - } - - export interface Params$Resource$Projects$Locations$Datastores$Sessions$Create - extends StandardParameters { - /** - * Required. Full resource name of parent data store. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}` - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1betaSession; - } - export interface Params$Resource$Projects$Locations$Datastores$Sessions$Delete - extends StandardParameters { - /** - * Required. The resource name of the Session to delete. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/sessions/{session_id\}` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Datastores$Sessions$Get - extends StandardParameters { - /** - * Required. The resource name of the Session to get. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/sessions/{session_id\}` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Datastores$Sessions$List - extends StandardParameters { - /** - * A filter to apply on the list results. The supported features are: user_pseudo_id, state. Example: "user_pseudo_id = some_id" - */ - filter?: string; - /** - * 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` Example: "update_time desc" "create_time" - */ - orderBy?: string; - /** - * Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000. - */ - pageSize?: number; - /** - * A page token, received from a previous `ListSessions` call. Provide this to retrieve the subsequent page. - */ - pageToken?: string; - /** - * Required. The data store resource name. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}` - */ - parent?: string; - } - export interface Params$Resource$Projects$Locations$Datastores$Sessions$Patch - extends StandardParameters { - /** - * Immutable. Fully qualified name `projects/{project\}/locations/global/collections/{collection\}/engines/{engine\}/sessions/x` - */ - name?: string; - /** - * 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. - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1betaSession; - } - - export class Resource$Projects$Locations$Datastores$Sessions$Answers { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Gets a Answer. + * Gets a list of Evaluations. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Datastores$Sessions$Answers$Get, + list( + params: Params$Resource$Projects$Locations$Evaluations$List, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Datastores$Sessions$Answers$Get, + list( + params?: Params$Resource$Projects$Locations$Evaluations$List, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Datastores$Sessions$Answers$Get, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Evaluations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Datastores$Sessions$Answers$Get, + list( + params: Params$Resource$Projects$Locations$Evaluations$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Datastores$Sessions$Answers$Get, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Evaluations$List, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - get( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Sessions$Answers$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Evaluations$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Sessions$Answers$Get; + {}) as Params$Resource$Projects$Locations$Evaluations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Datastores$Sessions$Answers$Get; + params = {} as Params$Resource$Projects$Locations$Evaluations$List; options = {}; } @@ -25547,109 +28672,92 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1beta/{+parent}/evaluations').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); - } - } - } - - export interface Params$Resource$Projects$Locations$Datastores$Sessions$Answers$Get - extends StandardParameters { - /** - * Required. The resource name of the Answer to get. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/engines/{engine_id\}/sessions/{session_id\}/answers/{answer_id\}` - */ - name?: string; - } - - export class Resource$Projects$Locations$Datastores$Sitesearchengine { - context: APIRequestContext; - targetSites: Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites; - constructor(context: APIRequestContext) { - this.context = context; - this.targetSites = - new Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites( - this.context + return createAPIRequest( + parameters ); + } } /** - * Downgrade from advanced site search to basic site search. + * Gets a list of results for a given a Evaluation. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - disableAdvancedSiteSearch( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Disableadvancedsitesearch, + listResults( + params: Params$Resource$Projects$Locations$Evaluations$Listresults, options: StreamMethodOptions ): GaxiosPromise; - disableAdvancedSiteSearch( - params?: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Disableadvancedsitesearch, + listResults( + params?: Params$Resource$Projects$Locations$Evaluations$Listresults, options?: MethodOptions - ): GaxiosPromise; - disableAdvancedSiteSearch( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Disableadvancedsitesearch, + ): GaxiosPromise; + listResults( + params: Params$Resource$Projects$Locations$Evaluations$Listresults, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - disableAdvancedSiteSearch( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Disableadvancedsitesearch, + listResults( + params: Params$Resource$Projects$Locations$Evaluations$Listresults, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - disableAdvancedSiteSearch( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Disableadvancedsitesearch, - callback: BodyResponseCallback + listResults( + params: Params$Resource$Projects$Locations$Evaluations$Listresults, + callback: BodyResponseCallback ): void; - disableAdvancedSiteSearch( - callback: BodyResponseCallback + listResults( + callback: BodyResponseCallback ): void; - disableAdvancedSiteSearch( + listResults( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Disableadvancedsitesearch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Evaluations$Listresults + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Disableadvancedsitesearch; + {}) as Params$Resource$Projects$Locations$Evaluations$Listresults; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Disableadvancedsitesearch; + {} as Params$Resource$Projects$Locations$Evaluations$Listresults; options = {}; } @@ -25663,67 +28771,127 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: ( - rootUrl + '/v1beta/{+siteSearchEngine}:disableAdvancedSiteSearch' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + url: (rootUrl + '/v1beta/{+evaluation}:listResults').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['siteSearchEngine'], - pathParams: ['siteSearchEngine'], + requiredParams: ['evaluation'], + pathParams: ['evaluation'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } + } + export interface Params$Resource$Projects$Locations$Evaluations$Create + extends StandardParameters { /** - * Upgrade from basic site search to advanced site search. + * Required. The parent resource name, such as `projects/{project\}/locations/{location\}`. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1betaEvaluation; + } + export interface Params$Resource$Projects$Locations$Evaluations$Get + extends StandardParameters { + /** + * Required. Full resource name of Evaluation, such as `projects/{project\}/locations/{location\}/evaluations/{evaluation\}`. If the caller does not have permission to access the Evaluation, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested Evaluation does not exist, a NOT_FOUND error is returned. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Evaluations$List + extends StandardParameters { + /** + * Maximum number of Evaluations to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned. + */ + pageSize?: number; + /** + * A page token ListEvaluationsResponse.next_page_token, received from a previous EvaluationService.ListEvaluations call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to EvaluationService.ListEvaluations must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned. + */ + pageToken?: string; + /** + * Required. The parent location resource name, such as `projects/{project\}/locations/{location\}`. If the caller does not have permission to list Evaluations under this location, regardless of whether or not this location exists, a `PERMISSION_DENIED` error is returned. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Evaluations$Listresults + extends StandardParameters { + /** + * Required. The evaluation resource name, such as `projects/{project\}/locations/{location\}/evaluations/{evaluation\}`. If the caller does not have permission to list EvaluationResult under this evaluation, regardless of whether or not this evaluation set exists, a `PERMISSION_DENIED` error is returned. + */ + evaluation?: string; + /** + * Maximum number of EvaluationResult to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned. + */ + pageSize?: number; + /** + * A page token ListEvaluationResultsResponse.next_page_token, received from a previous EvaluationService.ListEvaluationResults call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to EvaluationService.ListEvaluationResults must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned. + */ + pageToken?: string; + } + + export class Resource$Projects$Locations$Evaluations$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * 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. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - enableAdvancedSiteSearch( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Enableadvancedsitesearch, + get( + params: Params$Resource$Projects$Locations$Evaluations$Operations$Get, options: StreamMethodOptions ): GaxiosPromise; - enableAdvancedSiteSearch( - params?: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Enableadvancedsitesearch, + get( + params?: Params$Resource$Projects$Locations$Evaluations$Operations$Get, options?: MethodOptions ): GaxiosPromise; - enableAdvancedSiteSearch( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Enableadvancedsitesearch, + get( + params: Params$Resource$Projects$Locations$Evaluations$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - enableAdvancedSiteSearch( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Enableadvancedsitesearch, + get( + params: Params$Resource$Projects$Locations$Evaluations$Operations$Get, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - enableAdvancedSiteSearch( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Enableadvancedsitesearch, + get( + params: Params$Resource$Projects$Locations$Evaluations$Operations$Get, callback: BodyResponseCallback ): void; - enableAdvancedSiteSearch( + get( callback: BodyResponseCallback ): void; - enableAdvancedSiteSearch( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Enableadvancedsitesearch + | Params$Resource$Projects$Locations$Evaluations$Operations$Get | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -25739,13 +28907,13 @@ export namespace discoveryengine_v1beta { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Enableadvancedsitesearch; + {}) as Params$Resource$Projects$Locations$Evaluations$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Enableadvancedsitesearch; + {} as Params$Resource$Projects$Locations$Evaluations$Operations$Get; options = {}; } @@ -25759,17 +28927,15 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: ( - rootUrl + '/v1beta/{+siteSearchEngine}:enableAdvancedSiteSearch' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['siteSearchEngine'], - pathParams: ['siteSearchEngine'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { @@ -25781,67 +28947,82 @@ export namespace discoveryengine_v1beta { return createAPIRequest(parameters); } } + } + export interface Params$Resource$Projects$Locations$Evaluations$Operations$Get + extends StandardParameters { /** - * Request on-demand recrawl for a list of URIs. + * The name of the operation resource. + */ + name?: string; + } + + export class Resource$Projects$Locations$Groundingconfigs { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Performs a grounding check. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - recrawlUris( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Recrawluris, + check( + params: Params$Resource$Projects$Locations$Groundingconfigs$Check, options: StreamMethodOptions ): GaxiosPromise; - recrawlUris( - params?: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Recrawluris, + check( + params?: Params$Resource$Projects$Locations$Groundingconfigs$Check, options?: MethodOptions - ): GaxiosPromise; - recrawlUris( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Recrawluris, + ): GaxiosPromise; + check( + params: Params$Resource$Projects$Locations$Groundingconfigs$Check, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - recrawlUris( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Recrawluris, + check( + params: Params$Resource$Projects$Locations$Groundingconfigs$Check, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - recrawlUris( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Recrawluris, - callback: BodyResponseCallback + check( + params: Params$Resource$Projects$Locations$Groundingconfigs$Check, + callback: BodyResponseCallback ): void; - recrawlUris( - callback: BodyResponseCallback + check( + callback: BodyResponseCallback ): void; - recrawlUris( + check( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Recrawluris - | BodyResponseCallback + | Params$Resource$Projects$Locations$Groundingconfigs$Check + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Recrawluris; + {}) as Params$Resource$Projects$Locations$Groundingconfigs$Check; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Recrawluris; + {} as Params$Resource$Projects$Locations$Groundingconfigs$Check; options = {}; } @@ -25855,7 +29036,7 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+siteSearchEngine}:recrawlUris').replace( + url: (rootUrl + '/v1beta/{+groundingConfig}:check').replace( /([^:]\/)\/+/g, '$1' ), @@ -25865,102 +29046,80 @@ export namespace discoveryengine_v1beta { options ), params, - requiredParams: ['siteSearchEngine'], - pathParams: ['siteSearchEngine'], + requiredParams: ['groundingConfig'], + pathParams: ['groundingConfig'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } } - export interface Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Disableadvancedsitesearch - extends StandardParameters { - /** - * Required. Full resource name of the SiteSearchEngine, such as `projects/{project\}/locations/{location\}/dataStores/{data_store_id\}/siteSearchEngine`. - */ - siteSearchEngine?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1betaDisableAdvancedSiteSearchRequest; - } - export interface Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Enableadvancedsitesearch - extends StandardParameters { - /** - * Required. Full resource name of the SiteSearchEngine, such as `projects/{project\}/locations/{location\}/dataStores/{data_store_id\}/siteSearchEngine`. - */ - siteSearchEngine?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1betaEnableAdvancedSiteSearchRequest; - } - export interface Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Recrawluris + export interface Params$Resource$Projects$Locations$Groundingconfigs$Check extends StandardParameters { /** - * Required. Full resource name of the SiteSearchEngine, such as `projects/x/locations/x/collections/x/dataStores/x/siteSearchEngine`. + * Required. The resource name of the grounding config, such as `projects/x/locations/global/groundingConfigs/default_grounding_config`. */ - siteSearchEngine?: string; + groundingConfig?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1betaRecrawlUrisRequest; + requestBody?: Schema$GoogleCloudDiscoveryengineV1betaCheckGroundingRequest; } - export class Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites { + export class Resource$Projects$Locations$Operations { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * Creates TargetSite in a batch. + * 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. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - batchCreate( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Batchcreate, + get( + params: Params$Resource$Projects$Locations$Operations$Get, options: StreamMethodOptions ): GaxiosPromise; - batchCreate( - params?: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Batchcreate, + get( + params?: Params$Resource$Projects$Locations$Operations$Get, options?: MethodOptions ): GaxiosPromise; - batchCreate( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Batchcreate, + get( + params: Params$Resource$Projects$Locations$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - batchCreate( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Batchcreate, + get( + params: Params$Resource$Projects$Locations$Operations$Get, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - batchCreate( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Batchcreate, + get( + params: Params$Resource$Projects$Locations$Operations$Get, callback: BodyResponseCallback ): void; - batchCreate( + get( callback: BodyResponseCallback ): void; - batchCreate( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Batchcreate + | Params$Resource$Projects$Locations$Operations$Get | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -25976,13 +29135,12 @@ export namespace discoveryengine_v1beta { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Batchcreate; + {}) as Params$Resource$Projects$Locations$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Batchcreate; + params = {} as Params$Resource$Projects$Locations$Operations$Get; options = {}; } @@ -25996,17 +29154,15 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: ( - rootUrl + '/v1beta/{+parent}/targetSites:batchCreate' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { @@ -26020,65 +29176,64 @@ export namespace discoveryengine_v1beta { } /** - * Creates a TargetSite. + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - create( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Create, + list( + params: Params$Resource$Projects$Locations$Operations$List, options: StreamMethodOptions ): GaxiosPromise; - create( - params?: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Create, + list( + params?: Params$Resource$Projects$Locations$Operations$List, options?: MethodOptions - ): GaxiosPromise; - create( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Create, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Create, + list( + params: Params$Resource$Projects$Locations$Operations$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Create, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Operations$List, + callback: BodyResponseCallback ): void; - create( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - create( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Operations$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Create; + {}) as Params$Resource$Projects$Locations$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Create; + params = {} as Params$Resource$Projects$Locations$Operations$List; options = {}; } @@ -26092,90 +29247,125 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+parent}/targetSites').replace( + url: (rootUrl + '/v1beta/{+name}/operations').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } + } + export interface Params$Resource$Projects$Locations$Operations$Get + extends StandardParameters { /** - * Deletes a TargetSite. + * The name of the operation resource. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Operations$List + extends StandardParameters { + /** + * The standard list filter. + */ + filter?: string; + /** + * The name of the operation's parent resource. + */ + name?: string; + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. + */ + pageToken?: string; + } + + export class Resource$Projects$Locations$Rankingconfigs { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Ranks a list of text records based on the given input query. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - delete( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Delete, + rank( + params: Params$Resource$Projects$Locations$Rankingconfigs$Rank, options: StreamMethodOptions ): GaxiosPromise; - delete( - params?: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Delete, + rank( + params?: Params$Resource$Projects$Locations$Rankingconfigs$Rank, options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Delete, + ): GaxiosPromise; + rank( + params: Params$Resource$Projects$Locations$Rankingconfigs$Rank, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Delete, + rank( + params: Params$Resource$Projects$Locations$Rankingconfigs$Rank, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Delete, - callback: BodyResponseCallback + rank( + params: Params$Resource$Projects$Locations$Rankingconfigs$Rank, + callback: BodyResponseCallback ): void; - delete( - callback: BodyResponseCallback + rank( + callback: BodyResponseCallback ): void; - delete( + rank( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Rankingconfigs$Rank + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Delete; + {}) as Params$Resource$Projects$Locations$Rankingconfigs$Rank; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Delete; + params = {} as Params$Resource$Projects$Locations$Rankingconfigs$Rank; options = {}; } @@ -26189,87 +29379,122 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1beta/{+rankingConfig}:rank').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['rankingConfig'], + pathParams: ['rankingConfig'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } + } + + export interface Params$Resource$Projects$Locations$Rankingconfigs$Rank + extends StandardParameters { + /** + * Required. The resource name of the rank service config, such as `projects/{project_num\}/locations/{location_id\}/rankingConfigs/default_ranking_config`. + */ + rankingConfig?: string; /** - * Gets a TargetSite. + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1betaRankRequest; + } + + export class Resource$Projects$Locations$Samplequerysets { + context: APIRequestContext; + operations: Resource$Projects$Locations$Samplequerysets$Operations; + sampleQueries: Resource$Projects$Locations$Samplequerysets$Samplequeries; + constructor(context: APIRequestContext) { + this.context = context; + this.operations = + new Resource$Projects$Locations$Samplequerysets$Operations( + this.context + ); + this.sampleQueries = + new Resource$Projects$Locations$Samplequerysets$Samplequeries( + this.context + ); + } + + /** + * Creates a SampleQuerySet * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Get, + create( + params: Params$Resource$Projects$Locations$Samplequerysets$Create, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Get, + create( + params?: Params$Resource$Projects$Locations$Samplequerysets$Create, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Get, + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Samplequerysets$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Get, + create( + params: Params$Resource$Projects$Locations$Samplequerysets$Create, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Get, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Samplequerysets$Create, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + create( + callback: BodyResponseCallback ): void; - get( + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Samplequerysets$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Get; + {}) as Params$Resource$Projects$Locations$Samplequerysets$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Get; + {} as Params$Resource$Projects$Locations$Samplequerysets$Create; options = {}; } @@ -26283,89 +29508,88 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1beta/{+parent}/sampleQuerySets').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Gets a list of TargetSites. + * Deletes a SampleQuerySet. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$List, + delete( + params: Params$Resource$Projects$Locations$Samplequerysets$Delete, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$List, + delete( + params?: Params$Resource$Projects$Locations$Samplequerysets$Delete, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$List, + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Samplequerysets$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$List, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Samplequerysets$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Samplequerysets$Delete, + callback: BodyResponseCallback ): void; - list( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Samplequerysets$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$List; + {}) as Params$Resource$Projects$Locations$Samplequerysets$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$List; + {} as Params$Resource$Projects$Locations$Samplequerysets$Delete; options = {}; } @@ -26379,92 +29603,86 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+parent}/targetSites').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Updates a TargetSite. + * Gets a SampleQuerySet. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - patch( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Patch, + get( + params: Params$Resource$Projects$Locations$Samplequerysets$Get, options: StreamMethodOptions ): GaxiosPromise; - patch( - params?: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Patch, + get( + params?: Params$Resource$Projects$Locations$Samplequerysets$Get, options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Patch, + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Samplequerysets$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Patch, + get( + params: Params$Resource$Projects$Locations$Samplequerysets$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Patch, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Samplequerysets$Get, + callback: BodyResponseCallback ): void; - patch( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - patch( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Patch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Samplequerysets$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Patch; + {}) as Params$Resource$Projects$Locations$Samplequerysets$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Patch; + params = {} as Params$Resource$Projects$Locations$Samplequerysets$Get; options = {}; } @@ -26479,7 +29697,7 @@ export namespace discoveryengine_v1beta { options: Object.assign( { url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + method: 'GET', apiVersion: '', }, options @@ -26490,148 +29708,76 @@ export namespace discoveryengine_v1beta { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } - } - - export interface Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Batchcreate - extends StandardParameters { - /** - * Required. The parent resource shared by all TargetSites being created. `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine`. The parent field in the CreateBookRequest messages must either be empty or match this field. - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1betaBatchCreateTargetSitesRequest; - } - export interface Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Create - extends StandardParameters { - /** - * Required. Parent resource name of TargetSite, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine`. - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1betaTargetSite; - } - export interface Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Delete - extends StandardParameters { - /** - * Required. Full resource name of TargetSite, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine/targetSites/{target_site\}`. If the caller does not have permission to access the TargetSite, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested TargetSite does not exist, a NOT_FOUND error is returned. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Get - extends StandardParameters { - /** - * Required. Full resource name of TargetSite, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine/targetSites/{target_site\}`. If the caller does not have permission to access the TargetSite, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested TargetSite does not exist, a NOT_FOUND error is returned. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$List - extends StandardParameters { - /** - * Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. The maximum value is 1000; values above 1000 will be coerced to 1000. If this field is negative, an INVALID_ARGUMENT error is returned. - */ - pageSize?: number; - /** - * A page token, received from a previous `ListTargetSites` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListTargetSites` must match the call that provided the page token. - */ - pageToken?: string; - /** - * Required. The parent site search engine resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine`. If the caller does not have permission to list TargetSites under this site search engine, regardless of whether or not this branch exists, a PERMISSION_DENIED error is returned. - */ - parent?: string; - } - export interface Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Patch - extends StandardParameters { - /** - * 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. - */ - name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1betaTargetSite; - } - - export class Resource$Projects$Locations$Datastores$Suggestiondenylistentries { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Imports all SuggestionDenyListEntry for a DataStore. + * Gets a list of SampleQuerySets. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - import( - params: Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Import, + list( + params: Params$Resource$Projects$Locations$Samplequerysets$List, options: StreamMethodOptions ): GaxiosPromise; - import( - params?: Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Import, + list( + params?: Params$Resource$Projects$Locations$Samplequerysets$List, options?: MethodOptions - ): GaxiosPromise; - import( - params: Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Import, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Samplequerysets$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - import( - params: Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Import, + list( + params: Params$Resource$Projects$Locations$Samplequerysets$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - import( - params: Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Import, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Samplequerysets$List, + callback: BodyResponseCallback ): void; - import( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - import( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Import - | BodyResponseCallback + | Params$Resource$Projects$Locations$Samplequerysets$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Import; + {}) as Params$Resource$Projects$Locations$Samplequerysets$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Import; + params = {} as Params$Resource$Projects$Locations$Samplequerysets$List; options = {}; } @@ -26645,10 +29791,11 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: ( - rootUrl + '/v1beta/{+parent}/suggestionDenyListEntries:import' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + url: (rootUrl + '/v1beta/{+parent}/sampleQuerySets').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', apiVersion: '', }, options @@ -26659,75 +29806,76 @@ export namespace discoveryengine_v1beta { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Permanently deletes all SuggestionDenyListEntry for a DataStore. + * Updates a SampleQuerySet. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - purge( - params: Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Purge, + patch( + params: Params$Resource$Projects$Locations$Samplequerysets$Patch, options: StreamMethodOptions ): GaxiosPromise; - purge( - params?: Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Purge, + patch( + params?: Params$Resource$Projects$Locations$Samplequerysets$Patch, options?: MethodOptions - ): GaxiosPromise; - purge( - params: Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Purge, + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Samplequerysets$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - purge( - params: Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Purge, + patch( + params: Params$Resource$Projects$Locations$Samplequerysets$Patch, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - purge( - params: Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Purge, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Samplequerysets$Patch, + callback: BodyResponseCallback ): void; - purge( - callback: BodyResponseCallback + patch( + callback: BodyResponseCallback ): void; - purge( + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Purge - | BodyResponseCallback + | Params$Resource$Projects$Locations$Samplequerysets$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Purge; + {}) as Params$Resource$Projects$Locations$Samplequerysets$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Purge; + params = {} as Params$Resource$Projects$Locations$Samplequerysets$Patch; options = {}; } @@ -26741,117 +29889,158 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: ( - rootUrl + '/v1beta/{+parent}/suggestionDenyListEntries:purge' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } } - export interface Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Import + export interface Params$Resource$Projects$Locations$Samplequerysets$Create extends StandardParameters { /** - * Required. The parent data store resource name for which to import denylist entries. Follows pattern projects/x/locations/x/collections/x/dataStores/x. + * Required. The parent resource name, such as `projects/{project\}/locations/{location\}`. */ parent?: string; + /** + * Required. The ID to use for the SampleQuerySet, which will become the final component of the SampleQuerySet.name. If the caller does not have permission to create the SampleQuerySet, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. This field must be unique among all SampleQuerySets with the same parent. Otherwise, an `ALREADY_EXISTS` error is returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. + */ + sampleQuerySetId?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1betaImportSuggestionDenyListEntriesRequest; + requestBody?: Schema$GoogleCloudDiscoveryengineV1betaSampleQuerySet; } - export interface Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Purge + export interface Params$Resource$Projects$Locations$Samplequerysets$Delete extends StandardParameters { /** - * Required. The parent data store resource name for which to import denylist entries. Follows pattern projects/x/locations/x/collections/x/dataStores/x. + * Required. Full resource name of SampleQuerySet, such as `projects/{project\}/locations/{location\}/sampleQuerySets/{sampleQuerySet\}`. If the caller does not have permission to delete the SampleQuerySet, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the SampleQuerySet to delete does not exist, a `NOT_FOUND` error is returned. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Samplequerysets$Get + extends StandardParameters { + /** + * Required. Full resource name of SampleQuerySet, such as `projects/{project\}/locations/{location\}/sampleQuerySets/{sampleQuerySet\}`. If the caller does not have permission to access the SampleQuerySet, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested SampleQuerySet does not exist, a NOT_FOUND error is returned. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Samplequerysets$List + extends StandardParameters { + /** + * Maximum number of SampleQuerySets to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned. + */ + pageSize?: number; + /** + * A page token ListSampleQuerySetsResponse.next_page_token, received from a previous SampleQuerySetService.ListSampleQuerySets call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SampleQuerySetService.ListSampleQuerySets must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned. + */ + pageToken?: string; + /** + * Required. The parent location resource name, such as `projects/{project\}/locations/{location\}`. If the caller does not have permission to list SampleQuerySets under this location, regardless of whether or not this location exists, a `PERMISSION_DENIED` error is returned. */ parent?: string; + } + export interface Params$Resource$Projects$Locations$Samplequerysets$Patch + extends StandardParameters { + /** + * Immutable. The full resource name of the SampleQuerySet, in the format of `projects/{project\}/locations/{location\}/sampleQuerySets/{sampleQuerySet\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. + */ + name?: string; + /** + * Indicates which fields in the provided imported 'sample query set' to update. If not set, will by default update all fields. + */ + updateMask?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1betaPurgeSuggestionDenyListEntriesRequest; + requestBody?: Schema$GoogleCloudDiscoveryengineV1betaSampleQuerySet; } - export class Resource$Projects$Locations$Datastores$Userevents { + export class Resource$Projects$Locations$Samplequerysets$Operations { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * 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. + * 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. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - collect( - params: Params$Resource$Projects$Locations$Datastores$Userevents$Collect, + get( + params: Params$Resource$Projects$Locations$Samplequerysets$Operations$Get, options: StreamMethodOptions ): GaxiosPromise; - collect( - params?: Params$Resource$Projects$Locations$Datastores$Userevents$Collect, + get( + params?: Params$Resource$Projects$Locations$Samplequerysets$Operations$Get, options?: MethodOptions - ): GaxiosPromise; - collect( - params: Params$Resource$Projects$Locations$Datastores$Userevents$Collect, + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Samplequerysets$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - collect( - params: Params$Resource$Projects$Locations$Datastores$Userevents$Collect, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Samplequerysets$Operations$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - collect( - params: Params$Resource$Projects$Locations$Datastores$Userevents$Collect, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Samplequerysets$Operations$Get, + callback: BodyResponseCallback ): void; - collect(callback: BodyResponseCallback): void; - collect( + get( + callback: BodyResponseCallback + ): void; + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Userevents$Collect - | BodyResponseCallback + | Params$Resource$Projects$Locations$Samplequerysets$Operations$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Userevents$Collect; + {}) as Params$Resource$Projects$Locations$Samplequerysets$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Userevents$Collect; + {} as Params$Resource$Projects$Locations$Samplequerysets$Operations$Get; options = {}; } @@ -26865,90 +30054,102 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+parent}/userEvents:collect').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } + } + export interface Params$Resource$Projects$Locations$Samplequerysets$Operations$Get + extends StandardParameters { /** - * 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. + * The name of the operation resource. + */ + name?: string; + } + + export class Resource$Projects$Locations$Samplequerysets$Samplequeries { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Creates a SampleQuery * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - import( - params: Params$Resource$Projects$Locations$Datastores$Userevents$Import, + create( + params: Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Create, options: StreamMethodOptions ): GaxiosPromise; - import( - params?: Params$Resource$Projects$Locations$Datastores$Userevents$Import, + create( + params?: Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Create, options?: MethodOptions - ): GaxiosPromise; - import( - params: Params$Resource$Projects$Locations$Datastores$Userevents$Import, + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - import( - params: Params$Resource$Projects$Locations$Datastores$Userevents$Import, + create( + params: Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Create, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - import( - params: Params$Resource$Projects$Locations$Datastores$Userevents$Import, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Create, + callback: BodyResponseCallback ): void; - import( - callback: BodyResponseCallback + create( + callback: BodyResponseCallback ): void; - import( + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Userevents$Import - | BodyResponseCallback + | Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Userevents$Import; + {}) as Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Userevents$Import; + {} as Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Create; options = {}; } @@ -26962,7 +30163,7 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+parent}/userEvents:import').replace( + url: (rootUrl + '/v1beta/{+parent}/sampleQueries').replace( /([^:]\/)\/+/g, '$1' ), @@ -26977,75 +30178,73 @@ export namespace discoveryengine_v1beta { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Writes a single user event. + * Deletes a SampleQuery. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - write( - params: Params$Resource$Projects$Locations$Datastores$Userevents$Write, + delete( + params: Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Delete, options: StreamMethodOptions ): GaxiosPromise; - write( - params?: Params$Resource$Projects$Locations$Datastores$Userevents$Write, + delete( + params?: Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Delete, options?: MethodOptions - ): GaxiosPromise; - write( - params: Params$Resource$Projects$Locations$Datastores$Userevents$Write, + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - write( - params: Params$Resource$Projects$Locations$Datastores$Userevents$Write, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - write( - params: Params$Resource$Projects$Locations$Datastores$Userevents$Write, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - write( - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Delete, + callback: BodyResponseCallback ): void; - write( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Userevents$Write - | BodyResponseCallback + | Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Userevents$Write; + {}) as Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Userevents$Write; + {} as Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Delete; options = {}; } @@ -27059,147 +30258,87 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+parent}/userEvents:write').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); - } - } - } - - export interface Params$Resource$Projects$Locations$Datastores$Userevents$Collect - extends StandardParameters { - /** - * The event timestamp in milliseconds. This prevents browser caching of otherwise identical get requests. The name is abbreviated to reduce the payload bytes. - */ - ets?: string; - /** - * Required. The parent DataStore resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}`. - */ - parent?: string; - /** - * 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 third-party requests. - */ - uri?: string; - /** - * Required. URL encoded UserEvent proto with a length limit of 2,000,000 characters. - */ - userEvent?: string; - } - export interface Params$Resource$Projects$Locations$Datastores$Userevents$Import - extends StandardParameters { - /** - * Required. Parent DataStore resource name, of the form `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}` - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1betaImportUserEventsRequest; - } - export interface Params$Resource$Projects$Locations$Datastores$Userevents$Write - extends StandardParameters { - /** - * Required. The parent resource name. If the write user event action is applied in DataStore level, the format is: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}`. If the write user event action is applied in Location level, for example, the event with Document across multiple DataStore, the format is: `projects/{project\}/locations/{location\}`. - */ - parent?: string; - /** - * If set to true, the user event is written asynchronously after validation, and the API responds without waiting for the write. - */ - writeAsync?: boolean; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1betaUserEvent; - } - - export class Resource$Projects$Locations$Groundingconfigs { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; + return createAPIRequest(parameters); + } } /** - * Performs a grounding check. + * Gets a SampleQuery. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - check( - params: Params$Resource$Projects$Locations$Groundingconfigs$Check, + get( + params: Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Get, options: StreamMethodOptions ): GaxiosPromise; - check( - params?: Params$Resource$Projects$Locations$Groundingconfigs$Check, + get( + params?: Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Get, options?: MethodOptions - ): GaxiosPromise; - check( - params: Params$Resource$Projects$Locations$Groundingconfigs$Check, + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - check( - params: Params$Resource$Projects$Locations$Groundingconfigs$Check, + get( + params: Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - check( - params: Params$Resource$Projects$Locations$Groundingconfigs$Check, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Get, + callback: BodyResponseCallback ): void; - check( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - check( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Groundingconfigs$Check - | BodyResponseCallback + | Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Groundingconfigs$Check; + {}) as Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Groundingconfigs$Check; + {} as Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Get; options = {}; } @@ -27213,90 +30352,67 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+groundingConfig}:check').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['groundingConfig'], - pathParams: ['groundingConfig'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } - } - - export interface Params$Resource$Projects$Locations$Groundingconfigs$Check - extends StandardParameters { - /** - * Required. The resource name of the grounding config, such as `projects/x/locations/global/groundingConfigs/default_grounding_config`. - */ - groundingConfig?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1betaCheckGroundingRequest; - } - - export class Resource$Projects$Locations$Operations { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * 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. + * Bulk import of multiple SampleQuerys. Sample queries that already exist may be deleted. Note: It is possible for a subset of the SampleQuerys to be successfully imported. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Operations$Get, + import( + params: Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Import, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Operations$Get, + import( + params?: Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Import, options?: MethodOptions ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Operations$Get, + import( + params: Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Import, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Operations$Get, + import( + params: Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Import, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Operations$Get, + import( + params: Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Import, callback: BodyResponseCallback ): void; - get( + import( callback: BodyResponseCallback ): void; - get( + import( paramsOrCallback?: - | Params$Resource$Projects$Locations$Operations$Get + | Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Import | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -27312,12 +30428,13 @@ export namespace discoveryengine_v1beta { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Operations$Get; + {}) as Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Import; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Operations$Get; + params = + {} as Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Import; options = {}; } @@ -27331,15 +30448,18 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1beta/{+parent}/sampleQueries:import').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { @@ -27353,7 +30473,7 @@ export namespace discoveryengine_v1beta { } /** - * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + * Gets a list of SampleQuerys. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -27361,56 +30481,57 @@ export namespace discoveryengine_v1beta { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Operations$List, + params: Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$List, options: StreamMethodOptions ): GaxiosPromise; list( - params?: Params$Resource$Projects$Locations$Operations$List, + params?: Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$List, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; list( - params: Params$Resource$Projects$Locations$Operations$List, + params: Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Operations$List, + params: Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Operations$List, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$List, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Operations$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Operations$List; + {}) as Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Operations$List; + params = + {} as Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$List; options = {}; } @@ -27424,7 +30545,7 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+name}/operations').replace( + url: (rootUrl + '/v1beta/{+parent}/sampleQueries').replace( /([^:]\/)\/+/g, '$1' ), @@ -27434,115 +30555,82 @@ export namespace discoveryengine_v1beta { options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } - } - - export interface Params$Resource$Projects$Locations$Operations$Get - extends StandardParameters { - /** - * The name of the operation resource. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Operations$List - extends StandardParameters { - /** - * The standard list filter. - */ - filter?: string; - /** - * The name of the operation's parent resource. - */ - name?: string; - /** - * The standard list page size. - */ - pageSize?: number; - /** - * The standard list page token. - */ - pageToken?: string; - } - - export class Resource$Projects$Locations$Rankingconfigs { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Ranks a list of text records based on the given input query. + * Updates a SampleQuery. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - rank( - params: Params$Resource$Projects$Locations$Rankingconfigs$Rank, + patch( + params: Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Patch, options: StreamMethodOptions ): GaxiosPromise; - rank( - params?: Params$Resource$Projects$Locations$Rankingconfigs$Rank, + patch( + params?: Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Patch, options?: MethodOptions - ): GaxiosPromise; - rank( - params: Params$Resource$Projects$Locations$Rankingconfigs$Rank, + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - rank( - params: Params$Resource$Projects$Locations$Rankingconfigs$Rank, + patch( + params: Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Patch, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - rank( - params: Params$Resource$Projects$Locations$Rankingconfigs$Rank, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Patch, + callback: BodyResponseCallback ): void; - rank( - callback: BodyResponseCallback + patch( + callback: BodyResponseCallback ): void; - rank( + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Rankingconfigs$Rank - | BodyResponseCallback + | Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Rankingconfigs$Rank; + {}) as Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Rankingconfigs$Rank; + params = + {} as Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Patch; options = {}; } @@ -27556,44 +30644,102 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+rankingConfig}:rank').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', apiVersion: '', }, options ), params, - requiredParams: ['rankingConfig'], - pathParams: ['rankingConfig'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } } - export interface Params$Resource$Projects$Locations$Rankingconfigs$Rank + export interface Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Create extends StandardParameters { /** - * Required. The resource name of the rank service config, such as `projects/{project_num\}/locations/{location_id\}/rankingConfigs/default_ranking_config`. + * Required. The parent resource name, such as `projects/{project\}/locations/{location\}/sampleQuerySets/{sampleQuerySet\}`. */ - rankingConfig?: string; + parent?: string; + /** + * Required. The ID to use for the SampleQuery, which will become the final component of the SampleQuery.name. If the caller does not have permission to create the SampleQuery, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. This field must be unique among all SampleQuerys with the same parent. Otherwise, an `ALREADY_EXISTS` error is returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. + */ + sampleQueryId?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1betaRankRequest; + requestBody?: Schema$GoogleCloudDiscoveryengineV1betaSampleQuery; + } + export interface Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Delete + extends StandardParameters { + /** + * Required. Full resource name of SampleQuery, such as `projects/{project\}/locations/{location\}/sampleQuerySets/{sampleQuerySet\}/sampleQueries/{sampleQuery\}`. If the caller does not have permission to delete the SampleQuery, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the SampleQuery to delete does not exist, a `NOT_FOUND` error is returned. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Get + extends StandardParameters { + /** + * Required. Full resource name of SampleQuery, such as `projects/{project\}/locations/{location\}/sampleQuerySets/{sampleQuerySet\}/sampleQueries/{sampleQuery\}`. If the caller does not have permission to access the SampleQuery, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested SampleQuery does not exist, a NOT_FOUND error is returned. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Import + extends StandardParameters { + /** + * Required. The parent sample query set resource name, such as `projects/{project\}/locations/{location\}/sampleQuerySets/{sampleQuerySet\}`. If the caller does not have permission to list SampleQuerys under this sample query set, regardless of whether or not this sample query set exists, a `PERMISSION_DENIED` error is returned. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1betaImportSampleQueriesRequest; + } + export interface Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$List + extends StandardParameters { + /** + * Maximum number of SampleQuerys to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned. + */ + pageSize?: number; + /** + * A page token ListSampleQueriesResponse.next_page_token, received from a previous SampleQueryService.ListSampleQueries call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SampleQueryService.ListSampleQueries must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned. + */ + pageToken?: string; + /** + * Required. The parent sample query set resource name, such as `projects/{project\}/locations/{location\}/sampleQuerySets/{sampleQuerySet\}`. If the caller does not have permission to list SampleQuerys under this sample query set, regardless of whether or not this sample query set exists, a `PERMISSION_DENIED` error is returned. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Patch + extends StandardParameters { + /** + * Immutable. The full resource name of the sample query, in the format of `projects/{project\}/locations/{location\}/sampleQuerySets/{sampleQuerySet\}/sampleQueries/{sampleQuery\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. + */ + name?: string; + /** + * Indicates which fields in the provided imported 'simple query' to update. If not set, will by default update all fields. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1betaSampleQuery; } export class Resource$Projects$Locations$Userevents { diff --git a/src/apis/dlp/v2.ts b/src/apis/dlp/v2.ts index 0d17e084c9..76fdf0834d 100644 --- a/src/apis/dlp/v2.ts +++ b/src/apis/dlp/v2.ts @@ -188,6 +188,10 @@ export namespace dlp_v2 { * Match database resources not covered by any other filter. */ export interface Schema$GooglePrivacyDlpV2AllOtherDatabaseResources {} + /** + * Match discovery resources not covered by any other filter. + */ + export interface Schema$GooglePrivacyDlpV2AllOtherResources {} /** * Apply to all text. */ @@ -582,6 +586,27 @@ export namespace dlp_v2 { */ usernamePassword?: Schema$GooglePrivacyDlpV2SecretManagerCredential; } + /** + * Target used to match against for discovery with Cloud Storage buckets. + */ + export interface Schema$GooglePrivacyDlpV2CloudStorageDiscoveryTarget { + /** + * Optional. In addition to matching the filter, these conditions must be true before a profile is generated. + */ + conditions?: Schema$GooglePrivacyDlpV2DiscoveryFileStoreConditions; + /** + * Optional. Disable profiling for buckets that match this filter. + */ + disabled?: Schema$GooglePrivacyDlpV2Disabled; + /** + * Required. The buckets the generation_cadence applies to. The first target with a matching filter will be the one to apply to a bucket. + */ + filter?: Schema$GooglePrivacyDlpV2DiscoveryCloudStorageFilter; + /** + * 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. + */ + generationCadence?: Schema$GooglePrivacyDlpV2DiscoveryCloudStorageGenerationCadence; + } /** * Message representing a set of files in Cloud Storage. */ @@ -629,6 +654,19 @@ export namespace dlp_v2 { */ path?: string | null; } + /** + * 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. + */ + export interface Schema$GooglePrivacyDlpV2CloudStorageRegex { + /** + * 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 + */ + bucketNameRegex?: string | null; + /** + * Optional. For organizations, if unset, will match all projects. + */ + projectIdRegex?: string | null; + } /** * 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 `/` */ @@ -646,6 +684,19 @@ export namespace dlp_v2 { */ includeRegex?: string[] | null; } + /** + * Identifies a single Cloud Storage bucket. + */ + export interface Schema$GooglePrivacyDlpV2CloudStorageResourceReference { + /** + * Required. The bucket to scan. + */ + bucketName?: string | null; + /** + * Required. If within a project-level config, then this must match the config's project id. + */ + projectId?: string | null; + } /** * Represents a color in the RGB color space. */ @@ -1243,7 +1294,7 @@ export namespace dlp_v2 { */ export interface Schema$GooglePrivacyDlpV2DataProfileLocation { /** - * The ID of the Folder within an organization to scan. + * The ID of the folder within an organization to scan. */ folderId?: string | null; /** @@ -1364,11 +1415,11 @@ export namespace dlp_v2 { */ export interface Schema$GooglePrivacyDlpV2Deidentify { /** - * 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 + * 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 */ cloudStorageOutput?: string | null; /** - * List of user-specified file type groups to transform. If specified, only the files with these filetypes 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 filetypes supported are: IMAGES, TEXT_FILES, CSV, TSV. + * 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. */ fileTypesToTransform?: string[] | null; /** @@ -1673,6 +1724,49 @@ export namespace dlp_v2 { */ schemaModifiedCadence?: Schema$GooglePrivacyDlpV2SchemaModifiedCadence; } + /** + * 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. + */ + export interface Schema$GooglePrivacyDlpV2DiscoveryCloudStorageConditions { + /** + * Required. Only objects with the specified attributes will be scanned. Defaults to [ALL_SUPPORTED_BUCKETS] if unset. + */ + includedBucketAttributes?: string[] | null; + /** + * 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. + */ + includedObjectAttributes?: string[] | null; + } + /** + * 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. + */ + export interface Schema$GooglePrivacyDlpV2DiscoveryCloudStorageFilter { + /** + * 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. + */ + cloudStorageResourceReference?: Schema$GooglePrivacyDlpV2CloudStorageResourceReference; + /** + * Optional. A specific set of buckets for this filter to apply to. + */ + collection?: Schema$GooglePrivacyDlpV2FileStoreCollection; + /** + * 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. + */ + others?: Schema$GooglePrivacyDlpV2AllOtherResources; + } + /** + * How often existing buckets should have their profiles refreshed. New buckets are scanned as quickly as possible depending on system capacity. + */ + export interface Schema$GooglePrivacyDlpV2DiscoveryCloudStorageGenerationCadence { + /** + * 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. + */ + inspectTemplateModifiedCadence?: Schema$GooglePrivacyDlpV2DiscoveryInspectTemplateModifiedCadence; + /** + * 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. + */ + refreshFrequency?: string | null; + } /** * 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). */ @@ -1722,10 +1816,31 @@ export namespace dlp_v2 { */ updateTime?: string | null; } + /** + * 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. + */ + export interface Schema$GooglePrivacyDlpV2DiscoveryFileStoreConditions { + /** + * Optional. Cloud Storage conditions. + */ + cloudStorageConditions?: Schema$GooglePrivacyDlpV2DiscoveryCloudStorageConditions; + /** + * Optional. File store must have been created after this date. Used to avoid backfilling. + */ + createdAfter?: string | null; + /** + * Optional. Minimum age a file store must have. If set, the value must be 1 hour or greater. + */ + minAge?: string | null; + } /** * 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. */ export interface Schema$GooglePrivacyDlpV2DiscoveryGenerationCadence { + /** + * 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. + */ + inspectTemplateModifiedCadence?: Schema$GooglePrivacyDlpV2DiscoveryInspectTemplateModifiedCadence; /** * Governs when to update data profiles when a schema is modified. */ @@ -1735,6 +1850,15 @@ export namespace dlp_v2 { */ tableModifiedCadence?: Schema$GooglePrivacyDlpV2DiscoveryTableModifiedCadence; } + /** + * The cadence at which to update data profiles when the inspection rules defined by the `InspectTemplate` change. + */ + export interface Schema$GooglePrivacyDlpV2DiscoveryInspectTemplateModifiedCadence { + /** + * How frequently data profiles can be updated when the template is modified. Defaults to never. + */ + frequency?: string | null; + } /** * The cadence at which to update data profiles when a schema is modified. */ @@ -1753,7 +1877,7 @@ export namespace dlp_v2 { */ export interface Schema$GooglePrivacyDlpV2DiscoveryStartingLocation { /** - * The ID of the Folder within an organization to scan. + * The ID of the folder within an organization to scan. */ folderId?: string | null; /** @@ -1786,6 +1910,10 @@ export namespace dlp_v2 { * Cloud SQL target for Discovery. The first target to match a table will be the one applied. */ cloudSqlTarget?: Schema$GooglePrivacyDlpV2CloudSqlDiscoveryTarget; + /** + * Cloud Storage target for Discovery. The first target to match a table will be the one applied. + */ + cloudStorageTarget?: Schema$GooglePrivacyDlpV2CloudStorageDiscoveryTarget; /** * 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. */ @@ -1987,7 +2115,7 @@ export namespace dlp_v2 { */ dataRiskLevel?: Schema$GooglePrivacyDlpV2DataRiskLevel; /** - * A list of Errors detected while scanning this cluster. The list is truncated to 10 per cluster. + * A list of errors detected while scanning this cluster. The list is truncated to 10 per cluster. */ errors?: Schema$GooglePrivacyDlpV2Error[]; /** @@ -2047,7 +2175,16 @@ export namespace dlp_v2 { url?: string | null; } /** - * The profile for a file store. * Google Cloud Storage: maps 1:1 with a bucket. + * Match file stores (e.g. buckets) using regex filters. + */ + export interface Schema$GooglePrivacyDlpV2FileStoreCollection { + /** + * Optional. A collection of regular expressions to match a file store against. + */ + includeRegexes?: Schema$GooglePrivacyDlpV2FileStoreRegexes; + } + /** + * The profile for a file store. * Cloud Storage: maps 1:1 with a bucket. */ export interface Schema$GooglePrivacyDlpV2FileStoreDataProfile { /** @@ -2067,7 +2204,7 @@ export namespace dlp_v2 { */ dataSourceType?: Schema$GooglePrivacyDlpV2DataSourceType; /** - * For resources that have multiple storage locations, these are those regions. For Google 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. + * 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. */ dataStorageLocations?: string[] | null; /** @@ -2083,11 +2220,11 @@ export namespace dlp_v2 { */ fileStoreIsEmpty?: boolean | null; /** - * The location of the file store. * Google Cloud Storage: https://cloud.google.com/storage/docs/locations#available-locations + * The location of the file store. * Cloud Storage: https://cloud.google.com/storage/docs/locations#available-locations */ fileStoreLocation?: string | null; /** - * The file store path. * Google Cloud Storage: `gs://{bucket\}` + * The file store path. * Cloud Storage: `gs://{bucket\}` */ fileStorePath?: string | null; /** @@ -2115,7 +2252,7 @@ export namespace dlp_v2 { */ profileStatus?: Schema$GooglePrivacyDlpV2ProfileStatus; /** - * The resource name to the project data profile for this file store. + * The resource name of the project data profile for this file store. */ projectDataProfile?: string | null; /** @@ -2123,7 +2260,7 @@ export namespace dlp_v2 { */ projectId?: string | null; /** - * 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. + * 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. */ resourceAttributes?: {[key: string]: Schema$GooglePrivacyDlpV2Value} | null; /** @@ -2152,6 +2289,24 @@ export namespace dlp_v2 { */ infoType?: Schema$GooglePrivacyDlpV2InfoType; } + /** + * A pattern to match against one or more file stores. + */ + export interface Schema$GooglePrivacyDlpV2FileStoreRegex { + /** + * Optional. Regex for Cloud Storage. + */ + cloudStorageRegex?: Schema$GooglePrivacyDlpV2CloudStorageRegex; + } + /** + * A collection of regular expressions to determine what file store to match against. + */ + export interface Schema$GooglePrivacyDlpV2FileStoreRegexes { + /** + * 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. + */ + patterns?: Schema$GooglePrivacyDlpV2FileStoreRegex[]; + } /** * Represents a piece of potentially sensitive content. */ @@ -4256,7 +4411,7 @@ export namespace dlp_v2 { */ profileStatus?: Schema$GooglePrivacyDlpV2ProfileStatus; /** - * The resource name to the project data profile for this table. + * The resource name of the project data profile for this table. */ projectDataProfile?: string | null; /** @@ -5576,7 +5731,7 @@ export namespace dlp_v2 { */ locationId?: string; /** - * Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to the time the template was created. - `update_time`: corresponds to the time the template was last updated. - `name`: corresponds to the template's name. - `display_name`: corresponds to the template's display name. + * Comma-separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to the time the template was created. - `update_time`: corresponds to the time the template was last updated. - `name`: corresponds to the template's name. - `display_name`: corresponds to the template's display name. */ orderBy?: string; /** @@ -6115,7 +6270,7 @@ export namespace dlp_v2 { */ locationId?: string; /** - * Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to the time the template was created. - `update_time`: corresponds to the time the template was last updated. - `name`: corresponds to the template's name. - `display_name`: corresponds to the template's display name. + * Comma-separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to the time the template was created. - `update_time`: corresponds to the time the template was last updated. - `name`: corresponds to the template's name. - `display_name`: corresponds to the template's display name. */ orderBy?: string; /** @@ -6401,7 +6556,7 @@ export namespace dlp_v2 { */ filter?: string; /** - * Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Only one order field at a time is allowed. Examples: * `project_id asc` * `table_id` * `sensitivity_level desc` Supported fields are: - `project_id`: The Google Cloud project ID. - `dataset_id`: The ID of a BigQuery dataset. - `table_id`: The ID of a BigQuery table. - `sensitivity_level`: How sensitive the data in a column is, at most. - `data_risk_level`: How much risk is associated with this data. - `profile_last_generated`: When the profile was last updated in epoch seconds. + * Comma-separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Only one order field at a time is allowed. Examples: * `project_id asc` * `table_id` * `sensitivity_level desc` Supported fields are: - `project_id`: The Google Cloud project ID. - `dataset_id`: The ID of a BigQuery dataset. - `table_id`: The ID of a BigQuery table. - `sensitivity_level`: How sensitive the data in a column is, at most. - `data_risk_level`: How much risk is associated with this data. - `profile_last_generated`: When the profile was last updated in epoch seconds. */ orderBy?: string; /** @@ -7472,7 +7627,7 @@ export namespace dlp_v2 { */ locationId?: string; /** - * Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to the time the template was created. - `update_time`: corresponds to the time the template was last updated. - `name`: corresponds to the template's name. - `display_name`: corresponds to the template's display name. + * Comma-separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to the time the template was created. - `update_time`: corresponds to the time the template was last updated. - `name`: corresponds to the template's name. - `display_name`: corresponds to the template's display name. */ orderBy?: string; /** @@ -8012,7 +8167,7 @@ export namespace dlp_v2 { export interface Params$Resource$Organizations$Locations$Discoveryconfigs$List extends StandardParameters { /** - * Comma separated list of config fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `last_run_time`: corresponds to the last time the DiscoveryConfig ran. - `name`: corresponds to the DiscoveryConfig's name. - `status`: corresponds to DiscoveryConfig's status. + * Comma-separated list of config fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `last_run_time`: corresponds to the last time the DiscoveryConfig ran. - `name`: corresponds to the DiscoveryConfig's name. - `status`: corresponds to DiscoveryConfig's status. */ orderBy?: string; /** @@ -8156,7 +8311,7 @@ export namespace dlp_v2 { */ locationId?: string; /** - * Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc, end_time asc, create_time desc` Supported fields are: - `create_time`: corresponds to the time the job was created. - `end_time`: corresponds to the time the job ended. - `name`: corresponds to the job's name. - `state`: corresponds to `state` + * Comma-separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc, end_time asc, create_time desc` Supported fields are: - `create_time`: corresponds to the time the job was created. - `end_time`: corresponds to the time the job ended. - `name`: corresponds to the job's name. - `state`: corresponds to `state` */ orderBy?: string; /** @@ -8483,11 +8638,11 @@ export namespace dlp_v2 { export interface Params$Resource$Organizations$Locations$Filestoredataprofiles$List extends StandardParameters { /** - * Optional. Allows filtering. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field\} {operator\} {value\}`. * Supported fields/values: - `project_id` - The Google Cloud project ID. - `file_store_path` - The path like "gs://bucket". - `sensitivity_level` - HIGH|MODERATE|LOW - `data_risk_level` - HIGH|MODERATE|LOW - `resource_visibility`: PUBLIC|RESTRICTED - `status_code` - an RPC status code as defined in https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto * The operator must be `=` or `!=`. Examples: * `project_id = 12345 AND status_code = 1` * `project_id = 12345 AND sensitivity_level = HIGH` * `project_id = 12345 AND resource_visibility = PUBLIC` . * 'file_store_path = "gs://mybucket"` The length of this field should be no more than 500 characters. + * Optional. Allows filtering. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field\} {operator\} {value\}`. * Supported fields/values: - `project_id` - The Google Cloud project ID. - `file_store_path` - The path like "gs://bucket". - `sensitivity_level` - HIGH|MODERATE|LOW - `data_risk_level` - HIGH|MODERATE|LOW - `resource_visibility`: PUBLIC|RESTRICTED - `status_code` - an RPC status code as defined in https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto * The operator must be `=` or `!=`. Examples: * `project_id = 12345 AND status_code = 1` * `project_id = 12345 AND sensitivity_level = HIGH` * `project_id = 12345 AND resource_visibility = PUBLIC` * `file_store_path = "gs://mybucket"` The length of this field should be no more than 500 characters. */ filter?: string; /** - * Optional. Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Only one order field at a time is allowed. Examples: * `project_id asc` * `name` * `sensitivity_level desc` Supported fields are: - `project_id`: The Google Cloud project ID. - `sensitivity_level`: How sensitive the data in a table is, at most. - `data_risk_level`: How much risk is associated with this data. - `profile_last_generated`: When the profile was last updated in epoch seconds. - `last_modified`: The last time the resource was modified. - `resource_visibility`: Visibility restriction for this resource. - `name`: The name of the profile. - `create_time`: The time the file store was first created. + * Optional. Comma-separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Only one order field at a time is allowed. Examples: * `project_id asc` * `name` * `sensitivity_level desc` Supported fields are: - `project_id`: The Google Cloud project ID. - `sensitivity_level`: How sensitive the data in a table is, at most. - `data_risk_level`: How much risk is associated with this data. - `profile_last_generated`: When the profile was last updated in epoch seconds. - `last_modified`: The last time the resource was modified. - `resource_visibility`: Visibility restriction for this resource. - `name`: The name of the profile. - `create_time`: The time the file store was first created. */ orderBy?: string; /** @@ -9019,7 +9174,7 @@ export namespace dlp_v2 { */ locationId?: string; /** - * Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to the time the template was created. - `update_time`: corresponds to the time the template was last updated. - `name`: corresponds to the template's name. - `display_name`: corresponds to the template's display name. + * Comma-separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to the time the template was created. - `update_time`: corresponds to the time the template was last updated. - `name`: corresponds to the template's name. - `display_name`: corresponds to the template's display name. */ orderBy?: string; /** @@ -9565,7 +9720,7 @@ export namespace dlp_v2 { */ locationId?: string; /** - * Comma separated list of triggeredJob fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to the time the JobTrigger was created. - `update_time`: corresponds to the time the JobTrigger was last updated. - `last_run_time`: corresponds to the last time the JobTrigger ran. - `name`: corresponds to the JobTrigger's name. - `display_name`: corresponds to the JobTrigger's display name. - `status`: corresponds to JobTrigger's status. + * Comma-separated list of triggeredJob fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to the time the JobTrigger was created. - `update_time`: corresponds to the time the JobTrigger was last updated. - `last_run_time`: corresponds to the last time the JobTrigger ran. - `name`: corresponds to the JobTrigger's name. - `display_name`: corresponds to the JobTrigger's display name. - `status`: corresponds to JobTrigger's status. */ orderBy?: string; /** @@ -9812,7 +9967,7 @@ export namespace dlp_v2 { */ filter?: string; /** - * Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Only one order field at a time is allowed. Examples: * `project_id` * `sensitivity_level desc` Supported fields are: - `project_id`: Google Cloud project ID - `sensitivity_level`: How sensitive the data in a project is, at most. - `data_risk_level`: How much risk is associated with this data. - `profile_last_generated`: When the profile was last updated in epoch seconds. + * Comma-separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Only one order field at a time is allowed. Examples: * `project_id` * `sensitivity_level desc` Supported fields are: - `project_id`: Google Cloud project ID - `sensitivity_level`: How sensitive the data in a project is, at most. - `data_risk_level`: How much risk is associated with this data. - `profile_last_generated`: When the profile was last updated in epoch seconds. */ orderBy?: string; /** @@ -10344,7 +10499,7 @@ export namespace dlp_v2 { */ locationId?: string; /** - * Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc, display_name, create_time desc` Supported fields are: - `create_time`: corresponds to the time the most recent version of the resource was created. - `state`: corresponds to the state of the resource. - `name`: corresponds to resource name. - `display_name`: corresponds to info type's display name. + * Comma-separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc, display_name, create_time desc` Supported fields are: - `create_time`: corresponds to the time the most recent version of the resource was created. - `state`: corresponds to the state of the resource. - `name`: corresponds to resource name. - `display_name`: corresponds to info type's display name. */ orderBy?: string; /** @@ -10683,7 +10838,7 @@ export namespace dlp_v2 { */ filter?: string; /** - * Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Only one order field at a time is allowed. Examples: * `project_id asc` * `table_id` * `sensitivity_level desc` Supported fields are: - `project_id`: The Google Cloud project ID. - `dataset_id`: The ID of a BigQuery dataset. - `table_id`: The ID of a BigQuery table. - `sensitivity_level`: How sensitive the data in a table is, at most. - `data_risk_level`: How much risk is associated with this data. - `profile_last_generated`: When the profile was last updated in epoch seconds. - `last_modified`: The last time the resource was modified. - `resource_visibility`: Visibility restriction for this resource. - `row_count`: Number of rows in this resource. + * Comma-separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Only one order field at a time is allowed. Examples: * `project_id asc` * `table_id` * `sensitivity_level desc` Supported fields are: - `project_id`: The Google Cloud project ID. - `dataset_id`: The ID of a BigQuery dataset. - `table_id`: The ID of a BigQuery table. - `sensitivity_level`: How sensitive the data in a table is, at most. - `data_risk_level`: How much risk is associated with this data. - `profile_last_generated`: When the profile was last updated in epoch seconds. - `last_modified`: The last time the resource was modified. - `resource_visibility`: Visibility restriction for this resource. - `row_count`: Number of rows in this resource. */ orderBy?: string; /** @@ -11210,7 +11365,7 @@ export namespace dlp_v2 { */ locationId?: string; /** - * Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc, display_name, create_time desc` Supported fields are: - `create_time`: corresponds to the time the most recent version of the resource was created. - `state`: corresponds to the state of the resource. - `name`: corresponds to resource name. - `display_name`: corresponds to info type's display name. + * Comma-separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc, display_name, create_time desc` Supported fields are: - `create_time`: corresponds to the time the most recent version of the resource was created. - `state`: corresponds to the state of the resource. - `name`: corresponds to resource name. - `display_name`: corresponds to info type's display name. */ orderBy?: string; /** @@ -12113,7 +12268,7 @@ export namespace dlp_v2 { */ locationId?: string; /** - * Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to the time the template was created. - `update_time`: corresponds to the time the template was last updated. - `name`: corresponds to the template's name. - `display_name`: corresponds to the template's display name. + * Comma-separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to the time the template was created. - `update_time`: corresponds to the time the template was last updated. - `name`: corresponds to the template's name. - `display_name`: corresponds to the template's display name. */ orderBy?: string; /** @@ -12656,7 +12811,7 @@ export namespace dlp_v2 { */ locationId?: string; /** - * Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc, end_time asc, create_time desc` Supported fields are: - `create_time`: corresponds to the time the job was created. - `end_time`: corresponds to the time the job ended. - `name`: corresponds to the job's name. - `state`: corresponds to `state` + * Comma-separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc, end_time asc, create_time desc` Supported fields are: - `create_time`: corresponds to the time the job was created. - `end_time`: corresponds to the time the job ended. - `name`: corresponds to the job's name. - `state`: corresponds to `state` */ orderBy?: string; /** @@ -13304,7 +13459,7 @@ export namespace dlp_v2 { */ locationId?: string; /** - * Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to the time the template was created. - `update_time`: corresponds to the time the template was last updated. - `name`: corresponds to the template's name. - `display_name`: corresponds to the template's display name. + * Comma-separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to the time the template was created. - `update_time`: corresponds to the time the template was last updated. - `name`: corresponds to the template's name. - `display_name`: corresponds to the template's display name. */ orderBy?: string; /** @@ -13954,7 +14109,7 @@ export namespace dlp_v2 { */ locationId?: string; /** - * Comma separated list of triggeredJob fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to the time the JobTrigger was created. - `update_time`: corresponds to the time the JobTrigger was last updated. - `last_run_time`: corresponds to the last time the JobTrigger ran. - `name`: corresponds to the JobTrigger's name. - `display_name`: corresponds to the JobTrigger's display name. - `status`: corresponds to JobTrigger's status. + * Comma-separated list of triggeredJob fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to the time the JobTrigger was created. - `update_time`: corresponds to the time the JobTrigger was last updated. - `last_run_time`: corresponds to the last time the JobTrigger ran. - `name`: corresponds to the JobTrigger's name. - `display_name`: corresponds to the JobTrigger's display name. - `status`: corresponds to JobTrigger's status. */ orderBy?: string; /** @@ -14249,7 +14404,7 @@ export namespace dlp_v2 { */ filter?: string; /** - * Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Only one order field at a time is allowed. Examples: * `project_id asc` * `table_id` * `sensitivity_level desc` Supported fields are: - `project_id`: The Google Cloud project ID. - `dataset_id`: The ID of a BigQuery dataset. - `table_id`: The ID of a BigQuery table. - `sensitivity_level`: How sensitive the data in a column is, at most. - `data_risk_level`: How much risk is associated with this data. - `profile_last_generated`: When the profile was last updated in epoch seconds. + * Comma-separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Only one order field at a time is allowed. Examples: * `project_id asc` * `table_id` * `sensitivity_level desc` Supported fields are: - `project_id`: The Google Cloud project ID. - `dataset_id`: The ID of a BigQuery dataset. - `table_id`: The ID of a BigQuery table. - `sensitivity_level`: How sensitive the data in a column is, at most. - `data_risk_level`: How much risk is associated with this data. - `profile_last_generated`: When the profile was last updated in epoch seconds. */ orderBy?: string; /** @@ -15767,7 +15922,7 @@ export namespace dlp_v2 { */ locationId?: string; /** - * Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to the time the template was created. - `update_time`: corresponds to the time the template was last updated. - `name`: corresponds to the template's name. - `display_name`: corresponds to the template's display name. + * Comma-separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to the time the template was created. - `update_time`: corresponds to the time the template was last updated. - `name`: corresponds to the template's name. - `display_name`: corresponds to the template's display name. */ orderBy?: string; /** @@ -16305,7 +16460,7 @@ export namespace dlp_v2 { export interface Params$Resource$Projects$Locations$Discoveryconfigs$List extends StandardParameters { /** - * Comma separated list of config fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `last_run_time`: corresponds to the last time the DiscoveryConfig ran. - `name`: corresponds to the DiscoveryConfig's name. - `status`: corresponds to DiscoveryConfig's status. + * Comma-separated list of config fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `last_run_time`: corresponds to the last time the DiscoveryConfig ran. - `name`: corresponds to the DiscoveryConfig's name. - `status`: corresponds to DiscoveryConfig's status. */ orderBy?: string; /** @@ -17057,7 +17212,7 @@ export namespace dlp_v2 { */ locationId?: string; /** - * Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc, end_time asc, create_time desc` Supported fields are: - `create_time`: corresponds to the time the job was created. - `end_time`: corresponds to the time the job ended. - `name`: corresponds to the job's name. - `state`: corresponds to `state` + * Comma-separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc, end_time asc, create_time desc` Supported fields are: - `create_time`: corresponds to the time the job was created. - `end_time`: corresponds to the time the job ended. - `name`: corresponds to the job's name. - `state`: corresponds to `state` */ orderBy?: string; /** @@ -17384,11 +17539,11 @@ export namespace dlp_v2 { export interface Params$Resource$Projects$Locations$Filestoredataprofiles$List extends StandardParameters { /** - * Optional. Allows filtering. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field\} {operator\} {value\}`. * Supported fields/values: - `project_id` - The Google Cloud project ID. - `file_store_path` - The path like "gs://bucket". - `sensitivity_level` - HIGH|MODERATE|LOW - `data_risk_level` - HIGH|MODERATE|LOW - `resource_visibility`: PUBLIC|RESTRICTED - `status_code` - an RPC status code as defined in https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto * The operator must be `=` or `!=`. Examples: * `project_id = 12345 AND status_code = 1` * `project_id = 12345 AND sensitivity_level = HIGH` * `project_id = 12345 AND resource_visibility = PUBLIC` . * 'file_store_path = "gs://mybucket"` The length of this field should be no more than 500 characters. + * Optional. Allows filtering. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field\} {operator\} {value\}`. * Supported fields/values: - `project_id` - The Google Cloud project ID. - `file_store_path` - The path like "gs://bucket". - `sensitivity_level` - HIGH|MODERATE|LOW - `data_risk_level` - HIGH|MODERATE|LOW - `resource_visibility`: PUBLIC|RESTRICTED - `status_code` - an RPC status code as defined in https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto * The operator must be `=` or `!=`. Examples: * `project_id = 12345 AND status_code = 1` * `project_id = 12345 AND sensitivity_level = HIGH` * `project_id = 12345 AND resource_visibility = PUBLIC` * `file_store_path = "gs://mybucket"` The length of this field should be no more than 500 characters. */ filter?: string; /** - * Optional. Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Only one order field at a time is allowed. Examples: * `project_id asc` * `name` * `sensitivity_level desc` Supported fields are: - `project_id`: The Google Cloud project ID. - `sensitivity_level`: How sensitive the data in a table is, at most. - `data_risk_level`: How much risk is associated with this data. - `profile_last_generated`: When the profile was last updated in epoch seconds. - `last_modified`: The last time the resource was modified. - `resource_visibility`: Visibility restriction for this resource. - `name`: The name of the profile. - `create_time`: The time the file store was first created. + * Optional. Comma-separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Only one order field at a time is allowed. Examples: * `project_id asc` * `name` * `sensitivity_level desc` Supported fields are: - `project_id`: The Google Cloud project ID. - `sensitivity_level`: How sensitive the data in a table is, at most. - `data_risk_level`: How much risk is associated with this data. - `profile_last_generated`: When the profile was last updated in epoch seconds. - `last_modified`: The last time the resource was modified. - `resource_visibility`: Visibility restriction for this resource. - `name`: The name of the profile. - `create_time`: The time the file store was first created. */ orderBy?: string; /** @@ -18035,7 +18190,7 @@ export namespace dlp_v2 { */ locationId?: string; /** - * Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to the time the template was created. - `update_time`: corresponds to the time the template was last updated. - `name`: corresponds to the template's name. - `display_name`: corresponds to the template's display name. + * Comma-separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to the time the template was created. - `update_time`: corresponds to the time the template was last updated. - `name`: corresponds to the template's name. - `display_name`: corresponds to the template's display name. */ orderBy?: string; /** @@ -18795,7 +18950,7 @@ export namespace dlp_v2 { */ locationId?: string; /** - * Comma separated list of triggeredJob fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to the time the JobTrigger was created. - `update_time`: corresponds to the time the JobTrigger was last updated. - `last_run_time`: corresponds to the last time the JobTrigger ran. - `name`: corresponds to the JobTrigger's name. - `display_name`: corresponds to the JobTrigger's display name. - `status`: corresponds to JobTrigger's status. + * Comma-separated list of triggeredJob fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to the time the JobTrigger was created. - `update_time`: corresponds to the time the JobTrigger was last updated. - `last_run_time`: corresponds to the last time the JobTrigger ran. - `name`: corresponds to the JobTrigger's name. - `display_name`: corresponds to the JobTrigger's display name. - `status`: corresponds to JobTrigger's status. */ orderBy?: string; /** @@ -19042,7 +19197,7 @@ export namespace dlp_v2 { */ filter?: string; /** - * Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Only one order field at a time is allowed. Examples: * `project_id` * `sensitivity_level desc` Supported fields are: - `project_id`: Google Cloud project ID - `sensitivity_level`: How sensitive the data in a project is, at most. - `data_risk_level`: How much risk is associated with this data. - `profile_last_generated`: When the profile was last updated in epoch seconds. + * Comma-separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Only one order field at a time is allowed. Examples: * `project_id` * `sensitivity_level desc` Supported fields are: - `project_id`: Google Cloud project ID - `sensitivity_level`: How sensitive the data in a project is, at most. - `data_risk_level`: How much risk is associated with this data. - `profile_last_generated`: When the profile was last updated in epoch seconds. */ orderBy?: string; /** @@ -19571,7 +19726,7 @@ export namespace dlp_v2 { */ locationId?: string; /** - * Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc, display_name, create_time desc` Supported fields are: - `create_time`: corresponds to the time the most recent version of the resource was created. - `state`: corresponds to the state of the resource. - `name`: corresponds to resource name. - `display_name`: corresponds to info type's display name. + * Comma-separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc, display_name, create_time desc` Supported fields are: - `create_time`: corresponds to the time the most recent version of the resource was created. - `state`: corresponds to the state of the resource. - `name`: corresponds to resource name. - `display_name`: corresponds to info type's display name. */ orderBy?: string; /** @@ -19909,7 +20064,7 @@ export namespace dlp_v2 { */ filter?: string; /** - * Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Only one order field at a time is allowed. Examples: * `project_id asc` * `table_id` * `sensitivity_level desc` Supported fields are: - `project_id`: The Google Cloud project ID. - `dataset_id`: The ID of a BigQuery dataset. - `table_id`: The ID of a BigQuery table. - `sensitivity_level`: How sensitive the data in a table is, at most. - `data_risk_level`: How much risk is associated with this data. - `profile_last_generated`: When the profile was last updated in epoch seconds. - `last_modified`: The last time the resource was modified. - `resource_visibility`: Visibility restriction for this resource. - `row_count`: Number of rows in this resource. + * Comma-separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Only one order field at a time is allowed. Examples: * `project_id asc` * `table_id` * `sensitivity_level desc` Supported fields are: - `project_id`: The Google Cloud project ID. - `dataset_id`: The ID of a BigQuery dataset. - `table_id`: The ID of a BigQuery table. - `sensitivity_level`: How sensitive the data in a table is, at most. - `data_risk_level`: How much risk is associated with this data. - `profile_last_generated`: When the profile was last updated in epoch seconds. - `last_modified`: The last time the resource was modified. - `resource_visibility`: Visibility restriction for this resource. - `row_count`: Number of rows in this resource. */ orderBy?: string; /** @@ -20436,7 +20591,7 @@ export namespace dlp_v2 { */ locationId?: string; /** - * Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc, display_name, create_time desc` Supported fields are: - `create_time`: corresponds to the time the most recent version of the resource was created. - `state`: corresponds to the state of the resource. - `name`: corresponds to resource name. - `display_name`: corresponds to info type's display name. + * Comma-separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc, display_name, create_time desc` Supported fields are: - `create_time`: corresponds to the time the most recent version of the resource was created. - `state`: corresponds to the state of the resource. - `name`: corresponds to resource name. - `display_name`: corresponds to info type's display name. */ orderBy?: string; /** diff --git a/src/apis/documentai/v1.ts b/src/apis/documentai/v1.ts index de14db7290..30b95e0340 100644 --- a/src/apis/documentai/v1.ts +++ b/src/apis/documentai/v1.ts @@ -5722,6 +5722,10 @@ export namespace documentai_v1 { * The schema of the processor version. Describes the output. */ documentSchema?: Schema$GoogleCloudDocumentaiV1DocumentSchema; + /** + * Output only. Information about Generative AI model-based processor versions. + */ + genAiModelInfo?: Schema$GoogleCloudDocumentaiV1ProcessorVersionGenAiModelInfo; /** * Output only. Denotes that this `ProcessorVersion` is managed by Google. */ @@ -5785,6 +5789,45 @@ export namespace documentai_v1 { */ replacementProcessorVersion?: string | null; } + /** + * Information about Generative AI model-based processor versions. + */ + export interface Schema$GoogleCloudDocumentaiV1ProcessorVersionGenAiModelInfo { + /** + * Information for a custom Generative AI model created by the user. + */ + customGenAiModelInfo?: Schema$GoogleCloudDocumentaiV1ProcessorVersionGenAiModelInfoCustomGenAiModelInfo; + /** + * Information for a pretrained Google-managed foundation model. + */ + foundationGenAiModelInfo?: Schema$GoogleCloudDocumentaiV1ProcessorVersionGenAiModelInfoFoundationGenAiModelInfo; + } + /** + * 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. + */ + export interface Schema$GoogleCloudDocumentaiV1ProcessorVersionGenAiModelInfoCustomGenAiModelInfo { + /** + * The base processor version ID for the custom model. + */ + baseProcessorVersionId?: string | null; + /** + * The type of custom model created by the user. + */ + customModelType?: string | null; + } + /** + * Information for a pretrained Google-managed foundation model. + */ + export interface Schema$GoogleCloudDocumentaiV1ProcessorVersionGenAiModelInfoFoundationGenAiModelInfo { + /** + * Whether finetuning is allowed for this base processor version. + */ + finetuningAllowed?: boolean | null; + /** + * The minimum number of labeled documents in the training dataset required for finetuning. + */ + minTrainLabeledDocuments?: number | null; + } /** * Request message for the ProcessDocument method. */ diff --git a/src/apis/documentai/v1beta3.ts b/src/apis/documentai/v1beta3.ts index ed3c208724..0f036e00d4 100644 --- a/src/apis/documentai/v1beta3.ts +++ b/src/apis/documentai/v1beta3.ts @@ -5679,6 +5679,10 @@ export namespace documentai_v1beta3 { * The schema of the processor version. Describes the output. */ documentSchema?: Schema$GoogleCloudDocumentaiV1beta3DocumentSchema; + /** + * Output only. Information about Generative AI model-based processor versions. + */ + genAiModelInfo?: Schema$GoogleCloudDocumentaiV1beta3ProcessorVersionGenAiModelInfo; /** * Output only. Denotes that this `ProcessorVersion` is managed by Google. */ @@ -5742,6 +5746,45 @@ export namespace documentai_v1beta3 { */ replacementProcessorVersion?: string | null; } + /** + * Information about Generative AI model-based processor versions. + */ + export interface Schema$GoogleCloudDocumentaiV1beta3ProcessorVersionGenAiModelInfo { + /** + * Information for a custom Generative AI model created by the user. + */ + customGenAiModelInfo?: Schema$GoogleCloudDocumentaiV1beta3ProcessorVersionGenAiModelInfoCustomGenAiModelInfo; + /** + * Information for a pretrained Google-managed foundation model. + */ + foundationGenAiModelInfo?: Schema$GoogleCloudDocumentaiV1beta3ProcessorVersionGenAiModelInfoFoundationGenAiModelInfo; + } + /** + * 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. + */ + export interface Schema$GoogleCloudDocumentaiV1beta3ProcessorVersionGenAiModelInfoCustomGenAiModelInfo { + /** + * The base processor version ID for the custom model. + */ + baseProcessorVersionId?: string | null; + /** + * The type of custom model created by the user. + */ + customModelType?: string | null; + } + /** + * Information for a pretrained Google-managed foundation model. + */ + export interface Schema$GoogleCloudDocumentaiV1beta3ProcessorVersionGenAiModelInfoFoundationGenAiModelInfo { + /** + * Whether finetuning is allowed for this base processor version. + */ + finetuningAllowed?: boolean | null; + /** + * The minimum number of labeled documents in the training dataset required for finetuning. + */ + minTrainLabeledDocuments?: number | null; + } /** * Request message for the ProcessDocument method. */ diff --git a/src/apis/drive/v2.ts b/src/apis/drive/v2.ts index d73554f2d0..482e56546b 100644 --- a/src/apis/drive/v2.ts +++ b/src/apis/drive/v2.ts @@ -1206,7 +1206,7 @@ export namespace drive_v2 { */ sharingUser?: Schema$User; /** - * Shortcut file details. Only populated for shortcut files, which have the mimeType field set to `application/vnd.google-apps.shortcut`. + * Shortcut file details. Only populated for shortcut files, which have the mimeType field set to `application/vnd.google-apps.shortcut`. Can only be set on `files.insert` requests. */ shortcutDetails?: { targetId?: string; diff --git a/src/apis/drive/v3.ts b/src/apis/drive/v3.ts index 8c1cc0c0e5..62c95e1238 100644 --- a/src/apis/drive/v3.ts +++ b/src/apis/drive/v3.ts @@ -923,7 +923,7 @@ export namespace drive_v3 { */ sharingUser?: Schema$User; /** - * Shortcut file details. Only populated for shortcut files, which have the mimeType field set to `application/vnd.google-apps.shortcut`. + * Shortcut file details. Only populated for shortcut files, which have the mimeType field set to `application/vnd.google-apps.shortcut`. Can only be set on `files.create` requests. */ shortcutDetails?: { targetId?: string; diff --git a/src/apis/essentialcontacts/v1.ts b/src/apis/essentialcontacts/v1.ts index 00f461e258..3d57ab002a 100644 --- a/src/apis/essentialcontacts/v1.ts +++ b/src/apis/essentialcontacts/v1.ts @@ -166,7 +166,7 @@ export namespace essentialcontacts_v1 { */ validateTime?: string | null; /** - * The validity of the contact. A contact is considered valid if it is the correct recipient for notifications for a particular resource. + * Output only. The validity of the contact. A contact is considered valid if it is the correct recipient for notifications for a particular resource. */ validationState?: string | null; } diff --git a/src/apis/file/v1beta1.ts b/src/apis/file/v1beta1.ts index 6269356627..3da224f125 100644 --- a/src/apis/file/v1beta1.ts +++ b/src/apis/file/v1beta1.ts @@ -144,6 +144,10 @@ export namespace file_v1beta1 { * Output only. Amount of bytes that will be downloaded if the backup is restored */ downloadBytes?: string | null; + /** + * Output only. The file system protocol of the source Filestore instance that this backup is created from. + */ + fileSystemProtocol?: string | null; /** * Immutable. KMS key name used for data encryption. */ diff --git a/src/apis/firebaseappcheck/v1.ts b/src/apis/firebaseappcheck/v1.ts index cb4055dd75..4f16954c3f 100644 --- a/src/apis/firebaseappcheck/v1.ts +++ b/src/apis/firebaseappcheck/v1.ts @@ -208,6 +208,28 @@ export namespace firebaseappcheck_v1 { */ configs?: Schema$GoogleFirebaseAppcheckV1SafetyNetConfig[]; } + /** + * Request message for the BatchUpdateResourcePolicies method. + */ + export interface Schema$GoogleFirebaseAppcheckV1BatchUpdateResourcePoliciesRequest { + /** + * Required. The request messages specifying the ResourcePolicy objects to update. A maximum of 100 objects can be updated in a batch. + */ + requests?: Schema$GoogleFirebaseAppcheckV1UpdateResourcePolicyRequest[]; + /** + * Optional. A comma-separated list of names of fields in the ResourcePolicy objects to update. Example: `enforcement_mode`. If this field is present, the `update_mask` field in the UpdateResourcePolicyRequest messages must all match this field, or the entire batch fails and no updates will be committed. + */ + updateMask?: string | null; + } + /** + * Response message for the BatchUpdateResourcePolicies method. + */ + export interface Schema$GoogleFirebaseAppcheckV1BatchUpdateResourcePoliciesResponse { + /** + * ResourcePolicy objects after the updates have been applied. + */ + resourcePolicies?: Schema$GoogleFirebaseAppcheckV1ResourcePolicy[]; + } /** * Request message for the BatchUpdateServices method. */ @@ -465,6 +487,19 @@ export namespace firebaseappcheck_v1 { */ nextPageToken?: string | null; } + /** + * Response message for the ListResourcePolicies method. + */ + export interface Schema$GoogleFirebaseAppcheckV1ListResourcePoliciesResponse { + /** + * If the result list is too large to fit in a single response, then a token is returned. If the string is empty or omitted, then this response is the last page of results. This token can be used in a subsequent call to ListResourcePolicies to find the next group of ResourcePolicy objects. Page tokens are short-lived and should not be persisted. + */ + nextPageToken?: string | null; + /** + * The ResourcePolicy objects retrieved. + */ + resourcePolicies?: Schema$GoogleFirebaseAppcheckV1ResourcePolicy[]; + } /** * Response message for the ListServices method. */ @@ -567,6 +602,31 @@ export namespace firebaseappcheck_v1 { */ tokenTtl?: string | null; } + /** + * App Check enforcement policy for a specific resource of a Firebase service supported by App Check. Note that this policy will override the service-level configuration. + */ + export interface Schema$GoogleFirebaseAppcheckV1ResourcePolicy { + /** + * Required. The App Check enforcement mode for this resource. This will override the EnforcementMode setting on the service. + */ + enforcementMode?: string | null; + /** + * 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. This etag is strongly validated as defined by RFC 7232. + */ + etag?: string | null; + /** + * Required. Identifier. The relative name of the resource policy object, in the format: ``` projects/{project_number\}/services/{service_id\}/resourcePolicies/{resource_policy_id\} ``` Note that the `service_id` element must be a supported service ID. Currently, the following service IDs are supported: * `oauth2.googleapis.com` (Google Identity for iOS) `resource_policy_id` is a system-generated UID. + */ + name?: string | null; + /** + * Required. Service specific name of the resource object to which this policy applies, in the format: * `//oauth2.googleapis.com/projects/{project_number\}/oauthClients/{oauth_client_id\}` (Google Identity for iOS) Note that the resource must belong to the service specified in the `name` and be from the same project as this policy, but the resource is allowed to be missing at the time of creation of this policy; in that case, we make a best-effort attempt at respecting this policy, but it may not have any effect until the resource is fully created. + */ + targetResource?: string | null; + /** + * Output only. Timestamp when this resource policy configuration object was most recently updated. + */ + updateTime?: string | null; + } /** * An app's SafetyNet configuration object. This configuration controls certain properties of the `AppCheckToken` returned by ExchangeSafetyNetToken, such as its ttl. Note that your registered SHA-256 certificate fingerprints are used to validate tokens issued by SafetyNet; please register them via the Firebase Console or programmatically via the [Firebase Management Service](https://firebase.google.com/docs/projects/api/reference/rest/v11/projects.androidApps.sha/create). */ @@ -593,6 +653,19 @@ export namespace firebaseappcheck_v1 { */ name?: string | null; } + /** + * Request message for the UpdateResourcePolicy method as well as an individual update message for the BatchUpdateResourcePolicies method. + */ + export interface Schema$GoogleFirebaseAppcheckV1UpdateResourcePolicyRequest { + /** + * Required. The ResourcePolicy to update. The ResourcePolicy's `name` field is used to identify the ResourcePolicy to be updated, in the format: ``` projects/{project_number\}/services/{service_id\}/resourcePolicies/{resource_policy_id\} ``` Note that the `service_id` element must be a supported service ID. Currently, the following service IDs are supported: * `oauth2.googleapis.com` (Google Identity for iOS) + */ + resourcePolicy?: Schema$GoogleFirebaseAppcheckV1ResourcePolicy; + /** + * Required. A comma-separated list of names of fields in the ResourcePolicy to update. Example: `enforcement_mode`. + */ + updateMask?: string | null; + } /** * Request message for the UpdateService method as well as an individual update message for the BatchUpdateServices method. */ @@ -4944,8 +5017,12 @@ export namespace firebaseappcheck_v1 { export class Resource$Projects$Services { context: APIRequestContext; + resourcePolicies: Resource$Projects$Services$Resourcepolicies; constructor(context: APIRequestContext) { this.context = context; + this.resourcePolicies = new Resource$Projects$Services$Resourcepolicies( + this.context + ); } /** @@ -5385,4 +5462,664 @@ export namespace firebaseappcheck_v1 { */ requestBody?: Schema$GoogleFirebaseAppcheckV1Service; } + + export class Resource$Projects$Services$Resourcepolicies { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Atomically updates the specified ResourcePolicy configurations. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + batchUpdate( + params: Params$Resource$Projects$Services$Resourcepolicies$Batchupdate, + options: StreamMethodOptions + ): GaxiosPromise; + batchUpdate( + params?: Params$Resource$Projects$Services$Resourcepolicies$Batchupdate, + options?: MethodOptions + ): GaxiosPromise; + batchUpdate( + params: Params$Resource$Projects$Services$Resourcepolicies$Batchupdate, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + batchUpdate( + params: Params$Resource$Projects$Services$Resourcepolicies$Batchupdate, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + batchUpdate( + params: Params$Resource$Projects$Services$Resourcepolicies$Batchupdate, + callback: BodyResponseCallback + ): void; + batchUpdate( + callback: BodyResponseCallback + ): void; + batchUpdate( + paramsOrCallback?: + | Params$Resource$Projects$Services$Resourcepolicies$Batchupdate + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Services$Resourcepolicies$Batchupdate; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Services$Resourcepolicies$Batchupdate; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://firebaseappcheck.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v1/{+parent}/resourcePolicies:batchUpdate' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Creates the specified ResourcePolicy configuration. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + create( + params: Params$Resource$Projects$Services$Resourcepolicies$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Projects$Services$Resourcepolicies$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Services$Resourcepolicies$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Services$Resourcepolicies$Create, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Services$Resourcepolicies$Create, + callback: BodyResponseCallback + ): void; + create( + callback: BodyResponseCallback + ): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Services$Resourcepolicies$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Services$Resourcepolicies$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Services$Resourcepolicies$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://firebaseappcheck.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/resourcePolicies').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Deletes the specified ResourcePolicy configuration. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Projects$Services$Resourcepolicies$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Projects$Services$Resourcepolicies$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Services$Resourcepolicies$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Services$Resourcepolicies$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Services$Resourcepolicies$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Services$Resourcepolicies$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Services$Resourcepolicies$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Services$Resourcepolicies$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://firebaseappcheck.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets the requested ResourcePolicy configuration. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Projects$Services$Resourcepolicies$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Services$Resourcepolicies$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Services$Resourcepolicies$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Services$Resourcepolicies$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Services$Resourcepolicies$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Services$Resourcepolicies$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Services$Resourcepolicies$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Services$Resourcepolicies$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://firebaseappcheck.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Lists all ResourcePolicy configurations for the specified project and service. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Services$Resourcepolicies$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Services$Resourcepolicies$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Services$Resourcepolicies$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Services$Resourcepolicies$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Services$Resourcepolicies$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Services$Resourcepolicies$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Services$Resourcepolicies$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Services$Resourcepolicies$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://firebaseappcheck.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/resourcePolicies').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Updates the specified ResourcePolicy configuration. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + patch( + params: Params$Resource$Projects$Services$Resourcepolicies$Patch, + options: StreamMethodOptions + ): GaxiosPromise; + patch( + params?: Params$Resource$Projects$Services$Resourcepolicies$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Services$Resourcepolicies$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Services$Resourcepolicies$Patch, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Services$Resourcepolicies$Patch, + callback: BodyResponseCallback + ): void; + patch( + callback: BodyResponseCallback + ): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Services$Resourcepolicies$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Services$Resourcepolicies$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Services$Resourcepolicies$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://firebaseappcheck.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Projects$Services$Resourcepolicies$Batchupdate + extends StandardParameters { + /** + * Required. The parent service name, in the format ``` projects/{project_number\}/services/{service_id\} ``` The parent collection in the `name` field of any resource being updated must match this field, or the entire batch fails. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleFirebaseAppcheckV1BatchUpdateResourcePoliciesRequest; + } + export interface Params$Resource$Projects$Services$Resourcepolicies$Create + extends StandardParameters { + /** + * Required. The relative resource name of the parent Service in which the specified ResourcePolicy will be created, in the format: ``` projects/{project_number\}/services/{service_id\} ``` Note that the `service_id` element must be a supported service ID. Currently, the following service IDs are supported: * `oauth2.googleapis.com` (Google Identity for iOS) + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleFirebaseAppcheckV1ResourcePolicy; + } + export interface Params$Resource$Projects$Services$Resourcepolicies$Delete + extends StandardParameters { + /** + * The checksum to be validated against the current ResourcePolicy, to ensure the client has an up-to-date value before proceeding. This checksum is computed by the server based on the values of fields in the ResourcePolicy object, and can be obtained from the ResourcePolicy object received from the last CreateResourcePolicy, GetResourcePolicy, ListResourcePolicies, UpdateResourcePolicy, or BatchUpdateResourcePolicies call. This etag is strongly validated as defined by RFC 7232. + */ + etag?: string; + /** + * Required. The relative resource name of the ResourcePolicy to delete, in the format: ``` projects/{project_number\}/services/{service_id\}/resourcePolicies/{resource_policy_id\} ``` + */ + name?: string; + } + export interface Params$Resource$Projects$Services$Resourcepolicies$Get + extends StandardParameters { + /** + * Required. The relative resource name of the ResourcePolicy to retrieve, in the format: ``` projects/{project_number\}/services/{service_id\}/resourcePolicies/{resource_policy_id\} ``` Note that the `service_id` element must be a supported service ID. Currently, the following service IDs are supported: * `oauth2.googleapis.com` (Google Identity for iOS) + */ + name?: string; + } + export interface Params$Resource$Projects$Services$Resourcepolicies$List + extends StandardParameters { + /** + * Optional. Filters the results by the specified rule. For the exact syntax of this field, please consult the [AIP-160](https://google.aip.dev/160) standard. Currently, since the only fields in the ResourcePolicy resource are the scalar fields `enforcement_mode` and `target_resource`, this method does not support the traversal operator (`.`) or the has operator (`:`). Here are some examples of valid filters: * `enforcement_mode = ENFORCED` * `target_resource = "//oauth2.googleapis.com/projects/12345/oauthClients/"` * `enforcement_mode = ENFORCED AND target_resource = "//oauth2.googleapis.com/projects/12345/oauthClients/"` + */ + filter?: string; + /** + * The maximum number of ResourcePolicy objects to return in the response. The server may return fewer than this at its own discretion. If no value is specified (or too large a value is specified), the server will impose its own limit. + */ + pageSize?: number; + /** + * Token returned from a previous call to ListResourcePolicies indicating where in the set of ResourcePolicy objects to resume listing. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListResourcePolicies must match the call that provided the page token; if they do not match, the result is undefined. + */ + pageToken?: string; + /** + * Required. The relative resource name of the parent Service for which to list each associated ResourcePolicy, in the format: ``` projects/{project_number\}/services/{service_id\} ``` Note that the `service_id` element must be a supported service ID. Currently, the following service IDs are supported: * `oauth2.googleapis.com` (Google Identity for iOS) + */ + parent?: string; + } + export interface Params$Resource$Projects$Services$Resourcepolicies$Patch + extends StandardParameters { + /** + * Required. Identifier. The relative name of the resource policy object, in the format: ``` projects/{project_number\}/services/{service_id\}/resourcePolicies/{resource_policy_id\} ``` Note that the `service_id` element must be a supported service ID. Currently, the following service IDs are supported: * `oauth2.googleapis.com` (Google Identity for iOS) `resource_policy_id` is a system-generated UID. + */ + name?: string; + /** + * Required. A comma-separated list of names of fields in the ResourcePolicy to update. Example: `enforcement_mode`. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleFirebaseAppcheckV1ResourcePolicy; + } } diff --git a/src/apis/firebaseappdistribution/v1alpha.ts b/src/apis/firebaseappdistribution/v1alpha.ts index 126e6496e1..475ee21889 100644 --- a/src/apis/firebaseappdistribution/v1alpha.ts +++ b/src/apis/firebaseappdistribution/v1alpha.ts @@ -154,12 +154,12 @@ export namespace firebaseappdistribution_v1alpha { /** * Required. Steps to be accomplished by the AI */ - steps?: Schema$GoogleFirebaseAppdistroV1alphaAiInstructionsStep[]; + steps?: Schema$GoogleFirebaseAppdistroV1alphaAiStep[]; } /** * A step to be accomplished by the AI */ - export interface Schema$GoogleFirebaseAppdistroV1alphaAiInstructionsStep { + export interface Schema$GoogleFirebaseAppdistroV1alphaAiStep { /** * An assertion to be checked by the AI */ @@ -169,6 +169,19 @@ export namespace firebaseappdistribution_v1alpha { */ goal?: string | null; } + /** + * Captures the results of an AiStep + */ + export interface Schema$GoogleFirebaseAppdistroV1alphaAiStepResult { + /** + * Output only. The current state of the step + */ + state?: string | null; + /** + * Required. The step performed by the AI + */ + step?: Schema$GoogleFirebaseAppdistroV1alphaAiStep; + } export interface Schema$GoogleFirebaseAppdistroV1alphaApp { /** * App bundle test certificate generated for the app. @@ -223,6 +236,10 @@ export namespace firebaseappdistribution_v1alpha { * The results of running an automated test on a particular device. */ export interface Schema$GoogleFirebaseAppdistroV1alphaDeviceExecution { + /** + * Output only. Results of the AI steps if passed in + */ + aiStepResults?: Schema$GoogleFirebaseAppdistroV1alphaAiStepResult[]; /** * Output only. An app crash, if any occurred during the test. */ diff --git a/src/apis/firebaseml/v2beta.ts b/src/apis/firebaseml/v2beta.ts index d078af478c..4208c086a2 100644 --- a/src/apis/firebaseml/v2beta.ts +++ b/src/apis/firebaseml/v2beta.ts @@ -186,6 +186,10 @@ export namespace firebaseml_v2beta { * Output only. List of ratings for the safety of a response candidate. There is at most one rating per category. */ safetyRatings?: Schema$GoogleCloudAiplatformV1beta1SafetyRating[]; + /** + * Output only. Confidence score of the candidate. + */ + score?: number | null; } /** * Source attributions for content. @@ -243,17 +247,25 @@ export namespace firebaseml_v2beta { */ export interface Schema$GoogleCloudAiplatformV1beta1CountTokensRequest { /** - * Required. Input content. + * Optional. Input content. */ contents?: Schema$GoogleCloudAiplatformV1beta1Content[]; /** - * Required. The instances that are the input to token counting call. Schema is identical to the prediction schema of the underlying model. + * Optional. The instances that are the input to token counting call. Schema is identical to the prediction schema of the underlying model. */ instances?: any[] | null; /** - * Required. The name of the publisher model requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/publishers/x/models/x` + * Optional. The name of the publisher model requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/publishers/x/models/x` */ model?: string | null; + /** + * Optional. The user provided system instructions for the model. Note: only text should be used in parts and content in each part will be in a separate paragraph. + */ + systemInstruction?: Schema$GoogleCloudAiplatformV1beta1Content; + /** + * Optional. A list of `Tools` the model may use to generate the next 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. + */ + tools?: Schema$GoogleCloudAiplatformV1beta1Tool[]; } /** * Response message for PredictionService.CountTokens. @@ -471,53 +483,6 @@ export namespace firebaseml_v2beta { * Tool to retrieve public web data for grounding, powered by Google. */ export interface Schema$GoogleCloudAiplatformV1beta1GoogleSearchRetrieval {} - /** - * Grounding attribution. - */ - export interface Schema$GoogleCloudAiplatformV1beta1GroundingAttribution { - /** - * Optional. Output only. Confidence score of the attribution. Ranges from 0 to 1. 1 is the most confident. - */ - confidenceScore?: number | null; - /** - * Optional. Attribution from context retrieved by the retrieval tools. - */ - retrievedContext?: Schema$GoogleCloudAiplatformV1beta1GroundingAttributionRetrievedContext; - /** - * Output only. Segment of the content this attribution belongs to. - */ - segment?: Schema$GoogleCloudAiplatformV1beta1Segment; - /** - * Optional. Attribution from the web. - */ - web?: Schema$GoogleCloudAiplatformV1beta1GroundingAttributionWeb; - } - /** - * Attribution from context retrieved by the retrieval tools. - */ - export interface Schema$GoogleCloudAiplatformV1beta1GroundingAttributionRetrievedContext { - /** - * Output only. Title of the attribution. - */ - title?: string | null; - /** - * Output only. URI reference of the attribution. - */ - uri?: string | null; - } - /** - * Attribution from the web. - */ - export interface Schema$GoogleCloudAiplatformV1beta1GroundingAttributionWeb { - /** - * Output only. Title of the attribution. - */ - title?: string | null; - /** - * Output only. URI reference of the attribution. - */ - uri?: string | null; - } /** * Grounding chunk. */ @@ -561,10 +526,6 @@ export namespace firebaseml_v2beta { * Metadata returned to client when grounding is enabled. */ export interface Schema$GoogleCloudAiplatformV1beta1GroundingMetadata { - /** - * Optional. List of grounding attributions. - */ - groundingAttributions?: Schema$GoogleCloudAiplatformV1beta1GroundingAttribution[]; /** * List of supporting references retrieved from specified grounding source. */ diff --git a/src/apis/firestore/v1.ts b/src/apis/firestore/v1.ts index adfcc93ff1..ed578131ea 100644 --- a/src/apis/firestore/v1.ts +++ b/src/apis/firestore/v1.ts @@ -676,7 +676,7 @@ export namespace firestore_v1 { */ name?: string | null; /** - * At what relative time in the future, compared to its creation time, the backup should be deleted, e.g. keep backups for 7 days. + * At what relative time in the future, compared to its creation time, the backup should be deleted, e.g. keep backups for 7 days. The maximum supported retention is 14 weeks. */ retention?: string | null; /** @@ -1245,7 +1245,7 @@ export namespace firestore_v1 { */ export interface Schema$GoogleFirestoreAdminV1RestoreDatabaseRequest { /** - * Backup to restore from. Must be from the same project as the parent. Format is: `projects/{project_id\}/locations/{location\}/backups/{backup\}` + * Backup to restore from. Must be from the same project as the parent. The restored database will be created in the same location as the source backup. Format is: `projects/{project_id\}/locations/{location\}/backups/{backup\}` */ backup?: string | null; /** @@ -1253,7 +1253,7 @@ export namespace firestore_v1 { */ databaseId?: string | null; /** - * Use Customer Managed Encryption Keys (CMEK) for encryption. Only keys in the same location as this database are allowed to be used for encryption. For Firestore's nam5 multi-region, this corresponds to Cloud KMS multi-region us. For Firestore's eur3 multi-region, this corresponds to Cloud KMS multi-region europe. See https://cloud.google.com/kms/docs/locations. The expected format is `projects/{project_id\}/locations/{kms_location\}/keyRings/{key_ring\}/cryptoKeys/{crypto_key\}`. + * Use Customer Managed Encryption Keys (CMEK) for encryption. Only keys in the same location as the restored database are allowed to be used for encryption. For Firestore's nam5 multi-region, this corresponds to Cloud KMS multi-region us. For Firestore's eur3 multi-region, this corresponds to Cloud KMS multi-region europe. See https://cloud.google.com/kms/docs/locations. The expected format is `projects/{project_id\}/locations/{kms_location\}/keyRings/{key_ring\}/cryptoKeys/{crypto_key\}`. */ kmsKeyName?: string | null; /** diff --git a/src/apis/games/v1.ts b/src/apis/games/v1.ts index de323dc1b4..bdacf9392d 100644 --- a/src/apis/games/v1.ts +++ b/src/apis/games/v1.ts @@ -716,7 +716,7 @@ export namespace games_v1 { /** * Recall token data. */ - token?: Schema$RecallToken[]; + recallToken?: Schema$RecallToken; } /** * The payload to request to increment an achievement. @@ -1535,7 +1535,7 @@ export namespace games_v1 { /** * The recall token associated with the requested PGS Player principal. It can be unset if there is no recall token associated with the requested principal. */ - token?: Schema$RecallToken; + gamePlayerToken?: Schema$GamePlayerToken; } /** * A list of recall token data returned from the RetrieveGamesPlayerTokens RPC @@ -1544,7 +1544,7 @@ export namespace games_v1 { /** * The requested applications along with the recall tokens for the player. If the player does not have recall tokens for an application, that application is not included in the response. */ - applicationRecallTokens?: Schema$GamePlayerToken[]; + gamePlayerTokens?: Schema$GamePlayerToken[]; } /** * Response for the RetrievePlayerTokens RPC diff --git a/src/apis/gkebackup/v1.ts b/src/apis/gkebackup/v1.ts index 9f04512f3c..e98cc7c033 100644 --- a/src/apis/gkebackup/v1.ts +++ b/src/apis/gkebackup/v1.ts @@ -604,7 +604,7 @@ export namespace gkebackup_v1 { */ export interface Schema$GroupKind { /** - * Optional. API group string of a Kubernetes resource, e.g. "apiextensions.k8s.io", "storage.k8s.io", etc. Note: use empty string for core API group + * Optional. API group string of a Kubernetes resource, e.g. "apiextensions.k8s.io", "storage.k8s.io", etc. Note: use empty string for core API group. */ resourceGroup?: string | null; /** @@ -776,11 +776,11 @@ export namespace gkebackup_v1 { namespacedNames?: Schema$NamespacedName[]; } /** - * A list of Kubernetes Namespaces + * A list of Kubernetes Namespaces. */ export interface Schema$Namespaces { /** - * Optional. A list of Kubernetes Namespaces + * Optional. A list of Kubernetes Namespaces. */ namespaces?: string[] | null; } @@ -905,7 +905,7 @@ export namespace gkebackup_v1 { */ etag?: string | null; /** - * 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 `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 `MERGE_REPLACE_ON_CONFLICT`. + * 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 `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 `MERGE_REPLACE_ON_CONFLICT`. */ filter?: Schema$Filter; /** diff --git a/src/apis/gkehub/v1.ts b/src/apis/gkehub/v1.ts index 25baf1248a..39615e411f 100644 --- a/src/apis/gkehub/v1.ts +++ b/src/apis/gkehub/v1.ts @@ -525,10 +525,18 @@ export namespace gkehub_v1 { * Deployment state of the monitor pod */ monitor?: string | null; + /** + * Deployment state of otel-collector + */ + otelCollector?: string | null; /** * Deployment state of reconciler-manager pod */ reconcilerManager?: string | null; + /** + * Deployment state of resource-group-controller-manager + */ + resourceGroupControllerManager?: string | null; /** * Deployment state of root-reconciler */ @@ -585,7 +593,7 @@ export namespace gkehub_v1 { */ export interface Schema$ConfigManagementConfigSyncVersion { /** - * Version of the deployed admission_webhook pod + * Version of the deployed admission-webhook pod */ admissionWebhook?: string | null; /** @@ -600,10 +608,18 @@ export namespace gkehub_v1 { * Version of the deployed monitor pod */ monitor?: string | null; + /** + * Version of the deployed otel-collector pod + */ + otelCollector?: string | null; /** * Version of the deployed reconciler-manager pod */ reconcilerManager?: string | null; + /** + * Version of the deployed resource-group-controller-manager pod + */ + resourceGroupControllerManager?: string | null; /** * Version of the deployed reconciler container in root-reconciler pod */ @@ -1320,6 +1336,15 @@ export namespace gkehub_v1 { */ manifest?: Schema$ConnectAgentResource[]; } + /** + * Response for GenerateRBACRoleBindingYAML. + */ + export interface Schema$GenerateMembershipRBACRoleBindingYAMLResponse { + /** + * a yaml text blob including the RBAC policies. + */ + roleBindingsYaml?: string | null; + } /** * GkeCluster contains information specific to GKE clusters. */ @@ -2793,7 +2818,7 @@ export namespace gkehub_v1 { */ controlPlane?: string | null; /** - * Enables automatic Service Mesh management. + * Optional. Enables automatic Service Mesh management. */ management?: string | null; } @@ -6090,6 +6115,365 @@ export namespace gkehub_v1 { this.context = context; } + /** + * Creates a Membership RBACRoleBinding. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + create( + params: Params$Resource$Projects$Locations$Memberships$Rbacrolebindings$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Projects$Locations$Memberships$Rbacrolebindings$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Memberships$Rbacrolebindings$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Memberships$Rbacrolebindings$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Memberships$Rbacrolebindings$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Memberships$Rbacrolebindings$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Memberships$Rbacrolebindings$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Memberships$Rbacrolebindings$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://gkehub.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/rbacrolebindings').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Deletes a Membership RBACRoleBinding. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Projects$Locations$Memberships$Rbacrolebindings$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Projects$Locations$Memberships$Rbacrolebindings$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Memberships$Rbacrolebindings$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Memberships$Rbacrolebindings$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Memberships$Rbacrolebindings$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Memberships$Rbacrolebindings$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Memberships$Rbacrolebindings$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Memberships$Rbacrolebindings$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://gkehub.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Generates a YAML of the RBAC policies for the specified RoleBinding and its associated impersonation resources. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + generateMembershipRBACRoleBindingYAML( + params: Params$Resource$Projects$Locations$Memberships$Rbacrolebindings$Generatemembershiprbacrolebindingyaml, + options: StreamMethodOptions + ): GaxiosPromise; + generateMembershipRBACRoleBindingYAML( + params?: Params$Resource$Projects$Locations$Memberships$Rbacrolebindings$Generatemembershiprbacrolebindingyaml, + options?: MethodOptions + ): GaxiosPromise; + generateMembershipRBACRoleBindingYAML( + params: Params$Resource$Projects$Locations$Memberships$Rbacrolebindings$Generatemembershiprbacrolebindingyaml, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + generateMembershipRBACRoleBindingYAML( + params: Params$Resource$Projects$Locations$Memberships$Rbacrolebindings$Generatemembershiprbacrolebindingyaml, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + generateMembershipRBACRoleBindingYAML( + params: Params$Resource$Projects$Locations$Memberships$Rbacrolebindings$Generatemembershiprbacrolebindingyaml, + callback: BodyResponseCallback + ): void; + generateMembershipRBACRoleBindingYAML( + callback: BodyResponseCallback + ): void; + generateMembershipRBACRoleBindingYAML( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Memberships$Rbacrolebindings$Generatemembershiprbacrolebindingyaml + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Memberships$Rbacrolebindings$Generatemembershiprbacrolebindingyaml; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Memberships$Rbacrolebindings$Generatemembershiprbacrolebindingyaml; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://gkehub.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v1/{+parent}/rbacrolebindings:generateMembershipRBACRoleBindingYAML' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Returns the details of a Membership RBACRoleBinding. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Projects$Locations$Memberships$Rbacrolebindings$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Memberships$Rbacrolebindings$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Memberships$Rbacrolebindings$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Memberships$Rbacrolebindings$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Memberships$Rbacrolebindings$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Memberships$Rbacrolebindings$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Memberships$Rbacrolebindings$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Memberships$Rbacrolebindings$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://gkehub.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + /** * Lists all Membership RBACRoleBindings. * @@ -6187,8 +6571,140 @@ export namespace gkehub_v1 { ); } } + + /** + * Updates a Membership RBACRoleBinding. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + patch( + params: Params$Resource$Projects$Locations$Memberships$Rbacrolebindings$Patch, + options: StreamMethodOptions + ): GaxiosPromise; + patch( + params?: Params$Resource$Projects$Locations$Memberships$Rbacrolebindings$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Memberships$Rbacrolebindings$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Memberships$Rbacrolebindings$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Memberships$Rbacrolebindings$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Memberships$Rbacrolebindings$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Memberships$Rbacrolebindings$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Memberships$Rbacrolebindings$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://gkehub.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } } + export interface Params$Resource$Projects$Locations$Memberships$Rbacrolebindings$Create + extends StandardParameters { + /** + * Required. The parent (project and location) where the RBACRoleBinding will be created. Specified in the format `projects/x/locations/x/memberships/x`. + */ + parent?: string; + /** + * Required. Client chosen ID for the RBACRoleBinding. `rbacrolebinding_id` must be a valid RFC 1123 compliant DNS label: 1. At most 63 characters in length 2. It must consist of lower case alphanumeric characters or `-` 3. It must start and end with an alphanumeric character Which can be expressed as the regex: `[a-z0-9]([-a-z0-9]*[a-z0-9])?`, with a maximum length of 63 characters. + */ + rbacrolebindingId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$RBACRoleBinding; + } + export interface Params$Resource$Projects$Locations$Memberships$Rbacrolebindings$Delete + extends StandardParameters { + /** + * Required. The RBACRoleBinding resource name in the format `projects/x/locations/x/memberships/x/rbacrolebindings/x`. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Memberships$Rbacrolebindings$Generatemembershiprbacrolebindingyaml + extends StandardParameters { + /** + * Required. The parent (project and location) where the RBACRoleBinding will be created. Specified in the format `projects/x/locations/x/memberships/x`. + */ + parent?: string; + /** + * Required. Client chosen ID for the RBACRoleBinding. `rbacrolebinding_id` must be a valid RFC 1123 compliant DNS label: 1. At most 63 characters in length 2. It must consist of lower case alphanumeric characters or `-` 3. It must start and end with an alphanumeric character Which can be expressed as the regex: `[a-z0-9]([-a-z0-9]*[a-z0-9])?`, with a maximum length of 63 characters. + */ + rbacrolebindingId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$RBACRoleBinding; + } + export interface Params$Resource$Projects$Locations$Memberships$Rbacrolebindings$Get + extends StandardParameters { + /** + * Required. The RBACRoleBinding resource name in the format `projects/x/locations/x/memberships/x/rbacrolebindings/x`. + */ + name?: string; + } export interface Params$Resource$Projects$Locations$Memberships$Rbacrolebindings$List extends StandardParameters { /** @@ -6204,6 +6720,22 @@ export namespace gkehub_v1 { */ parent?: string; } + export interface Params$Resource$Projects$Locations$Memberships$Rbacrolebindings$Patch + extends StandardParameters { + /** + * The resource name for the rbacrolebinding `projects/{project\}/locations/{location\}/scopes/{scope\}/rbacrolebindings/{rbacrolebinding\}` or `projects/{project\}/locations/{location\}/memberships/{membership\}/rbacrolebindings/{rbacrolebinding\}` + */ + name?: string; + /** + * Required. The fields to be updated. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$RBACRoleBinding; + } export class Resource$Projects$Locations$Operations { context: APIRequestContext; diff --git a/src/apis/gkehub/v1alpha.ts b/src/apis/gkehub/v1alpha.ts index d43f058a46..03208682e9 100644 --- a/src/apis/gkehub/v1alpha.ts +++ b/src/apis/gkehub/v1alpha.ts @@ -666,10 +666,18 @@ export namespace gkehub_v1alpha { * Deployment state of the monitor pod */ monitor?: string | null; + /** + * Deployment state of otel-collector + */ + otelCollector?: string | null; /** * Deployment state of reconciler-manager pod */ reconcilerManager?: string | null; + /** + * Deployment state of resource-group-controller-manager + */ + resourceGroupControllerManager?: string | null; /** * Deployment state of root-reconciler */ @@ -726,7 +734,7 @@ export namespace gkehub_v1alpha { */ export interface Schema$ConfigManagementConfigSyncVersion { /** - * Version of the deployed admission_webhook pod + * Version of the deployed admission-webhook pod */ admissionWebhook?: string | null; /** @@ -741,10 +749,18 @@ export namespace gkehub_v1alpha { * Version of the deployed monitor pod */ monitor?: string | null; + /** + * Version of the deployed otel-collector pod + */ + otelCollector?: string | null; /** * Version of the deployed reconciler-manager pod */ reconcilerManager?: string | null; + /** + * Version of the deployed resource-group-controller-manager pod + */ + resourceGroupControllerManager?: string | null; /** * Version of the deployed reconciler container in root-reconciler pod */ @@ -3103,6 +3119,10 @@ export namespace gkehub_v1alpha { * **Service Mesh**: Spec for a single Membership for the servicemesh feature */ export interface Schema$ServiceMeshMembershipSpec { + /** + * Optional. Specifies the API that will be used for configuring the mesh workloads. + */ + configApi?: string | null; /** * Deprecated: use `management` instead Enables automatic control plane management. */ @@ -3112,7 +3132,7 @@ export namespace gkehub_v1alpha { */ defaultChannel?: string | null; /** - * Enables automatic Service Mesh management. + * Optional. Enables automatic Service Mesh management. */ management?: string | null; } diff --git a/src/apis/gkehub/v1beta.ts b/src/apis/gkehub/v1beta.ts index e80cc99959..969ab6670d 100644 --- a/src/apis/gkehub/v1beta.ts +++ b/src/apis/gkehub/v1beta.ts @@ -586,10 +586,18 @@ export namespace gkehub_v1beta { * Deployment state of the monitor pod */ monitor?: string | null; + /** + * Deployment state of otel-collector + */ + otelCollector?: string | null; /** * Deployment state of reconciler-manager pod */ reconcilerManager?: string | null; + /** + * Deployment state of resource-group-controller-manager + */ + resourceGroupControllerManager?: string | null; /** * Deployment state of root-reconciler */ @@ -646,7 +654,7 @@ export namespace gkehub_v1beta { */ export interface Schema$ConfigManagementConfigSyncVersion { /** - * Version of the deployed admission_webhook pod + * Version of the deployed admission-webhook pod */ admissionWebhook?: string | null; /** @@ -661,10 +669,18 @@ export namespace gkehub_v1beta { * Version of the deployed monitor pod */ monitor?: string | null; + /** + * Version of the deployed otel-collector pod + */ + otelCollector?: string | null; /** * Version of the deployed reconciler-manager pod */ reconcilerManager?: string | null; + /** + * Version of the deployed resource-group-controller-manager pod + */ + resourceGroupControllerManager?: string | null; /** * Version of the deployed reconciler container in root-reconciler pod */ @@ -2913,7 +2929,7 @@ export namespace gkehub_v1beta { */ controlPlane?: string | null; /** - * Enables automatic Service Mesh management. + * Optional. Enables automatic Service Mesh management. */ management?: string | null; } diff --git a/src/apis/healthcare/v1.ts b/src/apis/healthcare/v1.ts index 18d264d676..7eb5e9b204 100644 --- a/src/apis/healthcare/v1.ts +++ b/src/apis/healthcare/v1.ts @@ -526,7 +526,7 @@ export namespace healthcare_v1 { */ text?: Schema$TextConfig; /** - * Ensures in-flight data remains in the region of origin during de-identification. 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. + * 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. */ useRegionalDataProcessing?: boolean | null; } @@ -940,11 +940,11 @@ export namespace healthcare_v1 { */ pubsubTopic?: string | null; /** - * Whether to send full FHIR resource to this Pub/Sub topic. + * Whether to send full FHIR resource to this Pub/Sub topic. The default value is false. */ sendFullResource?: boolean | null; /** - * Whether to send full FHIR resource to this Pub/Sub topic for deleting FHIR resource. Note that setting this to true does not guarantee that all previous resources will be sent in the format of full FHIR resource. When a resource change is too large or during heavy traffic, only the resource name will be sent. Clients should always check the "payloadType" label from a Pub/Sub message to determine whether it needs to fetch the full previous resource as a separate operation. + * Whether to send full FHIR resource to this Pub/Sub topic for deleting FHIR resource. The default value is false. Note that setting this to true does not guarantee that all previous resources will be sent in the format of full FHIR resource. When a resource change is too large or during heavy traffic, only the resource name will be sent. Clients should always check the "payloadType" label from a Pub/Sub message to determine whether it needs to fetch the full previous resource as a separate operation. */ sendPreviousResourceOnDelete?: boolean | null; } @@ -957,7 +957,7 @@ export namespace healthcare_v1 { */ complexDataTypeReferenceParsing?: string | null; /** - * If true, overrides the default search behavior for this FHIR store to `handling=strict` which returns an error for unrecognized search parameters. If false, uses the FHIR specification default `handling=lenient` which ignores unrecognized search parameters. The handling can always be changed from the default on an individual API call by setting the HTTP header `Prefer: handling=strict` or `Prefer: handling=lenient`. + * If true, overrides the default search behavior for this FHIR store to `handling=strict` which returns an error for unrecognized search parameters. If false, uses the FHIR specification default `handling=lenient` which ignores unrecognized search parameters. The handling can always be changed from the default on an individual API call by setting the HTTP header `Prefer: handling=strict` or `Prefer: handling=lenient`. Defaults to false. */ defaultSearchHandlingStrict?: boolean | null; /** @@ -965,11 +965,11 @@ export namespace healthcare_v1 { */ disableReferentialIntegrity?: boolean | null; /** - * Immutable. Whether to disable resource versioning for this FHIR store. This field can not be changed after the creation of FHIR store. If set to false, which is the default behavior, all write operations cause historical versions to be recorded automatically. The historical versions can be fetched through the history APIs, but cannot be updated. If set to true, no historical versions are kept. The server sends errors for attempts to read the historical versions. + * Immutable. Whether to disable resource versioning for this FHIR store. This field can not be changed after the creation of FHIR store. If set to false, all write operations cause historical versions to be recorded automatically. The historical versions can be fetched through the history APIs, but cannot be updated. If set to true, no historical versions are kept. The server sends errors for attempts to read the historical versions. Defaults to false. */ disableResourceVersioning?: boolean | null; /** - * Whether this FHIR store has the [updateCreate capability](https://www.hl7.org/fhir/capabilitystatement-definitions.html#CapabilityStatement.rest.resource.updateCreate). This determines if the client can use an Update operation to create a new resource with a client-specified ID. If false, all IDs are server-assigned through the Create operation and attempts to update a non-existent resource return errors. 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. + * Whether this FHIR store has the [updateCreate capability](https://www.hl7.org/fhir/capabilitystatement-definitions.html#CapabilityStatement.rest.resource.updateCreate). This determines if the client can use an Update operation to create a new resource with a client-specified ID. If false, all IDs are server-assigned through the Create operation and attempts to update a non-existent resource return errors. 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. Defaults to false. */ enableUpdateCreate?: boolean | null; /** @@ -1182,7 +1182,7 @@ export namespace healthcare_v1 { */ datasetUri?: string | null; /** - * If this flag is `TRUE`, all tables are deleted from the dataset before the new exported tables are written. If the flag is not set and the destination dataset contains tables, the export call returns an error. If `write_disposition` is specified, this parameter is ignored. force=false is equivalent to write_disposition=WRITE_EMPTY and force=true is equivalent to write_disposition=WRITE_TRUNCATE. + * The default value is false. If this flag is `TRUE`, all tables are deleted from the dataset before the new exported tables are written. If the flag is not set and the destination dataset contains tables, the export call returns an error. If `write_disposition` is specified, this parameter is ignored. force=false is equivalent to write_disposition=WRITE_EMPTY and force=true is equivalent to write_disposition=WRITE_TRUNCATE. */ force?: boolean | null; /** @@ -1661,7 +1661,7 @@ export namespace healthcare_v1 { */ labels?: {[key: string]: string} | null; /** - * The message type for this message. MSH-9.1. + * Output only. The message type for this message. MSH-9.1. */ messageType?: string | null; /** @@ -1673,19 +1673,19 @@ export namespace healthcare_v1 { */ parsedData?: Schema$ParsedData; /** - * All patient IDs listed in the PID-2, PID-3, and PID-4 segments of this message. + * Output only. All patient IDs listed in the PID-2, PID-3, and PID-4 segments of this message. */ patientIds?: Schema$PatientId[]; /** - * The parsed version of the raw message data schematized according to this store's schemas and type definitions. + * Output only. The parsed version of the raw message data schematized according to this store's schemas and type definitions. */ schematizedData?: Schema$SchematizedData; /** - * The hospital that this message came from. MSH-4. + * Output only. The hospital that this message came from. MSH-4. */ sendFacility?: string | null; /** - * The datetime the sending application sent this message. MSH-7. + * Output only. The datetime the sending application sent this message. MSH-7. */ sendTime?: string | null; } @@ -2326,19 +2326,19 @@ export namespace healthcare_v1 { */ export interface Schema$ValidationConfig { /** - * Whether to disable FHIRPath validation for incoming resources. Set this to true to disable checking incoming resources for conformance against FHIRPath requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. + * Whether to disable FHIRPath validation for incoming resources. The default value is false. Set this to true to disable checking incoming resources for conformance against FHIRPath requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. */ disableFhirpathValidation?: boolean | null; /** - * Whether to disable profile validation for this FHIR store. Set this to true to disable checking incoming resources for conformance against structure definitions in this FHIR store. + * Whether to disable profile validation for this FHIR store. The default value is false. Set this to true to disable checking incoming resources for conformance against structure definitions in this FHIR store. */ disableProfileValidation?: boolean | null; /** - * Whether to disable reference type validation for incoming resources. Set this to true to disable checking incoming resources for conformance against reference type requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. + * Whether to disable reference type validation for incoming resources. The default value is false. Set this to true to disable checking incoming resources for conformance against reference type requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. */ disableReferenceTypeValidation?: boolean | null; /** - * Whether to disable required fields validation for incoming resources. Set this to true to disable checking incoming resources for conformance against required fields requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. + * Whether to disable required fields validation for incoming resources. The default value is false. Set this to true to disable checking incoming resources for conformance against required fields requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. */ disableRequiredFieldValidation?: boolean | null; /** diff --git a/src/apis/healthcare/v1beta1.ts b/src/apis/healthcare/v1beta1.ts index c906008d7f..1eaf7a5085 100644 --- a/src/apis/healthcare/v1beta1.ts +++ b/src/apis/healthcare/v1beta1.ts @@ -302,6 +302,19 @@ export namespace healthcare_v1beta1 { */ name?: string | null; } + /** + * Contains the error details of the unsupported admin Consent resources for when the ApplyAdminConsents method fails to apply one or more Consent resources. + */ + export interface Schema$ApplyAdminConsentsErrorDetail { + /** + * The list of Consent resources that are unsupported or cannot be applied and the error associated with each of them. + */ + consentErrors?: Schema$ConsentErrors[]; + /** + * The currently in progress non-validate-only ApplyAdminConsents operation ID if exist. + */ + existingOperationId?: string | null; + } /** * Request to apply the admin Consent resources for the specified FHIR store. */ @@ -704,7 +717,7 @@ export namespace healthcare_v1beta1 { */ accessDeterminationLogConfig?: Schema$AccessDeterminationLogConfig; /** - * Optional. 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. + * 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. */ accessEnforced?: boolean | null; /** @@ -720,6 +733,19 @@ export namespace healthcare_v1beta1 { */ version?: string | null; } + /** + * The Consent resource name and error. + */ + export interface Schema$ConsentErrors { + /** + * The error code and message. + */ + error?: Schema$Status; + /** + * 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\}`. + */ + name?: string | null; + } /** * The detailed evaluation of a particular Consent. */ @@ -882,7 +908,7 @@ export namespace healthcare_v1beta1 { */ text?: Schema$TextConfig; /** - * Ensures in-flight data remains in the region of origin during de-identification. Using this option results in a significant reduction of throughput, and is not compatible with `LOCATION` or `ORGANIZATION_NAME` infoTypes. If the deprecated DicomConfig or FhirConfig are used, then `LOCATION` must be excluded within TextConfig, and must also be excluded within ImageConfig if image redaction is required. + * 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. If the deprecated DicomConfig or FhirConfig are used, then `LOCATION` must be excluded within TextConfig, and must also be excluded within ImageConfig if image redaction is required. */ useRegionalDataProcessing?: boolean | null; } @@ -1484,11 +1510,11 @@ export namespace healthcare_v1beta1 { */ pubsubTopic?: string | null; /** - * Whether to send full FHIR resource to this Pub/Sub topic for Create and Update operation. Note that setting this to true does not guarantee that all resources will be sent in the format of full FHIR resource. When a resource change is too large or during heavy traffic, only the resource name will be sent. Clients should always check the "payloadType" label from a Pub/Sub message to determine whether it needs to fetch the full resource as a separate operation. + * Whether to send full FHIR resource to this Pub/Sub topic for Create and Update operation. The default value is false. Note that setting this to true does not guarantee that all resources will be sent in the format of full FHIR resource. When a resource change is too large or during heavy traffic, only the resource name will be sent. Clients should always check the "payloadType" label from a Pub/Sub message to determine whether it needs to fetch the full resource as a separate operation. */ sendFullResource?: boolean | null; /** - * Whether to send full FHIR resource to this Pub/Sub topic for deleting FHIR resource. Note that setting this to true does not guarantee that all previous resources will be sent in the format of full FHIR resource. When a resource change is too large or during heavy traffic, only the resource name will be sent. Clients should always check the "payloadType" label from a Pub/Sub message to determine whether it needs to fetch the full previous resource as a separate operation. + * Whether to send full FHIR resource to this Pub/Sub topic for deleting FHIR resource. The default value is false. Note that setting this to true does not guarantee that all previous resources will be sent in the format of full FHIR resource. When a resource change is too large or during heavy traffic, only the resource name will be sent. Clients should always check the "payloadType" label from a Pub/Sub message to determine whether it needs to fetch the full previous resource as a separate operation. */ sendPreviousResourceOnDelete?: boolean | null; } @@ -1514,7 +1540,7 @@ export namespace healthcare_v1beta1 { */ consentConfig?: Schema$ConsentConfig; /** - * If true, overrides the default search behavior for this FHIR store to `handling=strict` which returns an error for unrecognized search parameters. If false, uses the FHIR specification default `handling=lenient` which ignores unrecognized search parameters. The handling can always be changed from the default on an individual API call by setting the HTTP header `Prefer: handling=strict` or `Prefer: handling=lenient`. + * If true, overrides the default search behavior for this FHIR store to `handling=strict` which returns an error for unrecognized search parameters. If false, uses the FHIR specification default `handling=lenient` which ignores unrecognized search parameters. The handling can always be changed from the default on an individual API call by setting the HTTP header `Prefer: handling=strict` or `Prefer: handling=lenient`. Defaults to false. */ defaultSearchHandlingStrict?: boolean | null; /** @@ -1522,15 +1548,15 @@ export namespace healthcare_v1beta1 { */ disableReferentialIntegrity?: boolean | null; /** - * Immutable. Whether to disable resource versioning for this FHIR store. This field can not be changed after the creation of FHIR store. If set to false, which is the default behavior, all write operations cause historical versions to be recorded automatically. The historical versions can be fetched through the history APIs, but cannot be updated. If set to true, no historical versions are kept. The server sends errors for attempts to read the historical versions. + * Immutable. Whether to disable resource versioning for this FHIR store. This field can not be changed after the creation of FHIR store. If set to false, all write operations cause historical versions to be recorded automatically. The historical versions can be fetched through the history APIs, but cannot be updated. If set to true, no historical versions are kept. The server sends errors for attempts to read the historical versions. Defaults to false. */ disableResourceVersioning?: boolean | null; /** - * Optional. Whether to allow ExecuteBundle to accept history bundles, and directly insert and overwrite historical resource versions into the FHIR store. If set to false, using history bundles fails with an error. + * Optional. Whether to allow ExecuteBundle to accept history bundles, and directly insert and overwrite historical resource versions into the FHIR store. If set to false, using history bundles fails with an error. Defaults to false. */ enableHistoryModifications?: boolean | null; /** - * Whether this FHIR store has the [updateCreate capability](https://www.hl7.org/fhir/capabilitystatement-definitions.html#CapabilityStatement.rest.resource.updateCreate). This determines if the client can use an Update operation to create a new resource with a client-specified ID. If false, all IDs are server-assigned through the Create operation and attempts to update a non-existent resource return errors. 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. + * Whether this FHIR store has the [updateCreate capability](https://www.hl7.org/fhir/capabilitystatement-definitions.html#CapabilityStatement.rest.resource.updateCreate). This determines if the client can use an Update operation to create a new resource with a client-specified ID. If false, all IDs are server-assigned through the Create operation and attempts to update a non-existent resource return errors. 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. Defaults to false. */ enableUpdateCreate?: boolean | null; /** @@ -3287,19 +3313,19 @@ export namespace healthcare_v1beta1 { */ export interface Schema$ValidationConfig { /** - * Whether to disable FHIRPath validation for incoming resources. Set this to true to disable checking incoming resources for conformance against FHIRPath requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. + * Whether to disable FHIRPath validation for incoming resources. The default value is false. Set this to true to disable checking incoming resources for conformance against FHIRPath requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. */ disableFhirpathValidation?: boolean | null; /** - * Whether to disable profile validation for this FHIR store. Set this to true to disable checking incoming resources for conformance against StructureDefinitions in this FHIR store. + * Whether to disable profile validation for this FHIR store. The default value is false. Set this to true to disable checking incoming resources for conformance against StructureDefinitions in this FHIR store. */ disableProfileValidation?: boolean | null; /** - * Whether to disable reference type validation for incoming resources. Set this to true to disable checking incoming resources for conformance against reference type requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. + * Whether to disable reference type validation for incoming resources. The default value is false. Set this to true to disable checking incoming resources for conformance against reference type requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. */ disableReferenceTypeValidation?: boolean | null; /** - * Whether to disable required fields validation for incoming resources. Set this to true to disable checking incoming resources for conformance against required fields requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. + * Whether to disable required fields validation for incoming resources. The default value is false. Set this to true to disable checking incoming resources for conformance against required fields requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. */ disableRequiredFieldValidation?: boolean | null; /** diff --git a/src/apis/index.ts b/src/apis/index.ts index b0c122c68b..c6199cd583 100644 --- a/src/apis/index.ts +++ b/src/apis/index.ts @@ -49,6 +49,10 @@ import {VERSIONS as adminVersions, admin} from './admin'; import {VERSIONS as admobVersions, admob} from './admob'; import {VERSIONS as adsenseVersions, adsense} from './adsense'; import {VERSIONS as adsensehostVersions, adsensehost} from './adsensehost'; +import { + VERSIONS as adsenseplatformVersions, + adsenseplatform, +} from './adsenseplatform'; import { VERSIONS as advisorynotificationsVersions, advisorynotifications, @@ -244,6 +248,7 @@ import { VERSIONS as contentwarehouseVersions, contentwarehouse, } from './contentwarehouse'; +import {VERSIONS as cssVersions, css} from './css'; import {VERSIONS as customsearchVersions, customsearch} from './customsearch'; import {VERSIONS as datacatalogVersions, datacatalog} from './datacatalog'; import {VERSIONS as dataflowVersions, dataflow} from './dataflow'; @@ -725,6 +730,7 @@ export const APIS: APIList = { admob: admobVersions, adsense: adsenseVersions, adsensehost: adsensehostVersions, + adsenseplatform: adsenseplatformVersions, advisorynotifications: advisorynotificationsVersions, aiplatform: aiplatformVersions, airquality: airqualityVersions, @@ -806,6 +812,7 @@ export const APIS: APIList = { containeranalysis: containeranalysisVersions, content: contentVersions, contentwarehouse: contentwarehouseVersions, + css: cssVersions, customsearch: customsearchVersions, datacatalog: datacatalogVersions, dataflow: dataflowVersions, @@ -1025,6 +1032,7 @@ export class GeneratedAPIs { admob = admob; adsense = adsense; adsensehost = adsensehost; + adsenseplatform = adsenseplatform; advisorynotifications = advisorynotifications; aiplatform = aiplatform; airquality = airquality; @@ -1106,6 +1114,7 @@ export class GeneratedAPIs { containeranalysis = containeranalysis; content = content; contentwarehouse = contentwarehouse; + css = css; customsearch = customsearch; datacatalog = datacatalog; dataflow = dataflow; diff --git a/src/apis/logging/v2.ts b/src/apis/logging/v2.ts index d21ad773e6..865d549c18 100644 --- a/src/apis/logging/v2.ts +++ b/src/apis/logging/v2.ts @@ -5586,6 +5586,10 @@ export namespace logging_v2 { } export interface Params$Resource$Billingaccounts$Locations$Savedqueries$List extends StandardParameters { + /** + * Optional. Specifies the type ("Logging" or "OpsAnalytics") and the visibility (PRIVATE or SHARED) of the saved queries to list. If provided, the filter must contain either the type function or a visibility token, or both. If both are chosen, they can be placed in any order, but they must be joined by the AND operator or the empty character.The two supported type function calls are: type("Logging") type("OpsAnalytics")The two supported visibility tokens are: visibility = PRIVATE visibility = SHAREDFor example:type("Logging") AND visibility = PRIVATE visibility=SHARED type("OpsAnalytics") type("OpsAnalytics)" visibility = PRIVATE visibility = SHARED + */ + filter?: string; /** * Optional. The maximum number of results to return from this request.Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available. */ @@ -7622,7 +7626,7 @@ export namespace logging_v2 { export interface Params$Resource$Folders$Updatesettings extends StandardParameters { /** - * Required. The resource name for the settings to update. "organizations/[ORGANIZATION_ID]/settings" For example:"organizations/12345/settings" + * Required. The resource name for the settings to update. "organizations/[ORGANIZATION_ID]/settings" "folders/[FOLDER_ID]/settings" For example:"organizations/12345/settings" */ name?: string; /** @@ -11414,6 +11418,10 @@ export namespace logging_v2 { } export interface Params$Resource$Folders$Locations$Savedqueries$List extends StandardParameters { + /** + * Optional. Specifies the type ("Logging" or "OpsAnalytics") and the visibility (PRIVATE or SHARED) of the saved queries to list. If provided, the filter must contain either the type function or a visibility token, or both. If both are chosen, they can be placed in any order, but they must be joined by the AND operator or the empty character.The two supported type function calls are: type("Logging") type("OpsAnalytics")The two supported visibility tokens are: visibility = PRIVATE visibility = SHAREDFor example:type("Logging") AND visibility = PRIVATE visibility=SHARED type("OpsAnalytics") type("OpsAnalytics)" visibility = PRIVATE visibility = SHARED + */ + filter?: string; /** * Optional. The maximum number of results to return from this request.Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available. */ @@ -15543,7 +15551,7 @@ export namespace logging_v2 { export interface Params$Resource$Organizations$Updatesettings extends StandardParameters { /** - * Required. The resource name for the settings to update. "organizations/[ORGANIZATION_ID]/settings" For example:"organizations/12345/settings" + * Required. The resource name for the settings to update. "organizations/[ORGANIZATION_ID]/settings" "folders/[FOLDER_ID]/settings" For example:"organizations/12345/settings" */ name?: string; /** @@ -19358,6 +19366,10 @@ export namespace logging_v2 { } export interface Params$Resource$Organizations$Locations$Savedqueries$List extends StandardParameters { + /** + * Optional. Specifies the type ("Logging" or "OpsAnalytics") and the visibility (PRIVATE or SHARED) of the saved queries to list. If provided, the filter must contain either the type function or a visibility token, or both. If both are chosen, they can be placed in any order, but they must be joined by the AND operator or the empty character.The two supported type function calls are: type("Logging") type("OpsAnalytics")The two supported visibility tokens are: visibility = PRIVATE visibility = SHAREDFor example:type("Logging") AND visibility = PRIVATE visibility=SHARED type("OpsAnalytics") type("OpsAnalytics)" visibility = PRIVATE visibility = SHARED + */ + filter?: string; /** * Optional. The maximum number of results to return from this request.Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available. */ @@ -24208,6 +24220,10 @@ export namespace logging_v2 { } export interface Params$Resource$Projects$Locations$Savedqueries$List extends StandardParameters { + /** + * Optional. Specifies the type ("Logging" or "OpsAnalytics") and the visibility (PRIVATE or SHARED) of the saved queries to list. If provided, the filter must contain either the type function or a visibility token, or both. If both are chosen, they can be placed in any order, but they must be joined by the AND operator or the empty character.The two supported type function calls are: type("Logging") type("OpsAnalytics")The two supported visibility tokens are: visibility = PRIVATE visibility = SHAREDFor example:type("Logging") AND visibility = PRIVATE visibility=SHARED type("OpsAnalytics") type("OpsAnalytics)" visibility = PRIVATE visibility = SHARED + */ + filter?: string; /** * Optional. The maximum number of results to return from this request.Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available. */ @@ -26468,7 +26484,7 @@ export namespace logging_v2 { export interface Params$Resource$V2$Updatesettings extends StandardParameters { /** - * Required. The resource name for the settings to update. "organizations/[ORGANIZATION_ID]/settings" For example:"organizations/12345/settings" + * Required. The resource name for the settings to update. "organizations/[ORGANIZATION_ID]/settings" "folders/[FOLDER_ID]/settings" For example:"organizations/12345/settings" */ name?: string; /** diff --git a/src/apis/manufacturers/v1.ts b/src/apis/manufacturers/v1.ts index 3249b43069..04bf9260e2 100644 --- a/src/apis/manufacturers/v1.ts +++ b/src/apis/manufacturers/v1.ts @@ -475,6 +475,10 @@ export namespace manufacturers_v1 { * Product issue. */ export interface Schema$Issue { + /** + * Output only. List of country codes (ISO 3166-1 alpha-2) where issue applies to the manufacturer product. + */ + applicableCountries?: string[] | null; /** * If present, the attribute that triggered the issue. For more information about attributes, see https://support.google.com/manufacturers/answer/6124116. */ diff --git a/src/apis/meet/v2.ts b/src/apis/meet/v2.ts index cf765e1b28..1c5a48ccdf 100644 --- a/src/apis/meet/v2.ts +++ b/src/apis/meet/v2.ts @@ -391,15 +391,15 @@ export namespace meet_v2 { */ config?: Schema$SpaceConfig; /** - * Output only. Type friendly code to join the meeting. Format: `[a-z]+-[a-z]+-[a-z]+` such as `abc-mnop-xyz`. The maximum length is 128 characters. Can only be used as an alias of the space ID to get the space. + * Output only. Type friendly unique string used to join the meeting. Format: `[a-z]+-[a-z]+-[a-z]+`. For example, `abc-mnop-xyz`. The maximum length is 128 characters. Can only be used as an alias of the space name to get the space. */ meetingCode?: string | null; /** - * Output only. URI used to join meetings, such as `https://meet.google.com/abc-mnop-xyz`. + * Output only. URI used to join meetings consisting of `https://meet.google.com/` followed by the `meeting_code`. For example, `https://meet.google.com/abc-mnop-xyz`. */ meetingUri?: string | null; /** - * Immutable. Resource name of the space. Format: `spaces/{space\}` + * Immutable. Resource name of the space. Format: `spaces/{space\}`. `{space\}` is the resource identifier for the space. It's a unique, server-generated ID and is case sensitive. For example, `jQCFfuBOdN5z`. For more information, see [How Meet identifies a meeting space](https://developers.google.com/meet/api/guides/meeting-spaces#identify-meeting-space). */ name?: string | null; } @@ -1856,7 +1856,7 @@ export namespace meet_v2 { } /** - * Ends an active conference (if there's one). + * Ends an active conference (if there's one). For an example, see [End active conference](https://developers.google.com/meet/api/guides/meeting-spaces#end-active-conference). * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -1944,7 +1944,7 @@ export namespace meet_v2 { } /** - * Gets a space by `space_id` or `meeting_code`. + * Gets details about a meeting space. For an example, see [Get a meeting space](https://developers.google.com/meet/api/guides/meeting-spaces#get-meeting-space). * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -2028,7 +2028,7 @@ export namespace meet_v2 { } /** - * Updates a space. + * Updates details about a meeting space. For an example, see [Update a meeting space](https://developers.google.com/meet/api/guides/meeting-spaces#update-meeting-space). * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -2121,7 +2121,7 @@ export namespace meet_v2 { export interface Params$Resource$Spaces$Endactiveconference extends StandardParameters { /** - * Required. Resource name of the space. + * Required. Resource name of the space. Format: `spaces/{space\}`. `{space\}` is the resource identifier for the space. It's a unique, server-generated ID and is case sensitive. For example, `jQCFfuBOdN5z`. For more information, see [How Meet identifies a meeting space](https://developers.google.com/meet/api/guides/meeting-spaces#identify-meeting-space). */ name?: string; @@ -2132,13 +2132,13 @@ export namespace meet_v2 { } export interface Params$Resource$Spaces$Get extends StandardParameters { /** - * Required. Resource name of the space. + * Required. Resource name of the space. Format: `spaces/{space\}` or `spaces/{meetingCode\}`. `{space\}` is the resource identifier for the space. It's a unique, server-generated ID and is case sensitive. For example, `jQCFfuBOdN5z`. `{meetingCode\}` is an alias for the space. It's a typeable, unique character string and is non-case sensitive. For example, `abc-mnop-xyz`. The maximum length is 128 characters. A `meetingCode` shouldn't be stored long term as it can become dissociated from a meeting space and can be reused for different meeting spaces in the future. Generally, a `meetingCode` expires 365 days after last use. For more information, see [Learn about meeting codes in Google Meet](https://support.google.com/meet/answer/10710509). For more information, see [How Meet identifies a meeting space](https://developers.google.com/meet/api/guides/meeting-spaces#identify-meeting-space). */ name?: string; } export interface Params$Resource$Spaces$Patch extends StandardParameters { /** - * Immutable. Resource name of the space. Format: `spaces/{space\}` + * Immutable. Resource name of the space. Format: `spaces/{space\}`. `{space\}` is the resource identifier for the space. It's a unique, server-generated ID and is case sensitive. For example, `jQCFfuBOdN5z`. For more information, see [How Meet identifies a meeting space](https://developers.google.com/meet/api/guides/meeting-spaces#identify-meeting-space). */ name?: string; /** diff --git a/src/apis/merchantapi/accounts_v1beta.ts b/src/apis/merchantapi/accounts_v1beta.ts index 3cdcc54bd6..3cb84ed795 100644 --- a/src/apis/merchantapi/accounts_v1beta.ts +++ b/src/apis/merchantapi/accounts_v1beta.ts @@ -1409,7 +1409,7 @@ export namespace merchantapi_accounts_v1beta { */ accepted?: Schema$Accepted; /** - * Identifier. The resource name of the terms of service version. Format: `accounts/{account\}/termsOfServiceAgreementState/{identifier\}` + * Identifier. The resource name of the terms of service version. Format: `accounts/{account\}/termsOfServiceAgreementState/{identifier\}` The identifier format is: `{TermsOfServiceKind\}-{country\}` For example, an identifier could be: `MERCHANT_CENTER-US` */ name?: string | null; /** @@ -1595,6 +1595,9 @@ export namespace merchantapi_accounts_v1beta { export class Resource$Accounts { context: APIRequestContext; accounttax: Resource$Accounts$Accounttax; + businessIdentity: Resource$Accounts$Businessidentity; + businessInfo: Resource$Accounts$Businessinfo; + emailpreferences: Resource$Accounts$Emailpreferences; homepage: Resource$Accounts$Homepage; issues: Resource$Accounts$Issues; onlineReturnPolicies: Resource$Accounts$Onlinereturnpolicies; @@ -1606,6 +1609,13 @@ export namespace merchantapi_accounts_v1beta { constructor(context: APIRequestContext) { this.context = context; this.accounttax = new Resource$Accounts$Accounttax(this.context); + this.businessIdentity = new Resource$Accounts$Businessidentity( + this.context + ); + this.businessInfo = new Resource$Accounts$Businessinfo(this.context); + this.emailpreferences = new Resource$Accounts$Emailpreferences( + this.context + ); this.homepage = new Resource$Accounts$Homepage(this.context); this.issues = new Resource$Accounts$Issues(this.context); this.onlineReturnPolicies = new Resource$Accounts$Onlinereturnpolicies( @@ -1883,59 +1893,61 @@ export namespace merchantapi_accounts_v1beta { } /** - * Retrieves the business identity of an account. + * Lists accounts accessible to the calling user and matching the constraints of the request such as page size or filters. This is not just listing the sub-accounts of an MCA, but all accounts the calling user has access to including other MCAs, linked accounts, standalone accounts and so on. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - getBusinessIdentity( - params: Params$Resource$Accounts$Getbusinessidentity, + list( + params: Params$Resource$Accounts$List, options: StreamMethodOptions ): GaxiosPromise; - getBusinessIdentity( - params?: Params$Resource$Accounts$Getbusinessidentity, + list( + params?: Params$Resource$Accounts$List, options?: MethodOptions - ): GaxiosPromise; - getBusinessIdentity( - params: Params$Resource$Accounts$Getbusinessidentity, + ): GaxiosPromise; + list( + params: Params$Resource$Accounts$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - getBusinessIdentity( - params: Params$Resource$Accounts$Getbusinessidentity, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - getBusinessIdentity( - params: Params$Resource$Accounts$Getbusinessidentity, - callback: BodyResponseCallback + list( + params: Params$Resource$Accounts$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - getBusinessIdentity( - callback: BodyResponseCallback + list( + params: Params$Resource$Accounts$List, + callback: BodyResponseCallback ): void; - getBusinessIdentity( + list(callback: BodyResponseCallback): void; + list( paramsOrCallback?: - | Params$Resource$Accounts$Getbusinessidentity - | BodyResponseCallback + | Params$Resource$Accounts$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Accounts$Getbusinessidentity; + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Accounts$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Accounts$Getbusinessidentity; + params = {} as Params$Resource$Accounts$List; options = {}; } @@ -1948,7 +1960,7 @@ export namespace merchantapi_accounts_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/accounts/v1beta/{+name}').replace( + url: (rootUrl + '/accounts/v1beta/accounts').replace( /([^:]\/)\/+/g, '$1' ), @@ -1958,72 +1970,79 @@ export namespace merchantapi_accounts_v1beta { options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: [], + pathParams: [], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Retrieves the business info of an account. + * List all sub-accounts for a given multi client account. This is a convenience wrapper for the more powerful `ListAccounts` method. This method will produce the same results as calling `ListsAccounts` with the following filter: `relationship(providerId={parent\} AND service(type="ACCOUNT_AGGREGATION"))` * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - getBusinessInfo( - params: Params$Resource$Accounts$Getbusinessinfo, + listSubaccounts( + params: Params$Resource$Accounts$Listsubaccounts, options: StreamMethodOptions ): GaxiosPromise; - getBusinessInfo( - params?: Params$Resource$Accounts$Getbusinessinfo, + listSubaccounts( + params?: Params$Resource$Accounts$Listsubaccounts, options?: MethodOptions - ): GaxiosPromise; - getBusinessInfo( - params: Params$Resource$Accounts$Getbusinessinfo, + ): GaxiosPromise; + listSubaccounts( + params: Params$Resource$Accounts$Listsubaccounts, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - getBusinessInfo( - params: Params$Resource$Accounts$Getbusinessinfo, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + listSubaccounts( + params: Params$Resource$Accounts$Listsubaccounts, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - getBusinessInfo( - params: Params$Resource$Accounts$Getbusinessinfo, - callback: BodyResponseCallback + listSubaccounts( + params: Params$Resource$Accounts$Listsubaccounts, + callback: BodyResponseCallback ): void; - getBusinessInfo(callback: BodyResponseCallback): void; - getBusinessInfo( + listSubaccounts( + callback: BodyResponseCallback + ): void; + listSubaccounts( paramsOrCallback?: - | Params$Resource$Accounts$Getbusinessinfo - | BodyResponseCallback + | Params$Resource$Accounts$Listsubaccounts + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { + ): + | void + | GaxiosPromise + | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Accounts$Getbusinessinfo; + {}) as Params$Resource$Accounts$Listsubaccounts; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Accounts$Getbusinessinfo; + params = {} as Params$Resource$Accounts$Listsubaccounts; options = {}; } @@ -2036,82 +2055,80 @@ export namespace merchantapi_accounts_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/accounts/v1beta/{+name}').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: ( + rootUrl + '/accounts/v1beta/{+provider}:listSubaccounts' + ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['provider'], + pathParams: ['provider'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Retrieves a store's homepage. + * Updates an account regardless of its type: standalone, MCA or sub-account. Executing this method requires admin access. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - getHomepage( - params: Params$Resource$Accounts$Gethomepage, + patch( + params: Params$Resource$Accounts$Patch, options: StreamMethodOptions ): GaxiosPromise; - getHomepage( - params?: Params$Resource$Accounts$Gethomepage, + patch( + params?: Params$Resource$Accounts$Patch, options?: MethodOptions - ): GaxiosPromise; - getHomepage( - params: Params$Resource$Accounts$Gethomepage, + ): GaxiosPromise; + patch( + params: Params$Resource$Accounts$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - getHomepage( - params: Params$Resource$Accounts$Gethomepage, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + patch( + params: Params$Resource$Accounts$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - getHomepage( - params: Params$Resource$Accounts$Gethomepage, - callback: BodyResponseCallback + patch( + params: Params$Resource$Accounts$Patch, + callback: BodyResponseCallback ): void; - getHomepage(callback: BodyResponseCallback): void; - getHomepage( + patch(callback: BodyResponseCallback): void; + patch( paramsOrCallback?: - | Params$Resource$Accounts$Gethomepage - | BodyResponseCallback + | Params$Resource$Accounts$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Accounts$Gethomepage; + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Accounts$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Accounts$Gethomepage; + params = {} as Params$Resource$Accounts$Patch; options = {}; } @@ -2128,7 +2145,7 @@ export namespace merchantapi_accounts_v1beta { /([^:]\/)\/+/g, '$1' ), - method: 'GET', + method: 'PATCH', apiVersion: '', }, options @@ -2139,69 +2156,138 @@ export namespace merchantapi_accounts_v1beta { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } + } + export interface Params$Resource$Accounts$Createandconfigure + extends StandardParameters { /** - * Retrieve shipping setting information. + * Request body metadata + */ + requestBody?: Schema$CreateAndConfigureAccountRequest; + } + export interface Params$Resource$Accounts$Delete extends StandardParameters { + /** + * Required. The name of the account to delete. Format: `accounts/{account\}` + */ + name?: string; + } + export interface Params$Resource$Accounts$Get extends StandardParameters { + /** + * Required. The name of the account to retrieve. Format: `accounts/{account\}` + */ + name?: string; + } + export interface Params$Resource$Accounts$List extends StandardParameters { + /** + * Optional. Returns only accounts that match the [filter](/merchant/api/guides/accounts/filter). For more details, see the [filter syntax reference](/merchant/api/guides/accounts/filter-syntax). + */ + filter?: string; + /** + * Optional. The maximum number of accounts to return. The service may return fewer than this value. If unspecified, at most 250 accounts are returned. The maximum value is 500; values above 500 are coerced to 500. + */ + pageSize?: number; + /** + * Optional. A page token, received from a previous `ListAccounts` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAccounts` must match the call that provided the page token. + */ + pageToken?: string; + } + export interface Params$Resource$Accounts$Listsubaccounts + extends StandardParameters { + /** + * Optional. The maximum number of accounts to return. The service may return fewer than this value. If unspecified, at most 250 accounts are returned. The maximum value is 500; values above 500 are coerced to 500. + */ + pageSize?: number; + /** + * Optional. A page token, received from a previous `ListAccounts` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAccounts` must match the call that provided the page token. + */ + pageToken?: string; + /** + * Required. The parent account. Format: `accounts/{account\}` + */ + provider?: string; + } + export interface Params$Resource$Accounts$Patch extends StandardParameters { + /** + * Identifier. The resource name of the account. Format: `accounts/{account\}` + */ + name?: string; + /** + * Required. List of fields being updated. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Account; + } + + export class Resource$Accounts$Accounttax { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Returns the tax rules that match the conditions of GetAccountTaxRequest * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - getShippingSettings( - params: Params$Resource$Accounts$Getshippingsettings, + get( + params: Params$Resource$Accounts$Accounttax$Get, options: StreamMethodOptions ): GaxiosPromise; - getShippingSettings( - params?: Params$Resource$Accounts$Getshippingsettings, + get( + params?: Params$Resource$Accounts$Accounttax$Get, options?: MethodOptions - ): GaxiosPromise; - getShippingSettings( - params: Params$Resource$Accounts$Getshippingsettings, + ): GaxiosPromise; + get( + params: Params$Resource$Accounts$Accounttax$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - getShippingSettings( - params: Params$Resource$Accounts$Getshippingsettings, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - getShippingSettings( - params: Params$Resource$Accounts$Getshippingsettings, - callback: BodyResponseCallback + get( + params: Params$Resource$Accounts$Accounttax$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - getShippingSettings( - callback: BodyResponseCallback + get( + params: Params$Resource$Accounts$Accounttax$Get, + callback: BodyResponseCallback ): void; - getShippingSettings( + get(callback: BodyResponseCallback): void; + get( paramsOrCallback?: - | Params$Resource$Accounts$Getshippingsettings - | BodyResponseCallback + | Params$Resource$Accounts$Accounttax$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { + ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Accounts$Getshippingsettings; + {}) as Params$Resource$Accounts$Accounttax$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Accounts$Getshippingsettings; + params = {} as Params$Resource$Accounts$Accounttax$Get; options = {}; } @@ -2229,17 +2315,17 @@ export namespace merchantapi_accounts_v1beta { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Lists accounts accessible to the calling user and matching the constraints of the request such as page size or filters. This is not just listing the sub-accounts of an MCA, but all accounts the calling user has access to including other MCAs, linked accounts, standalone accounts and so on. + * Lists the tax settings of the sub-accounts only in your Merchant Center account. This method can only be called on a multi-client account, otherwise it'll return an error. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -2247,53 +2333,54 @@ export namespace merchantapi_accounts_v1beta { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Accounts$List, + params: Params$Resource$Accounts$Accounttax$List, options: StreamMethodOptions ): GaxiosPromise; list( - params?: Params$Resource$Accounts$List, + params?: Params$Resource$Accounts$Accounttax$List, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; list( - params: Params$Resource$Accounts$List, + params: Params$Resource$Accounts$Accounttax$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Accounts$List, + params: Params$Resource$Accounts$Accounttax$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Accounts$List, - callback: BodyResponseCallback + params: Params$Resource$Accounts$Accounttax$List, + callback: BodyResponseCallback ): void; - list(callback: BodyResponseCallback): void; + list(callback: BodyResponseCallback): void; list( paramsOrCallback?: - | Params$Resource$Accounts$List - | BodyResponseCallback + | Params$Resource$Accounts$Accounttax$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Accounts$List; + let params = (paramsOrCallback || + {}) as Params$Resource$Accounts$Accounttax$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Accounts$List; + params = {} as Params$Resource$Accounts$Accounttax$List; options = {}; } @@ -2306,7 +2393,7 @@ export namespace merchantapi_accounts_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/accounts/v1beta/accounts').replace( + url: (rootUrl + '/accounts/v1beta/{+parent}/accounttax').replace( /([^:]\/)\/+/g, '$1' ), @@ -2316,79 +2403,72 @@ export namespace merchantapi_accounts_v1beta { options ), params, - requiredParams: [], - pathParams: [], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * List all sub-accounts for a given multi client account. This is a convenience wrapper for the more powerful `ListAccounts` method. This method will produce the same results as calling `ListsAccounts` with the following filter: `relationship(providerId={parent\} AND service(type="ACCOUNT_AGGREGATION"))` + * Updates the tax settings of the account. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - listSubaccounts( - params: Params$Resource$Accounts$Listsubaccounts, + patch( + params: Params$Resource$Accounts$Accounttax$Patch, options: StreamMethodOptions ): GaxiosPromise; - listSubaccounts( - params?: Params$Resource$Accounts$Listsubaccounts, + patch( + params?: Params$Resource$Accounts$Accounttax$Patch, options?: MethodOptions - ): GaxiosPromise; - listSubaccounts( - params: Params$Resource$Accounts$Listsubaccounts, + ): GaxiosPromise; + patch( + params: Params$Resource$Accounts$Accounttax$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - listSubaccounts( - params: Params$Resource$Accounts$Listsubaccounts, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - listSubaccounts( - params: Params$Resource$Accounts$Listsubaccounts, - callback: BodyResponseCallback + patch( + params: Params$Resource$Accounts$Accounttax$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - listSubaccounts( - callback: BodyResponseCallback + patch( + params: Params$Resource$Accounts$Accounttax$Patch, + callback: BodyResponseCallback ): void; - listSubaccounts( + patch(callback: BodyResponseCallback): void; + patch( paramsOrCallback?: - | Params$Resource$Accounts$Listsubaccounts - | BodyResponseCallback + | Params$Resource$Accounts$Accounttax$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { + ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Accounts$Listsubaccounts; + {}) as Params$Resource$Accounts$Accounttax$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Accounts$Listsubaccounts; + params = {} as Params$Resource$Accounts$Accounttax$Patch; options = {}; } @@ -2401,80 +2481,131 @@ export namespace merchantapi_accounts_v1beta { const parameters = { options: Object.assign( { - url: ( - rootUrl + '/accounts/v1beta/{+provider}:listSubaccounts' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/accounts/v1beta/{+name}').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'PATCH', apiVersion: '', }, options ), params, - requiredParams: ['provider'], - pathParams: ['provider'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } + } + export interface Params$Resource$Accounts$Accounttax$Get + extends StandardParameters { /** - * Updates an account regardless of its type: standalone, MCA or sub-account. Executing this method requires admin access. + * Required. The name from which tax settings will be retrieved + */ + name?: string; + } + export interface Params$Resource$Accounts$Accounttax$List + extends StandardParameters { + /** + * The maximum number of tax settings to return in the response, used for paging. + */ + pageSize?: number; + /** + * The token returned by the previous request. + */ + pageToken?: string; + /** + * Required. The parent, which owns this collection of account tax. Format: accounts/{account\} + */ + parent?: string; + } + export interface Params$Resource$Accounts$Accounttax$Patch + extends StandardParameters { + /** + * Identifier. The name of the tax setting. Format: "{account_tax.name=accounts/{account\}\}" + */ + name?: string; + /** + * The list of fields to be updated + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$AccountTax; + } + + export class Resource$Accounts$Businessidentity { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Retrieves the business identity of an account. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - patch( - params: Params$Resource$Accounts$Patch, + getBusinessIdentity( + params: Params$Resource$Accounts$Businessidentity$Getbusinessidentity, options: StreamMethodOptions ): GaxiosPromise; - patch( - params?: Params$Resource$Accounts$Patch, + getBusinessIdentity( + params?: Params$Resource$Accounts$Businessidentity$Getbusinessidentity, options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Accounts$Patch, + ): GaxiosPromise; + getBusinessIdentity( + params: Params$Resource$Accounts$Businessidentity$Getbusinessidentity, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Accounts$Patch, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + getBusinessIdentity( + params: Params$Resource$Accounts$Businessidentity$Getbusinessidentity, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Accounts$Patch, - callback: BodyResponseCallback + getBusinessIdentity( + params: Params$Resource$Accounts$Businessidentity$Getbusinessidentity, + callback: BodyResponseCallback ): void; - patch(callback: BodyResponseCallback): void; - patch( + getBusinessIdentity( + callback: BodyResponseCallback + ): void; + getBusinessIdentity( paramsOrCallback?: - | Params$Resource$Accounts$Patch - | BodyResponseCallback + | Params$Resource$Accounts$Businessidentity$Getbusinessidentity + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Accounts$Patch; + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Accounts$Businessidentity$Getbusinessidentity; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Accounts$Patch; + params = + {} as Params$Resource$Accounts$Businessidentity$Getbusinessidentity; options = {}; } @@ -2491,7 +2622,7 @@ export namespace merchantapi_accounts_v1beta { /([^:]\/)\/+/g, '$1' ), - method: 'PATCH', + method: 'GET', apiVersion: '', }, options @@ -2502,12 +2633,12 @@ export namespace merchantapi_accounts_v1beta { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } @@ -2520,25 +2651,25 @@ export namespace merchantapi_accounts_v1beta { * @returns A promise if used with async/await, or void if used with a callback. */ updateBusinessIdentity( - params: Params$Resource$Accounts$Updatebusinessidentity, + params: Params$Resource$Accounts$Businessidentity$Updatebusinessidentity, options: StreamMethodOptions ): GaxiosPromise; updateBusinessIdentity( - params?: Params$Resource$Accounts$Updatebusinessidentity, + params?: Params$Resource$Accounts$Businessidentity$Updatebusinessidentity, options?: MethodOptions ): GaxiosPromise; updateBusinessIdentity( - params: Params$Resource$Accounts$Updatebusinessidentity, + params: Params$Resource$Accounts$Businessidentity$Updatebusinessidentity, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; updateBusinessIdentity( - params: Params$Resource$Accounts$Updatebusinessidentity, + params: Params$Resource$Accounts$Businessidentity$Updatebusinessidentity, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; updateBusinessIdentity( - params: Params$Resource$Accounts$Updatebusinessidentity, + params: Params$Resource$Accounts$Businessidentity$Updatebusinessidentity, callback: BodyResponseCallback ): void; updateBusinessIdentity( @@ -2546,7 +2677,7 @@ export namespace merchantapi_accounts_v1beta { ): void; updateBusinessIdentity( paramsOrCallback?: - | Params$Resource$Accounts$Updatebusinessidentity + | Params$Resource$Accounts$Businessidentity$Updatebusinessidentity | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -2559,12 +2690,13 @@ export namespace merchantapi_accounts_v1beta { | BodyResponseCallback ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Accounts$Updatebusinessidentity; + {}) as Params$Resource$Accounts$Businessidentity$Updatebusinessidentity; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Accounts$Updatebusinessidentity; + params = + {} as Params$Resource$Accounts$Businessidentity$Updatebusinessidentity; options = {}; } @@ -2600,43 +2732,72 @@ export namespace merchantapi_accounts_v1beta { return createAPIRequest(parameters); } } + } + export interface Params$Resource$Accounts$Businessidentity$Getbusinessidentity + extends StandardParameters { /** - * Updates the business info of an account. Executing this method requires admin access. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. + * Required. The resource name of the business identity. Format: `accounts/{account\}/businessIdentity` */ - updateBusinessInfo( - params: Params$Resource$Accounts$Updatebusinessinfo, + name?: string; + } + export interface Params$Resource$Accounts$Businessidentity$Updatebusinessidentity + extends StandardParameters { + /** + * Identifier. The resource name of the business identity. Format: `accounts/{account\}/businessIdentity` + */ + name?: string; + /** + * Required. List of fields being updated. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$BusinessIdentity; + } + + export class Resource$Accounts$Businessinfo { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Retrieves the business info of an account. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + getBusinessInfo( + params: Params$Resource$Accounts$Businessinfo$Getbusinessinfo, options: StreamMethodOptions ): GaxiosPromise; - updateBusinessInfo( - params?: Params$Resource$Accounts$Updatebusinessinfo, + getBusinessInfo( + params?: Params$Resource$Accounts$Businessinfo$Getbusinessinfo, options?: MethodOptions ): GaxiosPromise; - updateBusinessInfo( - params: Params$Resource$Accounts$Updatebusinessinfo, + getBusinessInfo( + params: Params$Resource$Accounts$Businessinfo$Getbusinessinfo, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - updateBusinessInfo( - params: Params$Resource$Accounts$Updatebusinessinfo, + getBusinessInfo( + params: Params$Resource$Accounts$Businessinfo$Getbusinessinfo, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - updateBusinessInfo( - params: Params$Resource$Accounts$Updatebusinessinfo, - callback: BodyResponseCallback - ): void; - updateBusinessInfo( + getBusinessInfo( + params: Params$Resource$Accounts$Businessinfo$Getbusinessinfo, callback: BodyResponseCallback ): void; - updateBusinessInfo( + getBusinessInfo(callback: BodyResponseCallback): void; + getBusinessInfo( paramsOrCallback?: - | Params$Resource$Accounts$Updatebusinessinfo + | Params$Resource$Accounts$Businessinfo$Getbusinessinfo | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -2649,12 +2810,12 @@ export namespace merchantapi_accounts_v1beta { | BodyResponseCallback ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Accounts$Updatebusinessinfo; + {}) as Params$Resource$Accounts$Businessinfo$Getbusinessinfo; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Accounts$Updatebusinessinfo; + params = {} as Params$Resource$Accounts$Businessinfo$Getbusinessinfo; options = {}; } @@ -2671,7 +2832,7 @@ export namespace merchantapi_accounts_v1beta { /([^:]\/)\/+/g, '$1' ), - method: 'PATCH', + method: 'GET', apiVersion: '', }, options @@ -2692,57 +2853,59 @@ export namespace merchantapi_accounts_v1beta { } /** - * Updates a store's homepage. Executing this method requires admin access. + * Updates the business info of an account. Executing this method requires admin access. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - updateHomepage( - params: Params$Resource$Accounts$Updatehomepage, + updateBusinessInfo( + params: Params$Resource$Accounts$Businessinfo$Updatebusinessinfo, options: StreamMethodOptions ): GaxiosPromise; - updateHomepage( - params?: Params$Resource$Accounts$Updatehomepage, + updateBusinessInfo( + params?: Params$Resource$Accounts$Businessinfo$Updatebusinessinfo, options?: MethodOptions - ): GaxiosPromise; - updateHomepage( - params: Params$Resource$Accounts$Updatehomepage, + ): GaxiosPromise; + updateBusinessInfo( + params: Params$Resource$Accounts$Businessinfo$Updatebusinessinfo, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - updateHomepage( - params: Params$Resource$Accounts$Updatehomepage, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + updateBusinessInfo( + params: Params$Resource$Accounts$Businessinfo$Updatebusinessinfo, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - updateHomepage( - params: Params$Resource$Accounts$Updatehomepage, - callback: BodyResponseCallback + updateBusinessInfo( + params: Params$Resource$Accounts$Businessinfo$Updatebusinessinfo, + callback: BodyResponseCallback ): void; - updateHomepage(callback: BodyResponseCallback): void; - updateHomepage( + updateBusinessInfo( + callback: BodyResponseCallback + ): void; + updateBusinessInfo( paramsOrCallback?: - | Params$Resource$Accounts$Updatehomepage - | BodyResponseCallback + | Params$Resource$Accounts$Businessinfo$Updatebusinessinfo + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { + ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Accounts$Updatehomepage; + {}) as Params$Resource$Accounts$Businessinfo$Updatebusinessinfo; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Accounts$Updatehomepage; + params = {} as Params$Resource$Accounts$Businessinfo$Updatebusinessinfo; options = {}; } @@ -2770,124 +2933,24 @@ export namespace merchantapi_accounts_v1beta { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } } - export interface Params$Resource$Accounts$Createandconfigure - extends StandardParameters { - /** - * Request body metadata - */ - requestBody?: Schema$CreateAndConfigureAccountRequest; - } - export interface Params$Resource$Accounts$Delete extends StandardParameters { - /** - * Required. The name of the account to delete. Format: `accounts/{account\}` - */ - name?: string; - } - export interface Params$Resource$Accounts$Get extends StandardParameters { - /** - * Required. The name of the account to retrieve. Format: `accounts/{account\}` - */ - name?: string; - } - export interface Params$Resource$Accounts$Getbusinessidentity - extends StandardParameters { - /** - * Required. The resource name of the business identity. Format: `accounts/{account\}/businessIdentity` - */ - name?: string; - } - export interface Params$Resource$Accounts$Getbusinessinfo + export interface Params$Resource$Accounts$Businessinfo$Getbusinessinfo extends StandardParameters { /** * Required. The resource name of the business info. Format: `accounts/{account\}/businessInfo` */ name?: string; } - export interface Params$Resource$Accounts$Gethomepage - extends StandardParameters { - /** - * Required. The name of the homepage to retrieve. Format: `accounts/{account\}/homepage` - */ - name?: string; - } - export interface Params$Resource$Accounts$Getshippingsettings - extends StandardParameters { - /** - * Required. The name of the shipping setting to retrieve. Format: `accounts/{account\}/shippingsetting` - */ - name?: string; - } - export interface Params$Resource$Accounts$List extends StandardParameters { - /** - * Optional. Returns only accounts that match the [filter](/merchant/api/guides/accounts/filter). For more details, see the [filter syntax reference](/merchant/api/guides/accounts/filter-syntax). - */ - filter?: string; - /** - * Optional. The maximum number of accounts to return. The service may return fewer than this value. If unspecified, at most 250 accounts are returned. The maximum value is 500; values above 500 are coerced to 500. - */ - pageSize?: number; - /** - * Optional. A page token, received from a previous `ListAccounts` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAccounts` must match the call that provided the page token. - */ - pageToken?: string; - } - export interface Params$Resource$Accounts$Listsubaccounts - extends StandardParameters { - /** - * Optional. The maximum number of accounts to return. The service may return fewer than this value. If unspecified, at most 250 accounts are returned. The maximum value is 500; values above 500 are coerced to 500. - */ - pageSize?: number; - /** - * Optional. A page token, received from a previous `ListAccounts` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAccounts` must match the call that provided the page token. - */ - pageToken?: string; - /** - * Required. The parent account. Format: `accounts/{account\}` - */ - provider?: string; - } - export interface Params$Resource$Accounts$Patch extends StandardParameters { - /** - * Identifier. The resource name of the account. Format: `accounts/{account\}` - */ - name?: string; - /** - * Required. List of fields being updated. - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$Account; - } - export interface Params$Resource$Accounts$Updatebusinessidentity - extends StandardParameters { - /** - * Identifier. The resource name of the business identity. Format: `accounts/{account\}/businessIdentity` - */ - name?: string; - /** - * Required. List of fields being updated. - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$BusinessIdentity; - } - export interface Params$Resource$Accounts$Updatebusinessinfo + export interface Params$Resource$Accounts$Businessinfo$Updatebusinessinfo extends StandardParameters { /** * Identifier. The resource name of the business info. Format: `accounts/{account\}/businessInfo` @@ -2903,81 +2966,68 @@ export namespace merchantapi_accounts_v1beta { */ requestBody?: Schema$BusinessInfo; } - export interface Params$Resource$Accounts$Updatehomepage - extends StandardParameters { - /** - * Identifier. The resource name of the store's homepage. Format: `accounts/{account\}/homepage` - */ - name?: string; - /** - * Required. List of fields being updated. - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$Homepage; - } - export class Resource$Accounts$Accounttax { + export class Resource$Accounts$Emailpreferences { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * Returns the tax rules that match the conditions of GetAccountTaxRequest + * Returns the email preferences for a Merchant Center account user. Use the name=accounts/x/users/me/emailPreferences alias to get preferences for the authenticated user. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Accounts$Accounttax$Get, + getEmailPreferences( + params: Params$Resource$Accounts$Emailpreferences$Getemailpreferences, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Accounts$Accounttax$Get, + getEmailPreferences( + params?: Params$Resource$Accounts$Emailpreferences$Getemailpreferences, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Accounts$Accounttax$Get, + ): GaxiosPromise; + getEmailPreferences( + params: Params$Resource$Accounts$Emailpreferences$Getemailpreferences, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Accounts$Accounttax$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + getEmailPreferences( + params: Params$Resource$Accounts$Emailpreferences$Getemailpreferences, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Accounts$Accounttax$Get, - callback: BodyResponseCallback + getEmailPreferences( + params: Params$Resource$Accounts$Emailpreferences$Getemailpreferences, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; - get( + getEmailPreferences( + callback: BodyResponseCallback + ): void; + getEmailPreferences( paramsOrCallback?: - | Params$Resource$Accounts$Accounttax$Get - | BodyResponseCallback + | Params$Resource$Accounts$Emailpreferences$Getemailpreferences + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { + ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Accounts$Accounttax$Get; + {}) as Params$Resource$Accounts$Emailpreferences$Getemailpreferences; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Accounts$Accounttax$Get; + params = + {} as Params$Resource$Accounts$Emailpreferences$Getemailpreferences; options = {}; } @@ -3005,160 +3055,70 @@ export namespace merchantapi_accounts_v1beta { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Lists the tax settings of the sub-accounts only in your Merchant Center account. This method can only be called on a multi-client account, otherwise it'll return an error. + * Updates the email preferences for a Merchant Center account user. MCA users should specify the MCA account rather than a sub-account of the MCA. Preferences which are not explicitly selected in the update mask will not be updated. It is invalid for updates to specify an UNCONFIRMED opt-in status value. Use the name=accounts/x/users/me/emailPreferences alias to update preferences for the authenticated user. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Accounts$Accounttax$List, + updateEmailPreferences( + params: Params$Resource$Accounts$Emailpreferences$Updateemailpreferences, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Accounts$Accounttax$List, + updateEmailPreferences( + params?: Params$Resource$Accounts$Emailpreferences$Updateemailpreferences, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Accounts$Accounttax$List, + ): GaxiosPromise; + updateEmailPreferences( + params: Params$Resource$Accounts$Emailpreferences$Updateemailpreferences, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Accounts$Accounttax$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Accounts$Accounttax$List, - callback: BodyResponseCallback - ): void; - list(callback: BodyResponseCallback): void; - list( - paramsOrCallback?: - | Params$Resource$Accounts$Accounttax$List - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Accounts$Accounttax$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Accounts$Accounttax$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://merchantapi.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/accounts/v1beta/{+parent}/accounttax').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['parent'], - pathParams: ['parent'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * Updates the tax settings of the account. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - patch( - params: Params$Resource$Accounts$Accounttax$Patch, - options: StreamMethodOptions - ): GaxiosPromise; - patch( - params?: Params$Resource$Accounts$Accounttax$Patch, - options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Accounts$Accounttax$Patch, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + updateEmailPreferences( + params: Params$Resource$Accounts$Emailpreferences$Updateemailpreferences, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Accounts$Accounttax$Patch, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + updateEmailPreferences( + params: Params$Resource$Accounts$Emailpreferences$Updateemailpreferences, + callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Accounts$Accounttax$Patch, - callback: BodyResponseCallback + updateEmailPreferences( + callback: BodyResponseCallback ): void; - patch(callback: BodyResponseCallback): void; - patch( + updateEmailPreferences( paramsOrCallback?: - | Params$Resource$Accounts$Accounttax$Patch - | BodyResponseCallback + | Params$Resource$Accounts$Emailpreferences$Updateemailpreferences + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { + ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Accounts$Accounttax$Patch; + {}) as Params$Resource$Accounts$Emailpreferences$Updateemailpreferences; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Accounts$Accounttax$Patch; + params = + {} as Params$Resource$Accounts$Emailpreferences$Updateemailpreferences; options = {}; } @@ -3186,53 +3146,38 @@ export namespace merchantapi_accounts_v1beta { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } } - export interface Params$Resource$Accounts$Accounttax$Get + export interface Params$Resource$Accounts$Emailpreferences$Getemailpreferences extends StandardParameters { /** - * Required. The name from which tax settings will be retrieved + * Required. The name of the `EmailPreferences` resource. Format: `accounts/{account\}/users/{email\}/emailPreferences` */ name?: string; } - export interface Params$Resource$Accounts$Accounttax$List - extends StandardParameters { - /** - * The maximum number of tax settings to return in the response, used for paging. - */ - pageSize?: number; - /** - * The token returned by the previous request. - */ - pageToken?: string; - /** - * Required. The parent, which owns this collection of account tax. Format: accounts/{account\} - */ - parent?: string; - } - export interface Params$Resource$Accounts$Accounttax$Patch + export interface Params$Resource$Accounts$Emailpreferences$Updateemailpreferences extends StandardParameters { /** - * Identifier. The name of the tax setting. Format: "{account_tax.name=accounts/{account\}\}" + * Identifier. The name of the EmailPreferences. The endpoint is only supported for the authenticated user. */ name?: string; /** - * The list of fields to be updated + * Required. List of fields being updated. */ updateMask?: string; /** * Request body metadata */ - requestBody?: Schema$AccountTax; + requestBody?: Schema$EmailPreferences; } export class Resource$Accounts$Homepage { @@ -3329,6 +3274,94 @@ export namespace merchantapi_accounts_v1beta { } } + /** + * Retrieves a store's homepage. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + getHomepage( + params: Params$Resource$Accounts$Homepage$Gethomepage, + options: StreamMethodOptions + ): GaxiosPromise; + getHomepage( + params?: Params$Resource$Accounts$Homepage$Gethomepage, + options?: MethodOptions + ): GaxiosPromise; + getHomepage( + params: Params$Resource$Accounts$Homepage$Gethomepage, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getHomepage( + params: Params$Resource$Accounts$Homepage$Gethomepage, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getHomepage( + params: Params$Resource$Accounts$Homepage$Gethomepage, + callback: BodyResponseCallback + ): void; + getHomepage(callback: BodyResponseCallback): void; + getHomepage( + paramsOrCallback?: + | Params$Resource$Accounts$Homepage$Gethomepage + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Accounts$Homepage$Gethomepage; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Accounts$Homepage$Gethomepage; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://merchantapi.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/accounts/v1beta/{+name}').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + /** * Unclaims a store's homepage. Executing this method requires admin access. * @@ -3416,6 +3449,94 @@ export namespace merchantapi_accounts_v1beta { return createAPIRequest(parameters); } } + + /** + * Updates a store's homepage. Executing this method requires admin access. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + updateHomepage( + params: Params$Resource$Accounts$Homepage$Updatehomepage, + options: StreamMethodOptions + ): GaxiosPromise; + updateHomepage( + params?: Params$Resource$Accounts$Homepage$Updatehomepage, + options?: MethodOptions + ): GaxiosPromise; + updateHomepage( + params: Params$Resource$Accounts$Homepage$Updatehomepage, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + updateHomepage( + params: Params$Resource$Accounts$Homepage$Updatehomepage, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + updateHomepage( + params: Params$Resource$Accounts$Homepage$Updatehomepage, + callback: BodyResponseCallback + ): void; + updateHomepage(callback: BodyResponseCallback): void; + updateHomepage( + paramsOrCallback?: + | Params$Resource$Accounts$Homepage$Updatehomepage + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Accounts$Homepage$Updatehomepage; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Accounts$Homepage$Updatehomepage; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://merchantapi.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/accounts/v1beta/{+name}').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'PATCH', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } } export interface Params$Resource$Accounts$Homepage$Claim @@ -3430,6 +3551,13 @@ export namespace merchantapi_accounts_v1beta { */ requestBody?: Schema$ClaimHomepageRequest; } + export interface Params$Resource$Accounts$Homepage$Gethomepage + extends StandardParameters { + /** + * Required. The name of the homepage to retrieve. Format: `accounts/{account\}/homepage` + */ + name?: string; + } export interface Params$Resource$Accounts$Homepage$Unclaim extends StandardParameters { /** @@ -3442,6 +3570,22 @@ export namespace merchantapi_accounts_v1beta { */ requestBody?: Schema$UnclaimHomepageRequest; } + export interface Params$Resource$Accounts$Homepage$Updatehomepage + extends StandardParameters { + /** + * Identifier. The resource name of the store's homepage. Format: `accounts/{account\}/homepage` + */ + name?: string; + /** + * Required. List of fields being updated. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Homepage; + } export class Resource$Accounts$Issues { context: APIRequestContext; @@ -4707,16 +4851,107 @@ export namespace merchantapi_accounts_v1beta { */ updateMask?: string; - /** - * Request body metadata - */ - requestBody?: Schema$Region; - } + /** + * Request body metadata + */ + requestBody?: Schema$Region; + } + + export class Resource$Accounts$Shippingsettings { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Retrieve shipping setting information. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + getShippingSettings( + params: Params$Resource$Accounts$Shippingsettings$Getshippingsettings, + options: StreamMethodOptions + ): GaxiosPromise; + getShippingSettings( + params?: Params$Resource$Accounts$Shippingsettings$Getshippingsettings, + options?: MethodOptions + ): GaxiosPromise; + getShippingSettings( + params: Params$Resource$Accounts$Shippingsettings$Getshippingsettings, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getShippingSettings( + params: Params$Resource$Accounts$Shippingsettings$Getshippingsettings, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getShippingSettings( + params: Params$Resource$Accounts$Shippingsettings$Getshippingsettings, + callback: BodyResponseCallback + ): void; + getShippingSettings( + callback: BodyResponseCallback + ): void; + getShippingSettings( + paramsOrCallback?: + | Params$Resource$Accounts$Shippingsettings$Getshippingsettings + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Accounts$Shippingsettings$Getshippingsettings; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Accounts$Shippingsettings$Getshippingsettings; + options = {}; + } - export class Resource$Accounts$Shippingsettings { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://merchantapi.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/accounts/v1beta/{+name}').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } } /** @@ -4807,6 +5042,13 @@ export namespace merchantapi_accounts_v1beta { } } + export interface Params$Resource$Accounts$Shippingsettings$Getshippingsettings + extends StandardParameters { + /** + * Required. The name of the shipping setting to retrieve. Format: `accounts/{account\}/shippingsetting` + */ + name?: string; + } export interface Params$Resource$Accounts$Shippingsettings$Insert extends StandardParameters { /** @@ -5026,7 +5268,7 @@ export namespace merchantapi_accounts_v1beta { export interface Params$Resource$Accounts$Termsofserviceagreementstates$Get extends StandardParameters { /** - * Required. The resource name of the terms of service version. Format: `accounts/{account\}/termsOfServiceAgreementState/{identifier\}` + * Required. The resource name of the terms of service version. Format: `accounts/{account\}/termsOfServiceAgreementState/{identifier\}` The identifier format is: `{TermsOfServiceKind\}-{country\}` */ name?: string; } @@ -5308,96 +5550,6 @@ export namespace merchantapi_accounts_v1beta { } } - /** - * Returns the email preferences for a Merchant Center account user. Use the name=accounts/x/users/me/emailPreferences alias to get preferences for the authenticated user. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - getEmailPreferences( - params: Params$Resource$Accounts$Users$Getemailpreferences, - options: StreamMethodOptions - ): GaxiosPromise; - getEmailPreferences( - params?: Params$Resource$Accounts$Users$Getemailpreferences, - options?: MethodOptions - ): GaxiosPromise; - getEmailPreferences( - params: Params$Resource$Accounts$Users$Getemailpreferences, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - getEmailPreferences( - params: Params$Resource$Accounts$Users$Getemailpreferences, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - getEmailPreferences( - params: Params$Resource$Accounts$Users$Getemailpreferences, - callback: BodyResponseCallback - ): void; - getEmailPreferences( - callback: BodyResponseCallback - ): void; - getEmailPreferences( - paramsOrCallback?: - | Params$Resource$Accounts$Users$Getemailpreferences - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Accounts$Users$Getemailpreferences; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Accounts$Users$Getemailpreferences; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://merchantapi.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/accounts/v1beta/{+name}').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - /** * Lists all users of a Merchant Center account. * @@ -5576,96 +5728,6 @@ export namespace merchantapi_accounts_v1beta { return createAPIRequest(parameters); } } - - /** - * Updates the email preferences for a Merchant Center account user. MCA users should specify the MCA account rather than a sub-account of the MCA. Preferences which are not explicitly selected in the update mask will not be updated. It is invalid for updates to specify an UNCONFIRMED opt-in status value. Use the name=accounts/x/users/me/emailPreferences alias to update preferences for the authenticated user. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - updateEmailPreferences( - params: Params$Resource$Accounts$Users$Updateemailpreferences, - options: StreamMethodOptions - ): GaxiosPromise; - updateEmailPreferences( - params?: Params$Resource$Accounts$Users$Updateemailpreferences, - options?: MethodOptions - ): GaxiosPromise; - updateEmailPreferences( - params: Params$Resource$Accounts$Users$Updateemailpreferences, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - updateEmailPreferences( - params: Params$Resource$Accounts$Users$Updateemailpreferences, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - updateEmailPreferences( - params: Params$Resource$Accounts$Users$Updateemailpreferences, - callback: BodyResponseCallback - ): void; - updateEmailPreferences( - callback: BodyResponseCallback - ): void; - updateEmailPreferences( - paramsOrCallback?: - | Params$Resource$Accounts$Users$Updateemailpreferences - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Accounts$Users$Updateemailpreferences; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Accounts$Users$Updateemailpreferences; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://merchantapi.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/accounts/v1beta/{+name}').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'PATCH', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } } export interface Params$Resource$Accounts$Users$Create @@ -5698,13 +5760,6 @@ export namespace merchantapi_accounts_v1beta { */ name?: string; } - export interface Params$Resource$Accounts$Users$Getemailpreferences - extends StandardParameters { - /** - * Required. The name of the `EmailPreferences` resource. Format: `accounts/{account\}/users/{email\}/emailPreferences` - */ - name?: string; - } export interface Params$Resource$Accounts$Users$List extends StandardParameters { /** @@ -5736,22 +5791,6 @@ export namespace merchantapi_accounts_v1beta { */ requestBody?: Schema$User; } - export interface Params$Resource$Accounts$Users$Updateemailpreferences - extends StandardParameters { - /** - * Identifier. The name of the EmailPreferences. The endpoint is only supported for the authenticated user. - */ - name?: string; - /** - * Required. List of fields being updated. - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$EmailPreferences; - } export class Resource$Termsofservice { context: APIRequestContext; diff --git a/src/apis/metastore/v1.ts b/src/apis/metastore/v1.ts index 3c2da91445..56ed90edda 100644 --- a/src/apis/metastore/v1.ts +++ b/src/apis/metastore/v1.ts @@ -393,6 +393,23 @@ export namespace metastore_v1 { */ subnetwork?: string | null; } + /** + * Metadata about a custom region. This is only populated if the region is a custom region. For single/multi regions, it will be empty. + */ + export interface Schema$CustomRegionMetadata { + /** + * The read-only regions for this custom region. + */ + optionalReadOnlyRegions?: string[] | null; + /** + * The read-write regions for this custom region. + */ + requiredReadWriteRegions?: string[] | null; + /** + * The Spanner witness region for this custom region. + */ + witnessRegion?: string | null; + } /** * A specification of the location of and metadata about a database dump from a relational database management system. */ @@ -757,6 +774,10 @@ export namespace metastore_v1 { * Metadata about the service in a location. */ export interface Schema$LocationMetadata { + /** + * Possible configurations supported if the current region is a custom region. + */ + customRegionMetadata?: Schema$CustomRegionMetadata[]; /** * The multi-region metadata if the current region is a multi-region. */ diff --git a/src/apis/metastore/v1alpha.ts b/src/apis/metastore/v1alpha.ts index 46a731f014..4a7d0b6bf2 100644 --- a/src/apis/metastore/v1alpha.ts +++ b/src/apis/metastore/v1alpha.ts @@ -411,6 +411,36 @@ export namespace metastore_v1alpha { */ subnetwork?: string | null; } + /** + * Custom configuration used to specify regions that the metastore service runs in. Currently only supported in the us multi-region. + */ + export interface Schema$CustomRegionConfig { + /** + * Optional. The list of read-only regions where the metastore service runs in. These regions should be part (or subset) of the multi-region. + */ + readOnlyRegions?: string[] | null; + /** + * Required. The list of read-write regions where the metastore service runs in. These regions should be part (or subset) of the multi-region. + */ + readWriteRegions?: string[] | null; + } + /** + * Metadata about a custom region. This is only populated if the region is a custom region. For single/multi regions, it will be empty. + */ + export interface Schema$CustomRegionMetadata { + /** + * The read-only regions for this custom region. + */ + optionalReadOnlyRegions?: string[] | null; + /** + * The read-write regions for this custom region. + */ + requiredReadWriteRegions?: string[] | null; + /** + * The Spanner witness region for this custom region. + */ + witnessRegion?: string | null; + } /** * A specification of the location of and metadata about a database dump from a relational database management system. */ @@ -793,6 +823,10 @@ export namespace metastore_v1alpha { * Metadata about the service in a location. */ export interface Schema$LocationMetadata { + /** + * Possible configurations supported if the current region is a custom region. + */ + customRegionMetadata?: Schema$CustomRegionMetadata[]; /** * The multi-region metadata if the current region is a multi-region. */ @@ -953,6 +987,16 @@ export namespace metastore_v1alpha { * Response message for DataprocMetastore.MoveTableToDatabase. */ export interface Schema$MoveTableToDatabaseResponse {} + /** + * The multi-region config for the Dataproc Metastore service. + */ + export interface Schema$MultiRegionConfig { + /** + * Output only. The list of root CA certificates that a gRPC client uses to connect to a multi-regional Dataproc Metastore service. + */ + certificates?: Schema$RootCACertificate[]; + customRegionConfig?: Schema$CustomRegionConfig; + } /** * 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. */ @@ -1144,6 +1188,19 @@ export namespace metastore_v1alpha { */ restoreType?: string | null; } + /** + * A gRPC client must install all root CA certificates to connect to a multi-regional Dataproc Metastore service and achieve failover. + */ + export interface Schema$RootCACertificate { + /** + * The root CA certificate in PEM format. The maximum length is 65536 bytes. + */ + certificate?: string | null; + /** + * The certificate expiration time in timestamp format. + */ + expirationTime?: string | null; + } /** * Represents the scaling configuration of a metastore service. */ @@ -1247,6 +1304,10 @@ export namespace metastore_v1alpha { * Output only. The metadata management activities of the metastore service. */ metadataManagementActivity?: Schema$MetadataManagementActivity; + /** + * Optional. Specifies the multi-region configuration information for the Hive metastore service. + */ + multiRegionConfig?: Schema$MultiRegionConfig; /** * Immutable. The relative resource name of the metastore service, in the following format:projects/{project_number\}/locations/{location_id\}/services/{service_id\}. */ diff --git a/src/apis/metastore/v1beta.ts b/src/apis/metastore/v1beta.ts index b88d386c26..f52d41dce6 100644 --- a/src/apis/metastore/v1beta.ts +++ b/src/apis/metastore/v1beta.ts @@ -411,6 +411,36 @@ export namespace metastore_v1beta { */ subnetwork?: string | null; } + /** + * Custom configuration used to specify regions that the metastore service runs in. Currently only supported in the us multi-region. + */ + export interface Schema$CustomRegionConfig { + /** + * Optional. The list of read-only regions where the metastore service runs in. These regions should be part (or subset) of the multi-region. + */ + readOnlyRegions?: string[] | null; + /** + * Required. The list of read-write regions where the metastore service runs in. These regions should be part (or subset) of the multi-region. + */ + readWriteRegions?: string[] | null; + } + /** + * Metadata about a custom region. This is only populated if the region is a custom region. For single/multi regions, it will be empty. + */ + export interface Schema$CustomRegionMetadata { + /** + * The read-only regions for this custom region. + */ + optionalReadOnlyRegions?: string[] | null; + /** + * The read-write regions for this custom region. + */ + requiredReadWriteRegions?: string[] | null; + /** + * The Spanner witness region for this custom region. + */ + witnessRegion?: string | null; + } /** * A specification of the location of and metadata about a database dump from a relational database management system. */ @@ -793,6 +823,10 @@ export namespace metastore_v1beta { * Metadata about the service in a location. */ export interface Schema$LocationMetadata { + /** + * Possible configurations supported if the current region is a custom region. + */ + customRegionMetadata?: Schema$CustomRegionMetadata[]; /** * The multi-region metadata if the current region is a multi-region. */ @@ -953,6 +987,16 @@ export namespace metastore_v1beta { * Response message for DataprocMetastore.MoveTableToDatabase. */ export interface Schema$MoveTableToDatabaseResponse {} + /** + * The multi-region config for the Dataproc Metastore service. + */ + export interface Schema$MultiRegionConfig { + /** + * Output only. The list of root CA certificates that a gRPC client uses to connect to a multi-regional Dataproc Metastore service. + */ + certificates?: Schema$RootCACertificate[]; + customRegionConfig?: Schema$CustomRegionConfig; + } /** * 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. */ @@ -1144,6 +1188,19 @@ export namespace metastore_v1beta { */ restoreType?: string | null; } + /** + * A gRPC client must install all root CA certificates to connect to a multi-regional Dataproc Metastore service and achieve failover. + */ + export interface Schema$RootCACertificate { + /** + * The root CA certificate in PEM format. The maximum length is 65536 bytes. + */ + certificate?: string | null; + /** + * The certificate expiration time in timestamp format. + */ + expirationTime?: string | null; + } /** * Represents the scaling configuration of a metastore service. */ @@ -1247,6 +1304,10 @@ export namespace metastore_v1beta { * Output only. The metadata management activities of the metastore service. */ metadataManagementActivity?: Schema$MetadataManagementActivity; + /** + * Optional. Specifies the multi-region configuration information for the Hive metastore service. + */ + multiRegionConfig?: Schema$MultiRegionConfig; /** * Immutable. The relative resource name of the metastore service, in the following format:projects/{project_number\}/locations/{location_id\}/services/{service_id\}. */ diff --git a/src/apis/migrationcenter/v1alpha1.ts b/src/apis/migrationcenter/v1alpha1.ts index 34cc4ecaac..cff27af8d1 100644 --- a/src/apis/migrationcenter/v1alpha1.ts +++ b/src/apis/migrationcenter/v1alpha1.ts @@ -2610,7 +2610,7 @@ export namespace migrationcenter_v1alpha1 { */ commitmentPlan?: string | null; /** - * Optional. License type of the OS image. + * Optional. License type for premium images (RHEL, RHEL for SAP, SLES, SLES for SAP, Windows Server). */ licenseType?: string | null; } diff --git a/src/apis/monitoring/v3.ts b/src/apis/monitoring/v3.ts index 7098a3609b..639a72f9d9 100644 --- a/src/apis/monitoring/v3.ts +++ b/src/apis/monitoring/v3.ts @@ -1584,7 +1584,7 @@ export namespace monitoring_v3 { */ mutationRecords?: Schema$MutationRecord[]; /** - * The full REST resource name for this channel. The format is: projects/[PROJECT_ID_OR_NUMBER]/notificationChannels/[CHANNEL_ID] The [CHANNEL_ID] is automatically assigned by the server on creation. + * Identifier. The full REST resource name for this channel. The format is: projects/[PROJECT_ID_OR_NUMBER]/notificationChannels/[CHANNEL_ID] The [CHANNEL_ID] is automatically assigned by the server on creation. */ name?: string | null; /** @@ -2088,6 +2088,10 @@ export namespace monitoring_v3 { * 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. */ export interface Schema$TimeSeries { + /** + * 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. + */ + description?: string | null; /** * 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. */ @@ -2109,7 +2113,7 @@ export namespace monitoring_v3 { */ resource?: Schema$MonitoredResource; /** - * 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. + * 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 or "1". */ unit?: string | null; /** @@ -5685,7 +5689,7 @@ export namespace monitoring_v3 { export interface Params$Resource$Projects$Notificationchannels$Patch extends StandardParameters { /** - * The full REST resource name for this channel. The format is: projects/[PROJECT_ID_OR_NUMBER]/notificationChannels/[CHANNEL_ID] The [CHANNEL_ID] is automatically assigned by the server on creation. + * Identifier. The full REST resource name for this channel. The format is: projects/[PROJECT_ID_OR_NUMBER]/notificationChannels/[CHANNEL_ID] The [CHANNEL_ID] is automatically assigned by the server on creation. */ name?: string; /** diff --git a/src/apis/networksecurity/v1.ts b/src/apis/networksecurity/v1.ts index 9efb09e6ff..5ac9cfba17 100644 --- a/src/apis/networksecurity/v1.ts +++ b/src/apis/networksecurity/v1.ts @@ -891,15 +891,15 @@ export namespace networksecurity_v1 { */ export interface Schema$MTLSPolicy { /** - * Required if the policy is to be used with Traffic Director. For external HTTPS load balancers it must be empty. Defines the mechanism to obtain the Certificate Authority certificate to validate the client certificate. + * 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. */ clientValidationCa?: Schema$ValidationCA[]; /** - * 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 external HTTPS load balancing. For Traffic Director it must be empty. + * 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. */ clientValidationMode?: string | null; /** - * 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 external HTTPS load balancers. + * 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. */ clientValidationTrustConfig?: string | null; } @@ -988,7 +988,7 @@ export namespace networksecurity_v1 { sources?: Schema$Source[]; } /** - * SecurityProfile is a resource that defines the behavior for one of many ProfileTypes. Next ID: 10 + * SecurityProfile is a resource that defines the behavior for one of many ProfileTypes. Next ID: 11 */ export interface Schema$SecurityProfile { /** @@ -1025,7 +1025,7 @@ export namespace networksecurity_v1 { updateTime?: string | null; } /** - * SecurityProfileGroup is a resource that defines the behavior for various ProfileTypes. Next ID: 9 + * SecurityProfileGroup is a resource that defines the behavior for various ProfileTypes. Next ID: 10 */ export interface Schema$SecurityProfileGroup { /** @@ -1058,11 +1058,11 @@ export namespace networksecurity_v1 { updateTime?: string | null; } /** - * 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 external HTTPS load balancers can be attached only to TargetHttpsProxy with an `EXTERNAL` or `EXTERNAL_MANAGED` load balancing scheme. Traffic Director compatible ServerTlsPolicies can be attached to EndpointPolicy and TargetHttpsProxy with Traffic Director `INTERNAL_SELF_MANAGED` load balancing scheme. + * 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. */ export interface Schema$ServerTlsPolicy { /** - * This field applies only for Traffic Director policies. It is must be set to false for external HTTPS 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. + * 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. */ allowOpen?: boolean | null; /** @@ -1078,7 +1078,7 @@ export namespace networksecurity_v1 { */ labels?: {[key: string]: string} | null; /** - * This field is required if the policy is used with external HTTPS 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. + * 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. */ mtlsPolicy?: Schema$MTLSPolicy; /** @@ -1086,7 +1086,7 @@ export namespace networksecurity_v1 { */ name?: string | null; /** - * Optional if policy is to be used with Traffic Director. For external HTTPS load balancer 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. + * 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. */ serverCertificate?: Schema$GoogleCloudNetworksecurityV1CertificateProvider; /** diff --git a/src/apis/networksecurity/v1beta1.ts b/src/apis/networksecurity/v1beta1.ts index d9db37e525..a38757b621 100644 --- a/src/apis/networksecurity/v1beta1.ts +++ b/src/apis/networksecurity/v1beta1.ts @@ -895,15 +895,15 @@ export namespace networksecurity_v1beta1 { */ export interface Schema$MTLSPolicy { /** - * Required if the policy is to be used with Traffic Director. For external HTTPS load balancers it must be empty. Defines the mechanism to obtain the Certificate Authority certificate to validate the client certificate. + * 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. */ clientValidationCa?: Schema$ValidationCA[]; /** - * 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 external HTTPS load balancing. For Traffic Director it must be empty. + * 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. */ clientValidationMode?: string | null; /** - * 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 external HTTPS load balancers. + * 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. */ clientValidationTrustConfig?: string | null; } @@ -992,7 +992,7 @@ export namespace networksecurity_v1beta1 { sources?: Schema$Source[]; } /** - * SecurityProfile is a resource that defines the behavior for one of many ProfileTypes. Next ID: 10 + * SecurityProfile is a resource that defines the behavior for one of many ProfileTypes. Next ID: 11 */ export interface Schema$SecurityProfile { /** @@ -1029,7 +1029,7 @@ export namespace networksecurity_v1beta1 { updateTime?: string | null; } /** - * SecurityProfileGroup is a resource that defines the behavior for various ProfileTypes. Next ID: 9 + * SecurityProfileGroup is a resource that defines the behavior for various ProfileTypes. Next ID: 10 */ export interface Schema$SecurityProfileGroup { /** @@ -1062,11 +1062,11 @@ export namespace networksecurity_v1beta1 { updateTime?: string | null; } /** - * 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 external HTTPS load balancers can be attached only to TargetHttpsProxy with an `EXTERNAL` or `EXTERNAL_MANAGED` load balancing scheme. Traffic Director compatible ServerTlsPolicies can be attached to EndpointPolicy and TargetHttpsProxy with Traffic Director `INTERNAL_SELF_MANAGED` load balancing scheme. + * 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. */ export interface Schema$ServerTlsPolicy { /** - * This field applies only for Traffic Director policies. It is must be set to false for external HTTPS 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. + * 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. */ allowOpen?: boolean | null; /** @@ -1082,7 +1082,7 @@ export namespace networksecurity_v1beta1 { */ labels?: {[key: string]: string} | null; /** - * This field is required if the policy is used with external HTTPS 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. + * 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. */ mtlsPolicy?: Schema$MTLSPolicy; /** @@ -1090,7 +1090,7 @@ export namespace networksecurity_v1beta1 { */ name?: string | null; /** - * Optional if policy is to be used with Traffic Director. For external HTTPS load balancer 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. + * 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. */ serverCertificate?: Schema$GoogleCloudNetworksecurityV1beta1CertificateProvider; /** diff --git a/src/apis/networkservices/v1.ts b/src/apis/networkservices/v1.ts index a705b10037..9ed5fae571 100644 --- a/src/apis/networkservices/v1.ts +++ b/src/apis/networkservices/v1.ts @@ -1717,7 +1717,7 @@ export namespace networkservices_v1 { */ meshes?: string[] | null; /** - * Required. Name of the TlsRoute resource. It matches pattern `projects/x/locations/global/tlsRoutes/tls_route_name\>`. + * Identifier. Name of the TlsRoute resource. It matches pattern `projects/x/locations/global/tlsRoutes/tls_route_name\>`. */ name?: string | null; /** @@ -3295,96 +3295,6 @@ export namespace networkservices_v1 { } } - /** - * Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - getIamPolicy( - params: Params$Resource$Projects$Locations$Endpointpolicies$Getiampolicy, - options: StreamMethodOptions - ): GaxiosPromise; - getIamPolicy( - params?: Params$Resource$Projects$Locations$Endpointpolicies$Getiampolicy, - options?: MethodOptions - ): GaxiosPromise; - getIamPolicy( - params: Params$Resource$Projects$Locations$Endpointpolicies$Getiampolicy, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Endpointpolicies$Getiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Endpointpolicies$Getiampolicy, - callback: BodyResponseCallback - ): void; - getIamPolicy(callback: BodyResponseCallback): void; - getIamPolicy( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Endpointpolicies$Getiampolicy - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Endpointpolicies$Getiampolicy; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Endpointpolicies$Getiampolicy; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://networkservices.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+resource}:getIamPolicy').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['resource'], - pathParams: ['resource'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - /** * Lists EndpointPolicies in a given project and location. * @@ -3569,60 +3479,128 @@ export namespace networkservices_v1 { return createAPIRequest(parameters); } } + } + export interface Params$Resource$Projects$Locations$Endpointpolicies$Create + extends StandardParameters { /** - * Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. + * Required. Short name of the EndpointPolicy resource to be created. E.g. "CustomECS". + */ + endpointPolicyId?: string; + /** + * Required. The parent resource of the EndpointPolicy. Must be in the format `projects/x/locations/global`. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$EndpointPolicy; + } + export interface Params$Resource$Projects$Locations$Endpointpolicies$Delete + extends StandardParameters { + /** + * Required. A name of the EndpointPolicy to delete. Must be in the format `projects/x/locations/global/endpointPolicies/x`. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Endpointpolicies$Get + extends StandardParameters { + /** + * Required. A name of the EndpointPolicy to get. Must be in the format `projects/x/locations/global/endpointPolicies/x`. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Endpointpolicies$List + extends StandardParameters { + /** + * Maximum number of EndpointPolicies to return per call. + */ + pageSize?: number; + /** + * The value returned by the last `ListEndpointPoliciesResponse` Indicates that this is a continuation of a prior `ListEndpointPolicies` call, and that the system should return the next page of data. + */ + pageToken?: string; + /** + * Required. The project and location from which the EndpointPolicies should be listed, specified in the format `projects/x/locations/global`. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Endpointpolicies$Patch + extends StandardParameters { + /** + * Required. Name of the EndpointPolicy resource. It matches pattern `projects/{project\}/locations/global/endpointPolicies/{endpoint_policy\}`. + */ + name?: string; + /** + * Optional. Field mask is used to specify the fields to be overwritten in the EndpointPolicy resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$EndpointPolicy; + } + + export class Resource$Projects$Locations$Gateways { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Creates a new Gateway in a given project and location. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - setIamPolicy( - params: Params$Resource$Projects$Locations$Endpointpolicies$Setiampolicy, + create( + params: Params$Resource$Projects$Locations$Gateways$Create, options: StreamMethodOptions ): GaxiosPromise; - setIamPolicy( - params?: Params$Resource$Projects$Locations$Endpointpolicies$Setiampolicy, + create( + params?: Params$Resource$Projects$Locations$Gateways$Create, options?: MethodOptions - ): GaxiosPromise; - setIamPolicy( - params: Params$Resource$Projects$Locations$Endpointpolicies$Setiampolicy, + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Gateways$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - setIamPolicy( - params: Params$Resource$Projects$Locations$Endpointpolicies$Setiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Gateways$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - setIamPolicy( - params: Params$Resource$Projects$Locations$Endpointpolicies$Setiampolicy, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Gateways$Create, + callback: BodyResponseCallback ): void; - setIamPolicy(callback: BodyResponseCallback): void; - setIamPolicy( + create(callback: BodyResponseCallback): void; + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Endpointpolicies$Setiampolicy - | BodyResponseCallback + | Params$Resource$Projects$Locations$Gateways$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { + ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Endpointpolicies$Setiampolicy; + {}) as Params$Resource$Projects$Locations$Gateways$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Endpointpolicies$Setiampolicy; + params = {} as Params$Resource$Projects$Locations$Gateways$Create; options = {}; } @@ -3636,7 +3614,7 @@ export namespace networkservices_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+resource}:setIamPolicy').replace( + url: (rootUrl + '/v1/{+parent}/gateways').replace( /([^:]\/)\/+/g, '$1' ), @@ -3646,1692 +3624,72 @@ export namespace networkservices_v1 { options ), params, - requiredParams: ['resource'], - pathParams: ['resource'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * 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. + * Deletes a single Gateway. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - testIamPermissions( - params: Params$Resource$Projects$Locations$Endpointpolicies$Testiampermissions, + delete( + params: Params$Resource$Projects$Locations$Gateways$Delete, options: StreamMethodOptions ): GaxiosPromise; - testIamPermissions( - params?: Params$Resource$Projects$Locations$Endpointpolicies$Testiampermissions, + delete( + params?: Params$Resource$Projects$Locations$Gateways$Delete, options?: MethodOptions - ): GaxiosPromise; - testIamPermissions( - params: Params$Resource$Projects$Locations$Endpointpolicies$Testiampermissions, + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Gateways$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - testIamPermissions( - params: Params$Resource$Projects$Locations$Endpointpolicies$Testiampermissions, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - testIamPermissions( - params: Params$Resource$Projects$Locations$Endpointpolicies$Testiampermissions, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Gateways$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - testIamPermissions( - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Gateways$Delete, + callback: BodyResponseCallback ): void; - testIamPermissions( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Endpointpolicies$Testiampermissions - | BodyResponseCallback + | Params$Resource$Projects$Locations$Gateways$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { + ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Endpointpolicies$Testiampermissions; + {}) as Params$Resource$Projects$Locations$Gateways$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Endpointpolicies$Testiampermissions; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://networkservices.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+resource}:testIamPermissions').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['resource'], - pathParams: ['resource'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Projects$Locations$Endpointpolicies$Create - extends StandardParameters { - /** - * Required. Short name of the EndpointPolicy resource to be created. E.g. "CustomECS". - */ - endpointPolicyId?: string; - /** - * Required. The parent resource of the EndpointPolicy. Must be in the format `projects/x/locations/global`. - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$EndpointPolicy; - } - export interface Params$Resource$Projects$Locations$Endpointpolicies$Delete - extends StandardParameters { - /** - * Required. A name of the EndpointPolicy to delete. Must be in the format `projects/x/locations/global/endpointPolicies/x`. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Endpointpolicies$Get - extends StandardParameters { - /** - * Required. A name of the EndpointPolicy to get. Must be in the format `projects/x/locations/global/endpointPolicies/x`. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Endpointpolicies$Getiampolicy - extends StandardParameters { - /** - * 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). - */ - 'options.requestedPolicyVersion'?: number; - /** - * REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - */ - resource?: string; - } - export interface Params$Resource$Projects$Locations$Endpointpolicies$List - extends StandardParameters { - /** - * Maximum number of EndpointPolicies to return per call. - */ - pageSize?: number; - /** - * The value returned by the last `ListEndpointPoliciesResponse` Indicates that this is a continuation of a prior `ListEndpointPolicies` call, and that the system should return the next page of data. - */ - pageToken?: string; - /** - * Required. The project and location from which the EndpointPolicies should be listed, specified in the format `projects/x/locations/global`. - */ - parent?: string; - } - export interface Params$Resource$Projects$Locations$Endpointpolicies$Patch - extends StandardParameters { - /** - * Required. Name of the EndpointPolicy resource. It matches pattern `projects/{project\}/locations/global/endpointPolicies/{endpoint_policy\}`. - */ - name?: string; - /** - * Optional. Field mask is used to specify the fields to be overwritten in the EndpointPolicy resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten. - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$EndpointPolicy; - } - export interface Params$Resource$Projects$Locations$Endpointpolicies$Setiampolicy - extends StandardParameters { - /** - * REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - */ - resource?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$SetIamPolicyRequest; - } - export interface Params$Resource$Projects$Locations$Endpointpolicies$Testiampermissions - extends StandardParameters { - /** - * REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - */ - resource?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$TestIamPermissionsRequest; - } - - export class Resource$Projects$Locations$Gateways { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * Creates a new Gateway in a given project and location. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - create( - params: Params$Resource$Projects$Locations$Gateways$Create, - options: StreamMethodOptions - ): GaxiosPromise; - create( - params?: Params$Resource$Projects$Locations$Gateways$Create, - options?: MethodOptions - ): GaxiosPromise; - create( - params: Params$Resource$Projects$Locations$Gateways$Create, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - create( - params: Params$Resource$Projects$Locations$Gateways$Create, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - create( - params: Params$Resource$Projects$Locations$Gateways$Create, - callback: BodyResponseCallback - ): void; - create(callback: BodyResponseCallback): void; - create( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Gateways$Create - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Gateways$Create; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Gateways$Create; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://networkservices.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+parent}/gateways').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['parent'], - pathParams: ['parent'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * Deletes a single Gateway. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - delete( - params: Params$Resource$Projects$Locations$Gateways$Delete, - options: StreamMethodOptions - ): GaxiosPromise; - delete( - params?: Params$Resource$Projects$Locations$Gateways$Delete, - options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Projects$Locations$Gateways$Delete, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Projects$Locations$Gateways$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Projects$Locations$Gateways$Delete, - callback: BodyResponseCallback - ): void; - delete(callback: BodyResponseCallback): void; - delete( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Gateways$Delete - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Gateways$Delete; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Gateways$Delete; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://networkservices.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * Gets details of a single Gateway. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - get( - params: Params$Resource$Projects$Locations$Gateways$Get, - options: StreamMethodOptions - ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Gateways$Get, - options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Gateways$Get, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Projects$Locations$Gateways$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Projects$Locations$Gateways$Get, - callback: BodyResponseCallback - ): void; - get(callback: BodyResponseCallback): void; - get( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Gateways$Get - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Gateways$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Gateways$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://networkservices.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - getIamPolicy( - params: Params$Resource$Projects$Locations$Gateways$Getiampolicy, - options: StreamMethodOptions - ): GaxiosPromise; - getIamPolicy( - params?: Params$Resource$Projects$Locations$Gateways$Getiampolicy, - options?: MethodOptions - ): GaxiosPromise; - getIamPolicy( - params: Params$Resource$Projects$Locations$Gateways$Getiampolicy, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Gateways$Getiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Gateways$Getiampolicy, - callback: BodyResponseCallback - ): void; - getIamPolicy(callback: BodyResponseCallback): void; - getIamPolicy( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Gateways$Getiampolicy - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Gateways$Getiampolicy; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Gateways$Getiampolicy; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://networkservices.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+resource}:getIamPolicy').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['resource'], - pathParams: ['resource'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * Lists Gateways in a given project and location. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - list( - params: Params$Resource$Projects$Locations$Gateways$List, - options: StreamMethodOptions - ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Gateways$List, - options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Gateways$List, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Projects$Locations$Gateways$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Projects$Locations$Gateways$List, - callback: BodyResponseCallback - ): void; - list(callback: BodyResponseCallback): void; - list( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Gateways$List - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Gateways$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Gateways$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://networkservices.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+parent}/gateways').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['parent'], - pathParams: ['parent'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * Updates the parameters of a single Gateway. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - patch( - params: Params$Resource$Projects$Locations$Gateways$Patch, - options: StreamMethodOptions - ): GaxiosPromise; - patch( - params?: Params$Resource$Projects$Locations$Gateways$Patch, - options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Projects$Locations$Gateways$Patch, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - patch( - params: Params$Resource$Projects$Locations$Gateways$Patch, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - patch( - params: Params$Resource$Projects$Locations$Gateways$Patch, - callback: BodyResponseCallback - ): void; - patch(callback: BodyResponseCallback): void; - patch( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Gateways$Patch - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Gateways$Patch; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Gateways$Patch; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://networkservices.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - setIamPolicy( - params: Params$Resource$Projects$Locations$Gateways$Setiampolicy, - options: StreamMethodOptions - ): GaxiosPromise; - setIamPolicy( - params?: Params$Resource$Projects$Locations$Gateways$Setiampolicy, - options?: MethodOptions - ): GaxiosPromise; - setIamPolicy( - params: Params$Resource$Projects$Locations$Gateways$Setiampolicy, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - setIamPolicy( - params: Params$Resource$Projects$Locations$Gateways$Setiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - setIamPolicy( - params: Params$Resource$Projects$Locations$Gateways$Setiampolicy, - callback: BodyResponseCallback - ): void; - setIamPolicy(callback: BodyResponseCallback): void; - setIamPolicy( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Gateways$Setiampolicy - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Gateways$Setiampolicy; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Gateways$Setiampolicy; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://networkservices.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+resource}:setIamPolicy').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['resource'], - pathParams: ['resource'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * 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. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - testIamPermissions( - params: Params$Resource$Projects$Locations$Gateways$Testiampermissions, - options: StreamMethodOptions - ): GaxiosPromise; - testIamPermissions( - params?: Params$Resource$Projects$Locations$Gateways$Testiampermissions, - options?: MethodOptions - ): GaxiosPromise; - testIamPermissions( - params: Params$Resource$Projects$Locations$Gateways$Testiampermissions, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - testIamPermissions( - params: Params$Resource$Projects$Locations$Gateways$Testiampermissions, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - testIamPermissions( - params: Params$Resource$Projects$Locations$Gateways$Testiampermissions, - callback: BodyResponseCallback - ): void; - testIamPermissions( - callback: BodyResponseCallback - ): void; - testIamPermissions( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Gateways$Testiampermissions - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Gateways$Testiampermissions; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Gateways$Testiampermissions; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://networkservices.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+resource}:testIamPermissions').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['resource'], - pathParams: ['resource'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Projects$Locations$Gateways$Create - extends StandardParameters { - /** - * Required. Short name of the Gateway resource to be created. - */ - gatewayId?: string; - /** - * Required. The parent resource of the Gateway. Must be in the format `projects/x/locations/x`. - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$Gateway; - } - export interface Params$Resource$Projects$Locations$Gateways$Delete - extends StandardParameters { - /** - * Required. A name of the Gateway to delete. Must be in the format `projects/x/locations/x/gateways/x`. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Gateways$Get - extends StandardParameters { - /** - * Required. A name of the Gateway to get. Must be in the format `projects/x/locations/x/gateways/x`. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Gateways$Getiampolicy - extends StandardParameters { - /** - * 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). - */ - 'options.requestedPolicyVersion'?: number; - /** - * REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - */ - resource?: string; - } - export interface Params$Resource$Projects$Locations$Gateways$List - extends StandardParameters { - /** - * Maximum number of Gateways to return per call. - */ - pageSize?: number; - /** - * The value returned by the last `ListGatewaysResponse` Indicates that this is a continuation of a prior `ListGateways` call, and that the system should return the next page of data. - */ - pageToken?: string; - /** - * Required. The project and location from which the Gateways should be listed, specified in the format `projects/x/locations/x`. - */ - parent?: string; - } - export interface Params$Resource$Projects$Locations$Gateways$Patch - extends StandardParameters { - /** - * Required. Name of the Gateway resource. It matches pattern `projects/x/locations/x/gateways/`. - */ - name?: string; - /** - * Optional. Field mask is used to specify the fields to be overwritten in the Gateway resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten. - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$Gateway; - } - export interface Params$Resource$Projects$Locations$Gateways$Setiampolicy - extends StandardParameters { - /** - * REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - */ - resource?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$SetIamPolicyRequest; - } - export interface Params$Resource$Projects$Locations$Gateways$Testiampermissions - extends StandardParameters { - /** - * REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - */ - resource?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$TestIamPermissionsRequest; - } - - export class Resource$Projects$Locations$Grpcroutes { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * Creates a new GrpcRoute in a given project and location. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - create( - params: Params$Resource$Projects$Locations$Grpcroutes$Create, - options: StreamMethodOptions - ): GaxiosPromise; - create( - params?: Params$Resource$Projects$Locations$Grpcroutes$Create, - options?: MethodOptions - ): GaxiosPromise; - create( - params: Params$Resource$Projects$Locations$Grpcroutes$Create, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - create( - params: Params$Resource$Projects$Locations$Grpcroutes$Create, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - create( - params: Params$Resource$Projects$Locations$Grpcroutes$Create, - callback: BodyResponseCallback - ): void; - create(callback: BodyResponseCallback): void; - create( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Grpcroutes$Create - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Grpcroutes$Create; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Grpcroutes$Create; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://networkservices.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+parent}/grpcRoutes').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['parent'], - pathParams: ['parent'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * Deletes a single GrpcRoute. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - delete( - params: Params$Resource$Projects$Locations$Grpcroutes$Delete, - options: StreamMethodOptions - ): GaxiosPromise; - delete( - params?: Params$Resource$Projects$Locations$Grpcroutes$Delete, - options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Projects$Locations$Grpcroutes$Delete, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Projects$Locations$Grpcroutes$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Projects$Locations$Grpcroutes$Delete, - callback: BodyResponseCallback - ): void; - delete(callback: BodyResponseCallback): void; - delete( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Grpcroutes$Delete - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Grpcroutes$Delete; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Grpcroutes$Delete; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://networkservices.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * Gets details of a single GrpcRoute. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - get( - params: Params$Resource$Projects$Locations$Grpcroutes$Get, - options: StreamMethodOptions - ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Grpcroutes$Get, - options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Grpcroutes$Get, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Projects$Locations$Grpcroutes$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Projects$Locations$Grpcroutes$Get, - callback: BodyResponseCallback - ): void; - get(callback: BodyResponseCallback): void; - get( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Grpcroutes$Get - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Grpcroutes$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Grpcroutes$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://networkservices.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * Lists GrpcRoutes in a given project and location. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - list( - params: Params$Resource$Projects$Locations$Grpcroutes$List, - options: StreamMethodOptions - ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Grpcroutes$List, - options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Grpcroutes$List, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Projects$Locations$Grpcroutes$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Projects$Locations$Grpcroutes$List, - callback: BodyResponseCallback - ): void; - list(callback: BodyResponseCallback): void; - list( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Grpcroutes$List - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Grpcroutes$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Grpcroutes$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://networkservices.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+parent}/grpcRoutes').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['parent'], - pathParams: ['parent'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * Updates the parameters of a single GrpcRoute. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - patch( - params: Params$Resource$Projects$Locations$Grpcroutes$Patch, - options: StreamMethodOptions - ): GaxiosPromise; - patch( - params?: Params$Resource$Projects$Locations$Grpcroutes$Patch, - options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Projects$Locations$Grpcroutes$Patch, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - patch( - params: Params$Resource$Projects$Locations$Grpcroutes$Patch, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - patch( - params: Params$Resource$Projects$Locations$Grpcroutes$Patch, - callback: BodyResponseCallback - ): void; - patch(callback: BodyResponseCallback): void; - patch( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Grpcroutes$Patch - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Grpcroutes$Patch; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Grpcroutes$Patch; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://networkservices.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Projects$Locations$Grpcroutes$Create - extends StandardParameters { - /** - * Required. Short name of the GrpcRoute resource to be created. - */ - grpcRouteId?: string; - /** - * Required. The parent resource of the GrpcRoute. Must be in the format `projects/x/locations/global`. - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GrpcRoute; - } - export interface Params$Resource$Projects$Locations$Grpcroutes$Delete - extends StandardParameters { - /** - * Required. A name of the GrpcRoute to delete. Must be in the format `projects/x/locations/global/grpcRoutes/x`. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Grpcroutes$Get - extends StandardParameters { - /** - * Required. A name of the GrpcRoute to get. Must be in the format `projects/x/locations/global/grpcRoutes/x`. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Grpcroutes$List - extends StandardParameters { - /** - * Maximum number of GrpcRoutes to return per call. - */ - pageSize?: number; - /** - * The value returned by the last `ListGrpcRoutesResponse` Indicates that this is a continuation of a prior `ListGrpcRoutes` call, and that the system should return the next page of data. - */ - pageToken?: string; - /** - * Required. The project and location from which the GrpcRoutes should be listed, specified in the format `projects/x/locations/global`. - */ - parent?: string; - } - export interface Params$Resource$Projects$Locations$Grpcroutes$Patch - extends StandardParameters { - /** - * Required. Name of the GrpcRoute resource. It matches pattern `projects/x/locations/global/grpcRoutes/` - */ - name?: string; - /** - * Optional. Field mask is used to specify the fields to be overwritten in the GrpcRoute resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten. - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GrpcRoute; - } - - export class Resource$Projects$Locations$Httproutes { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * Creates a new HttpRoute in a given project and location. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - create( - params: Params$Resource$Projects$Locations$Httproutes$Create, - options: StreamMethodOptions - ): GaxiosPromise; - create( - params?: Params$Resource$Projects$Locations$Httproutes$Create, - options?: MethodOptions - ): GaxiosPromise; - create( - params: Params$Resource$Projects$Locations$Httproutes$Create, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - create( - params: Params$Resource$Projects$Locations$Httproutes$Create, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - create( - params: Params$Resource$Projects$Locations$Httproutes$Create, - callback: BodyResponseCallback - ): void; - create(callback: BodyResponseCallback): void; - create( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Httproutes$Create - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Httproutes$Create; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Httproutes$Create; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://networkservices.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+parent}/httpRoutes').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['parent'], - pathParams: ['parent'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * Deletes a single HttpRoute. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - delete( - params: Params$Resource$Projects$Locations$Httproutes$Delete, - options: StreamMethodOptions - ): GaxiosPromise; - delete( - params?: Params$Resource$Projects$Locations$Httproutes$Delete, - options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Projects$Locations$Httproutes$Delete, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Projects$Locations$Httproutes$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Projects$Locations$Httproutes$Delete, - callback: BodyResponseCallback - ): void; - delete(callback: BodyResponseCallback): void; - delete( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Httproutes$Delete - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Httproutes$Delete; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Httproutes$Delete; + params = {} as Params$Resource$Projects$Locations$Gateways$Delete; options = {}; } @@ -5367,7 +3725,7 @@ export namespace networkservices_v1 { } /** - * Gets details of a single HttpRoute. + * Gets details of a single Gateway. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -5375,49 +3733,49 @@ export namespace networkservices_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Httproutes$Get, + params: Params$Resource$Projects$Locations$Gateways$Get, options: StreamMethodOptions ): GaxiosPromise; get( - params?: Params$Resource$Projects$Locations$Httproutes$Get, + params?: Params$Resource$Projects$Locations$Gateways$Get, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; get( - params: Params$Resource$Projects$Locations$Httproutes$Get, + params: Params$Resource$Projects$Locations$Gateways$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Httproutes$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Gateways$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Httproutes$Get, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Gateways$Get, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; + get(callback: BodyResponseCallback): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Httproutes$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Gateways$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { + ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Httproutes$Get; + {}) as Params$Resource$Projects$Locations$Gateways$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Httproutes$Get; + params = {} as Params$Resource$Projects$Locations$Gateways$Get; options = {}; } @@ -5443,17 +3801,17 @@ export namespace networkservices_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Lists HttpRoute in a given project and location. + * Lists Gateways in a given project and location. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -5461,54 +3819,54 @@ export namespace networkservices_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Httproutes$List, + params: Params$Resource$Projects$Locations$Gateways$List, options: StreamMethodOptions ): GaxiosPromise; list( - params?: Params$Resource$Projects$Locations$Httproutes$List, + params?: Params$Resource$Projects$Locations$Gateways$List, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; list( - params: Params$Resource$Projects$Locations$Httproutes$List, + params: Params$Resource$Projects$Locations$Gateways$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Httproutes$List, + params: Params$Resource$Projects$Locations$Gateways$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Httproutes$List, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Gateways$List, + callback: BodyResponseCallback ): void; - list(callback: BodyResponseCallback): void; + list(callback: BodyResponseCallback): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Httproutes$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Gateways$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Httproutes$List; + {}) as Params$Resource$Projects$Locations$Gateways$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Httproutes$List; + params = {} as Params$Resource$Projects$Locations$Gateways$List; options = {}; } @@ -5522,7 +3880,7 @@ export namespace networkservices_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/httpRoutes').replace( + url: (rootUrl + '/v1/{+parent}/gateways').replace( /([^:]\/)\/+/g, '$1' ), @@ -5537,17 +3895,17 @@ export namespace networkservices_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Updates the parameters of a single HttpRoute. + * Updates the parameters of a single Gateway. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -5555,31 +3913,31 @@ export namespace networkservices_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ patch( - params: Params$Resource$Projects$Locations$Httproutes$Patch, + params: Params$Resource$Projects$Locations$Gateways$Patch, options: StreamMethodOptions ): GaxiosPromise; patch( - params?: Params$Resource$Projects$Locations$Httproutes$Patch, + params?: Params$Resource$Projects$Locations$Gateways$Patch, options?: MethodOptions ): GaxiosPromise; patch( - params: Params$Resource$Projects$Locations$Httproutes$Patch, + params: Params$Resource$Projects$Locations$Gateways$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; patch( - params: Params$Resource$Projects$Locations$Httproutes$Patch, + params: Params$Resource$Projects$Locations$Gateways$Patch, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; patch( - params: Params$Resource$Projects$Locations$Httproutes$Patch, + params: Params$Resource$Projects$Locations$Gateways$Patch, callback: BodyResponseCallback ): void; patch(callback: BodyResponseCallback): void; patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Httproutes$Patch + | Params$Resource$Projects$Locations$Gateways$Patch | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -5592,12 +3950,12 @@ export namespace networkservices_v1 { | BodyResponseCallback ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Httproutes$Patch; + {}) as Params$Resource$Projects$Locations$Gateways$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Httproutes$Patch; + params = {} as Params$Resource$Projects$Locations$Gateways$Patch; options = {}; } @@ -5633,76 +3991,76 @@ export namespace networkservices_v1 { } } - export interface Params$Resource$Projects$Locations$Httproutes$Create + export interface Params$Resource$Projects$Locations$Gateways$Create extends StandardParameters { /** - * Required. Short name of the HttpRoute resource to be created. + * Required. Short name of the Gateway resource to be created. */ - httpRouteId?: string; + gatewayId?: string; /** - * Required. The parent resource of the HttpRoute. Must be in the format `projects/x/locations/global`. + * Required. The parent resource of the Gateway. Must be in the format `projects/x/locations/x`. */ parent?: string; /** * Request body metadata */ - requestBody?: Schema$HttpRoute; + requestBody?: Schema$Gateway; } - export interface Params$Resource$Projects$Locations$Httproutes$Delete + export interface Params$Resource$Projects$Locations$Gateways$Delete extends StandardParameters { /** - * Required. A name of the HttpRoute to delete. Must be in the format `projects/x/locations/global/httpRoutes/x`. + * Required. A name of the Gateway to delete. Must be in the format `projects/x/locations/x/gateways/x`. */ name?: string; } - export interface Params$Resource$Projects$Locations$Httproutes$Get + export interface Params$Resource$Projects$Locations$Gateways$Get extends StandardParameters { /** - * Required. A name of the HttpRoute to get. Must be in the format `projects/x/locations/global/httpRoutes/x`. + * Required. A name of the Gateway to get. Must be in the format `projects/x/locations/x/gateways/x`. */ name?: string; } - export interface Params$Resource$Projects$Locations$Httproutes$List + export interface Params$Resource$Projects$Locations$Gateways$List extends StandardParameters { /** - * Maximum number of HttpRoutes to return per call. + * Maximum number of Gateways to return per call. */ pageSize?: number; /** - * The value returned by the last `ListHttpRoutesResponse` Indicates that this is a continuation of a prior `ListHttpRoutes` call, and that the system should return the next page of data. + * The value returned by the last `ListGatewaysResponse` Indicates that this is a continuation of a prior `ListGateways` call, and that the system should return the next page of data. */ pageToken?: string; /** - * Required. The project and location from which the HttpRoutes should be listed, specified in the format `projects/x/locations/global`. + * Required. The project and location from which the Gateways should be listed, specified in the format `projects/x/locations/x`. */ parent?: string; } - export interface Params$Resource$Projects$Locations$Httproutes$Patch + export interface Params$Resource$Projects$Locations$Gateways$Patch extends StandardParameters { /** - * Required. Name of the HttpRoute resource. It matches pattern `projects/x/locations/global/httpRoutes/http_route_name\>`. + * Required. Name of the Gateway resource. It matches pattern `projects/x/locations/x/gateways/`. */ name?: string; /** - * Optional. Field mask is used to specify the fields to be overwritten in the HttpRoute resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten. + * Optional. Field mask is used to specify the fields to be overwritten in the Gateway resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten. */ updateMask?: string; /** * Request body metadata */ - requestBody?: Schema$HttpRoute; + requestBody?: Schema$Gateway; } - export class Resource$Projects$Locations$Lbrouteextensions { + export class Resource$Projects$Locations$Grpcroutes { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * Creates a new `LbRouteExtension` resource in a given project and location. + * Creates a new GrpcRoute in a given project and location. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -5710,31 +4068,31 @@ export namespace networkservices_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ create( - params: Params$Resource$Projects$Locations$Lbrouteextensions$Create, + params: Params$Resource$Projects$Locations$Grpcroutes$Create, options: StreamMethodOptions ): GaxiosPromise; create( - params?: Params$Resource$Projects$Locations$Lbrouteextensions$Create, + params?: Params$Resource$Projects$Locations$Grpcroutes$Create, options?: MethodOptions ): GaxiosPromise; create( - params: Params$Resource$Projects$Locations$Lbrouteextensions$Create, + params: Params$Resource$Projects$Locations$Grpcroutes$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; create( - params: Params$Resource$Projects$Locations$Lbrouteextensions$Create, + params: Params$Resource$Projects$Locations$Grpcroutes$Create, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; create( - params: Params$Resource$Projects$Locations$Lbrouteextensions$Create, + params: Params$Resource$Projects$Locations$Grpcroutes$Create, callback: BodyResponseCallback ): void; create(callback: BodyResponseCallback): void; create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Lbrouteextensions$Create + | Params$Resource$Projects$Locations$Grpcroutes$Create | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -5747,13 +4105,12 @@ export namespace networkservices_v1 { | BodyResponseCallback ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Lbrouteextensions$Create; + {}) as Params$Resource$Projects$Locations$Grpcroutes$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Lbrouteextensions$Create; + params = {} as Params$Resource$Projects$Locations$Grpcroutes$Create; options = {}; } @@ -5767,7 +4124,7 @@ export namespace networkservices_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/lbRouteExtensions').replace( + url: (rootUrl + '/v1/{+parent}/grpcRoutes').replace( /([^:]\/)\/+/g, '$1' ), @@ -5792,7 +4149,7 @@ export namespace networkservices_v1 { } /** - * Deletes the specified `LbRouteExtension` resource. + * Deletes a single GrpcRoute. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -5800,31 +4157,31 @@ export namespace networkservices_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Lbrouteextensions$Delete, + params: Params$Resource$Projects$Locations$Grpcroutes$Delete, options: StreamMethodOptions ): GaxiosPromise; delete( - params?: Params$Resource$Projects$Locations$Lbrouteextensions$Delete, + params?: Params$Resource$Projects$Locations$Grpcroutes$Delete, options?: MethodOptions ): GaxiosPromise; delete( - params: Params$Resource$Projects$Locations$Lbrouteextensions$Delete, + params: Params$Resource$Projects$Locations$Grpcroutes$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Lbrouteextensions$Delete, + params: Params$Resource$Projects$Locations$Grpcroutes$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Lbrouteextensions$Delete, + params: Params$Resource$Projects$Locations$Grpcroutes$Delete, callback: BodyResponseCallback ): void; delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Lbrouteextensions$Delete + | Params$Resource$Projects$Locations$Grpcroutes$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -5837,13 +4194,12 @@ export namespace networkservices_v1 { | BodyResponseCallback ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Lbrouteextensions$Delete; + {}) as Params$Resource$Projects$Locations$Grpcroutes$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Lbrouteextensions$Delete; + params = {} as Params$Resource$Projects$Locations$Grpcroutes$Delete; options = {}; } @@ -5879,7 +4235,7 @@ export namespace networkservices_v1 { } /** - * Gets details of the specified `LbRouteExtension` resource. + * Gets details of a single GrpcRoute. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -5887,49 +4243,49 @@ export namespace networkservices_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Lbrouteextensions$Get, + params: Params$Resource$Projects$Locations$Grpcroutes$Get, options: StreamMethodOptions ): GaxiosPromise; get( - params?: Params$Resource$Projects$Locations$Lbrouteextensions$Get, + params?: Params$Resource$Projects$Locations$Grpcroutes$Get, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; get( - params: Params$Resource$Projects$Locations$Lbrouteextensions$Get, + params: Params$Resource$Projects$Locations$Grpcroutes$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Lbrouteextensions$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Grpcroutes$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Lbrouteextensions$Get, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Grpcroutes$Get, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; + get(callback: BodyResponseCallback): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Lbrouteextensions$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Grpcroutes$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { + ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Lbrouteextensions$Get; + {}) as Params$Resource$Projects$Locations$Grpcroutes$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Lbrouteextensions$Get; + params = {} as Params$Resource$Projects$Locations$Grpcroutes$Get; options = {}; } @@ -5955,17 +4311,17 @@ export namespace networkservices_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Lists `LbRouteExtension` resources in a given project and location. + * Lists GrpcRoutes in a given project and location. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -5973,57 +4329,54 @@ export namespace networkservices_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Lbrouteextensions$List, + params: Params$Resource$Projects$Locations$Grpcroutes$List, options: StreamMethodOptions ): GaxiosPromise; list( - params?: Params$Resource$Projects$Locations$Lbrouteextensions$List, + params?: Params$Resource$Projects$Locations$Grpcroutes$List, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; list( - params: Params$Resource$Projects$Locations$Lbrouteextensions$List, + params: Params$Resource$Projects$Locations$Grpcroutes$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Lbrouteextensions$List, + params: Params$Resource$Projects$Locations$Grpcroutes$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Projects$Locations$Lbrouteextensions$List, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Grpcroutes$List, + callback: BodyResponseCallback ): void; + list(callback: BodyResponseCallback): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Lbrouteextensions$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Grpcroutes$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Lbrouteextensions$List; + {}) as Params$Resource$Projects$Locations$Grpcroutes$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Lbrouteextensions$List; + params = {} as Params$Resource$Projects$Locations$Grpcroutes$List; options = {}; } @@ -6037,7 +4390,7 @@ export namespace networkservices_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/lbRouteExtensions').replace( + url: (rootUrl + '/v1/{+parent}/grpcRoutes').replace( /([^:]\/)\/+/g, '$1' ), @@ -6052,19 +4405,17 @@ export namespace networkservices_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Updates the parameters of the specified `LbRouteExtension` resource. + * Updates the parameters of a single GrpcRoute. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -6072,31 +4423,31 @@ export namespace networkservices_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ patch( - params: Params$Resource$Projects$Locations$Lbrouteextensions$Patch, + params: Params$Resource$Projects$Locations$Grpcroutes$Patch, options: StreamMethodOptions ): GaxiosPromise; patch( - params?: Params$Resource$Projects$Locations$Lbrouteextensions$Patch, + params?: Params$Resource$Projects$Locations$Grpcroutes$Patch, options?: MethodOptions ): GaxiosPromise; patch( - params: Params$Resource$Projects$Locations$Lbrouteextensions$Patch, + params: Params$Resource$Projects$Locations$Grpcroutes$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; patch( - params: Params$Resource$Projects$Locations$Lbrouteextensions$Patch, + params: Params$Resource$Projects$Locations$Grpcroutes$Patch, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; patch( - params: Params$Resource$Projects$Locations$Lbrouteextensions$Patch, + params: Params$Resource$Projects$Locations$Grpcroutes$Patch, callback: BodyResponseCallback ): void; patch(callback: BodyResponseCallback): void; patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Lbrouteextensions$Patch + | Params$Resource$Projects$Locations$Grpcroutes$Patch | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -6109,13 +4460,12 @@ export namespace networkservices_v1 { | BodyResponseCallback ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Lbrouteextensions$Patch; + {}) as Params$Resource$Projects$Locations$Grpcroutes$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Lbrouteextensions$Patch; + params = {} as Params$Resource$Projects$Locations$Grpcroutes$Patch; options = {}; } @@ -6151,147 +4501,301 @@ export namespace networkservices_v1 { } } - export interface Params$Resource$Projects$Locations$Lbrouteextensions$Create + export interface Params$Resource$Projects$Locations$Grpcroutes$Create extends StandardParameters { /** - * Required. User-provided ID of the `LbRouteExtension` resource to be created. + * Required. Short name of the GrpcRoute resource to be created. */ - lbRouteExtensionId?: string; + grpcRouteId?: string; /** - * Required. The parent resource of the `LbRouteExtension` resource. Must be in the format `projects/{project\}/locations/{location\}`. + * Required. The parent resource of the GrpcRoute. Must be in the format `projects/x/locations/global`. */ parent?: string; - /** - * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server can ignore the request if it has already been completed. The server guarantees 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, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). - */ - requestId?: string; /** * Request body metadata */ - requestBody?: Schema$LbRouteExtension; + requestBody?: Schema$GrpcRoute; } - export interface Params$Resource$Projects$Locations$Lbrouteextensions$Delete + export interface Params$Resource$Projects$Locations$Grpcroutes$Delete extends StandardParameters { /** - * Required. The name of the `LbRouteExtension` resource to delete. Must be in the format `projects/{project\}/locations/{location\}/lbRouteExtensions/{lb_route_extension\}`. + * Required. A name of the GrpcRoute to delete. Must be in the format `projects/x/locations/global/grpcRoutes/x`. */ name?: string; - /** - * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server can ignore the request if it has already been completed. The server guarantees 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, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). - */ - requestId?: string; } - export interface Params$Resource$Projects$Locations$Lbrouteextensions$Get + export interface Params$Resource$Projects$Locations$Grpcroutes$Get extends StandardParameters { /** - * Required. A name of the `LbRouteExtension` resource to get. Must be in the format `projects/{project\}/locations/{location\}/lbRouteExtensions/{lb_route_extension\}`. + * Required. A name of the GrpcRoute to get. Must be in the format `projects/x/locations/global/grpcRoutes/x`. */ name?: string; } - export interface Params$Resource$Projects$Locations$Lbrouteextensions$List + export interface Params$Resource$Projects$Locations$Grpcroutes$List extends StandardParameters { /** - * Optional. Filtering results. - */ - filter?: string; - /** - * Optional. Hint for how to order the results. - */ - orderBy?: string; - /** - * Optional. Requested page size. The server might return fewer items than requested. If unspecified, the server picks an appropriate default. + * Maximum number of GrpcRoutes to return per call. */ pageSize?: number; /** - * Optional. A token identifying a page of results that the server returns. + * The value returned by the last `ListGrpcRoutesResponse` Indicates that this is a continuation of a prior `ListGrpcRoutes` call, and that the system should return the next page of data. */ pageToken?: string; /** - * Required. The project and location from which the `LbRouteExtension` resources are listed, specified in the following format: `projects/{project\}/locations/{location\}`. + * Required. The project and location from which the GrpcRoutes should be listed, specified in the format `projects/x/locations/global`. */ parent?: string; } - export interface Params$Resource$Projects$Locations$Lbrouteextensions$Patch + export interface Params$Resource$Projects$Locations$Grpcroutes$Patch extends StandardParameters { /** - * Required. Identifier. Name of the `LbRouteExtension` resource in the following format: `projects/{project\}/locations/{location\}/lbRouteExtensions/{lb_route_extension\}`. + * Required. Name of the GrpcRoute resource. It matches pattern `projects/x/locations/global/grpcRoutes/` */ name?: string; /** - * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server can ignore the request if it has already been completed. The server guarantees 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, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). - */ - requestId?: string; - /** - * Optional. Used to specify the fields to be overwritten in the `LbRouteExtension` resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field is overwritten if it is in the mask. If the user does not specify a mask, then all fields are overwritten. + * Optional. Field mask is used to specify the fields to be overwritten in the GrpcRoute resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten. */ updateMask?: string; /** * Request body metadata */ - requestBody?: Schema$LbRouteExtension; + requestBody?: Schema$GrpcRoute; } - export class Resource$Projects$Locations$Lbtrafficextensions { + export class Resource$Projects$Locations$Httproutes { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * Creates a new `LbTrafficExtension` resource in a given project and location. + * Creates a new HttpRoute in a given project and location. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + create( + params: Params$Resource$Projects$Locations$Httproutes$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Projects$Locations$Httproutes$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Httproutes$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Httproutes$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Httproutes$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Httproutes$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Httproutes$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Httproutes$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://networkservices.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/httpRoutes').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Deletes a single HttpRoute. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Projects$Locations$Httproutes$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Projects$Locations$Httproutes$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Httproutes$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Httproutes$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Httproutes$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Httproutes$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Httproutes$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Httproutes$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://networkservices.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets details of a single HttpRoute. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - create( - params: Params$Resource$Projects$Locations$Lbtrafficextensions$Create, + get( + params: Params$Resource$Projects$Locations$Httproutes$Get, options: StreamMethodOptions ): GaxiosPromise; - create( - params?: Params$Resource$Projects$Locations$Lbtrafficextensions$Create, + get( + params?: Params$Resource$Projects$Locations$Httproutes$Get, options?: MethodOptions - ): GaxiosPromise; - create( - params: Params$Resource$Projects$Locations$Lbtrafficextensions$Create, + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Httproutes$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Lbtrafficextensions$Create, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Httproutes$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Lbtrafficextensions$Create, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Httproutes$Get, + callback: BodyResponseCallback ): void; - create(callback: BodyResponseCallback): void; - create( + get(callback: BodyResponseCallback): void; + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Lbtrafficextensions$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Httproutes$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { + ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Lbtrafficextensions$Create; + {}) as Params$Resource$Projects$Locations$Httproutes$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Lbtrafficextensions$Create; + params = {} as Params$Resource$Projects$Locations$Httproutes$Get; options = {}; } @@ -6305,83 +4809,84 @@ export namespace networkservices_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/lbTrafficExtensions').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Deletes the specified `LbTrafficExtension` resource. + * Lists HttpRoute in a given project and location. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - delete( - params: Params$Resource$Projects$Locations$Lbtrafficextensions$Delete, + list( + params: Params$Resource$Projects$Locations$Httproutes$List, options: StreamMethodOptions ): GaxiosPromise; - delete( - params?: Params$Resource$Projects$Locations$Lbtrafficextensions$Delete, + list( + params?: Params$Resource$Projects$Locations$Httproutes$List, options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Projects$Locations$Lbtrafficextensions$Delete, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Httproutes$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Lbtrafficextensions$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Httproutes$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Lbtrafficextensions$Delete, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Httproutes$List, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + list(callback: BodyResponseCallback): void; + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Lbtrafficextensions$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Httproutes$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { + ): + | void + | GaxiosPromise + | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Lbtrafficextensions$Delete; + {}) as Params$Resource$Projects$Locations$Httproutes$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Lbtrafficextensions$Delete; + params = {} as Params$Resource$Projects$Locations$Httproutes$List; options = {}; } @@ -6395,83 +4900,82 @@ export namespace networkservices_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1/{+parent}/httpRoutes').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Gets details of the specified `LbTrafficExtension` resource. + * Updates the parameters of a single HttpRoute. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Lbtrafficextensions$Get, + patch( + params: Params$Resource$Projects$Locations$Httproutes$Patch, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Lbtrafficextensions$Get, + patch( + params?: Params$Resource$Projects$Locations$Httproutes$Patch, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Lbtrafficextensions$Get, + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Httproutes$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Lbtrafficextensions$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Httproutes$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Lbtrafficextensions$Get, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Httproutes$Patch, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; - get( + patch(callback: BodyResponseCallback): void; + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Lbtrafficextensions$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Httproutes$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { + ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Lbtrafficextensions$Get; + {}) as Params$Resource$Projects$Locations$Httproutes$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Lbtrafficextensions$Get; + params = {} as Params$Resource$Projects$Locations$Httproutes$Patch; options = {}; } @@ -6486,7 +4990,7 @@ export namespace networkservices_v1 { options: Object.assign( { url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'PATCH', apiVersion: '', }, options @@ -6497,75 +5001,137 @@ export namespace networkservices_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } + } + + export interface Params$Resource$Projects$Locations$Httproutes$Create + extends StandardParameters { + /** + * Required. Short name of the HttpRoute resource to be created. + */ + httpRouteId?: string; + /** + * Required. The parent resource of the HttpRoute. Must be in the format `projects/x/locations/global`. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$HttpRoute; + } + export interface Params$Resource$Projects$Locations$Httproutes$Delete + extends StandardParameters { + /** + * Required. A name of the HttpRoute to delete. Must be in the format `projects/x/locations/global/httpRoutes/x`. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Httproutes$Get + extends StandardParameters { + /** + * Required. A name of the HttpRoute to get. Must be in the format `projects/x/locations/global/httpRoutes/x`. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Httproutes$List + extends StandardParameters { + /** + * Maximum number of HttpRoutes to return per call. + */ + pageSize?: number; + /** + * The value returned by the last `ListHttpRoutesResponse` Indicates that this is a continuation of a prior `ListHttpRoutes` call, and that the system should return the next page of data. + */ + pageToken?: string; + /** + * Required. The project and location from which the HttpRoutes should be listed, specified in the format `projects/x/locations/global`. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Httproutes$Patch + extends StandardParameters { + /** + * Required. Name of the HttpRoute resource. It matches pattern `projects/x/locations/global/httpRoutes/http_route_name\>`. + */ + name?: string; + /** + * Optional. Field mask is used to specify the fields to be overwritten in the HttpRoute resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$HttpRoute; + } + + export class Resource$Projects$Locations$Lbrouteextensions { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } /** - * Lists `LbTrafficExtension` resources in a given project and location. + * Creates a new `LbRouteExtension` resource in a given project and location. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Lbtrafficextensions$List, + create( + params: Params$Resource$Projects$Locations$Lbrouteextensions$Create, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Lbtrafficextensions$List, + create( + params?: Params$Resource$Projects$Locations$Lbrouteextensions$Create, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Lbtrafficextensions$List, + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Lbrouteextensions$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Lbtrafficextensions$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Projects$Locations$Lbtrafficextensions$List, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Lbrouteextensions$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Lbrouteextensions$Create, + callback: BodyResponseCallback ): void; - list( + create(callback: BodyResponseCallback): void; + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Lbtrafficextensions$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Lbrouteextensions$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { + ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Lbtrafficextensions$List; + {}) as Params$Resource$Projects$Locations$Lbrouteextensions$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Lbtrafficextensions$List; + {} as Params$Resource$Projects$Locations$Lbrouteextensions$Create; options = {}; } @@ -6579,11 +5145,11 @@ export namespace networkservices_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/lbTrafficExtensions').replace( + url: (rootUrl + '/v1/{+parent}/lbRouteExtensions').replace( /([^:]\/)\/+/g, '$1' ), - method: 'GET', + method: 'POST', apiVersion: '', }, options @@ -6594,51 +5160,49 @@ export namespace networkservices_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Updates the parameters of the specified `LbTrafficExtension` resource. + * Deletes the specified `LbRouteExtension` resource. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - patch( - params: Params$Resource$Projects$Locations$Lbtrafficextensions$Patch, + delete( + params: Params$Resource$Projects$Locations$Lbrouteextensions$Delete, options: StreamMethodOptions ): GaxiosPromise; - patch( - params?: Params$Resource$Projects$Locations$Lbtrafficextensions$Patch, + delete( + params?: Params$Resource$Projects$Locations$Lbrouteextensions$Delete, options?: MethodOptions ): GaxiosPromise; - patch( - params: Params$Resource$Projects$Locations$Lbtrafficextensions$Patch, + delete( + params: Params$Resource$Projects$Locations$Lbrouteextensions$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Lbtrafficextensions$Patch, + delete( + params: Params$Resource$Projects$Locations$Lbrouteextensions$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Lbtrafficextensions$Patch, + delete( + params: Params$Resource$Projects$Locations$Lbrouteextensions$Delete, callback: BodyResponseCallback ): void; - patch(callback: BodyResponseCallback): void; - patch( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Lbtrafficextensions$Patch + | Params$Resource$Projects$Locations$Lbrouteextensions$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -6651,13 +5215,13 @@ export namespace networkservices_v1 { | BodyResponseCallback ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Lbtrafficextensions$Patch; + {}) as Params$Resource$Projects$Locations$Lbrouteextensions$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Lbtrafficextensions$Patch; + {} as Params$Resource$Projects$Locations$Lbrouteextensions$Delete; options = {}; } @@ -6672,7 +5236,7 @@ export namespace networkservices_v1 { options: Object.assign( { url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + method: 'DELETE', apiVersion: '', }, options @@ -6691,148 +5255,59 @@ export namespace networkservices_v1 { return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Projects$Locations$Lbtrafficextensions$Create - extends StandardParameters { - /** - * Required. User-provided ID of the `LbTrafficExtension` resource to be created. - */ - lbTrafficExtensionId?: string; - /** - * Required. The parent resource of the `LbTrafficExtension` resource. Must be in the format `projects/{project\}/locations/{location\}`. - */ - parent?: string; - /** - * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server can ignore the request if it has already been completed. The server guarantees 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, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). - */ - requestId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$LbTrafficExtension; - } - export interface Params$Resource$Projects$Locations$Lbtrafficextensions$Delete - extends StandardParameters { - /** - * Required. The name of the `LbTrafficExtension` resource to delete. Must be in the format `projects/{project\}/locations/{location\}/lbTrafficExtensions/{lb_traffic_extension\}`. - */ - name?: string; - /** - * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server can ignore the request if it has already been completed. The server guarantees 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, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). - */ - requestId?: string; - } - export interface Params$Resource$Projects$Locations$Lbtrafficextensions$Get - extends StandardParameters { - /** - * Required. A name of the `LbTrafficExtension` resource to get. Must be in the format `projects/{project\}/locations/{location\}/lbTrafficExtensions/{lb_traffic_extension\}`. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Lbtrafficextensions$List - extends StandardParameters { - /** - * Optional. Filtering results. - */ - filter?: string; - /** - * Optional. Hint for how to order the results. - */ - orderBy?: string; - /** - * Optional. Requested page size. The server might return fewer items than requested. If unspecified, the server picks an appropriate default. - */ - pageSize?: number; - /** - * Optional. A token identifying a page of results that the server returns. - */ - pageToken?: string; - /** - * Required. The project and location from which the `LbTrafficExtension` resources are listed, specified in the following format: `projects/{project\}/locations/{location\}`. - */ - parent?: string; - } - export interface Params$Resource$Projects$Locations$Lbtrafficextensions$Patch - extends StandardParameters { - /** - * Required. Identifier. Name of the `LbTrafficExtension` resource in the following format: `projects/{project\}/locations/{location\}/lbTrafficExtensions/{lb_traffic_extension\}`. - */ - name?: string; - /** - * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server can ignore the request if it has already been completed. The server guarantees 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, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). - */ - requestId?: string; - /** - * Optional. Used to specify the fields to be overwritten in the `LbTrafficExtension` resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field is overwritten if it is in the mask. If the user does not specify a mask, then all fields are overwritten. - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$LbTrafficExtension; - } - - export class Resource$Projects$Locations$Meshes { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Creates a new Mesh in a given project and location. + * Gets details of the specified `LbRouteExtension` resource. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - create( - params: Params$Resource$Projects$Locations$Meshes$Create, + get( + params: Params$Resource$Projects$Locations$Lbrouteextensions$Get, options: StreamMethodOptions ): GaxiosPromise; - create( - params?: Params$Resource$Projects$Locations$Meshes$Create, + get( + params?: Params$Resource$Projects$Locations$Lbrouteextensions$Get, options?: MethodOptions - ): GaxiosPromise; - create( - params: Params$Resource$Projects$Locations$Meshes$Create, + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Lbrouteextensions$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Meshes$Create, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Lbrouteextensions$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Meshes$Create, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Lbrouteextensions$Get, + callback: BodyResponseCallback ): void; - create(callback: BodyResponseCallback): void; - create( + get(callback: BodyResponseCallback): void; + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Meshes$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Lbrouteextensions$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { + ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Meshes$Create; + {}) as Params$Resource$Projects$Locations$Lbrouteextensions$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Meshes$Create; + params = {} as Params$Resource$Projects$Locations$Lbrouteextensions$Get; options = {}; } @@ -6846,82 +5321,87 @@ export namespace networkservices_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/meshes').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Deletes a single Mesh. + * Lists `LbRouteExtension` resources in a given project and location. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - delete( - params: Params$Resource$Projects$Locations$Meshes$Delete, + list( + params: Params$Resource$Projects$Locations$Lbrouteextensions$List, options: StreamMethodOptions ): GaxiosPromise; - delete( - params?: Params$Resource$Projects$Locations$Meshes$Delete, + list( + params?: Params$Resource$Projects$Locations$Lbrouteextensions$List, options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Projects$Locations$Meshes$Delete, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Lbrouteextensions$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Meshes$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Lbrouteextensions$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Meshes$Delete, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Lbrouteextensions$List, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + list( + callback: BodyResponseCallback + ): void; + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Meshes$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Lbrouteextensions$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { + ): + | void + | GaxiosPromise + | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Meshes$Delete; + {}) as Params$Resource$Projects$Locations$Lbrouteextensions$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Meshes$Delete; + params = + {} as Params$Resource$Projects$Locations$Lbrouteextensions$List; options = {}; } @@ -6935,79 +5415,85 @@ export namespace networkservices_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1/{+parent}/lbRouteExtensions').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Gets details of a single Mesh. + * Updates the parameters of the specified `LbRouteExtension` resource. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Meshes$Get, + patch( + params: Params$Resource$Projects$Locations$Lbrouteextensions$Patch, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Meshes$Get, + patch( + params?: Params$Resource$Projects$Locations$Lbrouteextensions$Patch, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Meshes$Get, + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Lbrouteextensions$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Meshes$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Lbrouteextensions$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Meshes$Get, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Lbrouteextensions$Patch, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; - get( + patch(callback: BodyResponseCallback): void; + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Meshes$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Lbrouteextensions$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { + ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Meshes$Get; + {}) as Params$Resource$Projects$Locations$Lbrouteextensions$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Meshes$Get; + params = + {} as Params$Resource$Projects$Locations$Lbrouteextensions$Patch; options = {}; } @@ -7022,7 +5508,7 @@ export namespace networkservices_v1 { options: Object.assign( { url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'PATCH', apiVersion: '', }, options @@ -7033,67 +5519,157 @@ export namespace networkservices_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } + } + + export interface Params$Resource$Projects$Locations$Lbrouteextensions$Create + extends StandardParameters { + /** + * Required. User-provided ID of the `LbRouteExtension` resource to be created. + */ + lbRouteExtensionId?: string; + /** + * Required. The parent resource of the `LbRouteExtension` resource. Must be in the format `projects/{project\}/locations/{location\}`. + */ + parent?: string; + /** + * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server can ignore the request if it has already been completed. The server guarantees 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, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$LbRouteExtension; + } + export interface Params$Resource$Projects$Locations$Lbrouteextensions$Delete + extends StandardParameters { + /** + * Required. The name of the `LbRouteExtension` resource to delete. Must be in the format `projects/{project\}/locations/{location\}/lbRouteExtensions/{lb_route_extension\}`. + */ + name?: string; + /** + * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server can ignore the request if it has already been completed. The server guarantees 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, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + } + export interface Params$Resource$Projects$Locations$Lbrouteextensions$Get + extends StandardParameters { + /** + * Required. A name of the `LbRouteExtension` resource to get. Must be in the format `projects/{project\}/locations/{location\}/lbRouteExtensions/{lb_route_extension\}`. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Lbrouteextensions$List + extends StandardParameters { + /** + * Optional. Filtering results. + */ + filter?: string; + /** + * Optional. Hint for how to order the results. + */ + orderBy?: string; + /** + * Optional. Requested page size. The server might return fewer items than requested. If unspecified, the server picks an appropriate default. + */ + pageSize?: number; + /** + * Optional. A token identifying a page of results that the server returns. + */ + pageToken?: string; + /** + * Required. The project and location from which the `LbRouteExtension` resources are listed, specified in the following format: `projects/{project\}/locations/{location\}`. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Lbrouteextensions$Patch + extends StandardParameters { + /** + * Required. Identifier. Name of the `LbRouteExtension` resource in the following format: `projects/{project\}/locations/{location\}/lbRouteExtensions/{lb_route_extension\}`. + */ + name?: string; + /** + * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server can ignore the request if it has already been completed. The server guarantees 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, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * Optional. Used to specify the fields to be overwritten in the `LbRouteExtension` resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field is overwritten if it is in the mask. If the user does not specify a mask, then all fields are overwritten. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$LbRouteExtension; + } + + export class Resource$Projects$Locations$Lbtrafficextensions { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } /** - * Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. + * Creates a new `LbTrafficExtension` resource in a given project and location. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - getIamPolicy( - params: Params$Resource$Projects$Locations$Meshes$Getiampolicy, + create( + params: Params$Resource$Projects$Locations$Lbtrafficextensions$Create, options: StreamMethodOptions ): GaxiosPromise; - getIamPolicy( - params?: Params$Resource$Projects$Locations$Meshes$Getiampolicy, + create( + params?: Params$Resource$Projects$Locations$Lbtrafficextensions$Create, options?: MethodOptions - ): GaxiosPromise; - getIamPolicy( - params: Params$Resource$Projects$Locations$Meshes$Getiampolicy, + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Lbtrafficextensions$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Meshes$Getiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Lbtrafficextensions$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Meshes$Getiampolicy, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Lbtrafficextensions$Create, + callback: BodyResponseCallback ): void; - getIamPolicy(callback: BodyResponseCallback): void; - getIamPolicy( + create(callback: BodyResponseCallback): void; + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Meshes$Getiampolicy - | BodyResponseCallback + | Params$Resource$Projects$Locations$Lbtrafficextensions$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { + ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Meshes$Getiampolicy; + {}) as Params$Resource$Projects$Locations$Lbtrafficextensions$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Meshes$Getiampolicy; + params = + {} as Params$Resource$Projects$Locations$Lbtrafficextensions$Create; options = {}; } @@ -7107,85 +5683,83 @@ export namespace networkservices_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+resource}:getIamPolicy').replace( + url: (rootUrl + '/v1/{+parent}/lbTrafficExtensions').replace( /([^:]\/)\/+/g, '$1' ), - method: 'GET', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['resource'], - pathParams: ['resource'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Lists Meshes in a given project and location. + * Deletes the specified `LbTrafficExtension` resource. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Meshes$List, + delete( + params: Params$Resource$Projects$Locations$Lbtrafficextensions$Delete, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Meshes$List, + delete( + params?: Params$Resource$Projects$Locations$Lbtrafficextensions$Delete, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Meshes$List, + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Lbtrafficextensions$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Meshes$List, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Lbtrafficextensions$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Meshes$List, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Lbtrafficextensions$Delete, + callback: BodyResponseCallback ): void; - list(callback: BodyResponseCallback): void; - list( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Meshes$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Lbtrafficextensions$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { + ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Meshes$List; + {}) as Params$Resource$Projects$Locations$Lbtrafficextensions$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Meshes$List; + params = + {} as Params$Resource$Projects$Locations$Lbtrafficextensions$Delete; options = {}; } @@ -7199,82 +5773,83 @@ export namespace networkservices_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/meshes').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Updates the parameters of a single Mesh. + * Gets details of the specified `LbTrafficExtension` resource. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - patch( - params: Params$Resource$Projects$Locations$Meshes$Patch, + get( + params: Params$Resource$Projects$Locations$Lbtrafficextensions$Get, options: StreamMethodOptions ): GaxiosPromise; - patch( - params?: Params$Resource$Projects$Locations$Meshes$Patch, + get( + params?: Params$Resource$Projects$Locations$Lbtrafficextensions$Get, options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Projects$Locations$Meshes$Patch, + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Lbtrafficextensions$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Meshes$Patch, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Lbtrafficextensions$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Meshes$Patch, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Lbtrafficextensions$Get, + callback: BodyResponseCallback ): void; - patch(callback: BodyResponseCallback): void; - patch( + get(callback: BodyResponseCallback): void; + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Meshes$Patch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Lbtrafficextensions$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { + ): + | void + | GaxiosPromise + | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Meshes$Patch; + {}) as Params$Resource$Projects$Locations$Lbtrafficextensions$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Meshes$Patch; + params = + {} as Params$Resource$Projects$Locations$Lbtrafficextensions$Get; options = {}; } @@ -7289,7 +5864,7 @@ export namespace networkservices_v1 { options: Object.assign( { url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + method: 'GET', apiVersion: '', }, options @@ -7300,67 +5875,75 @@ export namespace networkservices_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. + * Lists `LbTrafficExtension` resources in a given project and location. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - setIamPolicy( - params: Params$Resource$Projects$Locations$Meshes$Setiampolicy, + list( + params: Params$Resource$Projects$Locations$Lbtrafficextensions$List, options: StreamMethodOptions ): GaxiosPromise; - setIamPolicy( - params?: Params$Resource$Projects$Locations$Meshes$Setiampolicy, + list( + params?: Params$Resource$Projects$Locations$Lbtrafficextensions$List, options?: MethodOptions - ): GaxiosPromise; - setIamPolicy( - params: Params$Resource$Projects$Locations$Meshes$Setiampolicy, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Lbtrafficextensions$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - setIamPolicy( - params: Params$Resource$Projects$Locations$Meshes$Setiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Lbtrafficextensions$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - setIamPolicy( - params: Params$Resource$Projects$Locations$Meshes$Setiampolicy, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Lbtrafficextensions$List, + callback: BodyResponseCallback ): void; - setIamPolicy(callback: BodyResponseCallback): void; - setIamPolicy( + list( + callback: BodyResponseCallback + ): void; + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Meshes$Setiampolicy - | BodyResponseCallback + | Params$Resource$Projects$Locations$Lbtrafficextensions$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { + ): + | void + | GaxiosPromise + | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Meshes$Setiampolicy; + {}) as Params$Resource$Projects$Locations$Lbtrafficextensions$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Meshes$Setiampolicy; + params = + {} as Params$Resource$Projects$Locations$Lbtrafficextensions$List; options = {}; } @@ -7374,90 +5957,85 @@ export namespace networkservices_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+resource}:setIamPolicy').replace( + url: (rootUrl + '/v1/{+parent}/lbTrafficExtensions').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['resource'], - pathParams: ['resource'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * 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. + * Updates the parameters of the specified `LbTrafficExtension` resource. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - testIamPermissions( - params: Params$Resource$Projects$Locations$Meshes$Testiampermissions, + patch( + params: Params$Resource$Projects$Locations$Lbtrafficextensions$Patch, options: StreamMethodOptions ): GaxiosPromise; - testIamPermissions( - params?: Params$Resource$Projects$Locations$Meshes$Testiampermissions, + patch( + params?: Params$Resource$Projects$Locations$Lbtrafficextensions$Patch, options?: MethodOptions - ): GaxiosPromise; - testIamPermissions( - params: Params$Resource$Projects$Locations$Meshes$Testiampermissions, + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Lbtrafficextensions$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - testIamPermissions( - params: Params$Resource$Projects$Locations$Meshes$Testiampermissions, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - testIamPermissions( - params: Params$Resource$Projects$Locations$Meshes$Testiampermissions, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Lbtrafficextensions$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - testIamPermissions( - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Lbtrafficextensions$Patch, + callback: BodyResponseCallback ): void; - testIamPermissions( + patch(callback: BodyResponseCallback): void; + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Meshes$Testiampermissions - | BodyResponseCallback + | Params$Resource$Projects$Locations$Lbtrafficextensions$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { + ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Meshes$Testiampermissions; + {}) as Params$Resource$Projects$Locations$Lbtrafficextensions$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Meshes$Testiampermissions; + {} as Params$Resource$Projects$Locations$Lbtrafficextensions$Patch; options = {}; } @@ -7471,186 +6049,168 @@ export namespace networkservices_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+resource}:testIamPermissions').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', apiVersion: '', }, options ), - params, - requiredParams: ['resource'], - pathParams: ['resource'], + params, + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } } - export interface Params$Resource$Projects$Locations$Meshes$Create + export interface Params$Resource$Projects$Locations$Lbtrafficextensions$Create extends StandardParameters { /** - * Required. Short name of the Mesh resource to be created. + * Required. User-provided ID of the `LbTrafficExtension` resource to be created. */ - meshId?: string; + lbTrafficExtensionId?: string; /** - * Required. The parent resource of the Mesh. Must be in the format `projects/x/locations/global`. + * Required. The parent resource of the `LbTrafficExtension` resource. Must be in the format `projects/{project\}/locations/{location\}`. */ parent?: string; + /** + * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server can ignore the request if it has already been completed. The server guarantees 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, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; /** * Request body metadata */ - requestBody?: Schema$Mesh; + requestBody?: Schema$LbTrafficExtension; } - export interface Params$Resource$Projects$Locations$Meshes$Delete + export interface Params$Resource$Projects$Locations$Lbtrafficextensions$Delete extends StandardParameters { /** - * Required. A name of the Mesh to delete. Must be in the format `projects/x/locations/global/meshes/x`. + * Required. The name of the `LbTrafficExtension` resource to delete. Must be in the format `projects/{project\}/locations/{location\}/lbTrafficExtensions/{lb_traffic_extension\}`. */ name?: string; + /** + * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server can ignore the request if it has already been completed. The server guarantees 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, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; } - export interface Params$Resource$Projects$Locations$Meshes$Get + export interface Params$Resource$Projects$Locations$Lbtrafficextensions$Get extends StandardParameters { /** - * Required. A name of the Mesh to get. Must be in the format `projects/x/locations/global/meshes/x`. + * Required. A name of the `LbTrafficExtension` resource to get. Must be in the format `projects/{project\}/locations/{location\}/lbTrafficExtensions/{lb_traffic_extension\}`. */ name?: string; } - export interface Params$Resource$Projects$Locations$Meshes$Getiampolicy + export interface Params$Resource$Projects$Locations$Lbtrafficextensions$List extends StandardParameters { /** - * 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). + * Optional. Filtering results. */ - 'options.requestedPolicyVersion'?: number; + filter?: string; /** - * REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + * Optional. Hint for how to order the results. */ - resource?: string; - } - export interface Params$Resource$Projects$Locations$Meshes$List - extends StandardParameters { + orderBy?: string; /** - * Maximum number of Meshes to return per call. + * Optional. Requested page size. The server might return fewer items than requested. If unspecified, the server picks an appropriate default. */ pageSize?: number; /** - * The value returned by the last `ListMeshesResponse` Indicates that this is a continuation of a prior `ListMeshes` call, and that the system should return the next page of data. + * Optional. A token identifying a page of results that the server returns. */ pageToken?: string; /** - * Required. The project and location from which the Meshes should be listed, specified in the format `projects/x/locations/global`. + * Required. The project and location from which the `LbTrafficExtension` resources are listed, specified in the following format: `projects/{project\}/locations/{location\}`. */ parent?: string; } - export interface Params$Resource$Projects$Locations$Meshes$Patch + export interface Params$Resource$Projects$Locations$Lbtrafficextensions$Patch extends StandardParameters { /** - * Required. Name of the Mesh resource. It matches pattern `projects/x/locations/global/meshes/`. + * Required. Identifier. Name of the `LbTrafficExtension` resource in the following format: `projects/{project\}/locations/{location\}/lbTrafficExtensions/{lb_traffic_extension\}`. */ name?: string; /** - * Optional. Field mask is used to specify the fields to be overwritten in the Mesh resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten. - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$Mesh; - } - export interface Params$Resource$Projects$Locations$Meshes$Setiampolicy - extends StandardParameters { - /** - * REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - */ - resource?: string; - - /** - * Request body metadata + * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server can ignore the request if it has already been completed. The server guarantees 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, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ - requestBody?: Schema$SetIamPolicyRequest; - } - export interface Params$Resource$Projects$Locations$Meshes$Testiampermissions - extends StandardParameters { + requestId?: string; /** - * REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + * Optional. Used to specify the fields to be overwritten in the `LbTrafficExtension` resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field is overwritten if it is in the mask. If the user does not specify a mask, then all fields are overwritten. */ - resource?: string; + updateMask?: string; /** * Request body metadata */ - requestBody?: Schema$TestIamPermissionsRequest; + requestBody?: Schema$LbTrafficExtension; } - export class Resource$Projects$Locations$Operations { + export class Resource$Projects$Locations$Meshes { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * 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`. + * Creates a new Mesh in a given project and location. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - cancel( - params: Params$Resource$Projects$Locations$Operations$Cancel, + create( + params: Params$Resource$Projects$Locations$Meshes$Create, options: StreamMethodOptions ): GaxiosPromise; - cancel( - params?: Params$Resource$Projects$Locations$Operations$Cancel, + create( + params?: Params$Resource$Projects$Locations$Meshes$Create, options?: MethodOptions - ): GaxiosPromise; - cancel( - params: Params$Resource$Projects$Locations$Operations$Cancel, + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Meshes$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Projects$Locations$Operations$Cancel, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Meshes$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Projects$Locations$Operations$Cancel, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Meshes$Create, + callback: BodyResponseCallback ): void; - cancel(callback: BodyResponseCallback): void; - cancel( + create(callback: BodyResponseCallback): void; + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Operations$Cancel - | BodyResponseCallback + | Params$Resource$Projects$Locations$Meshes$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { + ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Operations$Cancel; + {}) as Params$Resource$Projects$Locations$Meshes$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Operations$Cancel; + params = {} as Params$Resource$Projects$Locations$Meshes$Create; options = {}; } @@ -7664,29 +6224,32 @@ export namespace networkservices_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1/{+parent}/meshes').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * 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`. + * Deletes a single Mesh. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -7694,49 +6257,135 @@ export namespace networkservices_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Operations$Delete, + params: Params$Resource$Projects$Locations$Meshes$Delete, options: StreamMethodOptions ): GaxiosPromise; delete( - params?: Params$Resource$Projects$Locations$Operations$Delete, + params?: Params$Resource$Projects$Locations$Meshes$Delete, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; delete( - params: Params$Resource$Projects$Locations$Operations$Delete, + params: Params$Resource$Projects$Locations$Meshes$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Operations$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Meshes$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Operations$Delete, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Meshes$Delete, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; + delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Operations$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Meshes$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Meshes$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Meshes$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://networkservices.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets details of a single Mesh. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Projects$Locations$Meshes$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Meshes$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Meshes$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Meshes$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Meshes$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Meshes$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { + ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Operations$Delete; + {}) as Params$Resource$Projects$Locations$Meshes$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Operations$Delete; + params = {} as Params$Resource$Projects$Locations$Meshes$Get; options = {}; } @@ -7751,7 +6400,7 @@ export namespace networkservices_v1 { options: Object.assign( { url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + method: 'GET', apiVersion: '', }, options @@ -7762,67 +6411,70 @@ export namespace networkservices_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * 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. + * Lists Meshes in a given project and location. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Operations$Get, + list( + params: Params$Resource$Projects$Locations$Meshes$List, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Operations$Get, + list( + params?: Params$Resource$Projects$Locations$Meshes$List, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Operations$Get, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Meshes$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Operations$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Meshes$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Operations$Get, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Meshes$List, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; - get( + list(callback: BodyResponseCallback): void; + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Operations$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Meshes$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { + ): + | void + | GaxiosPromise + | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Operations$Get; + {}) as Params$Resource$Projects$Locations$Meshes$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Operations$Get; + params = {} as Params$Resource$Projects$Locations$Meshes$List; options = {}; } @@ -7836,84 +6488,82 @@ export namespace networkservices_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1/{+parent}/meshes').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + * Updates the parameters of a single Mesh. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Operations$List, + patch( + params: Params$Resource$Projects$Locations$Meshes$Patch, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Operations$List, + patch( + params?: Params$Resource$Projects$Locations$Meshes$Patch, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Operations$List, + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Meshes$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Operations$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Meshes$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Operations$List, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Meshes$Patch, + callback: BodyResponseCallback ): void; - list(callback: BodyResponseCallback): void; - list( + patch(callback: BodyResponseCallback): void; + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Operations$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Meshes$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { + ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Operations$List; + {}) as Params$Resource$Projects$Locations$Meshes$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Operations$List; + params = {} as Params$Resource$Projects$Locations$Meshes$Patch; options = {}; } @@ -7927,11 +6577,8 @@ export namespace networkservices_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}/operations').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', apiVersion: '', }, options @@ -7942,121 +6589,222 @@ export namespace networkservices_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } } - export interface Params$Resource$Projects$Locations$Operations$Cancel + export interface Params$Resource$Projects$Locations$Meshes$Create extends StandardParameters { /** - * The name of the operation resource to be cancelled. + * Required. Short name of the Mesh resource to be created. */ - name?: string; + meshId?: string; + /** + * Required. The parent resource of the Mesh. Must be in the format `projects/x/locations/global`. + */ + parent?: string; /** * Request body metadata */ - requestBody?: Schema$CancelOperationRequest; + requestBody?: Schema$Mesh; } - export interface Params$Resource$Projects$Locations$Operations$Delete + export interface Params$Resource$Projects$Locations$Meshes$Delete extends StandardParameters { /** - * The name of the operation resource to be deleted. + * Required. A name of the Mesh to delete. Must be in the format `projects/x/locations/global/meshes/x`. */ name?: string; } - export interface Params$Resource$Projects$Locations$Operations$Get + export interface Params$Resource$Projects$Locations$Meshes$Get extends StandardParameters { /** - * The name of the operation resource. + * Required. A name of the Mesh to get. Must be in the format `projects/x/locations/global/meshes/x`. */ name?: string; } - export interface Params$Resource$Projects$Locations$Operations$List + export interface Params$Resource$Projects$Locations$Meshes$List extends StandardParameters { /** - * The standard list filter. + * Maximum number of Meshes to return per call. */ - filter?: string; + pageSize?: number; /** - * The name of the operation's parent resource. + * The value returned by the last `ListMeshesResponse` Indicates that this is a continuation of a prior `ListMeshes` call, and that the system should return the next page of data. + */ + pageToken?: string; + /** + * Required. The project and location from which the Meshes should be listed, specified in the format `projects/x/locations/global`. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Meshes$Patch + extends StandardParameters { + /** + * Required. Name of the Mesh resource. It matches pattern `projects/x/locations/global/meshes/`. */ name?: string; /** - * The standard list page size. + * Optional. Field mask is used to specify the fields to be overwritten in the Mesh resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten. */ - pageSize?: number; + updateMask?: string; + /** - * The standard list page token. + * Request body metadata */ - pageToken?: string; + requestBody?: Schema$Mesh; } - export class Resource$Projects$Locations$Servicebindings { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; + export class Resource$Projects$Locations$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * 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`. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + cancel( + params: Params$Resource$Projects$Locations$Operations$Cancel, + options: StreamMethodOptions + ): GaxiosPromise; + cancel( + params?: Params$Resource$Projects$Locations$Operations$Cancel, + options?: MethodOptions + ): GaxiosPromise; + cancel( + params: Params$Resource$Projects$Locations$Operations$Cancel, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancel( + params: Params$Resource$Projects$Locations$Operations$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancel( + params: Params$Resource$Projects$Locations$Operations$Cancel, + callback: BodyResponseCallback + ): void; + cancel(callback: BodyResponseCallback): void; + cancel( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Operations$Cancel + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Operations$Cancel; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Operations$Cancel; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://networkservices.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } } /** - * Creates a new ServiceBinding in a given project and location. + * 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`. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - create( - params: Params$Resource$Projects$Locations$Servicebindings$Create, + delete( + params: Params$Resource$Projects$Locations$Operations$Delete, options: StreamMethodOptions ): GaxiosPromise; - create( - params?: Params$Resource$Projects$Locations$Servicebindings$Create, + delete( + params?: Params$Resource$Projects$Locations$Operations$Delete, options?: MethodOptions - ): GaxiosPromise; - create( - params: Params$Resource$Projects$Locations$Servicebindings$Create, + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Servicebindings$Create, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Operations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Servicebindings$Create, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Operations$Delete, + callback: BodyResponseCallback ): void; - create(callback: BodyResponseCallback): void; - create( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Servicebindings$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Operations$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { + ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Servicebindings$Create; + {}) as Params$Resource$Projects$Locations$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Servicebindings$Create; + params = {} as Params$Resource$Projects$Locations$Operations$Delete; options = {}; } @@ -8070,64 +6818,61 @@ export namespace networkservices_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/serviceBindings').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Deletes a single ServiceBinding. + * 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. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - delete( - params: Params$Resource$Projects$Locations$Servicebindings$Delete, + get( + params: Params$Resource$Projects$Locations$Operations$Get, options: StreamMethodOptions ): GaxiosPromise; - delete( - params?: Params$Resource$Projects$Locations$Servicebindings$Delete, + get( + params?: Params$Resource$Projects$Locations$Operations$Get, options?: MethodOptions ): GaxiosPromise; - delete( - params: Params$Resource$Projects$Locations$Servicebindings$Delete, + get( + params: Params$Resource$Projects$Locations$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Servicebindings$Delete, + get( + params: Params$Resource$Projects$Locations$Operations$Get, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Servicebindings$Delete, + get( + params: Params$Resource$Projects$Locations$Operations$Get, callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + get(callback: BodyResponseCallback): void; + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Servicebindings$Delete + | Params$Resource$Projects$Locations$Operations$Get | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -8140,13 +6885,12 @@ export namespace networkservices_v1 { | BodyResponseCallback ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Servicebindings$Delete; + {}) as Params$Resource$Projects$Locations$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Servicebindings$Delete; + params = {} as Params$Resource$Projects$Locations$Operations$Get; options = {}; } @@ -8161,7 +6905,7 @@ export namespace networkservices_v1 { options: Object.assign( { url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + method: 'GET', apiVersion: '', }, options @@ -8182,57 +6926,62 @@ export namespace networkservices_v1 { } /** - * Gets details of a single ServiceBinding. + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Servicebindings$Get, + list( + params: Params$Resource$Projects$Locations$Operations$List, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Servicebindings$Get, + list( + params?: Params$Resource$Projects$Locations$Operations$List, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Servicebindings$Get, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Servicebindings$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Operations$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Servicebindings$Get, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Operations$List, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; - get( + list(callback: BodyResponseCallback): void; + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Servicebindings$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Operations$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { + ): + | void + | GaxiosPromise + | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Servicebindings$Get; + {}) as Params$Resource$Projects$Locations$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Servicebindings$Get; + params = {} as Params$Resource$Projects$Locations$Operations$List; options = {}; } @@ -8246,7 +6995,10 @@ export namespace networkservices_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1/{+name}/operations').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'GET', apiVersion: '', }, @@ -8258,68 +7010,121 @@ export namespace networkservices_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } + } + export interface Params$Resource$Projects$Locations$Operations$Cancel + extends StandardParameters { /** - * Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. + * The name of the operation resource to be cancelled. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$CancelOperationRequest; + } + export interface Params$Resource$Projects$Locations$Operations$Delete + extends StandardParameters { + /** + * The name of the operation resource to be deleted. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Operations$Get + extends StandardParameters { + /** + * The name of the operation resource. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Operations$List + extends StandardParameters { + /** + * The standard list filter. + */ + filter?: string; + /** + * The name of the operation's parent resource. + */ + name?: string; + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. + */ + pageToken?: string; + } + + export class Resource$Projects$Locations$Servicebindings { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Creates a new ServiceBinding in a given project and location. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - getIamPolicy( - params: Params$Resource$Projects$Locations$Servicebindings$Getiampolicy, + create( + params: Params$Resource$Projects$Locations$Servicebindings$Create, options: StreamMethodOptions ): GaxiosPromise; - getIamPolicy( - params?: Params$Resource$Projects$Locations$Servicebindings$Getiampolicy, + create( + params?: Params$Resource$Projects$Locations$Servicebindings$Create, options?: MethodOptions - ): GaxiosPromise; - getIamPolicy( - params: Params$Resource$Projects$Locations$Servicebindings$Getiampolicy, + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Servicebindings$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Servicebindings$Getiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Servicebindings$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Servicebindings$Getiampolicy, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Servicebindings$Create, + callback: BodyResponseCallback ): void; - getIamPolicy(callback: BodyResponseCallback): void; - getIamPolicy( + create(callback: BodyResponseCallback): void; + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Servicebindings$Getiampolicy - | BodyResponseCallback + | Params$Resource$Projects$Locations$Servicebindings$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { + ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Servicebindings$Getiampolicy; + {}) as Params$Resource$Projects$Locations$Servicebindings$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Servicebindings$Getiampolicy; + {} as Params$Resource$Projects$Locations$Servicebindings$Create; options = {}; } @@ -8333,89 +7138,83 @@ export namespace networkservices_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+resource}:getIamPolicy').replace( + url: (rootUrl + '/v1/{+parent}/serviceBindings').replace( /([^:]\/)\/+/g, '$1' ), - method: 'GET', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['resource'], - pathParams: ['resource'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Lists ServiceBinding in a given project and location. + * Deletes a single ServiceBinding. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Servicebindings$List, + delete( + params: Params$Resource$Projects$Locations$Servicebindings$Delete, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Servicebindings$List, + delete( + params?: Params$Resource$Projects$Locations$Servicebindings$Delete, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Servicebindings$List, + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Servicebindings$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Servicebindings$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Projects$Locations$Servicebindings$List, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Servicebindings$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Servicebindings$Delete, + callback: BodyResponseCallback ): void; - list( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Servicebindings$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Servicebindings$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { + ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Servicebindings$List; + {}) as Params$Resource$Projects$Locations$Servicebindings$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Servicebindings$List; + params = + {} as Params$Resource$Projects$Locations$Servicebindings$Delete; options = {}; } @@ -8429,83 +7228,79 @@ export namespace networkservices_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/serviceBindings').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. + * Gets details of a single ServiceBinding. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - setIamPolicy( - params: Params$Resource$Projects$Locations$Servicebindings$Setiampolicy, + get( + params: Params$Resource$Projects$Locations$Servicebindings$Get, options: StreamMethodOptions ): GaxiosPromise; - setIamPolicy( - params?: Params$Resource$Projects$Locations$Servicebindings$Setiampolicy, + get( + params?: Params$Resource$Projects$Locations$Servicebindings$Get, options?: MethodOptions - ): GaxiosPromise; - setIamPolicy( - params: Params$Resource$Projects$Locations$Servicebindings$Setiampolicy, + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Servicebindings$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - setIamPolicy( - params: Params$Resource$Projects$Locations$Servicebindings$Setiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Servicebindings$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - setIamPolicy( - params: Params$Resource$Projects$Locations$Servicebindings$Setiampolicy, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Servicebindings$Get, + callback: BodyResponseCallback ): void; - setIamPolicy(callback: BodyResponseCallback): void; - setIamPolicy( + get(callback: BodyResponseCallback): void; + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Servicebindings$Setiampolicy - | BodyResponseCallback + | Params$Resource$Projects$Locations$Servicebindings$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { + ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Servicebindings$Setiampolicy; + {}) as Params$Resource$Projects$Locations$Servicebindings$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Servicebindings$Setiampolicy; + params = {} as Params$Resource$Projects$Locations$Servicebindings$Get; options = {}; } @@ -8519,90 +7314,86 @@ export namespace networkservices_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+resource}:setIamPolicy').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['resource'], - pathParams: ['resource'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * 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. + * Lists ServiceBinding in a given project and location. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - testIamPermissions( - params: Params$Resource$Projects$Locations$Servicebindings$Testiampermissions, + list( + params: Params$Resource$Projects$Locations$Servicebindings$List, options: StreamMethodOptions ): GaxiosPromise; - testIamPermissions( - params?: Params$Resource$Projects$Locations$Servicebindings$Testiampermissions, + list( + params?: Params$Resource$Projects$Locations$Servicebindings$List, options?: MethodOptions - ): GaxiosPromise; - testIamPermissions( - params: Params$Resource$Projects$Locations$Servicebindings$Testiampermissions, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Servicebindings$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - testIamPermissions( - params: Params$Resource$Projects$Locations$Servicebindings$Testiampermissions, + list( + params: Params$Resource$Projects$Locations$Servicebindings$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - testIamPermissions( - params: Params$Resource$Projects$Locations$Servicebindings$Testiampermissions, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Servicebindings$List, + callback: BodyResponseCallback ): void; - testIamPermissions( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - testIamPermissions( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Servicebindings$Testiampermissions - | BodyResponseCallback + | Params$Resource$Projects$Locations$Servicebindings$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Servicebindings$Testiampermissions; + {}) as Params$Resource$Projects$Locations$Servicebindings$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Servicebindings$Testiampermissions; + params = {} as Params$Resource$Projects$Locations$Servicebindings$List; options = {}; } @@ -8616,27 +7407,27 @@ export namespace networkservices_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+resource}:testIamPermissions').replace( + url: (rootUrl + '/v1/{+parent}/serviceBindings').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['resource'], - pathParams: ['resource'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } } @@ -8671,17 +7462,6 @@ export namespace networkservices_v1 { */ name?: string; } - export interface Params$Resource$Projects$Locations$Servicebindings$Getiampolicy - extends StandardParameters { - /** - * 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). - */ - 'options.requestedPolicyVersion'?: number; - /** - * REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - */ - resource?: string; - } export interface Params$Resource$Projects$Locations$Servicebindings$List extends StandardParameters { /** @@ -8697,30 +7477,6 @@ export namespace networkservices_v1 { */ parent?: string; } - export interface Params$Resource$Projects$Locations$Servicebindings$Setiampolicy - extends StandardParameters { - /** - * REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - */ - resource?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$SetIamPolicyRequest; - } - export interface Params$Resource$Projects$Locations$Servicebindings$Testiampermissions - extends StandardParameters { - /** - * REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - */ - resource?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$TestIamPermissionsRequest; - } export class Resource$Projects$Locations$Servicelbpolicies { context: APIRequestContext; @@ -10558,7 +9314,7 @@ export namespace networkservices_v1 { export interface Params$Resource$Projects$Locations$Tlsroutes$Patch extends StandardParameters { /** - * Required. Name of the TlsRoute resource. It matches pattern `projects/x/locations/global/tlsRoutes/tls_route_name\>`. + * Identifier. Name of the TlsRoute resource. It matches pattern `projects/x/locations/global/tlsRoutes/tls_route_name\>`. */ name?: string; /** diff --git a/src/apis/networkservices/v1beta1.ts b/src/apis/networkservices/v1beta1.ts index dc178033b0..871c576e54 100644 --- a/src/apis/networkservices/v1beta1.ts +++ b/src/apis/networkservices/v1beta1.ts @@ -1717,7 +1717,7 @@ export namespace networkservices_v1beta1 { */ meshes?: string[] | null; /** - * Required. Name of the TlsRoute resource. It matches pattern `projects/x/locations/global/tlsRoutes/tls_route_name\>`. + * Identifier. Name of the TlsRoute resource. It matches pattern `projects/x/locations/global/tlsRoutes/tls_route_name\>`. */ name?: string | null; /** @@ -2324,96 +2324,6 @@ export namespace networkservices_v1beta1 { } } - /** - * Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - getIamPolicy( - params: Params$Resource$Projects$Locations$Endpointpolicies$Getiampolicy, - options: StreamMethodOptions - ): GaxiosPromise; - getIamPolicy( - params?: Params$Resource$Projects$Locations$Endpointpolicies$Getiampolicy, - options?: MethodOptions - ): GaxiosPromise; - getIamPolicy( - params: Params$Resource$Projects$Locations$Endpointpolicies$Getiampolicy, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Endpointpolicies$Getiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Endpointpolicies$Getiampolicy, - callback: BodyResponseCallback - ): void; - getIamPolicy(callback: BodyResponseCallback): void; - getIamPolicy( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Endpointpolicies$Getiampolicy - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Endpointpolicies$Getiampolicy; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Endpointpolicies$Getiampolicy; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://networkservices.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1beta1/{+resource}:getIamPolicy').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['resource'], - pathParams: ['resource'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - /** * Lists EndpointPolicies in a given project and location. * @@ -2598,60 +2508,128 @@ export namespace networkservices_v1beta1 { return createAPIRequest(parameters); } } + } + export interface Params$Resource$Projects$Locations$Endpointpolicies$Create + extends StandardParameters { /** - * Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. + * Required. Short name of the EndpointPolicy resource to be created. E.g. "CustomECS". + */ + endpointPolicyId?: string; + /** + * Required. The parent resource of the EndpointPolicy. Must be in the format `projects/x/locations/global`. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$EndpointPolicy; + } + export interface Params$Resource$Projects$Locations$Endpointpolicies$Delete + extends StandardParameters { + /** + * Required. A name of the EndpointPolicy to delete. Must be in the format `projects/x/locations/global/endpointPolicies/x`. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Endpointpolicies$Get + extends StandardParameters { + /** + * Required. A name of the EndpointPolicy to get. Must be in the format `projects/x/locations/global/endpointPolicies/x`. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Endpointpolicies$List + extends StandardParameters { + /** + * Maximum number of EndpointPolicies to return per call. + */ + pageSize?: number; + /** + * The value returned by the last `ListEndpointPoliciesResponse` Indicates that this is a continuation of a prior `ListEndpointPolicies` call, and that the system should return the next page of data. + */ + pageToken?: string; + /** + * Required. The project and location from which the EndpointPolicies should be listed, specified in the format `projects/x/locations/global`. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Endpointpolicies$Patch + extends StandardParameters { + /** + * Required. Name of the EndpointPolicy resource. It matches pattern `projects/{project\}/locations/global/endpointPolicies/{endpoint_policy\}`. + */ + name?: string; + /** + * Optional. Field mask is used to specify the fields to be overwritten in the EndpointPolicy resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$EndpointPolicy; + } + + export class Resource$Projects$Locations$Gateways { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Creates a new Gateway in a given project and location. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - setIamPolicy( - params: Params$Resource$Projects$Locations$Endpointpolicies$Setiampolicy, + create( + params: Params$Resource$Projects$Locations$Gateways$Create, options: StreamMethodOptions ): GaxiosPromise; - setIamPolicy( - params?: Params$Resource$Projects$Locations$Endpointpolicies$Setiampolicy, + create( + params?: Params$Resource$Projects$Locations$Gateways$Create, options?: MethodOptions - ): GaxiosPromise; - setIamPolicy( - params: Params$Resource$Projects$Locations$Endpointpolicies$Setiampolicy, + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Gateways$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - setIamPolicy( - params: Params$Resource$Projects$Locations$Endpointpolicies$Setiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Gateways$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - setIamPolicy( - params: Params$Resource$Projects$Locations$Endpointpolicies$Setiampolicy, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Gateways$Create, + callback: BodyResponseCallback ): void; - setIamPolicy(callback: BodyResponseCallback): void; - setIamPolicy( + create(callback: BodyResponseCallback): void; + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Endpointpolicies$Setiampolicy - | BodyResponseCallback + | Params$Resource$Projects$Locations$Gateways$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { + ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Endpointpolicies$Setiampolicy; + {}) as Params$Resource$Projects$Locations$Gateways$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Endpointpolicies$Setiampolicy; + params = {} as Params$Resource$Projects$Locations$Gateways$Create; options = {}; } @@ -2665,7 +2643,7 @@ export namespace networkservices_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+resource}:setIamPolicy').replace( + url: (rootUrl + '/v1beta1/{+parent}/gateways').replace( /([^:]\/)\/+/g, '$1' ), @@ -2675,1692 +2653,72 @@ export namespace networkservices_v1beta1 { options ), params, - requiredParams: ['resource'], - pathParams: ['resource'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * 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. + * Deletes a single Gateway. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - testIamPermissions( - params: Params$Resource$Projects$Locations$Endpointpolicies$Testiampermissions, + delete( + params: Params$Resource$Projects$Locations$Gateways$Delete, options: StreamMethodOptions ): GaxiosPromise; - testIamPermissions( - params?: Params$Resource$Projects$Locations$Endpointpolicies$Testiampermissions, + delete( + params?: Params$Resource$Projects$Locations$Gateways$Delete, options?: MethodOptions - ): GaxiosPromise; - testIamPermissions( - params: Params$Resource$Projects$Locations$Endpointpolicies$Testiampermissions, + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Gateways$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - testIamPermissions( - params: Params$Resource$Projects$Locations$Endpointpolicies$Testiampermissions, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - testIamPermissions( - params: Params$Resource$Projects$Locations$Endpointpolicies$Testiampermissions, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Gateways$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - testIamPermissions( - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Gateways$Delete, + callback: BodyResponseCallback ): void; - testIamPermissions( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Endpointpolicies$Testiampermissions - | BodyResponseCallback + | Params$Resource$Projects$Locations$Gateways$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { + ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Endpointpolicies$Testiampermissions; + {}) as Params$Resource$Projects$Locations$Gateways$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Endpointpolicies$Testiampermissions; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://networkservices.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1beta1/{+resource}:testIamPermissions').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['resource'], - pathParams: ['resource'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Projects$Locations$Endpointpolicies$Create - extends StandardParameters { - /** - * Required. Short name of the EndpointPolicy resource to be created. E.g. "CustomECS". - */ - endpointPolicyId?: string; - /** - * Required. The parent resource of the EndpointPolicy. Must be in the format `projects/x/locations/global`. - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$EndpointPolicy; - } - export interface Params$Resource$Projects$Locations$Endpointpolicies$Delete - extends StandardParameters { - /** - * Required. A name of the EndpointPolicy to delete. Must be in the format `projects/x/locations/global/endpointPolicies/x`. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Endpointpolicies$Get - extends StandardParameters { - /** - * Required. A name of the EndpointPolicy to get. Must be in the format `projects/x/locations/global/endpointPolicies/x`. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Endpointpolicies$Getiampolicy - extends StandardParameters { - /** - * 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). - */ - 'options.requestedPolicyVersion'?: number; - /** - * REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - */ - resource?: string; - } - export interface Params$Resource$Projects$Locations$Endpointpolicies$List - extends StandardParameters { - /** - * Maximum number of EndpointPolicies to return per call. - */ - pageSize?: number; - /** - * The value returned by the last `ListEndpointPoliciesResponse` Indicates that this is a continuation of a prior `ListEndpointPolicies` call, and that the system should return the next page of data. - */ - pageToken?: string; - /** - * Required. The project and location from which the EndpointPolicies should be listed, specified in the format `projects/x/locations/global`. - */ - parent?: string; - } - export interface Params$Resource$Projects$Locations$Endpointpolicies$Patch - extends StandardParameters { - /** - * Required. Name of the EndpointPolicy resource. It matches pattern `projects/{project\}/locations/global/endpointPolicies/{endpoint_policy\}`. - */ - name?: string; - /** - * Optional. Field mask is used to specify the fields to be overwritten in the EndpointPolicy resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten. - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$EndpointPolicy; - } - export interface Params$Resource$Projects$Locations$Endpointpolicies$Setiampolicy - extends StandardParameters { - /** - * REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - */ - resource?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$SetIamPolicyRequest; - } - export interface Params$Resource$Projects$Locations$Endpointpolicies$Testiampermissions - extends StandardParameters { - /** - * REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - */ - resource?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$TestIamPermissionsRequest; - } - - export class Resource$Projects$Locations$Gateways { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * Creates a new Gateway in a given project and location. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - create( - params: Params$Resource$Projects$Locations$Gateways$Create, - options: StreamMethodOptions - ): GaxiosPromise; - create( - params?: Params$Resource$Projects$Locations$Gateways$Create, - options?: MethodOptions - ): GaxiosPromise; - create( - params: Params$Resource$Projects$Locations$Gateways$Create, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - create( - params: Params$Resource$Projects$Locations$Gateways$Create, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - create( - params: Params$Resource$Projects$Locations$Gateways$Create, - callback: BodyResponseCallback - ): void; - create(callback: BodyResponseCallback): void; - create( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Gateways$Create - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Gateways$Create; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Gateways$Create; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://networkservices.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1beta1/{+parent}/gateways').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['parent'], - pathParams: ['parent'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * Deletes a single Gateway. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - delete( - params: Params$Resource$Projects$Locations$Gateways$Delete, - options: StreamMethodOptions - ): GaxiosPromise; - delete( - params?: Params$Resource$Projects$Locations$Gateways$Delete, - options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Projects$Locations$Gateways$Delete, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Projects$Locations$Gateways$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Projects$Locations$Gateways$Delete, - callback: BodyResponseCallback - ): void; - delete(callback: BodyResponseCallback): void; - delete( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Gateways$Delete - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Gateways$Delete; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Gateways$Delete; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://networkservices.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * Gets details of a single Gateway. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - get( - params: Params$Resource$Projects$Locations$Gateways$Get, - options: StreamMethodOptions - ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Gateways$Get, - options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Gateways$Get, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Projects$Locations$Gateways$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Projects$Locations$Gateways$Get, - callback: BodyResponseCallback - ): void; - get(callback: BodyResponseCallback): void; - get( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Gateways$Get - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Gateways$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Gateways$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://networkservices.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - getIamPolicy( - params: Params$Resource$Projects$Locations$Gateways$Getiampolicy, - options: StreamMethodOptions - ): GaxiosPromise; - getIamPolicy( - params?: Params$Resource$Projects$Locations$Gateways$Getiampolicy, - options?: MethodOptions - ): GaxiosPromise; - getIamPolicy( - params: Params$Resource$Projects$Locations$Gateways$Getiampolicy, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Gateways$Getiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Gateways$Getiampolicy, - callback: BodyResponseCallback - ): void; - getIamPolicy(callback: BodyResponseCallback): void; - getIamPolicy( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Gateways$Getiampolicy - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Gateways$Getiampolicy; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Gateways$Getiampolicy; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://networkservices.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1beta1/{+resource}:getIamPolicy').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['resource'], - pathParams: ['resource'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * Lists Gateways in a given project and location. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - list( - params: Params$Resource$Projects$Locations$Gateways$List, - options: StreamMethodOptions - ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Gateways$List, - options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Gateways$List, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Projects$Locations$Gateways$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Projects$Locations$Gateways$List, - callback: BodyResponseCallback - ): void; - list(callback: BodyResponseCallback): void; - list( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Gateways$List - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Gateways$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Gateways$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://networkservices.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1beta1/{+parent}/gateways').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['parent'], - pathParams: ['parent'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * Updates the parameters of a single Gateway. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - patch( - params: Params$Resource$Projects$Locations$Gateways$Patch, - options: StreamMethodOptions - ): GaxiosPromise; - patch( - params?: Params$Resource$Projects$Locations$Gateways$Patch, - options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Projects$Locations$Gateways$Patch, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - patch( - params: Params$Resource$Projects$Locations$Gateways$Patch, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - patch( - params: Params$Resource$Projects$Locations$Gateways$Patch, - callback: BodyResponseCallback - ): void; - patch(callback: BodyResponseCallback): void; - patch( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Gateways$Patch - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Gateways$Patch; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Gateways$Patch; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://networkservices.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - setIamPolicy( - params: Params$Resource$Projects$Locations$Gateways$Setiampolicy, - options: StreamMethodOptions - ): GaxiosPromise; - setIamPolicy( - params?: Params$Resource$Projects$Locations$Gateways$Setiampolicy, - options?: MethodOptions - ): GaxiosPromise; - setIamPolicy( - params: Params$Resource$Projects$Locations$Gateways$Setiampolicy, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - setIamPolicy( - params: Params$Resource$Projects$Locations$Gateways$Setiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - setIamPolicy( - params: Params$Resource$Projects$Locations$Gateways$Setiampolicy, - callback: BodyResponseCallback - ): void; - setIamPolicy(callback: BodyResponseCallback): void; - setIamPolicy( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Gateways$Setiampolicy - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Gateways$Setiampolicy; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Gateways$Setiampolicy; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://networkservices.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1beta1/{+resource}:setIamPolicy').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['resource'], - pathParams: ['resource'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * 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. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - testIamPermissions( - params: Params$Resource$Projects$Locations$Gateways$Testiampermissions, - options: StreamMethodOptions - ): GaxiosPromise; - testIamPermissions( - params?: Params$Resource$Projects$Locations$Gateways$Testiampermissions, - options?: MethodOptions - ): GaxiosPromise; - testIamPermissions( - params: Params$Resource$Projects$Locations$Gateways$Testiampermissions, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - testIamPermissions( - params: Params$Resource$Projects$Locations$Gateways$Testiampermissions, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - testIamPermissions( - params: Params$Resource$Projects$Locations$Gateways$Testiampermissions, - callback: BodyResponseCallback - ): void; - testIamPermissions( - callback: BodyResponseCallback - ): void; - testIamPermissions( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Gateways$Testiampermissions - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Gateways$Testiampermissions; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Gateways$Testiampermissions; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://networkservices.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1beta1/{+resource}:testIamPermissions').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['resource'], - pathParams: ['resource'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Projects$Locations$Gateways$Create - extends StandardParameters { - /** - * Required. Short name of the Gateway resource to be created. - */ - gatewayId?: string; - /** - * Required. The parent resource of the Gateway. Must be in the format `projects/x/locations/x`. - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$Gateway; - } - export interface Params$Resource$Projects$Locations$Gateways$Delete - extends StandardParameters { - /** - * Required. A name of the Gateway to delete. Must be in the format `projects/x/locations/x/gateways/x`. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Gateways$Get - extends StandardParameters { - /** - * Required. A name of the Gateway to get. Must be in the format `projects/x/locations/x/gateways/x`. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Gateways$Getiampolicy - extends StandardParameters { - /** - * 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). - */ - 'options.requestedPolicyVersion'?: number; - /** - * REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - */ - resource?: string; - } - export interface Params$Resource$Projects$Locations$Gateways$List - extends StandardParameters { - /** - * Maximum number of Gateways to return per call. - */ - pageSize?: number; - /** - * The value returned by the last `ListGatewaysResponse` Indicates that this is a continuation of a prior `ListGateways` call, and that the system should return the next page of data. - */ - pageToken?: string; - /** - * Required. The project and location from which the Gateways should be listed, specified in the format `projects/x/locations/x`. - */ - parent?: string; - } - export interface Params$Resource$Projects$Locations$Gateways$Patch - extends StandardParameters { - /** - * Required. Name of the Gateway resource. It matches pattern `projects/x/locations/x/gateways/`. - */ - name?: string; - /** - * Optional. Field mask is used to specify the fields to be overwritten in the Gateway resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten. - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$Gateway; - } - export interface Params$Resource$Projects$Locations$Gateways$Setiampolicy - extends StandardParameters { - /** - * REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - */ - resource?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$SetIamPolicyRequest; - } - export interface Params$Resource$Projects$Locations$Gateways$Testiampermissions - extends StandardParameters { - /** - * REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - */ - resource?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$TestIamPermissionsRequest; - } - - export class Resource$Projects$Locations$Grpcroutes { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * Creates a new GrpcRoute in a given project and location. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - create( - params: Params$Resource$Projects$Locations$Grpcroutes$Create, - options: StreamMethodOptions - ): GaxiosPromise; - create( - params?: Params$Resource$Projects$Locations$Grpcroutes$Create, - options?: MethodOptions - ): GaxiosPromise; - create( - params: Params$Resource$Projects$Locations$Grpcroutes$Create, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - create( - params: Params$Resource$Projects$Locations$Grpcroutes$Create, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - create( - params: Params$Resource$Projects$Locations$Grpcroutes$Create, - callback: BodyResponseCallback - ): void; - create(callback: BodyResponseCallback): void; - create( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Grpcroutes$Create - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Grpcroutes$Create; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Grpcroutes$Create; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://networkservices.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1beta1/{+parent}/grpcRoutes').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['parent'], - pathParams: ['parent'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * Deletes a single GrpcRoute. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - delete( - params: Params$Resource$Projects$Locations$Grpcroutes$Delete, - options: StreamMethodOptions - ): GaxiosPromise; - delete( - params?: Params$Resource$Projects$Locations$Grpcroutes$Delete, - options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Projects$Locations$Grpcroutes$Delete, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Projects$Locations$Grpcroutes$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Projects$Locations$Grpcroutes$Delete, - callback: BodyResponseCallback - ): void; - delete(callback: BodyResponseCallback): void; - delete( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Grpcroutes$Delete - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Grpcroutes$Delete; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Grpcroutes$Delete; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://networkservices.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * Gets details of a single GrpcRoute. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - get( - params: Params$Resource$Projects$Locations$Grpcroutes$Get, - options: StreamMethodOptions - ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Grpcroutes$Get, - options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Grpcroutes$Get, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Projects$Locations$Grpcroutes$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Projects$Locations$Grpcroutes$Get, - callback: BodyResponseCallback - ): void; - get(callback: BodyResponseCallback): void; - get( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Grpcroutes$Get - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Grpcroutes$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Grpcroutes$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://networkservices.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * Lists GrpcRoutes in a given project and location. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - list( - params: Params$Resource$Projects$Locations$Grpcroutes$List, - options: StreamMethodOptions - ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Grpcroutes$List, - options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Grpcroutes$List, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Projects$Locations$Grpcroutes$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Projects$Locations$Grpcroutes$List, - callback: BodyResponseCallback - ): void; - list(callback: BodyResponseCallback): void; - list( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Grpcroutes$List - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Grpcroutes$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Grpcroutes$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://networkservices.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1beta1/{+parent}/grpcRoutes').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['parent'], - pathParams: ['parent'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * Updates the parameters of a single GrpcRoute. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - patch( - params: Params$Resource$Projects$Locations$Grpcroutes$Patch, - options: StreamMethodOptions - ): GaxiosPromise; - patch( - params?: Params$Resource$Projects$Locations$Grpcroutes$Patch, - options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Projects$Locations$Grpcroutes$Patch, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - patch( - params: Params$Resource$Projects$Locations$Grpcroutes$Patch, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - patch( - params: Params$Resource$Projects$Locations$Grpcroutes$Patch, - callback: BodyResponseCallback - ): void; - patch(callback: BodyResponseCallback): void; - patch( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Grpcroutes$Patch - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Grpcroutes$Patch; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Grpcroutes$Patch; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://networkservices.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Projects$Locations$Grpcroutes$Create - extends StandardParameters { - /** - * Required. Short name of the GrpcRoute resource to be created. - */ - grpcRouteId?: string; - /** - * Required. The parent resource of the GrpcRoute. Must be in the format `projects/x/locations/global`. - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GrpcRoute; - } - export interface Params$Resource$Projects$Locations$Grpcroutes$Delete - extends StandardParameters { - /** - * Required. A name of the GrpcRoute to delete. Must be in the format `projects/x/locations/global/grpcRoutes/x`. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Grpcroutes$Get - extends StandardParameters { - /** - * Required. A name of the GrpcRoute to get. Must be in the format `projects/x/locations/global/grpcRoutes/x`. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Grpcroutes$List - extends StandardParameters { - /** - * Maximum number of GrpcRoutes to return per call. - */ - pageSize?: number; - /** - * The value returned by the last `ListGrpcRoutesResponse` Indicates that this is a continuation of a prior `ListGrpcRoutes` call, and that the system should return the next page of data. - */ - pageToken?: string; - /** - * Required. The project and location from which the GrpcRoutes should be listed, specified in the format `projects/x/locations/global`. - */ - parent?: string; - } - export interface Params$Resource$Projects$Locations$Grpcroutes$Patch - extends StandardParameters { - /** - * Required. Name of the GrpcRoute resource. It matches pattern `projects/x/locations/global/grpcRoutes/` - */ - name?: string; - /** - * Optional. Field mask is used to specify the fields to be overwritten in the GrpcRoute resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten. - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GrpcRoute; - } - - export class Resource$Projects$Locations$Httproutes { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * Creates a new HttpRoute in a given project and location. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - create( - params: Params$Resource$Projects$Locations$Httproutes$Create, - options: StreamMethodOptions - ): GaxiosPromise; - create( - params?: Params$Resource$Projects$Locations$Httproutes$Create, - options?: MethodOptions - ): GaxiosPromise; - create( - params: Params$Resource$Projects$Locations$Httproutes$Create, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - create( - params: Params$Resource$Projects$Locations$Httproutes$Create, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - create( - params: Params$Resource$Projects$Locations$Httproutes$Create, - callback: BodyResponseCallback - ): void; - create(callback: BodyResponseCallback): void; - create( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Httproutes$Create - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Httproutes$Create; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Httproutes$Create; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://networkservices.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1beta1/{+parent}/httpRoutes').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['parent'], - pathParams: ['parent'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * Deletes a single HttpRoute. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - delete( - params: Params$Resource$Projects$Locations$Httproutes$Delete, - options: StreamMethodOptions - ): GaxiosPromise; - delete( - params?: Params$Resource$Projects$Locations$Httproutes$Delete, - options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Projects$Locations$Httproutes$Delete, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Projects$Locations$Httproutes$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Projects$Locations$Httproutes$Delete, - callback: BodyResponseCallback - ): void; - delete(callback: BodyResponseCallback): void; - delete( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Httproutes$Delete - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Httproutes$Delete; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Httproutes$Delete; + params = {} as Params$Resource$Projects$Locations$Gateways$Delete; options = {}; } @@ -4396,7 +2754,7 @@ export namespace networkservices_v1beta1 { } /** - * Gets details of a single HttpRoute. + * Gets details of a single Gateway. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -4404,49 +2762,49 @@ export namespace networkservices_v1beta1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Httproutes$Get, + params: Params$Resource$Projects$Locations$Gateways$Get, options: StreamMethodOptions ): GaxiosPromise; get( - params?: Params$Resource$Projects$Locations$Httproutes$Get, + params?: Params$Resource$Projects$Locations$Gateways$Get, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; get( - params: Params$Resource$Projects$Locations$Httproutes$Get, + params: Params$Resource$Projects$Locations$Gateways$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Httproutes$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Gateways$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Httproutes$Get, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Gateways$Get, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; + get(callback: BodyResponseCallback): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Httproutes$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Gateways$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { + ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Httproutes$Get; + {}) as Params$Resource$Projects$Locations$Gateways$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Httproutes$Get; + params = {} as Params$Resource$Projects$Locations$Gateways$Get; options = {}; } @@ -4472,17 +2830,17 @@ export namespace networkservices_v1beta1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Lists HttpRoute in a given project and location. + * Lists Gateways in a given project and location. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -4490,54 +2848,54 @@ export namespace networkservices_v1beta1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Httproutes$List, + params: Params$Resource$Projects$Locations$Gateways$List, options: StreamMethodOptions ): GaxiosPromise; list( - params?: Params$Resource$Projects$Locations$Httproutes$List, + params?: Params$Resource$Projects$Locations$Gateways$List, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; list( - params: Params$Resource$Projects$Locations$Httproutes$List, + params: Params$Resource$Projects$Locations$Gateways$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Httproutes$List, + params: Params$Resource$Projects$Locations$Gateways$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Httproutes$List, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Gateways$List, + callback: BodyResponseCallback ): void; - list(callback: BodyResponseCallback): void; + list(callback: BodyResponseCallback): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Httproutes$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Gateways$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Httproutes$List; + {}) as Params$Resource$Projects$Locations$Gateways$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Httproutes$List; + params = {} as Params$Resource$Projects$Locations$Gateways$List; options = {}; } @@ -4551,7 +2909,7 @@ export namespace networkservices_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+parent}/httpRoutes').replace( + url: (rootUrl + '/v1beta1/{+parent}/gateways').replace( /([^:]\/)\/+/g, '$1' ), @@ -4566,17 +2924,17 @@ export namespace networkservices_v1beta1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Updates the parameters of a single HttpRoute. + * Updates the parameters of a single Gateway. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -4584,31 +2942,31 @@ export namespace networkservices_v1beta1 { * @returns A promise if used with async/await, or void if used with a callback. */ patch( - params: Params$Resource$Projects$Locations$Httproutes$Patch, + params: Params$Resource$Projects$Locations$Gateways$Patch, options: StreamMethodOptions ): GaxiosPromise; patch( - params?: Params$Resource$Projects$Locations$Httproutes$Patch, + params?: Params$Resource$Projects$Locations$Gateways$Patch, options?: MethodOptions ): GaxiosPromise; patch( - params: Params$Resource$Projects$Locations$Httproutes$Patch, + params: Params$Resource$Projects$Locations$Gateways$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; patch( - params: Params$Resource$Projects$Locations$Httproutes$Patch, + params: Params$Resource$Projects$Locations$Gateways$Patch, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; patch( - params: Params$Resource$Projects$Locations$Httproutes$Patch, + params: Params$Resource$Projects$Locations$Gateways$Patch, callback: BodyResponseCallback ): void; patch(callback: BodyResponseCallback): void; patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Httproutes$Patch + | Params$Resource$Projects$Locations$Gateways$Patch | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -4621,12 +2979,12 @@ export namespace networkservices_v1beta1 { | BodyResponseCallback ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Httproutes$Patch; + {}) as Params$Resource$Projects$Locations$Gateways$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Httproutes$Patch; + params = {} as Params$Resource$Projects$Locations$Gateways$Patch; options = {}; } @@ -4662,76 +3020,76 @@ export namespace networkservices_v1beta1 { } } - export interface Params$Resource$Projects$Locations$Httproutes$Create + export interface Params$Resource$Projects$Locations$Gateways$Create extends StandardParameters { /** - * Required. Short name of the HttpRoute resource to be created. + * Required. Short name of the Gateway resource to be created. */ - httpRouteId?: string; + gatewayId?: string; /** - * Required. The parent resource of the HttpRoute. Must be in the format `projects/x/locations/global`. + * Required. The parent resource of the Gateway. Must be in the format `projects/x/locations/x`. */ parent?: string; /** * Request body metadata */ - requestBody?: Schema$HttpRoute; + requestBody?: Schema$Gateway; } - export interface Params$Resource$Projects$Locations$Httproutes$Delete + export interface Params$Resource$Projects$Locations$Gateways$Delete extends StandardParameters { /** - * Required. A name of the HttpRoute to delete. Must be in the format `projects/x/locations/global/httpRoutes/x`. + * Required. A name of the Gateway to delete. Must be in the format `projects/x/locations/x/gateways/x`. */ name?: string; } - export interface Params$Resource$Projects$Locations$Httproutes$Get + export interface Params$Resource$Projects$Locations$Gateways$Get extends StandardParameters { /** - * Required. A name of the HttpRoute to get. Must be in the format `projects/x/locations/global/httpRoutes/x`. + * Required. A name of the Gateway to get. Must be in the format `projects/x/locations/x/gateways/x`. */ name?: string; } - export interface Params$Resource$Projects$Locations$Httproutes$List + export interface Params$Resource$Projects$Locations$Gateways$List extends StandardParameters { /** - * Maximum number of HttpRoutes to return per call. + * Maximum number of Gateways to return per call. */ pageSize?: number; /** - * The value returned by the last `ListHttpRoutesResponse` Indicates that this is a continuation of a prior `ListHttpRoutes` call, and that the system should return the next page of data. + * The value returned by the last `ListGatewaysResponse` Indicates that this is a continuation of a prior `ListGateways` call, and that the system should return the next page of data. */ pageToken?: string; /** - * Required. The project and location from which the HttpRoutes should be listed, specified in the format `projects/x/locations/global`. + * Required. The project and location from which the Gateways should be listed, specified in the format `projects/x/locations/x`. */ parent?: string; } - export interface Params$Resource$Projects$Locations$Httproutes$Patch + export interface Params$Resource$Projects$Locations$Gateways$Patch extends StandardParameters { /** - * Required. Name of the HttpRoute resource. It matches pattern `projects/x/locations/global/httpRoutes/http_route_name\>`. + * Required. Name of the Gateway resource. It matches pattern `projects/x/locations/x/gateways/`. */ name?: string; /** - * Optional. Field mask is used to specify the fields to be overwritten in the HttpRoute resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten. + * Optional. Field mask is used to specify the fields to be overwritten in the Gateway resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten. */ updateMask?: string; /** * Request body metadata */ - requestBody?: Schema$HttpRoute; + requestBody?: Schema$Gateway; } - export class Resource$Projects$Locations$Lbrouteextensions { + export class Resource$Projects$Locations$Grpcroutes { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * Creates a new `LbRouteExtension` resource in a given project and location. + * Creates a new GrpcRoute in a given project and location. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -4739,31 +3097,31 @@ export namespace networkservices_v1beta1 { * @returns A promise if used with async/await, or void if used with a callback. */ create( - params: Params$Resource$Projects$Locations$Lbrouteextensions$Create, + params: Params$Resource$Projects$Locations$Grpcroutes$Create, options: StreamMethodOptions ): GaxiosPromise; create( - params?: Params$Resource$Projects$Locations$Lbrouteextensions$Create, + params?: Params$Resource$Projects$Locations$Grpcroutes$Create, options?: MethodOptions ): GaxiosPromise; create( - params: Params$Resource$Projects$Locations$Lbrouteextensions$Create, + params: Params$Resource$Projects$Locations$Grpcroutes$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; create( - params: Params$Resource$Projects$Locations$Lbrouteextensions$Create, + params: Params$Resource$Projects$Locations$Grpcroutes$Create, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; create( - params: Params$Resource$Projects$Locations$Lbrouteextensions$Create, + params: Params$Resource$Projects$Locations$Grpcroutes$Create, callback: BodyResponseCallback ): void; create(callback: BodyResponseCallback): void; create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Lbrouteextensions$Create + | Params$Resource$Projects$Locations$Grpcroutes$Create | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -4776,13 +3134,12 @@ export namespace networkservices_v1beta1 { | BodyResponseCallback ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Lbrouteextensions$Create; + {}) as Params$Resource$Projects$Locations$Grpcroutes$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Lbrouteextensions$Create; + params = {} as Params$Resource$Projects$Locations$Grpcroutes$Create; options = {}; } @@ -4796,7 +3153,7 @@ export namespace networkservices_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+parent}/lbRouteExtensions').replace( + url: (rootUrl + '/v1beta1/{+parent}/grpcRoutes').replace( /([^:]\/)\/+/g, '$1' ), @@ -4821,7 +3178,7 @@ export namespace networkservices_v1beta1 { } /** - * Deletes the specified `LbRouteExtension` resource. + * Deletes a single GrpcRoute. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -4829,31 +3186,31 @@ export namespace networkservices_v1beta1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Lbrouteextensions$Delete, + params: Params$Resource$Projects$Locations$Grpcroutes$Delete, options: StreamMethodOptions ): GaxiosPromise; delete( - params?: Params$Resource$Projects$Locations$Lbrouteextensions$Delete, + params?: Params$Resource$Projects$Locations$Grpcroutes$Delete, options?: MethodOptions ): GaxiosPromise; delete( - params: Params$Resource$Projects$Locations$Lbrouteextensions$Delete, + params: Params$Resource$Projects$Locations$Grpcroutes$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Lbrouteextensions$Delete, + params: Params$Resource$Projects$Locations$Grpcroutes$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Lbrouteextensions$Delete, + params: Params$Resource$Projects$Locations$Grpcroutes$Delete, callback: BodyResponseCallback ): void; delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Lbrouteextensions$Delete + | Params$Resource$Projects$Locations$Grpcroutes$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -4866,13 +3223,12 @@ export namespace networkservices_v1beta1 { | BodyResponseCallback ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Lbrouteextensions$Delete; + {}) as Params$Resource$Projects$Locations$Grpcroutes$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Lbrouteextensions$Delete; + params = {} as Params$Resource$Projects$Locations$Grpcroutes$Delete; options = {}; } @@ -4908,7 +3264,7 @@ export namespace networkservices_v1beta1 { } /** - * Gets details of the specified `LbRouteExtension` resource. + * Gets details of a single GrpcRoute. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -4916,49 +3272,49 @@ export namespace networkservices_v1beta1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Lbrouteextensions$Get, + params: Params$Resource$Projects$Locations$Grpcroutes$Get, options: StreamMethodOptions ): GaxiosPromise; get( - params?: Params$Resource$Projects$Locations$Lbrouteextensions$Get, + params?: Params$Resource$Projects$Locations$Grpcroutes$Get, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; get( - params: Params$Resource$Projects$Locations$Lbrouteextensions$Get, + params: Params$Resource$Projects$Locations$Grpcroutes$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Lbrouteextensions$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Grpcroutes$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Lbrouteextensions$Get, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Grpcroutes$Get, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; + get(callback: BodyResponseCallback): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Lbrouteextensions$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Grpcroutes$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { + ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Lbrouteextensions$Get; + {}) as Params$Resource$Projects$Locations$Grpcroutes$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Lbrouteextensions$Get; + params = {} as Params$Resource$Projects$Locations$Grpcroutes$Get; options = {}; } @@ -4984,17 +3340,17 @@ export namespace networkservices_v1beta1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Lists `LbRouteExtension` resources in a given project and location. + * Lists GrpcRoutes in a given project and location. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -5002,57 +3358,54 @@ export namespace networkservices_v1beta1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Lbrouteextensions$List, + params: Params$Resource$Projects$Locations$Grpcroutes$List, options: StreamMethodOptions ): GaxiosPromise; list( - params?: Params$Resource$Projects$Locations$Lbrouteextensions$List, + params?: Params$Resource$Projects$Locations$Grpcroutes$List, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; list( - params: Params$Resource$Projects$Locations$Lbrouteextensions$List, + params: Params$Resource$Projects$Locations$Grpcroutes$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Lbrouteextensions$List, + params: Params$Resource$Projects$Locations$Grpcroutes$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Projects$Locations$Lbrouteextensions$List, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Grpcroutes$List, + callback: BodyResponseCallback ): void; + list(callback: BodyResponseCallback): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Lbrouteextensions$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Grpcroutes$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Lbrouteextensions$List; + {}) as Params$Resource$Projects$Locations$Grpcroutes$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Lbrouteextensions$List; + params = {} as Params$Resource$Projects$Locations$Grpcroutes$List; options = {}; } @@ -5066,7 +3419,7 @@ export namespace networkservices_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+parent}/lbRouteExtensions').replace( + url: (rootUrl + '/v1beta1/{+parent}/grpcRoutes').replace( /([^:]\/)\/+/g, '$1' ), @@ -5081,19 +3434,17 @@ export namespace networkservices_v1beta1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Updates the parameters of the specified `LbRouteExtension` resource. + * Updates the parameters of a single GrpcRoute. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -5101,31 +3452,31 @@ export namespace networkservices_v1beta1 { * @returns A promise if used with async/await, or void if used with a callback. */ patch( - params: Params$Resource$Projects$Locations$Lbrouteextensions$Patch, + params: Params$Resource$Projects$Locations$Grpcroutes$Patch, options: StreamMethodOptions ): GaxiosPromise; patch( - params?: Params$Resource$Projects$Locations$Lbrouteextensions$Patch, + params?: Params$Resource$Projects$Locations$Grpcroutes$Patch, options?: MethodOptions ): GaxiosPromise; patch( - params: Params$Resource$Projects$Locations$Lbrouteextensions$Patch, + params: Params$Resource$Projects$Locations$Grpcroutes$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; patch( - params: Params$Resource$Projects$Locations$Lbrouteextensions$Patch, + params: Params$Resource$Projects$Locations$Grpcroutes$Patch, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; patch( - params: Params$Resource$Projects$Locations$Lbrouteextensions$Patch, + params: Params$Resource$Projects$Locations$Grpcroutes$Patch, callback: BodyResponseCallback ): void; patch(callback: BodyResponseCallback): void; patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Lbrouteextensions$Patch + | Params$Resource$Projects$Locations$Grpcroutes$Patch | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -5138,13 +3489,12 @@ export namespace networkservices_v1beta1 { | BodyResponseCallback ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Lbrouteextensions$Patch; + {}) as Params$Resource$Projects$Locations$Grpcroutes$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Lbrouteextensions$Patch; + params = {} as Params$Resource$Projects$Locations$Grpcroutes$Patch; options = {}; } @@ -5180,147 +3530,301 @@ export namespace networkservices_v1beta1 { } } - export interface Params$Resource$Projects$Locations$Lbrouteextensions$Create + export interface Params$Resource$Projects$Locations$Grpcroutes$Create extends StandardParameters { /** - * Required. User-provided ID of the `LbRouteExtension` resource to be created. + * Required. Short name of the GrpcRoute resource to be created. */ - lbRouteExtensionId?: string; + grpcRouteId?: string; /** - * Required. The parent resource of the `LbRouteExtension` resource. Must be in the format `projects/{project\}/locations/{location\}`. + * Required. The parent resource of the GrpcRoute. Must be in the format `projects/x/locations/global`. */ parent?: string; - /** - * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server can ignore the request if it has already been completed. The server guarantees 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, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). - */ - requestId?: string; /** * Request body metadata */ - requestBody?: Schema$LbRouteExtension; + requestBody?: Schema$GrpcRoute; } - export interface Params$Resource$Projects$Locations$Lbrouteextensions$Delete + export interface Params$Resource$Projects$Locations$Grpcroutes$Delete extends StandardParameters { /** - * Required. The name of the `LbRouteExtension` resource to delete. Must be in the format `projects/{project\}/locations/{location\}/lbRouteExtensions/{lb_route_extension\}`. + * Required. A name of the GrpcRoute to delete. Must be in the format `projects/x/locations/global/grpcRoutes/x`. */ name?: string; - /** - * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server can ignore the request if it has already been completed. The server guarantees 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, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). - */ - requestId?: string; } - export interface Params$Resource$Projects$Locations$Lbrouteextensions$Get + export interface Params$Resource$Projects$Locations$Grpcroutes$Get extends StandardParameters { /** - * Required. A name of the `LbRouteExtension` resource to get. Must be in the format `projects/{project\}/locations/{location\}/lbRouteExtensions/{lb_route_extension\}`. + * Required. A name of the GrpcRoute to get. Must be in the format `projects/x/locations/global/grpcRoutes/x`. */ name?: string; } - export interface Params$Resource$Projects$Locations$Lbrouteextensions$List + export interface Params$Resource$Projects$Locations$Grpcroutes$List extends StandardParameters { /** - * Optional. Filtering results. - */ - filter?: string; - /** - * Optional. Hint for how to order the results. - */ - orderBy?: string; - /** - * Optional. Requested page size. The server might return fewer items than requested. If unspecified, the server picks an appropriate default. + * Maximum number of GrpcRoutes to return per call. */ pageSize?: number; /** - * Optional. A token identifying a page of results that the server returns. + * The value returned by the last `ListGrpcRoutesResponse` Indicates that this is a continuation of a prior `ListGrpcRoutes` call, and that the system should return the next page of data. */ pageToken?: string; /** - * Required. The project and location from which the `LbRouteExtension` resources are listed, specified in the following format: `projects/{project\}/locations/{location\}`. + * Required. The project and location from which the GrpcRoutes should be listed, specified in the format `projects/x/locations/global`. */ parent?: string; } - export interface Params$Resource$Projects$Locations$Lbrouteextensions$Patch + export interface Params$Resource$Projects$Locations$Grpcroutes$Patch extends StandardParameters { /** - * Required. Identifier. Name of the `LbRouteExtension` resource in the following format: `projects/{project\}/locations/{location\}/lbRouteExtensions/{lb_route_extension\}`. + * Required. Name of the GrpcRoute resource. It matches pattern `projects/x/locations/global/grpcRoutes/` */ name?: string; /** - * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server can ignore the request if it has already been completed. The server guarantees 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, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). - */ - requestId?: string; - /** - * Optional. Used to specify the fields to be overwritten in the `LbRouteExtension` resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field is overwritten if it is in the mask. If the user does not specify a mask, then all fields are overwritten. + * Optional. Field mask is used to specify the fields to be overwritten in the GrpcRoute resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten. */ updateMask?: string; /** * Request body metadata */ - requestBody?: Schema$LbRouteExtension; + requestBody?: Schema$GrpcRoute; } - export class Resource$Projects$Locations$Lbtrafficextensions { + export class Resource$Projects$Locations$Httproutes { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * Creates a new `LbTrafficExtension` resource in a given project and location. + * Creates a new HttpRoute in a given project and location. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + create( + params: Params$Resource$Projects$Locations$Httproutes$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Projects$Locations$Httproutes$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Httproutes$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Httproutes$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Httproutes$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Httproutes$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Httproutes$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Httproutes$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://networkservices.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+parent}/httpRoutes').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Deletes a single HttpRoute. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Projects$Locations$Httproutes$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Projects$Locations$Httproutes$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Httproutes$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Httproutes$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Httproutes$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Httproutes$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Httproutes$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Httproutes$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://networkservices.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets details of a single HttpRoute. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - create( - params: Params$Resource$Projects$Locations$Lbtrafficextensions$Create, + get( + params: Params$Resource$Projects$Locations$Httproutes$Get, options: StreamMethodOptions ): GaxiosPromise; - create( - params?: Params$Resource$Projects$Locations$Lbtrafficextensions$Create, + get( + params?: Params$Resource$Projects$Locations$Httproutes$Get, options?: MethodOptions - ): GaxiosPromise; - create( - params: Params$Resource$Projects$Locations$Lbtrafficextensions$Create, + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Httproutes$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Lbtrafficextensions$Create, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Httproutes$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Lbtrafficextensions$Create, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Httproutes$Get, + callback: BodyResponseCallback ): void; - create(callback: BodyResponseCallback): void; - create( + get(callback: BodyResponseCallback): void; + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Lbtrafficextensions$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Httproutes$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { + ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Lbtrafficextensions$Create; + {}) as Params$Resource$Projects$Locations$Httproutes$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Lbtrafficextensions$Create; + params = {} as Params$Resource$Projects$Locations$Httproutes$Get; options = {}; } @@ -5334,83 +3838,84 @@ export namespace networkservices_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+parent}/lbTrafficExtensions').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Deletes the specified `LbTrafficExtension` resource. + * Lists HttpRoute in a given project and location. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - delete( - params: Params$Resource$Projects$Locations$Lbtrafficextensions$Delete, + list( + params: Params$Resource$Projects$Locations$Httproutes$List, options: StreamMethodOptions ): GaxiosPromise; - delete( - params?: Params$Resource$Projects$Locations$Lbtrafficextensions$Delete, + list( + params?: Params$Resource$Projects$Locations$Httproutes$List, options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Projects$Locations$Lbtrafficextensions$Delete, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Httproutes$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Lbtrafficextensions$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Httproutes$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Lbtrafficextensions$Delete, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Httproutes$List, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + list(callback: BodyResponseCallback): void; + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Lbtrafficextensions$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Httproutes$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { + ): + | void + | GaxiosPromise + | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Lbtrafficextensions$Delete; + {}) as Params$Resource$Projects$Locations$Httproutes$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Lbtrafficextensions$Delete; + params = {} as Params$Resource$Projects$Locations$Httproutes$List; options = {}; } @@ -5424,83 +3929,82 @@ export namespace networkservices_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1beta1/{+parent}/httpRoutes').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Gets details of the specified `LbTrafficExtension` resource. + * Updates the parameters of a single HttpRoute. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Lbtrafficextensions$Get, + patch( + params: Params$Resource$Projects$Locations$Httproutes$Patch, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Lbtrafficextensions$Get, + patch( + params?: Params$Resource$Projects$Locations$Httproutes$Patch, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Lbtrafficextensions$Get, + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Httproutes$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Lbtrafficextensions$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Httproutes$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Lbtrafficextensions$Get, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Httproutes$Patch, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; - get( + patch(callback: BodyResponseCallback): void; + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Lbtrafficextensions$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Httproutes$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { + ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Lbtrafficextensions$Get; + {}) as Params$Resource$Projects$Locations$Httproutes$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Lbtrafficextensions$Get; + params = {} as Params$Resource$Projects$Locations$Httproutes$Patch; options = {}; } @@ -5515,7 +4019,7 @@ export namespace networkservices_v1beta1 { options: Object.assign( { url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'PATCH', apiVersion: '', }, options @@ -5526,75 +4030,137 @@ export namespace networkservices_v1beta1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } + } + + export interface Params$Resource$Projects$Locations$Httproutes$Create + extends StandardParameters { + /** + * Required. Short name of the HttpRoute resource to be created. + */ + httpRouteId?: string; + /** + * Required. The parent resource of the HttpRoute. Must be in the format `projects/x/locations/global`. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$HttpRoute; + } + export interface Params$Resource$Projects$Locations$Httproutes$Delete + extends StandardParameters { + /** + * Required. A name of the HttpRoute to delete. Must be in the format `projects/x/locations/global/httpRoutes/x`. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Httproutes$Get + extends StandardParameters { + /** + * Required. A name of the HttpRoute to get. Must be in the format `projects/x/locations/global/httpRoutes/x`. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Httproutes$List + extends StandardParameters { + /** + * Maximum number of HttpRoutes to return per call. + */ + pageSize?: number; + /** + * The value returned by the last `ListHttpRoutesResponse` Indicates that this is a continuation of a prior `ListHttpRoutes` call, and that the system should return the next page of data. + */ + pageToken?: string; + /** + * Required. The project and location from which the HttpRoutes should be listed, specified in the format `projects/x/locations/global`. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Httproutes$Patch + extends StandardParameters { + /** + * Required. Name of the HttpRoute resource. It matches pattern `projects/x/locations/global/httpRoutes/http_route_name\>`. + */ + name?: string; + /** + * Optional. Field mask is used to specify the fields to be overwritten in the HttpRoute resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$HttpRoute; + } + + export class Resource$Projects$Locations$Lbrouteextensions { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } /** - * Lists `LbTrafficExtension` resources in a given project and location. + * Creates a new `LbRouteExtension` resource in a given project and location. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Lbtrafficextensions$List, + create( + params: Params$Resource$Projects$Locations$Lbrouteextensions$Create, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Lbtrafficextensions$List, + create( + params?: Params$Resource$Projects$Locations$Lbrouteextensions$Create, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Lbtrafficextensions$List, + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Lbrouteextensions$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Lbtrafficextensions$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Projects$Locations$Lbtrafficextensions$List, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Lbrouteextensions$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Lbrouteextensions$Create, + callback: BodyResponseCallback ): void; - list( + create(callback: BodyResponseCallback): void; + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Lbtrafficextensions$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Lbrouteextensions$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { + ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Lbtrafficextensions$List; + {}) as Params$Resource$Projects$Locations$Lbrouteextensions$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Lbtrafficextensions$List; + {} as Params$Resource$Projects$Locations$Lbrouteextensions$Create; options = {}; } @@ -5608,11 +4174,11 @@ export namespace networkservices_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+parent}/lbTrafficExtensions').replace( + url: (rootUrl + '/v1beta1/{+parent}/lbRouteExtensions').replace( /([^:]\/)\/+/g, '$1' ), - method: 'GET', + method: 'POST', apiVersion: '', }, options @@ -5623,51 +4189,49 @@ export namespace networkservices_v1beta1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Updates the parameters of the specified `LbTrafficExtension` resource. + * Deletes the specified `LbRouteExtension` resource. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - patch( - params: Params$Resource$Projects$Locations$Lbtrafficextensions$Patch, + delete( + params: Params$Resource$Projects$Locations$Lbrouteextensions$Delete, options: StreamMethodOptions ): GaxiosPromise; - patch( - params?: Params$Resource$Projects$Locations$Lbtrafficextensions$Patch, + delete( + params?: Params$Resource$Projects$Locations$Lbrouteextensions$Delete, options?: MethodOptions ): GaxiosPromise; - patch( - params: Params$Resource$Projects$Locations$Lbtrafficextensions$Patch, + delete( + params: Params$Resource$Projects$Locations$Lbrouteextensions$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Lbtrafficextensions$Patch, + delete( + params: Params$Resource$Projects$Locations$Lbrouteextensions$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Lbtrafficextensions$Patch, + delete( + params: Params$Resource$Projects$Locations$Lbrouteextensions$Delete, callback: BodyResponseCallback ): void; - patch(callback: BodyResponseCallback): void; - patch( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Lbtrafficextensions$Patch + | Params$Resource$Projects$Locations$Lbrouteextensions$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -5680,13 +4244,13 @@ export namespace networkservices_v1beta1 { | BodyResponseCallback ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Lbtrafficextensions$Patch; + {}) as Params$Resource$Projects$Locations$Lbrouteextensions$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Lbtrafficextensions$Patch; + {} as Params$Resource$Projects$Locations$Lbrouteextensions$Delete; options = {}; } @@ -5701,7 +4265,7 @@ export namespace networkservices_v1beta1 { options: Object.assign( { url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + method: 'DELETE', apiVersion: '', }, options @@ -5720,148 +4284,59 @@ export namespace networkservices_v1beta1 { return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Projects$Locations$Lbtrafficextensions$Create - extends StandardParameters { - /** - * Required. User-provided ID of the `LbTrafficExtension` resource to be created. - */ - lbTrafficExtensionId?: string; - /** - * Required. The parent resource of the `LbTrafficExtension` resource. Must be in the format `projects/{project\}/locations/{location\}`. - */ - parent?: string; - /** - * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server can ignore the request if it has already been completed. The server guarantees 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, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). - */ - requestId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$LbTrafficExtension; - } - export interface Params$Resource$Projects$Locations$Lbtrafficextensions$Delete - extends StandardParameters { - /** - * Required. The name of the `LbTrafficExtension` resource to delete. Must be in the format `projects/{project\}/locations/{location\}/lbTrafficExtensions/{lb_traffic_extension\}`. - */ - name?: string; - /** - * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server can ignore the request if it has already been completed. The server guarantees 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, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). - */ - requestId?: string; - } - export interface Params$Resource$Projects$Locations$Lbtrafficextensions$Get - extends StandardParameters { - /** - * Required. A name of the `LbTrafficExtension` resource to get. Must be in the format `projects/{project\}/locations/{location\}/lbTrafficExtensions/{lb_traffic_extension\}`. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Lbtrafficextensions$List - extends StandardParameters { - /** - * Optional. Filtering results. - */ - filter?: string; - /** - * Optional. Hint for how to order the results. - */ - orderBy?: string; - /** - * Optional. Requested page size. The server might return fewer items than requested. If unspecified, the server picks an appropriate default. - */ - pageSize?: number; - /** - * Optional. A token identifying a page of results that the server returns. - */ - pageToken?: string; - /** - * Required. The project and location from which the `LbTrafficExtension` resources are listed, specified in the following format: `projects/{project\}/locations/{location\}`. - */ - parent?: string; - } - export interface Params$Resource$Projects$Locations$Lbtrafficextensions$Patch - extends StandardParameters { - /** - * Required. Identifier. Name of the `LbTrafficExtension` resource in the following format: `projects/{project\}/locations/{location\}/lbTrafficExtensions/{lb_traffic_extension\}`. - */ - name?: string; - /** - * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server can ignore the request if it has already been completed. The server guarantees 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, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). - */ - requestId?: string; - /** - * Optional. Used to specify the fields to be overwritten in the `LbTrafficExtension` resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field is overwritten if it is in the mask. If the user does not specify a mask, then all fields are overwritten. - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$LbTrafficExtension; - } - - export class Resource$Projects$Locations$Meshes { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Creates a new Mesh in a given project and location. + * Gets details of the specified `LbRouteExtension` resource. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - create( - params: Params$Resource$Projects$Locations$Meshes$Create, + get( + params: Params$Resource$Projects$Locations$Lbrouteextensions$Get, options: StreamMethodOptions ): GaxiosPromise; - create( - params?: Params$Resource$Projects$Locations$Meshes$Create, + get( + params?: Params$Resource$Projects$Locations$Lbrouteextensions$Get, options?: MethodOptions - ): GaxiosPromise; - create( - params: Params$Resource$Projects$Locations$Meshes$Create, + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Lbrouteextensions$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Meshes$Create, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Lbrouteextensions$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Meshes$Create, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Lbrouteextensions$Get, + callback: BodyResponseCallback ): void; - create(callback: BodyResponseCallback): void; - create( + get(callback: BodyResponseCallback): void; + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Meshes$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Lbrouteextensions$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { + ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Meshes$Create; + {}) as Params$Resource$Projects$Locations$Lbrouteextensions$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Meshes$Create; + params = {} as Params$Resource$Projects$Locations$Lbrouteextensions$Get; options = {}; } @@ -5875,82 +4350,87 @@ export namespace networkservices_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+parent}/meshes').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Deletes a single Mesh. + * Lists `LbRouteExtension` resources in a given project and location. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - delete( - params: Params$Resource$Projects$Locations$Meshes$Delete, + list( + params: Params$Resource$Projects$Locations$Lbrouteextensions$List, options: StreamMethodOptions ): GaxiosPromise; - delete( - params?: Params$Resource$Projects$Locations$Meshes$Delete, + list( + params?: Params$Resource$Projects$Locations$Lbrouteextensions$List, options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Projects$Locations$Meshes$Delete, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Lbrouteextensions$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Meshes$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Lbrouteextensions$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Meshes$Delete, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Lbrouteextensions$List, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + list( + callback: BodyResponseCallback + ): void; + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Meshes$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Lbrouteextensions$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { + ): + | void + | GaxiosPromise + | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Meshes$Delete; + {}) as Params$Resource$Projects$Locations$Lbrouteextensions$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Meshes$Delete; + params = + {} as Params$Resource$Projects$Locations$Lbrouteextensions$List; options = {}; } @@ -5964,79 +4444,85 @@ export namespace networkservices_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1beta1/{+parent}/lbRouteExtensions').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Gets details of a single Mesh. + * Updates the parameters of the specified `LbRouteExtension` resource. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Meshes$Get, + patch( + params: Params$Resource$Projects$Locations$Lbrouteextensions$Patch, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Meshes$Get, + patch( + params?: Params$Resource$Projects$Locations$Lbrouteextensions$Patch, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Meshes$Get, + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Lbrouteextensions$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Meshes$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Lbrouteextensions$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Meshes$Get, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Lbrouteextensions$Patch, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; - get( + patch(callback: BodyResponseCallback): void; + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Meshes$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Lbrouteextensions$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { + ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Meshes$Get; + {}) as Params$Resource$Projects$Locations$Lbrouteextensions$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Meshes$Get; + params = + {} as Params$Resource$Projects$Locations$Lbrouteextensions$Patch; options = {}; } @@ -6051,7 +4537,7 @@ export namespace networkservices_v1beta1 { options: Object.assign( { url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'PATCH', apiVersion: '', }, options @@ -6062,67 +4548,157 @@ export namespace networkservices_v1beta1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } + } + + export interface Params$Resource$Projects$Locations$Lbrouteextensions$Create + extends StandardParameters { + /** + * Required. User-provided ID of the `LbRouteExtension` resource to be created. + */ + lbRouteExtensionId?: string; + /** + * Required. The parent resource of the `LbRouteExtension` resource. Must be in the format `projects/{project\}/locations/{location\}`. + */ + parent?: string; + /** + * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server can ignore the request if it has already been completed. The server guarantees 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, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$LbRouteExtension; + } + export interface Params$Resource$Projects$Locations$Lbrouteextensions$Delete + extends StandardParameters { + /** + * Required. The name of the `LbRouteExtension` resource to delete. Must be in the format `projects/{project\}/locations/{location\}/lbRouteExtensions/{lb_route_extension\}`. + */ + name?: string; + /** + * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server can ignore the request if it has already been completed. The server guarantees 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, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + } + export interface Params$Resource$Projects$Locations$Lbrouteextensions$Get + extends StandardParameters { + /** + * Required. A name of the `LbRouteExtension` resource to get. Must be in the format `projects/{project\}/locations/{location\}/lbRouteExtensions/{lb_route_extension\}`. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Lbrouteextensions$List + extends StandardParameters { + /** + * Optional. Filtering results. + */ + filter?: string; + /** + * Optional. Hint for how to order the results. + */ + orderBy?: string; + /** + * Optional. Requested page size. The server might return fewer items than requested. If unspecified, the server picks an appropriate default. + */ + pageSize?: number; + /** + * Optional. A token identifying a page of results that the server returns. + */ + pageToken?: string; + /** + * Required. The project and location from which the `LbRouteExtension` resources are listed, specified in the following format: `projects/{project\}/locations/{location\}`. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Lbrouteextensions$Patch + extends StandardParameters { + /** + * Required. Identifier. Name of the `LbRouteExtension` resource in the following format: `projects/{project\}/locations/{location\}/lbRouteExtensions/{lb_route_extension\}`. + */ + name?: string; + /** + * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server can ignore the request if it has already been completed. The server guarantees 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, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * Optional. Used to specify the fields to be overwritten in the `LbRouteExtension` resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field is overwritten if it is in the mask. If the user does not specify a mask, then all fields are overwritten. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$LbRouteExtension; + } + + export class Resource$Projects$Locations$Lbtrafficextensions { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } /** - * Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. + * Creates a new `LbTrafficExtension` resource in a given project and location. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - getIamPolicy( - params: Params$Resource$Projects$Locations$Meshes$Getiampolicy, + create( + params: Params$Resource$Projects$Locations$Lbtrafficextensions$Create, options: StreamMethodOptions ): GaxiosPromise; - getIamPolicy( - params?: Params$Resource$Projects$Locations$Meshes$Getiampolicy, + create( + params?: Params$Resource$Projects$Locations$Lbtrafficextensions$Create, options?: MethodOptions - ): GaxiosPromise; - getIamPolicy( - params: Params$Resource$Projects$Locations$Meshes$Getiampolicy, + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Lbtrafficextensions$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Meshes$Getiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Lbtrafficextensions$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Meshes$Getiampolicy, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Lbtrafficextensions$Create, + callback: BodyResponseCallback ): void; - getIamPolicy(callback: BodyResponseCallback): void; - getIamPolicy( + create(callback: BodyResponseCallback): void; + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Meshes$Getiampolicy - | BodyResponseCallback + | Params$Resource$Projects$Locations$Lbtrafficextensions$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { + ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Meshes$Getiampolicy; + {}) as Params$Resource$Projects$Locations$Lbtrafficextensions$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Meshes$Getiampolicy; + params = + {} as Params$Resource$Projects$Locations$Lbtrafficextensions$Create; options = {}; } @@ -6136,85 +4712,83 @@ export namespace networkservices_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+resource}:getIamPolicy').replace( + url: (rootUrl + '/v1beta1/{+parent}/lbTrafficExtensions').replace( /([^:]\/)\/+/g, '$1' ), - method: 'GET', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['resource'], - pathParams: ['resource'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Lists Meshes in a given project and location. + * Deletes the specified `LbTrafficExtension` resource. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Meshes$List, + delete( + params: Params$Resource$Projects$Locations$Lbtrafficextensions$Delete, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Meshes$List, + delete( + params?: Params$Resource$Projects$Locations$Lbtrafficextensions$Delete, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Meshes$List, + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Lbtrafficextensions$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Meshes$List, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Lbtrafficextensions$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Meshes$List, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Lbtrafficextensions$Delete, + callback: BodyResponseCallback ): void; - list(callback: BodyResponseCallback): void; - list( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Meshes$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Lbtrafficextensions$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { + ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Meshes$List; + {}) as Params$Resource$Projects$Locations$Lbtrafficextensions$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Meshes$List; + params = + {} as Params$Resource$Projects$Locations$Lbtrafficextensions$Delete; options = {}; } @@ -6228,82 +4802,83 @@ export namespace networkservices_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+parent}/meshes').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Updates the parameters of a single Mesh. + * Gets details of the specified `LbTrafficExtension` resource. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - patch( - params: Params$Resource$Projects$Locations$Meshes$Patch, + get( + params: Params$Resource$Projects$Locations$Lbtrafficextensions$Get, options: StreamMethodOptions ): GaxiosPromise; - patch( - params?: Params$Resource$Projects$Locations$Meshes$Patch, + get( + params?: Params$Resource$Projects$Locations$Lbtrafficextensions$Get, options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Projects$Locations$Meshes$Patch, + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Lbtrafficextensions$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Meshes$Patch, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Lbtrafficextensions$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Meshes$Patch, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Lbtrafficextensions$Get, + callback: BodyResponseCallback ): void; - patch(callback: BodyResponseCallback): void; - patch( + get(callback: BodyResponseCallback): void; + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Meshes$Patch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Lbtrafficextensions$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { + ): + | void + | GaxiosPromise + | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Meshes$Patch; + {}) as Params$Resource$Projects$Locations$Lbtrafficextensions$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Meshes$Patch; + params = + {} as Params$Resource$Projects$Locations$Lbtrafficextensions$Get; options = {}; } @@ -6318,7 +4893,7 @@ export namespace networkservices_v1beta1 { options: Object.assign( { url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + method: 'GET', apiVersion: '', }, options @@ -6329,67 +4904,75 @@ export namespace networkservices_v1beta1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. + * Lists `LbTrafficExtension` resources in a given project and location. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - setIamPolicy( - params: Params$Resource$Projects$Locations$Meshes$Setiampolicy, + list( + params: Params$Resource$Projects$Locations$Lbtrafficextensions$List, options: StreamMethodOptions ): GaxiosPromise; - setIamPolicy( - params?: Params$Resource$Projects$Locations$Meshes$Setiampolicy, + list( + params?: Params$Resource$Projects$Locations$Lbtrafficextensions$List, options?: MethodOptions - ): GaxiosPromise; - setIamPolicy( - params: Params$Resource$Projects$Locations$Meshes$Setiampolicy, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Lbtrafficextensions$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - setIamPolicy( - params: Params$Resource$Projects$Locations$Meshes$Setiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Lbtrafficextensions$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - setIamPolicy( - params: Params$Resource$Projects$Locations$Meshes$Setiampolicy, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Lbtrafficextensions$List, + callback: BodyResponseCallback ): void; - setIamPolicy(callback: BodyResponseCallback): void; - setIamPolicy( + list( + callback: BodyResponseCallback + ): void; + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Meshes$Setiampolicy - | BodyResponseCallback + | Params$Resource$Projects$Locations$Lbtrafficextensions$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { + ): + | void + | GaxiosPromise + | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Meshes$Setiampolicy; + {}) as Params$Resource$Projects$Locations$Lbtrafficextensions$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Meshes$Setiampolicy; + params = + {} as Params$Resource$Projects$Locations$Lbtrafficextensions$List; options = {}; } @@ -6403,90 +4986,85 @@ export namespace networkservices_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+resource}:setIamPolicy').replace( + url: (rootUrl + '/v1beta1/{+parent}/lbTrafficExtensions').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['resource'], - pathParams: ['resource'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * 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. + * Updates the parameters of the specified `LbTrafficExtension` resource. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - testIamPermissions( - params: Params$Resource$Projects$Locations$Meshes$Testiampermissions, + patch( + params: Params$Resource$Projects$Locations$Lbtrafficextensions$Patch, options: StreamMethodOptions ): GaxiosPromise; - testIamPermissions( - params?: Params$Resource$Projects$Locations$Meshes$Testiampermissions, + patch( + params?: Params$Resource$Projects$Locations$Lbtrafficextensions$Patch, options?: MethodOptions - ): GaxiosPromise; - testIamPermissions( - params: Params$Resource$Projects$Locations$Meshes$Testiampermissions, + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Lbtrafficextensions$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - testIamPermissions( - params: Params$Resource$Projects$Locations$Meshes$Testiampermissions, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - testIamPermissions( - params: Params$Resource$Projects$Locations$Meshes$Testiampermissions, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Lbtrafficextensions$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - testIamPermissions( - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Lbtrafficextensions$Patch, + callback: BodyResponseCallback ): void; - testIamPermissions( + patch(callback: BodyResponseCallback): void; + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Meshes$Testiampermissions - | BodyResponseCallback + | Params$Resource$Projects$Locations$Lbtrafficextensions$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { + ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Meshes$Testiampermissions; + {}) as Params$Resource$Projects$Locations$Lbtrafficextensions$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Meshes$Testiampermissions; + {} as Params$Resource$Projects$Locations$Lbtrafficextensions$Patch; options = {}; } @@ -6500,186 +5078,168 @@ export namespace networkservices_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+resource}:testIamPermissions').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', apiVersion: '', }, options ), - params, - requiredParams: ['resource'], - pathParams: ['resource'], + params, + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } } - export interface Params$Resource$Projects$Locations$Meshes$Create + export interface Params$Resource$Projects$Locations$Lbtrafficextensions$Create extends StandardParameters { /** - * Required. Short name of the Mesh resource to be created. + * Required. User-provided ID of the `LbTrafficExtension` resource to be created. */ - meshId?: string; + lbTrafficExtensionId?: string; /** - * Required. The parent resource of the Mesh. Must be in the format `projects/x/locations/global`. + * Required. The parent resource of the `LbTrafficExtension` resource. Must be in the format `projects/{project\}/locations/{location\}`. */ parent?: string; + /** + * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server can ignore the request if it has already been completed. The server guarantees 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, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; /** * Request body metadata */ - requestBody?: Schema$Mesh; + requestBody?: Schema$LbTrafficExtension; } - export interface Params$Resource$Projects$Locations$Meshes$Delete + export interface Params$Resource$Projects$Locations$Lbtrafficextensions$Delete extends StandardParameters { /** - * Required. A name of the Mesh to delete. Must be in the format `projects/x/locations/global/meshes/x`. + * Required. The name of the `LbTrafficExtension` resource to delete. Must be in the format `projects/{project\}/locations/{location\}/lbTrafficExtensions/{lb_traffic_extension\}`. */ name?: string; + /** + * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server can ignore the request if it has already been completed. The server guarantees 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, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; } - export interface Params$Resource$Projects$Locations$Meshes$Get + export interface Params$Resource$Projects$Locations$Lbtrafficextensions$Get extends StandardParameters { /** - * Required. A name of the Mesh to get. Must be in the format `projects/x/locations/global/meshes/x`. + * Required. A name of the `LbTrafficExtension` resource to get. Must be in the format `projects/{project\}/locations/{location\}/lbTrafficExtensions/{lb_traffic_extension\}`. */ name?: string; } - export interface Params$Resource$Projects$Locations$Meshes$Getiampolicy + export interface Params$Resource$Projects$Locations$Lbtrafficextensions$List extends StandardParameters { /** - * 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). + * Optional. Filtering results. */ - 'options.requestedPolicyVersion'?: number; + filter?: string; /** - * REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + * Optional. Hint for how to order the results. */ - resource?: string; - } - export interface Params$Resource$Projects$Locations$Meshes$List - extends StandardParameters { + orderBy?: string; /** - * Maximum number of Meshes to return per call. + * Optional. Requested page size. The server might return fewer items than requested. If unspecified, the server picks an appropriate default. */ pageSize?: number; /** - * The value returned by the last `ListMeshesResponse` Indicates that this is a continuation of a prior `ListMeshes` call, and that the system should return the next page of data. + * Optional. A token identifying a page of results that the server returns. */ pageToken?: string; /** - * Required. The project and location from which the Meshes should be listed, specified in the format `projects/x/locations/global`. + * Required. The project and location from which the `LbTrafficExtension` resources are listed, specified in the following format: `projects/{project\}/locations/{location\}`. */ parent?: string; } - export interface Params$Resource$Projects$Locations$Meshes$Patch + export interface Params$Resource$Projects$Locations$Lbtrafficextensions$Patch extends StandardParameters { /** - * Required. Name of the Mesh resource. It matches pattern `projects/x/locations/global/meshes/`. + * Required. Identifier. Name of the `LbTrafficExtension` resource in the following format: `projects/{project\}/locations/{location\}/lbTrafficExtensions/{lb_traffic_extension\}`. */ name?: string; /** - * Optional. Field mask is used to specify the fields to be overwritten in the Mesh resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten. - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$Mesh; - } - export interface Params$Resource$Projects$Locations$Meshes$Setiampolicy - extends StandardParameters { - /** - * REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - */ - resource?: string; - - /** - * Request body metadata + * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server can ignore the request if it has already been completed. The server guarantees 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, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ - requestBody?: Schema$SetIamPolicyRequest; - } - export interface Params$Resource$Projects$Locations$Meshes$Testiampermissions - extends StandardParameters { + requestId?: string; /** - * REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + * Optional. Used to specify the fields to be overwritten in the `LbTrafficExtension` resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field is overwritten if it is in the mask. If the user does not specify a mask, then all fields are overwritten. */ - resource?: string; + updateMask?: string; /** * Request body metadata */ - requestBody?: Schema$TestIamPermissionsRequest; + requestBody?: Schema$LbTrafficExtension; } - export class Resource$Projects$Locations$Operations { + export class Resource$Projects$Locations$Meshes { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * 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`. + * Creates a new Mesh in a given project and location. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - cancel( - params: Params$Resource$Projects$Locations$Operations$Cancel, + create( + params: Params$Resource$Projects$Locations$Meshes$Create, options: StreamMethodOptions ): GaxiosPromise; - cancel( - params?: Params$Resource$Projects$Locations$Operations$Cancel, + create( + params?: Params$Resource$Projects$Locations$Meshes$Create, options?: MethodOptions - ): GaxiosPromise; - cancel( - params: Params$Resource$Projects$Locations$Operations$Cancel, + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Meshes$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Projects$Locations$Operations$Cancel, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Meshes$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Projects$Locations$Operations$Cancel, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Meshes$Create, + callback: BodyResponseCallback ): void; - cancel(callback: BodyResponseCallback): void; - cancel( + create(callback: BodyResponseCallback): void; + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Operations$Cancel - | BodyResponseCallback + | Params$Resource$Projects$Locations$Meshes$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { + ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Operations$Cancel; + {}) as Params$Resource$Projects$Locations$Meshes$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Operations$Cancel; + params = {} as Params$Resource$Projects$Locations$Meshes$Create; options = {}; } @@ -6693,7 +5253,7 @@ export namespace networkservices_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+name}:cancel').replace( + url: (rootUrl + '/v1beta1/{+parent}/meshes').replace( /([^:]\/)\/+/g, '$1' ), @@ -6703,22 +5263,22 @@ export namespace networkservices_v1beta1 { options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * 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`. + * Deletes a single Mesh. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -6726,49 +5286,135 @@ export namespace networkservices_v1beta1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Operations$Delete, + params: Params$Resource$Projects$Locations$Meshes$Delete, options: StreamMethodOptions ): GaxiosPromise; delete( - params?: Params$Resource$Projects$Locations$Operations$Delete, + params?: Params$Resource$Projects$Locations$Meshes$Delete, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; delete( - params: Params$Resource$Projects$Locations$Operations$Delete, + params: Params$Resource$Projects$Locations$Meshes$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Operations$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Meshes$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Operations$Delete, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Meshes$Delete, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; + delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Operations$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Meshes$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Meshes$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Meshes$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://networkservices.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets details of a single Mesh. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Projects$Locations$Meshes$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Meshes$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Meshes$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Meshes$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Meshes$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Meshes$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { + ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Operations$Delete; + {}) as Params$Resource$Projects$Locations$Meshes$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Operations$Delete; + params = {} as Params$Resource$Projects$Locations$Meshes$Get; options = {}; } @@ -6783,7 +5429,7 @@ export namespace networkservices_v1beta1 { options: Object.assign( { url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + method: 'GET', apiVersion: '', }, options @@ -6794,67 +5440,70 @@ export namespace networkservices_v1beta1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * 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. + * Lists Meshes in a given project and location. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Operations$Get, + list( + params: Params$Resource$Projects$Locations$Meshes$List, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Operations$Get, + list( + params?: Params$Resource$Projects$Locations$Meshes$List, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Operations$Get, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Meshes$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Operations$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Meshes$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Operations$Get, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Meshes$List, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; - get( + list(callback: BodyResponseCallback): void; + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Operations$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Meshes$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { + ): + | void + | GaxiosPromise + | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Operations$Get; + {}) as Params$Resource$Projects$Locations$Meshes$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Operations$Get; + params = {} as Params$Resource$Projects$Locations$Meshes$List; options = {}; } @@ -6868,84 +5517,82 @@ export namespace networkservices_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1beta1/{+parent}/meshes').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + * Updates the parameters of a single Mesh. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Operations$List, + patch( + params: Params$Resource$Projects$Locations$Meshes$Patch, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Operations$List, + patch( + params?: Params$Resource$Projects$Locations$Meshes$Patch, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Operations$List, + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Meshes$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Operations$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Meshes$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Operations$List, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Meshes$Patch, + callback: BodyResponseCallback ): void; - list(callback: BodyResponseCallback): void; - list( + patch(callback: BodyResponseCallback): void; + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Operations$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Meshes$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { + ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Operations$List; + {}) as Params$Resource$Projects$Locations$Meshes$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Operations$List; + params = {} as Params$Resource$Projects$Locations$Meshes$Patch; options = {}; } @@ -6959,11 +5606,8 @@ export namespace networkservices_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+name}/operations').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', apiVersion: '', }, options @@ -6974,121 +5618,225 @@ export namespace networkservices_v1beta1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } } - export interface Params$Resource$Projects$Locations$Operations$Cancel + export interface Params$Resource$Projects$Locations$Meshes$Create extends StandardParameters { /** - * The name of the operation resource to be cancelled. + * Required. Short name of the Mesh resource to be created. */ - name?: string; + meshId?: string; + /** + * Required. The parent resource of the Mesh. Must be in the format `projects/x/locations/global`. + */ + parent?: string; /** * Request body metadata */ - requestBody?: Schema$CancelOperationRequest; + requestBody?: Schema$Mesh; } - export interface Params$Resource$Projects$Locations$Operations$Delete + export interface Params$Resource$Projects$Locations$Meshes$Delete extends StandardParameters { /** - * The name of the operation resource to be deleted. + * Required. A name of the Mesh to delete. Must be in the format `projects/x/locations/global/meshes/x`. */ name?: string; } - export interface Params$Resource$Projects$Locations$Operations$Get + export interface Params$Resource$Projects$Locations$Meshes$Get extends StandardParameters { /** - * The name of the operation resource. + * Required. A name of the Mesh to get. Must be in the format `projects/x/locations/global/meshes/x`. */ name?: string; } - export interface Params$Resource$Projects$Locations$Operations$List + export interface Params$Resource$Projects$Locations$Meshes$List extends StandardParameters { /** - * The standard list filter. + * Maximum number of Meshes to return per call. */ - filter?: string; + pageSize?: number; /** - * The name of the operation's parent resource. + * The value returned by the last `ListMeshesResponse` Indicates that this is a continuation of a prior `ListMeshes` call, and that the system should return the next page of data. + */ + pageToken?: string; + /** + * Required. The project and location from which the Meshes should be listed, specified in the format `projects/x/locations/global`. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Meshes$Patch + extends StandardParameters { + /** + * Required. Name of the Mesh resource. It matches pattern `projects/x/locations/global/meshes/`. */ name?: string; /** - * The standard list page size. + * Optional. Field mask is used to specify the fields to be overwritten in the Mesh resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten. */ - pageSize?: number; + updateMask?: string; + /** - * The standard list page token. + * Request body metadata */ - pageToken?: string; + requestBody?: Schema$Mesh; } - export class Resource$Projects$Locations$Servicebindings { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; + export class Resource$Projects$Locations$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * 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`. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + cancel( + params: Params$Resource$Projects$Locations$Operations$Cancel, + options: StreamMethodOptions + ): GaxiosPromise; + cancel( + params?: Params$Resource$Projects$Locations$Operations$Cancel, + options?: MethodOptions + ): GaxiosPromise; + cancel( + params: Params$Resource$Projects$Locations$Operations$Cancel, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancel( + params: Params$Resource$Projects$Locations$Operations$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancel( + params: Params$Resource$Projects$Locations$Operations$Cancel, + callback: BodyResponseCallback + ): void; + cancel(callback: BodyResponseCallback): void; + cancel( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Operations$Cancel + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Operations$Cancel; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Operations$Cancel; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://networkservices.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+name}:cancel').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } } /** - * Creates a new ServiceBinding in a given project and location. + * 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`. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - create( - params: Params$Resource$Projects$Locations$Servicebindings$Create, + delete( + params: Params$Resource$Projects$Locations$Operations$Delete, options: StreamMethodOptions ): GaxiosPromise; - create( - params?: Params$Resource$Projects$Locations$Servicebindings$Create, + delete( + params?: Params$Resource$Projects$Locations$Operations$Delete, options?: MethodOptions - ): GaxiosPromise; - create( - params: Params$Resource$Projects$Locations$Servicebindings$Create, + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Servicebindings$Create, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Operations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Servicebindings$Create, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Operations$Delete, + callback: BodyResponseCallback ): void; - create(callback: BodyResponseCallback): void; - create( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Servicebindings$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Operations$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { + ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Servicebindings$Create; + {}) as Params$Resource$Projects$Locations$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Servicebindings$Create; + params = {} as Params$Resource$Projects$Locations$Operations$Delete; options = {}; } @@ -7102,64 +5850,61 @@ export namespace networkservices_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+parent}/serviceBindings').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Deletes a single ServiceBinding. + * 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. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - delete( - params: Params$Resource$Projects$Locations$Servicebindings$Delete, + get( + params: Params$Resource$Projects$Locations$Operations$Get, options: StreamMethodOptions ): GaxiosPromise; - delete( - params?: Params$Resource$Projects$Locations$Servicebindings$Delete, + get( + params?: Params$Resource$Projects$Locations$Operations$Get, options?: MethodOptions ): GaxiosPromise; - delete( - params: Params$Resource$Projects$Locations$Servicebindings$Delete, + get( + params: Params$Resource$Projects$Locations$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Servicebindings$Delete, + get( + params: Params$Resource$Projects$Locations$Operations$Get, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Servicebindings$Delete, + get( + params: Params$Resource$Projects$Locations$Operations$Get, callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + get(callback: BodyResponseCallback): void; + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Servicebindings$Delete + | Params$Resource$Projects$Locations$Operations$Get | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -7172,13 +5917,12 @@ export namespace networkservices_v1beta1 { | BodyResponseCallback ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Servicebindings$Delete; + {}) as Params$Resource$Projects$Locations$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Servicebindings$Delete; + params = {} as Params$Resource$Projects$Locations$Operations$Get; options = {}; } @@ -7193,7 +5937,7 @@ export namespace networkservices_v1beta1 { options: Object.assign( { url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + method: 'GET', apiVersion: '', }, options @@ -7214,57 +5958,62 @@ export namespace networkservices_v1beta1 { } /** - * Gets details of a single ServiceBinding. + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Servicebindings$Get, + list( + params: Params$Resource$Projects$Locations$Operations$List, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Servicebindings$Get, + list( + params?: Params$Resource$Projects$Locations$Operations$List, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Servicebindings$Get, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Servicebindings$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Operations$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Servicebindings$Get, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Operations$List, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; - get( + list(callback: BodyResponseCallback): void; + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Servicebindings$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Operations$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { + ): + | void + | GaxiosPromise + | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Servicebindings$Get; + {}) as Params$Resource$Projects$Locations$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Servicebindings$Get; + params = {} as Params$Resource$Projects$Locations$Operations$List; options = {}; } @@ -7278,7 +6027,10 @@ export namespace networkservices_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1beta1/{+name}/operations').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'GET', apiVersion: '', }, @@ -7290,68 +6042,121 @@ export namespace networkservices_v1beta1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } + } + export interface Params$Resource$Projects$Locations$Operations$Cancel + extends StandardParameters { /** - * Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. + * The name of the operation resource to be cancelled. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$CancelOperationRequest; + } + export interface Params$Resource$Projects$Locations$Operations$Delete + extends StandardParameters { + /** + * The name of the operation resource to be deleted. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Operations$Get + extends StandardParameters { + /** + * The name of the operation resource. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Operations$List + extends StandardParameters { + /** + * The standard list filter. + */ + filter?: string; + /** + * The name of the operation's parent resource. + */ + name?: string; + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. + */ + pageToken?: string; + } + + export class Resource$Projects$Locations$Servicebindings { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Creates a new ServiceBinding in a given project and location. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - getIamPolicy( - params: Params$Resource$Projects$Locations$Servicebindings$Getiampolicy, + create( + params: Params$Resource$Projects$Locations$Servicebindings$Create, options: StreamMethodOptions ): GaxiosPromise; - getIamPolicy( - params?: Params$Resource$Projects$Locations$Servicebindings$Getiampolicy, + create( + params?: Params$Resource$Projects$Locations$Servicebindings$Create, options?: MethodOptions - ): GaxiosPromise; - getIamPolicy( - params: Params$Resource$Projects$Locations$Servicebindings$Getiampolicy, + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Servicebindings$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Servicebindings$Getiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Servicebindings$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Servicebindings$Getiampolicy, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Servicebindings$Create, + callback: BodyResponseCallback ): void; - getIamPolicy(callback: BodyResponseCallback): void; - getIamPolicy( + create(callback: BodyResponseCallback): void; + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Servicebindings$Getiampolicy - | BodyResponseCallback + | Params$Resource$Projects$Locations$Servicebindings$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { + ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Servicebindings$Getiampolicy; + {}) as Params$Resource$Projects$Locations$Servicebindings$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Servicebindings$Getiampolicy; + {} as Params$Resource$Projects$Locations$Servicebindings$Create; options = {}; } @@ -7365,89 +6170,83 @@ export namespace networkservices_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+resource}:getIamPolicy').replace( + url: (rootUrl + '/v1beta1/{+parent}/serviceBindings').replace( /([^:]\/)\/+/g, '$1' ), - method: 'GET', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['resource'], - pathParams: ['resource'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Lists ServiceBinding in a given project and location. + * Deletes a single ServiceBinding. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Servicebindings$List, + delete( + params: Params$Resource$Projects$Locations$Servicebindings$Delete, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Servicebindings$List, + delete( + params?: Params$Resource$Projects$Locations$Servicebindings$Delete, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Servicebindings$List, + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Servicebindings$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Servicebindings$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Projects$Locations$Servicebindings$List, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Servicebindings$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Servicebindings$Delete, + callback: BodyResponseCallback ): void; - list( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Servicebindings$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Servicebindings$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { + ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Servicebindings$List; + {}) as Params$Resource$Projects$Locations$Servicebindings$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Servicebindings$List; + params = + {} as Params$Resource$Projects$Locations$Servicebindings$Delete; options = {}; } @@ -7461,83 +6260,79 @@ export namespace networkservices_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+parent}/serviceBindings').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. + * Gets details of a single ServiceBinding. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - setIamPolicy( - params: Params$Resource$Projects$Locations$Servicebindings$Setiampolicy, + get( + params: Params$Resource$Projects$Locations$Servicebindings$Get, options: StreamMethodOptions ): GaxiosPromise; - setIamPolicy( - params?: Params$Resource$Projects$Locations$Servicebindings$Setiampolicy, + get( + params?: Params$Resource$Projects$Locations$Servicebindings$Get, options?: MethodOptions - ): GaxiosPromise; - setIamPolicy( - params: Params$Resource$Projects$Locations$Servicebindings$Setiampolicy, + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Servicebindings$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - setIamPolicy( - params: Params$Resource$Projects$Locations$Servicebindings$Setiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Servicebindings$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - setIamPolicy( - params: Params$Resource$Projects$Locations$Servicebindings$Setiampolicy, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Servicebindings$Get, + callback: BodyResponseCallback ): void; - setIamPolicy(callback: BodyResponseCallback): void; - setIamPolicy( + get(callback: BodyResponseCallback): void; + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Servicebindings$Setiampolicy - | BodyResponseCallback + | Params$Resource$Projects$Locations$Servicebindings$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { + ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Servicebindings$Setiampolicy; + {}) as Params$Resource$Projects$Locations$Servicebindings$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Servicebindings$Setiampolicy; + params = {} as Params$Resource$Projects$Locations$Servicebindings$Get; options = {}; } @@ -7551,90 +6346,86 @@ export namespace networkservices_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+resource}:setIamPolicy').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['resource'], - pathParams: ['resource'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * 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. + * Lists ServiceBinding in a given project and location. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - testIamPermissions( - params: Params$Resource$Projects$Locations$Servicebindings$Testiampermissions, + list( + params: Params$Resource$Projects$Locations$Servicebindings$List, options: StreamMethodOptions ): GaxiosPromise; - testIamPermissions( - params?: Params$Resource$Projects$Locations$Servicebindings$Testiampermissions, + list( + params?: Params$Resource$Projects$Locations$Servicebindings$List, options?: MethodOptions - ): GaxiosPromise; - testIamPermissions( - params: Params$Resource$Projects$Locations$Servicebindings$Testiampermissions, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Servicebindings$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - testIamPermissions( - params: Params$Resource$Projects$Locations$Servicebindings$Testiampermissions, + list( + params: Params$Resource$Projects$Locations$Servicebindings$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - testIamPermissions( - params: Params$Resource$Projects$Locations$Servicebindings$Testiampermissions, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Servicebindings$List, + callback: BodyResponseCallback ): void; - testIamPermissions( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - testIamPermissions( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Servicebindings$Testiampermissions - | BodyResponseCallback + | Params$Resource$Projects$Locations$Servicebindings$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Servicebindings$Testiampermissions; + {}) as Params$Resource$Projects$Locations$Servicebindings$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Servicebindings$Testiampermissions; + params = {} as Params$Resource$Projects$Locations$Servicebindings$List; options = {}; } @@ -7648,27 +6439,27 @@ export namespace networkservices_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+resource}:testIamPermissions').replace( + url: (rootUrl + '/v1beta1/{+parent}/serviceBindings').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['resource'], - pathParams: ['resource'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } } @@ -7703,17 +6494,6 @@ export namespace networkservices_v1beta1 { */ name?: string; } - export interface Params$Resource$Projects$Locations$Servicebindings$Getiampolicy - extends StandardParameters { - /** - * 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). - */ - 'options.requestedPolicyVersion'?: number; - /** - * REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - */ - resource?: string; - } export interface Params$Resource$Projects$Locations$Servicebindings$List extends StandardParameters { /** @@ -7729,30 +6509,6 @@ export namespace networkservices_v1beta1 { */ parent?: string; } - export interface Params$Resource$Projects$Locations$Servicebindings$Setiampolicy - extends StandardParameters { - /** - * REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - */ - resource?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$SetIamPolicyRequest; - } - export interface Params$Resource$Projects$Locations$Servicebindings$Testiampermissions - extends StandardParameters { - /** - * REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - */ - resource?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$TestIamPermissionsRequest; - } export class Resource$Projects$Locations$Servicelbpolicies { context: APIRequestContext; @@ -9590,7 +8346,7 @@ export namespace networkservices_v1beta1 { export interface Params$Resource$Projects$Locations$Tlsroutes$Patch extends StandardParameters { /** - * Required. Name of the TlsRoute resource. It matches pattern `projects/x/locations/global/tlsRoutes/tls_route_name\>`. + * Identifier. Name of the TlsRoute resource. It matches pattern `projects/x/locations/global/tlsRoutes/tls_route_name\>`. */ name?: string; /** diff --git a/src/apis/ondemandscanning/v1.ts b/src/apis/ondemandscanning/v1.ts index e5636cc536..7fc3a2dfe8 100644 --- a/src/apis/ondemandscanning/v1.ts +++ b/src/apis/ondemandscanning/v1.ts @@ -541,10 +541,6 @@ export namespace ondemandscanning_v1 { * The status of an SBOM generation. */ sbomStatus?: Schema$SBOMStatus; - /** - * The status of an vulnerability attestation generation. - */ - vulnerabilityAttestation?: Schema$VulnerabilityAttestation; } /** * Deprecated. Prefer to use a regular Occurrence, and populate the Envelope at the top level of the Occurrence. @@ -1653,23 +1649,6 @@ export namespace ondemandscanning_v1 { */ vulnerabilityId?: string | null; } - /** - * The status of an vulnerability attestation generation. - */ - export interface Schema$VulnerabilityAttestation { - /** - * If failure, the error reason for why the attestation generation failed. - */ - error?: string | null; - /** - * The last time we attempted to generate an attestation. - */ - lastAttemptTime?: string | null; - /** - * The success/failure state of the latest attestation attempt. - */ - state?: string | null; - } /** * An occurrence of a severity vulnerability on a resource. */ diff --git a/src/apis/ondemandscanning/v1beta1.ts b/src/apis/ondemandscanning/v1beta1.ts index f0e997d02b..5c7bd6fc2f 100644 --- a/src/apis/ondemandscanning/v1beta1.ts +++ b/src/apis/ondemandscanning/v1beta1.ts @@ -537,10 +537,6 @@ export namespace ondemandscanning_v1beta1 { * The status of an SBOM generation. */ sbomStatus?: Schema$SBOMStatus; - /** - * The status of an vulnerability attestation generation. - */ - vulnerabilityAttestation?: Schema$VulnerabilityAttestation; } /** * Deprecated. Prefer to use a regular Occurrence, and populate the Envelope at the top level of the Occurrence. @@ -1649,23 +1645,6 @@ export namespace ondemandscanning_v1beta1 { */ vulnerabilityId?: string | null; } - /** - * The status of an vulnerability attestation generation. - */ - export interface Schema$VulnerabilityAttestation { - /** - * If failure, the error reason for why the attestation generation failed. - */ - error?: string | null; - /** - * The last time we attempted to generate an attestation. - */ - lastAttemptTime?: string | null; - /** - * The success/failure state of the latest attestation attempt. - */ - state?: string | null; - } /** * An occurrence of a severity vulnerability on a resource. */ diff --git a/src/apis/playdeveloperreporting/v1alpha1.ts b/src/apis/playdeveloperreporting/v1alpha1.ts index f546f25708..ff32490d47 100644 --- a/src/apis/playdeveloperreporting/v1alpha1.ts +++ b/src/apis/playdeveloperreporting/v1alpha1.ts @@ -576,11 +576,11 @@ export namespace playdeveloperreporting_v1alpha1 { */ export interface Schema$GooglePlayDeveloperReportingV1alpha1QueryErrorCountMetricSetRequest { /** - * Dimensions to slice the data by. **Supported dimensions:** * `apiLevel` (string): the API level of Android that was running on the user's device, e.g., 26. * `versionCode` (int64): unique identifier of the user's device model. The form of the identifier is 'deviceBrand/device', where deviceBrand corresponds to Build.BRAND and device corresponds to Build.DEVICE, e.g., google/coral. * `deviceModel` (string): unique identifier of the user's device model. * `deviceType` (string): identifier of the device's form factor, e.g., PHONE. * `reportType` (string): the type of error. The value should correspond to one of the possible values in ErrorType. * `isUserPerceived` (string): denotes whether error is user perceived or not, USER_PERCEIVED or NOT_USER_PERCEIVED. * `issueId` (string): the id an error was assigned to. The value should correspond to the `{issue\}` component of the issue name. * `deviceRamBucket` (int64): RAM of the device, in MB, in buckets (3GB, 4GB, etc.). * `deviceSocMake` (string): Make of the device's primary system-on-chip, e.g., Samsung. [Reference](https://developer.android.com/reference/android/os/Build#SOC_MANUFACTURER) * `deviceSocModel` (string): Model of the device's primary system-on-chip, e.g., "Exynos 2100". [Reference](https://developer.android.com/reference/android/os/Build#SOC_MODEL) * `deviceCpuMake` (string): Make of the device's CPU, e.g., Qualcomm. * `deviceCpuModel` (string): Model of the device's CPU, e.g., "Kryo 240". * `deviceGpuMake` (string): Make of the device's GPU, e.g., ARM. * `deviceGpuModel` (string): Model of the device's GPU, e.g., Mali. * `deviceGpuVersion` (string): Version of the device's GPU, e.g., T750. * `deviceVulkanVersion` (string): Vulkan version of the device, e.g., "4198400". * `deviceGlEsVersion` (string): OpenGL ES version of the device, e.g., "196610". * `deviceScreenSize` (string): Screen size of the device, e.g., NORMAL, LARGE. * `deviceScreenDpi` (string): Screen density of the device, e.g., mdpi, hdpi. + * Dimensions to slice the data by. **Supported dimensions:** * `apiLevel` (string): the API level of Android that was running on the user's device, e.g., 26. * `versionCode` (int64): unique identifier of the user's device model. The form of the identifier is 'deviceBrand/device', where deviceBrand corresponds to Build.BRAND and device corresponds to Build.DEVICE, e.g., google/coral. * `deviceModel` (string): unique identifier of the user's device model. * `deviceType` (string): identifier of the device's form factor, e.g., PHONE. * `reportType` (string): the type of error. The value should correspond to one of the possible values in ErrorType. * `issueId` (string): the id an error was assigned to. The value should correspond to the `{issue\}` component of the issue name. * `deviceRamBucket` (int64): RAM of the device, in MB, in buckets (3GB, 4GB, etc.). * `deviceSocMake` (string): Make of the device's primary system-on-chip, e.g., Samsung. [Reference](https://developer.android.com/reference/android/os/Build#SOC_MANUFACTURER) * `deviceSocModel` (string): Model of the device's primary system-on-chip, e.g., "Exynos 2100". [Reference](https://developer.android.com/reference/android/os/Build#SOC_MODEL) * `deviceCpuMake` (string): Make of the device's CPU, e.g., Qualcomm. * `deviceCpuModel` (string): Model of the device's CPU, e.g., "Kryo 240". * `deviceGpuMake` (string): Make of the device's GPU, e.g., ARM. * `deviceGpuModel` (string): Model of the device's GPU, e.g., Mali. * `deviceGpuVersion` (string): Version of the device's GPU, e.g., T750. * `deviceVulkanVersion` (string): Vulkan version of the device, e.g., "4198400". * `deviceGlEsVersion` (string): OpenGL ES version of the device, e.g., "196610". * `deviceScreenSize` (string): Screen size of the device, e.g., NORMAL, LARGE. * `deviceScreenDpi` (string): Screen density of the device, e.g., mdpi, hdpi. */ dimensions?: string[] | null; /** - * Filters to apply to data. The filtering expression follows [AIP-160](https://google.aip.dev/160) standard and supports filtering by equality of all breakdown dimensions. + * Filters to apply to data. The filtering expression follows [AIP-160](https://google.aip.dev/160) standard and supports filtering by equality of all breakdown dimensions and: * `isUserPerceived` (string): denotes whether error is user perceived or not, USER_PERCEIVED or NOT_USER_PERCEIVED. */ filter?: string | null; /** diff --git a/src/apis/playdeveloperreporting/v1beta1.ts b/src/apis/playdeveloperreporting/v1beta1.ts index f2c395d6b7..a43b428715 100644 --- a/src/apis/playdeveloperreporting/v1beta1.ts +++ b/src/apis/playdeveloperreporting/v1beta1.ts @@ -576,11 +576,11 @@ export namespace playdeveloperreporting_v1beta1 { */ export interface Schema$GooglePlayDeveloperReportingV1beta1QueryErrorCountMetricSetRequest { /** - * Dimensions to slice the data by. **Supported dimensions:** * `apiLevel` (string): the API level of Android that was running on the user's device, e.g., 26. * `versionCode` (int64): unique identifier of the user's device model. The form of the identifier is 'deviceBrand/device', where deviceBrand corresponds to Build.BRAND and device corresponds to Build.DEVICE, e.g., google/coral. * `deviceModel` (string): unique identifier of the user's device model. * `deviceType` (string): identifier of the device's form factor, e.g., PHONE. * `reportType` (string): the type of error. The value should correspond to one of the possible values in ErrorType. * `isUserPerceived` (string): denotes whether error is user perceived or not, USER_PERCEIVED or NOT_USER_PERCEIVED. * `issueId` (string): the id an error was assigned to. The value should correspond to the `{issue\}` component of the issue name. * `deviceRamBucket` (int64): RAM of the device, in MB, in buckets (3GB, 4GB, etc.). * `deviceSocMake` (string): Make of the device's primary system-on-chip, e.g., Samsung. [Reference](https://developer.android.com/reference/android/os/Build#SOC_MANUFACTURER) * `deviceSocModel` (string): Model of the device's primary system-on-chip, e.g., "Exynos 2100". [Reference](https://developer.android.com/reference/android/os/Build#SOC_MODEL) * `deviceCpuMake` (string): Make of the device's CPU, e.g., Qualcomm. * `deviceCpuModel` (string): Model of the device's CPU, e.g., "Kryo 240". * `deviceGpuMake` (string): Make of the device's GPU, e.g., ARM. * `deviceGpuModel` (string): Model of the device's GPU, e.g., Mali. * `deviceGpuVersion` (string): Version of the device's GPU, e.g., T750. * `deviceVulkanVersion` (string): Vulkan version of the device, e.g., "4198400". * `deviceGlEsVersion` (string): OpenGL ES version of the device, e.g., "196610". * `deviceScreenSize` (string): Screen size of the device, e.g., NORMAL, LARGE. * `deviceScreenDpi` (string): Screen density of the device, e.g., mdpi, hdpi. + * Dimensions to slice the data by. **Supported dimensions:** * `apiLevel` (string): the API level of Android that was running on the user's device, e.g., 26. * `versionCode` (int64): unique identifier of the user's device model. The form of the identifier is 'deviceBrand/device', where deviceBrand corresponds to Build.BRAND and device corresponds to Build.DEVICE, e.g., google/coral. * `deviceModel` (string): unique identifier of the user's device model. * `deviceType` (string): identifier of the device's form factor, e.g., PHONE. * `reportType` (string): the type of error. The value should correspond to one of the possible values in ErrorType. * `issueId` (string): the id an error was assigned to. The value should correspond to the `{issue\}` component of the issue name. * `deviceRamBucket` (int64): RAM of the device, in MB, in buckets (3GB, 4GB, etc.). * `deviceSocMake` (string): Make of the device's primary system-on-chip, e.g., Samsung. [Reference](https://developer.android.com/reference/android/os/Build#SOC_MANUFACTURER) * `deviceSocModel` (string): Model of the device's primary system-on-chip, e.g., "Exynos 2100". [Reference](https://developer.android.com/reference/android/os/Build#SOC_MODEL) * `deviceCpuMake` (string): Make of the device's CPU, e.g., Qualcomm. * `deviceCpuModel` (string): Model of the device's CPU, e.g., "Kryo 240". * `deviceGpuMake` (string): Make of the device's GPU, e.g., ARM. * `deviceGpuModel` (string): Model of the device's GPU, e.g., Mali. * `deviceGpuVersion` (string): Version of the device's GPU, e.g., T750. * `deviceVulkanVersion` (string): Vulkan version of the device, e.g., "4198400". * `deviceGlEsVersion` (string): OpenGL ES version of the device, e.g., "196610". * `deviceScreenSize` (string): Screen size of the device, e.g., NORMAL, LARGE. * `deviceScreenDpi` (string): Screen density of the device, e.g., mdpi, hdpi. */ dimensions?: string[] | null; /** - * Filters to apply to data. The filtering expression follows [AIP-160](https://google.aip.dev/160) standard and supports filtering by equality of all breakdown dimensions. + * Filters to apply to data. The filtering expression follows [AIP-160](https://google.aip.dev/160) standard and supports filtering by equality of all breakdown dimensions and: * `isUserPerceived` (string): denotes whether error is user perceived or not, USER_PERCEIVED or NOT_USER_PERCEIVED. */ filter?: string | null; /** diff --git a/src/apis/playintegrity/v1.ts b/src/apis/playintegrity/v1.ts index 2f7acbba05..b566b33aae 100644 --- a/src/apis/playintegrity/v1.ts +++ b/src/apis/playintegrity/v1.ts @@ -112,6 +112,7 @@ export namespace playintegrity_v1 { */ export class Playintegrity { context: APIRequestContext; + deviceRecall: Resource$Devicerecall; v1: Resource$V1; constructor(options: GlobalOptions, google?: GoogleConfigurable) { @@ -120,6 +121,7 @@ export namespace playintegrity_v1 { google, }; + this.deviceRecall = new Resource$Devicerecall(this.context); this.v1 = new Resource$V1(this.context); } } @@ -296,6 +298,156 @@ export namespace playintegrity_v1 { */ testingDetails?: Schema$TestingDetails; } + /** + * Contains the recall bits values. + */ + export interface Schema$Values { + /** + * Required. First recall bit value. + */ + bitFirst?: boolean | null; + /** + * Required. Second recall bit value. + */ + bitSecond?: boolean | null; + /** + * Required. Third recall bit value. + */ + bitThird?: boolean | null; + } + /** + * Request to write device recall bits. + */ + export interface Schema$WriteDeviceRecallRequest { + /** + * Required. Integrity token obtained from calling Play Integrity API. Note that the integrity token contains the existing device recall bits. The write will only succeed if those bits in the integrity token are up to date. + */ + integrityToken?: string | null; + /** + * Required. The new values for the device recall bits to be written. + */ + newValues?: Schema$Values; + } + /** + * Response for the Write Device Recall action. Currently empty. + */ + export interface Schema$WriteDeviceRecallResponse {} + + export class Resource$Devicerecall { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Writes recall bits for the device where Play Integrity API token is obtained. The endpoint is available to select Play partners in an early access program (EAP). + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + write( + params: Params$Resource$Devicerecall$Write, + options: StreamMethodOptions + ): GaxiosPromise; + write( + params?: Params$Resource$Devicerecall$Write, + options?: MethodOptions + ): GaxiosPromise; + write( + params: Params$Resource$Devicerecall$Write, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + write( + params: Params$Resource$Devicerecall$Write, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + write( + params: Params$Resource$Devicerecall$Write, + callback: BodyResponseCallback + ): void; + write( + callback: BodyResponseCallback + ): void; + write( + paramsOrCallback?: + | Params$Resource$Devicerecall$Write + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Devicerecall$Write; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Devicerecall$Write; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://playintegrity.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+packageName}/deviceRecall:write').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['packageName'], + pathParams: ['packageName'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Devicerecall$Write + extends StandardParameters { + /** + * Required. Package name of the app the attached integrity token belongs to. + */ + packageName?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$WriteDeviceRecallRequest; + } export class Resource$V1 { context: APIRequestContext; diff --git a/src/apis/pubsub/v1.ts b/src/apis/pubsub/v1.ts index 6096aca179..4809a8b99d 100644 --- a/src/apis/pubsub/v1.ts +++ b/src/apis/pubsub/v1.ts @@ -266,6 +266,10 @@ export namespace pubsub_v1 { * 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. */ maxDuration?: string | null; + /** + * Optional. The maximum number of messages that can be written to a Cloud Storage file before a new file is created. Min 1000 messages. + */ + maxMessages?: string | null; /** * Optional. The service account to use to write to Cloud Storage. The subscription creator or updater that specifies this field must have `iam.serviceAccounts.actAs` permission on the service account. If not specified, the Pub/Sub [service agent](https://cloud.google.com/iam/docs/service-agents), service-{project_number\}@gcp-sa-pubsub.iam.gserviceaccount.com, is used. */ diff --git a/src/apis/recaptchaenterprise/v1.ts b/src/apis/recaptchaenterprise/v1.ts index 7ad883124b..af96924ab4 100644 --- a/src/apis/recaptchaenterprise/v1.ts +++ b/src/apis/recaptchaenterprise/v1.ts @@ -317,7 +317,7 @@ export namespace recaptchaenterprise_v1 { */ expectedAction?: string | null; /** - * Optional. Flag for a reCAPTCHA express request for an assessment without a token. If enabled, `site_key` must reference a SCORE key with WAF feature set to EXPRESS. + * Optional. Flag for a reCAPTCHA express request for an assessment without a token. If enabled, `site_key` must reference an Express site key. */ express?: boolean | null; /** @@ -373,6 +373,10 @@ export namespace recaptchaenterprise_v1 { */ wafTokenAssessment?: boolean | null; } + /** + * Settings specific to keys that can be used for reCAPTCHA Express. + */ + export interface Schema$GoogleCloudRecaptchaenterpriseV1ExpressKeySettings {} /** * An individual action. Each action represents what to do if a policy matches. */ @@ -594,12 +598,16 @@ export namespace recaptchaenterprise_v1 { * Required. Human-readable display name of this key. Modifiable by user. */ displayName?: string | null; + /** + * Settings for keys that can be used by reCAPTCHA Express. + */ + expressSettings?: Schema$GoogleCloudRecaptchaenterpriseV1ExpressKeySettings; /** * Settings for keys that can be used by iOS apps. */ iosSettings?: Schema$GoogleCloudRecaptchaenterpriseV1IOSKeySettings; /** - * Optional. See [Creating and managing labels] (https://cloud.google.com/recaptcha-enterprise/docs/labels). + * Optional. See [Creating and managing labels] (https://cloud.google.com/recaptcha/docs/labels). */ labels?: {[key: string]: string} | null; /** @@ -697,7 +705,7 @@ export namespace recaptchaenterprise_v1 { */ export interface Schema$GoogleCloudRecaptchaenterpriseV1MigrateKeyRequest { /** - * 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-enterprise/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-enterprise/docs/billing-information. + * 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. */ skipBillingCheck?: boolean | null; } diff --git a/src/apis/retail/v2.ts b/src/apis/retail/v2.ts index 9adbae8e1e..f346544c97 100644 --- a/src/apis/retail/v2.ts +++ b/src/apis/retail/v2.ts @@ -1473,10 +1473,6 @@ export namespace retail_v2 { * The merged facet key should be a valid facet key that is different than the facet key of the current catalog attribute. We refer this is merged facet key as the child of the current catalog attribute. This merged facet key can't be a parent of another facet key (i.e. no directed path of length 2). This merged facet key needs to be either a textual custom attribute or a numerical custom attribute. */ mergedFacetKey?: string | null; - /** - * Each instance is a list of facet values that map into the same (possibly different) merged facet value. For the current attribute config, each facet value should map to at most one merged facet value. - */ - mergedFacetValues?: Schema$GoogleCloudRetailV2CatalogAttributeFacetConfigMergedFacetValue[]; } /** * Replaces a set of textual facet values by the same (possibly different) merged facet value. Each facet value should appear at most once as a value per CatalogAttribute. This feature is available only for textual custom attributes. @@ -1550,7 +1546,7 @@ export namespace retail_v2 { suggestion?: string | null; } /** - * Recent search of this user. + * Deprecated: Recent search of this user. */ export interface Schema$GoogleCloudRetailV2CompleteQueryResponseRecentSearchResult { /** diff --git a/src/apis/retail/v2alpha.ts b/src/apis/retail/v2alpha.ts index 919a68fd63..18106c57f7 100644 --- a/src/apis/retail/v2alpha.ts +++ b/src/apis/retail/v2alpha.ts @@ -494,10 +494,6 @@ export namespace retail_v2alpha { * Immutable. Full resource name of the branch, such as `projects/x/locations/global/catalogs/default_catalog/branches/branch_id`. */ name?: string | null; - /** - * Output only. The number of products in different groups that this branch has. The key is a group representing a set of products, and the value is the number of products in that group. Note: keys in this map may change over time. Possible keys: * "primary-in-stock", products have Product.Type.PRIMARY type and Product.Availability.IN_STOCK availability. * "primary-out-of-stock", products have Product.Type.PRIMARY type and Product.Availability.OUT_OF_STOCK availability. * "primary-preorder", products have Product.Type.PRIMARY type and Product.Availability.PREORDER availability. * "primary-backorder", products have Product.Type.PRIMARY type and Product.Availability.BACKORDER availability. * "variant-in-stock", products have Product.Type.VARIANT type and Product.Availability.IN_STOCK availability. * "variant-out-of-stock", products have Product.Type.VARIANT type and Product.Availability.OUT_OF_STOCK availability. * "variant-preorder", products have Product.Type.VARIANT type and Product.Availability.PREORDER availability. * "variant-backorder", products have Product.Type.VARIANT type and Product.Availability.BACKORDER availability. * "price-discounted", products have [Product.price_info.price] < [Product.price_info.original_price]. This field is not populated in BranchView.BASIC view. - */ - productCounts?: {[key: string]: string} | null; /** * Output only. Statistics for number of products in the branch, provided for different scopes. This field is not populated in BranchView.BASIC view. */ @@ -661,10 +657,6 @@ export namespace retail_v2alpha { * The merged facet key should be a valid facet key that is different than the facet key of the current catalog attribute. We refer this is merged facet key as the child of the current catalog attribute. This merged facet key can't be a parent of another facet key (i.e. no directed path of length 2). This merged facet key needs to be either a textual custom attribute or a numerical custom attribute. */ mergedFacetKey?: string | null; - /** - * Each instance is a list of facet values that map into the same (possibly different) merged facet value. For the current attribute config, each facet value should map to at most one merged facet value. - */ - mergedFacetValues?: Schema$GoogleCloudRetailV2alphaCatalogAttributeFacetConfigMergedFacetValue[]; } /** * Replaces a set of textual facet values by the same (possibly different) merged facet value. Each facet value should appear at most once as a value per CatalogAttribute. This feature is available only for textual custom attributes. @@ -763,7 +755,7 @@ export namespace retail_v2alpha { totalProductCount?: number | null; } /** - * Recent search of this user. + * Deprecated: Recent search of this user. */ export interface Schema$GoogleCloudRetailV2alphaCompleteQueryResponseRecentSearchResult { /** @@ -1082,6 +1074,19 @@ export namespace retail_v2alpha { */ outputResult?: Schema$GoogleCloudRetailV2alphaOutputResult; } + /** + * Request message for the `ExportUserEvents` method. + */ + export interface Schema$GoogleCloudRetailV2alphaExportUserEventsRequest { + /** + * A filtering expression to specify restrictions on returned events. The expression is a sequence of terms. Each term applies a restriction to the returned user events. Use this expression to restrict results to a specific time range or to filter events by eventType. For example, `eventTime \> "2012-04-23T18:25:43.511Z" eventsMissingCatalogItems eventTime<"2012-04-23T18:25:43.511Z" eventType=search` We expect only three types of fields: * `eventTime`: This can be specified twice, once with a less than operator and once with a greater than operator. The `eventTime` restriction should result in one, contiguous, valid, `eventTime` range. * `eventType`: Boolean operators `OR` and `NOT` are supported if the expression is enclosed in parentheses and the operators are separated from the tag values by a space. * `eventsMissingCatalogItems`: This restricts results to events for which catalog items were not found in the catalog. The default behavior is to return only those events for which catalog items were found. Some examples of valid filters expressions: * Example 1: `eventTime \> "2012-04-23T18:25:43.511Z" eventTime < "2012-04-23T18:30:43.511Z"` * Example 2: `eventTime \> "2012-04-23T18:25:43.511Z" eventType = detail-page-view` * Example 3: `eventsMissingCatalogItems eventType = (NOT search) eventTime < "2018-04-23T18:30:43.511Z"` * Example 4: `eventTime \> "2012-04-23T18:25:43.511Z"` * Example 5: `eventType = (detail-page-view OR search)` * Example 6: `eventsMissingCatalogItems` + */ + filter?: string | null; + /** + * Required. The output location of the data. + */ + outputConfig?: Schema$GoogleCloudRetailV2alphaOutputConfig; + } /** * Response of the ExportUserEventsRequest. If the long running operation was successful, then this message is returned by the google.longrunning.Operations.response field if the operation was successful. */ @@ -11563,6 +11568,102 @@ export namespace retail_v2alpha { } } + /** + * Exports user events. `Operation.response` is of type `ExportResponse`. `Operation.metadata` is of type `ExportMetadata`. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + export( + params: Params$Resource$Projects$Locations$Catalogs$Userevents$Export, + options: StreamMethodOptions + ): GaxiosPromise; + export( + params?: Params$Resource$Projects$Locations$Catalogs$Userevents$Export, + options?: MethodOptions + ): GaxiosPromise; + export( + params: Params$Resource$Projects$Locations$Catalogs$Userevents$Export, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + export( + params: Params$Resource$Projects$Locations$Catalogs$Userevents$Export, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + export( + params: Params$Resource$Projects$Locations$Catalogs$Userevents$Export, + callback: BodyResponseCallback + ): void; + export( + callback: BodyResponseCallback + ): void; + export( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Catalogs$Userevents$Export + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Catalogs$Userevents$Export; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Catalogs$Userevents$Export; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://retail.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2alpha/{+parent}/userEvents:export').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + /** * 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`. * @@ -11977,6 +12078,18 @@ export namespace retail_v2alpha { */ userEvent?: string; } + export interface Params$Resource$Projects$Locations$Catalogs$Userevents$Export + extends StandardParameters { + /** + * Required. Resource name of a Catalog. For example `projects/1234/locations/global/catalogs/default_catalog` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudRetailV2alphaExportUserEventsRequest; + } export interface Params$Resource$Projects$Locations$Catalogs$Userevents$Import extends StandardParameters { /** diff --git a/src/apis/retail/v2beta.ts b/src/apis/retail/v2beta.ts index 143dd3cc2e..28eda87a50 100644 --- a/src/apis/retail/v2beta.ts +++ b/src/apis/retail/v2beta.ts @@ -1107,10 +1107,6 @@ export namespace retail_v2beta { * The merged facet key should be a valid facet key that is different than the facet key of the current catalog attribute. We refer this is merged facet key as the child of the current catalog attribute. This merged facet key can't be a parent of another facet key (i.e. no directed path of length 2). This merged facet key needs to be either a textual custom attribute or a numerical custom attribute. */ mergedFacetKey?: string | null; - /** - * Each instance is a list of facet values that map into the same (possibly different) merged facet value. For the current attribute config, each facet value should map to at most one merged facet value. - */ - mergedFacetValues?: Schema$GoogleCloudRetailV2betaCatalogAttributeFacetConfigMergedFacetValue[]; } /** * Replaces a set of textual facet values by the same (possibly different) merged facet value. Each facet value should appear at most once as a value per CatalogAttribute. This feature is available only for textual custom attributes. @@ -1184,7 +1180,7 @@ export namespace retail_v2beta { suggestion?: string | null; } /** - * Recent search of this user. + * Deprecated: Recent search of this user. */ export interface Schema$GoogleCloudRetailV2betaCompleteQueryResponseRecentSearchResult { /** @@ -1468,6 +1464,19 @@ export namespace retail_v2beta { */ outputResult?: Schema$GoogleCloudRetailV2betaOutputResult; } + /** + * Request message for the `ExportUserEvents` method. + */ + export interface Schema$GoogleCloudRetailV2betaExportUserEventsRequest { + /** + * A filtering expression to specify restrictions on returned events. The expression is a sequence of terms. Each term applies a restriction to the returned user events. Use this expression to restrict results to a specific time range or to filter events by eventType. For example, `eventTime \> "2012-04-23T18:25:43.511Z" eventsMissingCatalogItems eventTime<"2012-04-23T18:25:43.511Z" eventType=search` We expect only three types of fields: * `eventTime`: This can be specified twice, once with a less than operator and once with a greater than operator. The `eventTime` restriction should result in one, contiguous, valid, `eventTime` range. * `eventType`: Boolean operators `OR` and `NOT` are supported if the expression is enclosed in parentheses and the operators are separated from the tag values by a space. * `eventsMissingCatalogItems`: This restricts results to events for which catalog items were not found in the catalog. The default behavior is to return only those events for which catalog items were found. Some examples of valid filters expressions: * Example 1: `eventTime \> "2012-04-23T18:25:43.511Z" eventTime < "2012-04-23T18:30:43.511Z"` * Example 2: `eventTime \> "2012-04-23T18:25:43.511Z" eventType = detail-page-view` * Example 3: `eventsMissingCatalogItems eventType = (NOT search) eventTime < "2018-04-23T18:30:43.511Z"` * Example 4: `eventTime \> "2012-04-23T18:25:43.511Z"` * Example 5: `eventType = (detail-page-view OR search)` * Example 6: `eventsMissingCatalogItems` + */ + filter?: string | null; + /** + * Required. The output location of the data. + */ + outputConfig?: Schema$GoogleCloudRetailV2betaOutputConfig; + } /** * Response of the ExportUserEventsRequest. If the long running operation was successful, then this message is returned by the google.longrunning.Operations.response field if the operation was successful. */ @@ -9916,6 +9925,102 @@ export namespace retail_v2beta { } } + /** + * Exports user events. `Operation.response` is of type `ExportResponse`. `Operation.metadata` is of type `ExportMetadata`. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + export( + params: Params$Resource$Projects$Locations$Catalogs$Userevents$Export, + options: StreamMethodOptions + ): GaxiosPromise; + export( + params?: Params$Resource$Projects$Locations$Catalogs$Userevents$Export, + options?: MethodOptions + ): GaxiosPromise; + export( + params: Params$Resource$Projects$Locations$Catalogs$Userevents$Export, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + export( + params: Params$Resource$Projects$Locations$Catalogs$Userevents$Export, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + export( + params: Params$Resource$Projects$Locations$Catalogs$Userevents$Export, + callback: BodyResponseCallback + ): void; + export( + callback: BodyResponseCallback + ): void; + export( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Catalogs$Userevents$Export + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Catalogs$Userevents$Export; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Catalogs$Userevents$Export; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://retail.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2beta/{+parent}/userEvents:export').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + /** * 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`. * @@ -10330,6 +10435,18 @@ export namespace retail_v2beta { */ userEvent?: string; } + export interface Params$Resource$Projects$Locations$Catalogs$Userevents$Export + extends StandardParameters { + /** + * Required. Resource name of a Catalog. For example `projects/1234/locations/global/catalogs/default_catalog` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudRetailV2betaExportUserEventsRequest; + } export interface Params$Resource$Projects$Locations$Catalogs$Userevents$Import extends StandardParameters { /** diff --git a/src/apis/run/v1.ts b/src/apis/run/v1.ts index d64a9f8658..d6bcbf3c67 100644 --- a/src/apis/run/v1.ts +++ b/src/apis/run/v1.ts @@ -603,6 +603,10 @@ export namespace run_v1 { * Reference to an Execution. Use /Executions.GetExecution with the given name to get full execution including the latest status. */ export interface Schema$ExecutionReference { + /** + * Optional. Status for the execution completion. + */ + completionStatus?: string | null; /** * Optional. Completion timestamp of the execution. */ @@ -611,6 +615,10 @@ export namespace run_v1 { * Optional. Creation timestamp of the execution. */ creationTimestamp?: string | null; + /** + * Optional. The read-only soft deletion timestamp of the execution. + */ + deletionTimestamp?: string | null; /** * Optional. Name of the execution. */ @@ -1183,23 +1191,6 @@ export namespace run_v1 { */ fileHash?: Schema$GoogleDevtoolsCloudbuildV1Hash[]; } - /** - * Represents a storage location in Cloud Storage - */ - export interface Schema$GoogleDevtoolsCloudbuildV1GCSLocation { - /** - * Cloud Storage bucket. See https://cloud.google.com/storage/docs/naming#requirements - */ - bucket?: string | null; - /** - * Cloud Storage generation for the object. If the generation is omitted, the latest generation will be used. - */ - generation?: string | null; - /** - * Cloud Storage object. See https://cloud.google.com/storage/docs/naming#objectnames - */ - object?: string | null; - } /** * GitConfig is a configuration for git operations. */ @@ -1244,13 +1235,9 @@ export namespace run_v1 { */ export interface Schema$GoogleDevtoolsCloudbuildV1HttpConfig { /** - * SecretVersion resource of the HTTP proxy URL. The proxy URL should be in format protocol://@]proxyhost[:port]. + * 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]`. */ proxySecretVersionName?: string | null; - /** - * Optional. Cloud Storage object storing the certificate to use with the HTTP proxy. - */ - proxySslCaInfo?: Schema$GoogleDevtoolsCloudbuildV1GCSLocation; } /** * Pairs a set of secret environment variables mapped to encrypted values with the Cloud KMS key to use to decrypt the value. @@ -2352,11 +2339,11 @@ export namespace run_v1 { */ export interface Schema$RevisionSpec { /** - * ContainerConcurrency specifies the maximum allowed in-flight (concurrent) requests per container instance of the Revision. If not specified, defaults to 80. + * ContainerConcurrency specifies the maximum allowed in-flight (concurrent) requests per container instance of the Revision. If not specified or 0, defaults to 80 when requested CPU \>= 1 and defaults to 1 when requested CPU < 1. */ containerConcurrency?: number | null; /** - * Required. Containers holds the single container that defines the unit of execution for this Revision. In the context of a Revision, we disallow a number of fields on this Container, including: name and lifecycle. In Cloud Run, only a single container may be provided. + * Required. Containers holds the list which define the units of execution for this Revision. In the context of a Revision, we disallow a number of fields on this Container, including: name and lifecycle. */ containers?: Schema$Container[]; /** diff --git a/src/apis/run/v2.ts b/src/apis/run/v2.ts index 0a373f2b80..29f5c566f2 100644 --- a/src/apis/run/v2.ts +++ b/src/apis/run/v2.ts @@ -443,6 +443,10 @@ export namespace run_v2 { * Reference to an Execution. Use /Executions.GetExecution with the given name to get full execution including the latest status. */ export interface Schema$GoogleCloudRunV2ExecutionReference { + /** + * Status for the execution completion. + */ + completionStatus?: string | null; /** * Creation timestamp of the execution. */ @@ -451,6 +455,10 @@ export namespace run_v2 { * Creation timestamp of the execution. */ createTime?: string | null; + /** + * The deletion time of the execution. It is only populated as a response to a Delete request. + */ + deleteTime?: string | null; /** * Name of the execution. */ @@ -521,7 +529,7 @@ export namespace run_v2 { */ export interface Schema$GoogleCloudRunV2GCSVolumeSource { /** - * Cloud Storage Bucket name. TODO (b/344678062) Fix the error validation once dynamic mounting is public. + * Cloud Storage Bucket name. */ bucket?: string | null; /** @@ -2043,23 +2051,6 @@ export namespace run_v2 { */ fileHash?: Schema$GoogleDevtoolsCloudbuildV1Hash[]; } - /** - * Represents a storage location in Cloud Storage - */ - export interface Schema$GoogleDevtoolsCloudbuildV1GCSLocation { - /** - * Cloud Storage bucket. See https://cloud.google.com/storage/docs/naming#requirements - */ - bucket?: string | null; - /** - * Cloud Storage generation for the object. If the generation is omitted, the latest generation will be used. - */ - generation?: string | null; - /** - * Cloud Storage object. See https://cloud.google.com/storage/docs/naming#objectnames - */ - object?: string | null; - } /** * GitConfig is a configuration for git operations. */ @@ -2104,13 +2095,9 @@ export namespace run_v2 { */ export interface Schema$GoogleDevtoolsCloudbuildV1HttpConfig { /** - * SecretVersion resource of the HTTP proxy URL. The proxy URL should be in format protocol://@]proxyhost[:port]. + * 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]`. */ proxySecretVersionName?: string | null; - /** - * Optional. Cloud Storage object storing the certificate to use with the HTTP proxy. - */ - proxySslCaInfo?: Schema$GoogleDevtoolsCloudbuildV1GCSLocation; } /** * Pairs a set of secret environment variables mapped to encrypted values with the Cloud KMS key to use to decrypt the value. @@ -3013,6 +3000,101 @@ export namespace run_v2 { return createAPIRequest(parameters); } } + + /** + * Export generated customer metadata for a given project. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + exportProjectMetadata( + params: Params$Resource$Projects$Locations$Exportprojectmetadata, + options: StreamMethodOptions + ): GaxiosPromise; + exportProjectMetadata( + params?: Params$Resource$Projects$Locations$Exportprojectmetadata, + options?: MethodOptions + ): GaxiosPromise; + exportProjectMetadata( + params: Params$Resource$Projects$Locations$Exportprojectmetadata, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + exportProjectMetadata( + params: Params$Resource$Projects$Locations$Exportprojectmetadata, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + exportProjectMetadata( + params: Params$Resource$Projects$Locations$Exportprojectmetadata, + callback: BodyResponseCallback + ): void; + exportProjectMetadata( + callback: BodyResponseCallback + ): void; + exportProjectMetadata( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Exportprojectmetadata + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Exportprojectmetadata; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Exportprojectmetadata; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://run.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2/{+name}:exportProjectMetadata').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } } export interface Params$Resource$Projects$Locations$Exportimage @@ -3041,6 +3123,13 @@ export namespace run_v2 { */ name?: string; } + export interface Params$Resource$Projects$Locations$Exportprojectmetadata + extends StandardParameters { + /** + * Required. The name of the project of which metadata should be exported. Format: `projects/{project_id_or_number\}/locations/{location\}` for Project in a given location. + */ + name?: string; + } export class Resource$Projects$Locations$Jobs { context: APIRequestContext; diff --git a/src/apis/securitycenter/v1.ts b/src/apis/securitycenter/v1.ts index f5d9a435ab..65145364b6 100644 --- a/src/apis/securitycenter/v1.ts +++ b/src/apis/securitycenter/v1.ts @@ -308,7 +308,7 @@ export namespace securitycenter_v1 { */ export interface Schema$AttackExposure { /** - * The resource name of the attack path simulation result that contains the details regarding this attack exposure score. Example: organizations/123/simulations/456/attackExposureResults/789 + * The resource name of the attack path simulation result that contains the details regarding this attack exposure score. Example: `organizations/123/simulations/456/attackExposureResults/789` */ attackExposureResult?: string | null; /** @@ -383,11 +383,11 @@ export namespace securitycenter_v1 { */ displayName?: string | null; /** - * The name of the resource at this point in the attack path. The format of the name follows the Cloud Asset Inventory [resource name format]("https://cloud.google.com/asset-inventory/docs/resource-name-format") + * The name of the resource at this point in the attack path. The format of the name follows the Cloud Asset Inventory [resource name format](https://cloud.google.com/asset-inventory/docs/resource-name-format) */ resource?: string | null; /** - * The [supported resource type](https://cloud.google.com/asset-inventory/docs/supported-asset-types") + * The [supported resource type](https://cloud.google.com/asset-inventory/docs/supported-asset-types) */ resourceType?: string | null; /** @@ -507,7 +507,7 @@ export namespace securitycenter_v1 { */ displayName?: string | null; /** - * The UUID of the Azure management group, for example, "20000000-0001-0000-0000-000000000000". + * The UUID of the Azure management group, for example, `20000000-0001-0000-0000-000000000000`. */ id?: string | null; } @@ -546,7 +546,7 @@ export namespace securitycenter_v1 { */ displayName?: string | null; /** - * The UUID of the Azure subscription, for example, "291bba3f-e0a5-47bc-a099-3bdcb2a50a05". + * The UUID of the Azure subscription, for example, `291bba3f-e0a5-47bc-a099-3bdcb2a50a05`. */ id?: string | null; } @@ -1043,7 +1043,7 @@ export namespace securitycenter_v1 { */ enablementState?: string | null; /** - * Output only. The resource name of the effective ETD custom module. Its format is: * "organizations/{organization\}/eventThreatDetectionSettings/effectiveCustomModules/{module\}". * "folders/{folder\}/eventThreatDetectionSettings/effectiveCustomModules/{module\}". * "projects/{project\}/eventThreatDetectionSettings/effectiveCustomModules/{module\}". + * Output only. The resource name of the effective ETD custom module. Its format is: * `organizations/{organization\}/eventThreatDetectionSettings/effectiveCustomModules/{module\}`. * `folders/{folder\}/eventThreatDetectionSettings/effectiveCustomModules/{module\}`. * `projects/{project\}/eventThreatDetectionSettings/effectiveCustomModules/{module\}`. */ name?: string | null; /** @@ -1097,7 +1097,7 @@ export namespace securitycenter_v1 { */ lastEditor?: string | null; /** - * Immutable. The resource name of the Event Threat Detection custom module. Its format is: * "organizations/{organization\}/eventThreatDetectionSettings/customModules/{module\}". * "folders/{folder\}/eventThreatDetectionSettings/customModules/{module\}". * "projects/{project\}/eventThreatDetectionSettings/customModules/{module\}". + * Immutable. The resource name of the Event Threat Detection custom module. Its format is: * `organizations/{organization\}/eventThreatDetectionSettings/customModules/{module\}`. * `folders/{folder\}/eventThreatDetectionSettings/customModules/{module\}`. * `projects/{project\}/eventThreatDetectionSettings/customModules/{module\}`. */ name?: string | null; /** @@ -1673,7 +1673,7 @@ export namespace securitycenter_v1 { */ mostRecentEditor?: string | null; /** - * This field will be ignored if provided on config creation. Format "organizations/{organization\}/muteConfigs/{mute_config\}" "folders/{folder\}/muteConfigs/{mute_config\}" "projects/{project\}/muteConfigs/{mute_config\}" "organizations/{organization\}/locations/global/muteConfigs/{mute_config\}" "folders/{folder\}/locations/global/muteConfigs/{mute_config\}" "projects/{project\}/locations/global/muteConfigs/{mute_config\}" + * This field will be ignored if provided on config creation. Format `organizations/{organization\}/muteConfigs/{mute_config\}` `folders/{folder\}/muteConfigs/{mute_config\}` `projects/{project\}/muteConfigs/{mute_config\}` `organizations/{organization\}/locations/global/muteConfigs/{mute_config\}` `folders/{folder\}/locations/global/muteConfigs/{mute_config\}` `projects/{project\}/locations/global/muteConfigs/{mute_config\}` */ name?: string | null; /** @@ -1910,7 +1910,7 @@ export namespace securitycenter_v1 { */ resourcePath?: Schema$ResourcePath; /** - * A string representation of the resource path. For Google Cloud, it has the format of organizations/{organization_id\}/folders/{folder_id\}/folders/{folder_id\}/projects/{project_id\} where there can be any number of folders. For AWS, it has the format of org/{organization_id\}/ou/{organizational_unit_id\}/ou/{organizational_unit_id\}/account/{account_id\} where there can be any number of organizational units. For Azure, it has the format of mg/{management_group_id\}/mg/{management_group_id\}/subscription/{subscription_id\}/rg/{resource_group_name\} where there can be any number of management groups. + * A string representation of the resource path. For Google Cloud, it has the format of `organizations/{organization_id\}/folders/{folder_id\}/folders/{folder_id\}/projects/{project_id\}` where there can be any number of folders. For AWS, it has the format of `org/{organization_id\}/ou/{organizational_unit_id\}/ou/{organizational_unit_id\}/account/{account_id\}` where there can be any number of organizational units. For Azure, it has the format of `mg/{management_group_id\}/mg/{management_group_id\}/subscription/{subscription_id\}/rg/{resource_group_name\}` where there can be any number of management groups. */ resourcePathString?: string | null; /** @@ -1952,11 +1952,11 @@ export namespace securitycenter_v1 { */ name?: string | null; /** - * List of resource labels to search for, evaluated with AND. For example, "resource_labels_selector": {"key": "value", "env": "prod"\} will match resources with labels "key": "value" AND "env": "prod" https://cloud.google.com/resource-manager/docs/creating-managing-labels + * List of resource labels to search for, evaluated with `AND`. For example, `"resource_labels_selector": {"key": "value", "env": "prod"\}` will match resources with labels "key": "value" `AND` "env": "prod" https://cloud.google.com/resource-manager/docs/creating-managing-labels */ resourceLabelsSelector?: {[key: string]: string} | null; /** - * Apply resource_value only to resources that match resource_type. resource_type will be checked with AND of other resources. For example, "storage.googleapis.com/Bucket" with resource_value "HIGH" will apply "HIGH" value only to "storage.googleapis.com/Bucket" resources. + * Apply resource_value only to resources that match resource_type. resource_type will be checked with `AND` of other resources. For example, "storage.googleapis.com/Bucket" with resource_value "HIGH" will apply "HIGH" value only to "storage.googleapis.com/Bucket" resources. */ resourceType?: string | null; /** @@ -1964,7 +1964,7 @@ export namespace securitycenter_v1 { */ resourceValue?: string | null; /** - * Project or folder to scope this configuration to. For example, "project/456" would apply this configuration only to resources in "project/456" scope will be checked with AND of other resources. + * Project or folder to scope this configuration to. For example, "project/456" would apply this configuration only to resources in "project/456" scope will be checked with `AND` of other resources. */ scope?: string | null; /** @@ -1972,7 +1972,7 @@ export namespace securitycenter_v1 { */ sensitiveDataProtectionMapping?: Schema$GoogleCloudSecuritycenterV1SensitiveDataProtectionMapping; /** - * Required. Tag values combined with AND to check against. Values in the form "tagValues/123" Example: [ "tagValues/123", "tagValues/456", "tagValues/789" ] https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing + * Required. Tag values combined with `AND` to check against. Values in the form "tagValues/123" Example: `[ "tagValues/123", "tagValues/456", "tagValues/789" ]` https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing */ tagValues?: string[] | null; /** @@ -2165,7 +2165,7 @@ export namespace securitycenter_v1 { */ export interface Schema$GoogleCloudSecuritycenterV2AttackExposure { /** - * The resource name of the attack path simulation result that contains the details regarding this attack exposure score. Example: organizations/123/simulations/456/attackExposureResults/789 + * The resource name of the attack path simulation result that contains the details regarding this attack exposure score. Example: `organizations/123/simulations/456/attackExposureResults/789` */ attackExposureResult?: string | null; /** @@ -2254,7 +2254,7 @@ export namespace securitycenter_v1 { */ displayName?: string | null; /** - * The UUID of the Azure management group, for example, "20000000-0001-0000-0000-000000000000". + * The UUID of the Azure management group, for example, `20000000-0001-0000-0000-000000000000`. */ id?: string | null; } @@ -2293,7 +2293,7 @@ export namespace securitycenter_v1 { */ displayName?: string | null; /** - * The UUID of the Azure subscription, for example, "291bba3f-e0a5-47bc-a099-3bdcb2a50a05". + * The UUID of the Azure subscription, for example, `291bba3f-e0a5-47bc-a099-3bdcb2a50a05`. */ id?: string | null; } @@ -2351,7 +2351,7 @@ export namespace securitycenter_v1 { */ createTime?: string | null; /** - * The dataset to write findings' updates to. Its format is "projects/[project_id]/datasets/[bigquery_dataset_id]". BigQuery Dataset unique ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). + * The dataset to write findings' updates to. Its format is "projects/[project_id]/datasets/[bigquery_dataset_id]". BigQuery dataset unique ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). */ dataset?: string | null; /** @@ -2367,7 +2367,7 @@ export namespace securitycenter_v1 { */ mostRecentEditor?: string | null; /** - * The relative resource name of this export. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name. The following list shows some examples: + `organizations/{organization_id\}/locations/{location_id\}/bigQueryExports/{export_id\}` + `folders/{folder_id\}/locations/{location_id\}/bigQueryExports/{export_id\}` + `projects/{project_id\}/locations/{location_id\}/bigQueryExports/{export_id\}` This field is provided in responses, and is ignored when provided in create requests. + * Identifier. The relative resource name of this export. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name. The following list shows some examples: + `organizations/{organization_id\}/locations/{location_id\}/bigQueryExports/{export_id\}` + `folders/{folder_id\}/locations/{location_id\}/bigQueryExports/{export_id\}` + `projects/{project_id\}/locations/{location_id\}/bigQueryExports/{export_id\}` This field is provided in responses, and is ignored when provided in create requests. */ name?: string | null; /** @@ -3273,7 +3273,7 @@ export namespace securitycenter_v1 { */ mostRecentEditor?: string | null; /** - * This field will be ignored if provided on config creation. The following list shows some examples of the format: + `organizations/{organization\}/muteConfigs/{mute_config\}` + `organizations/{organization\}locations/{location\}//muteConfigs/{mute_config\}` + `folders/{folder\}/muteConfigs/{mute_config\}` + `folders/{folder\}/locations/{location\}/muteConfigs/{mute_config\}` + `projects/{project\}/muteConfigs/{mute_config\}` + `projects/{project\}/locations/{location\}/muteConfigs/{mute_config\}` + * Identifier. This field will be ignored if provided on config creation. The following list shows some examples of the format: + `organizations/{organization\}/muteConfigs/{mute_config\}` + `organizations/{organization\}locations/{location\}//muteConfigs/{mute_config\}` + `folders/{folder\}/muteConfigs/{mute_config\}` + `folders/{folder\}/locations/{location\}/muteConfigs/{mute_config\}` + `projects/{project\}/muteConfigs/{mute_config\}` + `projects/{project\}/locations/{location\}/muteConfigs/{mute_config\}` */ name?: string | null; /** @@ -3571,7 +3571,7 @@ export namespace securitycenter_v1 { */ resourcePath?: Schema$GoogleCloudSecuritycenterV2ResourcePath; /** - * A string representation of the resource path. For Google Cloud, it has the format of organizations/{organization_id\}/folders/{folder_id\}/folders/{folder_id\}/projects/{project_id\} where there can be any number of folders. For AWS, it has the format of org/{organization_id\}/ou/{organizational_unit_id\}/ou/{organizational_unit_id\}/account/{account_id\} where there can be any number of organizational units. For Azure, it has the format of mg/{management_group_id\}/mg/{management_group_id\}/subscription/{subscription_id\}/rg/{resource_group_name\} where there can be any number of management groups. + * A string representation of the resource path. For Google Cloud, it has the format of `organizations/{organization_id\}/folders/{folder_id\}/folders/{folder_id\}/projects/{project_id\}` where there can be any number of folders. For AWS, it has the format of `org/{organization_id\}/ou/{organizational_unit_id\}/ou/{organizational_unit_id\}/account/{account_id\}` where there can be any number of organizational units. For Azure, it has the format of `mg/{management_group_id\}/mg/{management_group_id\}/subscription/{subscription_id\}/rg/{resource_group_name\}` where there can be any number of management groups. */ resourcePathString?: string | null; /** @@ -3626,23 +3626,23 @@ export namespace securitycenter_v1 { */ description?: string | null; /** - * Name for the resource value configuration + * Identifier. Name for the resource value configuration */ name?: string | null; /** - * List of resource labels to search for, evaluated with AND. For example, "resource_labels_selector": {"key": "value", "env": "prod"\} will match resources with labels "key": "value" AND "env": "prod" https://cloud.google.com/resource-manager/docs/creating-managing-labels + * List of resource labels to search for, evaluated with `AND`. For example, "resource_labels_selector": {"key": "value", "env": "prod"\} will match resources with labels "key": "value" `AND` "env": "prod" https://cloud.google.com/resource-manager/docs/creating-managing-labels */ resourceLabelsSelector?: {[key: string]: string} | null; /** - * Apply resource_value only to resources that match resource_type. resource_type will be checked with AND of other resources. For example, "storage.googleapis.com/Bucket" with resource_value "HIGH" will apply "HIGH" value only to "storage.googleapis.com/Bucket" resources. + * Apply resource_value only to resources that match resource_type. resource_type will be checked with `AND` of other resources. For example, "storage.googleapis.com/Bucket" with resource_value "HIGH" will apply "HIGH" value only to "storage.googleapis.com/Bucket" resources. */ resourceType?: string | null; /** - * Resource value level this expression represents Only required when there is no SDP mapping in the request + * Resource value level this expression represents Only required when there is no Sensitive Data Protection mapping in the request */ resourceValue?: string | null; /** - * Project or folder to scope this configuration to. For example, "project/456" would apply this configuration only to resources in "project/456" scope will be checked with AND of other resources. + * Project or folder to scope this configuration to. For example, "project/456" would apply this configuration only to resources in "project/456" scope and will be checked with `AND` of other resources. */ scope?: string | null; /** @@ -3650,7 +3650,7 @@ export namespace securitycenter_v1 { */ sensitiveDataProtectionMapping?: Schema$GoogleCloudSecuritycenterV2SensitiveDataProtectionMapping; /** - * Required. Tag values combined with AND to check against. Values in the form "tagValues/123" Example: [ "tagValues/123", "tagValues/456", "tagValues/789" ] https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing + * Tag values combined with `AND` to check against. Values in the form "tagValues/123" Example: `[ "tagValues/123", "tagValues/456", "tagValues/789" ]` https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing */ tagValues?: string[] | null; /** @@ -3844,7 +3844,7 @@ export namespace securitycenter_v1 { */ attackExposureScore?: number | null; /** - * List of resource names of findings associated with this toxic combination. For example, organizations/123/sources/456/findings/789. + * List of resource names of findings associated with this toxic combination. For example, `organizations/123/sources/456/findings/789`. */ relatedFindings?: string[] | null; } @@ -4622,7 +4622,7 @@ export namespace securitycenter_v1 { */ export interface Schema$PathNodeAssociatedFinding { /** - * Canonical name of the associated findings. Example: organizations/123/sources/456/findings/789 + * Canonical name of the associated findings. Example: `organizations/123/sources/456/findings/789` */ canonicalFinding?: string | null; /** @@ -4853,7 +4853,7 @@ export namespace securitycenter_v1 { */ resourcePath?: Schema$ResourcePath; /** - * A string representation of the resource path. For Google Cloud, it has the format of org/{organization_id\}/folder/{folder_id\}/folder/{folder_id\}/project/{project_id\} where there can be any number of folders. For AWS, it has the format of org/{organization_id\}/ou/{organizational_unit_id\}/ou/{organizational_unit_id\}/account/{account_id\} where there can be any number of organizational units. For Azure, it has the format of mg/{management_group_id\}/mg/{management_group_id\}/subscription/{subscription_id\}/rg/{resource_group_name\} where there can be any number of management groups. + * A string representation of the resource path. For Google Cloud, it has the format of `org/{organization_id\}/folder/{folder_id\}/folder/{folder_id\}/project/{project_id\}` where there can be any number of folders. For AWS, it has the format of `org/{organization_id\}/ou/{organizational_unit_id\}/ou/{organizational_unit_id\}/account/{account_id\}` where there can be any number of organizational units. For Azure, it has the format of `mg/{management_group_id\}/mg/{management_group_id\}/subscription/{subscription_id\}/rg/{resource_group_name\}` where there can be any number of management groups. */ resourcePathString?: string | null; /** @@ -5167,7 +5167,7 @@ export namespace securitycenter_v1 { */ createTime?: string | null; /** - * Full resource name of the Simulation: organizations/123/simulations/456 + * Full resource name of the Simulation: `organizations/123/simulations/456` */ name?: string | null; /** @@ -5295,7 +5295,7 @@ export namespace securitycenter_v1 { */ attackExposureScore?: number | null; /** - * List of resource names of findings associated with this toxic combination. For example, organizations/123/sources/456/findings/789. + * List of resource names of findings associated with this toxic combination. For example, `organizations/123/sources/456/findings/789`. */ relatedFindings?: string[] | null; } @@ -5726,7 +5726,7 @@ export namespace securitycenter_v1 { export interface Params$Resource$Folders$Assets$Group extends StandardParameters { /** - * Required. The name of the parent to group the assets by. Its format is "organizations/[organization_id]", "folders/[folder_id]", or "projects/[project_id]". + * Required. The name of the parent to group the assets by. Its format is `organizations/[organization_id]`, `folders/[folder_id]`, or `projects/[project_id]`. */ parent?: string; @@ -5762,7 +5762,7 @@ export namespace securitycenter_v1 { */ pageToken?: string; /** - * Required. The name of the parent resource that contains the assets. The value that you can specify on parent depends on the method in which you specify parent. You can specify one of the following values: "organizations/[organization_id]", "folders/[folder_id]", or "projects/[project_id]". + * Required. The name of the parent resource that contains the assets. The value that you can specify on parent depends on the method in which you specify parent. You can specify one of the following values: `organizations/[organization_id]`, `folders/[folder_id]`, or `projects/[project_id]`. */ parent?: string; /** @@ -6275,7 +6275,7 @@ export namespace securitycenter_v1 { */ bigQueryExportId?: string; /** - * Required. The name of the parent resource of the new BigQuery export. Its format is "organizations/[organization_id]", "folders/[folder_id]", or "projects/[project_id]". + * Required. The name of the parent resource of the new BigQuery export. Its format is `organizations/[organization_id]`, `folders/[folder_id]`, or `projects/[project_id]`. */ parent?: string; @@ -6287,14 +6287,14 @@ export namespace securitycenter_v1 { export interface Params$Resource$Folders$Bigqueryexports$Delete extends StandardParameters { /** - * Required. The name of the BigQuery export to delete. Its format is organizations/{organization\}/bigQueryExports/{export_id\}, folders/{folder\}/bigQueryExports/{export_id\}, or projects/{project\}/bigQueryExports/{export_id\} + * Required. The name of the BigQuery export to delete. Its format is `organizations/{organization\}/bigQueryExports/{export_id\}`, `folders/{folder\}/bigQueryExports/{export_id\}`, or `projects/{project\}/bigQueryExports/{export_id\}` */ name?: string; } export interface Params$Resource$Folders$Bigqueryexports$Get extends StandardParameters { /** - * Required. Name of the BigQuery export to retrieve. Its format is organizations/{organization\}/bigQueryExports/{export_id\}, folders/{folder\}/bigQueryExports/{export_id\}, or projects/{project\}/bigQueryExports/{export_id\} + * Required. Name of the BigQuery export to retrieve. Its format is `organizations/{organization\}/bigQueryExports/{export_id\}`, `folders/{folder\}/bigQueryExports/{export_id\}`, or `projects/{project\}/bigQueryExports/{export_id\}` */ name?: string; } @@ -6309,7 +6309,7 @@ export namespace securitycenter_v1 { */ pageToken?: string; /** - * Required. The parent, which owns the collection of BigQuery exports. Its format is "organizations/[organization_id]", "folders/[folder_id]", "projects/[project_id]". + * Required. The parent, which owns the collection of BigQuery exports. Its format is `organizations/[organization_id]`, `folders/[folder_id]`, `projects/[project_id]`. */ parent?: string; } @@ -6449,7 +6449,7 @@ export namespace securitycenter_v1 { export interface Params$Resource$Folders$Eventthreatdetectionsettings$Validatecustommodule extends StandardParameters { /** - * Required. Resource name of the parent to validate the Custom Module under. Its format is: * "organizations/{organization\}/eventThreatDetectionSettings". * "folders/{folder\}/eventThreatDetectionSettings". * "projects/{project\}/eventThreatDetectionSettings". + * Required. Resource name of the parent to validate the Custom Module under. Its format is: * `organizations/{organization\}/eventThreatDetectionSettings`. * `folders/{folder\}/eventThreatDetectionSettings`. * `projects/{project\}/eventThreatDetectionSettings`. */ parent?: string; @@ -7044,7 +7044,7 @@ export namespace securitycenter_v1 { export interface Params$Resource$Folders$Eventthreatdetectionsettings$Custommodules$Create extends StandardParameters { /** - * Required. The new custom module's parent. Its format is: * "organizations/{organization\}/eventThreatDetectionSettings". * "folders/{folder\}/eventThreatDetectionSettings". * "projects/{project\}/eventThreatDetectionSettings". + * Required. The new custom module's parent. Its format is: * `organizations/{organization\}/eventThreatDetectionSettings`. * `folders/{folder\}/eventThreatDetectionSettings`. * `projects/{project\}/eventThreatDetectionSettings`. */ parent?: string; @@ -7056,14 +7056,14 @@ export namespace securitycenter_v1 { export interface Params$Resource$Folders$Eventthreatdetectionsettings$Custommodules$Delete extends StandardParameters { /** - * Required. Name of the custom module to delete. Its format is: * "organizations/{organization\}/eventThreatDetectionSettings/customModules/{module\}". * "folders/{folder\}/eventThreatDetectionSettings/customModules/{module\}". * "projects/{project\}/eventThreatDetectionSettings/customModules/{module\}". + * Required. Name of the custom module to delete. Its format is: * `organizations/{organization\}/eventThreatDetectionSettings/customModules/{module\}`. * `folders/{folder\}/eventThreatDetectionSettings/customModules/{module\}`. * `projects/{project\}/eventThreatDetectionSettings/customModules/{module\}`. */ name?: string; } export interface Params$Resource$Folders$Eventthreatdetectionsettings$Custommodules$Get extends StandardParameters { /** - * Required. Name of the custom module to get. Its format is: * "organizations/{organization\}/eventThreatDetectionSettings/customModules/{module\}". * "folders/{folder\}/eventThreatDetectionSettings/customModules/{module\}". * "projects/{project\}/eventThreatDetectionSettings/customModules/{module\}". + * Required. Name of the custom module to get. Its format is: * `organizations/{organization\}/eventThreatDetectionSettings/customModules/{module\}`. * `folders/{folder\}/eventThreatDetectionSettings/customModules/{module\}`. * `projects/{project\}/eventThreatDetectionSettings/customModules/{module\}`. */ name?: string; } @@ -7078,7 +7078,7 @@ export namespace securitycenter_v1 { */ pageToken?: string; /** - * Required. Name of the parent to list custom modules under. Its format is: * "organizations/{organization\}/eventThreatDetectionSettings". * "folders/{folder\}/eventThreatDetectionSettings". * "projects/{project\}/eventThreatDetectionSettings". + * Required. Name of the parent to list custom modules under. Its format is: * `organizations/{organization\}/eventThreatDetectionSettings`. * `folders/{folder\}/eventThreatDetectionSettings`. * `projects/{project\}/eventThreatDetectionSettings`. */ parent?: string; } @@ -7093,14 +7093,14 @@ export namespace securitycenter_v1 { */ pageToken?: string; /** - * Required. Name of the parent to list custom modules under. Its format is: * "organizations/{organization\}/eventThreatDetectionSettings". * "folders/{folder\}/eventThreatDetectionSettings". * "projects/{project\}/eventThreatDetectionSettings". + * Required. Name of the parent to list custom modules under. Its format is: * `organizations/{organization\}/eventThreatDetectionSettings`. * `folders/{folder\}/eventThreatDetectionSettings`. * `projects/{project\}/eventThreatDetectionSettings`. */ parent?: string; } export interface Params$Resource$Folders$Eventthreatdetectionsettings$Custommodules$Patch extends StandardParameters { /** - * Immutable. The resource name of the Event Threat Detection custom module. Its format is: * "organizations/{organization\}/eventThreatDetectionSettings/customModules/{module\}". * "folders/{folder\}/eventThreatDetectionSettings/customModules/{module\}". * "projects/{project\}/eventThreatDetectionSettings/customModules/{module\}". + * Immutable. The resource name of the Event Threat Detection custom module. Its format is: * `organizations/{organization\}/eventThreatDetectionSettings/customModules/{module\}`. * `folders/{folder\}/eventThreatDetectionSettings/customModules/{module\}`. * `projects/{project\}/eventThreatDetectionSettings/customModules/{module\}`. */ name?: string; /** @@ -7319,7 +7319,7 @@ export namespace securitycenter_v1 { export interface Params$Resource$Folders$Eventthreatdetectionsettings$Effectivecustommodules$Get extends StandardParameters { /** - * Required. The resource name of the effective Event Threat Detection custom module. Its format is: * "organizations/{organization\}/eventThreatDetectionSettings/effectiveCustomModules/{module\}". * "folders/{folder\}/eventThreatDetectionSettings/effectiveCustomModules/{module\}". * "projects/{project\}/eventThreatDetectionSettings/effectiveCustomModules/{module\}". + * Required. The resource name of the effective Event Threat Detection custom module. Its format is: * `organizations/{organization\}/eventThreatDetectionSettings/effectiveCustomModules/{module\}`. * `folders/{folder\}/eventThreatDetectionSettings/effectiveCustomModules/{module\}`. * `projects/{project\}/eventThreatDetectionSettings/effectiveCustomModules/{module\}`. */ name?: string; } @@ -7334,7 +7334,7 @@ export namespace securitycenter_v1 { */ pageToken?: string; /** - * Required. Name of the parent to list custom modules for. Its format is: * "organizations/{organization\}/eventThreatDetectionSettings". * "folders/{folder\}/eventThreatDetectionSettings". * "projects/{project\}/eventThreatDetectionSettings". + * Required. Name of the parent to list custom modules for. Its format is: * `organizations/{organization\}/eventThreatDetectionSettings`. * `folders/{folder\}/eventThreatDetectionSettings`. * `projects/{project\}/eventThreatDetectionSettings`. */ parent?: string; } @@ -7438,7 +7438,7 @@ export namespace securitycenter_v1 { export interface Params$Resource$Folders$Findings$Bulkmute extends StandardParameters { /** - * Required. The parent, at which bulk action needs to be applied. Its format is "organizations/[organization_id]", "folders/[folder_id]", "projects/[project_id]". + * Required. The parent, at which bulk action needs to be applied. Its format is `organizations/[organization_id]`, `folders/[folder_id]`, `projects/[project_id]`. */ parent?: string; @@ -7938,7 +7938,7 @@ export namespace securitycenter_v1 { */ muteConfigId?: string; /** - * Required. Resource name of the new mute configs's parent. Its format is "organizations/[organization_id]", "folders/[folder_id]", or "projects/[project_id]". + * Required. Resource name of the new mute configs's parent. Its format is `organizations/[organization_id]`, `folders/[folder_id]`, or `projects/[project_id]`. */ parent?: string; @@ -7950,14 +7950,14 @@ export namespace securitycenter_v1 { export interface Params$Resource$Folders$Locations$Muteconfigs$Delete extends StandardParameters { /** - * Required. Name of the mute config to delete. Its format is organizations/{organization\}/muteConfigs/{config_id\}, folders/{folder\}/muteConfigs/{config_id\}, projects/{project\}/muteConfigs/{config_id\}, organizations/{organization\}/locations/global/muteConfigs/{config_id\}, folders/{folder\}/locations/global/muteConfigs/{config_id\}, or projects/{project\}/locations/global/muteConfigs/{config_id\}. + * Required. Name of the mute config to delete. Its format is `organizations/{organization\}/muteConfigs/{config_id\}`, `folders/{folder\}/muteConfigs/{config_id\}`, `projects/{project\}/muteConfigs/{config_id\}`, `organizations/{organization\}/locations/global/muteConfigs/{config_id\}`, `folders/{folder\}/locations/global/muteConfigs/{config_id\}`, or `projects/{project\}/locations/global/muteConfigs/{config_id\}`. */ name?: string; } export interface Params$Resource$Folders$Locations$Muteconfigs$Get extends StandardParameters { /** - * Required. Name of the mute config to retrieve. Its format is organizations/{organization\}/muteConfigs/{config_id\}, folders/{folder\}/muteConfigs/{config_id\}, projects/{project\}/muteConfigs/{config_id\}, organizations/{organization\}/locations/global/muteConfigs/{config_id\}, folders/{folder\}/locations/global/muteConfigs/{config_id\}, or projects/{project\}/locations/global/muteConfigs/{config_id\}. + * Required. Name of the mute config to retrieve. Its format is `organizations/{organization\}/muteConfigs/{config_id\}`, `folders/{folder\}/muteConfigs/{config_id\}`, `projects/{project\}/muteConfigs/{config_id\}`, `organizations/{organization\}/locations/global/muteConfigs/{config_id\}`, `folders/{folder\}/locations/global/muteConfigs/{config_id\}`, or `projects/{project\}/locations/global/muteConfigs/{config_id\}`. */ name?: string; } @@ -7972,14 +7972,14 @@ export namespace securitycenter_v1 { */ pageToken?: string; /** - * Required. The parent, which owns the collection of mute configs. Its format is "organizations/[organization_id]", "folders/[folder_id]", "projects/[project_id]". + * Required. The parent, which owns the collection of mute configs. Its format is `organizations/[organization_id]`, `folders/[folder_id]`, `projects/[project_id]`. */ parent?: string; } export interface Params$Resource$Folders$Locations$Muteconfigs$Patch extends StandardParameters { /** - * This field will be ignored if provided on config creation. Format "organizations/{organization\}/muteConfigs/{mute_config\}" "folders/{folder\}/muteConfigs/{mute_config\}" "projects/{project\}/muteConfigs/{mute_config\}" "organizations/{organization\}/locations/global/muteConfigs/{mute_config\}" "folders/{folder\}/locations/global/muteConfigs/{mute_config\}" "projects/{project\}/locations/global/muteConfigs/{mute_config\}" + * This field will be ignored if provided on config creation. Format `organizations/{organization\}/muteConfigs/{mute_config\}` `folders/{folder\}/muteConfigs/{mute_config\}` `projects/{project\}/muteConfigs/{mute_config\}` `organizations/{organization\}/locations/global/muteConfigs/{mute_config\}` `folders/{folder\}/locations/global/muteConfigs/{mute_config\}` `projects/{project\}/locations/global/muteConfigs/{mute_config\}` */ name?: string; /** @@ -8475,7 +8475,7 @@ export namespace securitycenter_v1 { */ muteConfigId?: string; /** - * Required. Resource name of the new mute configs's parent. Its format is "organizations/[organization_id]", "folders/[folder_id]", or "projects/[project_id]". + * Required. Resource name of the new mute configs's parent. Its format is `organizations/[organization_id]`, `folders/[folder_id]`, or `projects/[project_id]`. */ parent?: string; @@ -8487,14 +8487,14 @@ export namespace securitycenter_v1 { export interface Params$Resource$Folders$Muteconfigs$Delete extends StandardParameters { /** - * Required. Name of the mute config to delete. Its format is organizations/{organization\}/muteConfigs/{config_id\}, folders/{folder\}/muteConfigs/{config_id\}, projects/{project\}/muteConfigs/{config_id\}, organizations/{organization\}/locations/global/muteConfigs/{config_id\}, folders/{folder\}/locations/global/muteConfigs/{config_id\}, or projects/{project\}/locations/global/muteConfigs/{config_id\}. + * Required. Name of the mute config to delete. Its format is `organizations/{organization\}/muteConfigs/{config_id\}`, `folders/{folder\}/muteConfigs/{config_id\}`, `projects/{project\}/muteConfigs/{config_id\}`, `organizations/{organization\}/locations/global/muteConfigs/{config_id\}`, `folders/{folder\}/locations/global/muteConfigs/{config_id\}`, or `projects/{project\}/locations/global/muteConfigs/{config_id\}`. */ name?: string; } export interface Params$Resource$Folders$Muteconfigs$Get extends StandardParameters { /** - * Required. Name of the mute config to retrieve. Its format is organizations/{organization\}/muteConfigs/{config_id\}, folders/{folder\}/muteConfigs/{config_id\}, projects/{project\}/muteConfigs/{config_id\}, organizations/{organization\}/locations/global/muteConfigs/{config_id\}, folders/{folder\}/locations/global/muteConfigs/{config_id\}, or projects/{project\}/locations/global/muteConfigs/{config_id\}. + * Required. Name of the mute config to retrieve. Its format is `organizations/{organization\}/muteConfigs/{config_id\}`, `folders/{folder\}/muteConfigs/{config_id\}`, `projects/{project\}/muteConfigs/{config_id\}`, `organizations/{organization\}/locations/global/muteConfigs/{config_id\}`, `folders/{folder\}/locations/global/muteConfigs/{config_id\}`, or `projects/{project\}/locations/global/muteConfigs/{config_id\}`. */ name?: string; } @@ -8509,14 +8509,14 @@ export namespace securitycenter_v1 { */ pageToken?: string; /** - * Required. The parent, which owns the collection of mute configs. Its format is "organizations/[organization_id]", "folders/[folder_id]", "projects/[project_id]". + * Required. The parent, which owns the collection of mute configs. Its format is `organizations/[organization_id]`, `folders/[folder_id]`, `projects/[project_id]`. */ parent?: string; } export interface Params$Resource$Folders$Muteconfigs$Patch extends StandardParameters { /** - * This field will be ignored if provided on config creation. Format "organizations/{organization\}/muteConfigs/{mute_config\}" "folders/{folder\}/muteConfigs/{mute_config\}" "projects/{project\}/muteConfigs/{mute_config\}" "organizations/{organization\}/locations/global/muteConfigs/{mute_config\}" "folders/{folder\}/locations/global/muteConfigs/{mute_config\}" "projects/{project\}/locations/global/muteConfigs/{mute_config\}" + * This field will be ignored if provided on config creation. Format `organizations/{organization\}/muteConfigs/{mute_config\}` `folders/{folder\}/muteConfigs/{mute_config\}` `projects/{project\}/muteConfigs/{mute_config\}` `organizations/{organization\}/locations/global/muteConfigs/{mute_config\}` `folders/{folder\}/locations/global/muteConfigs/{mute_config\}` `projects/{project\}/locations/global/muteConfigs/{mute_config\}` */ name?: string; /** @@ -8998,7 +8998,7 @@ export namespace securitycenter_v1 { */ configId?: string; /** - * Required. Resource name of the new notification config's parent. Its format is "organizations/[organization_id]", "folders/[folder_id]", or "projects/[project_id]". + * Required. Resource name of the new notification config's parent. Its format is `organizations/[organization_id]`, `folders/[folder_id]`, or `projects/[project_id]`. */ parent?: string; @@ -9010,14 +9010,14 @@ export namespace securitycenter_v1 { export interface Params$Resource$Folders$Notificationconfigs$Delete extends StandardParameters { /** - * Required. Name of the notification config to delete. Its format is "organizations/[organization_id]/notificationConfigs/[config_id]", "folders/[folder_id]/notificationConfigs/[config_id]", or "projects/[project_id]/notificationConfigs/[config_id]". + * Required. Name of the notification config to delete. Its format is `organizations/[organization_id]/notificationConfigs/[config_id]`, `folders/[folder_id]/notificationConfigs/[config_id]`, or `projects/[project_id]/notificationConfigs/[config_id]`. */ name?: string; } export interface Params$Resource$Folders$Notificationconfigs$Get extends StandardParameters { /** - * Required. Name of the notification config to get. Its format is "organizations/[organization_id]/notificationConfigs/[config_id]", "folders/[folder_id]/notificationConfigs/[config_id]", or "projects/[project_id]/notificationConfigs/[config_id]". + * Required. Name of the notification config to get. Its format is `organizations/[organization_id]/notificationConfigs/[config_id]`, `folders/[folder_id]/notificationConfigs/[config_id]`, or `projects/[project_id]/notificationConfigs/[config_id]`. */ name?: string; } @@ -9754,7 +9754,7 @@ export namespace securitycenter_v1 { export interface Params$Resource$Folders$Securityhealthanalyticssettings$Custommodules$Create extends StandardParameters { /** - * Required. Resource name of the new custom module's parent. Its format is "organizations/{organization\}/securityHealthAnalyticsSettings", "folders/{folder\}/securityHealthAnalyticsSettings", or "projects/{project\}/securityHealthAnalyticsSettings" + * Required. Resource name of the new custom module's parent. Its format is `organizations/{organization\}/securityHealthAnalyticsSettings`, `folders/{folder\}/securityHealthAnalyticsSettings`, or `projects/{project\}/securityHealthAnalyticsSettings` */ parent?: string; @@ -9766,14 +9766,14 @@ export namespace securitycenter_v1 { export interface Params$Resource$Folders$Securityhealthanalyticssettings$Custommodules$Delete extends StandardParameters { /** - * Required. Name of the custom module to delete. Its format is "organizations/{organization\}/securityHealthAnalyticsSettings/customModules/{customModule\}", "folders/{folder\}/securityHealthAnalyticsSettings/customModules/{customModule\}", or "projects/{project\}/securityHealthAnalyticsSettings/customModules/{customModule\}" + * Required. Name of the custom module to delete. Its format is `organizations/{organization\}/securityHealthAnalyticsSettings/customModules/{customModule\}`, `folders/{folder\}/securityHealthAnalyticsSettings/customModules/{customModule\}`, or `projects/{project\}/securityHealthAnalyticsSettings/customModules/{customModule\}` */ name?: string; } export interface Params$Resource$Folders$Securityhealthanalyticssettings$Custommodules$Get extends StandardParameters { /** - * Required. Name of the custom module to get. Its format is "organizations/{organization\}/securityHealthAnalyticsSettings/customModules/{customModule\}", "folders/{folder\}/securityHealthAnalyticsSettings/customModules/{customModule\}", or "projects/{project\}/securityHealthAnalyticsSettings/customModules/{customModule\}" + * Required. Name of the custom module to get. Its format is `organizations/{organization\}/securityHealthAnalyticsSettings/customModules/{customModule\}`, `folders/{folder\}/securityHealthAnalyticsSettings/customModules/{customModule\}`, or `projects/{project\}/securityHealthAnalyticsSettings/customModules/{customModule\}` */ name?: string; } @@ -9788,7 +9788,7 @@ export namespace securitycenter_v1 { */ pageToken?: string; /** - * Required. Name of parent to list custom modules. Its format is "organizations/{organization\}/securityHealthAnalyticsSettings", "folders/{folder\}/securityHealthAnalyticsSettings", or "projects/{project\}/securityHealthAnalyticsSettings" + * Required. Name of parent to list custom modules. Its format is `organizations/{organization\}/securityHealthAnalyticsSettings`, `folders/{folder\}/securityHealthAnalyticsSettings`, or `projects/{project\}/securityHealthAnalyticsSettings` */ parent?: string; } @@ -9803,7 +9803,7 @@ export namespace securitycenter_v1 { */ pageToken?: string; /** - * Required. Name of parent to list descendant custom modules. Its format is "organizations/{organization\}/securityHealthAnalyticsSettings", "folders/{folder\}/securityHealthAnalyticsSettings", or "projects/{project\}/securityHealthAnalyticsSettings" + * Required. Name of parent to list descendant custom modules. Its format is `organizations/{organization\}/securityHealthAnalyticsSettings`, `folders/{folder\}/securityHealthAnalyticsSettings`, or `projects/{project\}/securityHealthAnalyticsSettings` */ parent?: string; } @@ -10041,7 +10041,7 @@ export namespace securitycenter_v1 { export interface Params$Resource$Folders$Securityhealthanalyticssettings$Effectivecustommodules$Get extends StandardParameters { /** - * Required. Name of the effective custom module to get. Its format is "organizations/{organization\}/securityHealthAnalyticsSettings/effectiveCustomModules/{customModule\}", "folders/{folder\}/securityHealthAnalyticsSettings/effectiveCustomModules/{customModule\}", or "projects/{project\}/securityHealthAnalyticsSettings/effectiveCustomModules/{customModule\}" + * Required. Name of the effective custom module to get. Its format is `organizations/{organization\}/securityHealthAnalyticsSettings/effectiveCustomModules/{customModule\}`, `folders/{folder\}/securityHealthAnalyticsSettings/effectiveCustomModules/{customModule\}`, or `projects/{project\}/securityHealthAnalyticsSettings/effectiveCustomModules/{customModule\}` */ name?: string; } @@ -10056,7 +10056,7 @@ export namespace securitycenter_v1 { */ pageToken?: string; /** - * Required. Name of parent to list effective custom modules. Its format is "organizations/{organization\}/securityHealthAnalyticsSettings", "folders/{folder\}/securityHealthAnalyticsSettings", or "projects/{project\}/securityHealthAnalyticsSettings" + * Required. Name of parent to list effective custom modules. Its format is `organizations/{organization\}/securityHealthAnalyticsSettings`, `folders/{folder\}/securityHealthAnalyticsSettings`, or `projects/{project\}/securityHealthAnalyticsSettings` */ parent?: string; } @@ -10173,7 +10173,7 @@ export namespace securitycenter_v1 { */ pageToken?: string; /** - * Required. Resource name of the parent of sources to list. Its format should be "organizations/[organization_id]", "folders/[folder_id]", or "projects/[project_id]". + * Required. Resource name of the parent of sources to list. Its format should be `organizations/[organization_id]`, `folders/[folder_id]`, or `projects/[project_id]`. */ parent?: string; } @@ -10732,7 +10732,7 @@ export namespace securitycenter_v1 { export interface Params$Resource$Folders$Sources$Findings$Group extends StandardParameters { /** - * Required. Name of the source to groupBy. Its format is "organizations/[organization_id]/sources/[source_id]", folders/[folder_id]/sources/[source_id], or projects/[project_id]/sources/[source_id]. To groupBy across all sources provide a source_id of `-`. For example: organizations/{organization_id\}/sources/-, folders/{folder_id\}/sources/-, or projects/{project_id\}/sources/- + * Required. Name of the source to groupBy. Its format is `organizations/[organization_id]/sources/[source_id]`, `folders/[folder_id]/sources/[source_id]`, or `projects/[project_id]/sources/[source_id]`. To groupBy across all sources provide a source_id of `-`. For example: `organizations/{organization_id\}/sources/-, folders/{folder_id\}/sources/-`, or `projects/{project_id\}/sources/-` */ parent?: string; @@ -10768,7 +10768,7 @@ export namespace securitycenter_v1 { */ pageToken?: string; /** - * Required. Name of the source the findings belong to. Its format is "organizations/[organization_id]/sources/[source_id], folders/[folder_id]/sources/[source_id], or projects/[project_id]/sources/[source_id]". To list across all sources provide a source_id of `-`. For example: organizations/{organization_id\}/sources/-, folders/{folder_id\}/sources/- or projects/{projects_id\}/sources/- + * Required. Name of the source the findings belong to. Its format is `organizations/[organization_id]/sources/[source_id]`, `folders/[folder_id]/sources/[source_id]`, or `projects/[project_id]/sources/[source_id]`. To list across all sources provide a source_id of `-`. For example: `organizations/{organization_id\}/sources/-`, `folders/{folder_id\}/sources/-` or `projects/{projects_id\}/sources/-` */ parent?: string; /** @@ -10795,7 +10795,7 @@ export namespace securitycenter_v1 { export interface Params$Resource$Folders$Sources$Findings$Setmute extends StandardParameters { /** - * Required. The [relative resource name](https://cloud.google.com/apis/design/resource_names#relative_resource_name) of the finding. Example: "organizations/{organization_id\}/sources/{source_id\}/findings/{finding_id\}", "folders/{folder_id\}/sources/{source_id\}/findings/{finding_id\}", "projects/{project_id\}/sources/{source_id\}/findings/{finding_id\}". + * Required. The [relative resource name](https://cloud.google.com/apis/design/resource_names#relative_resource_name) of the finding. Example: `organizations/{organization_id\}/sources/{source_id\}/findings/{finding_id\}`, `folders/{folder_id\}/sources/{source_id\}/findings/{finding_id\}`, `projects/{project_id\}/sources/{source_id\}/findings/{finding_id\}`. */ name?: string; @@ -10807,7 +10807,7 @@ export namespace securitycenter_v1 { export interface Params$Resource$Folders$Sources$Findings$Setstate extends StandardParameters { /** - * Required. The [relative resource name](https://cloud.google.com/apis/design/resource_names#relative_resource_name) of the finding. Example: "organizations/{organization_id\}/sources/{source_id\}/findings/{finding_id\}", "folders/{folder_id\}/sources/{source_id\}/findings/{finding_id\}", "projects/{project_id\}/sources/{source_id\}/findings/{finding_id\}". + * Required. The [relative resource name](https://cloud.google.com/apis/design/resource_names#relative_resource_name) of the finding. Example: `organizations/{organization_id\}/sources/{source_id\}/findings/{finding_id\}`, `folders/{folder_id\}/sources/{source_id\}/findings/{finding_id\}`, `projects/{project_id\}/sources/{source_id\}/findings/{finding_id\}`. */ name?: string; @@ -11186,7 +11186,7 @@ export namespace securitycenter_v1 { export interface Params$Resource$Organizations$Getorganizationsettings extends StandardParameters { /** - * Required. Name of the organization to get organization settings for. Its format is "organizations/[organization_id]/organizationSettings". + * Required. Name of the organization to get organization settings for. Its format is `organizations/[organization_id]/organizationSettings`. */ name?: string; } @@ -11578,7 +11578,7 @@ export namespace securitycenter_v1 { export interface Params$Resource$Organizations$Assets$Group extends StandardParameters { /** - * Required. The name of the parent to group the assets by. Its format is "organizations/[organization_id]", "folders/[folder_id]", or "projects/[project_id]". + * Required. The name of the parent to group the assets by. Its format is `organizations/[organization_id]`, `folders/[folder_id]`, or `projects/[project_id]`. */ parent?: string; @@ -11614,7 +11614,7 @@ export namespace securitycenter_v1 { */ pageToken?: string; /** - * Required. The name of the parent resource that contains the assets. The value that you can specify on parent depends on the method in which you specify parent. You can specify one of the following values: "organizations/[organization_id]", "folders/[folder_id]", or "projects/[project_id]". + * Required. The name of the parent resource that contains the assets. The value that you can specify on parent depends on the method in which you specify parent. You can specify one of the following values: `organizations/[organization_id]`, `folders/[folder_id]`, or `projects/[project_id]`. */ parent?: string; /** @@ -11625,7 +11625,7 @@ export namespace securitycenter_v1 { export interface Params$Resource$Organizations$Assets$Rundiscovery extends StandardParameters { /** - * Required. Name of the organization to run asset discovery for. Its format is "organizations/[organization_id]". + * Required. Name of the organization to run asset discovery for. Its format is `organizations/[organization_id]`. */ parent?: string; @@ -12139,7 +12139,7 @@ export namespace securitycenter_v1 { */ bigQueryExportId?: string; /** - * Required. The name of the parent resource of the new BigQuery export. Its format is "organizations/[organization_id]", "folders/[folder_id]", or "projects/[project_id]". + * Required. The name of the parent resource of the new BigQuery export. Its format is `organizations/[organization_id]`, `folders/[folder_id]`, or `projects/[project_id]`. */ parent?: string; @@ -12151,14 +12151,14 @@ export namespace securitycenter_v1 { export interface Params$Resource$Organizations$Bigqueryexports$Delete extends StandardParameters { /** - * Required. The name of the BigQuery export to delete. Its format is organizations/{organization\}/bigQueryExports/{export_id\}, folders/{folder\}/bigQueryExports/{export_id\}, or projects/{project\}/bigQueryExports/{export_id\} + * Required. The name of the BigQuery export to delete. Its format is `organizations/{organization\}/bigQueryExports/{export_id\}`, `folders/{folder\}/bigQueryExports/{export_id\}`, or `projects/{project\}/bigQueryExports/{export_id\}` */ name?: string; } export interface Params$Resource$Organizations$Bigqueryexports$Get extends StandardParameters { /** - * Required. Name of the BigQuery export to retrieve. Its format is organizations/{organization\}/bigQueryExports/{export_id\}, folders/{folder\}/bigQueryExports/{export_id\}, or projects/{project\}/bigQueryExports/{export_id\} + * Required. Name of the BigQuery export to retrieve. Its format is `organizations/{organization\}/bigQueryExports/{export_id\}`, `folders/{folder\}/bigQueryExports/{export_id\}`, or `projects/{project\}/bigQueryExports/{export_id\}` */ name?: string; } @@ -12173,7 +12173,7 @@ export namespace securitycenter_v1 { */ pageToken?: string; /** - * Required. The parent, which owns the collection of BigQuery exports. Its format is "organizations/[organization_id]", "folders/[folder_id]", "projects/[project_id]". + * Required. The parent, which owns the collection of BigQuery exports. Its format is `organizations/[organization_id]`, `folders/[folder_id]`, `projects/[project_id]`. */ parent?: string; } @@ -12313,7 +12313,7 @@ export namespace securitycenter_v1 { export interface Params$Resource$Organizations$Eventthreatdetectionsettings$Validatecustommodule extends StandardParameters { /** - * Required. Resource name of the parent to validate the Custom Module under. Its format is: * "organizations/{organization\}/eventThreatDetectionSettings". * "folders/{folder\}/eventThreatDetectionSettings". * "projects/{project\}/eventThreatDetectionSettings". + * Required. Resource name of the parent to validate the Custom Module under. Its format is: * `organizations/{organization\}/eventThreatDetectionSettings`. * `folders/{folder\}/eventThreatDetectionSettings`. * `projects/{project\}/eventThreatDetectionSettings`. */ parent?: string; @@ -12908,7 +12908,7 @@ export namespace securitycenter_v1 { export interface Params$Resource$Organizations$Eventthreatdetectionsettings$Custommodules$Create extends StandardParameters { /** - * Required. The new custom module's parent. Its format is: * "organizations/{organization\}/eventThreatDetectionSettings". * "folders/{folder\}/eventThreatDetectionSettings". * "projects/{project\}/eventThreatDetectionSettings". + * Required. The new custom module's parent. Its format is: * `organizations/{organization\}/eventThreatDetectionSettings`. * `folders/{folder\}/eventThreatDetectionSettings`. * `projects/{project\}/eventThreatDetectionSettings`. */ parent?: string; @@ -12920,14 +12920,14 @@ export namespace securitycenter_v1 { export interface Params$Resource$Organizations$Eventthreatdetectionsettings$Custommodules$Delete extends StandardParameters { /** - * Required. Name of the custom module to delete. Its format is: * "organizations/{organization\}/eventThreatDetectionSettings/customModules/{module\}". * "folders/{folder\}/eventThreatDetectionSettings/customModules/{module\}". * "projects/{project\}/eventThreatDetectionSettings/customModules/{module\}". + * Required. Name of the custom module to delete. Its format is: * `organizations/{organization\}/eventThreatDetectionSettings/customModules/{module\}`. * `folders/{folder\}/eventThreatDetectionSettings/customModules/{module\}`. * `projects/{project\}/eventThreatDetectionSettings/customModules/{module\}`. */ name?: string; } export interface Params$Resource$Organizations$Eventthreatdetectionsettings$Custommodules$Get extends StandardParameters { /** - * Required. Name of the custom module to get. Its format is: * "organizations/{organization\}/eventThreatDetectionSettings/customModules/{module\}". * "folders/{folder\}/eventThreatDetectionSettings/customModules/{module\}". * "projects/{project\}/eventThreatDetectionSettings/customModules/{module\}". + * Required. Name of the custom module to get. Its format is: * `organizations/{organization\}/eventThreatDetectionSettings/customModules/{module\}`. * `folders/{folder\}/eventThreatDetectionSettings/customModules/{module\}`. * `projects/{project\}/eventThreatDetectionSettings/customModules/{module\}`. */ name?: string; } @@ -12942,7 +12942,7 @@ export namespace securitycenter_v1 { */ pageToken?: string; /** - * Required. Name of the parent to list custom modules under. Its format is: * "organizations/{organization\}/eventThreatDetectionSettings". * "folders/{folder\}/eventThreatDetectionSettings". * "projects/{project\}/eventThreatDetectionSettings". + * Required. Name of the parent to list custom modules under. Its format is: * `organizations/{organization\}/eventThreatDetectionSettings`. * `folders/{folder\}/eventThreatDetectionSettings`. * `projects/{project\}/eventThreatDetectionSettings`. */ parent?: string; } @@ -12957,14 +12957,14 @@ export namespace securitycenter_v1 { */ pageToken?: string; /** - * Required. Name of the parent to list custom modules under. Its format is: * "organizations/{organization\}/eventThreatDetectionSettings". * "folders/{folder\}/eventThreatDetectionSettings". * "projects/{project\}/eventThreatDetectionSettings". + * Required. Name of the parent to list custom modules under. Its format is: * `organizations/{organization\}/eventThreatDetectionSettings`. * `folders/{folder\}/eventThreatDetectionSettings`. * `projects/{project\}/eventThreatDetectionSettings`. */ parent?: string; } export interface Params$Resource$Organizations$Eventthreatdetectionsettings$Custommodules$Patch extends StandardParameters { /** - * Immutable. The resource name of the Event Threat Detection custom module. Its format is: * "organizations/{organization\}/eventThreatDetectionSettings/customModules/{module\}". * "folders/{folder\}/eventThreatDetectionSettings/customModules/{module\}". * "projects/{project\}/eventThreatDetectionSettings/customModules/{module\}". + * Immutable. The resource name of the Event Threat Detection custom module. Its format is: * `organizations/{organization\}/eventThreatDetectionSettings/customModules/{module\}`. * `folders/{folder\}/eventThreatDetectionSettings/customModules/{module\}`. * `projects/{project\}/eventThreatDetectionSettings/customModules/{module\}`. */ name?: string; /** @@ -13183,7 +13183,7 @@ export namespace securitycenter_v1 { export interface Params$Resource$Organizations$Eventthreatdetectionsettings$Effectivecustommodules$Get extends StandardParameters { /** - * Required. The resource name of the effective Event Threat Detection custom module. Its format is: * "organizations/{organization\}/eventThreatDetectionSettings/effectiveCustomModules/{module\}". * "folders/{folder\}/eventThreatDetectionSettings/effectiveCustomModules/{module\}". * "projects/{project\}/eventThreatDetectionSettings/effectiveCustomModules/{module\}". + * Required. The resource name of the effective Event Threat Detection custom module. Its format is: * `organizations/{organization\}/eventThreatDetectionSettings/effectiveCustomModules/{module\}`. * `folders/{folder\}/eventThreatDetectionSettings/effectiveCustomModules/{module\}`. * `projects/{project\}/eventThreatDetectionSettings/effectiveCustomModules/{module\}`. */ name?: string; } @@ -13198,7 +13198,7 @@ export namespace securitycenter_v1 { */ pageToken?: string; /** - * Required. Name of the parent to list custom modules for. Its format is: * "organizations/{organization\}/eventThreatDetectionSettings". * "folders/{folder\}/eventThreatDetectionSettings". * "projects/{project\}/eventThreatDetectionSettings". + * Required. Name of the parent to list custom modules for. Its format is: * `organizations/{organization\}/eventThreatDetectionSettings`. * `folders/{folder\}/eventThreatDetectionSettings`. * `projects/{project\}/eventThreatDetectionSettings`. */ parent?: string; } @@ -13302,7 +13302,7 @@ export namespace securitycenter_v1 { export interface Params$Resource$Organizations$Findings$Bulkmute extends StandardParameters { /** - * Required. The parent, at which bulk action needs to be applied. Its format is "organizations/[organization_id]", "folders/[folder_id]", "projects/[project_id]". + * Required. The parent, at which bulk action needs to be applied. Its format is `organizations/[organization_id]`, `folders/[folder_id]`, `projects/[project_id]`. */ parent?: string; @@ -13805,7 +13805,7 @@ export namespace securitycenter_v1 { */ muteConfigId?: string; /** - * Required. Resource name of the new mute configs's parent. Its format is "organizations/[organization_id]", "folders/[folder_id]", or "projects/[project_id]". + * Required. Resource name of the new mute configs's parent. Its format is `organizations/[organization_id]`, `folders/[folder_id]`, or `projects/[project_id]`. */ parent?: string; @@ -13817,14 +13817,14 @@ export namespace securitycenter_v1 { export interface Params$Resource$Organizations$Locations$Muteconfigs$Delete extends StandardParameters { /** - * Required. Name of the mute config to delete. Its format is organizations/{organization\}/muteConfigs/{config_id\}, folders/{folder\}/muteConfigs/{config_id\}, projects/{project\}/muteConfigs/{config_id\}, organizations/{organization\}/locations/global/muteConfigs/{config_id\}, folders/{folder\}/locations/global/muteConfigs/{config_id\}, or projects/{project\}/locations/global/muteConfigs/{config_id\}. + * Required. Name of the mute config to delete. Its format is `organizations/{organization\}/muteConfigs/{config_id\}`, `folders/{folder\}/muteConfigs/{config_id\}`, `projects/{project\}/muteConfigs/{config_id\}`, `organizations/{organization\}/locations/global/muteConfigs/{config_id\}`, `folders/{folder\}/locations/global/muteConfigs/{config_id\}`, or `projects/{project\}/locations/global/muteConfigs/{config_id\}`. */ name?: string; } export interface Params$Resource$Organizations$Locations$Muteconfigs$Get extends StandardParameters { /** - * Required. Name of the mute config to retrieve. Its format is organizations/{organization\}/muteConfigs/{config_id\}, folders/{folder\}/muteConfigs/{config_id\}, projects/{project\}/muteConfigs/{config_id\}, organizations/{organization\}/locations/global/muteConfigs/{config_id\}, folders/{folder\}/locations/global/muteConfigs/{config_id\}, or projects/{project\}/locations/global/muteConfigs/{config_id\}. + * Required. Name of the mute config to retrieve. Its format is `organizations/{organization\}/muteConfigs/{config_id\}`, `folders/{folder\}/muteConfigs/{config_id\}`, `projects/{project\}/muteConfigs/{config_id\}`, `organizations/{organization\}/locations/global/muteConfigs/{config_id\}`, `folders/{folder\}/locations/global/muteConfigs/{config_id\}`, or `projects/{project\}/locations/global/muteConfigs/{config_id\}`. */ name?: string; } @@ -13839,14 +13839,14 @@ export namespace securitycenter_v1 { */ pageToken?: string; /** - * Required. The parent, which owns the collection of mute configs. Its format is "organizations/[organization_id]", "folders/[folder_id]", "projects/[project_id]". + * Required. The parent, which owns the collection of mute configs. Its format is `organizations/[organization_id]`, `folders/[folder_id]`, `projects/[project_id]`. */ parent?: string; } export interface Params$Resource$Organizations$Locations$Muteconfigs$Patch extends StandardParameters { /** - * This field will be ignored if provided on config creation. Format "organizations/{organization\}/muteConfigs/{mute_config\}" "folders/{folder\}/muteConfigs/{mute_config\}" "projects/{project\}/muteConfigs/{mute_config\}" "organizations/{organization\}/locations/global/muteConfigs/{mute_config\}" "folders/{folder\}/locations/global/muteConfigs/{mute_config\}" "projects/{project\}/locations/global/muteConfigs/{mute_config\}" + * This field will be ignored if provided on config creation. Format `organizations/{organization\}/muteConfigs/{mute_config\}` `folders/{folder\}/muteConfigs/{mute_config\}` `projects/{project\}/muteConfigs/{mute_config\}` `organizations/{organization\}/locations/global/muteConfigs/{mute_config\}` `folders/{folder\}/locations/global/muteConfigs/{mute_config\}` `projects/{project\}/locations/global/muteConfigs/{mute_config\}` */ name?: string; /** @@ -14342,7 +14342,7 @@ export namespace securitycenter_v1 { */ muteConfigId?: string; /** - * Required. Resource name of the new mute configs's parent. Its format is "organizations/[organization_id]", "folders/[folder_id]", or "projects/[project_id]". + * Required. Resource name of the new mute configs's parent. Its format is `organizations/[organization_id]`, `folders/[folder_id]`, or `projects/[project_id]`. */ parent?: string; @@ -14354,14 +14354,14 @@ export namespace securitycenter_v1 { export interface Params$Resource$Organizations$Muteconfigs$Delete extends StandardParameters { /** - * Required. Name of the mute config to delete. Its format is organizations/{organization\}/muteConfigs/{config_id\}, folders/{folder\}/muteConfigs/{config_id\}, projects/{project\}/muteConfigs/{config_id\}, organizations/{organization\}/locations/global/muteConfigs/{config_id\}, folders/{folder\}/locations/global/muteConfigs/{config_id\}, or projects/{project\}/locations/global/muteConfigs/{config_id\}. + * Required. Name of the mute config to delete. Its format is `organizations/{organization\}/muteConfigs/{config_id\}`, `folders/{folder\}/muteConfigs/{config_id\}`, `projects/{project\}/muteConfigs/{config_id\}`, `organizations/{organization\}/locations/global/muteConfigs/{config_id\}`, `folders/{folder\}/locations/global/muteConfigs/{config_id\}`, or `projects/{project\}/locations/global/muteConfigs/{config_id\}`. */ name?: string; } export interface Params$Resource$Organizations$Muteconfigs$Get extends StandardParameters { /** - * Required. Name of the mute config to retrieve. Its format is organizations/{organization\}/muteConfigs/{config_id\}, folders/{folder\}/muteConfigs/{config_id\}, projects/{project\}/muteConfigs/{config_id\}, organizations/{organization\}/locations/global/muteConfigs/{config_id\}, folders/{folder\}/locations/global/muteConfigs/{config_id\}, or projects/{project\}/locations/global/muteConfigs/{config_id\}. + * Required. Name of the mute config to retrieve. Its format is `organizations/{organization\}/muteConfigs/{config_id\}`, `folders/{folder\}/muteConfigs/{config_id\}`, `projects/{project\}/muteConfigs/{config_id\}`, `organizations/{organization\}/locations/global/muteConfigs/{config_id\}`, `folders/{folder\}/locations/global/muteConfigs/{config_id\}`, or `projects/{project\}/locations/global/muteConfigs/{config_id\}`. */ name?: string; } @@ -14376,14 +14376,14 @@ export namespace securitycenter_v1 { */ pageToken?: string; /** - * Required. The parent, which owns the collection of mute configs. Its format is "organizations/[organization_id]", "folders/[folder_id]", "projects/[project_id]". + * Required. The parent, which owns the collection of mute configs. Its format is `organizations/[organization_id]`, `folders/[folder_id]`, `projects/[project_id]`. */ parent?: string; } export interface Params$Resource$Organizations$Muteconfigs$Patch extends StandardParameters { /** - * This field will be ignored if provided on config creation. Format "organizations/{organization\}/muteConfigs/{mute_config\}" "folders/{folder\}/muteConfigs/{mute_config\}" "projects/{project\}/muteConfigs/{mute_config\}" "organizations/{organization\}/locations/global/muteConfigs/{mute_config\}" "folders/{folder\}/locations/global/muteConfigs/{mute_config\}" "projects/{project\}/locations/global/muteConfigs/{mute_config\}" + * This field will be ignored if provided on config creation. Format `organizations/{organization\}/muteConfigs/{mute_config\}` `folders/{folder\}/muteConfigs/{mute_config\}` `projects/{project\}/muteConfigs/{mute_config\}` `organizations/{organization\}/locations/global/muteConfigs/{mute_config\}` `folders/{folder\}/locations/global/muteConfigs/{mute_config\}` `projects/{project\}/locations/global/muteConfigs/{mute_config\}` */ name?: string; /** @@ -14865,7 +14865,7 @@ export namespace securitycenter_v1 { */ configId?: string; /** - * Required. Resource name of the new notification config's parent. Its format is "organizations/[organization_id]", "folders/[folder_id]", or "projects/[project_id]". + * Required. Resource name of the new notification config's parent. Its format is `organizations/[organization_id]`, `folders/[folder_id]`, or `projects/[project_id]`. */ parent?: string; @@ -14877,14 +14877,14 @@ export namespace securitycenter_v1 { export interface Params$Resource$Organizations$Notificationconfigs$Delete extends StandardParameters { /** - * Required. Name of the notification config to delete. Its format is "organizations/[organization_id]/notificationConfigs/[config_id]", "folders/[folder_id]/notificationConfigs/[config_id]", or "projects/[project_id]/notificationConfigs/[config_id]". + * Required. Name of the notification config to delete. Its format is `organizations/[organization_id]/notificationConfigs/[config_id]`, `folders/[folder_id]/notificationConfigs/[config_id]`, or `projects/[project_id]/notificationConfigs/[config_id]`. */ name?: string; } export interface Params$Resource$Organizations$Notificationconfigs$Get extends StandardParameters { /** - * Required. Name of the notification config to get. Its format is "organizations/[organization_id]/notificationConfigs/[config_id]", "folders/[folder_id]/notificationConfigs/[config_id]", or "projects/[project_id]/notificationConfigs/[config_id]". + * Required. Name of the notification config to get. Its format is `organizations/[organization_id]/notificationConfigs/[config_id]`, `folders/[folder_id]/notificationConfigs/[config_id]`, or `projects/[project_id]/notificationConfigs/[config_id]`. */ name?: string; } @@ -15819,7 +15819,7 @@ export namespace securitycenter_v1 { export interface Params$Resource$Organizations$Resourcevalueconfigs$Get extends StandardParameters { /** - * Required. Name of the resource value config to retrieve. Its format is organizations/{organization\}/resourceValueConfigs/{config_id\}. + * Required. Name of the resource value config to retrieve. Its format is `organizations/{organization\}/resourceValueConfigs/{config_id\}`. */ name?: string; } @@ -15834,7 +15834,7 @@ export namespace securitycenter_v1 { */ pageToken?: string; /** - * Required. The parent, which owns the collection of resource value configs. Its format is "organizations/[organization_id]" + * Required. The parent, which owns the collection of resource value configs. Its format is `organizations/[organization_id]` */ parent?: string; } @@ -16556,7 +16556,7 @@ export namespace securitycenter_v1 { export interface Params$Resource$Organizations$Securityhealthanalyticssettings$Custommodules$Create extends StandardParameters { /** - * Required. Resource name of the new custom module's parent. Its format is "organizations/{organization\}/securityHealthAnalyticsSettings", "folders/{folder\}/securityHealthAnalyticsSettings", or "projects/{project\}/securityHealthAnalyticsSettings" + * Required. Resource name of the new custom module's parent. Its format is `organizations/{organization\}/securityHealthAnalyticsSettings`, `folders/{folder\}/securityHealthAnalyticsSettings`, or `projects/{project\}/securityHealthAnalyticsSettings` */ parent?: string; @@ -16568,14 +16568,14 @@ export namespace securitycenter_v1 { export interface Params$Resource$Organizations$Securityhealthanalyticssettings$Custommodules$Delete extends StandardParameters { /** - * Required. Name of the custom module to delete. Its format is "organizations/{organization\}/securityHealthAnalyticsSettings/customModules/{customModule\}", "folders/{folder\}/securityHealthAnalyticsSettings/customModules/{customModule\}", or "projects/{project\}/securityHealthAnalyticsSettings/customModules/{customModule\}" + * Required. Name of the custom module to delete. Its format is `organizations/{organization\}/securityHealthAnalyticsSettings/customModules/{customModule\}`, `folders/{folder\}/securityHealthAnalyticsSettings/customModules/{customModule\}`, or `projects/{project\}/securityHealthAnalyticsSettings/customModules/{customModule\}` */ name?: string; } export interface Params$Resource$Organizations$Securityhealthanalyticssettings$Custommodules$Get extends StandardParameters { /** - * Required. Name of the custom module to get. Its format is "organizations/{organization\}/securityHealthAnalyticsSettings/customModules/{customModule\}", "folders/{folder\}/securityHealthAnalyticsSettings/customModules/{customModule\}", or "projects/{project\}/securityHealthAnalyticsSettings/customModules/{customModule\}" + * Required. Name of the custom module to get. Its format is `organizations/{organization\}/securityHealthAnalyticsSettings/customModules/{customModule\}`, `folders/{folder\}/securityHealthAnalyticsSettings/customModules/{customModule\}`, or `projects/{project\}/securityHealthAnalyticsSettings/customModules/{customModule\}` */ name?: string; } @@ -16590,7 +16590,7 @@ export namespace securitycenter_v1 { */ pageToken?: string; /** - * Required. Name of parent to list custom modules. Its format is "organizations/{organization\}/securityHealthAnalyticsSettings", "folders/{folder\}/securityHealthAnalyticsSettings", or "projects/{project\}/securityHealthAnalyticsSettings" + * Required. Name of parent to list custom modules. Its format is `organizations/{organization\}/securityHealthAnalyticsSettings`, `folders/{folder\}/securityHealthAnalyticsSettings`, or `projects/{project\}/securityHealthAnalyticsSettings` */ parent?: string; } @@ -16605,7 +16605,7 @@ export namespace securitycenter_v1 { */ pageToken?: string; /** - * Required. Name of parent to list descendant custom modules. Its format is "organizations/{organization\}/securityHealthAnalyticsSettings", "folders/{folder\}/securityHealthAnalyticsSettings", or "projects/{project\}/securityHealthAnalyticsSettings" + * Required. Name of parent to list descendant custom modules. Its format is `organizations/{organization\}/securityHealthAnalyticsSettings`, `folders/{folder\}/securityHealthAnalyticsSettings`, or `projects/{project\}/securityHealthAnalyticsSettings` */ parent?: string; } @@ -16843,7 +16843,7 @@ export namespace securitycenter_v1 { export interface Params$Resource$Organizations$Securityhealthanalyticssettings$Effectivecustommodules$Get extends StandardParameters { /** - * Required. Name of the effective custom module to get. Its format is "organizations/{organization\}/securityHealthAnalyticsSettings/effectiveCustomModules/{customModule\}", "folders/{folder\}/securityHealthAnalyticsSettings/effectiveCustomModules/{customModule\}", or "projects/{project\}/securityHealthAnalyticsSettings/effectiveCustomModules/{customModule\}" + * Required. Name of the effective custom module to get. Its format is `organizations/{organization\}/securityHealthAnalyticsSettings/effectiveCustomModules/{customModule\}`, `folders/{folder\}/securityHealthAnalyticsSettings/effectiveCustomModules/{customModule\}`, or `projects/{project\}/securityHealthAnalyticsSettings/effectiveCustomModules/{customModule\}` */ name?: string; } @@ -16858,7 +16858,7 @@ export namespace securitycenter_v1 { */ pageToken?: string; /** - * Required. Name of parent to list effective custom modules. Its format is "organizations/{organization\}/securityHealthAnalyticsSettings", "folders/{folder\}/securityHealthAnalyticsSettings", or "projects/{project\}/securityHealthAnalyticsSettings" + * Required. Name of parent to list effective custom modules. Its format is `organizations/{organization\}/securityHealthAnalyticsSettings`, `folders/{folder\}/securityHealthAnalyticsSettings`, or `projects/{project\}/securityHealthAnalyticsSettings` */ parent?: string; } @@ -16971,7 +16971,7 @@ export namespace securitycenter_v1 { export interface Params$Resource$Organizations$Simulations$Get extends StandardParameters { /** - * Required. The organization name or simulation name of this simulation Valid format: "organizations/{organization\}/simulations/latest" "organizations/{organization\}/simulations/{simulation\}" + * Required. The organization name or simulation name of this simulation Valid format: `organizations/{organization\}/simulations/latest` `organizations/{organization\}/simulations/{simulation\}` */ name?: string; } @@ -17110,7 +17110,7 @@ export namespace securitycenter_v1 { */ pageToken?: string; /** - * Required. Name of parent to list attack paths. Valid formats: "organizations/{organization\}", "organizations/{organization\}/simulations/{simulation\}" "organizations/{organization\}/simulations/{simulation\}/attackExposureResults/{attack_exposure_result_v2\}" "organizations/{organization\}/simulations/{simulation\}/valuedResources/{valued_resource\}" + * Required. Name of parent to list attack paths. Valid formats: `organizations/{organization\}`, `organizations/{organization\}/simulations/{simulation\}` `organizations/{organization\}/simulations/{simulation\}/attackExposureResults/{attack_exposure_result_v2\}` `organizations/{organization\}/simulations/{simulation\}/valuedResources/{valued_resource\}` */ parent?: string; } @@ -17226,7 +17226,7 @@ export namespace securitycenter_v1 { */ filter?: string; /** - * Optional. The fields by which to order the valued resources response. Supported fields: * `exposed_score` * `resource_value` * `resource_type` * `resource` * `display_name` Values should be a comma separated list of fields. For example: `exposed_score,resource_value`. The default sorting order is descending. To specify ascending or descending order for a field, append a " ASC" or a " DESC" suffix, respectively; for example: `exposed_score DESC`. + * Optional. The fields by which to order the valued resources response. Supported fields: * `exposed_score` * `resource_value` * `resource_type` * `resource` * `display_name` Values should be a comma separated list of fields. For example: `exposed_score,resource_value`. The default sorting order is descending. To specify ascending or descending order for a field, append a ` ASC` or a ` DESC` suffix, respectively; for example: `exposed_score DESC`. */ orderBy?: string; /** @@ -17238,7 +17238,7 @@ export namespace securitycenter_v1 { */ pageToken?: string; /** - * Required. Name of parent to list valued resources. Valid formats: "organizations/{organization\}", "organizations/{organization\}/simulations/{simulation\}" "organizations/{organization\}/simulations/{simulation\}/attackExposureResults/{attack_exposure_result_v2\}" + * Required. Name of parent to list valued resources. Valid formats: `organizations/{organization\}`, `organizations/{organization\}/simulations/{simulation\}` `organizations/{organization\}/simulations/{simulation\}/attackExposureResults/{attack_exposure_result_v2\}` */ parent?: string; } @@ -17360,7 +17360,7 @@ export namespace securitycenter_v1 { */ pageToken?: string; /** - * Required. Name of parent to list attack paths. Valid formats: "organizations/{organization\}", "organizations/{organization\}/simulations/{simulation\}" "organizations/{organization\}/simulations/{simulation\}/attackExposureResults/{attack_exposure_result_v2\}" "organizations/{organization\}/simulations/{simulation\}/valuedResources/{valued_resource\}" + * Required. Name of parent to list attack paths. Valid formats: `organizations/{organization\}`, `organizations/{organization\}/simulations/{simulation\}` `organizations/{organization\}/simulations/{simulation\}/attackExposureResults/{attack_exposure_result_v2\}` `organizations/{organization\}/simulations/{simulation\}/valuedResources/{valued_resource\}` */ parent?: string; } @@ -17564,7 +17564,7 @@ export namespace securitycenter_v1 { export interface Params$Resource$Organizations$Simulations$Valuedresources$Get extends StandardParameters { /** - * Required. The name of this valued resource Valid format: "organizations/{organization\}/simulations/{simulation\}/valuedResources/{valued_resource\}" + * Required. The name of this valued resource Valid format: `organizations/{organization\}/simulations/{simulation\}/valuedResources/{valued_resource\}` */ name?: string; } @@ -17575,7 +17575,7 @@ export namespace securitycenter_v1 { */ filter?: string; /** - * Optional. The fields by which to order the valued resources response. Supported fields: * `exposed_score` * `resource_value` * `resource_type` * `resource` * `display_name` Values should be a comma separated list of fields. For example: `exposed_score,resource_value`. The default sorting order is descending. To specify ascending or descending order for a field, append a " ASC" or a " DESC" suffix, respectively; for example: `exposed_score DESC`. + * Optional. The fields by which to order the valued resources response. Supported fields: * `exposed_score` * `resource_value` * `resource_type` * `resource` * `display_name` Values should be a comma separated list of fields. For example: `exposed_score,resource_value`. The default sorting order is descending. To specify ascending or descending order for a field, append a ` ASC` or a ` DESC` suffix, respectively; for example: `exposed_score DESC`. */ orderBy?: string; /** @@ -17587,7 +17587,7 @@ export namespace securitycenter_v1 { */ pageToken?: string; /** - * Required. Name of parent to list valued resources. Valid formats: "organizations/{organization\}", "organizations/{organization\}/simulations/{simulation\}" "organizations/{organization\}/simulations/{simulation\}/attackExposureResults/{attack_exposure_result_v2\}" + * Required. Name of parent to list valued resources. Valid formats: `organizations/{organization\}`, `organizations/{organization\}/simulations/{simulation\}` `organizations/{organization\}/simulations/{simulation\}/attackExposureResults/{attack_exposure_result_v2\}` */ parent?: string; } @@ -17709,7 +17709,7 @@ export namespace securitycenter_v1 { */ pageToken?: string; /** - * Required. Name of parent to list attack paths. Valid formats: "organizations/{organization\}", "organizations/{organization\}/simulations/{simulation\}" "organizations/{organization\}/simulations/{simulation\}/attackExposureResults/{attack_exposure_result_v2\}" "organizations/{organization\}/simulations/{simulation\}/valuedResources/{valued_resource\}" + * Required. Name of parent to list attack paths. Valid formats: `organizations/{organization\}`, `organizations/{organization\}/simulations/{simulation\}` `organizations/{organization\}/simulations/{simulation\}/attackExposureResults/{attack_exposure_result_v2\}` `organizations/{organization\}/simulations/{simulation\}/valuedResources/{valued_resource\}` */ parent?: string; } @@ -18353,7 +18353,7 @@ export namespace securitycenter_v1 { export interface Params$Resource$Organizations$Sources$Create extends StandardParameters { /** - * Required. Resource name of the new source's parent. Its format should be "organizations/[organization_id]". + * Required. Resource name of the new source's parent. Its format should be `organizations/[organization_id]`. */ parent?: string; @@ -18365,7 +18365,7 @@ export namespace securitycenter_v1 { export interface Params$Resource$Organizations$Sources$Get extends StandardParameters { /** - * Required. Relative resource name of the source. Its format is "organizations/[organization_id]/source/[source_id]". + * Required. Relative resource name of the source. Its format is `organizations/[organization_id]/source/[source_id]`. */ name?: string; } @@ -18392,7 +18392,7 @@ export namespace securitycenter_v1 { */ pageToken?: string; /** - * Required. Resource name of the parent of sources to list. Its format should be "organizations/[organization_id]", "folders/[folder_id]", or "projects/[project_id]". + * Required. Resource name of the parent of sources to list. Its format should be `organizations/[organization_id]`, `folders/[folder_id]`, or `projects/[project_id]`. */ parent?: string; } @@ -19086,7 +19086,7 @@ export namespace securitycenter_v1 { */ findingId?: string; /** - * Required. Resource name of the new finding's parent. Its format should be "organizations/[organization_id]/sources/[source_id]". + * Required. Resource name of the new finding's parent. Its format should be `organizations/[organization_id]/sources/[source_id]`. */ parent?: string; @@ -19098,7 +19098,7 @@ export namespace securitycenter_v1 { export interface Params$Resource$Organizations$Sources$Findings$Group extends StandardParameters { /** - * Required. Name of the source to groupBy. Its format is "organizations/[organization_id]/sources/[source_id]", folders/[folder_id]/sources/[source_id], or projects/[project_id]/sources/[source_id]. To groupBy across all sources provide a source_id of `-`. For example: organizations/{organization_id\}/sources/-, folders/{folder_id\}/sources/-, or projects/{project_id\}/sources/- + * Required. Name of the source to groupBy. Its format is `organizations/[organization_id]/sources/[source_id]`, `folders/[folder_id]/sources/[source_id]`, or `projects/[project_id]/sources/[source_id]`. To groupBy across all sources provide a source_id of `-`. For example: `organizations/{organization_id\}/sources/-, folders/{folder_id\}/sources/-`, or `projects/{project_id\}/sources/-` */ parent?: string; @@ -19134,7 +19134,7 @@ export namespace securitycenter_v1 { */ pageToken?: string; /** - * Required. Name of the source the findings belong to. Its format is "organizations/[organization_id]/sources/[source_id], folders/[folder_id]/sources/[source_id], or projects/[project_id]/sources/[source_id]". To list across all sources provide a source_id of `-`. For example: organizations/{organization_id\}/sources/-, folders/{folder_id\}/sources/- or projects/{projects_id\}/sources/- + * Required. Name of the source the findings belong to. Its format is `organizations/[organization_id]/sources/[source_id]`, `folders/[folder_id]/sources/[source_id]`, or `projects/[project_id]/sources/[source_id]`. To list across all sources provide a source_id of `-`. For example: `organizations/{organization_id\}/sources/-`, `folders/{folder_id\}/sources/-` or `projects/{projects_id\}/sources/-` */ parent?: string; /** @@ -19161,7 +19161,7 @@ export namespace securitycenter_v1 { export interface Params$Resource$Organizations$Sources$Findings$Setmute extends StandardParameters { /** - * Required. The [relative resource name](https://cloud.google.com/apis/design/resource_names#relative_resource_name) of the finding. Example: "organizations/{organization_id\}/sources/{source_id\}/findings/{finding_id\}", "folders/{folder_id\}/sources/{source_id\}/findings/{finding_id\}", "projects/{project_id\}/sources/{source_id\}/findings/{finding_id\}". + * Required. The [relative resource name](https://cloud.google.com/apis/design/resource_names#relative_resource_name) of the finding. Example: `organizations/{organization_id\}/sources/{source_id\}/findings/{finding_id\}`, `folders/{folder_id\}/sources/{source_id\}/findings/{finding_id\}`, `projects/{project_id\}/sources/{source_id\}/findings/{finding_id\}`. */ name?: string; @@ -19173,7 +19173,7 @@ export namespace securitycenter_v1 { export interface Params$Resource$Organizations$Sources$Findings$Setstate extends StandardParameters { /** - * Required. The [relative resource name](https://cloud.google.com/apis/design/resource_names#relative_resource_name) of the finding. Example: "organizations/{organization_id\}/sources/{source_id\}/findings/{finding_id\}", "folders/{folder_id\}/sources/{source_id\}/findings/{finding_id\}", "projects/{project_id\}/sources/{source_id\}/findings/{finding_id\}". + * Required. The [relative resource name](https://cloud.google.com/apis/design/resource_names#relative_resource_name) of the finding. Example: `organizations/{organization_id\}/sources/{source_id\}/findings/{finding_id\}`, `folders/{folder_id\}/sources/{source_id\}/findings/{finding_id\}`, `projects/{project_id\}/sources/{source_id\}/findings/{finding_id\}`. */ name?: string; @@ -19636,7 +19636,7 @@ export namespace securitycenter_v1 { export interface Params$Resource$Projects$Assets$Group extends StandardParameters { /** - * Required. The name of the parent to group the assets by. Its format is "organizations/[organization_id]", "folders/[folder_id]", or "projects/[project_id]". + * Required. The name of the parent to group the assets by. Its format is `organizations/[organization_id]`, `folders/[folder_id]`, or `projects/[project_id]`. */ parent?: string; @@ -19672,7 +19672,7 @@ export namespace securitycenter_v1 { */ pageToken?: string; /** - * Required. The name of the parent resource that contains the assets. The value that you can specify on parent depends on the method in which you specify parent. You can specify one of the following values: "organizations/[organization_id]", "folders/[folder_id]", or "projects/[project_id]". + * Required. The name of the parent resource that contains the assets. The value that you can specify on parent depends on the method in which you specify parent. You can specify one of the following values: `organizations/[organization_id]`, `folders/[folder_id]`, or `projects/[project_id]`. */ parent?: string; /** @@ -20185,7 +20185,7 @@ export namespace securitycenter_v1 { */ bigQueryExportId?: string; /** - * Required. The name of the parent resource of the new BigQuery export. Its format is "organizations/[organization_id]", "folders/[folder_id]", or "projects/[project_id]". + * Required. The name of the parent resource of the new BigQuery export. Its format is `organizations/[organization_id]`, `folders/[folder_id]`, or `projects/[project_id]`. */ parent?: string; @@ -20197,14 +20197,14 @@ export namespace securitycenter_v1 { export interface Params$Resource$Projects$Bigqueryexports$Delete extends StandardParameters { /** - * Required. The name of the BigQuery export to delete. Its format is organizations/{organization\}/bigQueryExports/{export_id\}, folders/{folder\}/bigQueryExports/{export_id\}, or projects/{project\}/bigQueryExports/{export_id\} + * Required. The name of the BigQuery export to delete. Its format is `organizations/{organization\}/bigQueryExports/{export_id\}`, `folders/{folder\}/bigQueryExports/{export_id\}`, or `projects/{project\}/bigQueryExports/{export_id\}` */ name?: string; } export interface Params$Resource$Projects$Bigqueryexports$Get extends StandardParameters { /** - * Required. Name of the BigQuery export to retrieve. Its format is organizations/{organization\}/bigQueryExports/{export_id\}, folders/{folder\}/bigQueryExports/{export_id\}, or projects/{project\}/bigQueryExports/{export_id\} + * Required. Name of the BigQuery export to retrieve. Its format is `organizations/{organization\}/bigQueryExports/{export_id\}`, `folders/{folder\}/bigQueryExports/{export_id\}`, or `projects/{project\}/bigQueryExports/{export_id\}` */ name?: string; } @@ -20219,7 +20219,7 @@ export namespace securitycenter_v1 { */ pageToken?: string; /** - * Required. The parent, which owns the collection of BigQuery exports. Its format is "organizations/[organization_id]", "folders/[folder_id]", "projects/[project_id]". + * Required. The parent, which owns the collection of BigQuery exports. Its format is `organizations/[organization_id]`, `folders/[folder_id]`, `projects/[project_id]`. */ parent?: string; } @@ -20359,7 +20359,7 @@ export namespace securitycenter_v1 { export interface Params$Resource$Projects$Eventthreatdetectionsettings$Validatecustommodule extends StandardParameters { /** - * Required. Resource name of the parent to validate the Custom Module under. Its format is: * "organizations/{organization\}/eventThreatDetectionSettings". * "folders/{folder\}/eventThreatDetectionSettings". * "projects/{project\}/eventThreatDetectionSettings". + * Required. Resource name of the parent to validate the Custom Module under. Its format is: * `organizations/{organization\}/eventThreatDetectionSettings`. * `folders/{folder\}/eventThreatDetectionSettings`. * `projects/{project\}/eventThreatDetectionSettings`. */ parent?: string; @@ -20954,7 +20954,7 @@ export namespace securitycenter_v1 { export interface Params$Resource$Projects$Eventthreatdetectionsettings$Custommodules$Create extends StandardParameters { /** - * Required. The new custom module's parent. Its format is: * "organizations/{organization\}/eventThreatDetectionSettings". * "folders/{folder\}/eventThreatDetectionSettings". * "projects/{project\}/eventThreatDetectionSettings". + * Required. The new custom module's parent. Its format is: * `organizations/{organization\}/eventThreatDetectionSettings`. * `folders/{folder\}/eventThreatDetectionSettings`. * `projects/{project\}/eventThreatDetectionSettings`. */ parent?: string; @@ -20966,14 +20966,14 @@ export namespace securitycenter_v1 { export interface Params$Resource$Projects$Eventthreatdetectionsettings$Custommodules$Delete extends StandardParameters { /** - * Required. Name of the custom module to delete. Its format is: * "organizations/{organization\}/eventThreatDetectionSettings/customModules/{module\}". * "folders/{folder\}/eventThreatDetectionSettings/customModules/{module\}". * "projects/{project\}/eventThreatDetectionSettings/customModules/{module\}". + * Required. Name of the custom module to delete. Its format is: * `organizations/{organization\}/eventThreatDetectionSettings/customModules/{module\}`. * `folders/{folder\}/eventThreatDetectionSettings/customModules/{module\}`. * `projects/{project\}/eventThreatDetectionSettings/customModules/{module\}`. */ name?: string; } export interface Params$Resource$Projects$Eventthreatdetectionsettings$Custommodules$Get extends StandardParameters { /** - * Required. Name of the custom module to get. Its format is: * "organizations/{organization\}/eventThreatDetectionSettings/customModules/{module\}". * "folders/{folder\}/eventThreatDetectionSettings/customModules/{module\}". * "projects/{project\}/eventThreatDetectionSettings/customModules/{module\}". + * Required. Name of the custom module to get. Its format is: * `organizations/{organization\}/eventThreatDetectionSettings/customModules/{module\}`. * `folders/{folder\}/eventThreatDetectionSettings/customModules/{module\}`. * `projects/{project\}/eventThreatDetectionSettings/customModules/{module\}`. */ name?: string; } @@ -20988,7 +20988,7 @@ export namespace securitycenter_v1 { */ pageToken?: string; /** - * Required. Name of the parent to list custom modules under. Its format is: * "organizations/{organization\}/eventThreatDetectionSettings". * "folders/{folder\}/eventThreatDetectionSettings". * "projects/{project\}/eventThreatDetectionSettings". + * Required. Name of the parent to list custom modules under. Its format is: * `organizations/{organization\}/eventThreatDetectionSettings`. * `folders/{folder\}/eventThreatDetectionSettings`. * `projects/{project\}/eventThreatDetectionSettings`. */ parent?: string; } @@ -21003,14 +21003,14 @@ export namespace securitycenter_v1 { */ pageToken?: string; /** - * Required. Name of the parent to list custom modules under. Its format is: * "organizations/{organization\}/eventThreatDetectionSettings". * "folders/{folder\}/eventThreatDetectionSettings". * "projects/{project\}/eventThreatDetectionSettings". + * Required. Name of the parent to list custom modules under. Its format is: * `organizations/{organization\}/eventThreatDetectionSettings`. * `folders/{folder\}/eventThreatDetectionSettings`. * `projects/{project\}/eventThreatDetectionSettings`. */ parent?: string; } export interface Params$Resource$Projects$Eventthreatdetectionsettings$Custommodules$Patch extends StandardParameters { /** - * Immutable. The resource name of the Event Threat Detection custom module. Its format is: * "organizations/{organization\}/eventThreatDetectionSettings/customModules/{module\}". * "folders/{folder\}/eventThreatDetectionSettings/customModules/{module\}". * "projects/{project\}/eventThreatDetectionSettings/customModules/{module\}". + * Immutable. The resource name of the Event Threat Detection custom module. Its format is: * `organizations/{organization\}/eventThreatDetectionSettings/customModules/{module\}`. * `folders/{folder\}/eventThreatDetectionSettings/customModules/{module\}`. * `projects/{project\}/eventThreatDetectionSettings/customModules/{module\}`. */ name?: string; /** @@ -21229,7 +21229,7 @@ export namespace securitycenter_v1 { export interface Params$Resource$Projects$Eventthreatdetectionsettings$Effectivecustommodules$Get extends StandardParameters { /** - * Required. The resource name of the effective Event Threat Detection custom module. Its format is: * "organizations/{organization\}/eventThreatDetectionSettings/effectiveCustomModules/{module\}". * "folders/{folder\}/eventThreatDetectionSettings/effectiveCustomModules/{module\}". * "projects/{project\}/eventThreatDetectionSettings/effectiveCustomModules/{module\}". + * Required. The resource name of the effective Event Threat Detection custom module. Its format is: * `organizations/{organization\}/eventThreatDetectionSettings/effectiveCustomModules/{module\}`. * `folders/{folder\}/eventThreatDetectionSettings/effectiveCustomModules/{module\}`. * `projects/{project\}/eventThreatDetectionSettings/effectiveCustomModules/{module\}`. */ name?: string; } @@ -21244,7 +21244,7 @@ export namespace securitycenter_v1 { */ pageToken?: string; /** - * Required. Name of the parent to list custom modules for. Its format is: * "organizations/{organization\}/eventThreatDetectionSettings". * "folders/{folder\}/eventThreatDetectionSettings". * "projects/{project\}/eventThreatDetectionSettings". + * Required. Name of the parent to list custom modules for. Its format is: * `organizations/{organization\}/eventThreatDetectionSettings`. * `folders/{folder\}/eventThreatDetectionSettings`. * `projects/{project\}/eventThreatDetectionSettings`. */ parent?: string; } @@ -21348,7 +21348,7 @@ export namespace securitycenter_v1 { export interface Params$Resource$Projects$Findings$Bulkmute extends StandardParameters { /** - * Required. The parent, at which bulk action needs to be applied. Its format is "organizations/[organization_id]", "folders/[folder_id]", "projects/[project_id]". + * Required. The parent, at which bulk action needs to be applied. Its format is `organizations/[organization_id]`, `folders/[folder_id]`, `projects/[project_id]`. */ parent?: string; @@ -21848,7 +21848,7 @@ export namespace securitycenter_v1 { */ muteConfigId?: string; /** - * Required. Resource name of the new mute configs's parent. Its format is "organizations/[organization_id]", "folders/[folder_id]", or "projects/[project_id]". + * Required. Resource name of the new mute configs's parent. Its format is `organizations/[organization_id]`, `folders/[folder_id]`, or `projects/[project_id]`. */ parent?: string; @@ -21860,14 +21860,14 @@ export namespace securitycenter_v1 { export interface Params$Resource$Projects$Locations$Muteconfigs$Delete extends StandardParameters { /** - * Required. Name of the mute config to delete. Its format is organizations/{organization\}/muteConfigs/{config_id\}, folders/{folder\}/muteConfigs/{config_id\}, projects/{project\}/muteConfigs/{config_id\}, organizations/{organization\}/locations/global/muteConfigs/{config_id\}, folders/{folder\}/locations/global/muteConfigs/{config_id\}, or projects/{project\}/locations/global/muteConfigs/{config_id\}. + * Required. Name of the mute config to delete. Its format is `organizations/{organization\}/muteConfigs/{config_id\}`, `folders/{folder\}/muteConfigs/{config_id\}`, `projects/{project\}/muteConfigs/{config_id\}`, `organizations/{organization\}/locations/global/muteConfigs/{config_id\}`, `folders/{folder\}/locations/global/muteConfigs/{config_id\}`, or `projects/{project\}/locations/global/muteConfigs/{config_id\}`. */ name?: string; } export interface Params$Resource$Projects$Locations$Muteconfigs$Get extends StandardParameters { /** - * Required. Name of the mute config to retrieve. Its format is organizations/{organization\}/muteConfigs/{config_id\}, folders/{folder\}/muteConfigs/{config_id\}, projects/{project\}/muteConfigs/{config_id\}, organizations/{organization\}/locations/global/muteConfigs/{config_id\}, folders/{folder\}/locations/global/muteConfigs/{config_id\}, or projects/{project\}/locations/global/muteConfigs/{config_id\}. + * Required. Name of the mute config to retrieve. Its format is `organizations/{organization\}/muteConfigs/{config_id\}`, `folders/{folder\}/muteConfigs/{config_id\}`, `projects/{project\}/muteConfigs/{config_id\}`, `organizations/{organization\}/locations/global/muteConfigs/{config_id\}`, `folders/{folder\}/locations/global/muteConfigs/{config_id\}`, or `projects/{project\}/locations/global/muteConfigs/{config_id\}`. */ name?: string; } @@ -21882,14 +21882,14 @@ export namespace securitycenter_v1 { */ pageToken?: string; /** - * Required. The parent, which owns the collection of mute configs. Its format is "organizations/[organization_id]", "folders/[folder_id]", "projects/[project_id]". + * Required. The parent, which owns the collection of mute configs. Its format is `organizations/[organization_id]`, `folders/[folder_id]`, `projects/[project_id]`. */ parent?: string; } export interface Params$Resource$Projects$Locations$Muteconfigs$Patch extends StandardParameters { /** - * This field will be ignored if provided on config creation. Format "organizations/{organization\}/muteConfigs/{mute_config\}" "folders/{folder\}/muteConfigs/{mute_config\}" "projects/{project\}/muteConfigs/{mute_config\}" "organizations/{organization\}/locations/global/muteConfigs/{mute_config\}" "folders/{folder\}/locations/global/muteConfigs/{mute_config\}" "projects/{project\}/locations/global/muteConfigs/{mute_config\}" + * This field will be ignored if provided on config creation. Format `organizations/{organization\}/muteConfigs/{mute_config\}` `folders/{folder\}/muteConfigs/{mute_config\}` `projects/{project\}/muteConfigs/{mute_config\}` `organizations/{organization\}/locations/global/muteConfigs/{mute_config\}` `folders/{folder\}/locations/global/muteConfigs/{mute_config\}` `projects/{project\}/locations/global/muteConfigs/{mute_config\}` */ name?: string; /** @@ -22385,7 +22385,7 @@ export namespace securitycenter_v1 { */ muteConfigId?: string; /** - * Required. Resource name of the new mute configs's parent. Its format is "organizations/[organization_id]", "folders/[folder_id]", or "projects/[project_id]". + * Required. Resource name of the new mute configs's parent. Its format is `organizations/[organization_id]`, `folders/[folder_id]`, or `projects/[project_id]`. */ parent?: string; @@ -22397,14 +22397,14 @@ export namespace securitycenter_v1 { export interface Params$Resource$Projects$Muteconfigs$Delete extends StandardParameters { /** - * Required. Name of the mute config to delete. Its format is organizations/{organization\}/muteConfigs/{config_id\}, folders/{folder\}/muteConfigs/{config_id\}, projects/{project\}/muteConfigs/{config_id\}, organizations/{organization\}/locations/global/muteConfigs/{config_id\}, folders/{folder\}/locations/global/muteConfigs/{config_id\}, or projects/{project\}/locations/global/muteConfigs/{config_id\}. + * Required. Name of the mute config to delete. Its format is `organizations/{organization\}/muteConfigs/{config_id\}`, `folders/{folder\}/muteConfigs/{config_id\}`, `projects/{project\}/muteConfigs/{config_id\}`, `organizations/{organization\}/locations/global/muteConfigs/{config_id\}`, `folders/{folder\}/locations/global/muteConfigs/{config_id\}`, or `projects/{project\}/locations/global/muteConfigs/{config_id\}`. */ name?: string; } export interface Params$Resource$Projects$Muteconfigs$Get extends StandardParameters { /** - * Required. Name of the mute config to retrieve. Its format is organizations/{organization\}/muteConfigs/{config_id\}, folders/{folder\}/muteConfigs/{config_id\}, projects/{project\}/muteConfigs/{config_id\}, organizations/{organization\}/locations/global/muteConfigs/{config_id\}, folders/{folder\}/locations/global/muteConfigs/{config_id\}, or projects/{project\}/locations/global/muteConfigs/{config_id\}. + * Required. Name of the mute config to retrieve. Its format is `organizations/{organization\}/muteConfigs/{config_id\}`, `folders/{folder\}/muteConfigs/{config_id\}`, `projects/{project\}/muteConfigs/{config_id\}`, `organizations/{organization\}/locations/global/muteConfigs/{config_id\}`, `folders/{folder\}/locations/global/muteConfigs/{config_id\}`, or `projects/{project\}/locations/global/muteConfigs/{config_id\}`. */ name?: string; } @@ -22419,14 +22419,14 @@ export namespace securitycenter_v1 { */ pageToken?: string; /** - * Required. The parent, which owns the collection of mute configs. Its format is "organizations/[organization_id]", "folders/[folder_id]", "projects/[project_id]". + * Required. The parent, which owns the collection of mute configs. Its format is `organizations/[organization_id]`, `folders/[folder_id]`, `projects/[project_id]`. */ parent?: string; } export interface Params$Resource$Projects$Muteconfigs$Patch extends StandardParameters { /** - * This field will be ignored if provided on config creation. Format "organizations/{organization\}/muteConfigs/{mute_config\}" "folders/{folder\}/muteConfigs/{mute_config\}" "projects/{project\}/muteConfigs/{mute_config\}" "organizations/{organization\}/locations/global/muteConfigs/{mute_config\}" "folders/{folder\}/locations/global/muteConfigs/{mute_config\}" "projects/{project\}/locations/global/muteConfigs/{mute_config\}" + * This field will be ignored if provided on config creation. Format `organizations/{organization\}/muteConfigs/{mute_config\}` `folders/{folder\}/muteConfigs/{mute_config\}` `projects/{project\}/muteConfigs/{mute_config\}` `organizations/{organization\}/locations/global/muteConfigs/{mute_config\}` `folders/{folder\}/locations/global/muteConfigs/{mute_config\}` `projects/{project\}/locations/global/muteConfigs/{mute_config\}` */ name?: string; /** @@ -22908,7 +22908,7 @@ export namespace securitycenter_v1 { */ configId?: string; /** - * Required. Resource name of the new notification config's parent. Its format is "organizations/[organization_id]", "folders/[folder_id]", or "projects/[project_id]". + * Required. Resource name of the new notification config's parent. Its format is `organizations/[organization_id]`, `folders/[folder_id]`, or `projects/[project_id]`. */ parent?: string; @@ -22920,14 +22920,14 @@ export namespace securitycenter_v1 { export interface Params$Resource$Projects$Notificationconfigs$Delete extends StandardParameters { /** - * Required. Name of the notification config to delete. Its format is "organizations/[organization_id]/notificationConfigs/[config_id]", "folders/[folder_id]/notificationConfigs/[config_id]", or "projects/[project_id]/notificationConfigs/[config_id]". + * Required. Name of the notification config to delete. Its format is `organizations/[organization_id]/notificationConfigs/[config_id]`, `folders/[folder_id]/notificationConfigs/[config_id]`, or `projects/[project_id]/notificationConfigs/[config_id]`. */ name?: string; } export interface Params$Resource$Projects$Notificationconfigs$Get extends StandardParameters { /** - * Required. Name of the notification config to get. Its format is "organizations/[organization_id]/notificationConfigs/[config_id]", "folders/[folder_id]/notificationConfigs/[config_id]", or "projects/[project_id]/notificationConfigs/[config_id]". + * Required. Name of the notification config to get. Its format is `organizations/[organization_id]/notificationConfigs/[config_id]`, `folders/[folder_id]/notificationConfigs/[config_id]`, or `projects/[project_id]/notificationConfigs/[config_id]`. */ name?: string; } @@ -23664,7 +23664,7 @@ export namespace securitycenter_v1 { export interface Params$Resource$Projects$Securityhealthanalyticssettings$Custommodules$Create extends StandardParameters { /** - * Required. Resource name of the new custom module's parent. Its format is "organizations/{organization\}/securityHealthAnalyticsSettings", "folders/{folder\}/securityHealthAnalyticsSettings", or "projects/{project\}/securityHealthAnalyticsSettings" + * Required. Resource name of the new custom module's parent. Its format is `organizations/{organization\}/securityHealthAnalyticsSettings`, `folders/{folder\}/securityHealthAnalyticsSettings`, or `projects/{project\}/securityHealthAnalyticsSettings` */ parent?: string; @@ -23676,14 +23676,14 @@ export namespace securitycenter_v1 { export interface Params$Resource$Projects$Securityhealthanalyticssettings$Custommodules$Delete extends StandardParameters { /** - * Required. Name of the custom module to delete. Its format is "organizations/{organization\}/securityHealthAnalyticsSettings/customModules/{customModule\}", "folders/{folder\}/securityHealthAnalyticsSettings/customModules/{customModule\}", or "projects/{project\}/securityHealthAnalyticsSettings/customModules/{customModule\}" + * Required. Name of the custom module to delete. Its format is `organizations/{organization\}/securityHealthAnalyticsSettings/customModules/{customModule\}`, `folders/{folder\}/securityHealthAnalyticsSettings/customModules/{customModule\}`, or `projects/{project\}/securityHealthAnalyticsSettings/customModules/{customModule\}` */ name?: string; } export interface Params$Resource$Projects$Securityhealthanalyticssettings$Custommodules$Get extends StandardParameters { /** - * Required. Name of the custom module to get. Its format is "organizations/{organization\}/securityHealthAnalyticsSettings/customModules/{customModule\}", "folders/{folder\}/securityHealthAnalyticsSettings/customModules/{customModule\}", or "projects/{project\}/securityHealthAnalyticsSettings/customModules/{customModule\}" + * Required. Name of the custom module to get. Its format is `organizations/{organization\}/securityHealthAnalyticsSettings/customModules/{customModule\}`, `folders/{folder\}/securityHealthAnalyticsSettings/customModules/{customModule\}`, or `projects/{project\}/securityHealthAnalyticsSettings/customModules/{customModule\}` */ name?: string; } @@ -23698,7 +23698,7 @@ export namespace securitycenter_v1 { */ pageToken?: string; /** - * Required. Name of parent to list custom modules. Its format is "organizations/{organization\}/securityHealthAnalyticsSettings", "folders/{folder\}/securityHealthAnalyticsSettings", or "projects/{project\}/securityHealthAnalyticsSettings" + * Required. Name of parent to list custom modules. Its format is `organizations/{organization\}/securityHealthAnalyticsSettings`, `folders/{folder\}/securityHealthAnalyticsSettings`, or `projects/{project\}/securityHealthAnalyticsSettings` */ parent?: string; } @@ -23713,7 +23713,7 @@ export namespace securitycenter_v1 { */ pageToken?: string; /** - * Required. Name of parent to list descendant custom modules. Its format is "organizations/{organization\}/securityHealthAnalyticsSettings", "folders/{folder\}/securityHealthAnalyticsSettings", or "projects/{project\}/securityHealthAnalyticsSettings" + * Required. Name of parent to list descendant custom modules. Its format is `organizations/{organization\}/securityHealthAnalyticsSettings`, `folders/{folder\}/securityHealthAnalyticsSettings`, or `projects/{project\}/securityHealthAnalyticsSettings` */ parent?: string; } @@ -23951,7 +23951,7 @@ export namespace securitycenter_v1 { export interface Params$Resource$Projects$Securityhealthanalyticssettings$Effectivecustommodules$Get extends StandardParameters { /** - * Required. Name of the effective custom module to get. Its format is "organizations/{organization\}/securityHealthAnalyticsSettings/effectiveCustomModules/{customModule\}", "folders/{folder\}/securityHealthAnalyticsSettings/effectiveCustomModules/{customModule\}", or "projects/{project\}/securityHealthAnalyticsSettings/effectiveCustomModules/{customModule\}" + * Required. Name of the effective custom module to get. Its format is `organizations/{organization\}/securityHealthAnalyticsSettings/effectiveCustomModules/{customModule\}`, `folders/{folder\}/securityHealthAnalyticsSettings/effectiveCustomModules/{customModule\}`, or `projects/{project\}/securityHealthAnalyticsSettings/effectiveCustomModules/{customModule\}` */ name?: string; } @@ -23966,7 +23966,7 @@ export namespace securitycenter_v1 { */ pageToken?: string; /** - * Required. Name of parent to list effective custom modules. Its format is "organizations/{organization\}/securityHealthAnalyticsSettings", "folders/{folder\}/securityHealthAnalyticsSettings", or "projects/{project\}/securityHealthAnalyticsSettings" + * Required. Name of parent to list effective custom modules. Its format is `organizations/{organization\}/securityHealthAnalyticsSettings`, `folders/{folder\}/securityHealthAnalyticsSettings`, or `projects/{project\}/securityHealthAnalyticsSettings` */ parent?: string; } @@ -24083,7 +24083,7 @@ export namespace securitycenter_v1 { */ pageToken?: string; /** - * Required. Resource name of the parent of sources to list. Its format should be "organizations/[organization_id]", "folders/[folder_id]", or "projects/[project_id]". + * Required. Resource name of the parent of sources to list. Its format should be `organizations/[organization_id]`, `folders/[folder_id]`, or `projects/[project_id]`. */ parent?: string; } @@ -24642,7 +24642,7 @@ export namespace securitycenter_v1 { export interface Params$Resource$Projects$Sources$Findings$Group extends StandardParameters { /** - * Required. Name of the source to groupBy. Its format is "organizations/[organization_id]/sources/[source_id]", folders/[folder_id]/sources/[source_id], or projects/[project_id]/sources/[source_id]. To groupBy across all sources provide a source_id of `-`. For example: organizations/{organization_id\}/sources/-, folders/{folder_id\}/sources/-, or projects/{project_id\}/sources/- + * Required. Name of the source to groupBy. Its format is `organizations/[organization_id]/sources/[source_id]`, `folders/[folder_id]/sources/[source_id]`, or `projects/[project_id]/sources/[source_id]`. To groupBy across all sources provide a source_id of `-`. For example: `organizations/{organization_id\}/sources/-, folders/{folder_id\}/sources/-`, or `projects/{project_id\}/sources/-` */ parent?: string; @@ -24678,7 +24678,7 @@ export namespace securitycenter_v1 { */ pageToken?: string; /** - * Required. Name of the source the findings belong to. Its format is "organizations/[organization_id]/sources/[source_id], folders/[folder_id]/sources/[source_id], or projects/[project_id]/sources/[source_id]". To list across all sources provide a source_id of `-`. For example: organizations/{organization_id\}/sources/-, folders/{folder_id\}/sources/- or projects/{projects_id\}/sources/- + * Required. Name of the source the findings belong to. Its format is `organizations/[organization_id]/sources/[source_id]`, `folders/[folder_id]/sources/[source_id]`, or `projects/[project_id]/sources/[source_id]`. To list across all sources provide a source_id of `-`. For example: `organizations/{organization_id\}/sources/-`, `folders/{folder_id\}/sources/-` or `projects/{projects_id\}/sources/-` */ parent?: string; /** @@ -24705,7 +24705,7 @@ export namespace securitycenter_v1 { export interface Params$Resource$Projects$Sources$Findings$Setmute extends StandardParameters { /** - * Required. The [relative resource name](https://cloud.google.com/apis/design/resource_names#relative_resource_name) of the finding. Example: "organizations/{organization_id\}/sources/{source_id\}/findings/{finding_id\}", "folders/{folder_id\}/sources/{source_id\}/findings/{finding_id\}", "projects/{project_id\}/sources/{source_id\}/findings/{finding_id\}". + * Required. The [relative resource name](https://cloud.google.com/apis/design/resource_names#relative_resource_name) of the finding. Example: `organizations/{organization_id\}/sources/{source_id\}/findings/{finding_id\}`, `folders/{folder_id\}/sources/{source_id\}/findings/{finding_id\}`, `projects/{project_id\}/sources/{source_id\}/findings/{finding_id\}`. */ name?: string; @@ -24717,7 +24717,7 @@ export namespace securitycenter_v1 { export interface Params$Resource$Projects$Sources$Findings$Setstate extends StandardParameters { /** - * Required. The [relative resource name](https://cloud.google.com/apis/design/resource_names#relative_resource_name) of the finding. Example: "organizations/{organization_id\}/sources/{source_id\}/findings/{finding_id\}", "folders/{folder_id\}/sources/{source_id\}/findings/{finding_id\}", "projects/{project_id\}/sources/{source_id\}/findings/{finding_id\}". + * Required. The [relative resource name](https://cloud.google.com/apis/design/resource_names#relative_resource_name) of the finding. Example: `organizations/{organization_id\}/sources/{source_id\}/findings/{finding_id\}`, `folders/{folder_id\}/sources/{source_id\}/findings/{finding_id\}`, `projects/{project_id\}/sources/{source_id\}/findings/{finding_id\}`. */ name?: string; diff --git a/src/apis/securitycenter/v1beta1.ts b/src/apis/securitycenter/v1beta1.ts index d429da079c..5468578ed6 100644 --- a/src/apis/securitycenter/v1beta1.ts +++ b/src/apis/securitycenter/v1beta1.ts @@ -292,7 +292,7 @@ export namespace securitycenter_v1beta1 { */ export interface Schema$AttackExposure { /** - * The resource name of the attack path simulation result that contains the details regarding this attack exposure score. Example: organizations/123/simulations/456/attackExposureResults/789 + * The resource name of the attack path simulation result that contains the details regarding this attack exposure score. Example: `organizations/123/simulations/456/attackExposureResults/789` */ attackExposureResult?: string | null; /** @@ -407,7 +407,7 @@ export namespace securitycenter_v1beta1 { */ displayName?: string | null; /** - * The UUID of the Azure management group, for example, "20000000-0001-0000-0000-000000000000". + * The UUID of the Azure management group, for example, `20000000-0001-0000-0000-000000000000`. */ id?: string | null; } @@ -446,7 +446,7 @@ export namespace securitycenter_v1beta1 { */ displayName?: string | null; /** - * The UUID of the Azure subscription, for example, "291bba3f-e0a5-47bc-a099-3bdcb2a50a05". + * The UUID of the Azure subscription, for example, `291bba3f-e0a5-47bc-a099-3bdcb2a50a05`. */ id?: string | null; } @@ -1494,7 +1494,7 @@ export namespace securitycenter_v1beta1 { */ mostRecentEditor?: string | null; /** - * This field will be ignored if provided on config creation. Format "organizations/{organization\}/muteConfigs/{mute_config\}" "folders/{folder\}/muteConfigs/{mute_config\}" "projects/{project\}/muteConfigs/{mute_config\}" "organizations/{organization\}/locations/global/muteConfigs/{mute_config\}" "folders/{folder\}/locations/global/muteConfigs/{mute_config\}" "projects/{project\}/locations/global/muteConfigs/{mute_config\}" + * This field will be ignored if provided on config creation. Format `organizations/{organization\}/muteConfigs/{mute_config\}` `folders/{folder\}/muteConfigs/{mute_config\}` `projects/{project\}/muteConfigs/{mute_config\}` `organizations/{organization\}/locations/global/muteConfigs/{mute_config\}` `folders/{folder\}/locations/global/muteConfigs/{mute_config\}` `projects/{project\}/locations/global/muteConfigs/{mute_config\}` */ name?: string | null; /** @@ -1731,7 +1731,7 @@ export namespace securitycenter_v1beta1 { */ resourcePath?: Schema$ResourcePath; /** - * A string representation of the resource path. For Google Cloud, it has the format of organizations/{organization_id\}/folders/{folder_id\}/folders/{folder_id\}/projects/{project_id\} where there can be any number of folders. For AWS, it has the format of org/{organization_id\}/ou/{organizational_unit_id\}/ou/{organizational_unit_id\}/account/{account_id\} where there can be any number of organizational units. For Azure, it has the format of mg/{management_group_id\}/mg/{management_group_id\}/subscription/{subscription_id\}/rg/{resource_group_name\} where there can be any number of management groups. + * A string representation of the resource path. For Google Cloud, it has the format of `organizations/{organization_id\}/folders/{folder_id\}/folders/{folder_id\}/projects/{project_id\}` where there can be any number of folders. For AWS, it has the format of `org/{organization_id\}/ou/{organizational_unit_id\}/ou/{organizational_unit_id\}/account/{account_id\}` where there can be any number of organizational units. For Azure, it has the format of `mg/{management_group_id\}/mg/{management_group_id\}/subscription/{subscription_id\}/rg/{resource_group_name\}` where there can be any number of management groups. */ resourcePathString?: string | null; /** @@ -1773,11 +1773,11 @@ export namespace securitycenter_v1beta1 { */ name?: string | null; /** - * List of resource labels to search for, evaluated with AND. For example, "resource_labels_selector": {"key": "value", "env": "prod"\} will match resources with labels "key": "value" AND "env": "prod" https://cloud.google.com/resource-manager/docs/creating-managing-labels + * List of resource labels to search for, evaluated with `AND`. For example, `"resource_labels_selector": {"key": "value", "env": "prod"\}` will match resources with labels "key": "value" `AND` "env": "prod" https://cloud.google.com/resource-manager/docs/creating-managing-labels */ resourceLabelsSelector?: {[key: string]: string} | null; /** - * Apply resource_value only to resources that match resource_type. resource_type will be checked with AND of other resources. For example, "storage.googleapis.com/Bucket" with resource_value "HIGH" will apply "HIGH" value only to "storage.googleapis.com/Bucket" resources. + * Apply resource_value only to resources that match resource_type. resource_type will be checked with `AND` of other resources. For example, "storage.googleapis.com/Bucket" with resource_value "HIGH" will apply "HIGH" value only to "storage.googleapis.com/Bucket" resources. */ resourceType?: string | null; /** @@ -1785,7 +1785,7 @@ export namespace securitycenter_v1beta1 { */ resourceValue?: string | null; /** - * Project or folder to scope this configuration to. For example, "project/456" would apply this configuration only to resources in "project/456" scope will be checked with AND of other resources. + * Project or folder to scope this configuration to. For example, "project/456" would apply this configuration only to resources in "project/456" scope will be checked with `AND` of other resources. */ scope?: string | null; /** @@ -1793,7 +1793,7 @@ export namespace securitycenter_v1beta1 { */ sensitiveDataProtectionMapping?: Schema$GoogleCloudSecuritycenterV1SensitiveDataProtectionMapping; /** - * Required. Tag values combined with AND to check against. Values in the form "tagValues/123" Example: [ "tagValues/123", "tagValues/456", "tagValues/789" ] https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing + * Required. Tag values combined with `AND` to check against. Values in the form "tagValues/123" Example: `[ "tagValues/123", "tagValues/456", "tagValues/789" ]` https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing */ tagValues?: string[] | null; /** @@ -1986,7 +1986,7 @@ export namespace securitycenter_v1beta1 { */ export interface Schema$GoogleCloudSecuritycenterV2AttackExposure { /** - * The resource name of the attack path simulation result that contains the details regarding this attack exposure score. Example: organizations/123/simulations/456/attackExposureResults/789 + * The resource name of the attack path simulation result that contains the details regarding this attack exposure score. Example: `organizations/123/simulations/456/attackExposureResults/789` */ attackExposureResult?: string | null; /** @@ -2075,7 +2075,7 @@ export namespace securitycenter_v1beta1 { */ displayName?: string | null; /** - * The UUID of the Azure management group, for example, "20000000-0001-0000-0000-000000000000". + * The UUID of the Azure management group, for example, `20000000-0001-0000-0000-000000000000`. */ id?: string | null; } @@ -2114,7 +2114,7 @@ export namespace securitycenter_v1beta1 { */ displayName?: string | null; /** - * The UUID of the Azure subscription, for example, "291bba3f-e0a5-47bc-a099-3bdcb2a50a05". + * The UUID of the Azure subscription, for example, `291bba3f-e0a5-47bc-a099-3bdcb2a50a05`. */ id?: string | null; } @@ -2172,7 +2172,7 @@ export namespace securitycenter_v1beta1 { */ createTime?: string | null; /** - * The dataset to write findings' updates to. Its format is "projects/[project_id]/datasets/[bigquery_dataset_id]". BigQuery Dataset unique ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). + * The dataset to write findings' updates to. Its format is "projects/[project_id]/datasets/[bigquery_dataset_id]". BigQuery dataset unique ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). */ dataset?: string | null; /** @@ -2188,7 +2188,7 @@ export namespace securitycenter_v1beta1 { */ mostRecentEditor?: string | null; /** - * The relative resource name of this export. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name. The following list shows some examples: + `organizations/{organization_id\}/locations/{location_id\}/bigQueryExports/{export_id\}` + `folders/{folder_id\}/locations/{location_id\}/bigQueryExports/{export_id\}` + `projects/{project_id\}/locations/{location_id\}/bigQueryExports/{export_id\}` This field is provided in responses, and is ignored when provided in create requests. + * Identifier. The relative resource name of this export. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name. The following list shows some examples: + `organizations/{organization_id\}/locations/{location_id\}/bigQueryExports/{export_id\}` + `folders/{folder_id\}/locations/{location_id\}/bigQueryExports/{export_id\}` + `projects/{project_id\}/locations/{location_id\}/bigQueryExports/{export_id\}` This field is provided in responses, and is ignored when provided in create requests. */ name?: string | null; /** @@ -3094,7 +3094,7 @@ export namespace securitycenter_v1beta1 { */ mostRecentEditor?: string | null; /** - * This field will be ignored if provided on config creation. The following list shows some examples of the format: + `organizations/{organization\}/muteConfigs/{mute_config\}` + `organizations/{organization\}locations/{location\}//muteConfigs/{mute_config\}` + `folders/{folder\}/muteConfigs/{mute_config\}` + `folders/{folder\}/locations/{location\}/muteConfigs/{mute_config\}` + `projects/{project\}/muteConfigs/{mute_config\}` + `projects/{project\}/locations/{location\}/muteConfigs/{mute_config\}` + * Identifier. This field will be ignored if provided on config creation. The following list shows some examples of the format: + `organizations/{organization\}/muteConfigs/{mute_config\}` + `organizations/{organization\}locations/{location\}//muteConfigs/{mute_config\}` + `folders/{folder\}/muteConfigs/{mute_config\}` + `folders/{folder\}/locations/{location\}/muteConfigs/{mute_config\}` + `projects/{project\}/muteConfigs/{mute_config\}` + `projects/{project\}/locations/{location\}/muteConfigs/{mute_config\}` */ name?: string | null; /** @@ -3392,7 +3392,7 @@ export namespace securitycenter_v1beta1 { */ resourcePath?: Schema$GoogleCloudSecuritycenterV2ResourcePath; /** - * A string representation of the resource path. For Google Cloud, it has the format of organizations/{organization_id\}/folders/{folder_id\}/folders/{folder_id\}/projects/{project_id\} where there can be any number of folders. For AWS, it has the format of org/{organization_id\}/ou/{organizational_unit_id\}/ou/{organizational_unit_id\}/account/{account_id\} where there can be any number of organizational units. For Azure, it has the format of mg/{management_group_id\}/mg/{management_group_id\}/subscription/{subscription_id\}/rg/{resource_group_name\} where there can be any number of management groups. + * A string representation of the resource path. For Google Cloud, it has the format of `organizations/{organization_id\}/folders/{folder_id\}/folders/{folder_id\}/projects/{project_id\}` where there can be any number of folders. For AWS, it has the format of `org/{organization_id\}/ou/{organizational_unit_id\}/ou/{organizational_unit_id\}/account/{account_id\}` where there can be any number of organizational units. For Azure, it has the format of `mg/{management_group_id\}/mg/{management_group_id\}/subscription/{subscription_id\}/rg/{resource_group_name\}` where there can be any number of management groups. */ resourcePathString?: string | null; /** @@ -3447,23 +3447,23 @@ export namespace securitycenter_v1beta1 { */ description?: string | null; /** - * Name for the resource value configuration + * Identifier. Name for the resource value configuration */ name?: string | null; /** - * List of resource labels to search for, evaluated with AND. For example, "resource_labels_selector": {"key": "value", "env": "prod"\} will match resources with labels "key": "value" AND "env": "prod" https://cloud.google.com/resource-manager/docs/creating-managing-labels + * List of resource labels to search for, evaluated with `AND`. For example, "resource_labels_selector": {"key": "value", "env": "prod"\} will match resources with labels "key": "value" `AND` "env": "prod" https://cloud.google.com/resource-manager/docs/creating-managing-labels */ resourceLabelsSelector?: {[key: string]: string} | null; /** - * Apply resource_value only to resources that match resource_type. resource_type will be checked with AND of other resources. For example, "storage.googleapis.com/Bucket" with resource_value "HIGH" will apply "HIGH" value only to "storage.googleapis.com/Bucket" resources. + * Apply resource_value only to resources that match resource_type. resource_type will be checked with `AND` of other resources. For example, "storage.googleapis.com/Bucket" with resource_value "HIGH" will apply "HIGH" value only to "storage.googleapis.com/Bucket" resources. */ resourceType?: string | null; /** - * Resource value level this expression represents Only required when there is no SDP mapping in the request + * Resource value level this expression represents Only required when there is no Sensitive Data Protection mapping in the request */ resourceValue?: string | null; /** - * Project or folder to scope this configuration to. For example, "project/456" would apply this configuration only to resources in "project/456" scope will be checked with AND of other resources. + * Project or folder to scope this configuration to. For example, "project/456" would apply this configuration only to resources in "project/456" scope and will be checked with `AND` of other resources. */ scope?: string | null; /** @@ -3471,7 +3471,7 @@ export namespace securitycenter_v1beta1 { */ sensitiveDataProtectionMapping?: Schema$GoogleCloudSecuritycenterV2SensitiveDataProtectionMapping; /** - * Required. Tag values combined with AND to check against. Values in the form "tagValues/123" Example: [ "tagValues/123", "tagValues/456", "tagValues/789" ] https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing + * Tag values combined with `AND` to check against. Values in the form "tagValues/123" Example: `[ "tagValues/123", "tagValues/456", "tagValues/789" ]` https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing */ tagValues?: string[] | null; /** @@ -3665,7 +3665,7 @@ export namespace securitycenter_v1beta1 { */ attackExposureScore?: number | null; /** - * List of resource names of findings associated with this toxic combination. For example, organizations/123/sources/456/findings/789. + * List of resource names of findings associated with this toxic combination. For example, `organizations/123/sources/456/findings/789`. */ relatedFindings?: string[] | null; } @@ -4676,7 +4676,7 @@ export namespace securitycenter_v1beta1 { */ attackExposureScore?: number | null; /** - * List of resource names of findings associated with this toxic combination. For example, organizations/123/sources/456/findings/789. + * List of resource names of findings associated with this toxic combination. For example, `organizations/123/sources/456/findings/789`. */ relatedFindings?: string[] | null; } diff --git a/src/apis/securitycenter/v1beta2.ts b/src/apis/securitycenter/v1beta2.ts index 0912c27e6a..eea088e7c5 100644 --- a/src/apis/securitycenter/v1beta2.ts +++ b/src/apis/securitycenter/v1beta2.ts @@ -254,7 +254,7 @@ export namespace securitycenter_v1beta2 { */ export interface Schema$AttackExposure { /** - * The resource name of the attack path simulation result that contains the details regarding this attack exposure score. Example: organizations/123/simulations/456/attackExposureResults/789 + * The resource name of the attack path simulation result that contains the details regarding this attack exposure score. Example: `organizations/123/simulations/456/attackExposureResults/789` */ attackExposureResult?: string | null; /** @@ -343,7 +343,7 @@ export namespace securitycenter_v1beta2 { */ displayName?: string | null; /** - * The UUID of the Azure management group, for example, "20000000-0001-0000-0000-000000000000". + * The UUID of the Azure management group, for example, `20000000-0001-0000-0000-000000000000`. */ id?: string | null; } @@ -382,7 +382,7 @@ export namespace securitycenter_v1beta2 { */ displayName?: string | null; /** - * The UUID of the Azure subscription, for example, "291bba3f-e0a5-47bc-a099-3bdcb2a50a05". + * The UUID of the Azure subscription, for example, `291bba3f-e0a5-47bc-a099-3bdcb2a50a05`. */ id?: string | null; } @@ -655,11 +655,11 @@ export namespace securitycenter_v1beta2 { */ export interface Schema$ContainerThreatDetectionSettings { /** - * The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's. + * The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration. */ modules?: {[key: string]: Schema$Config} | null; /** - * The resource name of the ContainerThreatDetectionSettings. Formats: * organizations/{organization\}/containerThreatDetectionSettings * folders/{folder\}/containerThreatDetectionSettings * projects/{project\}/containerThreatDetectionSettings * projects/{project\}/locations/{location\}/clusters/{cluster\}/containerThreatDetectionSettings + * Identifier. The resource name of the ContainerThreatDetectionSettings. Formats: * organizations/{organization\}/containerThreatDetectionSettings * folders/{folder\}/containerThreatDetectionSettings * projects/{project\}/containerThreatDetectionSettings * projects/{project\}/locations/{location\}/clusters/{cluster\}/containerThreatDetectionSettings */ name?: string | null; /** @@ -843,11 +843,11 @@ export namespace securitycenter_v1beta2 { */ export interface Schema$EventThreatDetectionSettings { /** - * The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's. + * The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration. */ modules?: {[key: string]: Schema$Config} | null; /** - * The resource name of the EventThreatDetectionSettings. Formats: * organizations/{organization\}/eventThreatDetectionSettings * folders/{folder\}/eventThreatDetectionSettings * projects/{project\}/eventThreatDetectionSettings + * Identifier. The resource name of the EventThreatDetectionSettings. Formats: * organizations/{organization\}/eventThreatDetectionSettings * folders/{folder\}/eventThreatDetectionSettings * projects/{project\}/eventThreatDetectionSettings */ name?: string | null; /** @@ -1405,7 +1405,7 @@ export namespace securitycenter_v1beta2 { */ mostRecentEditor?: string | null; /** - * This field will be ignored if provided on config creation. Format "organizations/{organization\}/muteConfigs/{mute_config\}" "folders/{folder\}/muteConfigs/{mute_config\}" "projects/{project\}/muteConfigs/{mute_config\}" "organizations/{organization\}/locations/global/muteConfigs/{mute_config\}" "folders/{folder\}/locations/global/muteConfigs/{mute_config\}" "projects/{project\}/locations/global/muteConfigs/{mute_config\}" + * This field will be ignored if provided on config creation. Format `organizations/{organization\}/muteConfigs/{mute_config\}` `folders/{folder\}/muteConfigs/{mute_config\}` `projects/{project\}/muteConfigs/{mute_config\}` `organizations/{organization\}/locations/global/muteConfigs/{mute_config\}` `folders/{folder\}/locations/global/muteConfigs/{mute_config\}` `projects/{project\}/locations/global/muteConfigs/{mute_config\}` */ name?: string | null; /** @@ -1642,7 +1642,7 @@ export namespace securitycenter_v1beta2 { */ resourcePath?: Schema$ResourcePath; /** - * A string representation of the resource path. For Google Cloud, it has the format of organizations/{organization_id\}/folders/{folder_id\}/folders/{folder_id\}/projects/{project_id\} where there can be any number of folders. For AWS, it has the format of org/{organization_id\}/ou/{organizational_unit_id\}/ou/{organizational_unit_id\}/account/{account_id\} where there can be any number of organizational units. For Azure, it has the format of mg/{management_group_id\}/mg/{management_group_id\}/subscription/{subscription_id\}/rg/{resource_group_name\} where there can be any number of management groups. + * A string representation of the resource path. For Google Cloud, it has the format of `organizations/{organization_id\}/folders/{folder_id\}/folders/{folder_id\}/projects/{project_id\}` where there can be any number of folders. For AWS, it has the format of `org/{organization_id\}/ou/{organizational_unit_id\}/ou/{organizational_unit_id\}/account/{account_id\}` where there can be any number of organizational units. For Azure, it has the format of `mg/{management_group_id\}/mg/{management_group_id\}/subscription/{subscription_id\}/rg/{resource_group_name\}` where there can be any number of management groups. */ resourcePathString?: string | null; /** @@ -1684,11 +1684,11 @@ export namespace securitycenter_v1beta2 { */ name?: string | null; /** - * List of resource labels to search for, evaluated with AND. For example, "resource_labels_selector": {"key": "value", "env": "prod"\} will match resources with labels "key": "value" AND "env": "prod" https://cloud.google.com/resource-manager/docs/creating-managing-labels + * List of resource labels to search for, evaluated with `AND`. For example, `"resource_labels_selector": {"key": "value", "env": "prod"\}` will match resources with labels "key": "value" `AND` "env": "prod" https://cloud.google.com/resource-manager/docs/creating-managing-labels */ resourceLabelsSelector?: {[key: string]: string} | null; /** - * Apply resource_value only to resources that match resource_type. resource_type will be checked with AND of other resources. For example, "storage.googleapis.com/Bucket" with resource_value "HIGH" will apply "HIGH" value only to "storage.googleapis.com/Bucket" resources. + * Apply resource_value only to resources that match resource_type. resource_type will be checked with `AND` of other resources. For example, "storage.googleapis.com/Bucket" with resource_value "HIGH" will apply "HIGH" value only to "storage.googleapis.com/Bucket" resources. */ resourceType?: string | null; /** @@ -1696,7 +1696,7 @@ export namespace securitycenter_v1beta2 { */ resourceValue?: string | null; /** - * Project or folder to scope this configuration to. For example, "project/456" would apply this configuration only to resources in "project/456" scope will be checked with AND of other resources. + * Project or folder to scope this configuration to. For example, "project/456" would apply this configuration only to resources in "project/456" scope will be checked with `AND` of other resources. */ scope?: string | null; /** @@ -1704,7 +1704,7 @@ export namespace securitycenter_v1beta2 { */ sensitiveDataProtectionMapping?: Schema$GoogleCloudSecuritycenterV1SensitiveDataProtectionMapping; /** - * Required. Tag values combined with AND to check against. Values in the form "tagValues/123" Example: [ "tagValues/123", "tagValues/456", "tagValues/789" ] https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing + * Required. Tag values combined with `AND` to check against. Values in the form "tagValues/123" Example: `[ "tagValues/123", "tagValues/456", "tagValues/789" ]` https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing */ tagValues?: string[] | null; /** @@ -1897,7 +1897,7 @@ export namespace securitycenter_v1beta2 { */ export interface Schema$GoogleCloudSecuritycenterV2AttackExposure { /** - * The resource name of the attack path simulation result that contains the details regarding this attack exposure score. Example: organizations/123/simulations/456/attackExposureResults/789 + * The resource name of the attack path simulation result that contains the details regarding this attack exposure score. Example: `organizations/123/simulations/456/attackExposureResults/789` */ attackExposureResult?: string | null; /** @@ -1986,7 +1986,7 @@ export namespace securitycenter_v1beta2 { */ displayName?: string | null; /** - * The UUID of the Azure management group, for example, "20000000-0001-0000-0000-000000000000". + * The UUID of the Azure management group, for example, `20000000-0001-0000-0000-000000000000`. */ id?: string | null; } @@ -2025,7 +2025,7 @@ export namespace securitycenter_v1beta2 { */ displayName?: string | null; /** - * The UUID of the Azure subscription, for example, "291bba3f-e0a5-47bc-a099-3bdcb2a50a05". + * The UUID of the Azure subscription, for example, `291bba3f-e0a5-47bc-a099-3bdcb2a50a05`. */ id?: string | null; } @@ -2083,7 +2083,7 @@ export namespace securitycenter_v1beta2 { */ createTime?: string | null; /** - * The dataset to write findings' updates to. Its format is "projects/[project_id]/datasets/[bigquery_dataset_id]". BigQuery Dataset unique ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). + * The dataset to write findings' updates to. Its format is "projects/[project_id]/datasets/[bigquery_dataset_id]". BigQuery dataset unique ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). */ dataset?: string | null; /** @@ -2099,7 +2099,7 @@ export namespace securitycenter_v1beta2 { */ mostRecentEditor?: string | null; /** - * The relative resource name of this export. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name. The following list shows some examples: + `organizations/{organization_id\}/locations/{location_id\}/bigQueryExports/{export_id\}` + `folders/{folder_id\}/locations/{location_id\}/bigQueryExports/{export_id\}` + `projects/{project_id\}/locations/{location_id\}/bigQueryExports/{export_id\}` This field is provided in responses, and is ignored when provided in create requests. + * Identifier. The relative resource name of this export. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name. The following list shows some examples: + `organizations/{organization_id\}/locations/{location_id\}/bigQueryExports/{export_id\}` + `folders/{folder_id\}/locations/{location_id\}/bigQueryExports/{export_id\}` + `projects/{project_id\}/locations/{location_id\}/bigQueryExports/{export_id\}` This field is provided in responses, and is ignored when provided in create requests. */ name?: string | null; /** @@ -3005,7 +3005,7 @@ export namespace securitycenter_v1beta2 { */ mostRecentEditor?: string | null; /** - * This field will be ignored if provided on config creation. The following list shows some examples of the format: + `organizations/{organization\}/muteConfigs/{mute_config\}` + `organizations/{organization\}locations/{location\}//muteConfigs/{mute_config\}` + `folders/{folder\}/muteConfigs/{mute_config\}` + `folders/{folder\}/locations/{location\}/muteConfigs/{mute_config\}` + `projects/{project\}/muteConfigs/{mute_config\}` + `projects/{project\}/locations/{location\}/muteConfigs/{mute_config\}` + * Identifier. This field will be ignored if provided on config creation. The following list shows some examples of the format: + `organizations/{organization\}/muteConfigs/{mute_config\}` + `organizations/{organization\}locations/{location\}//muteConfigs/{mute_config\}` + `folders/{folder\}/muteConfigs/{mute_config\}` + `folders/{folder\}/locations/{location\}/muteConfigs/{mute_config\}` + `projects/{project\}/muteConfigs/{mute_config\}` + `projects/{project\}/locations/{location\}/muteConfigs/{mute_config\}` */ name?: string | null; /** @@ -3303,7 +3303,7 @@ export namespace securitycenter_v1beta2 { */ resourcePath?: Schema$GoogleCloudSecuritycenterV2ResourcePath; /** - * A string representation of the resource path. For Google Cloud, it has the format of organizations/{organization_id\}/folders/{folder_id\}/folders/{folder_id\}/projects/{project_id\} where there can be any number of folders. For AWS, it has the format of org/{organization_id\}/ou/{organizational_unit_id\}/ou/{organizational_unit_id\}/account/{account_id\} where there can be any number of organizational units. For Azure, it has the format of mg/{management_group_id\}/mg/{management_group_id\}/subscription/{subscription_id\}/rg/{resource_group_name\} where there can be any number of management groups. + * A string representation of the resource path. For Google Cloud, it has the format of `organizations/{organization_id\}/folders/{folder_id\}/folders/{folder_id\}/projects/{project_id\}` where there can be any number of folders. For AWS, it has the format of `org/{organization_id\}/ou/{organizational_unit_id\}/ou/{organizational_unit_id\}/account/{account_id\}` where there can be any number of organizational units. For Azure, it has the format of `mg/{management_group_id\}/mg/{management_group_id\}/subscription/{subscription_id\}/rg/{resource_group_name\}` where there can be any number of management groups. */ resourcePathString?: string | null; /** @@ -3358,23 +3358,23 @@ export namespace securitycenter_v1beta2 { */ description?: string | null; /** - * Name for the resource value configuration + * Identifier. Name for the resource value configuration */ name?: string | null; /** - * List of resource labels to search for, evaluated with AND. For example, "resource_labels_selector": {"key": "value", "env": "prod"\} will match resources with labels "key": "value" AND "env": "prod" https://cloud.google.com/resource-manager/docs/creating-managing-labels + * List of resource labels to search for, evaluated with `AND`. For example, "resource_labels_selector": {"key": "value", "env": "prod"\} will match resources with labels "key": "value" `AND` "env": "prod" https://cloud.google.com/resource-manager/docs/creating-managing-labels */ resourceLabelsSelector?: {[key: string]: string} | null; /** - * Apply resource_value only to resources that match resource_type. resource_type will be checked with AND of other resources. For example, "storage.googleapis.com/Bucket" with resource_value "HIGH" will apply "HIGH" value only to "storage.googleapis.com/Bucket" resources. + * Apply resource_value only to resources that match resource_type. resource_type will be checked with `AND` of other resources. For example, "storage.googleapis.com/Bucket" with resource_value "HIGH" will apply "HIGH" value only to "storage.googleapis.com/Bucket" resources. */ resourceType?: string | null; /** - * Resource value level this expression represents Only required when there is no SDP mapping in the request + * Resource value level this expression represents Only required when there is no Sensitive Data Protection mapping in the request */ resourceValue?: string | null; /** - * Project or folder to scope this configuration to. For example, "project/456" would apply this configuration only to resources in "project/456" scope will be checked with AND of other resources. + * Project or folder to scope this configuration to. For example, "project/456" would apply this configuration only to resources in "project/456" scope and will be checked with `AND` of other resources. */ scope?: string | null; /** @@ -3382,7 +3382,7 @@ export namespace securitycenter_v1beta2 { */ sensitiveDataProtectionMapping?: Schema$GoogleCloudSecuritycenterV2SensitiveDataProtectionMapping; /** - * Required. Tag values combined with AND to check against. Values in the form "tagValues/123" Example: [ "tagValues/123", "tagValues/456", "tagValues/789" ] https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing + * Tag values combined with `AND` to check against. Values in the form "tagValues/123" Example: `[ "tagValues/123", "tagValues/456", "tagValues/789" ]` https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing */ tagValues?: string[] | null; /** @@ -3576,7 +3576,7 @@ export namespace securitycenter_v1beta2 { */ attackExposureScore?: number | null; /** - * List of resource names of findings associated with this toxic combination. For example, organizations/123/sources/456/findings/789. + * List of resource names of findings associated with this toxic combination. For example, `organizations/123/sources/456/findings/789`. */ relatedFindings?: string[] | null; } @@ -4143,11 +4143,11 @@ export namespace securitycenter_v1beta2 { */ export interface Schema$SecurityHealthAnalyticsSettings { /** - * The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's. + * The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration. */ modules?: {[key: string]: Schema$Config} | null; /** - * The resource name of the SecurityHealthAnalyticsSettings. Formats: * organizations/{organization\}/securityHealthAnalyticsSettings * folders/{folder\}/securityHealthAnalyticsSettings * projects/{project\}/securityHealthAnalyticsSettings + * Identifier. The resource name of the SecurityHealthAnalyticsSettings. Formats: * organizations/{organization\}/securityHealthAnalyticsSettings * folders/{folder\}/securityHealthAnalyticsSettings * projects/{project\}/securityHealthAnalyticsSettings */ name?: string | null; /** @@ -4319,7 +4319,7 @@ export namespace securitycenter_v1beta2 { */ attackExposureScore?: number | null; /** - * List of resource names of findings associated with this toxic combination. For example, organizations/123/sources/456/findings/789. + * List of resource names of findings associated with this toxic combination. For example, `organizations/123/sources/456/findings/789`. */ relatedFindings?: string[] | null; } @@ -4328,11 +4328,11 @@ export namespace securitycenter_v1beta2 { */ export interface Schema$VirtualMachineThreatDetectionSettings { /** - * The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's. + * The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration. */ modules?: {[key: string]: Schema$Config} | null; /** - * The resource name of the VirtualMachineThreatDetectionSettings. Formats: * organizations/{organization\}/virtualMachineThreatDetectionSettings * folders/{folder\}/virtualMachineThreatDetectionSettings * projects/{project\}/virtualMachineThreatDetectionSettings + * Identifier. The resource name of the VirtualMachineThreatDetectionSettings. Formats: * organizations/{organization\}/virtualMachineThreatDetectionSettings * folders/{folder\}/virtualMachineThreatDetectionSettings * projects/{project\}/virtualMachineThreatDetectionSettings */ name?: string | null; /** @@ -4404,11 +4404,11 @@ export namespace securitycenter_v1beta2 { */ export interface Schema$WebSecurityScannerSettings { /** - * The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's. + * The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration. */ modules?: {[key: string]: Schema$Config} | null; /** - * The resource name of the WebSecurityScannerSettings. Formats: * organizations/{organization\}/webSecurityScannerSettings * folders/{folder\}/webSecurityScannerSettings * projects/{project\}/webSecurityScannerSettings + * Identifier. The resource name of the WebSecurityScannerSettings. Formats: * organizations/{organization\}/webSecurityScannerSettings * folders/{folder\}/webSecurityScannerSettings * projects/{project\}/webSecurityScannerSettings */ name?: string | null; /** @@ -5747,7 +5747,7 @@ export namespace securitycenter_v1beta2 { export interface Params$Resource$Folders$Updatecontainerthreatdetectionsettings extends StandardParameters { /** - * The resource name of the ContainerThreatDetectionSettings. Formats: * organizations/{organization\}/containerThreatDetectionSettings * folders/{folder\}/containerThreatDetectionSettings * projects/{project\}/containerThreatDetectionSettings * projects/{project\}/locations/{location\}/clusters/{cluster\}/containerThreatDetectionSettings + * Identifier. The resource name of the ContainerThreatDetectionSettings. Formats: * organizations/{organization\}/containerThreatDetectionSettings * folders/{folder\}/containerThreatDetectionSettings * projects/{project\}/containerThreatDetectionSettings * projects/{project\}/locations/{location\}/clusters/{cluster\}/containerThreatDetectionSettings */ name?: string; /** @@ -5763,7 +5763,7 @@ export namespace securitycenter_v1beta2 { export interface Params$Resource$Folders$Updateeventthreatdetectionsettings extends StandardParameters { /** - * The resource name of the EventThreatDetectionSettings. Formats: * organizations/{organization\}/eventThreatDetectionSettings * folders/{folder\}/eventThreatDetectionSettings * projects/{project\}/eventThreatDetectionSettings + * Identifier. The resource name of the EventThreatDetectionSettings. Formats: * organizations/{organization\}/eventThreatDetectionSettings * folders/{folder\}/eventThreatDetectionSettings * projects/{project\}/eventThreatDetectionSettings */ name?: string; /** @@ -5795,7 +5795,7 @@ export namespace securitycenter_v1beta2 { export interface Params$Resource$Folders$Updatesecurityhealthanalyticssettings extends StandardParameters { /** - * The resource name of the SecurityHealthAnalyticsSettings. Formats: * organizations/{organization\}/securityHealthAnalyticsSettings * folders/{folder\}/securityHealthAnalyticsSettings * projects/{project\}/securityHealthAnalyticsSettings + * Identifier. The resource name of the SecurityHealthAnalyticsSettings. Formats: * organizations/{organization\}/securityHealthAnalyticsSettings * folders/{folder\}/securityHealthAnalyticsSettings * projects/{project\}/securityHealthAnalyticsSettings */ name?: string; /** @@ -5811,7 +5811,7 @@ export namespace securitycenter_v1beta2 { export interface Params$Resource$Folders$Updatevirtualmachinethreatdetectionsettings extends StandardParameters { /** - * The resource name of the VirtualMachineThreatDetectionSettings. Formats: * organizations/{organization\}/virtualMachineThreatDetectionSettings * folders/{folder\}/virtualMachineThreatDetectionSettings * projects/{project\}/virtualMachineThreatDetectionSettings + * Identifier. The resource name of the VirtualMachineThreatDetectionSettings. Formats: * organizations/{organization\}/virtualMachineThreatDetectionSettings * folders/{folder\}/virtualMachineThreatDetectionSettings * projects/{project\}/virtualMachineThreatDetectionSettings */ name?: string; /** @@ -5827,7 +5827,7 @@ export namespace securitycenter_v1beta2 { export interface Params$Resource$Folders$Updatewebsecurityscannersettings extends StandardParameters { /** - * The resource name of the WebSecurityScannerSettings. Formats: * organizations/{organization\}/webSecurityScannerSettings * folders/{folder\}/webSecurityScannerSettings * projects/{project\}/webSecurityScannerSettings + * Identifier. The resource name of the WebSecurityScannerSettings. Formats: * organizations/{organization\}/webSecurityScannerSettings * folders/{folder\}/webSecurityScannerSettings * projects/{project\}/webSecurityScannerSettings */ name?: string; /** @@ -7942,7 +7942,7 @@ export namespace securitycenter_v1beta2 { export interface Params$Resource$Organizations$Updatecontainerthreatdetectionsettings extends StandardParameters { /** - * The resource name of the ContainerThreatDetectionSettings. Formats: * organizations/{organization\}/containerThreatDetectionSettings * folders/{folder\}/containerThreatDetectionSettings * projects/{project\}/containerThreatDetectionSettings * projects/{project\}/locations/{location\}/clusters/{cluster\}/containerThreatDetectionSettings + * Identifier. The resource name of the ContainerThreatDetectionSettings. Formats: * organizations/{organization\}/containerThreatDetectionSettings * folders/{folder\}/containerThreatDetectionSettings * projects/{project\}/containerThreatDetectionSettings * projects/{project\}/locations/{location\}/clusters/{cluster\}/containerThreatDetectionSettings */ name?: string; /** @@ -7958,7 +7958,7 @@ export namespace securitycenter_v1beta2 { export interface Params$Resource$Organizations$Updateeventthreatdetectionsettings extends StandardParameters { /** - * The resource name of the EventThreatDetectionSettings. Formats: * organizations/{organization\}/eventThreatDetectionSettings * folders/{folder\}/eventThreatDetectionSettings * projects/{project\}/eventThreatDetectionSettings + * Identifier. The resource name of the EventThreatDetectionSettings. Formats: * organizations/{organization\}/eventThreatDetectionSettings * folders/{folder\}/eventThreatDetectionSettings * projects/{project\}/eventThreatDetectionSettings */ name?: string; /** @@ -7990,7 +7990,7 @@ export namespace securitycenter_v1beta2 { export interface Params$Resource$Organizations$Updatesecurityhealthanalyticssettings extends StandardParameters { /** - * The resource name of the SecurityHealthAnalyticsSettings. Formats: * organizations/{organization\}/securityHealthAnalyticsSettings * folders/{folder\}/securityHealthAnalyticsSettings * projects/{project\}/securityHealthAnalyticsSettings + * Identifier. The resource name of the SecurityHealthAnalyticsSettings. Formats: * organizations/{organization\}/securityHealthAnalyticsSettings * folders/{folder\}/securityHealthAnalyticsSettings * projects/{project\}/securityHealthAnalyticsSettings */ name?: string; /** @@ -8006,7 +8006,7 @@ export namespace securitycenter_v1beta2 { export interface Params$Resource$Organizations$Updatevirtualmachinethreatdetectionsettings extends StandardParameters { /** - * The resource name of the VirtualMachineThreatDetectionSettings. Formats: * organizations/{organization\}/virtualMachineThreatDetectionSettings * folders/{folder\}/virtualMachineThreatDetectionSettings * projects/{project\}/virtualMachineThreatDetectionSettings + * Identifier. The resource name of the VirtualMachineThreatDetectionSettings. Formats: * organizations/{organization\}/virtualMachineThreatDetectionSettings * folders/{folder\}/virtualMachineThreatDetectionSettings * projects/{project\}/virtualMachineThreatDetectionSettings */ name?: string; /** @@ -8022,7 +8022,7 @@ export namespace securitycenter_v1beta2 { export interface Params$Resource$Organizations$Updatewebsecurityscannersettings extends StandardParameters { /** - * The resource name of the WebSecurityScannerSettings. Formats: * organizations/{organization\}/webSecurityScannerSettings * folders/{folder\}/webSecurityScannerSettings * projects/{project\}/webSecurityScannerSettings + * Identifier. The resource name of the WebSecurityScannerSettings. Formats: * organizations/{organization\}/webSecurityScannerSettings * folders/{folder\}/webSecurityScannerSettings * projects/{project\}/webSecurityScannerSettings */ name?: string; /** @@ -10038,7 +10038,7 @@ export namespace securitycenter_v1beta2 { export interface Params$Resource$Projects$Updatecontainerthreatdetectionsettings extends StandardParameters { /** - * The resource name of the ContainerThreatDetectionSettings. Formats: * organizations/{organization\}/containerThreatDetectionSettings * folders/{folder\}/containerThreatDetectionSettings * projects/{project\}/containerThreatDetectionSettings * projects/{project\}/locations/{location\}/clusters/{cluster\}/containerThreatDetectionSettings + * Identifier. The resource name of the ContainerThreatDetectionSettings. Formats: * organizations/{organization\}/containerThreatDetectionSettings * folders/{folder\}/containerThreatDetectionSettings * projects/{project\}/containerThreatDetectionSettings * projects/{project\}/locations/{location\}/clusters/{cluster\}/containerThreatDetectionSettings */ name?: string; /** @@ -10054,7 +10054,7 @@ export namespace securitycenter_v1beta2 { export interface Params$Resource$Projects$Updateeventthreatdetectionsettings extends StandardParameters { /** - * The resource name of the EventThreatDetectionSettings. Formats: * organizations/{organization\}/eventThreatDetectionSettings * folders/{folder\}/eventThreatDetectionSettings * projects/{project\}/eventThreatDetectionSettings + * Identifier. The resource name of the EventThreatDetectionSettings. Formats: * organizations/{organization\}/eventThreatDetectionSettings * folders/{folder\}/eventThreatDetectionSettings * projects/{project\}/eventThreatDetectionSettings */ name?: string; /** @@ -10086,7 +10086,7 @@ export namespace securitycenter_v1beta2 { export interface Params$Resource$Projects$Updatesecurityhealthanalyticssettings extends StandardParameters { /** - * The resource name of the SecurityHealthAnalyticsSettings. Formats: * organizations/{organization\}/securityHealthAnalyticsSettings * folders/{folder\}/securityHealthAnalyticsSettings * projects/{project\}/securityHealthAnalyticsSettings + * Identifier. The resource name of the SecurityHealthAnalyticsSettings. Formats: * organizations/{organization\}/securityHealthAnalyticsSettings * folders/{folder\}/securityHealthAnalyticsSettings * projects/{project\}/securityHealthAnalyticsSettings */ name?: string; /** @@ -10102,7 +10102,7 @@ export namespace securitycenter_v1beta2 { export interface Params$Resource$Projects$Updatevirtualmachinethreatdetectionsettings extends StandardParameters { /** - * The resource name of the VirtualMachineThreatDetectionSettings. Formats: * organizations/{organization\}/virtualMachineThreatDetectionSettings * folders/{folder\}/virtualMachineThreatDetectionSettings * projects/{project\}/virtualMachineThreatDetectionSettings + * Identifier. The resource name of the VirtualMachineThreatDetectionSettings. Formats: * organizations/{organization\}/virtualMachineThreatDetectionSettings * folders/{folder\}/virtualMachineThreatDetectionSettings * projects/{project\}/virtualMachineThreatDetectionSettings */ name?: string; /** @@ -10118,7 +10118,7 @@ export namespace securitycenter_v1beta2 { export interface Params$Resource$Projects$Updatewebsecurityscannersettings extends StandardParameters { /** - * The resource name of the WebSecurityScannerSettings. Formats: * organizations/{organization\}/webSecurityScannerSettings * folders/{folder\}/webSecurityScannerSettings * projects/{project\}/webSecurityScannerSettings + * Identifier. The resource name of the WebSecurityScannerSettings. Formats: * organizations/{organization\}/webSecurityScannerSettings * folders/{folder\}/webSecurityScannerSettings * projects/{project\}/webSecurityScannerSettings */ name?: string; /** @@ -10583,7 +10583,7 @@ export namespace securitycenter_v1beta2 { export interface Params$Resource$Projects$Locations$Clusters$Updatecontainerthreatdetectionsettings extends StandardParameters { /** - * The resource name of the ContainerThreatDetectionSettings. Formats: * organizations/{organization\}/containerThreatDetectionSettings * folders/{folder\}/containerThreatDetectionSettings * projects/{project\}/containerThreatDetectionSettings * projects/{project\}/locations/{location\}/clusters/{cluster\}/containerThreatDetectionSettings + * Identifier. The resource name of the ContainerThreatDetectionSettings. Formats: * organizations/{organization\}/containerThreatDetectionSettings * folders/{folder\}/containerThreatDetectionSettings * projects/{project\}/containerThreatDetectionSettings * projects/{project\}/locations/{location\}/clusters/{cluster\}/containerThreatDetectionSettings */ name?: string; /** diff --git a/src/apis/serviceconsumermanagement/v1.ts b/src/apis/serviceconsumermanagement/v1.ts index 2fabfa6bc4..91d91333da 100644 --- a/src/apis/serviceconsumermanagement/v1.ts +++ b/src/apis/serviceconsumermanagement/v1.ts @@ -540,7 +540,7 @@ export namespace serviceconsumermanagement_v1 { tag?: string | null; } /** - * `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. + * `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: \> ... code_snippet_rules: - selector: google.calendar.Calendar.Delete code_snippets: - includes: - github_include: region_tag: calendar_delete code_language: JAVA account: GoogleCloudPlatform project: java-docs-samples file: calendar/delete.java 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. */ export interface Schema$Documentation { /** diff --git a/src/apis/serviceconsumermanagement/v1beta1.ts b/src/apis/serviceconsumermanagement/v1beta1.ts index 81634fcb34..9ca6be3d4e 100644 --- a/src/apis/serviceconsumermanagement/v1beta1.ts +++ b/src/apis/serviceconsumermanagement/v1beta1.ts @@ -466,7 +466,7 @@ export namespace serviceconsumermanagement_v1beta1 { path?: string | null; } /** - * `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. + * `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: \> ... code_snippet_rules: - selector: google.calendar.Calendar.Delete code_snippets: - includes: - github_include: region_tag: calendar_delete code_language: JAVA account: GoogleCloudPlatform project: java-docs-samples file: calendar/delete.java 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. */ export interface Schema$Documentation { /** diff --git a/src/apis/servicemanagement/v1.ts b/src/apis/servicemanagement/v1.ts index 52135ddb0b..5b00978b71 100644 --- a/src/apis/servicemanagement/v1.ts +++ b/src/apis/servicemanagement/v1.ts @@ -612,7 +612,7 @@ export namespace servicemanagement_v1 { message?: string | null; } /** - * `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. + * `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: \> ... code_snippet_rules: - selector: google.calendar.Calendar.Delete code_snippets: - includes: - github_include: region_tag: calendar_delete code_language: JAVA account: GoogleCloudPlatform project: java-docs-samples file: calendar/delete.java 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. */ export interface Schema$Documentation { /** diff --git a/src/apis/servicenetworking/v1.ts b/src/apis/servicenetworking/v1.ts index 7bf0a864f5..0065806e1f 100644 --- a/src/apis/servicenetworking/v1.ts +++ b/src/apis/servicenetworking/v1.ts @@ -666,11 +666,11 @@ export namespace servicenetworking_v1 { */ allowedResponseExtensions?: string[] | null; /** - * A list of full type names of provided contexts. + * A list of full type names of provided contexts. It is used to support propagating HTTP headers and ETags from the response extension. */ provided?: string[] | null; /** - * A list of full type names of requested contexts. + * A list of full type names of requested contexts, only the requested context will be made available to the backend. */ requested?: string[] | null; /** @@ -813,7 +813,7 @@ export namespace servicenetworking_v1 { producerPrivateZone?: Schema$DnsZone; } /** - * `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: \> ... code_snippet_rules: - selector: google.calendar.Calendar.Delete code_snippets: - includes: - github_include: region_tag: calendar_delete code_language: JAVA account: GoogleCloudPlatform project: java-docs-samples file: calendar/delete.java 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. + * `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. */ export interface Schema$Documentation { /** @@ -1132,7 +1132,7 @@ export namespace servicenetworking_v1 { rules?: Schema$HttpRule[]; } /** - * 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/x\}" \}; \} \} 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/x\}"` 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. Example below selects a gRPC method and applies 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. + * 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/x\}" \}; \} \} 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/x\}"` 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. */ export interface Schema$HttpRule { /** diff --git a/src/apis/servicenetworking/v1beta.ts b/src/apis/servicenetworking/v1beta.ts index b4767ebdac..b69561c680 100644 --- a/src/apis/servicenetworking/v1beta.ts +++ b/src/apis/servicenetworking/v1beta.ts @@ -562,11 +562,11 @@ export namespace servicenetworking_v1beta { */ allowedResponseExtensions?: string[] | null; /** - * A list of full type names of provided contexts. + * A list of full type names of provided contexts. It is used to support propagating HTTP headers and ETags from the response extension. */ provided?: string[] | null; /** - * A list of full type names of requested contexts. + * A list of full type names of requested contexts, only the requested context will be made available to the backend. */ requested?: string[] | null; /** @@ -678,7 +678,7 @@ export namespace servicenetworking_v1beta { name?: string | null; } /** - * `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: \> ... code_snippet_rules: - selector: google.calendar.Calendar.Delete code_snippets: - includes: - github_include: region_tag: calendar_delete code_language: JAVA account: GoogleCloudPlatform project: java-docs-samples file: calendar/delete.java 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. + * `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. */ export interface Schema$Documentation { /** @@ -971,7 +971,7 @@ export namespace servicenetworking_v1beta { rules?: Schema$HttpRule[]; } /** - * 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/x\}" \}; \} \} 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/x\}"` 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. Example below selects a gRPC method and applies 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. + * 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/x\}" \}; \} \} 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/x\}"` 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. */ export interface Schema$HttpRule { /** diff --git a/src/apis/serviceusage/v1.ts b/src/apis/serviceusage/v1.ts index a294ccc4ce..47c648f222 100644 --- a/src/apis/serviceusage/v1.ts +++ b/src/apis/serviceusage/v1.ts @@ -516,11 +516,11 @@ export namespace serviceusage_v1 { */ allowedResponseExtensions?: string[] | null; /** - * A list of full type names of provided contexts. + * A list of full type names of provided contexts. It is used to support propagating HTTP headers and ETags from the response extension. */ provided?: string[] | null; /** - * A list of full type names of requested contexts. + * A list of full type names of requested contexts, only the requested context will be made available to the backend. */ requested?: string[] | null; /** @@ -1182,7 +1182,7 @@ export namespace serviceusage_v1 { rules?: Schema$HttpRule[]; } /** - * 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/x\}" \}; \} \} 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/x\}"` 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. Example below selects a gRPC method and applies 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. + * 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/x\}" \}; \} \} 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/x\}"` 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. */ export interface Schema$HttpRule { /** diff --git a/src/apis/serviceusage/v1beta1.ts b/src/apis/serviceusage/v1beta1.ts index f5e74b9c85..6a56d94f65 100644 --- a/src/apis/serviceusage/v1beta1.ts +++ b/src/apis/serviceusage/v1beta1.ts @@ -565,11 +565,11 @@ export namespace serviceusage_v1beta1 { */ allowedResponseExtensions?: string[] | null; /** - * A list of full type names of provided contexts. + * A list of full type names of provided contexts. It is used to support propagating HTTP headers and ETags from the response extension. */ provided?: string[] | null; /** - * A list of full type names of requested contexts. + * A list of full type names of requested contexts, only the requested context will be made available to the backend. */ requested?: string[] | null; /** @@ -1222,7 +1222,7 @@ export namespace serviceusage_v1beta1 { rules?: Schema$HttpRule[]; } /** - * 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/x\}" \}; \} \} 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/x\}"` 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. Example below selects a gRPC method and applies 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. + * 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/x\}" \}; \} \} 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/x\}"` 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. */ export interface Schema$HttpRule { /** diff --git a/src/apis/sheets/v4.ts b/src/apis/sheets/v4.ts index 4f48dcb946..c3b0c36abe 100644 --- a/src/apis/sheets/v4.ts +++ b/src/apis/sheets/v4.ts @@ -174,7 +174,7 @@ export namespace sheets_v4 { rule?: Schema$ConditionalFormatRule; } /** - * Adds a data source. After the data source is added successfully, an associated DATA_SOURCE sheet is created and an execution is triggered to refresh the sheet to read data from the data source. The request requires an additional `bigquery.readonly` OAuth scope. + * Adds a data source. After the data source is added successfully, an associated DATA_SOURCE sheet is created and an execution is triggered to refresh the sheet to read data from the data source. The request requires an additional `bigquery.readonly` OAuth scope if you are adding a BigQuery data source. */ export interface Schema$AddDataSourceRequest { /** @@ -1055,7 +1055,7 @@ export namespace sheets_v4 { series?: Schema$ChartData; } /** - * Cancels one or multiple refreshes of data source objects in the spreadsheet by the specified references. + * Cancels one or multiple refreshes of data source objects in the spreadsheet by the specified references. The request requires an additional `bigquery.readonly` OAuth scope if you are cancelling a refresh on a BigQuery data source. */ export interface Schema$CancelDataSourceRefreshRequest { /** @@ -3407,7 +3407,7 @@ export namespace sheets_v4 { reference?: Schema$DataSourceObjectReference; } /** - * Refreshes one or multiple data source objects in the spreadsheet by the specified references. The request requires an additional `bigquery.readonly` OAuth scope. If there are multiple refresh requests referencing the same data source objects in one batch, only the last refresh request is processed, and all those requests will have the same response accordingly. + * Refreshes one or multiple data source objects in the spreadsheet by the specified references. The request requires an additional `bigquery.readonly` OAuth scope if you are refreshing a BigQuery data source. If there are multiple refresh requests referencing the same data source objects in one batch, only the last refresh request is processed, and all those requests will have the same response accordingly. */ export interface Schema$RefreshDataSourceRequest { /** @@ -4590,7 +4590,7 @@ export namespace sheets_v4 { oldRule?: Schema$ConditionalFormatRule; } /** - * Updates a data source. After the data source is updated successfully, an execution is triggered to refresh the associated DATA_SOURCE sheet to read data from the updated data source. The request requires an additional `bigquery.readonly` OAuth scope. + * Updates a data source. After the data source is updated successfully, an execution is triggered to refresh the associated DATA_SOURCE sheet to read data from the updated data source. The request requires an additional `bigquery.readonly` OAuth scope if you are updating a BigQuery data source. */ export interface Schema$UpdateDataSourceRequest { /** diff --git a/src/apis/spanner/v1.ts b/src/apis/spanner/v1.ts index c7d879f791..d602b530d4 100644 --- a/src/apis/spanner/v1.ts +++ b/src/apis/spanner/v1.ts @@ -127,7 +127,7 @@ export namespace spanner_v1 { } /** - * Autoscaling config for an instance. + * Autoscaling configuration for an instance. */ export interface Schema$AutoscalingConfig { /** @@ -570,7 +570,7 @@ export namespace spanner_v1 { */ extraStatements?: string[] | null; /** - * Optional. Proto descriptors used by CREATE/ALTER PROTO BUNDLE statements in 'extra_statements' above. 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). + * 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). */ protoDescriptors?: string | null; } @@ -583,7 +583,7 @@ export namespace spanner_v1 { */ cancelTime?: string | null; /** - * The target instance config end state. + * The target instance configuration end state. */ instanceConfig?: Schema$InstanceConfig; /** @@ -596,11 +596,11 @@ export namespace spanner_v1 { */ export interface Schema$CreateInstanceConfigRequest { /** - * 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. + * 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. */ instanceConfig?: Schema$InstanceConfig; /** - * Required. The ID of the instance config 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. 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. */ instanceConfigId?: string | null; /** @@ -710,7 +710,7 @@ export namespace spanner_v1 { */ earliestVersionTime?: string | null; /** - * 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). + * 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). */ enableDropProtection?: boolean | null; /** @@ -1137,11 +1137,11 @@ export namespace spanner_v1 { */ name?: string | null; /** - * 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 may be zero in API responses for instances that are not yet in state `READY`. See [the documentation](https://cloud.google.com/spanner/docs/compute-capacity) for more information about nodes and processing units. + * 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). */ nodeCount?: number | null; /** - * The number of processing units allocated to this instance. At most one of 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 may be zero in API responses for instances that are not yet in state `READY`. See [the documentation](https://cloud.google.com/spanner/docs/compute-capacity) for more information about nodes and processing units. + * 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. See [the documentation](https://cloud.google.com/spanner/docs/compute-capacity) for more information about nodes and processing units. */ processingUnits?: number | null; /** @@ -1158,11 +1158,11 @@ export namespace spanner_v1 { */ export interface Schema$InstanceConfig { /** - * 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. + * 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. */ baseConfig?: string | null; /** - * Output only. Whether this instance config is a Google or User Managed Configuration. + * Output only. Whether this instance configuration is a Google- or user-managed configuration. */ configType?: string | null; /** @@ -1170,7 +1170,7 @@ export namespace spanner_v1 { */ displayName?: string | null; /** - * etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a instance config from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform instance config updates in order to avoid race conditions: An etag is returned in the response which contains instance configs, and systems are expected to put that etag in the request to update instance config to ensure that their change will be applied to the same version of the instance config. If no etag is provided in the call to update instance config, then the existing instance config is overwritten blindly. + * 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. */ etag?: string | null; /** @@ -1186,11 +1186,11 @@ export namespace spanner_v1 { */ leaderOptions?: string[] | null; /** - * A unique identifier for the instance configuration. Values are of the form `projects//instanceConfigs/a-z*`. User instance config must start with `custom-`. + * A unique identifier for the instance configuration. Values are of the form `projects//instanceConfigs/a-z*`. User instance configuration must start with `custom-`. */ name?: string | null; /** - * Output only. The available optional replicas to choose from for user managed configurations. Populated for Google managed configurations. + * Output only. The available optional replicas to choose from for user-managed configurations. Populated for Google-managed configurations. */ optionalReplicas?: Schema$ReplicaInfo[]; /** @@ -1198,15 +1198,15 @@ export namespace spanner_v1 { */ quorumType?: string | null; /** - * Output only. If true, the instance config is being created or updated. If false, there are no ongoing operations for the instance config. + * Output only. If true, the instance configuration is being created or updated. If false, there are no ongoing operations for the instance config. */ reconciling?: boolean | null; /** - * 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`. + * 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`. */ replicas?: Schema$ReplicaInfo[]; /** - * Output only. The current instance config state. Applicable only for USER_MANAGED configs. + * Output only. The current instance configuration state. Applicable only for `USER_MANAGED` configurations. */ state?: string | null; /** @@ -1256,11 +1256,11 @@ export namespace spanner_v1 { */ name?: string | null; /** - * 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`. + * 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`. */ nodeCount?: number | null; /** - * 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 may be zero in API responses for instance partitions that are not yet in state `READY`. + * 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. */ processingUnits?: number | null; /** @@ -1446,7 +1446,7 @@ export namespace spanner_v1 { */ nextPageToken?: string | null; /** - * The list of matching instance config long-running operations. Each operation's name will be prefixed by the instance config's name. The operation's metadata field type `metadata.type_url` describes the type of the metadata. + * The list of matching instance configuration long-running operations. Each operation's name will be prefixed by the instance config's name. The operation's metadata field type `metadata.type_url` describes the type of the metadata. */ operations?: Schema$Operation[]; } @@ -1646,7 +1646,7 @@ export namespace spanner_v1 { */ export interface Schema$MoveInstanceRequest { /** - * Required. The target instance config for the instance to move. Values are of the form `projects//instanceConfigs/`. + * Required. The target instance configuration for the instance to move. Values are of the form `projects//instanceConfigs/`. */ targetConfig?: string | null; } @@ -1807,7 +1807,7 @@ export namespace spanner_v1 { */ partitionOptions?: Schema$PartitionOptions; /** - * Required. The query request to generate partitions for. The request will fail if the query is not 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 about other conditions, see [Read data in 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 operations. + * Required. The query request to generate partitions for. The request fails if the query is not 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 about other conditions, see [Read data in 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 operations. */ sql?: string | null; /** @@ -2153,7 +2153,7 @@ export namespace spanner_v1 { */ kmsKeyName?: string | null; /** - * Optional. Specifies the KMS configuration for the 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 instance configuration. Some examples: * For single region database instance configs, specify a single regional location KMS key. * For multi-regional database instance configs of type GOOGLE_MANAGED, either specify a multi-regional location KMS key or multiple regional location KMS keys that cover all regions in the instance config. * For a database instance config of type USER_MANAGED, please specify only regional location KMS keys to cover each region in the instance config. Multi-regional location KMS keys are not supported for USER_MANAGED instance configs. + * Optional. Specifies the KMS configuration for the 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 instance configuration. Some examples: * For single region database instance configurations, specify a single regional location KMS key. * For multi-regional database instance configurations of type `GOOGLE_MANAGED`, either specify a multi-regional location KMS key or multiple regional location KMS keys that cover all regions in the instance configuration. * For a database instance configuration of type `USER_MANAGED`, please specify only regional location KMS keys to cover each region in the instance configuration. Multi-regional location KMS keys are not supported for USER_MANAGED instance configurations. */ kmsKeyNames?: string[] | null; } @@ -2604,7 +2604,7 @@ export namespace spanner_v1 { */ cancelTime?: string | null; /** - * The desired instance config after updating. + * The desired instance configuration after updating. */ instanceConfig?: Schema$InstanceConfig; /** @@ -2617,7 +2617,7 @@ export namespace spanner_v1 { */ export interface Schema$UpdateInstanceConfigRequest { /** - * Required. The user instance config to update, which must always include the instance config name. Otherwise, only fields mentioned in update_mask need be included. To prevent conflicts of concurrent updates, etag can be used. + * 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. */ instanceConfig?: Schema$InstanceConfig; /** @@ -2784,7 +2784,7 @@ export namespace spanner_v1 { } /** - * Lists the user-managed instance config long-running operations in the given project. An instance config operation has a name of the form `projects//instanceConfigs//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. + * Lists the user-managed instance configuration long-running operations in the given project. An instance configuration operation has a name of the form `projects//instanceConfigs//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. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -2884,7 +2884,7 @@ export namespace spanner_v1 { export interface Params$Resource$Projects$Instanceconfigoperations$List extends StandardParameters { /** - * An expression that filters the list of returned operations. 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 one of: `<`, `\>`, `<=`, `\>=`, `!=`, `=`, or `:`. Colon `:` is the contains operator. Filter rules are not case sensitive. The following fields in the Operation are eligible for filtering: * `name` - The name of the long-running operation * `done` - False if the operation is in progress, else true. * `metadata.@type` - the type of metadata. For example, the type string for CreateInstanceConfigMetadata is `type.googleapis.com/google.spanner.admin.instance.v1.CreateInstanceConfigMetadata`. * `metadata.` - any field in metadata.value. `metadata.@type` must be specified first, if filtering on metadata fields. * `error` - Error associated with the long-running operation. * `response.@type` - the type of response. * `response.` - any field in response.value. You can combine multiple expressions by enclosing each expression in parentheses. By default, expressions are combined with AND logic. However, you can specify AND, OR, and NOT logic explicitly. Here are a few examples: * `done:true` - The operation is complete. * `(metadata.@type=` \ `type.googleapis.com/google.spanner.admin.instance.v1.CreateInstanceConfigMetadata) AND` \ `(metadata.instance_config.name:custom-config) AND` \ `(metadata.progress.start_time < \"2021-03-28T14:50:00Z\") AND` \ `(error:*)` - Return operations where: * The operation's metadata type is CreateInstanceConfigMetadata. * The instance config name contains "custom-config". * The operation started before 2021-03-28T14:50:00Z. * The operation resulted in an error. + * An expression that filters the list of returned operations. 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 one of: `<`, `\>`, `<=`, `\>=`, `!=`, `=`, or `:`. Colon `:` is the contains operator. Filter rules are not case sensitive. The following fields in the Operation are eligible for filtering: * `name` - The name of the long-running operation * `done` - False if the operation is in progress, else true. * `metadata.@type` - the type of metadata. For example, the type string for CreateInstanceConfigMetadata is `type.googleapis.com/google.spanner.admin.instance.v1.CreateInstanceConfigMetadata`. * `metadata.` - any field in metadata.value. `metadata.@type` must be specified first, if filtering on metadata fields. * `error` - Error associated with the long-running operation. * `response.@type` - the type of response. * `response.` - any field in response.value. You can combine multiple expressions by enclosing each expression in parentheses. By default, expressions are combined with AND logic. However, you can specify AND, OR, and NOT logic explicitly. Here are a few examples: * `done:true` - The operation is complete. * `(metadata.@type=` \ `type.googleapis.com/google.spanner.admin.instance.v1.CreateInstanceConfigMetadata) AND` \ `(metadata.instance_config.name:custom-config) AND` \ `(metadata.progress.start_time < \"2021-03-28T14:50:00Z\") AND` \ `(error:*)` - Return operations where: * The operation's metadata type is CreateInstanceConfigMetadata. * The instance configuration name contains "custom-config". * The operation started before 2021-03-28T14:50:00Z. * The operation resulted in an error. */ filter?: string; /** @@ -2896,7 +2896,7 @@ export namespace spanner_v1 { */ pageToken?: string; /** - * Required. The project of the instance config operations. Values are of the form `projects/`. + * Required. The project of the instance configuration operations. Values are of the form `projects/`. */ parent?: string; } @@ -2916,7 +2916,7 @@ export namespace spanner_v1 { } /** - * Creates an instance config and begins preparing it to be used. The returned long-running operation can be used to track the progress of preparing the new instance config. The instance config name is assigned by the caller. If the named instance config already exists, `CreateInstanceConfig` returns `ALREADY_EXISTS`. Immediately after the request returns: * The instance config is readable via the API, with all requested attributes. The instance config's reconciling field is set to true. Its state is `CREATING`. While the operation is pending: * Cancelling the operation renders the instance config immediately unreadable via the API. * Except for deleting the creating resource, all other attempts to modify the instance config are rejected. Upon completion of the returned operation: * Instances can be created using the instance configuration. * The instance config's reconciling field becomes false. Its 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 config. The metadata field type is CreateInstanceConfigMetadata. The response field type is InstanceConfig, if successful. Authorization requires `spanner.instanceConfigs.create` permission on the resource parent. + * Creates an instance configuration and begins preparing it to be used. The returned long-running operation can be used to track the progress of preparing the new instance config. The instance configuration name is assigned by the caller. If the named instance configuration already exists, `CreateInstanceConfig` returns `ALREADY_EXISTS`. Immediately after the request returns: * The instance configuration is readable via the API, with all requested attributes. The instance config's reconciling field is set to true. Its state is `CREATING`. While the operation is pending: * Cancelling the operation renders the instance configuration immediately unreadable via the API. * Except for deleting the creating resource, all other attempts to modify the instance configuration are rejected. Upon completion of the returned operation: * Instances can be created using the instance configuration. * The instance config's reconciling field becomes false. Its 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 config. The metadata field type is CreateInstanceConfigMetadata. The response field type is InstanceConfig, if successful. Authorization requires `spanner.instanceConfigs.create` permission on the resource parent. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -3004,7 +3004,7 @@ export namespace spanner_v1 { } /** - * Deletes the instance config. Deletion is only allowed when no instances are using the configuration. If any instances are using the config, returns `FAILED_PRECONDITION`. Only user managed configurations can be deleted. Authorization requires `spanner.instanceConfigs.delete` permission on the resource name. + * Deletes the instance config. Deletion is only allowed when no instances are using the configuration. If any instances are using the config, returns `FAILED_PRECONDITION`. Only user-managed configurations can be deleted. Authorization requires `spanner.instanceConfigs.delete` permission on the resource name. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -3174,7 +3174,7 @@ export namespace spanner_v1 { } /** - * Lists the supported instance configurations for a given project. Returns both Google managed configs and user managed configs. + * Lists the supported instance configurations for a given project. Returns both Google-managed configurations and user-managed configurations. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -3269,7 +3269,7 @@ export namespace spanner_v1 { } /** - * Updates an instance config. The returned long-running operation can be used to track the progress of updating the instance. If the named instance config does not exist, returns `NOT_FOUND`. Only user managed configurations can be updated. Immediately after the request returns: * The instance config's reconciling field is set to true. While the operation is pending: * Cancelling the operation sets its metadata's cancel_time. The operation is guaranteed to succeed at undoing all changes, after which point it terminates with a `CANCELLED` status. * All other attempts to modify the instance config are rejected. * Reading the instance config via the API continues to give the pre-request values. Upon completion of the returned operation: * Creating instances using the instance configuration uses the new values. * The instance config's new values are readable via the API. * The instance config's reconciling field becomes false. The returned long-running operation will have a name of the format `/operations/` and can be used to track the instance config modification. The metadata field type is UpdateInstanceConfigMetadata. The response field type is InstanceConfig, if successful. Authorization requires `spanner.instanceConfigs.update` permission on the resource name. + * Updates an instance config. The returned long-running operation can be used to track the progress of updating the instance. If the named instance configuration does not exist, returns `NOT_FOUND`. Only user-managed configurations can be updated. Immediately after the request returns: * The instance config's reconciling field is set to true. While the operation is pending: * Cancelling the operation sets its metadata's cancel_time. The operation is guaranteed to succeed at undoing all changes, after which point it terminates with a `CANCELLED` status. * All other attempts to modify the instance configuration are rejected. * Reading the instance configuration via the API continues to give the pre-request values. Upon completion of the returned operation: * Creating instances using the instance configuration uses the new values. * The instance config's new values are readable via the API. * The instance config's reconciling field becomes false. The returned long-running operation will have a name of the format `/operations/` and can be used to track the instance configuration modification. The metadata field type is UpdateInstanceConfigMetadata. The response field type is InstanceConfig, if successful. Authorization requires `spanner.instanceConfigs.update` permission on the resource name. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -3369,7 +3369,7 @@ export namespace spanner_v1 { export interface Params$Resource$Projects$Instanceconfigs$Delete extends StandardParameters { /** - * Used for optimistic concurrency control as a way to help prevent simultaneous deletes of an instance config from overwriting each other. If not empty, the API only deletes the instance config when the etag provided matches the current status of the requested instance config. Otherwise, deletes the instance config without checking the current status of the requested instance config. + * Used for optimistic concurrency control as a way to help prevent simultaneous deletes of an instance configuration from overwriting each other. If not empty, the API only deletes the instance configuration when the etag provided matches the current status of the requested instance config. Otherwise, deletes the instance configuration without checking the current status of the requested instance config. */ etag?: string; /** @@ -3406,7 +3406,7 @@ export namespace spanner_v1 { export interface Params$Resource$Projects$Instanceconfigs$Patch extends StandardParameters { /** - * A unique identifier for the instance configuration. Values are of the form `projects//instanceConfigs/a-z*`. User instance config must start with `custom-`. + * A unique identifier for the instance configuration. Values are of the form `projects//instanceConfigs/a-z*`. User instance configuration must start with `custom-`. */ name?: string; @@ -4689,7 +4689,7 @@ export namespace spanner_v1 { } /** - * Moves the instance to the target instance config. The returned long-running operation can be used to track the progress of moving the instance. `MoveInstance` returns `FAILED_PRECONDITION` if the instance meets any of the following criteria: * Has an ongoing move to a different instance config * Has backups * Has an ongoing update * Is under free trial * Contains any CMEK-enabled databases While the operation is pending: * All other attempts to modify the instance, including changes to its compute capacity, are rejected. * The following database and backup admin operations are rejected: * DatabaseAdmin.CreateDatabase, * DatabaseAdmin.UpdateDatabaseDdl (Disabled if default_leader is specified in the request.) * DatabaseAdmin.RestoreDatabase * DatabaseAdmin.CreateBackup * DatabaseAdmin.CopyBackup * Both the source and target instance configs are subject to hourly compute and storage charges. * The instance may experience higher read-write latencies and a higher transaction abort rate. However, moving an instance does not cause any downtime. The returned long-running operation will have a name of the format `/operations/` and can be used to track the move instance operation. The metadata field type is MoveInstanceMetadata. The response field type is Instance, if successful. Cancelling the operation sets its metadata's cancel_time. Cancellation is not immediate since it involves moving any data previously moved to target instance config back to the original instance config. The same operation can be used to track the progress of the cancellation. Upon successful completion of the cancellation, the operation terminates with CANCELLED status. Upon completion(if not cancelled) of the returned operation: * Instance would be successfully moved to the target instance config. * You are billed for compute and storage in target instance config. Authorization requires `spanner.instances.update` permission on the resource instance. For more details, please see [documentation](https://cloud.google.com/spanner/docs/move-instance). + * Moves the instance to the target instance config. The returned long-running operation can be used to track the progress of moving the instance. `MoveInstance` returns `FAILED_PRECONDITION` if the instance meets any of the following criteria: * Has an ongoing move to a different instance config * Has backups * Has an ongoing update * Is under free trial * Contains any CMEK-enabled databases While the operation is pending: * All other attempts to modify the instance, including changes to its compute capacity, are rejected. * The following database and backup admin operations are rejected: * DatabaseAdmin.CreateDatabase, * DatabaseAdmin.UpdateDatabaseDdl (Disabled if default_leader is specified in the request.) * DatabaseAdmin.RestoreDatabase * DatabaseAdmin.CreateBackup * DatabaseAdmin.CopyBackup * Both the source and target instance configurations are subject to hourly compute and storage charges. * The instance may experience higher read-write latencies and a higher transaction abort rate. However, moving an instance does not cause any downtime. The returned long-running operation will have a name of the format `/operations/` and can be used to track the move instance operation. The metadata field type is MoveInstanceMetadata. The response field type is Instance, if successful. Cancelling the operation sets its metadata's cancel_time. Cancellation is not immediate since it involves moving any data previously moved to target instance configuration back to the original instance config. The same operation can be used to track the progress of the cancellation. Upon successful completion of the cancellation, the operation terminates with `CANCELLED` status. Upon completion(if not cancelled) of the returned operation: * Instance would be successfully moved to the target instance config. * You are billed for compute and storage in target instance config. Authorization requires `spanner.instances.update` permission on the resource instance. For more details, please see [documentation](https://cloud.google.com/spanner/docs/move-instance). * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -6735,11 +6735,14 @@ export namespace spanner_v1 { export class Resource$Projects$Instances$Databases { context: APIRequestContext; + backupSchedules: Resource$Projects$Instances$Databases$Backupschedules; databaseRoles: Resource$Projects$Instances$Databases$Databaseroles; operations: Resource$Projects$Instances$Databases$Operations; sessions: Resource$Projects$Instances$Databases$Sessions; constructor(context: APIRequestContext) { this.context = context; + this.backupSchedules = + new Resource$Projects$Instances$Databases$Backupschedules(this.context); this.databaseRoles = new Resource$Projects$Instances$Databases$Databaseroles(this.context); this.operations = new Resource$Projects$Instances$Databases$Operations( @@ -6840,7 +6843,7 @@ export namespace spanner_v1 { } /** - * Creates a new Cloud Spanner database and starts to prepare it for serving. The returned long-running operation will have a name of the format `/operations/` and can be used to track preparation of the database. The metadata field type is CreateDatabaseMetadata. The response field type is Database, if successful. + * Creates a new Spanner database and starts to prepare it for serving. The returned long-running operation will have a name of the format `/operations/` and can be used to track preparation of the database. The metadata field type is CreateDatabaseMetadata. The response field type is Database, if successful. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -8061,6 +8064,324 @@ export namespace spanner_v1 { requestBody?: Schema$UpdateDatabaseDdlRequest; } + export class Resource$Projects$Instances$Databases$Backupschedules { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * 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. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + getIamPolicy( + params: Params$Resource$Projects$Instances$Databases$Backupschedules$Getiampolicy, + options: StreamMethodOptions + ): GaxiosPromise; + getIamPolicy( + params?: Params$Resource$Projects$Instances$Databases$Backupschedules$Getiampolicy, + options?: MethodOptions + ): GaxiosPromise; + getIamPolicy( + params: Params$Resource$Projects$Instances$Databases$Backupschedules$Getiampolicy, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getIamPolicy( + params: Params$Resource$Projects$Instances$Databases$Backupschedules$Getiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getIamPolicy( + params: Params$Resource$Projects$Instances$Databases$Backupschedules$Getiampolicy, + callback: BodyResponseCallback + ): void; + getIamPolicy(callback: BodyResponseCallback): void; + getIamPolicy( + paramsOrCallback?: + | Params$Resource$Projects$Instances$Databases$Backupschedules$Getiampolicy + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Instances$Databases$Backupschedules$Getiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Instances$Databases$Backupschedules$Getiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://spanner.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+resource}:getIamPolicy').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['resource'], + pathParams: ['resource'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * 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. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + setIamPolicy( + params: Params$Resource$Projects$Instances$Databases$Backupschedules$Setiampolicy, + options: StreamMethodOptions + ): GaxiosPromise; + setIamPolicy( + params?: Params$Resource$Projects$Instances$Databases$Backupschedules$Setiampolicy, + options?: MethodOptions + ): GaxiosPromise; + setIamPolicy( + params: Params$Resource$Projects$Instances$Databases$Backupschedules$Setiampolicy, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setIamPolicy( + params: Params$Resource$Projects$Instances$Databases$Backupschedules$Setiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setIamPolicy( + params: Params$Resource$Projects$Instances$Databases$Backupschedules$Setiampolicy, + callback: BodyResponseCallback + ): void; + setIamPolicy(callback: BodyResponseCallback): void; + setIamPolicy( + paramsOrCallback?: + | Params$Resource$Projects$Instances$Databases$Backupschedules$Setiampolicy + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Instances$Databases$Backupschedules$Setiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Instances$Databases$Backupschedules$Setiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://spanner.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+resource}:setIamPolicy').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['resource'], + pathParams: ['resource'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * 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. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + testIamPermissions( + params: Params$Resource$Projects$Instances$Databases$Backupschedules$Testiampermissions, + options: StreamMethodOptions + ): GaxiosPromise; + testIamPermissions( + params?: Params$Resource$Projects$Instances$Databases$Backupschedules$Testiampermissions, + options?: MethodOptions + ): GaxiosPromise; + testIamPermissions( + params: Params$Resource$Projects$Instances$Databases$Backupschedules$Testiampermissions, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Projects$Instances$Databases$Backupschedules$Testiampermissions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Projects$Instances$Databases$Backupschedules$Testiampermissions, + callback: BodyResponseCallback + ): void; + testIamPermissions( + callback: BodyResponseCallback + ): void; + testIamPermissions( + paramsOrCallback?: + | Params$Resource$Projects$Instances$Databases$Backupschedules$Testiampermissions + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Instances$Databases$Backupschedules$Testiampermissions; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Instances$Databases$Backupschedules$Testiampermissions; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://spanner.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+resource}:testIamPermissions').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['resource'], + pathParams: ['resource'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Instances$Databases$Backupschedules$Getiampolicy + extends StandardParameters { + /** + * REQUIRED: The Cloud Spanner resource for which the policy is being retrieved. The format is `projects//instances/` for instance resources and `projects//instances//databases/` for database resources. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GetIamPolicyRequest; + } + export interface Params$Resource$Projects$Instances$Databases$Backupschedules$Setiampolicy + extends StandardParameters { + /** + * REQUIRED: The Cloud Spanner resource for which the policy is being set. The format is `projects//instances/` for instance resources and `projects//instances//databases/` for databases resources. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$SetIamPolicyRequest; + } + export interface Params$Resource$Projects$Instances$Databases$Backupschedules$Testiampermissions + extends StandardParameters { + /** + * REQUIRED: The Cloud Spanner resource for which permissions are being tested. The format is `projects//instances/` for instance resources and `projects//instances//databases/` for database resources. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$TestIamPermissionsRequest; + } + export class Resource$Projects$Instances$Databases$Databaseroles { context: APIRequestContext; constructor(context: APIRequestContext) { diff --git a/src/apis/sqladmin/v1.ts b/src/apis/sqladmin/v1.ts index eb99174933..a703e2eb92 100644 --- a/src/apis/sqladmin/v1.ts +++ b/src/apis/sqladmin/v1.ts @@ -916,6 +916,7 @@ export namespace sqladmin_v1 { sqlExportOptions?: { mysqlExportOptions?: {masterData?: number}; parallel?: boolean; + postgresExportOptions?: {clean?: boolean; ifExists?: boolean}; schemaOnly?: boolean; tables?: string[]; threads?: number; @@ -1105,7 +1106,11 @@ export namespace sqladmin_v1 { /** * Optional. Options for importing data from SQL statements. */ - sqlImportOptions?: {parallel?: boolean; threads?: number} | null; + sqlImportOptions?: { + parallel?: boolean; + postgresImportOptions?: {clean?: boolean; ifExists?: boolean}; + threads?: number; + } | null; /** * Path to the import file in Cloud Storage, in the form `gs://bucketName/fileName`. Compressed gzip files (.gz) are supported when `fileType` is `SQL`. The instance must have write permissions to the bucket and read access to the file. */ diff --git a/src/apis/sqladmin/v1beta4.ts b/src/apis/sqladmin/v1beta4.ts index 4bec6e3de5..907bf7464a 100644 --- a/src/apis/sqladmin/v1beta4.ts +++ b/src/apis/sqladmin/v1beta4.ts @@ -919,6 +919,7 @@ export namespace sqladmin_v1beta4 { sqlExportOptions?: { mysqlExportOptions?: {masterData?: number}; parallel?: boolean; + postgresExportOptions?: {clean?: boolean; ifExists?: boolean}; schemaOnly?: boolean; tables?: string[]; threads?: number; @@ -1108,7 +1109,11 @@ export namespace sqladmin_v1beta4 { /** * Optional. Options for importing data from SQL statements. */ - sqlImportOptions?: {parallel?: boolean; threads?: number} | null; + sqlImportOptions?: { + parallel?: boolean; + postgresImportOptions?: {clean?: boolean; ifExists?: boolean}; + threads?: number; + } | null; /** * Path to the import file in Cloud Storage, in the form `gs://bucketName/fileName`. Compressed gzip files (.gz) are supported when `fileType` is `SQL`. The instance must have write permissions to the bucket and read access to the file. */ diff --git a/src/apis/storage/v1.ts b/src/apis/storage/v1.ts index fb1042e7c7..c8301619b9 100644 --- a/src/apis/storage/v1.ts +++ b/src/apis/storage/v1.ts @@ -275,6 +275,17 @@ export namespace storage_v1 { * The ID of the bucket. For buckets, the id and name properties are the same. */ id?: string | null; + /** + * The bucket's IP filter configuration. Specifies the network sources that are allowed to access the operations on the bucket, as well as its underlying objects. Only enforced when the mode is set to 'Enabled'. + */ + ipFilter?: { + mode?: string; + publicNetworkSource?: {allowedIpCidrRanges?: string[]}; + vpcNetworkSources?: Array<{ + allowedIpCidrRanges?: string[]; + network?: string; + }>; + } | null; /** * The kind of item this is. For buckets, this is always storage#bucket. */ diff --git a/src/apis/sts/v1.ts b/src/apis/sts/v1.ts index 89344283e5..15a886a274 100644 --- a/src/apis/sts/v1.ts +++ b/src/apis/sts/v1.ts @@ -243,6 +243,10 @@ export namespace sts_v1 { * Response message for ExchangeToken. */ export interface Schema$GoogleIdentityStsV1ExchangeTokenResponse { + /** + * The access boundary session key. This key is used along with the access boundary intermediate token to generate Credential Access Boundary tokens at client side. This field is absent when the `requested_token_type` from the request is not `urn:ietf:params:oauth:token-type:access_boundary_intermediate_token`. + */ + access_boundary_session_key?: string | null; /** * An OAuth 2.0 security token, issued by Google, in response to the token exchange request. Tokens can vary in size, depending in part on the size of mapped claims, up to a maximum of 12288 bytes (12 KB). Google reserves the right to change the token size and the maximum length at any time. */ diff --git a/src/apis/tagmanager/v2.ts b/src/apis/tagmanager/v2.ts index 7998521657..798aa2d146 100644 --- a/src/apis/tagmanager/v2.ts +++ b/src/apis/tagmanager/v2.ts @@ -2687,7 +2687,7 @@ export namespace tagmanager_v2 { } /** - * Looks up a Container by destination ID. + * Looks up a Container by destination ID or tag ID. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -3104,9 +3104,13 @@ export namespace tagmanager_v2 { export interface Params$Resource$Accounts$Containers$Lookup extends StandardParameters { /** - * Destination ID linked to a GTM Container, e.g. AW-123456789. Example: accounts/containers:lookup?destination_id={destination_id\}. + * Destination ID linked to a GTM Container, e.g. AW-123456789. Example: accounts/containers:lookup?destination_id={destination_id\}. Only one of destination_id or tag_id should be set. */ destinationId?: string; + /** + * Tag ID for a GTM Container, e.g. GTM-123456789. Example: accounts/containers:lookup?tag_id={tag_id\}. Only one of destination_id or tag_id should be set. + */ + tagId?: string; } export interface Params$Resource$Accounts$Containers$Move_tag_id extends StandardParameters { diff --git a/src/apis/transcoder/v1.ts b/src/apis/transcoder/v1.ts index 4245d6f739..dbde1eab17 100644 --- a/src/apis/transcoder/v1.ts +++ b/src/apis/transcoder/v1.ts @@ -990,7 +990,7 @@ export namespace transcoder_v1 { */ export interface Schema$Output { /** - * URI for the output file(s). For example, `gs://my-bucket/outputs/`. If empty, the value is populated from Job.output_uri. See [Supported input and output formats](https://cloud.google.com/transcoder/docs/concepts/supported-input-and-output-formats). + * URI for the output file(s). For example, `gs://my-bucket/outputs/`. Must be a directory and not a top-level bucket. If empty, the value is populated from Job.output_uri. See [Supported input and output formats](https://cloud.google.com/transcoder/docs/concepts/supported-input-and-output-formats). */ uri?: string | null; } diff --git a/src/apis/translate/v3.ts b/src/apis/translate/v3.ts index b3afeb4cc5..062c95ca35 100644 --- a/src/apis/translate/v3.ts +++ b/src/apis/translate/v3.ts @@ -212,18 +212,30 @@ export namespace translate_v3 { */ export interface Schema$AdaptiveMtTranslateRequest { /** - * Required. The content of the input in string format. For now only one sentence per request is supported. + * Required. The content of the input in string format. */ content?: string[] | null; /** * Required. The resource name for the dataset to use for adaptive MT. `projects/{project\}/locations/{location-id\}/adaptiveMtDatasets/{dataset\}` */ dataset?: string | null; + /** + * Optional. Glossary to be applied. The glossary must be within the same region (have the same location-id) as the model, otherwise an INVALID_ARGUMENT (400) error is returned. + */ + glossaryConfig?: Schema$TranslateTextGlossaryConfig; + /** + * Configuration for caller provided reference sentences. + */ + referenceSentenceConfig?: Schema$ReferenceSentenceConfig; } /** * An AdaptiveMtTranslate response. */ export interface Schema$AdaptiveMtTranslateResponse { + /** + * Text translation response if a glossary is provided in the request. This could be the same as 'translation' above if no terms apply. + */ + glossaryTranslations?: Schema$AdaptiveMtTranslation[]; /** * Output only. The translation's language code. */ @@ -628,7 +640,7 @@ export namespace translate_v3 { */ description?: string | null; /** - * Required. The resource name of the entry. Format: "projects/x/locations/x/glossaries/x/glossaryEntries/x" + * Identifier. The resource name of the entry. Format: "projects/x/locations/x/glossaries/x/glossaryEntries/x" */ name?: string | null; /** @@ -997,6 +1009,45 @@ export namespace translate_v3 { */ gcsDestination?: Schema$GcsDestination; } + /** + * Message of caller-provided reference configuration. + */ + export interface Schema$ReferenceSentenceConfig { + /** + * Reference sentences pair lists. Each list will be used as the references to translate the sentence under "content" field at the corresponding index. Length of the list is required to be equal to the length of "content" field. + */ + referenceSentencePairLists?: Schema$ReferenceSentencePairList[]; + /** + * Source language code. + */ + sourceLanguageCode?: string | null; + /** + * Target language code. + */ + targetLanguageCode?: string | null; + } + /** + * A pair of sentences used as reference in source and target languages. + */ + export interface Schema$ReferenceSentencePair { + /** + * Source sentence in the sentence pair. + */ + sourceSentence?: string | null; + /** + * Target sentence in the sentence pair. + */ + targetSentence?: string | null; + } + /** + * A list of reference sentence pairs. + */ + export interface Schema$ReferenceSentencePairList { + /** + * Reference sentence pairs. + */ + referenceSentencePairs?: Schema$ReferenceSentencePair[]; + } /** * A single romanization response. */ @@ -1183,7 +1234,7 @@ export namespace translate_v3 { */ mimeType?: string | null; /** - * Optional. The `model` type requested for this translation. The format depends on model type: - AutoML Translation models: `projects/{project-number-or-id\}/locations/{location-id\}/models/{model-id\}` - General (built-in) models: `projects/{project-number-or-id\}/locations/{location-id\}/models/general/nmt`, For global (non-regionalized) requests, use `location-id` `global`. For example, `projects/{project-number-or-id\}/locations/global/models/general/nmt`. If not provided, the default Google model (NMT) will be used + * Optional. The `model` type requested for this translation. The format depends on model type: - AutoML Translation models: `projects/{project-number-or-id\}/locations/{location-id\}/models/{model-id\}` - General (built-in) models: `projects/{project-number-or-id\}/locations/{location-id\}/models/general/nmt`, - Translation LLM models: `projects/{project-number-or-id\}/locations/{location-id\}/models/general/translation-llm`, For global (non-regionalized) requests, use `location-id` `global`. For example, `projects/{project-number-or-id\}/locations/global/models/general/nmt`. If not provided, the default Google model (NMT) will be used */ model?: string | null; /** @@ -5580,7 +5631,7 @@ export namespace translate_v3 { export interface Params$Resource$Projects$Locations$Glossaries$Glossaryentries$Patch extends StandardParameters { /** - * Required. The resource name of the entry. Format: "projects/x/locations/x/glossaries/x/glossaryEntries/x" + * Identifier. The resource name of the entry. Format: "projects/x/locations/x/glossaries/x/glossaryEntries/x" */ name?: string; diff --git a/src/apis/vmmigration/v1.ts b/src/apis/vmmigration/v1.ts index 7613ece9c1..5272d88bec 100644 --- a/src/apis/vmmigration/v1.ts +++ b/src/apis/vmmigration/v1.ts @@ -549,6 +549,10 @@ export namespace vmmigration_v1 { * Request message for 'CancelCutoverJob' request. */ export interface Schema$CancelCutoverJobRequest {} + /** + * Request message for 'CancelDiskMigrationJob' request. + */ + export interface Schema$CancelDiskMigrationJobRequest {} /** * Request message for 'CancelImageImportJob' request. */ @@ -1081,7 +1085,7 @@ export namespace vmmigration_v1 { */ export interface Schema$DiskImageTargetDetails { /** - * Optional. Additional licenses to assign to the image. + * Optional. Additional licenses to assign to the image. Format: https://www.googleapis.com/compute/v1/projects/PROJECT_ID/global/licenses/LICENSE_NAME Or https://www.googleapis.com/compute/beta/projects/PROJECT_ID/global/licenses/LICENSE_NAME */ additionalLicenses?: string[] | null; /** @@ -1843,7 +1847,7 @@ export namespace vmmigration_v1 { */ network?: string | null; /** - * The subnetwork to connect the NIC to. + * Optional. The subnetwork to connect the NIC to. */ subnetwork?: string | null; } @@ -1985,7 +1989,7 @@ export namespace vmmigration_v1 { */ sourceDiskNumber?: number | null; /** - * Optional. Details for attachment of the disk to a VM. Used when the disk is set to be attacked to a target VM. + * Optional. Details for attachment of the disk to a VM. Used when the disk is set to be attached to a target VM. */ vmAttachmentDetails?: Schema$VmAttachmentDetails; } @@ -2085,6 +2089,10 @@ export namespace vmmigration_v1 { * Request message for 'ResumeMigration' request. */ export interface Schema$ResumeMigrationRequest {} + /** + * Request message for 'RunDiskMigrationJobRequest' request. + */ + export interface Schema$RunDiskMigrationJobRequest {} /** * A policy for scheduling replications. */ @@ -4611,6 +4619,7 @@ export namespace vmmigration_v1 { export class Resource$Projects$Locations$Sources { context: APIRequestContext; datacenterConnectors: Resource$Projects$Locations$Sources$Datacenterconnectors; + diskMigrationJobs: Resource$Projects$Locations$Sources$Diskmigrationjobs; migratingVms: Resource$Projects$Locations$Sources$Migratingvms; utilizationReports: Resource$Projects$Locations$Sources$Utilizationreports; constructor(context: APIRequestContext) { @@ -4619,6 +4628,8 @@ export namespace vmmigration_v1 { new Resource$Projects$Locations$Sources$Datacenterconnectors( this.context ); + this.diskMigrationJobs = + new Resource$Projects$Locations$Sources$Diskmigrationjobs(this.context); this.migratingVms = new Resource$Projects$Locations$Sources$Migratingvms( this.context ); @@ -5791,6 +5802,210 @@ export namespace vmmigration_v1 { requestBody?: Schema$UpgradeApplianceRequest; } + export class Resource$Projects$Locations$Sources$Diskmigrationjobs { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Cancels the disk migration job. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + cancel( + params: Params$Resource$Projects$Locations$Sources$Diskmigrationjobs$Cancel, + options: StreamMethodOptions + ): GaxiosPromise; + cancel( + params?: Params$Resource$Projects$Locations$Sources$Diskmigrationjobs$Cancel, + options?: MethodOptions + ): GaxiosPromise; + cancel( + params: Params$Resource$Projects$Locations$Sources$Diskmigrationjobs$Cancel, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancel( + params: Params$Resource$Projects$Locations$Sources$Diskmigrationjobs$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancel( + params: Params$Resource$Projects$Locations$Sources$Diskmigrationjobs$Cancel, + callback: BodyResponseCallback + ): void; + cancel(callback: BodyResponseCallback): void; + cancel( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Sources$Diskmigrationjobs$Cancel + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Sources$Diskmigrationjobs$Cancel; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Sources$Diskmigrationjobs$Cancel; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://vmmigration.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Runs the disk migration job. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + run( + params: Params$Resource$Projects$Locations$Sources$Diskmigrationjobs$Run, + options: StreamMethodOptions + ): GaxiosPromise; + run( + params?: Params$Resource$Projects$Locations$Sources$Diskmigrationjobs$Run, + options?: MethodOptions + ): GaxiosPromise; + run( + params: Params$Resource$Projects$Locations$Sources$Diskmigrationjobs$Run, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + run( + params: Params$Resource$Projects$Locations$Sources$Diskmigrationjobs$Run, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + run( + params: Params$Resource$Projects$Locations$Sources$Diskmigrationjobs$Run, + callback: BodyResponseCallback + ): void; + run(callback: BodyResponseCallback): void; + run( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Sources$Diskmigrationjobs$Run + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Sources$Diskmigrationjobs$Run; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Sources$Diskmigrationjobs$Run; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://vmmigration.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:run').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Sources$Diskmigrationjobs$Cancel + extends StandardParameters { + /** + * Required. The name of the DiskMigrationJob. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$CancelDiskMigrationJobRequest; + } + export interface Params$Resource$Projects$Locations$Sources$Diskmigrationjobs$Run + extends StandardParameters { + /** + * Required. The name of the DiskMigrationJob. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$RunDiskMigrationJobRequest; + } + export class Resource$Projects$Locations$Sources$Migratingvms { context: APIRequestContext; cloneJobs: Resource$Projects$Locations$Sources$Migratingvms$Clonejobs; diff --git a/src/apis/vmmigration/v1alpha1.ts b/src/apis/vmmigration/v1alpha1.ts index 9caa2714c1..31696896d9 100644 --- a/src/apis/vmmigration/v1alpha1.ts +++ b/src/apis/vmmigration/v1alpha1.ts @@ -549,6 +549,10 @@ export namespace vmmigration_v1alpha1 { * Request message for 'CancelCutoverJob' request. */ export interface Schema$CancelCutoverJobRequest {} + /** + * Request message for 'CancelDiskMigrationJob' request. + */ + export interface Schema$CancelDiskMigrationJobRequest {} /** * Request message for 'CancelImageImportJob' request. */ @@ -1102,7 +1106,7 @@ export namespace vmmigration_v1alpha1 { */ export interface Schema$DiskImageTargetDetails { /** - * Optional. Additional licenses to assign to the image. + * Optional. Additional licenses to assign to the image. Format: https://www.googleapis.com/compute/v1/projects/PROJECT_ID/global/licenses/LICENSE_NAME Or https://www.googleapis.com/compute/beta/projects/PROJECT_ID/global/licenses/LICENSE_NAME */ additionalLicenses?: string[] | null; /** @@ -1872,7 +1876,7 @@ export namespace vmmigration_v1alpha1 { */ network?: string | null; /** - * The subnetwork to connect the NIC to. + * Optional. The subnetwork to connect the NIC to. */ subnetwork?: string | null; } @@ -2014,7 +2018,7 @@ export namespace vmmigration_v1alpha1 { */ sourceDiskNumber?: number | null; /** - * Optional. Details for attachment of the disk to a VM. Used when the disk is set to be attacked to a target VM. + * Optional. Details for attachment of the disk to a VM. Used when the disk is set to be attached to a target VM. */ vmAttachmentDetails?: Schema$VmAttachmentDetails; } @@ -2118,6 +2122,10 @@ export namespace vmmigration_v1alpha1 { * Request message for 'ResumeMigration' request. */ export interface Schema$ResumeMigrationRequest {} + /** + * Request message for 'RunDiskMigrationJobRequest' request. + */ + export interface Schema$RunDiskMigrationJobRequest {} /** * A policy for scheduling replications. */ @@ -4783,6 +4791,7 @@ export namespace vmmigration_v1alpha1 { export class Resource$Projects$Locations$Sources { context: APIRequestContext; datacenterConnectors: Resource$Projects$Locations$Sources$Datacenterconnectors; + diskMigrationJobs: Resource$Projects$Locations$Sources$Diskmigrationjobs; migratingVms: Resource$Projects$Locations$Sources$Migratingvms; utilizationReports: Resource$Projects$Locations$Sources$Utilizationreports; constructor(context: APIRequestContext) { @@ -4791,6 +4800,8 @@ export namespace vmmigration_v1alpha1 { new Resource$Projects$Locations$Sources$Datacenterconnectors( this.context ); + this.diskMigrationJobs = + new Resource$Projects$Locations$Sources$Diskmigrationjobs(this.context); this.migratingVms = new Resource$Projects$Locations$Sources$Migratingvms( this.context ); @@ -5963,6 +5974,216 @@ export namespace vmmigration_v1alpha1 { requestBody?: Schema$UpgradeApplianceRequest; } + export class Resource$Projects$Locations$Sources$Diskmigrationjobs { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Cancels the disk migration job. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + cancel( + params: Params$Resource$Projects$Locations$Sources$Diskmigrationjobs$Cancel, + options: StreamMethodOptions + ): GaxiosPromise; + cancel( + params?: Params$Resource$Projects$Locations$Sources$Diskmigrationjobs$Cancel, + options?: MethodOptions + ): GaxiosPromise; + cancel( + params: Params$Resource$Projects$Locations$Sources$Diskmigrationjobs$Cancel, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancel( + params: Params$Resource$Projects$Locations$Sources$Diskmigrationjobs$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancel( + params: Params$Resource$Projects$Locations$Sources$Diskmigrationjobs$Cancel, + callback: BodyResponseCallback + ): void; + cancel(callback: BodyResponseCallback): void; + cancel( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Sources$Diskmigrationjobs$Cancel + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Sources$Diskmigrationjobs$Cancel; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Sources$Diskmigrationjobs$Cancel; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://vmmigration.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha1/{+name}:cancel').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Runs the disk migration job. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + run( + params: Params$Resource$Projects$Locations$Sources$Diskmigrationjobs$Run, + options: StreamMethodOptions + ): GaxiosPromise; + run( + params?: Params$Resource$Projects$Locations$Sources$Diskmigrationjobs$Run, + options?: MethodOptions + ): GaxiosPromise; + run( + params: Params$Resource$Projects$Locations$Sources$Diskmigrationjobs$Run, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + run( + params: Params$Resource$Projects$Locations$Sources$Diskmigrationjobs$Run, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + run( + params: Params$Resource$Projects$Locations$Sources$Diskmigrationjobs$Run, + callback: BodyResponseCallback + ): void; + run(callback: BodyResponseCallback): void; + run( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Sources$Diskmigrationjobs$Run + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Sources$Diskmigrationjobs$Run; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Sources$Diskmigrationjobs$Run; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://vmmigration.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha1/{+name}:run').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Sources$Diskmigrationjobs$Cancel + extends StandardParameters { + /** + * Required. The name of the DiskMigrationJob. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$CancelDiskMigrationJobRequest; + } + export interface Params$Resource$Projects$Locations$Sources$Diskmigrationjobs$Run + extends StandardParameters { + /** + * Required. The name of the DiskMigrationJob. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$RunDiskMigrationJobRequest; + } + export class Resource$Projects$Locations$Sources$Migratingvms { context: APIRequestContext; cloneJobs: Resource$Projects$Locations$Sources$Migratingvms$Clonejobs; diff --git a/src/apis/vmwareengine/v1.ts b/src/apis/vmwareengine/v1.ts index 8d4a4f6d8d..faf3ffb915 100644 --- a/src/apis/vmwareengine/v1.ts +++ b/src/apis/vmwareengine/v1.ts @@ -150,6 +150,56 @@ export namespace vmwareengine_v1 { */ logType?: string | null; } + /** + * Autoscaling policy describes the behavior of the autoscaling with respect to the resource utilization. The scale-out operation is initiated if the utilization exceeds ANY of the respective thresholds. The scale-in operation is initiated if the utilization is below ALL of the respective thresholds. + */ + export interface Schema$AutoscalingPolicy { + /** + * Optional. Utilization thresholds pertaining to amount of consumed memory. + */ + consumedMemoryThresholds?: Schema$Thresholds; + /** + * Optional. Utilization thresholds pertaining to CPU utilization. + */ + cpuThresholds?: Schema$Thresholds; + /** + * Optional. Utilization thresholds pertaining to amount of granted memory. + */ + grantedMemoryThresholds?: Schema$Thresholds; + /** + * Required. The canonical identifier of the node type to add or remove. Corresponds to the `NodeType`. + */ + nodeTypeId?: string | null; + /** + * Required. Number of nodes to add to a cluster during a scale-out operation. Must be divisible by 2 for stretched clusters. During a scale-in operation only one node (or 2 for stretched clusters) are removed in a single iteration. + */ + scaleOutSize?: number | null; + /** + * Optional. Utilization thresholds pertaining to amount of consumed storage. + */ + storageThresholds?: Schema$Thresholds; + } + /** + * Autoscaling settings define the rules used by VMware Engine to automatically scale-out and scale-in the clusters in a private cloud. + */ + export interface Schema$AutoscalingSettings { + /** + * Required. The map with autoscaling policies applied to the cluster. The key is the identifier of the policy. It must meet the following requirements: * Only contains 1-63 alphanumeric characters and hyphens * Begins with an alphabetical character * Ends with a non-hyphen character * Not formatted as a UUID * Complies with [RFC 1034](https://datatracker.ietf.org/doc/html/rfc1034) (section 3.5) Currently there map must contain only one element that describes the autoscaling policy for compute nodes. + */ + autoscalingPolicies?: {[key: string]: Schema$AutoscalingPolicy} | null; + /** + * Optional. The minimum duration between consecutive autoscale operations. It starts once addition or removal of nodes is fully completed. Defaults to 30 minutes if not specified. Cool down period must be in whole minutes (for example, 30, 31, 50, 180 minutes). + */ + coolDownPeriod?: string | null; + /** + * Optional. Maximum number of nodes of any type in a cluster. If not specified the default limits apply. + */ + maxClusterNodeCount?: number | null; + /** + * Optional. Minimum number of nodes of any type in a cluster. If not specified the default limits apply. + */ + minClusterNodeCount?: number | null; + } /** * Associates `members`, or principals, with a `role`. */ @@ -171,6 +221,10 @@ export namespace vmwareengine_v1 { * A cluster in a private cloud. */ export interface Schema$Cluster { + /** + * Optional. Configuration of the autoscaling applied to this cluster. + */ + autoscalingSettings?: Schema$AutoscalingSettings; /** * Output only. Creation time of this resource. */ @@ -1524,6 +1578,19 @@ export namespace vmwareengine_v1 { */ permissions?: string[] | null; } + /** + * Thresholds define the utilization of resources triggering scale-out and scale-in operations. + */ + export interface Schema$Thresholds { + /** + * Required. The utilization triggering the scale-in operation in percent. + */ + scaleIn?: number | null; + /** + * Required. The utilization triggering the scale-out operation in percent. + */ + scaleOut?: number | null; + } /** * Request message for VmwareEngine.UndeletePrivateCloud */ diff --git a/src/apis/workloadmanager/v1.ts b/src/apis/workloadmanager/v1.ts index addad6a975..c68c4515cb 100644 --- a/src/apis/workloadmanager/v1.ts +++ b/src/apis/workloadmanager/v1.ts @@ -141,6 +141,10 @@ export namespace workloadmanager_v1 { * Provides the mapping of a cloud asset to a direct physical location or to a proxy that defines the location on its behalf. */ export interface Schema$AssetLocation { + /** + * Spanner path of the CCFE RMS database. It is only applicable for CCFE tenants that use CCFE RMS for storing resource metadata. + */ + ccfeRmsPath?: string | null; /** * Defines the customer expectation around ZI/ZS for this asset and ZI/ZS state of the region at the time of asset creation. */ @@ -1083,6 +1087,13 @@ export namespace workloadmanager_v1 { timeoutSeconds?: number | null; } export interface Schema$SpannerLocation { + /** + * Set of backups used by the resource with name in the same format as what is available at http://table/spanner_automon.backup_metadata + */ + backupName?: string[] | null; + /** + * Set of databases used by the resource in format /span// + */ dbName?: string[] | null; } /** diff --git a/src/apis/workstations/v1.ts b/src/apis/workstations/v1.ts index 8559cdfca6..38fb7105ae 100644 --- a/src/apis/workstations/v1.ts +++ b/src/apis/workstations/v1.ts @@ -227,11 +227,11 @@ export namespace workstations_v1 { kmsKeyServiceAccount?: string | null; } /** - * Configuration options for private workstation clusters. + * Configuration options for a custom domain. */ export interface Schema$DomainConfig { /** - * Immutable. Whether Workstations endpoint is private. + * Immutable. Domain used by Workstations for HTTP ingress. */ domain?: string | null; } @@ -673,10 +673,38 @@ export namespace workstations_v1 { */ version?: number | null; } + /** + * A PortRange defines a range of ports. Both first and last are inclusive. To specify a single port, both first and last should be the same. + */ + export interface Schema$PortRange { + /** + * Required. Starting port number for the current range of ports. + */ + first?: number | null; + /** + * Required. Ending port number for the current range of ports. + */ + last?: number | null; + } + /** + * Configuration options for private workstation clusters. + */ export interface Schema$PrivateClusterConfig { + /** + * Optional. Additional projects that are allowed to attach to the workstation cluster's service attachment. By default, the workstation cluster's project and the VPC host project (if different) are allowed. + */ allowedProjects?: string[] | null; + /** + * Output only. Hostname for the workstation cluster. This field will be populated only when private endpoint is enabled. To access workstations in the workstation cluster, create a new DNS zone mapping this domain name to an internal IP address and a forwarding rule mapping that address to the service attachment. + */ clusterHostname?: string | null; + /** + * Immutable. Whether Workstations endpoint is private. + */ enablePrivateEndpoint?: boolean | null; + /** + * Output only. Service attachment URI for the workstation cluster. The service attachemnt 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). + */ serviceAttachmentUri?: string | null; } /** @@ -908,6 +936,10 @@ export namespace workstations_v1 { * A workstation configuration resource in the Cloud Workstations API. Workstation configurations act as templates for workstations. The workstation configuration defines details such as the workstation virtual machine (VM) instance type, persistent storage, container image defining environment, which IDE or Code Editor to use, and more. Administrators and platform teams can also use [Identity and Access Management (IAM)](https://cloud.google.com/iam/docs/overview) rules to grant access to teams or to individual developers. */ export interface Schema$WorkstationConfig { + /** + * Optional. A Single or Range of ports externally accessible in the workstation. If not specified defaults to ports 22, 80 and ports 1024-65535. + */ + allowedPorts?: Schema$PortRange[]; /** * Optional. Client-specified annotations. */ diff --git a/src/apis/workstations/v1beta.ts b/src/apis/workstations/v1beta.ts index abc12a1cdc..c45561e210 100644 --- a/src/apis/workstations/v1beta.ts +++ b/src/apis/workstations/v1beta.ts @@ -256,11 +256,11 @@ export namespace workstations_v1beta { kmsKeyServiceAccount?: string | null; } /** - * Configuration options for private workstation clusters. + * Configuration options for a custom domain. */ export interface Schema$DomainConfig { /** - * Immutable. Whether Workstations endpoint is private. + * Immutable. Domain used by Workstations for HTTP ingress. */ domain?: string | null; } @@ -678,7 +678,7 @@ export namespace workstations_v1beta { version?: number | null; } /** - * A PortsConfig defines a range of ports. Both first and last are inclusive. To specify a single port, both first and last should be the same. + * A PortRange defines a range of ports. Both first and last are inclusive. To specify a single port, both first and last should be the same. */ export interface Schema$PortRange { /** @@ -690,10 +690,25 @@ export namespace workstations_v1beta { */ last?: number | null; } + /** + * Configuration options for private workstation clusters. + */ export interface Schema$PrivateClusterConfig { + /** + * Optional. Additional projects that are allowed to attach to the workstation cluster's service attachment. By default, the workstation cluster's project and the VPC host project (if different) are allowed. + */ allowedProjects?: string[] | null; + /** + * Output only. Hostname for the workstation cluster. This field will be populated only when private endpoint is enabled. To access workstations in the workstation cluster, create a new DNS zone mapping this domain name to an internal IP address and a forwarding rule mapping that address to the service attachment. + */ clusterHostname?: string | null; + /** + * Immutable. Whether Workstations endpoint is private. + */ enablePrivateEndpoint?: boolean | null; + /** + * Output only. Service attachment URI for the workstation cluster. The service attachemnt 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). + */ serviceAttachmentUri?: string | null; } /** @@ -835,6 +850,14 @@ export namespace workstations_v1beta { * Output only. Indicates whether this workstation is currently being updated to match its intended state. */ reconciling?: boolean | null; + /** + * Output only. Reserved for future use. + */ + satisfiesPzi?: boolean | null; + /** + * Output only. Reserved for future use. + */ + satisfiesPzs?: boolean | null; /** * Optional. The source workstation from which this workstations persistent directories were cloned on creation. */ @@ -916,6 +939,14 @@ export namespace workstations_v1beta { * Output only. Indicates whether this workstation cluster is currently being updated to match its intended state. */ reconciling?: boolean | null; + /** + * Output only. Reserved for future use. + */ + satisfiesPzi?: boolean | null; + /** + * Output only. Reserved for future use. + */ + satisfiesPzs?: boolean | null; /** * Immutable. Name of the Compute Engine subnetwork in which instances associated with this workstation cluster will be created. Must be part of the subnetwork specified for this workstation cluster. */ @@ -1025,6 +1056,14 @@ export namespace workstations_v1beta { * Optional. Number of seconds that a workstation can run until it is automatically shut down. We recommend that workstations be shut down daily to reduce costs and so that security updates can be applied upon restart. The idle_timeout and running_timeout fields are independent of each other. Note that the running_timeout field shuts down VMs after the specified time, regardless of whether or not the VMs are idle. Provide duration terminated by `s` for seconds—for example, `"54000s"` (15 hours). Defaults to `"43200s"` (12 hours). A value of `"0s"` indicates that workstations using this configuration should never time out. If encryption_key is set, it must be greater than `"0s"` and less than `"86400s"` (24 hours). Warning: A value of `"0s"` indicates that Cloud Workstations VMs created with this configuration have no maximum running time. This is strongly discouraged because you incur costs and will not pick up security updates. */ runningTimeout?: string | null; + /** + * Output only. Reserved for future use. + */ + satisfiesPzi?: boolean | null; + /** + * Output only. Reserved for future use. + */ + satisfiesPzs?: boolean | null; /** * Output only. A system-assigned unique identifier for this workstation configuration. */ diff --git a/src/generator/download.ts b/src/generator/download.ts index 1d6579b1d3..085cb90122 100644 --- a/src/generator/download.ts +++ b/src/generator/download.ts @@ -21,7 +21,7 @@ import {request, Headers} from 'gaxios'; import * as gapi from 'googleapis-common'; export type Schema = {[index: string]: {}}; -export const DISCOVERY_URL = 'https://www.googleapis.com/discovery/v1/apis/'; +export const DISCOVERY_URL = 'https://raw.githubusercontent.com/googleapis/discovery-artifact-manager/master/discoveries/index.json'; export interface Change { action: 'ADDED' | 'DELETED' | 'CHANGED'; @@ -65,10 +65,10 @@ export async function downloadDiscoveryDocs( ? headers['Content-Type'] : 'json'; console.log(`sending request to ${options.discoveryUrl}`); - const res = await request({url: options.discoveryUrl, headers}); - const apis = res.data.items; + const res = await request({url: options.discoveryUrl, headers}); + const apis = (JSON.parse(res.data as string)).items as gapi.Schema[]; const indexPath = path.join(options.downloadPath, 'index.json'); - gfs.writeFile(indexPath, res.data); + gfs.writeFile(indexPath, JSON.parse(res.data as string)); const queue = new Q({concurrency: 25}); console.log(`Downloading ${apis.length} APIs...`); const changes = await queue.addAll( diff --git a/src/index.ts b/src/index.ts index 48dd806f8e..a6f8abcea8 100644 --- a/src/index.ts +++ b/src/index.ts @@ -39,6 +39,7 @@ export {admob_v1beta} from './apis/admob/v1beta'; export {adsense_v1_4} from './apis/adsense/v1.4'; export {adsense_v2} from './apis/adsense/v2'; export {adsensehost_v4_1} from './apis/adsensehost/v4.1'; +export {adsenseplatform_v1alpha} from './apis/adsenseplatform/v1alpha'; export {advisorynotifications_v1} from './apis/advisorynotifications/v1'; export {aiplatform_v1} from './apis/aiplatform/v1'; export {aiplatform_v1beta1} from './apis/aiplatform/v1beta1'; @@ -181,6 +182,7 @@ export {containeranalysis_v1beta1} from './apis/containeranalysis/v1beta1'; export {content_v2_1} from './apis/content/v2.1'; export {content_v2} from './apis/content/v2'; export {contentwarehouse_v1} from './apis/contentwarehouse/v1'; +export {css_v1} from './apis/css/v1'; export {customsearch_v1} from './apis/customsearch/v1'; export {datacatalog_v1} from './apis/datacatalog/v1'; export {datacatalog_v1beta1} from './apis/datacatalog/v1beta1'; diff --git a/test/test.download.ts b/test/test.download.ts index cd6e1abd45..3ad775dc0a 100644 --- a/test/test.download.ts +++ b/test/test.download.ts @@ -24,7 +24,8 @@ import * as http from 'http'; describe(__filename, () => { nock.disableNetConnect(); - const discoveryUrl = 'https://www.googleapis.com/discovery/v1/apis/'; + const discoveryUrl = + 'https://raw.githubusercontent.com/googleapis/discovery-artifact-manager/master/discoveries/index.json'; const fakeIndexPath = 'test/fixtures/index.json'; const sandbox = sinon.createSandbox(); @@ -79,8 +80,8 @@ describe(__filename, () => { it('should download the discovery docs', async () => { const scopes = [ - nock('https://www.googleapis.com') - .get('/discovery/v1/apis/') + nock('https://raw.githubusercontent.com/googleapis') + .get('/discovery-artifact-manager/master/discoveries/index.json') .replyWithFile(200, fakeIndexPath, { 'Content-Type': 'application/json', }), @@ -99,8 +100,8 @@ describe(__filename, () => { it('should ignore changes to schemas that only have revision changes', async () => { const scopes = [ - nock('https://www.googleapis.com') - .get('/discovery/v1/apis/') + nock('https://raw.githubusercontent.com/googleapis') + .get('/discovery-artifact-manager/master/discoveries/index.json') .replyWithFile(200, fakeIndexPath, { 'Content-Type': 'application/json', }),